@noeldemartin/solid-utils 0.6.0-next.cccdc9c7e033588e2df9d1887ceae49788344d84 → 0.6.0-next.cfba421315c47e4aa5a72990714376d9dcd1ffff

package/src/testing/hepers.test.ts

@@ -0,0 +1,329 @@
+import { describe, expect, it } from 'vitest';
+
+import { sparqlEquals, turtleEquals } from './helpers';
+
+describe('Testing helpers', () => {
+
+    it('Compares sparql', () => {
+        // Arrange
+        const expected = 'INSERT DATA { <#me> a <http://xmlns.com/foaf/0.1/Person> . }';
+        const actual = 'INSERT DATA { <#me> a <http://xmlns.com/foaf/0.1/Person> . }';
+
+        // Act
+        const result = sparqlEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(true);
+    });
+
+    it('Compares sparql operations', () => {
+        // Arrange
+        const expected = `
+            INSERT DATA { <#me> <http://xmlns.com/foaf/0.1/name> "Amy Doe" . } ;
+            DELETE DATA { <#me> <http://xmlns.com/foaf/0.1/name> "John Doe" . }
+        `;
+        const actual = 'INSERT DATA { <#me> <http://xmlns.com/foaf/0.1/name> "Amy Doe" . }';
+
+        // Act
+        const result = sparqlEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(false);
+    });
+
+    it('Compares sparql triples', () => {
+        // Arrange
+        const expected = 'INSERT DATA { <#me> a <http://xmlns.com/foaf/0.1/Person> . }';
+        const actual = 'INSERT DATA { <#me> <http://xmlns.com/foaf/0.1/name> "Amy Doe" . }';
+
+        // Act
+        const result = sparqlEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(false);
+    });
+
+    it('Compares expanded ordered lists in Turtle', () => {
+        // Arrange
+        const expected = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:recipeIngredient ( "Broth" "Noodles" ) .
+        `;
+        const actual = `
+            @prefix schema: <https://schema.org/> .
+            @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:recipeIngredient _:b0 .
+
+            _:b0
+                rdf:first "Broth" ;
+                rdf:rest _:b1 .
+
+            _:b1
+                rdf:first "Noodles" ;
+                rdf:rest rdf:nil .
+        `;
+
+        // Act
+        const result = turtleEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(true);
+    });
+
+    it('Compares different ordered lists in Turtle', () => {
+        // Arrange
+        const expected = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:recipeIngredient ( "Broth" "Noodles" ) .
+        `;
+        const actual = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:recipeIngredient ( "Noodles" "Broth" ) .
+        `;
+
+        // Act
+        const result = turtleEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(false);
+    });
+
+    it('Compares different unordered lists in Turtle', () => {
+        // Arrange
+        const expected = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:recipeIngredient "Broth", "Noodles" .
+        `;
+        const actual = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:recipeIngredient "Noodles", "Broth" .
+        `;
+
+        // Act
+        const result = turtleEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(true);
+    });
+
+    it('Compares sparql using regex patterns', () => {
+        // Arrange
+        const expected = `
+            INSERT DATA {
+                @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+                @prefix foaf: <http://xmlns.com/foaf/> .
+                @prefix purl: <http://purl.org/dc/terms/> .
+
+                <#me>
+                    foaf:name "[[.*]] Doe" ;
+                    foaf:age 42 .
+
+                <#something-[[.*]]>
+                    purl:created "[[.*]]"^^xsd:dateTime ;
+                    purl:modified "2021-01-16T[[.*]]"^^xsd:dateTime ;
+                    purl:available "2021-01-16T12:34:56Z"^^xsd:dateTime .
+            }
+        `;
+        const actual = `
+            INSERT DATA {
+                @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+                @prefix foaf: <http://xmlns.com/foaf/> .
+                @prefix purl: <http://purl.org/dc/terms/> .
+
+                <#me>
+                    foaf:name "John Doe" ;
+                    foaf:age 42 .
+
+                <#something-123456>
+                    purl:created "2021-01-16T12:12:50.123Z"^^xsd:dateTime ;
+                    purl:modified "2021-01-16T12:12:50.123Z"^^xsd:dateTime ;
+                    purl:available "2021-01-16T12:34:56.000Z"^^xsd:dateTime .
+            }
+        `;
+
+        // Act
+        const result = sparqlEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(true);
+    });
+
+    it('supports aliases in regex patterns', () => {
+        // Arrange
+        const expected = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:recipeInstructions <#[[step-1][.*]]>, <#[[step-2][.*]]> .
+
+            <#[[step-1][.*]]>
+                a schema:HowToStep ;
+                schema:text "Boil the noodles" .
+
+            <#[[step-2][.*]]>
+                a schema:HowToStep ;
+                schema:text "Dip them into the broth" .
+        `;
+        const actual = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:recipeInstructions <#ramen-step-1>, <#ramen-step-2> .
+
+            <#ramen-step-1>
+                a schema:HowToStep ;
+                schema:text "Boil the noodles" .
+
+            <#ramen-step-2>
+                a schema:HowToStep ;
+                schema:text "Dip them into the broth" .
+        `;
+
+        // Act
+        const result = turtleEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(true);
+    });
+
+    it('counts matching triples only once', () => {
+        // Arrange
+        const expected = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen", "Ramen" .
+        `;
+        const actual = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:description "is life" .
+        `;
+
+        // Act
+        const result = turtleEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(false);
+    });
+
+    it('allows regex patterns to be mixed up', () => {
+        // Arrange
+        const expected = `
+            @prefix schema: <https://schema.org/> .
+
+            <#[[instruction-1][.*]]-operation-[[operation-1][.*]]> schema:object <#[[instruction-1][.*]]> .
+            <#[[instruction-1][.*]]-metadata> schema:object <#[[instruction-1][.*]]> .
+        `;
+        const actual = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen-step-1-metadata> schema:object <#ramen> .
+            <#ramen-step-1-operation-1> schema:object <#ramen> .
+        `;
+
+        // Act
+        const result = turtleEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(true);
+    });
+
+    it('matches built-in patterns', () => {
+        // Arrange
+        const expected = `
+            @prefix schema: <https://schema.org/> .
+
+            <#[[foobar][%uuid%]]> schema:description "Lorem ipsum" .
+            <#[[%uuid%]]> schema:description "Dolor sit amet" .
+        `;
+        const actual = `
+            @prefix schema: <https://schema.org/> .
+
+            <#20421db7-0c7d-419c-b27e-2c9b3cc026b3> schema:description "Lorem ipsum" .
+            <#d4b41533-dd5d-4a66-9d3f-316f80f135b2> schema:description "Dolor sit amet" .
+        `;
+
+        // Act
+        const result = turtleEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(true);
+    });
+
+    // TODO
+    it.skip('aliases match regex patterns', () => {
+        // Arrange
+        const expected = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:recipeInstructions <#[[step-1][.*]]>, <#[[step-2][.*]]> .
+
+            <#[[step-1][.*]]>
+                a schema:HowToStep ;
+                schema:text "Boil the noodles" .
+
+            <#[[step-2][.*]]>
+                a schema:HowToStep ;
+                schema:text "Dip them into the broth" .
+        `;
+        const actual = `
+            @prefix schema: <https://schema.org/> .
+
+            <#ramen>
+                a schema:Recipe ;
+                schema:name "Ramen" ;
+                schema:recipeInstructions <#ramen-step-1>, <#ramen-step-2> .
+
+            <#ramen-step-1>
+                a schema:HowToStep ;
+                schema:text "Boil the noodles" .
+
+            <#ramen-step-3>
+                a schema:HowToStep ;
+                schema:text "Dip them into the broth" .
+        `;
+
+        // Act
+        const result = turtleEquals(expected, actual);
+
+        // Assert
+        expect(result.success).toBe(false);
+    });
+
+});

package/src/testing/index.ts

@@ -0,0 +1,3 @@
+export * from './vitest';
+export * from './helpers';
+export * from './chai';

package/src/testing/types/index.ts

@@ -0,0 +1,2 @@
+export type { ChaiSolidAssertions } from '@noeldemartin/solid-utils/testing/chai';
+export type { VitestSolidMatchers } from '@noeldemartin/solid-utils/testing/vitest';

package/src/testing/vitest/index.ts

@@ -0,0 +1,20 @@
+import { expect } from 'vitest';
+
+import matchers from './matchers';
+
+export type VitestSolidMatchers<R = unknown> = {
+    [K in keyof typeof matchers]: (
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        ...args: Parameters<(typeof matchers)[K]> extends [any, ...infer Rest] ? Rest : never
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    ) => ReturnType<(typeof matchers)[K]> extends Promise<any> ? Promise<R> : R;
+};
+
+export function installVitestSolidMatchers(): void {
+    expect.extend(matchers);
+}
+
+declare module '@vitest/expect' {
+    interface Assertion<T> extends VitestSolidMatchers<T> {}
+    interface AsymmetricMatchersContaining extends VitestSolidMatchers {}
+}

package/src/testing/vitest/matchers.ts

@@ -0,0 +1,68 @@
+import type { MatcherState, MatchersObject } from '@vitest/expect';
+
+import { normalizeSparql, normalizeTurtle } from '@noeldemartin/solid-utils/helpers/io';
+import { jsonldEquals, sparqlEquals, turtleEquals } from '@noeldemartin/solid-utils/testing/helpers';
+import type { EqualityResult } from '@noeldemartin/solid-utils/testing/helpers';
+import type { JsonLD } from '@noeldemartin/solid-utils/helpers';
+
+interface FormatResultOptions {
+    state: MatcherState;
+    hint: string;
+    expected: unknown;
+    received: unknown;
+}
+
+function formatResult(result: EqualityResult, options: FormatResultOptions) {
+    const pass = result.success;
+    const utils = options.state.utils;
+    const message = pass
+        ? () => [result.message, utils.matcherHint(options.hint)].join('\n\n')
+        : () =>
+            [
+                result.message,
+                utils.matcherHint(options.hint),
+                [
+                    `Expected: not ${utils.printExpected(options.expected)}`,
+                    `Received: ${utils.printReceived(options.received)}`,
+                ].join('\n'),
+            ].join('\n\n');
+
+    return { pass, message };
+}
+
+export function defineMatchers<T extends MatchersObject>(matchers: T): T {
+    return matchers;
+}
+
+export default defineMatchers({
+    async toEqualJsonLD(received, expected: JsonLD) {
+        const result = await jsonldEquals(expected, received);
+
+        return formatResult(result, {
+            state: this,
+            hint: 'toEqualJsonLD',
+            expected,
+            received,
+        });
+    },
+    toEqualSparql(received, expected: string) {
+        const result = sparqlEquals(expected, received);
+
+        return formatResult(result, {
+            state: this,
+            hint: 'toEqualSparql',
+            expected: normalizeSparql(expected),
+            received: normalizeSparql(received),
+        });
+    },
+    toEqualTurtle(received, expected: string) {
+        const result = turtleEquals(expected, received);
+
+        return formatResult(result, {
+            state: this,
+            hint: 'toEqualTurtle',
+            expected: normalizeTurtle(expected),
+            received: normalizeTurtle(received),
+        });
+    },
+});

package/src/types/n3.d.ts

@@ -1,9 +1,7 @@
 import '@types/n3';
 
 declare module 'n3' {
-
     interface Parser {
         _resolveRelativeIRI(iri: string): string;
     }
-
 }