Flag tests

mtojek · mtojek · commit 1844264274f4 · 2022-12-13T15:02:16.000+01:00
diff --git a/coderd/coderd_test.go b/coderd/coderd_test.go
@@ -129,3 +129,64 @@ func TestHealthz(t *testing.T) {
 
 	assert.Equal(t, "OK", string(body))
 }
+
+func TestSwagger(t *testing.T) {
+	t.Parallel()
+
+	const swaggerEndpoint = "/swagger"
+	t.Run("endpoint enabled", func(t *testing.T) {
+		t.Parallel()
+
+		client := coderdtest.New(t, &coderdtest.Options{
+			SwaggerEndpointEnabled: true,
+		})
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitMedium)
+		defer cancel()
+
+		resp, err := requestWithRetries(ctx, t, client, http.MethodGet, swaggerEndpoint, nil)
+		require.NoError(t, err)
+
+		body, err := io.ReadAll(resp.Body)
+		require.NoError(t, err)
+		defer resp.Body.Close()
+
+		require.Contains(t, string(body), "Swagger UI")
+	})
+	t.Run("doc.json exposed", func(t *testing.T) {
+		t.Parallel()
+
+		client := coderdtest.New(t, &coderdtest.Options{
+			SwaggerEndpointEnabled: true,
+		})
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitMedium)
+		defer cancel()
+
+		resp, err := requestWithRetries(ctx, t, client, http.MethodGet, swaggerEndpoint+"/doc.json", nil)
+		require.NoError(t, err)
+
+		body, err := io.ReadAll(resp.Body)
+		require.NoError(t, err)
+		defer resp.Body.Close()
+
+		require.Contains(t, string(body), `"swagger": "2.0"`)
+	})
+	t.Run("endpoint disabled by default", func(t *testing.T) {
+		t.Parallel()
+
+		client := coderdtest.New(t, nil)
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitMedium)
+		defer cancel()
+
+		resp, err := requestWithRetries(ctx, t, client, http.MethodGet, swaggerEndpoint, nil)
+		require.NoError(t, err)
+
+		body, err := io.ReadAll(resp.Body)
+		require.NoError(t, err)
+		defer resp.Body.Close()
+
+		require.Equal(t, "<pre>\n</pre>\n", string(body))
+	})
+}
diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -111,6 +111,8 @@ type Options struct {
 	// test instances are running against the same database.
 	Database database.Store
 	Pubsub   database.Pubsub
+
+	SwaggerEndpointEnabled bool
 }
 
 // New constructs a codersdk client connected to an in-memory API instance.
@@ -288,6 +290,7 @@ func NewOptions(t *testing.T, options *Options) (func(http.Handler), context.Can
 			AgentStatsRefreshInterval:   options.AgentStatsRefreshInterval,
 			DeploymentConfig:            options.DeploymentConfig,
 			UpdateCheckOptions:          options.UpdateCheckOptions,
+			SwaggerEndpointEnabled:      options.SwaggerEndpointEnabled,
 		}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,8 @@ type Options struct {`
`111`	`111`	`// test instances are running against the same database.`
`112`	`112`	`Database database.Store`
`113`	`113`	`Pubsub database.Pubsub`
	`114`	`+`
	`115`	`+ SwaggerEndpointEnabled bool`
`114`	`116`	`}`
`115`	`117`
`116`	`118`	`// New constructs a codersdk client connected to an in-memory API instance.`
`@@ -288,6 +290,7 @@ func NewOptions(t testing.T, options Options) (func(http.Handler), context.Can`
`288`	`290`	`AgentStatsRefreshInterval: options.AgentStatsRefreshInterval,`
`289`	`291`	`DeploymentConfig: options.DeploymentConfig,`
`290`	`292`	`UpdateCheckOptions: options.UpdateCheckOptions,`
	`293`	`+ SwaggerEndpointEnabled: options.SwaggerEndpointEnabled,`
`291`	`294`	`}`
`292`	`295`	`}`
`293`	`296`