create-appraisejs 0.2.0-alpha.6 → 0.3.0-alpha.0

package/templates/default/src/lib/sync/sync-executor.test.ts

@@ -0,0 +1,76 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { resolveRequestedSyncExecutionOrder } from '@/lib/sync/sync-registry'
+
+vi.mock('execa', () => ({
+  execa: vi.fn(),
+}))
+
+import { execa } from 'execa'
+import { runRequestedSync } from './sync-executor'
+
+describe('runRequestedSync', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('executes requested sync scripts in dependency order', async () => {
+    vi.mocked(execa).mockResolvedValue({
+      exitCode: 0,
+      stdout: 'ok',
+      stderr: '',
+    } as never)
+
+    const result = await runRequestedSync('sync-test-cases')
+
+    expect(result).toMatchObject({
+      requestedScriptId: 'sync-test-cases',
+      executedScriptIds: resolveRequestedSyncExecutionOrder('sync-test-cases'),
+      success: true,
+    })
+    expect(execa).toHaveBeenCalledTimes(resolveRequestedSyncExecutionOrder('sync-test-cases').length)
+  })
+
+  it('stops on the first failing script and reports the parsed cause', async () => {
+    vi.mocked(execa)
+      .mockResolvedValueOnce({
+        exitCode: 0,
+        stdout: 'modules synced',
+        stderr: '',
+      } as never)
+      .mockResolvedValueOnce({
+        exitCode: 0,
+        stdout: 'tags synced',
+        stderr: '',
+      } as never)
+      .mockResolvedValueOnce({
+        exitCode: 2,
+        stdout: '',
+        stderr: '\u001b[31mError: Missing suite definitions\u001b[39m',
+      } as never)
+
+    const result = await runRequestedSync('sync-test-cases')
+
+    expect(result).toMatchObject({
+      requestedScriptId: 'sync-test-cases',
+      success: false,
+      failedScriptId: 'sync-test-suites',
+      exitCode: 2,
+      executedScriptIds: ['sync-modules', 'sync-tags', 'sync-test-suites'],
+      cause: 'Missing suite definitions',
+    })
+  })
+
+  it('returns a failure result when the sync process throws', async () => {
+    vi.mocked(execa).mockRejectedValue(new Error('spawn EACCES'))
+
+    const result = await runRequestedSync('sync-modules')
+
+    expect(result).toMatchObject({
+      requestedScriptId: 'sync-modules',
+      success: false,
+      failedScriptId: 'sync-modules',
+      executedScriptIds: ['sync-modules'],
+      cause: 'spawn EACCES',
+    })
+  })
+})

package/templates/default/src/lib/sync/sync-pending-counts.test.ts

@@ -1,5 +1,4 @@
-import test from 'node:test'
-import assert from 'node:assert/strict'
+import { describe, expect, it } from 'vitest'
 import {
   StepParameterType,
   TagType,
@@ -16,248 +15,250 @@ import {
   countTestCaseMismatches,
 } from '@/lib/sync/sync-pending-counts'
 
-test('ignores DB-only modules when counting pending module sync work', () => {
-  const count = countModuleMismatches(new Set(['/']), [
-    { id: 'root', name: 'root', path: '/', parentId: null },
-    { id: 'module-1', name: 'ui-only-module', path: '/ui-only-module', parentId: 'root' },
-  ])
+describe('sync pending counts', () => {
+  it('ignores DB-only modules when counting pending module sync work', () => {
+    const count = countModuleMismatches(new Set(['/']), [
+      { id: 'root', name: 'root', path: '/', parentId: null },
+      { id: 'module-1', name: 'ui-only-module', path: '/ui-only-module', parentId: 'root' },
+    ])
 
-  assert.equal(count, 0)
-})
+    expect(count).toBe(0)
+  })
 
-test('ignores DB-only standalone filter tags when filesystem tags are already satisfied', () => {
-  const count = countTagMismatches(
-    [{ name: 'smoke', tagExpression: '@smoke', type: TagType.FILTER }],
-    [
-      { name: 'smoke', type: TagType.FILTER },
-      { name: 'standalone', type: TagType.FILTER },
-    ],
-  )
+  it('ignores DB-only standalone filter tags when filesystem tags are already satisfied', () => {
+    const count = countTagMismatches(
+      [{ name: 'smoke', tagExpression: '@smoke', type: TagType.FILTER }],
+      [
+        { name: 'smoke', type: TagType.FILTER },
+        { name: 'standalone', type: TagType.FILTER },
+      ],
+    )
 
-  assert.equal(count, 0)
-})
+    expect(count).toBe(0)
+  })
 
-test('treats projected template step groups as synchronized even with extra DB rows', () => {
-  const count = countTemplateStepGroupMismatches(
-    [{ name: 'Actions', description: 'Projected from UI', type: TemplateStepGroupType.ACTION }],
-    [
-      { name: 'Actions', description: 'Projected from UI', type: TemplateStepGroupType.ACTION },
-      { name: 'Actions', description: 'stale row', type: TemplateStepGroupType.VALIDATION },
-      { name: 'DB Only Group', description: null, type: TemplateStepGroupType.ACTION },
-    ],
-  )
+  it('treats projected template step groups as synchronized even with extra DB rows', () => {
+    const count = countTemplateStepGroupMismatches(
+      [{ name: 'Actions', description: 'Projected from UI', type: TemplateStepGroupType.ACTION }],
+      [
+        { name: 'Actions', description: 'Projected from UI', type: TemplateStepGroupType.ACTION },
+        { name: 'Actions', description: 'stale row', type: TemplateStepGroupType.VALIDATION },
+        { name: 'DB Only Group', description: null, type: TemplateStepGroupType.ACTION },
+      ],
+    )
 
-  assert.equal(count, 0)
-})
+    expect(count).toBe(0)
+  })
 
-test('matches template steps against any equivalent DB row after function normalization', () => {
-  const count = countTemplateStepMismatches(
-    [
-      {
-        groupName: 'Actions',
-        groupType: TemplateStepGroupType.ACTION,
-        step: {
-          jsdoc: {
-            name: 'Click button',
-            description: 'Clicks a button',
-            icon: TemplateStepIcon.MOUSE,
+  it('matches template steps against any equivalent DB row after function normalization', () => {
+    const count = countTemplateStepMismatches(
+      [
+        {
+          groupName: 'Actions',
+          groupType: TemplateStepGroupType.ACTION,
+          step: {
+            jsdoc: {
+              name: 'Click button',
+              description: 'Clicks a button',
+              icon: TemplateStepIcon.MOUSE,
+            },
+            signature: 'click {string}',
+            functionDefinition: '',
+            normalizedFunctionDefinition:
+              "When('click {string}', async function (this: CustomWorld, button: string) {\n  await this.page.click(button);\n});",
+            parameters: [{ name: 'button', order: 0, type: StepParameterType.STRING }],
+            keyword: 'When',
           },
+        },
+      ],
+      [
+        {
+          signature: 'click {string}',
+          name: 'Click button',
+          description: 'stale row',
+          functionDefinition: "When('click {string}', async function () {});",
+          icon: TemplateStepIcon.MOUSE,
+          type: TemplateStepType.ACTION,
+          templateStepGroup: { name: 'Actions' },
+          parameters: [],
+        },
+        {
           signature: 'click {string}',
-          functionDefinition: '',
-          normalizedFunctionDefinition:
+          name: 'Click button',
+          description: 'Clicks a button',
+          functionDefinition:
             "When('click {string}', async function (this: CustomWorld, button: string) {\n  await this.page.click(button);\n});",
+          icon: TemplateStepIcon.MOUSE,
+          type: TemplateStepType.ACTION,
+          templateStepGroup: { name: 'Actions' },
           parameters: [{ name: 'button', order: 0, type: StepParameterType.STRING }],
-          keyword: 'When',
         },
-      },
-    ],
-    [
-      {
-        signature: 'click {string}',
-        name: 'Click button',
-        description: 'stale row',
-        functionDefinition: "When('click {string}', async function () {});",
-        icon: TemplateStepIcon.MOUSE,
-        type: TemplateStepType.ACTION,
-        templateStepGroup: { name: 'Actions' },
-        parameters: [],
-      },
-      {
-        signature: 'click {string}',
-        name: 'Click button',
-        description: 'Clicks a button',
-        functionDefinition:
-          "When('click {string}', async function (this: CustomWorld, button: string) {\n  await this.page.click(button);\n});",
-        icon: TemplateStepIcon.MOUSE,
-        type: TemplateStepType.ACTION,
-        templateStepGroup: { name: 'Actions' },
-        parameters: [{ name: 'button', order: 0, type: StepParameterType.STRING }],
-      },
-    ],
-  )
+      ],
+    )
 
-  assert.equal(count, 0)
-})
+    expect(count).toBe(0)
+  })
 
-test('matches test suites by generated filesystem key instead of raw DB name', () => {
-  const count = countTestSuiteMismatches(
-    [
-      {
-        name: 'user-login-suite',
-        description: 'Projected suite',
-        modulePath: '/auth',
-        tags: ['@smoke'],
-      },
-    ],
-    [
-      {
-        name: 'User Login Suite',
-        description: 'Projected suite',
-        moduleId: 'module-auth',
-        tags: [{ tagExpression: '@smoke' }],
-      },
-    ],
-    new Map([['module-auth', '/auth']]),
-  )
+  it('matches test suites by generated filesystem key instead of raw DB name', () => {
+    const count = countTestSuiteMismatches(
+      [
+        {
+          name: 'user-login-suite',
+          description: 'Projected suite',
+          modulePath: '/auth',
+          tags: ['@smoke'],
+        },
+      ],
+      [
+        {
+          name: 'User Login Suite',
+          description: 'Projected suite',
+          moduleId: 'module-auth',
+          tags: [{ tagExpression: '@smoke' }],
+        },
+      ],
+      new Map([['module-auth', '/auth']]),
+    )
 
-  assert.equal(count, 0)
-})
+    expect(count).toBe(0)
+  })
 
-test('matches test suites when DB description is null and feature uses suite name', () => {
-  const count = countTestSuiteMismatches(
-    [
-      {
-        name: 'user-login-suite',
-        description: 'User Login Suite',
-        modulePath: '/auth',
-        tags: [],
-      },
-    ],
-    [
-      {
-        name: 'User Login Suite',
-        description: null,
-        moduleId: 'module-auth',
-        tags: [],
-      },
-    ],
-    new Map([['module-auth', '/auth']]),
-  )
+  it('matches test suites when DB description is null and feature uses suite name', () => {
+    const count = countTestSuiteMismatches(
+      [
+        {
+          name: 'user-login-suite',
+          description: 'User Login Suite',
+          modulePath: '/auth',
+          tags: [],
+        },
+      ],
+      [
+        {
+          name: 'User Login Suite',
+          description: null,
+          moduleId: 'module-auth',
+          tags: [],
+        },
+      ],
+      new Map([['module-auth', '/auth']]),
+    )
 
-  assert.equal(count, 0)
-})
+    expect(count).toBe(0)
+  })
 
-test('matches projected test cases against generated feature-file output', () => {
-  const count = countTestCaseMismatches(
-    [
-      {
-        identifierTag: '@tc_login',
-        title: 'Login',
-        description: 'Opens the login screen',
-        testSuiteName: 'user-login-suite',
-        modulePath: '/auth',
-        filterTags: ['@smoke'],
-        steps: [
-          { order: 1, keyword: 'Given', text: 'open the login page' },
-          { order: 2, keyword: 'Then', text: 'should see the dashboard' },
-        ],
-      },
-    ],
-    [
-      {
-        title: 'Login',
-        description: 'Opens the login screen',
-        tags: [
-          { tagExpression: '@tc_login', type: TagType.IDENTIFIER },
-          { tagExpression: '@smoke', type: TagType.FILTER },
-        ],
-        TestSuite: [{ name: 'User Login Suite', moduleId: 'module-auth' }],
-        steps: [
-          {
-            order: 1,
-            gherkinStep: 'When open the login page',
-            label: 'open the login page',
-            icon: TemplateStepIcon.MOUSE,
-            TemplateStep: { signature: 'open the login page' },
-            parameters: [],
-          },
-          {
-            order: 2,
-            gherkinStep: 'Then should see the dashboard',
-            label: 'should see the dashboard',
-            icon: TemplateStepIcon.VALIDATION,
-            TemplateStep: { signature: 'should see the dashboard' },
-            parameters: [],
-          },
-        ],
-      },
-    ],
-    new Map([['module-auth', '/auth']]),
-    [
-      { signature: 'open the login page', parameters: [] },
-      { signature: 'should see the dashboard', parameters: [] },
-    ],
-  )
+  it('matches projected test cases against generated feature-file output', () => {
+    const count = countTestCaseMismatches(
+      [
+        {
+          identifierTag: '@tc_login',
+          title: 'Login',
+          description: 'Opens the login screen',
+          testSuiteName: 'user-login-suite',
+          modulePath: '/auth',
+          filterTags: ['@smoke'],
+          steps: [
+            { order: 1, keyword: 'Given', text: 'open the login page' },
+            { order: 2, keyword: 'Then', text: 'should see the dashboard' },
+          ],
+        },
+      ],
+      [
+        {
+          title: 'Login',
+          description: 'Opens the login screen',
+          tags: [
+            { tagExpression: '@tc_login', type: TagType.IDENTIFIER },
+            { tagExpression: '@smoke', type: TagType.FILTER },
+          ],
+          TestSuite: [{ name: 'User Login Suite', moduleId: 'module-auth' }],
+          steps: [
+            {
+              order: 1,
+              gherkinStep: 'When open the login page',
+              label: 'open the login page',
+              icon: TemplateStepIcon.MOUSE,
+              TemplateStep: { signature: 'open the login page' },
+              parameters: [],
+            },
+            {
+              order: 2,
+              gherkinStep: 'Then should see the dashboard',
+              label: 'should see the dashboard',
+              icon: TemplateStepIcon.VALIDATION,
+              TemplateStep: { signature: 'should see the dashboard' },
+              parameters: [],
+            },
+          ],
+        },
+      ],
+      new Map([['module-auth', '/auth']]),
+      [
+        { signature: 'open the login page', parameters: [] },
+        { signature: 'should see the dashboard', parameters: [] },
+      ],
+    )
 
-  assert.equal(count, 0)
-})
+    expect(count).toBe(0)
+  })
 
-test('ignores duplicate stale DB test cases when one matching identifier row exists', () => {
-  const count = countTestCaseMismatches(
-    [
-      {
-        identifierTag: '@tc_profile',
-        title: 'Profile',
-        description: 'Shows the profile page',
-        testSuiteName: 'profile-suite',
-        modulePath: '/account',
-        filterTags: ['@regression'],
-        steps: [{ order: 1, keyword: 'Given', text: 'open the profile page' }],
-      },
-    ],
-    [
-      {
-        title: 'Old Profile',
-        description: 'stale',
-        tags: [
-          { tagExpression: '@tc_profile', type: TagType.IDENTIFIER },
-          { tagExpression: '@regression', type: TagType.FILTER },
-        ],
-        TestSuite: [{ name: 'Other Suite', moduleId: 'module-account' }],
-        steps: [
-          {
-            order: 1,
-            gherkinStep: 'When open the wrong page',
-            label: 'open the wrong page',
-            icon: TemplateStepIcon.MOUSE,
-            TemplateStep: { signature: 'open the wrong page' },
-            parameters: [],
-          },
-        ],
-      },
-      {
-        title: 'Profile',
-        description: 'Shows the profile page',
-        tags: [
-          { tagExpression: '@tc_profile', type: TagType.IDENTIFIER },
-          { tagExpression: '@regression', type: TagType.FILTER },
-        ],
-        TestSuite: [{ name: 'Profile Suite', moduleId: 'module-account' }],
-        steps: [
-          {
-            order: 1,
-            gherkinStep: 'When open the profile page',
-            label: 'open the profile page',
-            icon: TemplateStepIcon.MOUSE,
-            TemplateStep: { signature: 'open the profile page' },
-            parameters: [],
-          },
-        ],
-      },
-    ],
-    new Map([['module-account', '/account']]),
-    [{ signature: 'open the profile page', parameters: [] }],
-  )
+  it('ignores duplicate stale DB test cases when one matching identifier row exists', () => {
+    const count = countTestCaseMismatches(
+      [
+        {
+          identifierTag: '@tc_profile',
+          title: 'Profile',
+          description: 'Shows the profile page',
+          testSuiteName: 'profile-suite',
+          modulePath: '/account',
+          filterTags: ['@regression'],
+          steps: [{ order: 1, keyword: 'Given', text: 'open the profile page' }],
+        },
+      ],
+      [
+        {
+          title: 'Old Profile',
+          description: 'stale',
+          tags: [
+            { tagExpression: '@tc_profile', type: TagType.IDENTIFIER },
+            { tagExpression: '@regression', type: TagType.FILTER },
+          ],
+          TestSuite: [{ name: 'Other Suite', moduleId: 'module-account' }],
+          steps: [
+            {
+              order: 1,
+              gherkinStep: 'When open the wrong page',
+              label: 'open the wrong page',
+              icon: TemplateStepIcon.MOUSE,
+              TemplateStep: { signature: 'open the wrong page' },
+              parameters: [],
+            },
+          ],
+        },
+        {
+          title: 'Profile',
+          description: 'Shows the profile page',
+          tags: [
+            { tagExpression: '@tc_profile', type: TagType.IDENTIFIER },
+            { tagExpression: '@regression', type: TagType.FILTER },
+          ],
+          TestSuite: [{ name: 'Profile Suite', moduleId: 'module-account' }],
+          steps: [
+            {
+              order: 1,
+              gherkinStep: 'When open the profile page',
+              label: 'open the profile page',
+              icon: TemplateStepIcon.MOUSE,
+              TemplateStep: { signature: 'open the profile page' },
+              parameters: [],
+            },
+          ],
+        },
+      ],
+      new Map([['module-account', '/account']]),
+      [{ signature: 'open the profile page', parameters: [] }],
+    )
 
-  assert.equal(count, 0)
+    expect(count).toBe(0)
+  })
 })

package/templates/default/src/lib/sync/sync-pending-counts.ts

@@ -14,11 +14,8 @@ import {
   TemplateStepType,
 } from '@prisma/client'
 import prisma from '@/config/db-config'
-import {
-  ensureAutomationWorkspaceReady,
-  getAutomationEnvironmentsDir,
-  getAutomationFeaturesDir,
-} from '@/lib/automation/paths'
+import { getAutomationEnvironmentsDir, getAutomationFeaturesDir } from '@/lib/automation/automation-path-roots'
+import { ensureAutomationWorkspaceReady } from '@/lib/automation/automation-workspace'
 import { extractModulePathFromFilePath, scanFeatureFiles, type ParsedFeature, type ParsedStep } from '@/lib/gherkin-parser'
 import { getAllModulesWithPaths } from '@/lib/module-hierarchy-builder'
 import { SYNC_ALL_REQUEST_ID, syncScriptDefinitions, type SyncRequestId, type SyncScriptId } from '@/lib/sync/sync-registry'

package/templates/default/src/lib/template-sync-utils.d.ts

@@ -1,7 +1,7 @@
-export declare function shouldExcludeTemplatePath(relativePath: string): boolean;
-export declare function shouldBackfillLegacyEnvironmentConfig(targetHasEnvironmentsFile: boolean, legacyEnvironmentsDirExists: boolean): boolean;
-export declare function getAutomationFeaturesDir(baseDir: string): string;
-export declare function getAutomationLocatorsDir(baseDir: string): string;
-export declare function getAutomationLocatorMapPath(baseDir: string): string;
-export declare function extractModulePathFromAutomationFile(filePath: string, baseDir: string, automationSubdir: 'features' | 'locators'): string;
+export declare function shouldExcludeTemplatePath(relativePath: string): boolean;
+export declare function shouldBackfillLegacyEnvironmentConfig(targetHasEnvironmentsFile: boolean, legacyEnvironmentsDirExists: boolean): boolean;
+export declare function getAutomationFeaturesDir(baseDir: string): string;
+export declare function getAutomationLocatorsDir(baseDir: string): string;
+export declare function getAutomationLocatorMapPath(baseDir: string): string;
+export declare function extractModulePathFromAutomationFile(filePath: string, baseDir: string, automationSubdir: 'features' | 'locators'): string;
 //# sourceMappingURL=template-sync-utils.d.ts.map