reviews

machine424 · machine424 · commit cb7d9fe52564 · 2025-10-13T16:25:15.000+02:00
diff --git a/Documentation/resources.adoc b/Documentation/resources.adoc
@@ -92,7 +92,6 @@ $ curl -k -H "Authorization: Bearer $TOKEN" "https://$ROUTE/api/v2/alerts?filter
 # Access Alertmanager endpoints from within the cluster.
 $ curl -k -H "Authorization: Bearer $TOKEN" "https://alertmanager-main.openshift-monitoring:9094/api/v2/alerts?filter=alertname=Watchdog"
 ----
-
 +
 The following example exercises permissions granted by the `monitoring-alertmanager-edit` role. The binding commands must be run by a user with the necessary privileges.
 +
@@ -179,7 +178,6 @@ $ curl -k -X POST -f "https://alertmanager-main.openshift-monitoring:9092/api/v2
     "comment": "Silence test"
   }'
 ----
-
 +
 The following example exercises permissions granted by the `monitoring-edit` cluster role. The binding commands must be run by a user with the necessary privileges.
 +
@@ -270,7 +268,6 @@ $ curl -k -H "Authorization: Bearer $TOKEN" "https://$ROUTE/api/v1/query?query=u
 # Access Prometheus endpoints from within the cluster.
 $ curl -k -H "Authorization: Bearer $TOKEN" "https://prometheus-k8s.openshift-monitoring:9091/api/v1/query?query=up"
 ----
-
 +
 The following example exercises permissions granted by the `cluster-monitoring-metrics-api` role. The binding commands must be run by a user with the necessary privileges.
 +
@@ -344,7 +341,6 @@ $ curl -k -H "Authorization: Bearer $TOKEN" "https://$ROUTE/api/v1/query?query=u
 # Access Thanos Querier endpoints from within the cluster.
 $ curl -k -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9091/api/v1/query?query=up"
 ----
-
 +
 The following example exercises permissions granted by the `cluster-monitoring-metrics-api` role. The binding commands must be run by a user with the necessary privileges.
 +
@@ -410,7 +406,6 @@ $ TOKEN=$(oc create token thanos-client --namespace=test-thanos-querier-tenancy-
 $ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/rules?namespace=test-thanos-querier-tenancy-rules-monitoring-rules-edit"
 $ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/alerts?namespace=test-thanos-querier-tenancy-rules-monitoring-rules-edit"
 ----
-
 +
 The following example exercises permissions granted by the `monitoring-edit` cluster role. The binding commands must be run by a user with the necessary privileges.
 +
@@ -431,7 +426,6 @@ $ TOKEN=$(oc create token thanos-client --namespace=test-thanos-querier-tenancy-
 $ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/rules?namespace=test-thanos-querier-tenancy-rules-monitoring-edit"
 $ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/alerts?namespace=test-thanos-querier-tenancy-rules-monitoring-edit"
 ----
-
 +
 The following example exercises permissions granted by the `monitoring-rules-view` cluster role. The binding commands must be run by a user with the necessary privileges.
 +
diff --git a/Documentation/resources.md b/Documentation/resources.md
@@ -75,7 +75,6 @@ $ curl -k -H "Authorization: Bearer $TOKEN" "https://$ROUTE/api/v2/alerts?filter
 # Access Alertmanager endpoints from within the cluster.
 $ curl -k -H "Authorization: Bearer $TOKEN" "https://alertmanager-main.openshift-monitoring:9094/api/v2/alerts?filter=alertname=Watchdog"
 ```
-
 ```
 # The following example exercises permissions granted by the `monitoring-alertmanager-edit` role. The binding commands must be run by a user with the necessary privileges.
 
@@ -158,7 +157,6 @@ $ curl -k -X POST -f "https://alertmanager-main.openshift-monitoring:9092/api/v2
     "comment": "Silence test"
   }'
 ```
-
 ```
 # The following example exercises permissions granted by the `monitoring-edit` cluster role. The binding commands must be run by a user with the necessary privileges.
 
@@ -242,7 +240,6 @@ $ curl -k -H "Authorization: Bearer $TOKEN" "https://$ROUTE/api/v1/query?query=u
 # Access Prometheus endpoints from within the cluster.
 $ curl -k -H "Authorization: Bearer $TOKEN" "https://prometheus-k8s.openshift-monitoring:9091/api/v1/query?query=up"
 ```
-
 ```
 # The following example exercises permissions granted by the `cluster-monitoring-metrics-api` role. The binding commands must be run by a user with the necessary privileges.
 
@@ -310,7 +307,6 @@ $ curl -k -H "Authorization: Bearer $TOKEN" "https://$ROUTE/api/v1/query?query=u
 # Access Thanos Querier endpoints from within the cluster.
 $ curl -k -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9091/api/v1/query?query=up"
 ```
-
 ```
 # The following example exercises permissions granted by the `cluster-monitoring-metrics-api` role. The binding commands must be run by a user with the necessary privileges.
 
@@ -370,7 +366,6 @@ $ TOKEN=$(oc create token thanos-client --namespace=test-thanos-querier-tenancy-
 $ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/rules?namespace=test-thanos-querier-tenancy-rules-monitoring-rules-edit"
 $ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/alerts?namespace=test-thanos-querier-tenancy-rules-monitoring-rules-edit"
 ```
-
 ```
 # The following example exercises permissions granted by the `monitoring-edit` cluster role. The binding commands must be run by a user with the necessary privileges.
 
@@ -389,7 +384,6 @@ $ TOKEN=$(oc create token thanos-client --namespace=test-thanos-querier-tenancy-
 $ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/rules?namespace=test-thanos-querier-tenancy-rules-monitoring-edit"
 $ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/alerts?namespace=test-thanos-querier-tenancy-rules-monitoring-edit"
 ```
-
 ```
 # The following example exercises permissions granted by the `monitoring-rules-view` cluster role. The binding commands must be run by a user with the necessary privileges.
 
diff --git a/test/e2e/test_command/test_command.go b/test/e2e/test_command/test_command.go
@@ -86,7 +86,7 @@ func (f markdownFormatter) formatTest(description, commands string) string {
 	sb.WriteString("\n\n")
 	sb.WriteString(commands)
 	sb.WriteString("\n")
-	sb.WriteString("```\n")
+	sb.WriteString("```")
 	return sb.String()
 }
 
@@ -99,7 +99,7 @@ func (f asciidocFormatter) formatTest(description, commands string) string {
 	sb.WriteString("\n+\n")
 	sb.WriteString("[source,terminal]\n----\n")
 	sb.WriteString(commands)
-	sb.WriteString("\n----\n")
+	sb.WriteString("\n----")
 	return sb.String()
 }
 
@@ -109,7 +109,7 @@ func (suite *Suite) format(f formatter) string {
 		description, commands := t.parse()
 		tests[i] = f.formatTest(description, formatCommands(commands))
 	}
-	return strings.Join(tests, "\n")
+	return strings.Join(tests, "\n") + "\n"
 }
 
 func (suite *Suite) StringMarkdown() string {

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,6 @@ $ curl -k -H "Authorization: Bearer $TOKEN" "https://$ROUTE/api/v2/alerts?filter`
`92`	`92`	`# Access Alertmanager endpoints from within the cluster.`
`93`	`93`	`$ curl -k -H "Authorization: Bearer $TOKEN" "https://alertmanager-main.openshift-monitoring:9094/api/v2/alerts?filter=alertname=Watchdog"`
`94`	`94`	`----`
`95`		`-`
`96`	`95`	`+`
`97`	`96`	The following example exercises permissions granted by the `monitoring-alertmanager-edit` role. The binding commands must be run by a user with the necessary privileges.
`98`	`97`	`+`
`@@ -179,7 +178,6 @@ $ curl -k -X POST -f "https://alertmanager-main.openshift-monitoring:9092/api/v2`
`179`	`178`	`"comment": "Silence test"`
`180`	`179`	`}'`
`181`	`180`	`----`
`182`		`-`
`183`	`181`	`+`
`184`	`182`	The following example exercises permissions granted by the `monitoring-edit` cluster role. The binding commands must be run by a user with the necessary privileges.
`185`	`183`	`+`
`@@ -270,7 +268,6 @@ $ curl -k -H "Authorization: Bearer $TOKEN" "https://$ROUTE/api/v1/query?query=u`
`270`	`268`	`# Access Prometheus endpoints from within the cluster.`
`271`	`269`	`$ curl -k -H "Authorization: Bearer $TOKEN" "https://prometheus-k8s.openshift-monitoring:9091/api/v1/query?query=up"`
`272`	`270`	`----`
`273`		`-`
`274`	`271`	`+`
`275`	`272`	The following example exercises permissions granted by the `cluster-monitoring-metrics-api` role. The binding commands must be run by a user with the necessary privileges.
`276`	`273`	`+`
`@@ -344,7 +341,6 @@ $ curl -k -H "Authorization: Bearer $TOKEN" "https://$ROUTE/api/v1/query?query=u`
`344`	`341`	`# Access Thanos Querier endpoints from within the cluster.`
`345`	`342`	`$ curl -k -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9091/api/v1/query?query=up"`
`346`	`343`	`----`
`347`		`-`
`348`	`344`	`+`
`349`	`345`	The following example exercises permissions granted by the `cluster-monitoring-metrics-api` role. The binding commands must be run by a user with the necessary privileges.
`350`	`346`	`+`
`@@ -410,7 +406,6 @@ $ TOKEN=$(oc create token thanos-client --namespace=test-thanos-querier-tenancy-`
`410`	`406`	`$ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/rules?namespace=test-thanos-querier-tenancy-rules-monitoring-rules-edit"`
`411`	`407`	`$ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/alerts?namespace=test-thanos-querier-tenancy-rules-monitoring-rules-edit"`
`412`	`408`	`----`
`413`		`-`
`414`	`409`	`+`
`415`	`410`	The following example exercises permissions granted by the `monitoring-edit` cluster role. The binding commands must be run by a user with the necessary privileges.
`416`	`411`	`+`
`@@ -431,7 +426,6 @@ $ TOKEN=$(oc create token thanos-client --namespace=test-thanos-querier-tenancy-`
`431`	`426`	`$ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/rules?namespace=test-thanos-querier-tenancy-rules-monitoring-edit"`
`432`	`427`	`$ curl -k -f -H "Authorization: Bearer $TOKEN" "https://thanos-querier.openshift-monitoring:9093/api/v1/alerts?namespace=test-thanos-querier-tenancy-rules-monitoring-edit"`
`433`	`428`	`----`
`434`		`-`
`435`	`429`	`+`
`436`	`430`	The following example exercises permissions granted by the `monitoring-rules-view` cluster role. The binding commands must be run by a user with the necessary privileges.
`437`	`431`	`+`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ func (f markdownFormatter) formatTest(description, commands string) string {`
`86`	`86`	`sb.WriteString("\n\n")`
`87`	`87`	`sb.WriteString(commands)`
`88`	`88`	`sb.WriteString("\n")`
`89`		- sb.WriteString("```\n")
	`89`	+ sb.WriteString("```")
`90`	`90`	`return sb.String()`
`91`	`91`	`}`
`92`	`92`
`@@ -99,7 +99,7 @@ func (f asciidocFormatter) formatTest(description, commands string) string {`
`99`	`99`	`sb.WriteString("\n+\n")`
`100`	`100`	`sb.WriteString("[source,terminal]\n----\n")`
`101`	`101`	`sb.WriteString(commands)`
`102`		`- sb.WriteString("\n----\n")`
	`102`	`+ sb.WriteString("\n----")`
`103`	`103`	`return sb.String()`
`104`	`104`	`}`
`105`	`105`
`@@ -109,7 +109,7 @@ func (suite *Suite) format(f formatter) string {`
`109`	`109`	`description, commands := t.parse()`
`110`	`110`	`tests[i] = f.formatTest(description, formatCommands(commands))`
`111`	`111`	`}`
`112`		`- return strings.Join(tests, "\n")`
	`112`	`+ return strings.Join(tests, "\n") + "\n"`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`func (suite *Suite) StringMarkdown() string {`