Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: improve schema validation #1071

Merged
merged 15 commits into from
Apr 12, 2020
Merged

fix: improve schema validation #1071

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
bb500b3
fix: improve oas2/oas3-schema rules validation
P0lip Apr 7, 2020
af4eb9a
fix(schema): more consistent casing
P0lip Apr 7, 2020
2d81c8b
fix(schema): pretty-print path-less property
P0lip Apr 7, 2020
0ed1294
revert: accidently committed tab
P0lip Apr 7, 2020
95f186f
style: rename _ to potentialProperty
P0lip Apr 8, 2020
d287724
fix: add missing dot to the error message
P0lip Apr 8, 2020
3853201
test: add more cases
P0lip Apr 8, 2020
29db49f
Merge branch 'develop' into fix/schema-validation
P0lip Apr 8, 2020
8cf81f2
fix: handle security schemes edge case
P0lip Apr 8, 2020
7fecad5
chore: rename test description
P0lip Apr 9, 2020
b3f45e9
Merge branch 'develop' into fix/schema-validation
P0lip Apr 9, 2020
8dcc4cd
Merge branch 'develop' into fix/schema-validation
P0lip Apr 10, 2020
ebb97d4
test: add some unit tests
P0lip Apr 10, 2020
e06c954
chore: document oasDocumentSchema fn
P0lip Apr 12, 2020
938fc72
Merge branch 'develop' into fix/schema-validation
P0lip Apr 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/__tests__/linter.jest.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,13 @@ describe('Linter', () => {

const rules = {
'strings-maxLength': testRuleset.rules['strings-maxLength'],
'oas3-schema': testRuleset.rules['oas3-schema'],
'oas3-schema': {
...testRuleset.rules['oas3-schema'],
then: {
...testRuleset.rules['oas3-schema'].then,
function: 'oasDocumentSchema',
},
},
};

spectral.setRuleset({ rules, exceptions: {}, functions: {} });
Expand Down Expand Up @@ -397,7 +403,13 @@ describe('Linter', () => {

const rules = {
'no-yaml-remote-reference': testRuleset.rules['no-yaml-remote-reference'],
'oas3-schema': testRuleset.rules['oas3-schema'],
'oas3-schema': {
...testRuleset.rules['oas3-schema'],
then: {
...testRuleset.rules['oas3-schema'].then,
function: 'oasDocumentSchema',
},
},
};

spectral.setRuleset({ rules, exceptions: {}, functions: {} });
Expand Down
157 changes: 156 additions & 1 deletion src/rulesets/oas/functions/__tests__/oasDocumentSchema.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ import { isOpenApiv2, isOpenApiv3, RuleType, Spectral } from '../../../..';
import { functions } from '../../../../functions';
import { setFunctionContext } from '../../../evaluators';
import { rules } from '../../index.json';
import oasDocumentSchema from '../oasDocumentSchema';
import oasDocumentSchema, { prepareResults } from '../oasDocumentSchema';

import { ErrorObject } from 'ajv';
import * as oas2Schema from '../../schemas/schema.oas2.json';
import * as oas3Schema from '../../schemas/schema.oas3.json';

Expand Down Expand Up @@ -189,4 +190,158 @@ describe('oasDocumentSchema', () => {
]);
});
});

describe('prepareResults', () => {
test('given oneOf error one of which is required $ref property missing, picks only one error', () => {
const errors: ErrorObject[] = [
{
keyword: 'type',
dataPath: '/paths/test/post/parameters/0/schema/type',
schemaPath: '#/properties/type/type',
params: { type: 'string' },
message: 'should be string',
},
{
keyword: 'required',
dataPath: '/paths/test/post/parameters/0/schema',
schemaPath: '#/definitions/Reference/required',
params: { missingProperty: '$ref' },
message: "should have required property '$ref'",
},
{
keyword: 'oneOf',
dataPath: '/paths/test/post/parameters/0/schema',
schemaPath: '#/properties/schema/oneOf',
params: { passingSchemas: null },
message: 'should match exactly one schema in oneOf',
},
];

prepareResults(errors);

expect(errors).toStrictEqual([
P0lip marked this conversation as resolved.
Show resolved Hide resolved
{
keyword: 'type',
dataPath: '/paths/test/post/parameters/0/schema/type',
schemaPath: '#/properties/type/type',
params: { type: 'string' },
message: 'should be string',
},
]);
});

test('given oneOf error one without any $ref property missing, picks all errors', () => {
const errors: ErrorObject[] = [
{
keyword: 'type',
dataPath: '/paths/test/post/parameters/0/schema/type',
schemaPath: '#/properties/type/type',
params: { type: 'string' },
message: 'should be string',
},
{
keyword: 'type',
dataPath: '/paths/test/post/parameters/1/schema/type',
schemaPath: '#/properties/type/type',
params: { type: 'string' },
message: 'should be string',
},
{
keyword: 'oneOf',
dataPath: '/paths/test/post/parameters/0/schema',
schemaPath: '#/properties/schema/oneOf',
params: { passingSchemas: null },
message: 'should match exactly one schema in oneOf',
},
];

prepareResults(errors);

expect(errors).toStrictEqual([
{
keyword: 'type',
dataPath: '/paths/test/post/parameters/0/schema/type',
schemaPath: '#/properties/type/type',
params: { type: 'string' },
message: 'should be string',
},
{
dataPath: '/paths/test/post/parameters/1/schema/type',
keyword: 'type',
message: 'should be string',
params: {
type: 'string',
},
schemaPath: '#/properties/type/type',
},
{
dataPath: '/paths/test/post/parameters/0/schema',
keyword: 'oneOf',
message: 'should match exactly one schema in oneOf',
params: {
passingSchemas: null,
},
schemaPath: '#/properties/schema/oneOf',
},
]);
});

test('given errors with different data paths, picks all errors', () => {
const errors: ErrorObject[] = [
{
keyword: 'type',
dataPath: '/paths/test/post/parameters/0/schema/type',
schemaPath: '#/properties/type/type',
params: { type: 'string' },
message: 'should be string',
},
{
keyword: 'required',
dataPath: '/paths/foo/post/parameters/0/schema',
schemaPath: '#/definitions/Reference/required',
params: { missingProperty: '$ref' },
message: "should have required property '$ref'",
},
{
keyword: 'oneOf',
dataPath: '/paths/baz/post/parameters/0/schema',
schemaPath: '#/properties/schema/oneOf',
params: { passingSchemas: null },
message: 'should match exactly one schema in oneOf',
},
];

prepareResults(errors);

expect(errors).toStrictEqual([
{
dataPath: '/paths/test/post/parameters/0/schema/type',
keyword: 'type',
message: 'should be string',
params: {
type: 'string',
},
schemaPath: '#/properties/type/type',
},
{
dataPath: '/paths/foo/post/parameters/0/schema',
keyword: 'required',
message: "should have required property '$ref'",
params: {
missingProperty: '$ref',
},
schemaPath: '#/definitions/Reference/required',
},
{
dataPath: '/paths/baz/post/parameters/0/schema',
keyword: 'oneOf',
message: 'should match exactly one schema in oneOf',
params: {
passingSchemas: null,
},
schemaPath: '#/properties/schema/oneOf',
},
]);
});
});
});
2 changes: 1 addition & 1 deletion src/rulesets/oas/functions/oasDocumentSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const ERROR_MAP = [
];

// /shrug
P0lip marked this conversation as resolved.
Show resolved Hide resolved
function prepareResults(errors: AJV.ErrorObject[]) {
export function prepareResults(errors: AJV.ErrorObject[]) {
for (let i = 0; i < errors.length; i++) {
const error = errors[i];

Expand Down