714-rules-to-aos--AvoidLinkHeadersRule #763
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,32 @@ | ||
| package de.zalando.zally.rule.zalando | ||
|
|
||
| import com.typesafe.config.Config | ||
| import de.zalando.zally.rule.Context | ||
| import de.zalando.zally.rule.HttpHeadersRule | ||
| import de.zalando.zally.rule.api.Check | ||
| import de.zalando.zally.rule.api.Rule | ||
| import de.zalando.zally.rule.api.Severity | ||
| import de.zalando.zally.rule.api.Violation | ||
| import de.zalando.zally.util.getAllHeaders | ||
| import org.springframework.beans.factory.annotation.Autowired | ||
|
|
||
| @Rule( | ||
| ruleSet = ZalandoRuleSet::class, | ||
| id = "166", | ||
| severity = Severity.MUST, | ||
| title = "Avoid Link in Header Rule" | ||
| ) | ||
| class AvoidLinkHeadersRule(@Autowired rulesConfig: Config) { | ||
|
|
||
| private val headersWhitelist = rulesConfig.getStringList(HttpHeadersRule::class.simpleName + ".whitelist").toSet() | ||
|
|
||
| private val description = "Do Not Use Link Headers with JSON entities" | ||
|
|
||
| @Check(severity = Severity.MUST) | ||
| fun validate(context: Context): List<Violation> { | ||
| val allHeaders = context.api.getAllHeaders() | ||
| return allHeaders | ||
| .filter { it.name !in headersWhitelist && it.name == "Link" } | ||
| .map { context.violation(description, it.element) } // createViolation(context, it) } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| package de.zalando.zally.util | ||
|
|
||
| import io.swagger.v3.oas.models.OpenAPI | ||
| import io.swagger.v3.oas.models.parameters.Parameter | ||
| import io.swagger.v3.oas.models.responses.ApiResponse | ||
|
|
||
| data class HeaderElement( | ||
| val name: String, | ||
| val element: Any | ||
| ) | ||
|
|
||
| fun OpenAPI.getAllHeaders(): Set<HeaderElement> { | ||
|
|
||
| fun Collection<Parameter>?.extractHeaders() = orEmpty() | ||
| .filter { it.`in` == "header" } | ||
| .map { HeaderElement(it.name, it) } | ||
| .toSet() | ||
|
|
||
| fun Collection<ApiResponse>?.extractHeaders() = orEmpty() | ||
| .flatMap { it.headers.orEmpty().entries } | ||
| .map { HeaderElement(it.key, it.value) } | ||
| .toSet() | ||
|
|
||
| val fromParams = components.parameters.orEmpty().values.extractHeaders() | ||
|
|
||
| val fromPaths = paths.orEmpty().flatMap { (_, path) -> | ||
| val fromPathParameters = path.parameters.extractHeaders() | ||
| val fromOperations = path.readOperations().flatMap { operation -> | ||
| val fromOpParams = operation.parameters.extractHeaders() | ||
| val fromOpResponses = operation.responses.orEmpty().values.extractHeaders() | ||
| fromOpParams + fromOpResponses | ||
| } | ||
| fromPathParameters + fromOperations | ||
| } | ||
|
|
||
| return fromParams + fromPaths | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,135 @@ | ||
| package de.zalando.zally.rule.zalando | ||
|
|
||
| import de.zalando.zally.rule.Context | ||
| import de.zalando.zally.rule.ZallyAssertions.Companion.assertThat | ||
| import de.zalando.zally.testConfig | ||
| import org.intellij.lang.annotations.Language | ||
| import org.junit.Test | ||
|
|
||
| class AvoidLinkHeadersRuleTest { | ||
|
|
||
| private val rule = AvoidLinkHeadersRule(testConfig) | ||
|
|
||
| @Test | ||
| fun `a Swagger API with no header called Link produces no violation`() { | ||
| @Language("YAML") | ||
| val context = Context.createSwaggerContext(""" | ||
| swagger: 2.0 | ||
| info: | ||
| title: Clean Swagger API | ||
| paths: | ||
| /foo: | ||
| get: | ||
| description: Lorem Ipsum | ||
| responses: | ||
| 202: | ||
| description: Lorem Ipsum | ||
| headers: | ||
| Location: # should not violate since not called `Link` | ||
| type: string | ||
| format: url | ||
| parameters: | ||
| FlowId: # should not violate since not named `Link` | ||
| name: X-Flow-Id | ||
| in: header | ||
| type: string | ||
| Link: # should not violate since not a header | ||
| name: Link | ||
| in: query | ||
| type: string | ||
| ProductId: # should not violate since not a header nor named `Link` | ||
| name: product_id | ||
| in: path | ||
| type: string | ||
| """.trimIndent(), failOnParseErrors = true)!! | ||
| val violations = rule.validate(context) | ||
| assertThat(violations).isEmpty() | ||
| } | ||
|
|
||
| @Test | ||
| fun `an OpenAPI 3 API with no header called Link produces no violation`() { | ||
| @Language("YAML") | ||
| val context = Context.createOpenApiContext(""" | ||
| openapi: 3.0.0 | ||
| info: | ||
| title: Clean Swagger API | ||
| version: 1.0.0 | ||
| paths: | ||
| /foo: | ||
| get: | ||
| description: Lorem Ipsum | ||
| responses: | ||
| 202: | ||
| description: Lorem Ipsum | ||
| headers: | ||
| Location: | ||
| schema: | ||
| type: string | ||
| format: url | ||
| components: | ||
| parameters: | ||
| FlowId: | ||
| name: X-Flow-Id | ||
| in: header | ||
| required: false | ||
| schema: | ||
| type: string | ||
| Authorization: | ||
| name: Authorization | ||
| in: header | ||
| required: true | ||
| schema: | ||
| type: string | ||
| ProductId: | ||
| name: product_id | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| """.trimIndent(), failOnParseErrors = true)!! | ||
| val violations = rule.validate(context) | ||
| assertThat(violations).isEmpty() | ||
| } | ||
|
|
||
| @Test | ||
| fun `an API with Link headers causes violations`() { | ||
| @Language("YAML") | ||
| val context = Context.createSwaggerContext(""" | ||
| swagger: 2.0 | ||
| info: | ||
| title: Clean Swagger API | ||
| paths: | ||
| /foo: | ||
| get: | ||
| parameters: | ||
| - name: Authorization | ||
| in: header | ||
| type: string | ||
| - name: Link | ||
| in: header | ||
| type: string | ||
| responses: | ||
| 202: | ||
| description: Lorem Ipsum | ||
| headers: | ||
| Location: | ||
| type: string | ||
| format: url | ||
| post: | ||
| responses: | ||
| 202: | ||
| description: Lorem Ipsum | ||
| headers: | ||
| Link: | ||
| type: string | ||
| format: url | ||
| """.trimIndent(), failOnParseErrors = true)!! | ||
| val violations = rule.validate(context) | ||
| assertThat(violations) | ||
| .descriptionsAllEqualTo("Do Not Use Link Headers with JSON entities") | ||
| .pointersEqualTo( | ||
| "/paths/~1foo/get/parameters/1", | ||
| "/paths/~1foo/post/responses/202/headers/Link" | ||
| ) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can have an even smaller example, like:
BTW, the
parametersare wrongly intended in your example (should be underget:).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Those parameters are for all of the API, not just for that path/verb.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wanted the example to include:
to make sure the test does not return false negatives.
I can remove one of the header parameter for shortening it.
I can also add one that is called
Linkbut is not a header, again to shield against false negatives in the test.