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

Jump to bottom

Validate SDL directives #1435

Closed
wants to merge 4 commits into from
Closed

Validate SDL directives #1435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b3c3832
Add ability to getDirectives() on a type
mjmahone Jul 26, 2018
b553a76
Add validation for duplicate directive usages
mjmahone Jul 26, 2018
89710c8
Add directive location is correct validation
mjmahone Jul 27, 2018
a4c73af
Replace '.getDirectives' with generic method (#1436)
IvanGoncharov Jul 27, 2018
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
290 changes: 290 additions & 0 deletions src/type/__tests__/validation-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import {
GraphQLString,
} from '../../';
import { parse } from '../../language/parser';
import { Source } from '../../language/source';
import { validateSchema } from '../validate';
import { buildSchema } from '../../utilities/buildASTSchema';
import { extendSchema } from '../../utilities/extendSchema';
Expand Down Expand Up @@ -725,6 +726,10 @@ describe('Type System: Input Objects must have fields', () => {
'Input Object type SomeInputObject must define one or more fields.',
locations: [{ line: 6, column: 7 }, { line: 4, column: 9 }],
},
{
message: 'Directive @test not allowed at INPUT_OBJECT location.',
locations: [{ line: 4, column: 38 }, { line: 2, column: 9 }],
},
]);
});

Expand Down Expand Up @@ -1827,3 +1832,288 @@ describe('Objects must adhere to Interface they implement', () => {
]);
});
});

describe('Type System: Schema directives must validate', () => {
it('accepts a Schema with valid directives', () => {
const schema = buildSchema(`
schema @testA @testB {
query: Query
}

type Query @testA @testB {
test: AnInterface @testC
}

directive @testA on SCHEMA | OBJECT | INTERFACE | UNION | SCALAR | INPUT_OBJECT | ENUM
directive @testB on SCHEMA | OBJECT | INTERFACE | UNION | SCALAR | INPUT_OBJECT | ENUM
directive @testC on FIELD_DEFINITION | ARGUMENT_DEFINITION | ENUM_VALUE | INPUT_FIELD_DEFINITION
directive @testD on FIELD_DEFINITION | ARGUMENT_DEFINITION | ENUM_VALUE | INPUT_FIELD_DEFINITION

interface AnInterface @testA {
field: String! @testC
}

type TypeA implements AnInterface @testA {
field(arg: SomeInput @testC): String! @testC @testD
}

type TypeB @testB @testA {
scalar_field: SomeScalar @testC
enum_field: SomeEnum @testC @testD
}

union SomeUnion @testA = TypeA | TypeB

scalar SomeScalar @testA @testB

enum SomeEnum @testA @testB {
SOME_VALUE @testC
}

input SomeInput @testA @testB {
some_input_field: String @testC
}
`);
expect(validateSchema(schema)).to.deep.equal([]);
});

it('rejects a Schema with directive defined multiple times', () => {
const schema = buildSchema(`
type Query {
test: String
}

directive @testA on SCHEMA
directive @testA on SCHEMA
`);
expect(validateSchema(schema)).to.deep.equal([
{
message: 'Directive @testA defined multiple times.',
locations: [{ line: 6, column: 7 }, { line: 7, column: 7 }],
},
]);
});

it('rejects a Schema with same directive used twice per location', () => {
const schema = buildSchema(`
directive @schema on SCHEMA
directive @object on OBJECT
directive @interface on INTERFACE
directive @union on UNION
directive @scalar on SCALAR
directive @input_object on INPUT_OBJECT
directive @enum on ENUM
directive @field_definition on FIELD_DEFINITION
directive @enum_value on ENUM_VALUE
directive @input_field_definition on INPUT_FIELD_DEFINITION
directive @argument_definition on ARGUMENT_DEFINITION

schema @schema @schema {
query: Query
}

type Query implements SomeInterface @object @object {
test(arg: SomeInput @argument_definition @argument_definition): String
}

interface SomeInterface @interface @interface {
test: String @field_definition @field_definition
}

union SomeUnion @union @union = Query

scalar SomeScalar @scalar @scalar

enum SomeEnum @enum @enum {
SOME_VALUE @enum_value @enum_value
}

input SomeInput @input_object @input_object {
some_input_field: String @input_field_definition @input_field_definition
}
`);
expect(validateSchema(schema)).to.deep.equal([
{
message: 'Directive @schema used twice at the same location.',
locations: [{ line: 14, column: 14 }, { line: 14, column: 22 }],
},
{
message:
'Directive @argument_definition used twice at the same location.',
locations: [{ line: 19, column: 29 }, { line: 19, column: 50 }],
},
{
message: 'Directive @object used twice at the same location.',
locations: [{ line: 18, column: 43 }, { line: 18, column: 51 }],
},
{
message: 'Directive @field_definition used twice at the same location.',
locations: [{ line: 23, column: 22 }, { line: 23, column: 40 }],
},
{
message: 'Directive @interface used twice at the same location.',
locations: [{ line: 22, column: 31 }, { line: 22, column: 42 }],
},
{
message:
'Directive @input_field_definition not allowed at FIELD_DEFINITION location.',
locations: [{ line: 35, column: 34 }, { line: 11, column: 7 }],
},
{
message:
'Directive @input_field_definition not allowed at FIELD_DEFINITION location.',
locations: [{ line: 35, column: 58 }, { line: 11, column: 7 }],
},
{
message:
'Directive @input_field_definition used twice at the same location.',
locations: [{ line: 35, column: 34 }, { line: 35, column: 58 }],
},
{
message: 'Directive @input_object used twice at the same location.',
locations: [{ line: 34, column: 23 }, { line: 34, column: 37 }],
},
{
message: 'Directive @union used twice at the same location.',
locations: [{ line: 26, column: 23 }, { line: 26, column: 30 }],
},
{
message: 'Directive @scalar used twice at the same location.',
locations: [{ line: 28, column: 25 }, { line: 28, column: 33 }],
},
{
message: 'Directive @enum_value used twice at the same location.',
locations: [{ line: 31, column: 20 }, { line: 31, column: 32 }],
},
{
message: 'Directive @enum used twice at the same location.',
locations: [{ line: 30, column: 21 }, { line: 30, column: 27 }],
},
]);
});

it('rejects a Schema with directive used again in extension', () => {
const schema = buildSchema(
new Source(`
directive @testA on OBJECT

type Query @testA {
test: String
}
`),
'schema.graphql',
);
const extensions = parse(
new Source(
`
extend type Query @testA
`,
'extensions.graphql',
),
);
const extendedSchema = extendSchema(schema, extensions);
expect(validateSchema(extendedSchema)).to.deep.equal([
{
message: 'Directive @testA used twice at the same location.',
locations: [{ line: 4, column: 20 }, { line: 2, column: 29 }],
},
]);
});

it('rejects a Schema with directives used in wrong location', () => {
const schema = buildSchema(`
directive @schema on SCHEMA
directive @object on OBJECT
directive @interface on INTERFACE
directive @union on UNION
directive @scalar on SCALAR
directive @input_object on INPUT_OBJECT
directive @enum on ENUM
directive @field_definition on FIELD_DEFINITION
directive @enum_value on ENUM_VALUE
directive @input_field_definition on INPUT_FIELD_DEFINITION
directive @argument_definition on ARGUMENT_DEFINITION

schema @object {
query: Query
}

type Query implements SomeInterface @schema {
test(arg: SomeInput @field_definition): String
}

interface SomeInterface @interface {
test: String @argument_definition
}

union SomeUnion @interface = Query

scalar SomeScalar @enum_value

enum SomeEnum @input_object {
SOME_VALUE @enum
}

input SomeInput @object {
some_input_field: String @union
}
`);
const extensions = parse(
new Source(
`
extend type Query @testA
`,
'extensions.graphql',
),
);
const extendedSchema = extendSchema(schema, extensions);
expect(validateSchema(extendedSchema)).to.deep.equal([
{
message: 'Directive @object not allowed at SCHEMA location.',
locations: [{ line: 14, column: 14 }, { line: 3, column: 7 }],
},
{
message:
'Directive @field_definition not allowed at ARGUMENT_DEFINITION location.',
locations: [{ line: 19, column: 29 }, { line: 9, column: 7 }],
},
{
message: 'Directive @schema not allowed at OBJECT location.',
locations: [{ line: 18, column: 43 }, { line: 2, column: 7 }],
},
{
message: 'No directive @testA defined.',
locations: [{ line: 2, column: 29 }],
},
{
message:
'Directive @argument_definition not allowed at FIELD_DEFINITION location.',
locations: [{ line: 23, column: 22 }, { line: 12, column: 7 }],
},
{
message: 'Directive @union not allowed at FIELD_DEFINITION location.',
locations: [{ line: 35, column: 34 }, { line: 5, column: 7 }],
},
{
message: 'Directive @object not allowed at INPUT_OBJECT location.',
locations: [{ line: 34, column: 23 }, { line: 3, column: 7 }],
},
{
message: 'Directive @interface not allowed at UNION location.',
locations: [{ line: 26, column: 23 }, { line: 4, column: 7 }],
},
{
message: 'Directive @enum_value not allowed at SCALAR location.',
locations: [{ line: 28, column: 25 }, { line: 10, column: 7 }],
},
{
message: 'Directive @enum not allowed at ENUM_VALUE location.',
locations: [{ line: 31, column: 20 }, { line: 8, column: 7 }],
},
{
message: 'Directive @input_object not allowed at ENUM location.',
locations: [{ line: 30, column: 21 }, { line: 7, column: 7 }],
},
]);
});
});
Loading