@testspectra/cli 1.1.6 → 1.1.8-rc.1

package/dist/linter/__tests__/component-test-imports.test.js

@@ -0,0 +1,115 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
+import { SpecLinter } from '../spec-linter.js';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+/**
+ * Covers the component-testing `.tsx` import exception (see
+ * docs/v2/features/component-testing/react/mount-convention.md §"Static Imports Are Allowed
+ * Here"): imports are allowed in `.test.tsx` files EXCEPT ones resolving into ambient-global-
+ * backed directories (page-objects/, support/steps/, fixtures/). Structural rules
+ * (single-it-required, no-describe-block) stay fully enforced for `.tsx` exactly as for `.ts`.
+ */
+describe('Component Test (.tsx) Import Exception', () => {
+    const tempDir = path.join(__dirname, '__temp_tsx_imports__');
+    const specFrontmatter = `---
+id: TC-0200
+title: Sample component test
+priority: High
+caseType: Positive
+status: automated
+coverage:
+  web: automated
+---
+
+# Sample component test
+
+## Test Steps
+1. Mount the component and assert it is visible.
+`;
+    beforeEach(() => {
+        fs.mkdirSync(tempDir, { recursive: true });
+        fs.writeFileSync(path.join(tempDir, 'spec.md'), specFrontmatter);
+    });
+    afterEach(() => {
+        if (fs.existsSync(tempDir)) {
+            fs.rmSync(tempDir, { recursive: true, force: true });
+        }
+    });
+    it('does not flag no-manual-import for ordinary component/library imports in .test.tsx', () => {
+        fs.writeFileSync(path.join(tempDir, 'web.test.tsx'), `import { Button } from '../../src/components/Button/Button.js';
+import React from 'react';
+
+it('Sample component test', async () => {
+  await Spectra.mount(<Button label="Save" />);
+});
+`);
+        const { diagnostics } = SpecLinter.validateSpecFile(path.join(tempDir, 'spec.md'));
+        const importErrors = diagnostics.filter((d) => d.code === 'testspectra/no-manual-import');
+        expect(importErrors).toHaveLength(0);
+    });
+    it('still flags no-manual-import when a .test.tsx import resolves into page-objects/', () => {
+        fs.writeFileSync(path.join(tempDir, 'web.test.tsx'), `import ButtonComponent from '../../page-objects/ButtonComponent/web.js';
+
+it('Sample component test', async () => {
+  await ButtonComponent.root.shouldBeVisible();
+});
+`);
+        const { diagnostics } = SpecLinter.validateSpecFile(path.join(tempDir, 'spec.md'));
+        const importErrors = diagnostics.filter((d) => d.code === 'testspectra/no-manual-import');
+        expect(importErrors).toHaveLength(1);
+        expect(importErrors[0].message).toContain('page-objects');
+    });
+    it('still flags no-manual-import when a .test.tsx import resolves into support/steps/', () => {
+        fs.writeFileSync(path.join(tempDir, 'web.test.tsx'), `import verifyButtonState from '../../support/steps/verifyButtonState/web.step.js';
+
+it('Sample component test', async () => {
+  await verifyButtonState('Save', true);
+});
+`);
+        const { diagnostics } = SpecLinter.validateSpecFile(path.join(tempDir, 'spec.md'));
+        const importErrors = diagnostics.filter((d) => d.code === 'testspectra/no-manual-import');
+        expect(importErrors).toHaveLength(1);
+    });
+    it('still flags no-manual-import when a .test.tsx import resolves into fixtures/', () => {
+        fs.writeFileSync(path.join(tempDir, 'web.test.tsx'), `import users from '../../fixtures/users.json';
+
+it('Sample component test', async () => {
+  expect(users).toBeDefined();
+});
+`);
+        const { diagnostics } = SpecLinter.validateSpecFile(path.join(tempDir, 'spec.md'));
+        const importErrors = diagnostics.filter((d) => d.code === 'testspectra/no-manual-import');
+        expect(importErrors).toHaveLength(1);
+    });
+    it('still enforces single-it-required and no-describe-block in .test.tsx files', () => {
+        fs.writeFileSync(path.join(tempDir, 'web.test.tsx'), `import { Button } from '../../src/components/Button/Button.js';
+
+describe('Button', () => {
+  it('Sample component test', async () => {
+    await Spectra.mount(<Button label="Save" />);
+  });
+
+  it('Another test', async () => {
+    await Spectra.mount(<Button label="Cancel" />);
+  });
+});
+`);
+        const { diagnostics } = SpecLinter.validateSpecFile(path.join(tempDir, 'spec.md'));
+        expect(diagnostics.some((d) => d.code === 'testspectra/no-describe-block')).toBe(true);
+        expect(diagnostics.some((d) => d.code === 'testspectra/single-it-required')).toBe(true);
+    });
+    it('still forbids all imports (unchanged behavior) in plain .test.ts E2E specs', () => {
+        fs.writeFileSync(path.join(tempDir, 'web.test.ts'), `import { LoginPage } from '../../page-objects/LoginPage/web.js';
+
+it('Sample component test', async () => {
+  await LoginPage.submitButton.click();
+});
+`);
+        const { diagnostics } = SpecLinter.validateSpecFile(path.join(tempDir, 'spec.md'));
+        const importErrors = diagnostics.filter((d) => d.code === 'testspectra/no-manual-import');
+        expect(importErrors).toHaveLength(1);
+    });
+});

package/dist/linter/__tests__/shared-lib-boundary.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/linter/__tests__/shared-lib-boundary.test.js

@@ -0,0 +1,270 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
+import { SpecLinter } from '../spec-linter.js';
+import { isInsideSharedLibrary, findSharedLibraryRoots } from '../discovery.js';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+describe('Shared Library Boundary (testspectra/no-specs-in-shared-lib)', () => {
+    const tempDir = path.join(__dirname, '__temp_shared_boundary__');
+    beforeEach(() => {
+        fs.mkdirSync(tempDir, { recursive: true });
+    });
+    afterEach(() => {
+        if (fs.existsSync(tempDir)) {
+            fs.rmSync(tempDir, { recursive: true, force: true });
+        }
+    });
+    describe('findSharedLibraryRoots()', () => {
+        it('discovers parent folders of project.json files containing both scope:shared and type:shared', () => {
+            const sharedDir1 = path.join(tempDir, 'shared', 'testing');
+            const sharedDir2 = path.join(tempDir, 'libs', 'common-helpers');
+            const nonSharedDir = path.join(tempDir, 'packages', 'playground', 'e2e');
+            fs.mkdirSync(sharedDir1, { recursive: true });
+            fs.mkdirSync(sharedDir2, { recursive: true });
+            fs.mkdirSync(nonSharedDir, { recursive: true });
+            fs.writeFileSync(path.join(sharedDir1, 'project.json'), JSON.stringify({ name: 'shared-testing', tags: ['scope:shared', 'type:shared'] }));
+            fs.writeFileSync(path.join(sharedDir2, 'project.json'), JSON.stringify({ name: 'common-helpers', tags: ['scope:shared', 'type:shared'] }));
+            fs.writeFileSync(path.join(nonSharedDir, 'project.json'), JSON.stringify({ name: 'playground-e2e', tags: ['scope:playground', 'type:e2e'] }));
+            const roots = findSharedLibraryRoots(tempDir);
+            expect(roots).toHaveLength(2);
+            expect(roots).toContain(sharedDir1);
+            expect(roots).toContain(sharedDir2);
+            expect(roots).not.toContain(nonSharedDir);
+        });
+    });
+    describe('isInsideSharedLibrary()', () => {
+        it('returns true for files inside a project tagged with scope:shared or type:shared in project.json', () => {
+            const sharedDir = path.join(tempDir, 'shared', 'testing');
+            fs.mkdirSync(sharedDir, { recursive: true });
+            fs.writeFileSync(path.join(sharedDir, 'project.json'), JSON.stringify({
+                name: 'shared-testing',
+                tags: ['scope:shared', 'type:shared'],
+            }));
+            const stepFile = path.join(sharedDir, 'support', 'steps', 'web.step.ts');
+            const specFile = path.join(sharedDir, 'specs', 'TC-001', 'spec.md');
+            const actionFile = path.join(sharedDir, 'support', 'actions', 'web.action.ts');
+            expect(isInsideSharedLibrary(stepFile)).toBe(true);
+            expect(isInsideSharedLibrary(specFile)).toBe(true);
+            expect(isInsideSharedLibrary(actionFile)).toBe(true);
+            expect(isInsideSharedLibrary(sharedDir)).toBe(true);
+        });
+        it('returns true for shared library regardless of folder name if tagged in project.json', () => {
+            const customLibDir = path.join(tempDir, 'custom-helpers', 'common');
+            fs.mkdirSync(customLibDir, { recursive: true });
+            fs.writeFileSync(path.join(customLibDir, 'project.json'), JSON.stringify({
+                name: 'custom-common-lib',
+                tags: ['scope:shared', 'type:shared'],
+            }));
+            const actionFile = path.join(customLibDir, 'support', 'actions', 'click.action.ts');
+            expect(isInsideSharedLibrary(actionFile)).toBe(true);
+        });
+        it('returns false when folder is named "shared" but project.json is not tagged as shared', () => {
+            const sharedAppDir = path.join(tempDir, 'shared-app');
+            fs.mkdirSync(sharedAppDir, { recursive: true });
+            fs.writeFileSync(path.join(sharedAppDir, 'project.json'), JSON.stringify({
+                name: 'shared-app',
+                tags: ['scope:shared-app', 'type:e2e'],
+            }));
+            const specFile = path.join(sharedAppDir, 'specs', 'TC-001', 'spec.md');
+            expect(isInsideSharedLibrary(specFile)).toBe(false);
+        });
+        it('returns false for feature package project.json without shared tags', () => {
+            const featureDir = path.join(tempDir, 'packages', 'playground', 'e2e');
+            fs.mkdirSync(featureDir, { recursive: true });
+            fs.writeFileSync(path.join(featureDir, 'project.json'), JSON.stringify({
+                name: 'playground-e2e',
+                tags: ['scope:playground', 'type:e2e'],
+            }));
+            const specFile = path.join(featureDir, 'specs', 'TC-001', 'spec.md');
+            expect(isInsideSharedLibrary(specFile)).toBe(false);
+        });
+        it('returns false when no project.json exists in directory tree', () => {
+            const nonProjectSpec = path.join(tempDir, 'standalone', 'specs', 'TC-001', 'spec.md');
+            expect(isInsideSharedLibrary(nonProjectSpec)).toBe(false);
+        });
+    });
+    describe('testspectra/no-specs-in-shared-lib validation', () => {
+        it('emits testspectra/no-specs-in-shared-lib when spec.md is found inside shared/testing/', () => {
+            const sharedLibDir = path.join(tempDir, 'shared', 'testing');
+            fs.mkdirSync(sharedLibDir, { recursive: true });
+            fs.writeFileSync(path.join(sharedLibDir, 'project.json'), JSON.stringify({
+                name: 'shared-testing',
+                tags: ['scope:shared', 'type:shared'],
+            }));
+            const sharedSpecDir = path.join(sharedLibDir, 'specs', 'TC-error');
+            fs.mkdirSync(sharedSpecDir, { recursive: true });
+            fs.writeFileSync(path.join(sharedSpecDir, 'spec.md'), `---
+id: TC-ERROR-001
+title: Spec inside shared lib
+priority: High
+caseType: Positive
+status: draft
+---
+
+# Spec inside shared lib
+
+## Test Steps
+1. Step one
+`);
+            const result = SpecLinter.validateWorkspace(tempDir);
+            const errors = result.diagnostics.filter((d) => d.code === 'testspectra/no-specs-in-shared-lib');
+            expect(errors).toHaveLength(1);
+            expect(errors[0].severity).toBe('error');
+            expect(errors[0].message).toContain('shared testing library');
+        });
+        it('emits testspectra/no-specs-in-shared-lib when suite.md is found inside shared/testing/', () => {
+            const sharedLibDir = path.join(tempDir, 'shared', 'testing');
+            fs.mkdirSync(sharedLibDir, { recursive: true });
+            fs.writeFileSync(path.join(sharedLibDir, 'project.json'), JSON.stringify({
+                name: 'shared-testing',
+                tags: ['scope:shared', 'type:shared'],
+            }));
+            const sharedSuiteDir = path.join(sharedLibDir, 'support');
+            fs.mkdirSync(sharedSuiteDir, { recursive: true });
+            fs.writeFileSync(path.join(sharedSuiteDir, 'suite.md'), `---
+id: suite-error
+name: Suite inside shared lib
+status: active
+---
+
+# Suite: Inside Shared Lib
+`);
+            const result = SpecLinter.validateWorkspace(tempDir);
+            const errors = result.diagnostics.filter((d) => d.code === 'testspectra/no-specs-in-shared-lib');
+            expect(errors).toHaveLength(1);
+            expect(errors[0].message).toContain('shared testing library');
+        });
+        it('emits testspectra/no-specs-in-shared-lib when spec.md is inside a shared library with non-"shared" folder name', () => {
+            const customLibDir = path.join(tempDir, 'libs', 'my-testing-utils');
+            fs.mkdirSync(customLibDir, { recursive: true });
+            fs.writeFileSync(path.join(customLibDir, 'project.json'), JSON.stringify({
+                name: 'my-testing-utils',
+                tags: ['scope:shared', 'type:shared'],
+            }));
+            const specDir = path.join(customLibDir, 'specs', 'TC-custom');
+            fs.mkdirSync(specDir, { recursive: true });
+            fs.writeFileSync(path.join(specDir, 'spec.md'), `---
+id: TC-CUSTOM-001
+title: Spec inside custom shared lib
+priority: High
+caseType: Positive
+status: draft
+---
+
+# Spec inside custom shared lib
+
+## Test Steps
+1. Step one
+`);
+            const result = SpecLinter.validateWorkspace(tempDir);
+            const errors = result.diagnostics.filter((d) => d.code === 'testspectra/no-specs-in-shared-lib');
+            expect(errors).toHaveLength(1);
+            expect(errors[0].severity).toBe('error');
+            expect(errors[0].message).toContain('shared testing library');
+        });
+        it('does NOT emit testspectra/no-specs-in-shared-lib for specs in feature package directories', () => {
+            const featureDir = path.join(tempDir, 'packages', 'playground', 'e2e');
+            fs.mkdirSync(featureDir, { recursive: true });
+            fs.writeFileSync(path.join(featureDir, 'project.json'), JSON.stringify({
+                name: 'playground-e2e',
+                tags: ['scope:playground', 'type:e2e'],
+            }));
+            const featureSpecDir = path.join(featureDir, 'specs', 'TC-001');
+            fs.mkdirSync(featureSpecDir, { recursive: true });
+            fs.writeFileSync(path.join(featureSpecDir, 'spec.md'), `---
+id: TC-001
+title: Feature spec
+priority: High
+caseType: Positive
+status: draft
+---
+
+# Feature spec
+
+## Test Steps
+1. Step one
+`);
+            const result = SpecLinter.validateWorkspace(tempDir);
+            const errors = result.diagnostics.filter((d) => d.code === 'testspectra/no-specs-in-shared-lib');
+            expect(errors).toHaveLength(0);
+        });
+        it('does NOT emit testspectra/no-specs-in-shared-lib when folder is named "shared" but project.json has e2e tags', () => {
+            const sharedE2eDir = path.join(tempDir, 'shared-feature', 'e2e');
+            fs.mkdirSync(sharedE2eDir, { recursive: true });
+            fs.writeFileSync(path.join(sharedE2eDir, 'project.json'), JSON.stringify({
+                name: 'shared-feature-e2e',
+                tags: ['scope:shared-feature', 'type:e2e'],
+            }));
+            const specDir = path.join(sharedE2eDir, 'specs', 'TC-001');
+            fs.mkdirSync(specDir, { recursive: true });
+            fs.writeFileSync(path.join(specDir, 'spec.md'), `---
+id: TC-001
+title: Shared named feature spec
+priority: High
+caseType: Positive
+status: draft
+---
+
+# Shared named feature spec
+
+## Test Steps
+1. Step one
+`);
+            const result = SpecLinter.validateWorkspace(tempDir);
+            const errors = result.diagnostics.filter((d) => d.code === 'testspectra/no-specs-in-shared-lib');
+            expect(errors).toHaveLength(0);
+        });
+        it('does NOT emit testspectra/no-specs-in-shared-lib for specs in root specs/ directory', () => {
+            const rootSpecDir = path.join(tempDir, 'specs', 'TC-001');
+            fs.mkdirSync(rootSpecDir, { recursive: true });
+            fs.writeFileSync(path.join(rootSpecDir, 'spec.md'), `---
+id: TC-001
+title: Root spec
+priority: High
+caseType: Positive
+status: draft
+---
+
+# Root spec
+
+## Test Steps
+1. Step one
+`);
+            const result = SpecLinter.validateWorkspace(tempDir);
+            const errors = result.diagnostics.filter((d) => d.code === 'testspectra/no-specs-in-shared-lib');
+            expect(errors).toHaveLength(0);
+        });
+        it('emits multiple testspectra/no-specs-in-shared-lib when multiple specs found in shared library', () => {
+            const sharedLibDir = path.join(tempDir, 'shared', 'testing');
+            fs.mkdirSync(sharedLibDir, { recursive: true });
+            fs.writeFileSync(path.join(sharedLibDir, 'project.json'), JSON.stringify({
+                name: 'shared-testing',
+                tags: ['scope:shared', 'type:shared'],
+            }));
+            const sharedDir1 = path.join(sharedLibDir, 'specs', 'TC-001');
+            const sharedDir2 = path.join(sharedLibDir, 'specs', 'TC-002');
+            fs.mkdirSync(sharedDir1, { recursive: true });
+            fs.mkdirSync(sharedDir2, { recursive: true });
+            const specContent = `---
+id: TC-TEST
+title: Test
+priority: High
+caseType: Positive
+status: draft
+---
+
+# Test
+
+## Test Steps
+1. Step
+`;
+            fs.writeFileSync(path.join(sharedDir1, 'spec.md'), specContent);
+            fs.writeFileSync(path.join(sharedDir2, 'spec.md'), specContent);
+            const result = SpecLinter.validateWorkspace(tempDir);
+            const errors = result.diagnostics.filter((d) => d.code === 'testspectra/no-specs-in-shared-lib');
+            expect(errors).toHaveLength(2);
+        });
+    });
+});

package/dist/linter/__tests__/spec-schema.test.d.ts

@@ -0,0 +1 @@
+export {};