Added unit-tests. Small fixes to stream example.

Author: padiazg

build_test.go

@@ -1,6 +1,9 @@
 package docs
 
-import "testing"
+import (
+	"bytes"
+	"testing"
+)
 
 func TestUnitBuild(t *testing.T) {
 	t.Parallel()
@@ -109,3 +112,124 @@ func TestUnitGetPathFromFirstElem(t *testing.T) {
 }
 
 // QUICK CHECK TESTS ARE COMING WITH NEXT RELEASE.
+
+func TestOAS_BuildStream(t *testing.T) {
+	tests := []struct {
+		name    string
+		oas     *OAS
+		wantW   string
+		wantErr bool
+	}{
+		{
+			name: "success",
+			oas: &OAS{
+				OASVersion: "3.0.1",
+				Info: Info{
+					Title:       "Test",
+					Description: "Test object",
+				},
+				Components: Components{
+					Component{
+						Schemas: Schemas{Schema{
+							Name: "schema_testing",
+							Properties: SchemaProperties{
+								SchemaProperty{
+									Name:        "EnumProp",
+									Type:        "enum",
+									Description: "short desc",
+									Enum:        []string{"enum", "test", "strSlc"},
+								},
+								SchemaProperty{
+									Name:        "intProp",
+									Type:        "integer",
+									Format:      "int64",
+									Description: "short desc",
+									Default:     1337,
+								},
+							},
+							XML: XMLEntry{Name: "XML entry test"},
+						}},
+						SecuritySchemes: SecuritySchemes{SecurityScheme{
+							Name: "ses_scheme_testing",
+							In:   "not empty",
+							Flows: SecurityFlows{SecurityFlow{
+								Type:    "implicit",
+								AuthURL: "http://petstore.swagger.io/oauth/dialog",
+								Scopes: SecurityScopes{
+									SecurityScope{
+										Name:        "write:pets",
+										Description: "Write to Pets",
+									},
+									SecurityScope{
+										Name:        "read:pets",
+										Description: "Read Pets",
+									},
+								},
+							}},
+						}},
+					},
+				},
+			},
+			wantErr: false,
+			wantW: `openapi: 3.0.1
+info:
+    title: Test
+    description: Test object
+    termsOfService: ""
+    contact:
+        email: ""
+    license:
+        name: ""
+        url: ""
+    version: ""
+externalDocs:
+    description: ""
+    url: ""
+servers: []
+tags: []
+paths: {}
+components:
+    schemas:
+        schema_testing:
+            $ref: ""
+            properties:
+                EnumProp:
+                    description: short desc
+                    enum:
+                        - enum
+                        - test
+                        - strSlc
+                    type: enum
+                intProp:
+                    default: 1337
+                    description: short desc
+                    format: int64
+                    type: integer
+            type: ""
+            xml:
+                name: XML entry test
+    securitySchemes:
+        ses_scheme_testing:
+            flows:
+                implicit:
+                    authorizationUrl: http://petstore.swagger.io/oauth/dialog
+                    scopes:
+                        read:pets: Read Pets
+                        write:pets: Write to Pets
+            in: not empty
+`,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			w := &bytes.Buffer{}
+			if err := tt.oas.BuildStream(w); (err != nil) != tt.wantErr {
+				t.Errorf("OAS.BuildStream() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if gotW := w.String(); gotW != tt.wantW {
+				t.Errorf("OAS.BuildStream() = [%v], want {%v}", gotW, tt.wantW)
+			}
+		})
+	}
+}

examples/stream_output/main.go

@@ -53,7 +53,7 @@ func main() {
 		},
 		// HandlerFuncName: "handleCreateUser",
 		RequestBody: docs.RequestBody{
-			Description: "Create a new User",
+			Description: "Get a user",
 			Content: docs.ContentTypes{
 				getContentApplicationJSON("#/components/schemas/User"),
 			},
@@ -76,14 +76,6 @@ func main() {
 		}
 	})
 
-	// print routes
-	// hm := reflect.ValueOf(mux).Elem()
-	// fl := hm.FieldByIndex([]int{1})
-	// fmt.Printf("%+v\n", fl)
-
-	// path, _ := os.Getwd()
-	// fmt.Printf("cwd: %s\n", path)
-
 	fmt.Printf("Listening at :%d", port)
 	if err := http.ListenAndServe(fmt.Sprintf(":%d", port), LogginMiddleware(mux)); err != nil {
 		if errors.Is(err, http.ErrServerClosed) {

routing_test.go

@@ -268,3 +268,66 @@ func TestQuickUnitAttachRoutes(t *testing.T) {
 		t.Errorf("Check failed: %#v", err)
 	}
 }
+
+func TestOAS_AddRoute(t *testing.T) {
+
+	var (
+		respose200         = Response{Code: 200, Description: "Ok"}
+		respose404         = Response{Code: 404, Description: "Not Found"}
+		contentTypeUser    = ContentType{Name: "application/json", Schema: "#/components/schemas/User"}
+		requestBodyGetUser = RequestBody{
+			Description: "Get a User",
+			Content:     ContentTypes{contentTypeUser},
+			Required:    true,
+		}
+		requestBodyCreateUser = RequestBody{
+			Description: "Create a new User",
+			Content:     ContentTypes{contentTypeUser},
+			Required:    true,
+		}
+		pathGetUser = Path{
+			Route:       "/users",
+			HTTPMethod:  "GET",
+			OperationID: "getUser",
+			Summary:     "Get a User",
+			Responses:   Responses{respose200},
+			RequestBody: requestBodyGetUser,
+		}
+		pathCreateUser = Path{
+			Route:       "/users",
+			HTTPMethod:  "POST",
+			OperationID: "createUser",
+			Summary:     "Create a new User",
+			Responses:   Responses{respose200, respose404},
+			RequestBody: requestBodyCreateUser,
+		}
+	)
+
+	tests := []struct {
+		name      string
+		oas       *OAS
+		path      Path
+		wantPaths Paths
+	}{
+		{
+			name:      "success-no-existing-paths",
+			oas:       &OAS{},
+			path:      pathGetUser,
+			wantPaths: Paths{pathGetUser},
+		},
+		{
+			name:      "success-existing-paths",
+			oas:       &OAS{Paths: Paths{pathGetUser}},
+			path:      pathCreateUser,
+			wantPaths: Paths{pathGetUser, pathCreateUser},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			tt.oas.AddRoute(tt.path)
+			if !reflect.DeepEqual(tt.wantPaths, tt.oas.Paths) {
+				t.Errorf("OAS.AddRoute() = [%v], want {%v}", tt.oas.Paths, tt.wantPaths)
+			}
+		})
+	}
+}