test: workspaces example

.github/workflows/ci.yml

@@ -45,7 +45,7 @@ jobs:
             fail-fast: false
             matrix:
                 node-version: [16, 18]
-                example-name: [example-basic]
+                example-name: [example-basic, example-workspace]
 
         steps:
             - uses: actions/checkout@v3

README.md

@@ -95,6 +95,12 @@ sonar.javascript.lcov.reportPaths=./coverage/lcov.info
 
 ## Examples
 
+### Workspace
+
+See [examples/example-workspace](https://github.com/AriPerkkio/vitest-sonar-reporter/tree/main/examples/example-workspace) for example setup using [Vitest Workspaces](https://vitest.dev/guide/workspace.html).
+
+### Basic
+
 ```ts
 import { describe, expect, test } from 'vitest';
 

examples/example-workspace/package.json

@@ -0,0 +1,14 @@
+{
+    "name": "example-workspace",
+    "type": "module",
+    "private": true,
+    "scripts": {
+        "test": "vitest run && vitest run --root ./report-test --config vitest.config.report.ts"
+    },
+    "devDependencies": {
+        "typescript": "latest",
+        "vite": "^3",
+        "vitest": "latest",
+        "vitest-sonar-reporter": "file:../../"
+    }
+}

examples/example-workspace/packages/client/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "example-workspace-client",
+    "type": "module",
+    "private": true,
+    "scripts": {
+        "test": "vitest run"
+    }
+}

examples/example-workspace/packages/client/src/render-user.ts

@@ -0,0 +1,12 @@
+import { parseName } from '@shared';
+
+export function renderUser(userName: string) {
+    const { first, last } = parseName(userName);
+
+    return `
+      <div class="user">
+        <span class="firstname">${first}</span>
+        <span class="lastname">${last}</span>
+      </div>
+    `;
+}

examples/example-workspace/packages/client/test/render-user.test.ts

@@ -0,0 +1,16 @@
+import { describe, test, expect } from 'vitest';
+
+import { renderUser } from '../src/render-user';
+
+describe('renderUser', () => {
+    test('renders user', () => {
+        expect(renderUser('John Doe')).toMatchInlineSnapshot(`
+          "
+                <div class=\\"user\\">
+                  <span class=\\"firstname\\">John</span>
+                  <span class=\\"lastname\\">Doe</span>
+                </div>
+              "
+        `);
+    });
+});

examples/example-workspace/packages/client/vitest.config.ts

@@ -0,0 +1,13 @@
+import { fileURLToPath } from 'url';
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        name: 'client',
+        alias: {
+            '@shared': fileURLToPath(
+                new URL('../shared/src/index.ts', import.meta.url)
+            ),
+        },
+    },
+});

examples/example-workspace/packages/server/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "example-workspace-server",
+    "type": "module",
+    "private": true,
+    "scripts": {
+        "test": "vitest run"
+    }
+}

examples/example-workspace/packages/server/src/request-parse.ts

@@ -0,0 +1,8 @@
+import { parseName } from '@shared';
+
+export function parseUserFromRequest(request: {
+    headers: Record<string, string>;
+}) {
+    const header = request.headers['x-user'];
+    return parseName(header);
+}

examples/example-workspace/packages/server/test/request-parse.test.ts

@@ -0,0 +1,14 @@
+import { describe, expect, test } from 'vitest';
+
+import { parseUserFromRequest } from '../src/request-parse';
+
+describe('parseUserFromRequest', () => {
+    test('returns user from request', () => {
+        const request = { headers: { 'x-user': 'John Doe' } };
+
+        expect(parseUserFromRequest(request)).toEqual({
+            first: 'John',
+            last: 'Doe',
+        });
+    });
+});

examples/example-workspace/packages/server/vitest.config.ts

@@ -0,0 +1,13 @@
+import { fileURLToPath } from 'url';
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        name: 'server',
+        alias: {
+            '@shared': fileURLToPath(
+                new URL('../shared/src/index.ts', import.meta.url)
+            ),
+        },
+    },
+});

examples/example-workspace/packages/shared/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "example-workspace-shared",
+    "type": "module",
+    "private": true,
+    "scripts": {
+        "test": "vitest run"
+    }
+}

examples/example-workspace/packages/shared/src/index.ts

@@ -0,0 +1 @@
+export * from './user-utils';

examples/example-workspace/packages/shared/src/user-utils.ts

@@ -0,0 +1,9 @@
+export function parseName(fullname: string) {
+    const [first, last] = fullname.split(' ');
+    return { first, last };
+}
+
+export function getInitials(fullname: string) {
+    const { first, last } = parseName(fullname);
+    return `${first[0]}.${last[0]}`;
+}

examples/example-workspace/packages/shared/test/user-utils.test.ts

@@ -0,0 +1,19 @@
+import { describe, expect, test } from 'vitest';
+
+import { parseName, getInitials } from '../src/user-utils';
+
+describe('parseName', () => {
+    test('returns first name', () => {
+        expect(parseName('John Doe')).toHaveProperty('first', 'John');
+    });
+
+    test('returns last name', () => {
+        expect(parseName('John Doe')).toHaveProperty('last', 'Doe');
+    });
+});
+
+describe('getInitials', () => {
+    test('returns initials', () => {
+        expect(getInitials('John Doe')).toBe('J.D');
+    });
+});

examples/example-workspace/packages/shared/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        name: 'shared',
+    },
+});

examples/example-workspace/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+    - packages/*

examples/example-workspace/report-test/report.test.ts

@@ -0,0 +1,29 @@
+import { existsSync, readFileSync } from 'node:fs';
+import { expect, test } from 'vitest';
+
+import { stabilizeReport } from '../../../test/utils';
+
+test('report exists', () => {
+    expect(existsSync('./sonar-report.xml')).toBe(true);
+});
+
+test('report matches snapshot', () => {
+    const output = readFileSync('./sonar-report.xml', 'utf8');
+    const report = stabilizeReport(output);
+
+    expect(report).toMatchInlineSnapshot(`
+      "<testExecutions version=\\"1\\">
+        <file path=\\"packages/client/test/render-user.test.ts\\">
+          <testCase name=\\"renderUser - renders user\\" duration=\\"123\\" />
+        </file>
+        <file path=\\"packages/server/test/request-parse.test.ts\\">
+          <testCase name=\\"parseUserFromRequest - returns user from request\\" duration=\\"123\\" />
+        </file>
+        <file path=\\"packages/shared/test/user-utils.test.ts\\">
+          <testCase name=\\"parseName - returns first name\\" duration=\\"123\\" />
+          <testCase name=\\"parseName - returns last name\\" duration=\\"123\\" />
+          <testCase name=\\"getInitials - returns initials\\" duration=\\"123\\" />
+        </file>
+      </testExecutions>"
+    `);
+});

examples/example-workspace/report-test/vitest.config.report.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        include: ['report.test.ts'],
+        reporters: ['verbose'],
+    },
+});

examples/example-workspace/tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "compilerOptions": {
+        "paths": {
+            "@shared": ["./packages/shared/src/index.ts"]
+        }
+    }
+}

examples/example-workspace/vitest.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        reporters: ['default', 'vitest-sonar-reporter'],
+        outputFile: {
+            'vitest-sonar-reporter': './sonar-report.xml',
+        },
+    },
+});

examples/example-workspace/vitest.workspace.ts

@@ -0,0 +1,3 @@
+import { defineWorkspace } from 'vitest/config';
+
+export default defineWorkspace(['packages/*']);