|
| 1 | +package rules_test |
| 2 | + |
| 3 | +import ( |
| 4 | + "testing" |
| 5 | + |
| 6 | + "github.com/speakeasy-api/openapi/linter" |
| 7 | + "github.com/speakeasy-api/openapi/openapi" |
| 8 | + "github.com/speakeasy-api/openapi/openapi/linter/rules" |
| 9 | + "github.com/stretchr/testify/assert" |
| 10 | +) |
| 11 | + |
| 12 | +// howToFixer is the interface satisfied by rules that provide fix guidance. |
| 13 | +type howToFixer interface { |
| 14 | + HowToFix() string |
| 15 | +} |
| 16 | + |
| 17 | +// allRules returns every built-in rule instance. |
| 18 | +func allRules() []linter.RuleRunner[*openapi.OpenAPI] { |
| 19 | + return []linter.RuleRunner[*openapi.OpenAPI]{ |
| 20 | + &rules.PathParamsRule{}, |
| 21 | + &rules.PathDeclarationsRule{}, |
| 22 | + &rules.PathQueryRule{}, |
| 23 | + &rules.TypedEnumRule{}, |
| 24 | + &rules.DuplicatedEnumRule{}, |
| 25 | + &rules.NoEvalInMarkdownRule{}, |
| 26 | + &rules.OAS3APIServersRule{}, |
| 27 | + &rules.NoRefSiblingsRule{}, |
| 28 | + &rules.NoScriptTagsInMarkdownRule{}, |
| 29 | + &rules.OAS3HostNotExampleRule{}, |
| 30 | + &rules.OperationIdRule{}, |
| 31 | + &rules.OperationSuccessResponseRule{}, |
| 32 | + &rules.OperationErrorResponseRule{}, |
| 33 | + &rules.OperationTagDefinedRule{}, |
| 34 | + &rules.OperationSingularTagRule{}, |
| 35 | + &rules.OperationDescriptionRule{}, |
| 36 | + &rules.OperationTagsRule{}, |
| 37 | + &rules.InfoDescriptionRule{}, |
| 38 | + &rules.InfoContactRule{}, |
| 39 | + &rules.InfoLicenseRule{}, |
| 40 | + &rules.LicenseURLRule{}, |
| 41 | + &rules.PathTrailingSlashRule{}, |
| 42 | + &rules.PathsKebabCaseRule{}, |
| 43 | + &rules.NoVerbsInPathRule{}, |
| 44 | + &rules.TagDescriptionRule{}, |
| 45 | + &rules.TagsAlphabeticalRule{}, |
| 46 | + &rules.ContactPropertiesRule{}, |
| 47 | + &rules.OpenAPITagsRule{}, |
| 48 | + &rules.ComponentDescriptionRule{}, |
| 49 | + &rules.UnusedComponentRule{}, |
| 50 | + &rules.OperationIDValidInURLRule{}, |
| 51 | + &rules.LinkOperationRule{}, |
| 52 | + &rules.OAS3HostTrailingSlashRule{}, |
| 53 | + &rules.OAS3ParameterDescriptionRule{}, |
| 54 | + &rules.NoAmbiguousPathsRule{}, |
| 55 | + &rules.DescriptionDuplicationRule{}, |
| 56 | + &rules.OwaspNoHttpBasicRule{}, |
| 57 | + &rules.OwaspNoAPIKeysInURLRule{}, |
| 58 | + &rules.OwaspNoCredentialsInURLRule{}, |
| 59 | + &rules.OwaspAuthInsecureSchemesRule{}, |
| 60 | + &rules.OwaspDefineErrorResponses401Rule{}, |
| 61 | + &rules.OwaspDefineErrorResponses500Rule{}, |
| 62 | + &rules.OwaspDefineErrorResponses429Rule{}, |
| 63 | + &rules.OwaspSecurityHostsHttpsOAS3Rule{}, |
| 64 | + &rules.OwaspDefineErrorValidationRule{}, |
| 65 | + &rules.OwaspProtectionGlobalUnsafeRule{}, |
| 66 | + &rules.OwaspProtectionGlobalUnsafeStrictRule{}, |
| 67 | + &rules.OwaspProtectionGlobalSafeRule{}, |
| 68 | + &rules.OwaspRateLimitRule{}, |
| 69 | + &rules.OwaspRateLimitRetryAfterRule{}, |
| 70 | + &rules.OwaspNoNumericIDsRule{}, |
| 71 | + &rules.OwaspJWTBestPracticesRule{}, |
| 72 | + &rules.OwaspArrayLimitRule{}, |
| 73 | + &rules.OwaspStringLimitRule{}, |
| 74 | + &rules.OwaspStringRestrictedRule{}, |
| 75 | + &rules.OwaspIntegerFormatRule{}, |
| 76 | + &rules.OwaspIntegerLimitRule{}, |
| 77 | + &rules.OwaspNoAdditionalPropertiesRule{}, |
| 78 | + &rules.OwaspAdditionalPropertiesConstrainedRule{}, |
| 79 | + &rules.OAS3NoNullableRule{}, |
| 80 | + &rules.OAS3ExampleMissingRule{}, |
| 81 | + &rules.OASSchemaCheckRule{}, |
| 82 | + } |
| 83 | +} |
| 84 | + |
| 85 | +func TestAllRules_MetadataPopulated(t *testing.T) { |
| 86 | + t.Parallel() |
| 87 | + |
| 88 | + for _, rule := range allRules() { |
| 89 | + t.Run(rule.ID(), func(t *testing.T) { |
| 90 | + t.Parallel() |
| 91 | + |
| 92 | + assert.NotEmpty(t, rule.ID(), "rule ID should not be empty") |
| 93 | + assert.NotEmpty(t, rule.Category(), "rule category should not be empty") |
| 94 | + assert.NotEmpty(t, rule.Description(), "rule description should not be empty") |
| 95 | + assert.NotEmpty(t, rule.Summary(), "rule summary should not be empty") |
| 96 | + assert.NotEmpty(t, rule.DefaultSeverity(), "rule default severity should not be empty") |
| 97 | + |
| 98 | + if fixer, ok := rule.(howToFixer); ok { |
| 99 | + assert.NotEmpty(t, fixer.HowToFix(), "rule HowToFix should not be empty") |
| 100 | + } |
| 101 | + }) |
| 102 | + } |
| 103 | +} |
0 commit comments