@redocly/openapi-core 1.0.0-rc.3 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/__tests__/utils.ts +88 -0
- package/lib/config/all.js +0 -1
- package/lib/config/minimal.js +0 -1
- package/lib/config/recommended.js +0 -1
- package/package.json +1 -1
- package/src/__tests__/__snapshots__/bundle.test.ts.snap +437 -0
- package/src/__tests__/bundle.test.ts +236 -0
- package/src/__tests__/codeframes.test.ts +530 -0
- package/src/__tests__/fixtures/.redocly.lint-ignore.yaml +5 -0
- package/src/__tests__/fixtures/extension.js +24 -0
- package/src/__tests__/fixtures/refs/definitions.yaml +3 -0
- package/src/__tests__/fixtures/refs/examples.yaml +8 -0
- package/src/__tests__/fixtures/refs/external-request-body.yaml +13 -0
- package/src/__tests__/fixtures/refs/externalref.yaml +35 -0
- package/src/__tests__/fixtures/refs/hosted.yaml +35 -0
- package/src/__tests__/fixtures/refs/openapi-with-external-refs-conflicting-names.yaml +21 -0
- package/src/__tests__/fixtures/refs/openapi-with-external-refs.yaml +33 -0
- package/src/__tests__/fixtures/refs/openapi-with-url-refs.yaml +18 -0
- package/src/__tests__/fixtures/refs/param-b.yaml +1 -0
- package/src/__tests__/fixtures/refs/param-c.yaml +1 -0
- package/src/__tests__/fixtures/refs/rename.yaml +1 -0
- package/src/__tests__/fixtures/refs/requestBody.yaml +9 -0
- package/src/__tests__/fixtures/refs/schema-a.yaml +1 -0
- package/src/__tests__/fixtures/refs/simple.yaml +1 -0
- package/src/__tests__/fixtures/refs/vendor.schema.yaml +20 -0
- package/src/__tests__/fixtures/resolve/External.yaml +10 -0
- package/src/__tests__/fixtures/resolve/External2.yaml +4 -0
- package/src/__tests__/fixtures/resolve/description.md +3 -0
- package/src/__tests__/fixtures/resolve/externalInfo.yaml +4 -0
- package/src/__tests__/fixtures/resolve/externalLicense.yaml +1 -0
- package/src/__tests__/fixtures/resolve/openapi-with-back.yaml +13 -0
- package/src/__tests__/fixtures/resolve/openapi-with-md-description.yaml +5 -0
- package/src/__tests__/fixtures/resolve/openapi.yaml +28 -0
- package/src/__tests__/fixtures/resolve/schemas/type-a.yaml +10 -0
- package/src/__tests__/fixtures/resolve/schemas/type-b.yaml +6 -0
- package/src/__tests__/fixtures/resolve/transitive/a.yaml +1 -0
- package/src/__tests__/fixtures/resolve/transitive/components.yaml +5 -0
- package/src/__tests__/fixtures/resolve/transitive/schemas.yaml +3 -0
- package/src/__tests__/format.test.ts +76 -0
- package/src/__tests__/js-yaml.test.ts +73 -0
- package/src/__tests__/lint.test.ts +392 -0
- package/src/__tests__/logger-browser.test.ts +53 -0
- package/src/__tests__/logger.test.ts +47 -0
- package/src/__tests__/login.test.ts +17 -0
- package/src/__tests__/normalizeVisitors.test.ts +151 -0
- package/src/__tests__/output-browser.test.ts +18 -0
- package/src/__tests__/output.test.ts +15 -0
- package/src/__tests__/ref-utils.test.ts +120 -0
- package/src/__tests__/resolve-http.test.ts +77 -0
- package/src/__tests__/resolve.test.ts +431 -0
- package/src/__tests__/utils-browser.test.ts +11 -0
- package/src/__tests__/utils.test.ts +144 -0
- package/src/__tests__/walk.test.ts +1545 -0
- package/src/benchmark/benches/lint-with-many-rules.bench.ts +35 -0
- package/src/benchmark/benches/lint-with-nested-rule.bench.ts +39 -0
- package/src/benchmark/benches/lint-with-no-rules.bench.ts +20 -0
- package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts +35 -0
- package/src/benchmark/benches/lint-with-top-level-rule.bench.ts +32 -0
- package/src/benchmark/benches/rebilly.yaml +32275 -0
- package/src/benchmark/benches/recommended-oas3.bench.ts +22 -0
- package/src/benchmark/benches/resolve-with-no-external.bench.ts +23 -0
- package/src/benchmark/benchmark.js +311 -0
- package/src/benchmark/colors.js +29 -0
- package/src/benchmark/fork.js +83 -0
- package/src/benchmark/utils.ts +36 -0
- package/src/bundle.ts +417 -0
- package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap +164 -0
- package/src/config/__tests__/__snapshots__/config.test.ts.snap +144 -0
- package/src/config/__tests__/config-resolvers.test.ts +491 -0
- package/src/config/__tests__/config.test.ts +312 -0
- package/src/config/__tests__/fixtures/ingore-file.ts +8 -0
- package/src/config/__tests__/fixtures/load-redocly.yaml +2 -0
- package/src/config/__tests__/fixtures/plugin-config.yaml +2 -0
- package/src/config/__tests__/fixtures/plugin.js +56 -0
- package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml +11 -0
- package/src/config/__tests__/fixtures/resolve-config/api/plugin.js +69 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml +7 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-custom-function.yaml +17 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml +18 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-wrong-custom-function.yaml +15 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config.yaml +9 -0
- package/src/config/__tests__/fixtures/resolve-config/plugin.js +80 -0
- package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml +3 -0
- package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml +4 -0
- package/src/config/__tests__/load.test.ts +167 -0
- package/src/config/__tests__/resolve-plugins.test.ts +27 -0
- package/src/config/__tests__/utils.test.ts +204 -0
- package/src/config/all.ts +74 -0
- package/src/config/builtIn.ts +37 -0
- package/src/config/config-resolvers.ts +474 -0
- package/src/config/config.ts +332 -0
- package/src/config/index.ts +7 -0
- package/src/config/load.ts +144 -0
- package/src/config/minimal.ts +61 -0
- package/src/config/recommended.ts +61 -0
- package/src/config/rules.ts +54 -0
- package/src/config/types.ts +231 -0
- package/src/config/utils.ts +349 -0
- package/src/decorators/__tests__/filter-in.test.ts +310 -0
- package/src/decorators/__tests__/filter-out.test.ts +335 -0
- package/src/decorators/__tests__/media-type-examples-override.test.ts +665 -0
- package/src/decorators/__tests__/remove-x-internal.test.ts +316 -0
- package/src/decorators/__tests__/resources/request.yaml +3 -0
- package/src/decorators/__tests__/resources/response.yaml +3 -0
- package/src/decorators/common/filters/filter-helper.ts +72 -0
- package/src/decorators/common/filters/filter-in.ts +18 -0
- package/src/decorators/common/filters/filter-out.ts +18 -0
- package/src/decorators/common/info-description-override.ts +24 -0
- package/src/decorators/common/info-override.ts +15 -0
- package/src/decorators/common/media-type-examples-override.ts +79 -0
- package/src/decorators/common/operation-description-override.ts +30 -0
- package/src/decorators/common/registry-dependencies.ts +25 -0
- package/src/decorators/common/remove-x-internal.ts +59 -0
- package/src/decorators/common/tag-description-override.ts +25 -0
- package/src/decorators/oas2/index.ts +20 -0
- package/src/decorators/oas3/index.ts +22 -0
- package/src/env.ts +5 -0
- package/src/format/codeframes.ts +216 -0
- package/src/format/format.ts +375 -0
- package/src/index.ts +71 -0
- package/src/js-yaml/index.ts +14 -0
- package/src/lint.ts +148 -0
- package/src/logger.ts +34 -0
- package/src/oas-types.ts +57 -0
- package/src/output.ts +7 -0
- package/src/redocly/__tests__/redocly-client.test.ts +146 -0
- package/src/redocly/index.ts +187 -0
- package/src/redocly/redocly-client-types.ts +10 -0
- package/src/redocly/registry-api-types.ts +32 -0
- package/src/redocly/registry-api.ts +150 -0
- package/src/ref-utils.ts +85 -0
- package/src/resolve.ts +417 -0
- package/src/rules/__tests__/fixtures/code-sample.php +9 -0
- package/src/rules/__tests__/fixtures/invalid-yaml.yaml +1 -0
- package/src/rules/__tests__/fixtures/ref.yaml +1 -0
- package/src/rules/__tests__/no-unresolved-refs.test.ts +257 -0
- package/src/rules/__tests__/utils.test.ts +160 -0
- package/src/rules/ajv.ts +102 -0
- package/src/rules/common/__tests__/info-license.test.ts +62 -0
- package/src/rules/common/__tests__/license-url.test.ts +63 -0
- package/src/rules/common/__tests__/no-ambiguous-paths.test.ts +96 -0
- package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts +210 -0
- package/src/rules/common/__tests__/no-identical-paths.test.ts +58 -0
- package/src/rules/common/__tests__/no-path-trailing-slash.test.ts +85 -0
- package/src/rules/common/__tests__/operation-2xx-response.test.ts +192 -0
- package/src/rules/common/__tests__/operation-4xx-response.test.ts +231 -0
- package/src/rules/common/__tests__/operation-operationId-unique.test.ts +76 -0
- package/src/rules/common/__tests__/operation-operationId-url-safe.test.ts +45 -0
- package/src/rules/common/__tests__/operation-parameters-unique.test.ts +167 -0
- package/src/rules/common/__tests__/operation-singular-tag.test.ts +72 -0
- package/src/rules/common/__tests__/path-http-verbs-order.test.ts +95 -0
- package/src/rules/common/__tests__/path-not-include-query.test.ts +64 -0
- package/src/rules/common/__tests__/path-params-defined.test.ts +202 -0
- package/src/rules/common/__tests__/paths-kebab-case.test.ts +108 -0
- package/src/rules/common/__tests__/scalar-property-missing-example.test.ts +264 -0
- package/src/rules/common/__tests__/security-defined.test.ts +175 -0
- package/src/rules/common/__tests__/spec-strict-refs.test.ts +69 -0
- package/src/rules/common/__tests__/spec.test.ts +610 -0
- package/src/rules/common/__tests__/tag-description.test.ts +65 -0
- package/src/rules/common/__tests__/tags-alphabetical.test.ts +64 -0
- package/src/rules/common/assertions/__tests__/asserts.test.ts +869 -0
- package/src/rules/common/assertions/__tests__/index.test.ts +100 -0
- package/src/rules/common/assertions/__tests__/utils.test.ts +236 -0
- package/src/rules/common/assertions/asserts.ts +357 -0
- package/src/rules/common/assertions/index.ts +53 -0
- package/src/rules/common/assertions/utils.ts +331 -0
- package/src/rules/common/info-contact.ts +15 -0
- package/src/rules/common/info-license-url.ts +10 -0
- package/src/rules/common/info-license.ts +15 -0
- package/src/rules/common/no-ambiguous-paths.ts +50 -0
- package/src/rules/common/no-enum-type-mismatch.ts +52 -0
- package/src/rules/common/no-http-verbs-in-paths.ts +36 -0
- package/src/rules/common/no-identical-paths.ts +24 -0
- package/src/rules/common/no-invalid-parameter-examples.ts +36 -0
- package/src/rules/common/no-invalid-schema-examples.ts +27 -0
- package/src/rules/common/no-path-trailing-slash.ts +15 -0
- package/src/rules/common/operation-2xx-response.ts +24 -0
- package/src/rules/common/operation-4xx-response.ts +24 -0
- package/src/rules/common/operation-description.ts +13 -0
- package/src/rules/common/operation-operationId-unique.ts +21 -0
- package/src/rules/common/operation-operationId-url-safe.ts +19 -0
- package/src/rules/common/operation-operationId.ts +17 -0
- package/src/rules/common/operation-parameters-unique.ts +48 -0
- package/src/rules/common/operation-singular-tag.ts +17 -0
- package/src/rules/common/operation-summary.ts +13 -0
- package/src/rules/common/operation-tag-defined.ts +26 -0
- package/src/rules/common/parameter-description.ts +22 -0
- package/src/rules/common/path-declaration-must-exist.ts +15 -0
- package/src/rules/common/path-excludes-patterns.ts +23 -0
- package/src/rules/common/path-http-verbs-order.ts +30 -0
- package/src/rules/common/path-not-include-query.ts +17 -0
- package/src/rules/common/path-params-defined.ts +65 -0
- package/src/rules/common/path-segment-plural.ts +31 -0
- package/src/rules/common/paths-kebab-case.ts +19 -0
- package/src/rules/common/required-string-property-missing-min-length.ts +44 -0
- package/src/rules/common/response-contains-header.ts +35 -0
- package/src/rules/common/scalar-property-missing-example.ts +58 -0
- package/src/rules/common/security-defined.ts +65 -0
- package/src/rules/common/spec-strict-refs.ts +30 -0
- package/src/rules/common/spec.ts +175 -0
- package/src/rules/common/tag-description.ts +10 -0
- package/src/rules/common/tags-alphabetical.ts +20 -0
- package/src/rules/no-unresolved-refs.ts +51 -0
- package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts +110 -0
- package/src/rules/oas2/__tests__/response-contains-header.test.ts +174 -0
- package/src/rules/oas2/__tests__/response-contains-property.test.ts +155 -0
- package/src/rules/oas2/__tests__/spec/fixtures/description.md +1 -0
- package/src/rules/oas2/__tests__/spec/info.test.ts +355 -0
- package/src/rules/oas2/__tests__/spec/operation.test.ts +123 -0
- package/src/rules/oas2/__tests__/spec/paths.test.ts +245 -0
- package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts +35 -0
- package/src/rules/oas2/__tests__/spec/utils.ts +32 -0
- package/src/rules/oas2/boolean-parameter-prefixes.ts +26 -0
- package/src/rules/oas2/index.ts +91 -0
- package/src/rules/oas2/remove-unused-components.ts +81 -0
- package/src/rules/oas2/request-mime-type.ts +16 -0
- package/src/rules/oas2/response-contains-property.ts +36 -0
- package/src/rules/oas2/response-mime-type.ts +16 -0
- package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts +111 -0
- package/src/rules/oas3/__tests__/component-name-unique.test.ts +823 -0
- package/src/rules/oas3/__tests__/fixtures/common.yaml +11 -0
- package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts +205 -0
- package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts +65 -0
- package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts +473 -0
- package/src/rules/oas3/__tests__/no-server-example.com.test.ts +60 -0
- package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts +79 -0
- package/src/rules/oas3/__tests__/no-unused-components.test.ts +131 -0
- package/src/rules/oas3/__tests__/operation-4xx-problem-details-rfc7807.test.ts +145 -0
- package/src/rules/oas3/__tests__/response-contains-header.test.ts +389 -0
- package/src/rules/oas3/__tests__/response-contains-property.test.ts +403 -0
- package/src/rules/oas3/__tests__/spec/callbacks.test.ts +41 -0
- package/src/rules/oas3/__tests__/spec/fixtures/description.md +1 -0
- package/src/rules/oas3/__tests__/spec/info.test.ts +391 -0
- package/src/rules/oas3/__tests__/spec/operation.test.ts +253 -0
- package/src/rules/oas3/__tests__/spec/paths.test.ts +284 -0
- package/src/rules/oas3/__tests__/spec/referenceableScalars.test.ts +77 -0
- package/src/rules/oas3/__tests__/spec/servers.test.ts +505 -0
- package/src/rules/oas3/__tests__/spec/spec.test.ts +298 -0
- package/src/rules/oas3/__tests__/spec/utils.ts +32 -0
- package/src/rules/oas3/__tests__/spec-components-invalid-map-name.test.ts +276 -0
- package/src/rules/oas3/__tests__/utils/lint-document-for-test.ts +23 -0
- package/src/rules/oas3/boolean-parameter-prefixes.ts +28 -0
- package/src/rules/oas3/component-name-unique.ts +158 -0
- package/src/rules/oas3/index.ts +113 -0
- package/src/rules/oas3/no-empty-servers.ts +22 -0
- package/src/rules/oas3/no-example-value-and-externalValue.ts +14 -0
- package/src/rules/oas3/no-invalid-media-type-examples.ts +49 -0
- package/src/rules/oas3/no-server-example.com.ts +14 -0
- package/src/rules/oas3/no-server-trailing-slash.ts +15 -0
- package/src/rules/oas3/no-server-variables-empty-enum.ts +66 -0
- package/src/rules/oas3/no-undefined-server-variable.ts +30 -0
- package/src/rules/oas3/no-unused-components.ts +75 -0
- package/src/rules/oas3/operation-4xx-problem-details-rfc7807.ts +35 -0
- package/src/rules/oas3/remove-unused-components.ts +95 -0
- package/src/rules/oas3/request-mime-type.ts +30 -0
- package/src/rules/oas3/response-contains-property.ts +38 -0
- package/src/rules/oas3/response-mime-type.ts +30 -0
- package/src/rules/oas3/spec-components-invalid-map-name.ts +69 -0
- package/src/rules/other/stats.ts +73 -0
- package/src/rules/utils.ts +193 -0
- package/src/types/config-external-schemas.ts +917 -0
- package/src/types/index.ts +149 -0
- package/src/types/oas2.ts +478 -0
- package/src/types/oas3.ts +597 -0
- package/src/types/oas3_1.ts +258 -0
- package/src/types/redocly-yaml.ts +1040 -0
- package/src/typings/common.ts +17 -0
- package/src/typings/openapi.ts +298 -0
- package/src/typings/swagger.ts +236 -0
- package/src/utils.ts +276 -0
- package/src/visitors.ts +491 -0
- package/src/walk.ts +439 -0
- package/tsconfig.json +8 -0
- package/tsconfig.tsbuildinfo +1 -0
|
@@ -0,0 +1,869 @@
|
|
|
1
|
+
import { Location } from '../../../../ref-utils';
|
|
2
|
+
import { Source } from '../../../../resolve';
|
|
3
|
+
import { AssertionFnContext, Asserts, asserts, buildAssertCustomFunction } from '../asserts';
|
|
4
|
+
|
|
5
|
+
let baseLocation = new Location(jest.fn() as any as Source, 'pointer');
|
|
6
|
+
|
|
7
|
+
const assertionProperties = {
|
|
8
|
+
baseLocation: baseLocation,
|
|
9
|
+
} as AssertionFnContext;
|
|
10
|
+
|
|
11
|
+
describe('oas3 assertions', () => {
|
|
12
|
+
describe('generic rules', () => {
|
|
13
|
+
const fakeNode = {
|
|
14
|
+
foo: '',
|
|
15
|
+
bar: '',
|
|
16
|
+
baz: '',
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
describe('pattern', () => {
|
|
20
|
+
it('value should match regex pattern', () => {
|
|
21
|
+
expect(asserts.pattern('test string', '/test/', assertionProperties)).toEqual([]);
|
|
22
|
+
expect(asserts.pattern('test string', '/test me/', assertionProperties)).toEqual([
|
|
23
|
+
{ location: baseLocation, message: '"test string" should match a regex /test me/' },
|
|
24
|
+
]);
|
|
25
|
+
expect(asserts.pattern(['test string', 'test me'], '/test/', assertionProperties)).toEqual(
|
|
26
|
+
[]
|
|
27
|
+
);
|
|
28
|
+
expect(
|
|
29
|
+
asserts.pattern(['test string', 'test me'], '/test me/', assertionProperties)
|
|
30
|
+
).toEqual([
|
|
31
|
+
{
|
|
32
|
+
message: '"test string" should match a regex /test me/',
|
|
33
|
+
location: baseLocation.key(),
|
|
34
|
+
},
|
|
35
|
+
]);
|
|
36
|
+
expect(
|
|
37
|
+
asserts.pattern(
|
|
38
|
+
'./components/smth/test.yaml',
|
|
39
|
+
'/^(./)?components/.*.yaml$/',
|
|
40
|
+
assertionProperties
|
|
41
|
+
)
|
|
42
|
+
).toEqual([]);
|
|
43
|
+
expect(
|
|
44
|
+
asserts.pattern('./other.yaml', '/^(./)?components/.*.yaml$/', assertionProperties)
|
|
45
|
+
).toEqual([
|
|
46
|
+
{
|
|
47
|
+
message: '"./other.yaml" should match a regex /^(./)?components/.*.yaml$/',
|
|
48
|
+
location: baseLocation,
|
|
49
|
+
},
|
|
50
|
+
]);
|
|
51
|
+
});
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
describe('notPattern', () => {
|
|
55
|
+
it('value should not match regex pattern', () => {
|
|
56
|
+
expect(asserts.notPattern('test string', '/test me/', assertionProperties)).toEqual([]);
|
|
57
|
+
expect(asserts.notPattern('test string', '/test/', assertionProperties)).toEqual([
|
|
58
|
+
{ location: baseLocation, message: '"test string" should not match a regex /test/' },
|
|
59
|
+
]);
|
|
60
|
+
expect(
|
|
61
|
+
asserts.notPattern(['test string', 'test me'], '/test other/', assertionProperties)
|
|
62
|
+
).toEqual([]);
|
|
63
|
+
expect(
|
|
64
|
+
asserts.notPattern(['test string', 'test me'], '/test me/', assertionProperties)
|
|
65
|
+
).toEqual([
|
|
66
|
+
{
|
|
67
|
+
message: '"test me" should not match a regex /test me/',
|
|
68
|
+
location: baseLocation.key(),
|
|
69
|
+
},
|
|
70
|
+
]);
|
|
71
|
+
});
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
describe('ref', () => {
|
|
75
|
+
it('value should have ref', () => {
|
|
76
|
+
expect(
|
|
77
|
+
asserts.ref({ $ref: 'text' }, true, {
|
|
78
|
+
...assertionProperties,
|
|
79
|
+
rawValue: { $ref: 'text' },
|
|
80
|
+
})
|
|
81
|
+
).toEqual([]);
|
|
82
|
+
expect(asserts.ref({}, true, { ...assertionProperties, rawValue: {} })).toEqual([
|
|
83
|
+
{
|
|
84
|
+
message: 'should use $ref',
|
|
85
|
+
location: baseLocation.key(),
|
|
86
|
+
},
|
|
87
|
+
]);
|
|
88
|
+
});
|
|
89
|
+
|
|
90
|
+
it('value should not have ref', () => {
|
|
91
|
+
expect(
|
|
92
|
+
asserts.ref({ $ref: 'text' }, false, {
|
|
93
|
+
...assertionProperties,
|
|
94
|
+
rawValue: { $ref: 'text' },
|
|
95
|
+
})
|
|
96
|
+
).toEqual([
|
|
97
|
+
{
|
|
98
|
+
message: 'should not use $ref',
|
|
99
|
+
location: baseLocation,
|
|
100
|
+
},
|
|
101
|
+
]);
|
|
102
|
+
expect(asserts.ref({}, false, { ...assertionProperties, rawValue: {} })).toEqual([]);
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
it('value should match regex pattern', () => {
|
|
106
|
+
expect(
|
|
107
|
+
asserts.ref({ $ref: 'test string' }, '/test/', {
|
|
108
|
+
...assertionProperties,
|
|
109
|
+
rawValue: { $ref: 'test string' },
|
|
110
|
+
})
|
|
111
|
+
).toEqual([]);
|
|
112
|
+
expect(
|
|
113
|
+
asserts.ref({ $ref: 'test string' }, '/test me/', {
|
|
114
|
+
...assertionProperties,
|
|
115
|
+
rawValue: { $ref: 'text' },
|
|
116
|
+
})
|
|
117
|
+
).toEqual([{ message: '$ref value should match /test me/', location: baseLocation }]);
|
|
118
|
+
expect(
|
|
119
|
+
asserts.ref({ $ref: './components/smth/test.yaml' }, '/^(./)?components/.*.yaml$/', {
|
|
120
|
+
...assertionProperties,
|
|
121
|
+
rawValue: { $ref: './components/smth/test.yaml' },
|
|
122
|
+
})
|
|
123
|
+
).toEqual([]);
|
|
124
|
+
expect(
|
|
125
|
+
asserts.ref({ $ref: './paths/smth/test.yaml' }, '/^(./)?components/.*.yaml$/', {
|
|
126
|
+
...assertionProperties,
|
|
127
|
+
rawValue: { $ref: './paths/smth/test.yaml' },
|
|
128
|
+
})
|
|
129
|
+
).toEqual([
|
|
130
|
+
{
|
|
131
|
+
message: '$ref value should match /^(./)?components/.*.yaml$/',
|
|
132
|
+
location: baseLocation,
|
|
133
|
+
},
|
|
134
|
+
]);
|
|
135
|
+
});
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
describe('enum', () => {
|
|
139
|
+
it('value should be among predefined keys', () => {
|
|
140
|
+
expect(asserts.enum('test', ['test', 'example'], assertionProperties)).toEqual([]);
|
|
141
|
+
expect(asserts.enum(['test'], ['test', 'example'], assertionProperties)).toEqual([]);
|
|
142
|
+
expect(asserts.enum(['test', 'example'], ['test', 'example'], assertionProperties)).toEqual(
|
|
143
|
+
[]
|
|
144
|
+
);
|
|
145
|
+
expect(
|
|
146
|
+
asserts.enum(['test', 'example', 'foo'], ['test', 'example'], assertionProperties)
|
|
147
|
+
).toEqual([
|
|
148
|
+
{
|
|
149
|
+
message: '"foo" should be one of the predefined values',
|
|
150
|
+
location: baseLocation.child('foo').key(),
|
|
151
|
+
},
|
|
152
|
+
]);
|
|
153
|
+
expect(asserts.enum('test', ['foo', 'example'], assertionProperties)).toEqual([
|
|
154
|
+
{
|
|
155
|
+
message: '"test" should be one of the predefined values',
|
|
156
|
+
location: baseLocation,
|
|
157
|
+
},
|
|
158
|
+
]);
|
|
159
|
+
expect(asserts.enum(['test', 'foo'], ['test', 'example'], assertionProperties)).toEqual([
|
|
160
|
+
{
|
|
161
|
+
message: '"foo" should be one of the predefined values',
|
|
162
|
+
location: baseLocation.child('foo').key(),
|
|
163
|
+
},
|
|
164
|
+
]);
|
|
165
|
+
});
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
describe('defined', () => {
|
|
169
|
+
it('value should be defined', () => {
|
|
170
|
+
expect(asserts.defined('test', true, assertionProperties)).toEqual([]);
|
|
171
|
+
expect(asserts.defined(undefined, true, assertionProperties)).toEqual([
|
|
172
|
+
{
|
|
173
|
+
message: 'Should be defined',
|
|
174
|
+
location: baseLocation,
|
|
175
|
+
},
|
|
176
|
+
]);
|
|
177
|
+
});
|
|
178
|
+
it('value should be undefined', () => {
|
|
179
|
+
expect(asserts.defined(undefined, false, assertionProperties)).toEqual([]);
|
|
180
|
+
expect(asserts.defined('test', false, assertionProperties)).toEqual([
|
|
181
|
+
{
|
|
182
|
+
message: 'Should be not defined',
|
|
183
|
+
location: baseLocation,
|
|
184
|
+
},
|
|
185
|
+
]);
|
|
186
|
+
});
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
describe('undefined', () => {
|
|
190
|
+
it('value should be undefined', () => {
|
|
191
|
+
expect(asserts.undefined(undefined, true, assertionProperties)).toEqual([]);
|
|
192
|
+
expect(asserts.undefined('test', true, assertionProperties)).toEqual([
|
|
193
|
+
{
|
|
194
|
+
message: 'Should not be defined',
|
|
195
|
+
location: baseLocation,
|
|
196
|
+
},
|
|
197
|
+
]);
|
|
198
|
+
});
|
|
199
|
+
it('value should be defined', () => {
|
|
200
|
+
expect(asserts.undefined('test', false, assertionProperties)).toEqual([]);
|
|
201
|
+
expect(asserts.undefined(undefined, false, assertionProperties)).toEqual([
|
|
202
|
+
{
|
|
203
|
+
message: 'Should be defined',
|
|
204
|
+
location: baseLocation,
|
|
205
|
+
},
|
|
206
|
+
]);
|
|
207
|
+
});
|
|
208
|
+
});
|
|
209
|
+
|
|
210
|
+
describe('required', () => {
|
|
211
|
+
it('values should be required', () => {
|
|
212
|
+
expect(
|
|
213
|
+
asserts.required(['one', 'two', 'three'], ['one', 'two'], assertionProperties)
|
|
214
|
+
).toEqual([]);
|
|
215
|
+
expect(
|
|
216
|
+
asserts.required(['one', 'two'], ['one', 'two', 'three'], assertionProperties)
|
|
217
|
+
).toEqual([
|
|
218
|
+
{
|
|
219
|
+
message: 'three is required',
|
|
220
|
+
location: baseLocation.key(),
|
|
221
|
+
},
|
|
222
|
+
]);
|
|
223
|
+
});
|
|
224
|
+
});
|
|
225
|
+
|
|
226
|
+
describe('nonEmpty', () => {
|
|
227
|
+
it('value should not be empty', () => {
|
|
228
|
+
expect(asserts.nonEmpty('test', true, assertionProperties)).toEqual([]);
|
|
229
|
+
expect(asserts.nonEmpty('', true, assertionProperties)).toEqual([
|
|
230
|
+
{
|
|
231
|
+
message: 'Should not be empty',
|
|
232
|
+
location: baseLocation,
|
|
233
|
+
},
|
|
234
|
+
]);
|
|
235
|
+
expect(asserts.nonEmpty(null, true, assertionProperties)).toEqual([
|
|
236
|
+
{
|
|
237
|
+
message: 'Should not be empty',
|
|
238
|
+
location: baseLocation,
|
|
239
|
+
},
|
|
240
|
+
]);
|
|
241
|
+
expect(asserts.nonEmpty(undefined, true, assertionProperties)).toEqual([
|
|
242
|
+
{
|
|
243
|
+
message: 'Should not be empty',
|
|
244
|
+
location: baseLocation,
|
|
245
|
+
},
|
|
246
|
+
]);
|
|
247
|
+
});
|
|
248
|
+
it('value should be empty', () => {
|
|
249
|
+
expect(asserts.nonEmpty('', false, assertionProperties)).toEqual([]);
|
|
250
|
+
expect(asserts.nonEmpty(null, false, assertionProperties)).toEqual([]);
|
|
251
|
+
expect(asserts.nonEmpty(undefined, false, assertionProperties)).toEqual([]);
|
|
252
|
+
expect(asserts.nonEmpty('test', false, assertionProperties)).toEqual([
|
|
253
|
+
{
|
|
254
|
+
message: 'Should be empty',
|
|
255
|
+
location: baseLocation,
|
|
256
|
+
},
|
|
257
|
+
]);
|
|
258
|
+
});
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
describe('minLength', () => {
|
|
262
|
+
it('value should have less or equal than 5 symbols length', () => {
|
|
263
|
+
expect(asserts.minLength('test', 5, assertionProperties)).toEqual([
|
|
264
|
+
{
|
|
265
|
+
message: 'Should have at least 5 characters',
|
|
266
|
+
location: baseLocation,
|
|
267
|
+
},
|
|
268
|
+
]);
|
|
269
|
+
expect(asserts.minLength([1, 2, 3, 4], 5, assertionProperties)).toEqual([
|
|
270
|
+
{
|
|
271
|
+
message: 'Should have at least 5 characters',
|
|
272
|
+
location: baseLocation,
|
|
273
|
+
},
|
|
274
|
+
]);
|
|
275
|
+
expect(asserts.minLength([1, 2, 3, 4, 5], 5, assertionProperties)).toEqual([]);
|
|
276
|
+
expect(asserts.minLength([1, 2, 3, 4, 5, 6], 5, assertionProperties)).toEqual([]);
|
|
277
|
+
expect(asserts.minLength('example', 5, assertionProperties)).toEqual([]);
|
|
278
|
+
expect(asserts.minLength([], 5, assertionProperties)).toEqual([
|
|
279
|
+
{
|
|
280
|
+
message: 'Should have at least 5 characters',
|
|
281
|
+
location: baseLocation,
|
|
282
|
+
},
|
|
283
|
+
]);
|
|
284
|
+
expect(asserts.minLength('', 5, assertionProperties)).toEqual([
|
|
285
|
+
{
|
|
286
|
+
message: 'Should have at least 5 characters',
|
|
287
|
+
location: baseLocation,
|
|
288
|
+
},
|
|
289
|
+
]);
|
|
290
|
+
});
|
|
291
|
+
});
|
|
292
|
+
|
|
293
|
+
describe('maxLength', () => {
|
|
294
|
+
it('value should have more or equal than 5 symbols length', () => {
|
|
295
|
+
expect(asserts.maxLength('test', 5, assertionProperties)).toEqual([]);
|
|
296
|
+
expect(asserts.maxLength([1, 2, 3, 4], 5, assertionProperties)).toEqual([]);
|
|
297
|
+
expect(asserts.maxLength([1, 2, 3, 4, 5], 5, assertionProperties)).toEqual([]);
|
|
298
|
+
expect(asserts.maxLength([1, 2, 3, 4, 5, 6], 5, assertionProperties)).toEqual([
|
|
299
|
+
{
|
|
300
|
+
message: 'Should have at most 5 characters',
|
|
301
|
+
location: baseLocation,
|
|
302
|
+
},
|
|
303
|
+
]);
|
|
304
|
+
expect(asserts.maxLength('example', 5, assertionProperties)).toEqual([
|
|
305
|
+
{
|
|
306
|
+
message: 'Should have at most 5 characters',
|
|
307
|
+
location: baseLocation,
|
|
308
|
+
},
|
|
309
|
+
]);
|
|
310
|
+
expect(asserts.maxLength([], 5, assertionProperties)).toEqual([]);
|
|
311
|
+
expect(asserts.maxLength('', 5, assertionProperties)).toEqual([]);
|
|
312
|
+
});
|
|
313
|
+
});
|
|
314
|
+
|
|
315
|
+
describe('casing', () => {
|
|
316
|
+
it('value should be camelCase', () => {
|
|
317
|
+
expect(asserts.casing(['testExample', 'fooBar'], 'camelCase', assertionProperties)).toEqual(
|
|
318
|
+
[]
|
|
319
|
+
);
|
|
320
|
+
expect(asserts.casing(['testExample', 'FooBar'], 'camelCase', assertionProperties)).toEqual(
|
|
321
|
+
[
|
|
322
|
+
{
|
|
323
|
+
message: '"FooBar" should use camelCase',
|
|
324
|
+
location: baseLocation.child('FooBar').key(),
|
|
325
|
+
},
|
|
326
|
+
]
|
|
327
|
+
);
|
|
328
|
+
expect(asserts.casing('testExample', 'camelCase', assertionProperties)).toEqual([]);
|
|
329
|
+
expect(asserts.casing('TestExample', 'camelCase', assertionProperties)).toEqual([
|
|
330
|
+
{
|
|
331
|
+
message: '"TestExample" should use camelCase',
|
|
332
|
+
location: baseLocation,
|
|
333
|
+
},
|
|
334
|
+
]);
|
|
335
|
+
expect(asserts.casing('test-example', 'camelCase', assertionProperties)).toEqual([
|
|
336
|
+
{
|
|
337
|
+
message: '"test-example" should use camelCase',
|
|
338
|
+
location: baseLocation,
|
|
339
|
+
},
|
|
340
|
+
]);
|
|
341
|
+
expect(asserts.casing('test_example', 'camelCase', assertionProperties)).toEqual([
|
|
342
|
+
{
|
|
343
|
+
message: '"test_example" should use camelCase',
|
|
344
|
+
location: baseLocation,
|
|
345
|
+
},
|
|
346
|
+
]);
|
|
347
|
+
});
|
|
348
|
+
it('value should be PascalCase', () => {
|
|
349
|
+
expect(asserts.casing('TestExample', 'PascalCase', assertionProperties)).toEqual([]);
|
|
350
|
+
expect(
|
|
351
|
+
asserts.casing(['TestExample', 'FooBar'], 'PascalCase', assertionProperties)
|
|
352
|
+
).toEqual([]);
|
|
353
|
+
expect(
|
|
354
|
+
asserts.casing(['TestExample', 'fooBar'], 'PascalCase', assertionProperties)
|
|
355
|
+
).toEqual([
|
|
356
|
+
{
|
|
357
|
+
message: '"fooBar" should use PascalCase',
|
|
358
|
+
location: baseLocation.child('fooBar').key(),
|
|
359
|
+
},
|
|
360
|
+
]);
|
|
361
|
+
expect(asserts.casing('testExample', 'PascalCase', assertionProperties)).toEqual([
|
|
362
|
+
{
|
|
363
|
+
message: '"testExample" should use PascalCase',
|
|
364
|
+
location: baseLocation,
|
|
365
|
+
},
|
|
366
|
+
]);
|
|
367
|
+
expect(asserts.casing('test-example', 'PascalCase', assertionProperties)).toEqual([
|
|
368
|
+
{
|
|
369
|
+
message: '"test-example" should use PascalCase',
|
|
370
|
+
location: baseLocation,
|
|
371
|
+
},
|
|
372
|
+
]);
|
|
373
|
+
expect(asserts.casing('test_example', 'PascalCase', assertionProperties)).toEqual([
|
|
374
|
+
{
|
|
375
|
+
message: '"test_example" should use PascalCase',
|
|
376
|
+
location: baseLocation,
|
|
377
|
+
},
|
|
378
|
+
]);
|
|
379
|
+
});
|
|
380
|
+
it('value should be kebab-case', () => {
|
|
381
|
+
expect(asserts.casing('test-example', 'kebab-case', assertionProperties)).toEqual([]);
|
|
382
|
+
expect(
|
|
383
|
+
asserts.casing(['test-example', 'foo-bar'], 'kebab-case', assertionProperties)
|
|
384
|
+
).toEqual([]);
|
|
385
|
+
expect(
|
|
386
|
+
asserts.casing(['test-example', 'foo_bar'], 'kebab-case', assertionProperties)
|
|
387
|
+
).toEqual([
|
|
388
|
+
{
|
|
389
|
+
message: '"foo_bar" should use kebab-case',
|
|
390
|
+
location: baseLocation.child('foo_bar').key(),
|
|
391
|
+
},
|
|
392
|
+
]);
|
|
393
|
+
expect(asserts.casing('testExample', 'kebab-case', assertionProperties)).toEqual([
|
|
394
|
+
{
|
|
395
|
+
message: '"testExample" should use kebab-case',
|
|
396
|
+
location: baseLocation,
|
|
397
|
+
},
|
|
398
|
+
]);
|
|
399
|
+
expect(asserts.casing('TestExample', 'kebab-case', assertionProperties)).toEqual([
|
|
400
|
+
{
|
|
401
|
+
message: '"TestExample" should use kebab-case',
|
|
402
|
+
location: baseLocation,
|
|
403
|
+
},
|
|
404
|
+
]);
|
|
405
|
+
expect(asserts.casing('test_example', 'kebab-case', assertionProperties)).toEqual([
|
|
406
|
+
{
|
|
407
|
+
message: '"test_example" should use kebab-case',
|
|
408
|
+
location: baseLocation,
|
|
409
|
+
},
|
|
410
|
+
]);
|
|
411
|
+
});
|
|
412
|
+
it('value should be snake_case', () => {
|
|
413
|
+
expect(asserts.casing('test_example', 'snake_case', assertionProperties)).toEqual([]);
|
|
414
|
+
expect(
|
|
415
|
+
asserts.casing(['test_example', 'foo_bar'], 'snake_case', assertionProperties)
|
|
416
|
+
).toEqual([]);
|
|
417
|
+
expect(
|
|
418
|
+
asserts.casing(['test_example', 'foo-bar'], 'snake_case', assertionProperties)
|
|
419
|
+
).toEqual([
|
|
420
|
+
{
|
|
421
|
+
message: '"foo-bar" should use snake_case',
|
|
422
|
+
location: baseLocation.child('foo-bar').key(),
|
|
423
|
+
},
|
|
424
|
+
]);
|
|
425
|
+
expect(asserts.casing('testExample', 'snake_case', assertionProperties)).toEqual([
|
|
426
|
+
{
|
|
427
|
+
message: '"testExample" should use snake_case',
|
|
428
|
+
location: baseLocation,
|
|
429
|
+
},
|
|
430
|
+
]);
|
|
431
|
+
expect(asserts.casing('TestExample', 'snake_case', assertionProperties)).toEqual([
|
|
432
|
+
{
|
|
433
|
+
message: '"TestExample" should use snake_case',
|
|
434
|
+
location: baseLocation,
|
|
435
|
+
},
|
|
436
|
+
]);
|
|
437
|
+
expect(asserts.casing('test-example', 'snake_case', assertionProperties)).toEqual([
|
|
438
|
+
{
|
|
439
|
+
message: '"test-example" should use snake_case',
|
|
440
|
+
location: baseLocation,
|
|
441
|
+
},
|
|
442
|
+
]);
|
|
443
|
+
});
|
|
444
|
+
it('value should be MACRO_CASE', () => {
|
|
445
|
+
expect(asserts.casing('TEST_EXAMPLE', 'MACRO_CASE', assertionProperties)).toEqual([]);
|
|
446
|
+
expect(
|
|
447
|
+
asserts.casing(['TEST_EXAMPLE', 'FOO_BAR'], 'MACRO_CASE', assertionProperties)
|
|
448
|
+
).toEqual([]);
|
|
449
|
+
expect(
|
|
450
|
+
asserts.casing(['TEST_EXAMPLE', 'FOO-BAR'], 'MACRO_CASE', assertionProperties)
|
|
451
|
+
).toEqual([
|
|
452
|
+
{
|
|
453
|
+
message: '"FOO-BAR" should use MACRO_CASE',
|
|
454
|
+
location: baseLocation.child('FOO-BAR').key(),
|
|
455
|
+
},
|
|
456
|
+
]);
|
|
457
|
+
expect(asserts.casing('TEST_EXAMPLE_', 'MACRO_CASE', assertionProperties)).toEqual([
|
|
458
|
+
{
|
|
459
|
+
message: '"TEST_EXAMPLE_" should use MACRO_CASE',
|
|
460
|
+
location: baseLocation,
|
|
461
|
+
},
|
|
462
|
+
]);
|
|
463
|
+
expect(asserts.casing('_TEST_EXAMPLE', 'MACRO_CASE', assertionProperties)).toEqual([
|
|
464
|
+
{
|
|
465
|
+
message: '"_TEST_EXAMPLE" should use MACRO_CASE',
|
|
466
|
+
location: baseLocation,
|
|
467
|
+
},
|
|
468
|
+
]);
|
|
469
|
+
expect(asserts.casing('TEST__EXAMPLE', 'MACRO_CASE', assertionProperties)).toEqual([
|
|
470
|
+
{
|
|
471
|
+
message: '"TEST__EXAMPLE" should use MACRO_CASE',
|
|
472
|
+
location: baseLocation,
|
|
473
|
+
},
|
|
474
|
+
]);
|
|
475
|
+
expect(asserts.casing('TEST-EXAMPLE', 'MACRO_CASE', assertionProperties)).toEqual([
|
|
476
|
+
{
|
|
477
|
+
message: '"TEST-EXAMPLE" should use MACRO_CASE',
|
|
478
|
+
location: baseLocation,
|
|
479
|
+
},
|
|
480
|
+
]);
|
|
481
|
+
expect(asserts.casing('testExample', 'MACRO_CASE', assertionProperties)).toEqual([
|
|
482
|
+
{
|
|
483
|
+
message: '"testExample" should use MACRO_CASE',
|
|
484
|
+
location: baseLocation,
|
|
485
|
+
},
|
|
486
|
+
]);
|
|
487
|
+
expect(asserts.casing('TestExample', 'MACRO_CASE', assertionProperties)).toEqual([
|
|
488
|
+
{
|
|
489
|
+
message: '"TestExample" should use MACRO_CASE',
|
|
490
|
+
location: baseLocation,
|
|
491
|
+
},
|
|
492
|
+
]);
|
|
493
|
+
expect(asserts.casing('test-example', 'MACRO_CASE', assertionProperties)).toEqual([
|
|
494
|
+
{
|
|
495
|
+
message: '"test-example" should use MACRO_CASE',
|
|
496
|
+
location: baseLocation,
|
|
497
|
+
},
|
|
498
|
+
]);
|
|
499
|
+
});
|
|
500
|
+
it('value should be COBOL-CASE', () => {
|
|
501
|
+
expect(asserts.casing('TEST-EXAMPLE', 'COBOL-CASE', assertionProperties)).toEqual([]);
|
|
502
|
+
expect(
|
|
503
|
+
asserts.casing(['TEST-EXAMPLE', 'FOO-BAR'], 'COBOL-CASE', assertionProperties)
|
|
504
|
+
).toEqual([]);
|
|
505
|
+
expect(
|
|
506
|
+
asserts.casing(['TEST-EXAMPLE', 'FOO_BAR'], 'COBOL-CASE', assertionProperties)
|
|
507
|
+
).toEqual([
|
|
508
|
+
{
|
|
509
|
+
message: '"FOO_BAR" should use COBOL-CASE',
|
|
510
|
+
location: baseLocation.child('FOO_BAR').key(),
|
|
511
|
+
},
|
|
512
|
+
]);
|
|
513
|
+
expect(asserts.casing('TEST-EXAMPLE-', 'COBOL-CASE', assertionProperties)).toEqual([
|
|
514
|
+
{
|
|
515
|
+
message: '"TEST-EXAMPLE-" should use COBOL-CASE',
|
|
516
|
+
location: baseLocation,
|
|
517
|
+
},
|
|
518
|
+
]);
|
|
519
|
+
expect(asserts.casing('0TEST-EXAMPLE', 'COBOL-CASE', assertionProperties)).toEqual([
|
|
520
|
+
{
|
|
521
|
+
message: '"0TEST-EXAMPLE" should use COBOL-CASE',
|
|
522
|
+
location: baseLocation,
|
|
523
|
+
},
|
|
524
|
+
]);
|
|
525
|
+
expect(asserts.casing('-TEST-EXAMPLE', 'COBOL-CASE', assertionProperties)).toEqual([
|
|
526
|
+
{
|
|
527
|
+
message: '"-TEST-EXAMPLE" should use COBOL-CASE',
|
|
528
|
+
location: baseLocation,
|
|
529
|
+
},
|
|
530
|
+
]);
|
|
531
|
+
expect(asserts.casing('TEST--EXAMPLE', 'COBOL-CASE', assertionProperties)).toEqual([
|
|
532
|
+
{
|
|
533
|
+
message: '"TEST--EXAMPLE" should use COBOL-CASE',
|
|
534
|
+
location: baseLocation,
|
|
535
|
+
},
|
|
536
|
+
]);
|
|
537
|
+
expect(asserts.casing('TEST_EXAMPLE', 'COBOL-CASE', assertionProperties)).toEqual([
|
|
538
|
+
{
|
|
539
|
+
message: '"TEST_EXAMPLE" should use COBOL-CASE',
|
|
540
|
+
location: baseLocation,
|
|
541
|
+
},
|
|
542
|
+
]);
|
|
543
|
+
expect(asserts.casing('testExample', 'COBOL-CASE', assertionProperties)).toEqual([
|
|
544
|
+
{
|
|
545
|
+
message: '"testExample" should use COBOL-CASE',
|
|
546
|
+
location: baseLocation,
|
|
547
|
+
},
|
|
548
|
+
]);
|
|
549
|
+
expect(asserts.casing('TestExample', 'COBOL-CASE', assertionProperties)).toEqual([
|
|
550
|
+
{
|
|
551
|
+
message: '"TestExample" should use COBOL-CASE',
|
|
552
|
+
location: baseLocation,
|
|
553
|
+
},
|
|
554
|
+
]);
|
|
555
|
+
expect(asserts.casing('test-example', 'COBOL-CASE', assertionProperties)).toEqual([
|
|
556
|
+
{
|
|
557
|
+
message: '"test-example" should use COBOL-CASE',
|
|
558
|
+
location: baseLocation,
|
|
559
|
+
},
|
|
560
|
+
]);
|
|
561
|
+
});
|
|
562
|
+
it('value should be flatcase', () => {
|
|
563
|
+
expect(asserts.casing('testexample', 'flatcase', assertionProperties)).toEqual([]);
|
|
564
|
+
expect(asserts.casing(['testexample', 'foobar'], 'flatcase', assertionProperties)).toEqual(
|
|
565
|
+
[]
|
|
566
|
+
);
|
|
567
|
+
expect(asserts.casing(['testexample', 'foo_bar'], 'flatcase', assertionProperties)).toEqual(
|
|
568
|
+
[
|
|
569
|
+
{
|
|
570
|
+
message: '"foo_bar" should use flatcase',
|
|
571
|
+
location: baseLocation.child('foo_bar').key(),
|
|
572
|
+
},
|
|
573
|
+
]
|
|
574
|
+
);
|
|
575
|
+
expect(asserts.casing('testexample_', 'flatcase', assertionProperties)).toEqual([
|
|
576
|
+
{
|
|
577
|
+
message: '"testexample_" should use flatcase',
|
|
578
|
+
location: baseLocation,
|
|
579
|
+
},
|
|
580
|
+
]);
|
|
581
|
+
expect(asserts.casing('0testexample', 'flatcase', assertionProperties)).toEqual([
|
|
582
|
+
{
|
|
583
|
+
message: '"0testexample" should use flatcase',
|
|
584
|
+
location: baseLocation,
|
|
585
|
+
},
|
|
586
|
+
]);
|
|
587
|
+
expect(asserts.casing('testExample', 'flatcase', assertionProperties)).toEqual([
|
|
588
|
+
{
|
|
589
|
+
message: '"testExample" should use flatcase',
|
|
590
|
+
location: baseLocation,
|
|
591
|
+
},
|
|
592
|
+
]);
|
|
593
|
+
expect(asserts.casing('TestExample', 'flatcase', assertionProperties)).toEqual([
|
|
594
|
+
{
|
|
595
|
+
message: '"TestExample" should use flatcase',
|
|
596
|
+
location: baseLocation,
|
|
597
|
+
},
|
|
598
|
+
]);
|
|
599
|
+
expect(asserts.casing('test-example', 'flatcase', assertionProperties)).toEqual([
|
|
600
|
+
{
|
|
601
|
+
message: '"test-example" should use flatcase',
|
|
602
|
+
location: baseLocation,
|
|
603
|
+
},
|
|
604
|
+
]);
|
|
605
|
+
});
|
|
606
|
+
});
|
|
607
|
+
|
|
608
|
+
describe('sortOrder', () => {
|
|
609
|
+
it('value should be ordered in ASC direction', () => {
|
|
610
|
+
expect(asserts.sortOrder(['example', 'foo', 'test'], 'asc', assertionProperties)).toEqual(
|
|
611
|
+
[]
|
|
612
|
+
);
|
|
613
|
+
expect(
|
|
614
|
+
asserts.sortOrder(['example', 'foo', 'test'], { direction: 'asc' }, assertionProperties)
|
|
615
|
+
).toEqual([]);
|
|
616
|
+
expect(asserts.sortOrder(['example'], 'asc', assertionProperties)).toEqual([]);
|
|
617
|
+
expect(asserts.sortOrder(['example', 'test', 'foo'], 'asc', assertionProperties)).toEqual([
|
|
618
|
+
{
|
|
619
|
+
message: 'Should be sorted in an ascending order',
|
|
620
|
+
location: baseLocation,
|
|
621
|
+
},
|
|
622
|
+
]);
|
|
623
|
+
expect(asserts.sortOrder(['example', 'foo', 'test'], 'desc', assertionProperties)).toEqual([
|
|
624
|
+
{
|
|
625
|
+
message: 'Should be sorted in a descending order',
|
|
626
|
+
location: baseLocation,
|
|
627
|
+
},
|
|
628
|
+
]);
|
|
629
|
+
expect(
|
|
630
|
+
asserts.sortOrder(
|
|
631
|
+
[{ name: 'bar' }, { name: 'baz' }, { name: 'foo' }],
|
|
632
|
+
{ direction: 'asc', property: 'name' },
|
|
633
|
+
assertionProperties
|
|
634
|
+
)
|
|
635
|
+
).toEqual([]);
|
|
636
|
+
expect(
|
|
637
|
+
asserts.sortOrder(
|
|
638
|
+
[{ name: 'bar' }, { name: 'baz' }, { name: 'foo' }],
|
|
639
|
+
{ direction: 'desc', property: 'name' },
|
|
640
|
+
assertionProperties
|
|
641
|
+
)
|
|
642
|
+
).toEqual([
|
|
643
|
+
{
|
|
644
|
+
message: 'Should be sorted in a descending order by property name',
|
|
645
|
+
location: baseLocation,
|
|
646
|
+
},
|
|
647
|
+
]);
|
|
648
|
+
});
|
|
649
|
+
it('value should be ordered in DESC direction', () => {
|
|
650
|
+
expect(asserts.sortOrder(['test', 'foo', 'example'], 'desc', assertionProperties)).toEqual(
|
|
651
|
+
[]
|
|
652
|
+
);
|
|
653
|
+
expect(
|
|
654
|
+
asserts.sortOrder(['test', 'foo', 'example'], { direction: 'desc' }, assertionProperties)
|
|
655
|
+
).toEqual([]);
|
|
656
|
+
expect(asserts.sortOrder(['example'], 'desc', assertionProperties)).toEqual([]);
|
|
657
|
+
expect(asserts.sortOrder(['example', 'test', 'foo'], 'desc', assertionProperties)).toEqual([
|
|
658
|
+
{
|
|
659
|
+
message: 'Should be sorted in a descending order',
|
|
660
|
+
location: baseLocation,
|
|
661
|
+
},
|
|
662
|
+
]);
|
|
663
|
+
expect(asserts.sortOrder(['test', 'foo', 'example'], 'asc', assertionProperties)).toEqual([
|
|
664
|
+
{
|
|
665
|
+
message: 'Should be sorted in an ascending order',
|
|
666
|
+
location: baseLocation,
|
|
667
|
+
},
|
|
668
|
+
]);
|
|
669
|
+
expect(
|
|
670
|
+
asserts.sortOrder(
|
|
671
|
+
[{ name: 'foo' }, { name: 'baz' }, { name: 'bar' }],
|
|
672
|
+
{ direction: 'desc', property: 'name' },
|
|
673
|
+
assertionProperties
|
|
674
|
+
)
|
|
675
|
+
).toEqual([]);
|
|
676
|
+
expect(
|
|
677
|
+
asserts.sortOrder(
|
|
678
|
+
[{ name: 'foo' }, { name: 'baz' }, { name: 'bar' }],
|
|
679
|
+
{ direction: 'asc', property: 'name' },
|
|
680
|
+
assertionProperties
|
|
681
|
+
)
|
|
682
|
+
).toEqual([
|
|
683
|
+
{
|
|
684
|
+
message: 'Should be sorted in an ascending order by property name',
|
|
685
|
+
location: baseLocation,
|
|
686
|
+
},
|
|
687
|
+
]);
|
|
688
|
+
});
|
|
689
|
+
it('should not order objects without property defined', () => {
|
|
690
|
+
expect(
|
|
691
|
+
asserts.sortOrder(
|
|
692
|
+
[
|
|
693
|
+
{ name: 'bar', id: 1 },
|
|
694
|
+
{ name: 'baz', id: 2 },
|
|
695
|
+
{ name: 'foo', id: 3 },
|
|
696
|
+
],
|
|
697
|
+
{ direction: 'desc' },
|
|
698
|
+
assertionProperties
|
|
699
|
+
)
|
|
700
|
+
).toEqual([
|
|
701
|
+
{
|
|
702
|
+
message: 'Please define a property to sort objects by',
|
|
703
|
+
location: baseLocation,
|
|
704
|
+
},
|
|
705
|
+
]);
|
|
706
|
+
expect(
|
|
707
|
+
asserts.sortOrder(
|
|
708
|
+
[
|
|
709
|
+
{ name: 'bar', id: 1 },
|
|
710
|
+
{ name: 'baz', id: 2 },
|
|
711
|
+
{ name: 'foo', id: 3 },
|
|
712
|
+
],
|
|
713
|
+
{ direction: 'asc' },
|
|
714
|
+
assertionProperties
|
|
715
|
+
)
|
|
716
|
+
).toEqual([
|
|
717
|
+
{
|
|
718
|
+
message: 'Please define a property to sort objects by',
|
|
719
|
+
location: baseLocation,
|
|
720
|
+
},
|
|
721
|
+
]);
|
|
722
|
+
});
|
|
723
|
+
it('should ignore string value casing while ordering', () => {
|
|
724
|
+
expect(asserts.sortOrder(['Example', 'foo', 'Test'], 'asc', assertionProperties)).toEqual(
|
|
725
|
+
[]
|
|
726
|
+
);
|
|
727
|
+
expect(asserts.sortOrder(['Test', 'foo', 'Example'], 'desc', assertionProperties)).toEqual(
|
|
728
|
+
[]
|
|
729
|
+
);
|
|
730
|
+
expect(
|
|
731
|
+
asserts.sortOrder(
|
|
732
|
+
[{ name: 'bar' }, { name: 'Baz' }, { name: 'Foo' }],
|
|
733
|
+
{ direction: 'asc', property: 'name' },
|
|
734
|
+
assertionProperties
|
|
735
|
+
)
|
|
736
|
+
).toEqual([]);
|
|
737
|
+
expect(
|
|
738
|
+
asserts.sortOrder(
|
|
739
|
+
[{ name: 'Foo' }, { name: 'baz' }, { name: 'Bar' }],
|
|
740
|
+
{ direction: 'desc', property: 'name' },
|
|
741
|
+
assertionProperties
|
|
742
|
+
)
|
|
743
|
+
).toEqual([]);
|
|
744
|
+
});
|
|
745
|
+
});
|
|
746
|
+
|
|
747
|
+
describe('mutuallyExclusive', () => {
|
|
748
|
+
it('node should not have more than one property from predefined list', () => {
|
|
749
|
+
expect(
|
|
750
|
+
asserts.mutuallyExclusive(Object.keys(fakeNode), ['foo', 'test'], assertionProperties)
|
|
751
|
+
).toEqual([]);
|
|
752
|
+
expect(asserts.mutuallyExclusive(Object.keys(fakeNode), [], assertionProperties)).toEqual(
|
|
753
|
+
[]
|
|
754
|
+
);
|
|
755
|
+
expect(
|
|
756
|
+
asserts.mutuallyExclusive(Object.keys(fakeNode), ['foo', 'bar'], assertionProperties)
|
|
757
|
+
).toEqual([
|
|
758
|
+
{ message: 'foo, bar keys should be mutually exclusive', location: baseLocation.key() },
|
|
759
|
+
]);
|
|
760
|
+
expect(
|
|
761
|
+
asserts.mutuallyExclusive(
|
|
762
|
+
Object.keys(fakeNode),
|
|
763
|
+
['foo', 'bar', 'test'],
|
|
764
|
+
assertionProperties
|
|
765
|
+
)
|
|
766
|
+
).toEqual([
|
|
767
|
+
{
|
|
768
|
+
message: 'foo, bar, test keys should be mutually exclusive',
|
|
769
|
+
location: baseLocation.key(),
|
|
770
|
+
},
|
|
771
|
+
]);
|
|
772
|
+
});
|
|
773
|
+
});
|
|
774
|
+
|
|
775
|
+
describe('mutuallyRequired', () => {
|
|
776
|
+
it('node should have all the properties from predefined list', () => {
|
|
777
|
+
expect(
|
|
778
|
+
asserts.mutuallyRequired(Object.keys(fakeNode), ['foo', 'bar'], assertionProperties)
|
|
779
|
+
).toEqual([]);
|
|
780
|
+
expect(
|
|
781
|
+
asserts.mutuallyRequired(
|
|
782
|
+
Object.keys(fakeNode),
|
|
783
|
+
['foo', 'bar', 'baz'],
|
|
784
|
+
assertionProperties
|
|
785
|
+
)
|
|
786
|
+
).toEqual([]);
|
|
787
|
+
expect(asserts.mutuallyRequired(Object.keys(fakeNode), [], assertionProperties)).toEqual(
|
|
788
|
+
[]
|
|
789
|
+
);
|
|
790
|
+
expect(
|
|
791
|
+
asserts.mutuallyRequired(Object.keys(fakeNode), ['foo', 'test'], assertionProperties)
|
|
792
|
+
).toEqual([
|
|
793
|
+
{ message: 'Properties foo, test are mutually required', location: baseLocation.key() },
|
|
794
|
+
]);
|
|
795
|
+
expect(
|
|
796
|
+
asserts.mutuallyRequired(
|
|
797
|
+
Object.keys(fakeNode),
|
|
798
|
+
['foo', 'bar', 'test'],
|
|
799
|
+
assertionProperties
|
|
800
|
+
)
|
|
801
|
+
).toEqual([
|
|
802
|
+
{
|
|
803
|
+
message: 'Properties foo, bar, test are mutually required',
|
|
804
|
+
location: baseLocation.key(),
|
|
805
|
+
},
|
|
806
|
+
]);
|
|
807
|
+
});
|
|
808
|
+
});
|
|
809
|
+
|
|
810
|
+
describe('requireAny', () => {
|
|
811
|
+
it('node must have at least one property from predefined list', () => {
|
|
812
|
+
expect(
|
|
813
|
+
asserts.requireAny(Object.keys(fakeNode), ['foo', 'test'], assertionProperties)
|
|
814
|
+
).toEqual([]);
|
|
815
|
+
expect(
|
|
816
|
+
asserts.requireAny(Object.keys(fakeNode), ['test', 'bar'], assertionProperties)
|
|
817
|
+
).toEqual([]);
|
|
818
|
+
expect(asserts.requireAny(Object.keys(fakeNode), [], assertionProperties)).toEqual([
|
|
819
|
+
{
|
|
820
|
+
message: 'Should have any of ',
|
|
821
|
+
location: baseLocation.key(),
|
|
822
|
+
},
|
|
823
|
+
]);
|
|
824
|
+
expect(
|
|
825
|
+
asserts.requireAny(Object.keys(fakeNode), ['test', 'test1'], assertionProperties)
|
|
826
|
+
).toEqual([
|
|
827
|
+
{
|
|
828
|
+
message: 'Should have any of test, test1',
|
|
829
|
+
location: baseLocation.key(),
|
|
830
|
+
},
|
|
831
|
+
]);
|
|
832
|
+
expect(
|
|
833
|
+
asserts.requireAny(Object.keys(fakeNode), ['foo', 'bar'], assertionProperties)
|
|
834
|
+
).toEqual([]);
|
|
835
|
+
expect(
|
|
836
|
+
asserts.requireAny(Object.keys(fakeNode), ['foo', 'bar', 'test'], assertionProperties)
|
|
837
|
+
).toEqual([]);
|
|
838
|
+
});
|
|
839
|
+
});
|
|
840
|
+
|
|
841
|
+
describe('function', () => {
|
|
842
|
+
it('node must have at least one property from predefined list', () => {
|
|
843
|
+
const customFn = jest.fn((value: string[], options: any) => {
|
|
844
|
+
if (value[0] === options.word) {
|
|
845
|
+
return [
|
|
846
|
+
{ message: `First value should be ${options.word}`, location: baseLocation.key() },
|
|
847
|
+
];
|
|
848
|
+
}
|
|
849
|
+
return [];
|
|
850
|
+
});
|
|
851
|
+
asserts['local/customFn' as keyof Asserts] = buildAssertCustomFunction(customFn);
|
|
852
|
+
expect(
|
|
853
|
+
asserts['local/customFn' as keyof Asserts](
|
|
854
|
+
Object.keys(fakeNode),
|
|
855
|
+
{ word: 'foo' },
|
|
856
|
+
assertionProperties
|
|
857
|
+
)
|
|
858
|
+
).toEqual([
|
|
859
|
+
{
|
|
860
|
+
message: 'First value should be foo',
|
|
861
|
+
location: baseLocation.key(),
|
|
862
|
+
},
|
|
863
|
+
]);
|
|
864
|
+
expect(customFn.mock.calls.length).toBe(1);
|
|
865
|
+
expect(customFn.mock.calls[0][0]).toEqual(Object.keys(fakeNode));
|
|
866
|
+
});
|
|
867
|
+
});
|
|
868
|
+
});
|
|
869
|
+
});
|