Skip to content

Commit

Permalink
feat: add Spectral rule to validate required channel servers field
Browse files Browse the repository at this point in the history
  • Loading branch information
@smoya
smoya committed Nov 28, 2023
1 parent 983b469 commit 99e38cd
Show file tree
Hide file tree
Showing 3 changed files with 229 additions and 1 deletion.
18 changes: 18 additions & 0 deletions src/ruleset/v3/ruleset.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,24 @@ export const v3CoreRuleset = {
match: '#\\/channels\\/', // If doesn't match, rule fails.
},
},
},

/**
* Channel Object rules
*/
'asyncapi3-required-channel-servers-unambiguity': {
description: 'The "servers" field of a channel under the root "channels" object must always reference to a subset of the servers under the root "servers" object.',
severity: 'error',
recommended: true,
resolved: false, // We use the JSON pointer to match the channel.
given: '$.channels.*',
then: {
field: '$.servers.*.$ref',
function: pattern,
functionOptions: {
match: '#\\/servers\\/', // If doesn't match, rule fails.
},
},
}
},
};
210 changes: 210 additions & 0 deletions test/ruleset/rules/v3/asyncapi3-required-channel-servers-unambiguity.spec.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@
import { testRule, DiagnosticSeverity } from '../../tester';

testRule('asyncapi3-required-channel-servers-unambiguity', [
{
name: 'valid case - required channel (under root) server field points to a subset of required servers (under root)',
document: {
asyncapi: '3.0.0',
info: {
title: 'Account Service',
version: '1.0.0'
},
servers: {
prod: {
host: 'my-api.com',
protocol: 'ws',
},
dev: {
host: 'localhost',
protocol: 'ws',
},
},
channels: {
UserSignedUp: {
servers: [
{ $ref: '#/servers/prod' },
{ $ref: '#/servers/dev' },
]
}
},
},
errors: [],
},
{
name: 'valid case - required channel (under root) server field points to a subset of required servers (under root) from an external doc',
document: {
asyncapi: '3.0.0',
info: {
title: 'Account Service',
version: '1.0.0'
},
channels: {
UserSignedUp: {
servers: [
{ $ref: 'http://foo.bar/components/file.yml#/servers/prod' },
{ $ref: 'http://foo.bar/components/file.yml#/servers/dev' },
]
}
},
},
errors: [],
},
{
name: 'valid case - optional channel (under components) server field points to a subset of required servers (under root)',
document: {
asyncapi: '3.0.0',
info: {
title: 'Account Service',
version: '1.0.0'
},
servers: {
prod: {
host: 'my-api.com',
protocol: 'ws',
},
dev: {
host: 'localhost',
protocol: 'ws',
},
},
components: {
channels: {
UserSignedUp: {
servers: [
{ $ref: '#/servers/prod' },
{ $ref: '#/servers/dev' },
]
}
},
},
},
errors: [],
},
{
name: 'valid case - optional channel (under components) server field points to a subset of optional servers (under components)',
document: {
asyncapi: '3.0.0',
info: {
title: 'Account Service',
version: '1.0.0'
},
components: {
servers: {
prod: {
host: 'my-api.com',
protocol: 'ws',
},
dev: {
host: 'localhost',
protocol: 'ws',
},
},
channels: {
UserSignedUp: {
messages: {
UserSignedUp: {
payload: {
type: 'object',
properties: {
displayName: {
type: 'string'
},
email: {
type: 'string'
}
}
}
}
}
}
},
operations: {
UserSignedUp: {
action: 'send',
channel: {
$ref: '#/components/channels/UserSignedUp'
},
messages: [
{
$ref: '#/components/channels/UserSignedUp/messages/UserSignedUp'
}
]
}
}
}
},
errors: [],
},
{
name: 'invalid case - required channel (in root) servers field points to a subset of optional servers (under components)',
document: {
asyncapi: '3.0.0',
info: {
title: 'Account Service',
version: '1.0.0'
},
channels: {
UserSignedUp: {
servers: [
{ $ref: '#/components/servers/prod' },
{ $ref: '#/components/servers/dev' },
]
}
},
components: {
servers: {
prod: {
host: 'my-api.com',
protocol: 'ws',
},
dev: {
host: 'localhost',
protocol: 'ws',
},
}
}
},
errors: [
{
message: 'The "servers" field of a channel under the root "channels" object must always reference to a subset of the servers under the root "servers" object.',
path: ['channels', 'UserSignedUp', 'servers', '0', '$ref'],
severity: DiagnosticSeverity.Error,
},
{
message: 'The "servers" field of a channel under the root "channels" object must always reference to a subset of the servers under the root "servers" object.',
path: ['channels', 'UserSignedUp', 'servers', '1', '$ref'],
severity: DiagnosticSeverity.Error,
}
],
},
{
name: 'invalid case - required channel (in root) servers field points to a subset of optional servers (under components) from an external doc',
document: {
asyncapi: '3.0.0',
info: {
title: 'Account Service',
version: '1.0.0'
},
channels: {
UserSignedUp: {
servers: [
{ $ref: 'http://foo.bar/components/file.yml#/components/servers/prod' },
{ $ref: 'http://foo.bar/components/file.yml#/components/servers/dev' },
]
}
}
},
errors: [
{
message: 'The "servers" field of a channel under the root "channels" object must always reference to a subset of the servers under the root "servers" object.',
path: ['channels', 'UserSignedUp', 'servers', '0', '$ref'],
severity: DiagnosticSeverity.Error,
},
{
message: 'The "servers" field of a channel under the root "channels" object must always reference to a subset of the servers under the root "servers" object.',
path: ['channels', 'UserSignedUp', 'servers', '1', '$ref'],
severity: DiagnosticSeverity.Error,
}
],
},
]);
2 changes: 1 addition & 1 deletion test/ruleset/rules/v3/asyncapi3-required-operation-channel-unambiguity.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ testRule('asyncapi3-required-operation-channel-unambiguity', [
errors: [],
},
{
name: 'valid case - required operation (under components) channel field points to a required channel (under root)',
name: 'valid case - optional operation (under components) channel field points to a required channel (under root)',
document: {
asyncapi: '3.0.0',
info: {
Expand Down

0 comments on commit 99e38cd

Please sign in to comment.