Merge pull request #28 from padiazg/fix-lint-and-test

Fix lint and test

Author: kaynetik

build_test.go

@@ -5,6 +5,55 @@ import (
 	"testing"
 )
 
+const (
+	buildStreamTestWant = `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:
+            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
+`
+)
+
 func TestUnitBuild(t *testing.T) {
 	t.Parallel()
 
@@ -114,6 +163,8 @@ func TestUnitGetPathFromFirstElem(t *testing.T) {
 // QUICK CHECK TESTS ARE COMING WITH NEXT RELEASE.
 
 func TestOAS_BuildStream(t *testing.T) {
+	t.Parallel()
+
 	tests := []struct {
 		name    string
 		oas     *OAS
@@ -124,27 +175,19 @@ func TestOAS_BuildStream(t *testing.T) {
 			name: "success",
 			oas: &OAS{
 				OASVersion: "3.0.1",
-				Info: Info{
-					Title:       "Test",
-					Description: "Test object",
-				},
+				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"},
+									Name: "EnumProp", Type: "enum", Description: "short desc",
+									Enum: []string{"enum", "test", "strSlc"},
 								},
 								SchemaProperty{
-									Name:        "intProp",
-									Type:        "integer",
-									Format:      "int64",
-									Description: "short desc",
-									Default:     1337,
+									Name: "intProp", Type: "integer", Format: "int64",
+									Description: "short desc", Default: 1337,
 								},
 							},
 							XML: XMLEntry{Name: "XML entry test"},
@@ -156,70 +199,20 @@ func TestOAS_BuildStream(t *testing.T) {
 								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",
-									},
+									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
-`,
+			wantW:   buildStreamTestWant,
 		},
 	}
+
+	t.Parallel()
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			w := &bytes.Buffer{}

examples/stream_output/main.go

@@ -24,7 +24,7 @@ func main() {
 	apiSetExternalDocs(&apiDoc)
 	apiSetComponents(&apiDoc)
 
-	apiDoc.AddRoute(docs.Path{
+	apiDoc.AddRoute(&docs.Path{
 		Route:       "/users",
 		HTTPMethod:  "POST",
 		OperationID: "createUser",
@@ -43,7 +43,7 @@ func main() {
 		},
 	})
 
-	apiDoc.AddRoute(docs.Path{
+	apiDoc.AddRoute(&docs.Path{
 		Route:       "/users",
 		HTTPMethod:  "GET",
 		OperationID: "getUser",

routing.go

@@ -40,6 +40,6 @@ func (oas *OAS) GetPathByIndex(index int) *Path {
 }
 
 // AddRoute is used for add API documentation routes.
-func (oas *OAS) AddRoute(path Path) {
-	oas.Paths = append(oas.Paths, path)
+func (oas *OAS) AddRoute(path *Path) {
+	oas.Paths = append(oas.Paths, *path)
 }

routing_test.go

@@ -305,19 +305,19 @@ func TestOAS_AddRoute(t *testing.T) {
 	tests := []struct {
 		name      string
 		oas       *OAS
-		path      Path
+		path      *Path
 		wantPaths Paths
 	}{
 		{
 			name:      "success-no-existing-paths",
 			oas:       &OAS{},
-			path:      pathGetUser,
+			path:      &pathGetUser,
 			wantPaths: Paths{pathGetUser},
 		},
 		{
 			name:      "success-existing-paths",
 			oas:       &OAS{Paths: Paths{pathGetUser}},
-			path:      pathCreateUser,
+			path:      &pathCreateUser,
 			wantPaths: Paths{pathGetUser, pathCreateUser},
 		},
 	}

server.go

@@ -18,6 +18,7 @@ const (
 	defaultIndexPath           = "/index.html"
 	fwSlashSuffix              = "/"
 	sigContSleeperMilliseconds = 20
+	readHeaderTimeout          = 60 * time.Second // same than nginx
 )
 
 // ConfigSwaggerUI represents a structure which will be used to pass required configuration params to
@@ -156,8 +157,9 @@ func (c *ConfigSwaggerUI) initializeDefaultHTTPServer() {
 	fileServer := http.FileServer(c.initFS)
 
 	c.httpServer = &http.Server{
-		Addr:    fmt.Sprintf(":%s", c.Port),
-		Handler: http.StripPrefix(strings.TrimRight(c.Route, fwSlashSuffix), fileServer),
+		Addr:              fmt.Sprintf(":%s", c.Port),
+		Handler:           http.StripPrefix(strings.TrimRight(c.Route, fwSlashSuffix), fileServer),
+		ReadHeaderTimeout: readHeaderTimeout,
 	}
 }