Skip to content

test(COMPASS-28): move to @stoplight/spectral-core #2724

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

Draft
timdawborn wants to merge 1 commit into from
Draft

test(COMPASS-28): move to @stoplight/spectral-core #2724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 42 additions & 10 deletions lib/src/generators/json-schema/json-schema.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,48 @@
import { isJSONSchemaDraft7, Spectral } from "@stoplight/spectral";
import JsonSchemaValidator from "ajv";
import { parseContract } from "../../parsers/contract-parser";
import { createProjectFromExistingSourceFile } from "../../spec-helpers/helper";
import { generateJsonSchema } from "./json-schema";

describe("JSON Schema generator", () => {
const spectral = new Spectral();
/**
* Checks a generated schema against the draft-07 meta-schema.
*
* Two assertions, because they catch different things. `validateSchema` reads
* the schema's shape and accepts a dangling `$ref`, an unknown keyword and an
* unknown format. `compile` is what resolves references — and this generator
* emits them — and under `strict` it also rejects a keyword or format it does
* not know. A fresh instance per call, since compiling registers the schema.
*/
const assertValidJsonSchema = (schema: unknown): void => {
const validator = new JsonSchemaValidator({ strict: true });
expect(validator.validateSchema(schema as object)).toBe(true);
expect(validator.errors ?? []).toEqual([]);
expect(() => validator.compile(schema as object)).not.toThrow();
};

beforeAll(async () => {
spectral.registerFormat("json-schema-draft7", isJSONSchemaDraft7);
test("rejects a schema the generator should never emit", () => {
// The call this replaced had no ruleset loaded, so it returned zero findings
// for a valid schema and a broken one alike. This is the case that proves
// the replacement can fail.
expect(() =>
assertValidJsonSchema({
$schema: "http://json-schema.org/draft-07/schema#",
$ref: "#/definitions/Absent",
definitions: {}
})
).toThrow();
});

test("rejects a keyword ajv does not know", () => {
// Pins `strict`. Without it a misspelled keyword is ignored rather than
// reported, and the schema compiles as though the constraint were there.
expect(() =>
assertValidJsonSchema({
$schema: "http://json-schema.org/draft-07/schema#",
type: "number",
minimun: 3
})
).toThrow();
});

test("produces minimal json schema", async () => {
Expand All @@ -21,8 +56,7 @@ describe("JSON Schema generator", () => {
expect(result.$schema).toEqual("http://json-schema.org/draft-07/schema#");
expect(result.definitions).toEqual({});
expect(result).toMatchSnapshot();
const spectralResult = await spectral.run(result);
expect(spectralResult).toHaveLength(0);
assertValidJsonSchema(result);
});

test("produces definitions", async () => {
Expand All @@ -36,8 +70,7 @@ describe("JSON Schema generator", () => {
expect(result.definitions).toHaveProperty("User");
expect(result.definitions).toHaveProperty("Users");
expect(result).toMatchSnapshot();
const spectralResult = await spectral.run(result);
expect(spectralResult).toHaveLength(0);
assertValidJsonSchema(result);
});

test("evaluates intersection type", async () => {
Expand All @@ -49,7 +82,6 @@ describe("JSON Schema generator", () => {
const result = generateJsonSchema(contract);

expect(result).toMatchSnapshot();
const spectralResult = await spectral.run(result);
expect(spectralResult).toHaveLength(0);
assertValidJsonSchema(result);
});
});
115 changes: 93 additions & 22 deletions lib/src/generators/openapi2/openapi2.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,94 @@
import { isOpenApiv2, Spectral } from "@stoplight/spectral";
import {
Document,
ISpectralDiagnostic,
RulesetDefinition,
Spectral
} from "@stoplight/spectral-core";
import { Json } from "@stoplight/spectral-parsers";
import { oas } from "@stoplight/spectral-rulesets";
import { Contract } from "../../definitions";
import { parseContract } from "../../parsers/contract-parser";
import { createProjectFromExistingSourceFile } from "../../spec-helpers/helper";
import { generateOpenAPI2 } from "./openapi2";

describe("OpenAPI 2 generator", () => {
/**
* The OpenAPI rules every generated document is held to. See the equivalent
* block in `openapi3.spec.ts` for why `oas` is pulled in with everything off
* and how each rule's own `formats` decides where it applies.
*/
const ruleset: RulesetDefinition = {
extends: [[oas as RulesetDefinition, "off"]],
rules: {
// `operation-2xx-response` under spectral 5.
"operation-success-response": true,
"operation-operationId-unique": true,
"operation-parameters": true,
"path-params": true,
"no-eval-in-markdown": true,
"no-script-tags-in-markdown": true,
"openapi-tags-alphabetical": true,
"operation-operationId-valid-in-url": true,
"path-declarations-must-exist": true,
"path-keys-no-trailing-slash": true,
"path-not-include-query": true,
"typed-enum": true,
"oas2-operation-formData-consume-check": true,
"oas2-operation-security-defined": true,
// As in `openapi3.spec.ts`: the old ruleset named `oas2-valid-example`,
// which spectral 5 did not have, so neither of these ran. The schema half
// waits on https://airtasker.atlassian.net/browse/COMPASS-29
"oas2-valid-media-example": true,
"oas2-valid-schema-example": false,
"oas2-anyOf": true,
"oas2-oneOf": true,
"oas2-schema": true
// `example-value-or-externalValue` is gone rather than renamed. Spectral 6
// has only an `oas3-` form, which an OpenAPI 2 document would skip — and
// spectral 5 had no rule by that name either, so nothing is lost.
}
};

const spectral = new Spectral();

beforeAll(async () => {
spectral.registerFormat("oas2", isOpenApiv2);
await spectral.loadRuleset(`${__dirname}/spectral.ruleset.yml`);
beforeAll(() => {
spectral.setRuleset(ruleset);
});

const lint = (document: unknown): Promise<ISpectralDiagnostic[]> =>
spectral.run(new Document(JSON.stringify(document), Json));

test("the extends and rules wiring leaves the named rules enabled", async () => {
// Every assertion above is `toHaveLength(0)`, which a ruleset that enabled
// nothing satisfies just as well as a clean document. A rule that no longer
// exists is not the gap: `setRuleset` throws on an unknown name, so a
// rename fails loudly on its own. The gap is a ruleset that stays
// well-formed while enabling nothing — every rule flipped to `false`, or
// the `extends`/`rules` wiring changed — which would leave all of those
// assertions passing over nothing. So this document breaks specific rules
// and names the codes it expects back.
const findings = await lint({
swagger: "2.0",
info: { title: "t", version: "1" },
host: "example.org",
tags: [{ name: "zebra" }, { name: "apple" }],
paths: {
"/trailing/": { get: { responses: { "200": { description: "ok" } } } }
}
});

expect(findings.map(finding => finding.code).sort()).toEqual([
"openapi-tags-alphabetical",
"path-keys-no-trailing-slash"
]);
});

test("minimal contract produces minimal OpenAPI 2", async () => {
const contract = generateContract("minimal-contract.ts");
const result = generateOpenAPI2(contract);

expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});

Expand All @@ -26,7 +97,7 @@ describe("OpenAPI 2 generator", () => {
const result = generateOpenAPI2(contract);

expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});

Expand All @@ -45,7 +116,7 @@ describe("OpenAPI 2 generator", () => {
name: "security-header"
});
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});
});
Expand All @@ -59,7 +130,7 @@ describe("OpenAPI 2 generator", () => {
get: expect.anything()
});
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});

Expand All @@ -71,7 +142,7 @@ describe("OpenAPI 2 generator", () => {
post: expect.anything()
});
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});

Expand All @@ -83,7 +154,7 @@ describe("OpenAPI 2 generator", () => {
put: expect.anything()
});
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});

Expand All @@ -95,7 +166,7 @@ describe("OpenAPI 2 generator", () => {
patch: expect.anything()
});
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});

Expand All @@ -107,7 +178,7 @@ describe("OpenAPI 2 generator", () => {
delete: expect.anything()
});
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});
});
Expand All @@ -134,7 +205,7 @@ describe("OpenAPI 2 generator", () => {
}
]);
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});
});
Expand All @@ -159,7 +230,7 @@ describe("OpenAPI 2 generator", () => {
}
]);
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});

Expand All @@ -180,7 +251,7 @@ describe("OpenAPI 2 generator", () => {
}
]);
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});

Expand All @@ -203,7 +274,7 @@ describe("OpenAPI 2 generator", () => {
}
]);
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});

Expand Down Expand Up @@ -233,7 +304,7 @@ describe("OpenAPI 2 generator", () => {
}
]);
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});

Expand All @@ -253,7 +324,7 @@ describe("OpenAPI 2 generator", () => {
}
);
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});
});
Expand All @@ -280,7 +351,7 @@ describe("OpenAPI 2 generator", () => {
}
});
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});
});
Expand Down Expand Up @@ -418,7 +489,7 @@ describe("OpenAPI 2 generator", () => {
}
});
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});
});
Expand All @@ -432,7 +503,7 @@ describe("OpenAPI 2 generator", () => {
get: expect.anything()
});
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});
});
Expand All @@ -448,7 +519,7 @@ describe("OpenAPI 2 generator", () => {
}
});
expect(JSON.stringify(result, null, 2)).toMatchSnapshot();
const spectralResult = await spectral.run(result);
const spectralResult = await lint(result);
expect(spectralResult).toHaveLength(0);
});
});
Expand Down
22 changes: 0 additions & 22 deletions lib/src/generators/openapi2/spectral.ruleset.yml
View file
Open in desktop

This file was deleted.

Loading
Loading