@testspectra/cli 1.0.11 → 1.0.12

package/templates/nx/default/spectra.config.ts

@@ -0,0 +1,61 @@
+import { defineConfig } from "@testspectra/cli";
+
+export default defineConfig({
+  webConfig: {
+    baseUrl: "https://the-internet.herokuapp.com",
+    maxConcurrentSessions: "1",
+    headlessMode: true,
+    implicitWait: "5000",
+    pageLoadTimeout: "30000",
+    scriptTimeout: "30000",
+    parallelizationMode: "testcase",
+  },
+  browsers: [
+    {
+      id: "chrome-desktop",
+      type: "chrome",
+      mobileEmulation: false,
+    },
+  ],
+  androidConfig: {
+    appiumServer: "http://127.0.0.1:4723",
+    platformName: "Android",
+    platformVersion: "13",
+    deviceName: "emulator-5554",
+    automationName: "UiAutomator2",
+    appPackage: "",
+    appActivity: "",
+    autoGrantPermissions: true,
+    noReset: false,
+    implicitWait: "10000",
+    parallelizationMode: "suite",
+  },
+  iosConfig: {
+    appiumServer: "http://127.0.0.1:4723",
+    platformName: "iOS",
+    platformVersion: "16.0",
+    deviceName: "iPhone 14",
+    automationName: "XCUITest",
+    bundleId: "",
+    udid: "auto",
+    xcodeOrgId: "",
+    xcodeSigningId: "iPhone Developer",
+    autoAcceptAlerts: true,
+    noReset: false,
+    implicitWait: "10000",
+    parallelizationMode: "suite",
+  },
+  loadConfig: {
+    virtualUsers: "10",
+    duration: "1m",
+  },
+  loadStages: [],
+  thresholds: [],
+  executionConfig: {
+    networkMonitoringEnabled: true,
+    fastResponseTime: "200",
+    normalResponseTime: "1000",
+    monitoredDomains: [],
+    environmentVariables: [],
+  },
+});

package/templates/nx/default/steps/loginUser/mobile.step.ts

@@ -0,0 +1,4 @@
+export default async function loginUser(u: string, p: string): Promise<void> {
+  await LoginPage.open();
+  await LoginPage.login(u, p);
+}

package/templates/nx/default/steps/loginUser/web.step.ts

@@ -0,0 +1,4 @@
+export default async function loginUser(u: string, p: string): Promise<void> {
+  await LoginPage.open();
+  await LoginPage.login(u, p);
+}

package/templates/nx/default/steps/searchProduct/mobile.step.ts

@@ -0,0 +1,5 @@
+export default async function searchProduct(query: string): Promise<void> {
+  await ProductPage.open();
+  await Spectra.type(ProductPage.searchInput, query);
+  await Spectra.pressKey("Enter");
+}

package/templates/nx/default/steps/searchProduct/web.step.ts

@@ -0,0 +1,5 @@
+export default async function searchProduct(query: string): Promise<void> {
+  await ProductPage.open();
+  await Spectra.type(ProductPage.searchInput, query);
+  await Spectra.pressKey("Enter");
+}

package/templates/nx/default/tsconfig.android.json

@@ -0,0 +1,39 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "composite": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "types": ["node", "@wdio/globals/types", "@wdio/mocha-framework"]
+  },
+  "include": [
+    ".testspectra/types/android.d.ts",
+    ".testspectra/types/fixtures.d.ts",
+    "page-objects/**/*.ts",
+    "steps/**/*.ts",
+    "actions/**/*.ts",
+    "global-hooks/**/*.ts",
+    "specs/**/hooks/**/*.ts",
+    "specs/**/*.ts",
+    "spectra.config.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "page-objects/**/web.ts",
+    "page-objects/**/ios.ts",
+    "steps/**/web.step.ts",
+    "steps/**/ios.step.ts",
+    "actions/**/web.action.ts",
+    "actions/**/ios.action.ts",
+    "global-hooks/**/web.hook.ts",
+    "global-hooks/**/ios.hook.ts",
+    "specs/**/hooks/**/web.hook.ts",
+    "specs/**/hooks/**/ios.hook.ts",
+    "specs/**/web.test.ts",
+    "specs/**/ios.test.ts"
+  ]
+}

package/templates/nx/default/tsconfig.ios.json

@@ -0,0 +1,39 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "composite": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "types": ["node", "@wdio/globals/types", "@wdio/mocha-framework"]
+  },
+  "include": [
+    ".testspectra/types/ios.d.ts",
+    ".testspectra/types/fixtures.d.ts",
+    "page-objects/**/*.ts",
+    "steps/**/*.ts",
+    "actions/**/*.ts",
+    "global-hooks/**/*.ts",
+    "specs/**/hooks/**/*.ts",
+    "specs/**/*.ts",
+    "spectra.config.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "page-objects/**/web.ts",
+    "page-objects/**/android.ts",
+    "steps/**/web.step.ts",
+    "steps/**/android.step.ts",
+    "actions/**/web.action.ts",
+    "actions/**/android.action.ts",
+    "global-hooks/**/web.hook.ts",
+    "global-hooks/**/android.hook.ts",
+    "specs/**/hooks/**/web.hook.ts",
+    "specs/**/hooks/**/android.hook.ts",
+    "specs/**/web.test.ts",
+    "specs/**/android.test.ts"
+  ]
+}

package/templates/nx/default/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "types": ["node", "@wdio/globals/types", "@wdio/mocha-framework"],
+    "plugins": [
+      { "name": "@testspectra/cli" }
+    ],
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true
+  },
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.web.json" },
+    { "path": "./tsconfig.android.json" },
+    { "path": "./tsconfig.ios.json" }
+  ]
+}

package/templates/nx/default/tsconfig.web.json

@@ -0,0 +1,45 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "composite": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "types": ["node", "@wdio/globals/types", "@wdio/mocha-framework"]
+  },
+  "include": [
+    ".testspectra/types/web.d.ts",
+    ".testspectra/types/fixtures.d.ts",
+    "page-objects/**/*.ts",
+    "steps/**/*.ts",
+    "actions/**/*.ts",
+    "global-hooks/**/*.ts",
+    "specs/**/hooks/**/*.ts",
+    "specs/**/*.ts",
+    "spectra.config.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "page-objects/**/android.ts",
+    "page-objects/**/ios.ts",
+    "page-objects/**/mobile.ts",
+    "steps/**/android.step.ts",
+    "steps/**/ios.step.ts",
+    "steps/**/mobile.step.ts",
+    "actions/**/android.action.ts",
+    "actions/**/ios.action.ts",
+    "actions/**/mobile.action.ts",
+    "global-hooks/**/android.hook.ts",
+    "global-hooks/**/ios.hook.ts",
+    "global-hooks/**/mobile.hook.ts",
+    "specs/**/hooks/**/android.hook.ts",
+    "specs/**/hooks/**/ios.hook.ts",
+    "specs/**/hooks/**/mobile.hook.ts",
+    "specs/**/android.test.ts",
+    "specs/**/ios.test.ts",
+    "specs/**/mobile.test.ts"
+  ]
+}

package/templates/nx/fixtures/couponCode.json

@@ -0,0 +1 @@
+"DISCOUNT50"

package/templates/nx/fixtures/searchQuery.json

@@ -0,0 +1 @@
+"Laptop Gaming"

package/templates/nx/fixtures/userData.json

@@ -0,0 +1 @@
+{"username": "tomsmith", "role": "admin"}

package/templates/nx/global-hooks/before.web.hook.ts

@@ -0,0 +1,4 @@
+export default async function (): Promise<void> {
+  // Global before setup (executed once before all suites)
+  await browser.maximizeWindow();
+}

package/templates/nx/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@testspectra/template-nx",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "test": "spectra run",
+    "type-check": "tsc -b"
+  },
+  "devDependencies": {
+    "@testspectra/cli": "workspace:*",
+    "@types/node": "^20.14.0",
+    "@wdio/globals": "^9.2.8",
+    "@wdio/mocha-framework": "^9.2.8",
+    "webdriverio": "^9.2.8",
+    "typescript": "^5.4.5"
+  }
+}

package/templates/nx/page-objects/LoginPage/mobile.ts

@@ -0,0 +1,32 @@
+export default class LoginPage {
+  static get usernameInput(): ChainablePromiseElement {
+    return $('~username_input');
+  }
+
+  static get passwordInput(): ChainablePromiseElement {
+    return $('~password_input');
+  }
+
+  static get rememberMeCheckbox(): ChainablePromiseElement {
+    return $('~remember_me_checkbox');
+  }
+
+  static get submitButton(): ChainablePromiseElement {
+    return $('~login_button');
+  }
+
+  static get welcomeText(): ChainablePromiseElement {
+    return $('~welcome_text');
+  }
+
+  static async open() {
+    // Mobile app launch handled by Appium capabilities
+  }
+
+  static async login(username: string, pass: string) {
+    await Spectra.waitForElement(this.usernameInput);
+    await Spectra.type(this.usernameInput, username, { clearFirst: true });
+    await Spectra.type(this.passwordInput, pass, { clearFirst: true });
+    await Spectra.click(this.submitButton);
+  }
+}

package/templates/nx/page-objects/LoginPage/web.ts

@@ -0,0 +1,32 @@
+export default class LoginPage {
+  static get usernameInput(): ChainablePromiseElement {
+    return $('#username');
+  }
+
+  static get passwordInput(): ChainablePromiseElement {
+    return $('#password');
+  }
+
+  static get rememberMeCheckbox(): ChainablePromiseElement {
+    return $('#remember-me');
+  }
+
+  static get submitButton(): ChainablePromiseElement {
+    return $('button[type="submit"]');
+  }
+
+  static get flashAlert(): ChainablePromiseElement {
+    return $('#flash');
+  }
+
+  static async open() {
+    await Spectra.navigate('/login');
+  }
+
+  static async login(username: string, pass: string) {
+    await Spectra.waitForElement(this.usernameInput);
+    await Spectra.type(this.usernameInput, username, { clearFirst: true });
+    await Spectra.type(this.passwordInput, pass, { clearFirst: true });
+    await Spectra.click(this.submitButton);
+  }
+}

package/templates/nx/page-objects/ProductPage/mobile.ts

@@ -0,0 +1,39 @@
+export default class ProductPage {
+  static get searchInput(): ChainablePromiseElement {
+    return $('~search_input');
+  }
+
+  static get categorySelect(): ChainablePromiseElement {
+    return $('~category_picker');
+  }
+
+  static get productList(): ChainablePromiseElement {
+    return $('~product_list');
+  }
+
+  static get firstProductCard(): ChainablePromiseElement {
+    return $('~product_item_0');
+  }
+
+  static get addToCartButton(): ChainablePromiseElement {
+    return $('~btn_add_to_cart');
+  }
+
+  static get cartBadge(): ChainablePromiseElement {
+    return $('~cart_badge');
+  }
+
+  static async open() {
+    // Mobile in-app navigation to products tab
+  }
+
+  static async filterByCategory(category: string) {
+    await Spectra.click(this.categorySelect);
+    await Spectra.click(`~option_${category}`);
+  }
+
+  static async addFirstProductToCart() {
+    await Spectra.swipe({ direction: "down", distance: 400 });
+    await Spectra.click(this.addToCartButton);
+  }
+}

package/templates/nx/page-objects/ProductPage/web.ts

@@ -0,0 +1,38 @@
+export default class ProductPage {
+  static get searchInput(): ChainablePromiseElement {
+    return $('#search-input');
+  }
+
+  static get categorySelect(): ChainablePromiseElement {
+    return $('#category-select');
+  }
+
+  static get productList(): ChainablePromiseElement {
+    return $('#product-grid');
+  }
+
+  static get firstProductCard(): ChainablePromiseElement {
+    return $('.product-card');
+  }
+
+  static get addToCartButton(): ChainablePromiseElement {
+    return $('#add-to-cart');
+  }
+
+  static get cartBadge(): ChainablePromiseElement {
+    return $('#cart-count');
+  }
+
+  static async open() {
+    await Spectra.navigate('/products');
+  }
+
+  static async filterByCategory(category: string) {
+    await Spectra.select(this.categorySelect, category);
+  }
+
+  static async addFirstProductToCart() {
+    await Spectra.scroll({ selector: this.firstProductCard });
+    await Spectra.click(this.addToCartButton);
+  }
+}

package/templates/nx/page-objects/SettingsPage/common.ts

@@ -0,0 +1,26 @@
+export default class SettingsPage {
+  static get darkModeToggle(): ChainablePromiseElement {
+    return $('[data-testid="dark-mode-toggle"]');
+  }
+
+  static get languageDropdown(): ChainablePromiseElement {
+    return $('[data-testid="language-select"]');
+  }
+
+  static get saveButton(): ChainablePromiseElement {
+    return $('[data-testid="save-settings"]');
+  }
+
+  static get statusMessage(): ChainablePromiseElement {
+    return $('[data-testid="status-message"]');
+  }
+
+  static async open() {
+    await Spectra.navigate('/settings');
+  }
+
+  static async toggleDarkMode() {
+    await Spectra.click(this.darkModeToggle);
+    await Spectra.click(this.saveButton);
+  }
+}

package/templates/nx/project.json

@@ -0,0 +1,34 @@
+{
+  "name": "{{PROJECT_NAME}}",
+  "$schema": "node_modules/nx/schemas/project-schema.json",
+  "projectType": "application",
+  "sourceRoot": ".",
+  "targets": {
+    "e2e": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "spectra run",
+        "cwd": "{{PROJECT_DIR}}"
+      },
+      "configurations": {
+        "android": {
+          "command": "spectra run --target android"
+        },
+        "ios": {
+          "command": "spectra run --target ios"
+        },
+        "headless": {
+          "command": "spectra run --headless"
+        }
+      }
+    },
+    "type-check": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "tsc -b",
+        "cwd": "{{PROJECT_DIR}}"
+      }
+    }
+  },
+  "tags": ["type:e2e", "framework:testspectra"]
+}

package/templates/nx/specs/Auth/TC-AUTH-01/android.test.ts

@@ -0,0 +1,6 @@
+it("should authenticate user on Android Appium device", async () => {
+  await Step.loginUser("tomsmith", "SuperSecretPassword!");
+
+  await LoginPage.welcomeText.shouldBeVisible();
+  await LoginPage.welcomeText.shouldContainText("Welcome");
+});

package/templates/nx/specs/Auth/TC-AUTH-01/ios.test.ts

@@ -0,0 +1,6 @@
+it("should authenticate user on iOS Appium device", async () => {
+  await Step.loginUser("tomsmith", "SuperSecretPassword!");
+
+  await LoginPage.welcomeText.shouldBeVisible();
+  await LoginPage.welcomeText.shouldContainText("Welcome");
+});

package/templates/nx/specs/Auth/TC-AUTH-01/web.test.ts

@@ -0,0 +1,13 @@
+it("should authenticate user and verify flash message across specific platforms", async () => {
+  await browser.intercept("/api/status", "GET", Fixture.userData);
+
+  // 1. Navigation via Page Object
+  await LoginPage.open();
+
+  // 2. High-level business flow via Shared Step & Page Object
+  await Step.loginUser("tomsmith", "SuperSecretPassword!");
+
+  // 3. Direct callable assertion on Page Object element
+  await LoginPage.flashAlert.shouldBeVisible();
+  await LoginPage.flashAlert.shouldContainText("You logged into a secure area!");
+});

package/templates/nx/specs/Auth/TC-AUTH-02/android.test.ts

@@ -0,0 +1,5 @@
+it("should toggle remember me checkbox on Android", async () => {
+  await LoginPage.open();
+  await LoginPage.rememberMeCheckbox.shouldBeVisible();
+  await Spectra.click(LoginPage.rememberMeCheckbox);
+});

package/templates/nx/specs/Auth/TC-AUTH-02/web.test.ts

@@ -0,0 +1,5 @@
+it("should toggle remember me checkbox on Web", async () => {
+  await LoginPage.open();
+  await LoginPage.rememberMeCheckbox.shouldBeVisible();
+  await Spectra.click(LoginPage.rememberMeCheckbox);
+});

package/templates/nx/specs/Auth/hooks/before.android.hook.ts

@@ -0,0 +1,3 @@
+export default async function (): Promise<void> {
+  // Setup Android Appium capabilities
+}

package/templates/nx/specs/Auth/hooks/before.ios.hook.ts

@@ -0,0 +1,3 @@
+export default async function (): Promise<void> {
+  // Setup iOS Appium capabilities
+}

package/templates/nx/specs/Auth/hooks/before.web.hook.ts

@@ -0,0 +1,3 @@
+export default async function (): Promise<void> {
+  // Suite-specific setup before test cases in Auth suite run
+}

package/templates/nx/specs/Product/TC-PROD-01/mobile.test.ts

@@ -0,0 +1,8 @@
+it("should filter products by category and add to cart on Mobile (Android & iOS)", async () => {
+  await ProductPage.open();
+  await ProductPage.filterByCategory("Electronics");
+  await ProductPage.addFirstProductToCart();
+
+  await ProductPage.cartBadge.shouldBeVisible();
+  await ProductPage.cartBadge.shouldHaveText("1");
+});

package/templates/nx/specs/Product/TC-PROD-01/web.test.ts

@@ -0,0 +1,8 @@
+it("should filter products by category and add to cart on Web", async () => {
+  await ProductPage.open();
+  await ProductPage.filterByCategory("Electronics");
+  await ProductPage.addFirstProductToCart();
+
+  await ProductPage.cartBadge.shouldBeVisible();
+  await ProductPage.cartBadge.shouldHaveText("1");
+});

package/templates/nx/specs/Product/TC-PROD-02/mobile.test.ts

@@ -0,0 +1,6 @@
+it("should search products and apply promotional discount coupon on Mobile", async () => {
+  await Step.searchProduct(Fixture.searchQuery);
+  await Spectra.applyDiscount(Fixture.couponCode);
+
+  await ProductPage.firstProductCard.shouldBeVisible();
+});

package/templates/nx/specs/Product/TC-PROD-02/web.test.ts

@@ -0,0 +1,6 @@
+it("should search products and apply promotional discount coupon on Web", async () => {
+  await Step.searchProduct(Fixture.searchQuery);
+  await Spectra.applyDiscount(Fixture.couponCode);
+
+  await ProductPage.firstProductCard.shouldBeVisible();
+});

package/templates/nx/specs/Product/hooks/before.web.hook.ts

@@ -0,0 +1,3 @@
+export default async function (): Promise<void> {
+  // Suite-specific setup for Product catalog suite
+}

package/templates/nx/specs/Settings/TC-SET-01/common.test.ts

@@ -0,0 +1,8 @@
+it("should toggle dark mode setting across all platforms (Common)", async () => {
+  await SettingsPage.open();
+  await SettingsPage.darkModeToggle.shouldBeVisible();
+  await SettingsPage.toggleDarkMode();
+
+  await SettingsPage.statusMessage.shouldBeVisible();
+  await SettingsPage.statusMessage.shouldContainText("Settings saved");
+});

package/templates/nx/spectra.config.ts

@@ -0,0 +1,61 @@
+import { defineConfig } from "@testspectra/cli";
+
+export default defineConfig({
+  webConfig: {
+    baseUrl: "https://the-internet.herokuapp.com",
+    maxConcurrentSessions: "1",
+    headlessMode: true,
+    implicitWait: "5000",
+    pageLoadTimeout: "30000",
+    scriptTimeout: "30000",
+    parallelizationMode: "testcase",
+  },
+  browsers: [
+    {
+      id: "chrome-desktop",
+      type: "chrome",
+      mobileEmulation: false,
+    },
+  ],
+  androidConfig: {
+    appiumServer: "http://127.0.0.1:4723",
+    platformName: "Android",
+    platformVersion: "13",
+    deviceName: "emulator-5554",
+    automationName: "UiAutomator2",
+    appPackage: "",
+    appActivity: "",
+    autoGrantPermissions: true,
+    noReset: false,
+    implicitWait: "10000",
+    parallelizationMode: "suite",
+  },
+  iosConfig: {
+    appiumServer: "http://127.0.0.1:4723",
+    platformName: "iOS",
+    platformVersion: "16.0",
+    deviceName: "iPhone 14",
+    automationName: "XCUITest",
+    bundleId: "",
+    udid: "auto",
+    xcodeOrgId: "",
+    xcodeSigningId: "iPhone Developer",
+    autoAcceptAlerts: true,
+    noReset: false,
+    implicitWait: "10000",
+    parallelizationMode: "suite",
+  },
+  loadConfig: {
+    virtualUsers: "10",
+    duration: "1m",
+  },
+  loadStages: [],
+  thresholds: [],
+  executionConfig: {
+    networkMonitoringEnabled: true,
+    fastResponseTime: "200",
+    normalResponseTime: "1000",
+    monitoredDomains: [],
+    environmentVariables: [],
+  },
+});

package/templates/nx/steps/loginUser/mobile.step.ts

@@ -0,0 +1,4 @@
+export default async function loginUser(u: string, p: string): Promise<void> {
+  await LoginPage.open();
+  await LoginPage.login(u, p);
+}

package/templates/nx/steps/loginUser/web.step.ts

@@ -0,0 +1,4 @@
+export default async function loginUser(u: string, p: string): Promise<void> {
+  await LoginPage.open();
+  await LoginPage.login(u, p);
+}