create-appraisejs 0.1.6 → 0.1.8-alpha

package/templates/default/src/tests/hooks/hooks.ts

@@ -1,99 +1,99 @@
-import { After, AfterAll, AfterStep, Before, BeforeAll, setDefaultTimeout } from '@cucumber/cucumber'
-import { CustomWorld } from '../config/executor/world.js'
-import { BrowserName } from '@/types/executor/browser.type'
-import { config } from 'dotenv'
-import { chromium, ChromiumBrowser, firefox, FirefoxBrowser, webkit, WebKitBrowser } from 'playwright'
-
-// Load environment variables
-config()
-
-// Initialize browser
-let browser: ChromiumBrowser | FirefoxBrowser | WebKitBrowser
-
-// Track scenario status
-let currentScenarioStatus: string = 'unknown'
-
-BeforeAll(async function () {
-  setDefaultTimeout(60000)
-  const browserName = (process.env.BROWSER as BrowserName) || 'chromium'
-  switch (browserName) {
-    case 'chromium':
-      browser = await chromium.launch({
-        headless: process.env.HEADLESS === 'true',
-      })
-      break
-    case 'firefox':
-      browser = await firefox.launch({
-        headless: process.env.HEADLESS === 'true',
-      })
-      break
-    case 'webkit':
-      browser = await webkit.launch({
-        headless: process.env.HEADLESS === 'true',
-      })
-      break
-    default:
-      throw new Error(`Invalid browser name: ${browserName}`)
-  }
-})
-
-Before(async function (this: CustomWorld) {
-  this.clearVars()
-  this.context = await browser.newContext()
-  await this.context.tracing.start({
-    screenshots: true,
-    snapshots: true,
-    sources: true,
-  })
-  this.page = await this.context.newPage()
-})
-
-AfterStep(async function (this: CustomWorld, result) {
-  // Track the worst status encountered (failed > skipped > passed)
-  const status = result.result?.status
-  if (status === 'FAILED') {
-    currentScenarioStatus = 'failed'
-  } else if (status === 'SKIPPED' && currentScenarioStatus !== 'failed') {
-    currentScenarioStatus = 'skipped'
-  } else if (status === 'PASSED' && currentScenarioStatus === 'unknown') {
-    currentScenarioStatus = 'passed'
-  }
-})
-
-After(async function (this: CustomWorld, scenario) {
-  // Emit scenario end event as JSON to stdout
-  // ProcessManager will parse this and re-emit it as an event
-  let tracePath: string | undefined
-  if (scenario.result?.status === 'FAILED') {
-    tracePath = `${process.cwd()}/src/tests/reports/traces/${crypto.randomUUID()}.zip`
-    await this.context.tracing.stop({
-      path: tracePath,
-    })
-  }
-
-  const eventData = {
-    event: 'scenario::end',
-    data: {
-      scenarioName: scenario.pickle.name,
-      status: currentScenarioStatus,
-      tracePath: tracePath,
-    },
-  }
-
-  // Write to stdout in a parseable JSON format
-  // Use process.stdout.write to ensure it's captured by TaskSpawner
-  const eventJson = JSON.stringify(eventData)
-  console.log(eventJson)
-  // Also write directly to stdout to ensure it's captured
-  process.stdout.write(eventJson + '\n')
-
-  // Reset status for next scenario
-  currentScenarioStatus = 'unknown'
-
-  await this.page.close()
-  await this.context.close()
-})
-
-AfterAll(async function () {
-  await browser.close()
-})
+import { After, AfterAll, AfterStep, Before, BeforeAll, setDefaultTimeout } from '@cucumber/cucumber'
+import { CustomWorld } from '../config/executor/world.js'
+import { BrowserName } from '@/types/executor/browser.type'
+import { config } from 'dotenv'
+import { chromium, ChromiumBrowser, firefox, FirefoxBrowser, webkit, WebKitBrowser } from 'playwright'
+
+// Load environment variables
+config()
+
+// Initialize browser
+let browser: ChromiumBrowser | FirefoxBrowser | WebKitBrowser
+
+// Track scenario status
+let currentScenarioStatus: string = 'unknown'
+
+BeforeAll(async function () {
+  setDefaultTimeout(60000)
+  const browserName = (process.env.BROWSER as BrowserName) || 'chromium'
+  switch (browserName) {
+    case 'chromium':
+      browser = await chromium.launch({
+        headless: process.env.HEADLESS === 'true',
+      })
+      break
+    case 'firefox':
+      browser = await firefox.launch({
+        headless: process.env.HEADLESS === 'true',
+      })
+      break
+    case 'webkit':
+      browser = await webkit.launch({
+        headless: process.env.HEADLESS === 'true',
+      })
+      break
+    default:
+      throw new Error(`Invalid browser name: ${browserName}`)
+  }
+})
+
+Before(async function (this: CustomWorld) {
+  this.clearVars()
+  this.context = await browser.newContext()
+  await this.context.tracing.start({
+    screenshots: true,
+    snapshots: true,
+    sources: true,
+  })
+  this.page = await this.context.newPage()
+})
+
+AfterStep(async function (this: CustomWorld, result) {
+  // Track the worst status encountered (failed > skipped > passed)
+  const status = result.result?.status
+  if (status === 'FAILED') {
+    currentScenarioStatus = 'failed'
+  } else if (status === 'SKIPPED' && currentScenarioStatus !== 'failed') {
+    currentScenarioStatus = 'skipped'
+  } else if (status === 'PASSED' && currentScenarioStatus === 'unknown') {
+    currentScenarioStatus = 'passed'
+  }
+})
+
+After(async function (this: CustomWorld, scenario) {
+  // Emit scenario end event as JSON to stdout
+  // ProcessManager will parse this and re-emit it as an event
+  let tracePath: string | undefined
+  if (scenario.result?.status === 'FAILED') {
+    tracePath = `${process.cwd()}/src/tests/reports/traces/${crypto.randomUUID()}.zip`
+    await this.context.tracing.stop({
+      path: tracePath,
+    })
+  }
+
+  const eventData = {
+    event: 'scenario::end',
+    data: {
+      scenarioName: scenario.pickle.name,
+      status: currentScenarioStatus,
+      tracePath: tracePath,
+    },
+  }
+
+  // Write to stdout in a parseable JSON format
+  // Use process.stdout.write to ensure it's captured by TaskSpawner
+  const eventJson = JSON.stringify(eventData)
+  console.log(eventJson)
+  // Also write directly to stdout to ensure it's captured
+  process.stdout.write(eventJson + '\n')
+
+  // Reset status for next scenario
+  currentScenarioStatus = 'unknown'
+
+  await this.page.close()
+  await this.context.close()
+})
+
+AfterAll(async function () {
+  await browser.close()
+})

package/templates/default/src/tests/mapping/locator-map.json

@@ -1 +1 @@
-[]
+[]

package/templates/default/src/tests/steps/actions/click.step.ts

@@ -1,62 +1,62 @@
-/**
- * @name click
- * @description Template step for handling element click
- * @type ACTION
- */
-import { When } from '@cucumber/cucumber'
-import { CustomWorld } from '../../config/executor/world.js'
-import { SelectorName } from '@/types/locator/locator.type'
-import { resolveLocator } from '../../utils/locator.util.js'
-
-// This file is generated automatically. Add template steps to this group to generate content.
-
-/**
- * @name click
- * @description Template step for clicking on an element
- * @icon MOUSE
- */
-When('the user clicks on the {string} element', async function (this: CustomWorld, elementName: SelectorName) {
-  const selector = await resolveLocator(this.page, elementName)
-  if (!selector) {
-    throw new Error(`Selector ${elementName} not found. Current url: ${this.page.url()}`)
-  }
-  try {
-    await this.page.locator(selector).click()
-  } catch (error) {
-    throw new Error(`Failed to click on the ${elementName} element: ${error}`)
-  }
-})
-
-/**
- * @name double click
- * @description Template step for double clicking on an element
- * @icon MOUSE
- */
-When('the user double clicks on the {string} element', async function (this: CustomWorld, elementName: SelectorName) {
-  const selector = await resolveLocator(this.page, elementName)
-  if (!selector) {
-    throw new Error(`Selector ${elementName} not found. Current url: ${this.page.url()}`)
-  }
-  try {
-    await this.page.locator(selector).dblclick()
-  } catch (error) {
-    throw new Error(`Failed to double click on the ${elementName} element: ${error}`)
-  }
-})
-
-/**
- * @name right click
- * @description Template step for right clicking on an element
- * @icon MOUSE
- */
-When('the user right clicks on the {string} element', async function (this: CustomWorld, elementName: SelectorName) {
-  const selector = await resolveLocator(this.page, elementName)
-  if (!selector) {
-    throw new Error(`Selector ${elementName} not found. Current url: ${this.page.url()}`)
-  }
-  try {
-    await this.page.locator(selector).click({ button: 'right' })
-  } catch (error) {
-    throw new Error(`Failed to right click on the ${elementName} element: ${error}`)
-  }
-})
+/**
+ * @name click
+ * @description Template step for handling element click
+ * @type ACTION
+ */
+import { When } from '@cucumber/cucumber'
+import { CustomWorld } from '../../config/executor/world.js'
+import { SelectorName } from '@/types/locator/locator.type'
+import { resolveLocator } from '../../utils/locator.util.js'
+
+// This file is generated automatically. Add template steps to this group to generate content.
+
+/**
+ * @name click
+ * @description Template step for clicking on an element
+ * @icon MOUSE
+ */
+When('the user clicks on the {string} element', async function (this: CustomWorld, elementName: SelectorName) {
+  const selector = await resolveLocator(this.page, elementName)
+  if (!selector) {
+    throw new Error(`Selector ${elementName} not found. Current url: ${this.page.url()}`)
+  }
+  try {
+    await this.page.locator(selector).click()
+  } catch (error) {
+    throw new Error(`Failed to click on the ${elementName} element: ${error}`)
+  }
+})
+
+/**
+ * @name double click
+ * @description Template step for double clicking on an element
+ * @icon MOUSE
+ */
+When('the user double clicks on the {string} element', async function (this: CustomWorld, elementName: SelectorName) {
+  const selector = await resolveLocator(this.page, elementName)
+  if (!selector) {
+    throw new Error(`Selector ${elementName} not found. Current url: ${this.page.url()}`)
+  }
+  try {
+    await this.page.locator(selector).dblclick()
+  } catch (error) {
+    throw new Error(`Failed to double click on the ${elementName} element: ${error}`)
+  }
+})
+
+/**
+ * @name right click
+ * @description Template step for right clicking on an element
+ * @icon MOUSE
+ */
+When('the user right clicks on the {string} element', async function (this: CustomWorld, elementName: SelectorName) {
+  const selector = await resolveLocator(this.page, elementName)
+  if (!selector) {
+    throw new Error(`Selector ${elementName} not found. Current url: ${this.page.url()}`)
+  }
+  try {
+    await this.page.locator(selector).click({ button: 'right' })
+  } catch (error) {
+    throw new Error(`Failed to right click on the ${elementName} element: ${error}`)
+  }
+})

package/templates/default/src/tests/steps/actions/navigation.step.ts

@@ -1,72 +1,73 @@
-/**
- * @name navigation
- * @description Template steps that deals with browser navigation
- * @type ACTION
- */
-import { When } from '@cucumber/cucumber'
-import { CustomWorld } from '../../config/executor/world.js'
-import { getEnvironment } from '../../utils/environment.util.js'
-
-// This file is generated automatically. Add template steps to this group to generate content.
-
-/**
- * @name navigate to url
- * @description Navigate to the specified URL
- * @icon NAVIGATION
- */
-When('the user navigates to the {string} url', async function (this: CustomWorld, url: string) {
-  try {
-    await this.page.goto(url, { waitUntil: 'domcontentloaded' })
-  } catch (error) {
-    throw new Error(`Failed to navigate to the ${url} url: ${error}`)
-  }
-})
-
-/**
- * @name navigate to environment base url
- * @description Navigate to the base url of previously stored environment configuration
- * @icon NAVIGATION
- */
-When(
-  'the user navigates to the base url of the {string} environment',
-  async function (this: CustomWorld, environmentName: string) {
-    try {
-      const environmentConfig = getEnvironment(environmentName)
-      if (!environmentConfig) {
-        throw new Error(`Environment ${environmentName} not found`)
-      }
-      await this.page.goto(environmentConfig.baseUrl, {
-        waitUntil: 'domcontentloaded',
-      })
-    } catch (error) {
-      throw new Error(`Failed to navigate to the base url of the ${environmentName} environment: ${error}`)
-    }
-  },
-)
-
-/**
- * @name reload
- * @description Template step for reloading the current page
- * @icon NAVIGATION
- */
-When('the user reloads the page', async function (this: CustomWorld) {
-  try {
-    await this.page.reload()
-    await this.page.waitForLoadState('domcontentloaded')
-  } catch (error) {
-    throw new Error(`Failed to reload the page: ${error}`)
-  }
-})
-
-/**
- * @name go back
- * @description Template step for going back to the previous page
- * @icon NAVIGATION
- */
-When('the user goes back to the previous page', async function (this: CustomWorld) {
-  try {
-    await this.page.goBack({ waitUntil: 'domcontentloaded' })
-  } catch (error) {
-    throw new Error(`Failed to go back to the previous page: ${error}`)
-  }
-})
+/**
+ * @name navigation
+ * @description Template steps that deals with browser navigation
+ * @type ACTION
+ */
+import { When } from '@cucumber/cucumber'
+import { CustomWorld } from '../../config/executor/world.js'
+import { getEnvironment } from '../../utils/environment.util.js'
+
+// This file is generated automatically. Add template steps to this group to generate content.
+
+/**
+ * @name navigate to url
+ * @description Navigate to the specified URL
+ * @icon NAVIGATION
+ */
+When('the user navigates to the {string} url', async function (this: CustomWorld, url: string) {
+  try {
+    await this.page.goto(url, { waitUntil: 'domcontentloaded' })
+  } catch (error) {
+    throw new Error(`Failed to navigate to the ${url} url: ${error}`)
+  }
+})
+
+/**
+ * @name navigate to environment base url
+ * @description Navigate to the base url of the selected environment
+ * @icon NAVIGATION
+ */
+When('the user navigates to the base url of the selected environment', async function (this: CustomWorld) {
+  try {
+    const environment = process.env.ENVIRONMENT as string
+    if (!environment) {
+      throw new Error('Environment is not set')
+    }
+    const environmentConfig = getEnvironment(environment)
+    if (!environmentConfig) {
+      throw new Error(`Environment ${environment} not found`)
+    }
+    await this.page.goto(environmentConfig.baseUrl, {
+      waitUntil: 'domcontentloaded',
+    })
+  } catch (error) {
+    throw new Error(`Failed to navigate to the base url of the selected environment: ${error}`)
+  }
+})
+
+/**
+ * @name reload
+ * @description Template step for reloading the current page
+ * @icon NAVIGATION
+ */
+When('the user reloads the page', async function (this: CustomWorld) {
+  try {
+    await this.page.reload()
+    await this.page.waitForLoadState('domcontentloaded')
+  } catch (error) {
+    throw new Error(`Failed to reload the page: ${error}`)
+  }
+})
+
+/**
+ * @name go back
+ * @description Template step for going back to the previous page
+ * @icon NAVIGATION
+ */
+When('the user goes back to the previous page', async function (this: CustomWorld) {
+  try {
+    await this.page.goBack({ waitUntil: 'domcontentloaded' })
+  } catch (error) {
+    throw new Error(`Failed to go back to the previous page: ${error}`)
+  }
+})

package/templates/default/src/tests/steps/validations/active_state_assertion.step.ts

@@ -1,34 +1,34 @@
-/**
- * @name active state assertion
- * @description Template steps for handling the validation of the active state of an element
- * @type VALIDATION
- */
-import { Then } from '@cucumber/cucumber'
-import { CustomWorld, expect } from '../../config/executor/world.js'
-import { SelectorName } from '@/types/locator/locator.type'
-import { resolveLocator } from '../../utils/locator.util.js'
-
-// This file is generated automatically. Add template steps to this group to generate content.
-
-/**
- * @name assert element active
- * @description Template step for validating whether an element is active or not
- * @icon VALIDATION
- */
-Then(
-  'the element {string} should have active status {boolean} ',
-  async function (this: CustomWorld, elementName: SelectorName, isActive: boolean) {
-    try {
-      const selector = await resolveLocator(this.page, elementName)
-      if (!selector) throw new Error(`Selector ${elementName} not found`)
-      const elementActiveStatus = await this.page.locator(selector).isEnabled({ timeout: 10000 })
-      if (isActive) {
-        void expect(elementActiveStatus, `Expected ${elementName} to be active`).to.be.true
-      } else {
-        void expect(elementActiveStatus, `Expected ${elementName} NOT to be active`).to.be.false
-      }
-    } catch (error) {
-      throw new Error(`Failed to validate the active status of the element ${elementName}: ${error}`)
-    }
-  },
-)
+/**
+ * @name active state assertion
+ * @description Template steps for handling the validation of the active state of an element
+ * @type VALIDATION
+ */
+import { Then } from '@cucumber/cucumber'
+import { CustomWorld, expect } from '../../config/executor/world.js'
+import { SelectorName } from '@/types/locator/locator.type'
+import { resolveLocator } from '../../utils/locator.util.js'
+
+// This file is generated automatically. Add template steps to this group to generate content.
+
+/**
+ * @name assert element active
+ * @description Template step for validating whether an element is active or not
+ * @icon VALIDATION
+ */
+Then(
+  'the element {string} should have active status {boolean} ',
+  async function (this: CustomWorld, elementName: SelectorName, isActive: boolean) {
+    try {
+      const selector = await resolveLocator(this.page, elementName)
+      if (!selector) throw new Error(`Selector ${elementName} not found`)
+      const elementActiveStatus = await this.page.locator(selector).isEnabled({ timeout: 10000 })
+      if (isActive) {
+        void expect(elementActiveStatus, `Expected ${elementName} to be active`).to.be.true
+      } else {
+        void expect(elementActiveStatus, `Expected ${elementName} NOT to be active`).to.be.false
+      }
+    } catch (error) {
+      throw new Error(`Failed to validate the active status of the element ${elementName}: ${error}`)
+    }
+  },
+)

package/templates/default/src/tests/steps/validations/navigation_assertion.step.ts

@@ -1,23 +1,24 @@
-/**
- * @name navigation assertion
- * @description Template steps that handles navigation validations
- * @type VALIDATION
- */
-import { Then } from '@cucumber/cucumber'
-import { CustomWorld, expect } from '../../config/executor/world.js'
-
-// This file is generated automatically. Add template steps to this group to generate content.
-
-/**
- * @name assert url route equals
- * @description Template step for validating whether a url route equals the provided value or not
- * @icon VALIDATION
- */
-Then('the url route should be equal to {string}', async function (this: CustomWorld, route: string) {
-  try {
-    const currentRoute = await this.page.url()
-    expect(currentRoute, `Expected the current route to be "${route}"`).to.equal(route)
-  } catch (error) {
-    throw new Error(`Failed to validate the equality of the current route to the route "${route}": ${error}`)
-  }
-})
+/**
+ * @name navigation assertion
+ * @description Template steps that handles navigation validations
+ * @type VALIDATION
+ */
+import { Then } from '@cucumber/cucumber'
+import { CustomWorld, expect } from '../../config/executor/world.js'
+
+// This file is generated automatically. Add template steps to this group to generate content.
+
+/**
+ * @name assert url route equals
+ * @description Template step for validating whether a url route equals the provided value or not
+ * @icon VALIDATION
+ */
+Then('the url route should be equal to {string}', async function (this: CustomWorld, route: string) {
+  try {
+    await this.page.waitForLoadState('networkidle')
+    const currentRoute = new URL(this.page.url()).pathname
+    expect(currentRoute, `Expected the current route to be "${route}"`).to.equal(route.toLowerCase())
+  } catch (error) {
+    throw new Error(`Failed to validate the equality of the current route to the route "${route}": ${error}`)
+  }
+})