Skip to content

Added validated references tests #53

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

Merged
merged 1 commit into from
Jul 12, 2024
Merged

Added validated references tests #53

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
257 changes: 257 additions & 0 deletions language-server/src/features/validate-references.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,257 @@
import { afterEach, beforeEach, describe, expect, test } from "vitest";
import { PublishDiagnosticsNotification } from "vscode-languageserver";
import { TestClient } from "../test-client.js";
import documentSettings from "./document-settings.js";
import semanticTokens from "./semantic-tokens.js";
import schemaRegistry from "./schema-registry.js";
import workspace from "./workspace.js";
import validateReferencesFeature from "./validate-references.js";

import type { Diagnostic } from "vscode-languageserver";
import type { DocumentSettings } from "./document-settings.js";


describe("Feature - Validate References Errors", () => {
let client: TestClient<DocumentSettings>;

beforeEach(async () => {
client = new TestClient([
workspace,
documentSettings,
semanticTokens,
schemaRegistry,
validateReferencesFeature
]);
await client.start();
});

afterEach(async () => {
await client.stop();
});

test("invalid external reference", async () => {
const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
client.onNotification(PublishDiagnosticsNotification.type, (params) => {
resolve(params.diagnostics);
});
});

await client.openDocument("./subject.schema.json", `{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"topics": {
"$ref": "https://example.com/schemas/nonexistent.schema.json"
}
}
}`);

const diagnostics = await diagnosticsPromise;
expect(diagnostics[0].message).to.eql("Referenced schema doesn't exist");
});

test("valid external reference (file based)", async () => {
const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
client.onNotification(PublishDiagnosticsNotification.type, (params) => {
resolve(params.diagnostics);
});
});
await client.openDocument("./subjectB.schema.json", `{
"$schema": "http://json-schema.org/draft-07/schema#"
}`);
await client.openDocument("./subject.schema.json", `{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"topics": {
"$ref": "./subjectB.schema.json"
}
}
}`);

const diagnostics = await diagnosticsPromise;
expect(diagnostics).to.eql([]);
});

test("valid external reference (self identifying)", async () => {
const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
client.onNotification(PublishDiagnosticsNotification.type, (params) => {
resolve(params.diagnostics);
});
});
await client.openDocument("./subjectB.schema.json", `{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/schemas/person.json"
}`);
await client.openDocument("./subject.schema.json", `{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"topics": {
"$ref": "http://example.com/schemas/person.json"
}
}
}`);

const diagnostics = await diagnosticsPromise;
expect(diagnostics).to.eql([]);
});

test("valid local reference", async () => {
const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
client.onNotification(PublishDiagnosticsNotification.type, (params) => {
resolve(params.diagnostics);
});
});

await client.openDocument("./subject.schema.json", `{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"topics": {
"type": "array",
"items": {
"$ref": "#/definitions/topic"
}
}
},
"definitions": {
"topic": {
"type": "string"
}
}
}`);

const diagnostics = await diagnosticsPromise;
expect(diagnostics).to.eql([]);
});

test("invalid local reference", async () => {
const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
client.onNotification(PublishDiagnosticsNotification.type, (params) => {
resolve(params.diagnostics);
});
});

await client.openDocument("./subject.schema.json", `{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"topics": {
"type": "array",
"items": {
"$ref": "#/definitions/topic"
}
}
}
}`);

const diagnostics = await diagnosticsPromise;
expect(diagnostics[0].message).to.eql("Referenced schema doesn't exist");
});

test("valid external reference (file-based embedded)", async () => {
const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
client.onNotification(PublishDiagnosticsNotification.type, (params) => {
resolve(params.diagnostics);
});
});

await client.openDocument("./subject.schema.json", `{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$ref": "/embedded",
"$defs": {
"a": {
"$id": "/embedded"
}
}
}`);

const diagnostics = await diagnosticsPromise;
expect(diagnostics).to.eql([]);
});

test("valid external reference (self-identified relative embedded)", async () => {
const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
client.onNotification(PublishDiagnosticsNotification.type, (params) => {
resolve(params.diagnostics);
});
});

await client.openDocument("./subject.schema.json", `{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://example.com/main",
"$ref": "/embedded",
"$defs": {
"a": {
"$id": "/embedded"
}
}
}`);

const diagnostics = await diagnosticsPromise;
expect(diagnostics).to.eql([]);
});

test("valid external reference (self-identified absolute embedded)", async () => {
const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
client.onNotification(PublishDiagnosticsNotification.type, (params) => {
resolve(params.diagnostics);
});
});

await client.openDocument("./subject.schema.json", `{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://example.com/main",
"$ref": "/embedded",
"$defs": {
"a": {
"$id": "https://example.com/embedded"
}
}
}`);

const diagnostics = await diagnosticsPromise;
expect(diagnostics).to.eql([]);
});

test("valid external/local reference (external)", async () => {
const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
client.onNotification(PublishDiagnosticsNotification.type, (params) => {
resolve(params.diagnostics);
});
});
await client.openDocument("./subject.schema.json", `{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$defs": {
"a": {}
}
}`);
await client.openDocument("./subjectB.schema.json", `{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$ref": "./subject.schema.json#/$defs/a"
}
}`);

const diagnostics = await diagnosticsPromise;
expect(diagnostics).to.eql([]);
});

test("valid external/local reference (embedded)", async () => {
const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
client.onNotification(PublishDiagnosticsNotification.type, (params) => {
resolve(params.diagnostics);
});
});
await client.openDocument("./subject.schema.json", `{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$ref": "./external#/$defs/b",
"$defs": {
"a": {
"$id": "./external",
"$defs": {
"b": {}
}
}
}
}`);

const diagnostics = await diagnosticsPromise;
expect(diagnostics).to.eql([]);
});
});