Assert: success or failure defined

mtojek · mtojek · commit 716527673f32 · 2023-01-12T11:28:56.000+01:00
diff --git a/coderd/coderdtest/swagger_test.go b/coderd/coderdtest/swagger_test.go
@@ -21,6 +21,9 @@ type swaggerComment struct {
 
 	method string
 	router string
+
+	hasSuccess bool
+	hasFailure bool
 }
 
 func TestAllEndpointsDocumented(t *testing.T) {
@@ -44,6 +47,7 @@ func TestAllEndpointsDocumented(t *testing.T) {
 		}
 
 		assertConsistencyBetweenRouteIDAndSummary(t, *c)
+		assertSuccessOrFailureDefined(t, *c)
 		return nil
 	})
 }
@@ -95,6 +99,10 @@ func parseSwaggerComment(commentGroup *ast.CommentGroup) swaggerComment {
 		} else if strings.Contains(text, "@ID ") {
 			args := strings.SplitN(text, " ", 3)
 			c.id = args[2]
+		} else if strings.Contains(text, "@Success ") {
+			c.hasSuccess = true
+		} else if strings.Contains(text, "@Failure ") {
+			c.hasFailure = true
 		}
 	}
 	return c
@@ -118,3 +126,7 @@ func assertConsistencyBetweenRouteIDAndSummary(t *testing.T, comment swaggerComm
 
 	assert.Equal(t, exp, comment.id, "Router ID must match summary")
 }
+
+func assertSuccessOrFailureDefined(t *testing.T, comment swaggerComment) {
+	assert.True(t, comment.hasSuccess || comment.hasFailure, "At least one @Success or @Failure annotation must be defined")
+}

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,9 @@ type swaggerComment struct {`
`21`	`21`
`22`	`22`	`method string`
`23`	`23`	`router string`
	`24`	`+`
	`25`	`+ hasSuccess bool`
	`26`	`+ hasFailure bool`
`24`	`27`	`}`
`25`	`28`
`26`	`29`	`func TestAllEndpointsDocumented(t *testing.T) {`
`@@ -44,6 +47,7 @@ func TestAllEndpointsDocumented(t *testing.T) {`
`44`	`47`	`}`
`45`	`48`
`46`	`49`	`assertConsistencyBetweenRouteIDAndSummary(t, *c)`
	`50`	`+ assertSuccessOrFailureDefined(t, *c)`
`47`	`51`	`return nil`
`48`	`52`	`})`
`49`	`53`	`}`
`@@ -95,6 +99,10 @@ func parseSwaggerComment(commentGroup *ast.CommentGroup) swaggerComment {`
`95`	`99`	`} else if strings.Contains(text, "@ID ") {`
`96`	`100`	`args := strings.SplitN(text, " ", 3)`
`97`	`101`	`c.id = args[2]`
	`102`	`+ } else if strings.Contains(text, "@Success ") {`
	`103`	`+ c.hasSuccess = true`
	`104`	`+ } else if strings.Contains(text, "@Failure ") {`
	`105`	`+ c.hasFailure = true`
`98`	`106`	`}`
`99`	`107`	`}`
`100`	`108`	`return c`
`@@ -118,3 +126,7 @@ func assertConsistencyBetweenRouteIDAndSummary(t *testing.T, comment swaggerComm`
`118`	`126`
`119`	`127`	`assert.Equal(t, exp, comment.id, "Router ID must match summary")`
`120`	`128`	`}`
	`129`	`+`
	`130`	`+func assertSuccessOrFailureDefined(t *testing.T, comment swaggerComment) {`
	`131`	`+ assert.True(t, comment.hasSuccess \|\| comment.hasFailure, "At least one @Success or @Failure annotation must be defined")`
	`132`	`+}`