create-cmp-cli 0.2.0 → 0.3.0

package/template/qa/appium/lib/appium-client.mjs

@@ -1,225 +0,0 @@
-import fs from 'node:fs/promises';
-
-export class AppiumClient {
-  constructor({ serverUrl, capabilities }) {
-    this.serverUrl = serverUrl.replace(/\/$/, '');
-    this.capabilities = capabilities;
-    this.sessionId = null;
-  }
-
-  async start() {
-    const result = await this.#request('/session', {
-      method: 'POST',
-      body: {
-        capabilities: {
-          alwaysMatch: this.capabilities,
-          firstMatch: [{}],
-        },
-      },
-    });
-    this.sessionId = result.sessionId ?? result.value?.sessionId;
-    return this.sessionId;
-  }
-
-  async stop() {
-    if (!this.sessionId) {
-      return;
-    }
-    await this.#request(`/session/${this.sessionId}`, { method: 'DELETE' });
-    this.sessionId = null;
-  }
-
-  async pause(ms) {
-    await new Promise((resolve) => setTimeout(resolve, ms));
-  }
-
-  async back() {
-    await this.#sessionRequest('/back', { method: 'POST', body: {} });
-  }
-
-  async screenshot(filePath) {
-    const result = await this.#sessionRequest('/screenshot', { method: 'GET' });
-    await fs.mkdir(new URL('.', `file://${filePath}`).pathname, { recursive: true }).catch(() => {});
-    await fs.writeFile(filePath, Buffer.from(result.value, 'base64'));
-  }
-
-  async pageSource() {
-    const result = await this.#sessionRequest('/source', { method: 'GET' });
-    return result.value;
-  }
-
-  async clickByText(text, timeoutMs = 10000) {
-    await this.clickByXPath(`//*[@text=${escapeXPathText(text)}]`, timeoutMs);
-  }
-
-  async clickByTextContaining(text, timeoutMs = 10000) {
-    await this.clickByXPath(`//*[contains(@text,${escapeXPathText(text)})]`, timeoutMs);
-  }
-
-  async waitForTextContaining(text, timeoutMs = 10000) {
-    const safeText = escapeXPathText(text);
-    return this.waitForElement('xpath', `//*[contains(@text,${safeText})]`, timeoutMs);
-  }
-
-  async clickByAccessibilityId(label, timeoutMs = 10000) {
-    const elementId = await this.waitForElement('accessibility id', label, timeoutMs);
-    await this.clickElement(elementId);
-  }
-
-  async clickByXPath(xpath, timeoutMs = 10000) {
-    const elementId = await this.waitForElement('xpath', xpath, timeoutMs);
-    await this.clickElement(elementId);
-  }
-
-  async clickElement(elementId) {
-    await this.#sessionRequest(`/element/${elementId}/click`, { method: 'POST', body: {} });
-  }
-
-  async waitForText(text, timeoutMs = 10000) {
-    const safeText = escapeXPathText(text);
-    return this.waitForElement('xpath', `//*[@text=${safeText}]`, timeoutMs);
-  }
-
-  async elementExists(using, value) {
-    try {
-      await this.#sessionRequest('/element', {
-        method: 'POST',
-        body: { using, value },
-      });
-      return true;
-    } catch {
-      return false;
-    }
-  }
-
-  async typeByXPath(xpath, text, timeoutMs = 10000) {
-    const elementId = await this.waitForElement('xpath', xpath, timeoutMs);
-    await this.clickElement(elementId);
-    await this.clearElement(elementId);
-    await this.typeElement(elementId, text);
-    return elementId;
-  }
-
-  async typeIntoLabeledField(label, text, timeoutMs = 10000) {
-    const safeLabel = escapeXPathText(label);
-    return this.typeByXPath(`//android.widget.EditText[.//android.widget.TextView[@text=${safeLabel}]]`, text, timeoutMs);
-  }
-
-  async clearElement(elementId) {
-    await this.#sessionRequest(`/element/${elementId}/clear`, { method: 'POST', body: {} });
-  }
-
-  async typeElement(elementId, text) {
-    await this.#sessionRequest(`/element/${elementId}/value`, {
-      method: 'POST',
-      body: {
-        text,
-        value: Array.from(text),
-      },
-    });
-  }
-
-  async waitForTextGone(text, timeoutMs = 10000) {
-    const safeText = escapeXPathText(text);
-    const startedAt = Date.now();
-    while (Date.now() - startedAt < timeoutMs) {
-      const exists = await this.elementExists('xpath', `//*[@text=${safeText}]`);
-      if (!exists) {
-        return;
-      }
-      await this.pause(300);
-    }
-    throw new Error(`Timed out waiting for text to disappear: ${text}`);
-  }
-
-  async getWindowRect() {
-    const result = await this.#sessionRequest('/window/rect', { method: 'GET' });
-    return result.value;
-  }
-
-  async swipe(startX, startY, endX, endY, durationMs = 350) {
-    await this.#sessionRequest('/actions', {
-      method: 'POST',
-      body: {
-        actions: [
-          {
-            type: 'pointer',
-            id: 'finger1',
-            parameters: { pointerType: 'touch' },
-            actions: [
-              { type: 'pointerMove', duration: 0, x: startX, y: startY },
-              { type: 'pointerDown', button: 0 },
-              { type: 'pause', duration: 100 },
-              { type: 'pointerMove', duration: durationMs, x: endX, y: endY },
-              { type: 'pointerUp', button: 0 },
-            ],
-          },
-        ],
-      },
-    });
-    await this.#sessionRequest('/actions', { method: 'DELETE', body: {} });
-  }
-
-  async swipeUp() {
-    const rect = await this.getWindowRect();
-    const midX = Math.round(rect.width / 2);
-    await this.swipe(midX, Math.round(rect.height * 0.8), midX, Math.round(rect.height * 0.35));
-  }
-
-  async waitForElement(using, value, timeoutMs = 10000) {
-    const startedAt = Date.now();
-    let lastError = null;
-    while (Date.now() - startedAt < timeoutMs) {
-      try {
-        const result = await this.#sessionRequest('/element', {
-          method: 'POST',
-          body: { using, value },
-        });
-        const element = result.value;
-        const elementId = element?.['element-6066-11e4-a52e-4f735466cecf'] ?? element?.ELEMENT;
-        if (elementId) {
-          return elementId;
-        }
-      } catch (error) {
-        lastError = error;
-      }
-      await this.pause(350);
-    }
-    throw new Error(`Timed out waiting for element ${using}=${value}: ${lastError?.message ?? 'not found'}`);
-  }
-
-  async #sessionRequest(path, options) {
-    if (!this.sessionId) {
-      throw new Error('Appium session has not been started');
-    }
-    return this.#request(`/session/${this.sessionId}${path}`, options);
-  }
-
-  async #request(path, { method, body } = {}) {
-    const response = await fetch(`${this.serverUrl}${path}`, {
-      method,
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      body: body === undefined ? undefined : JSON.stringify(body),
-    });
-    const text = await response.text();
-    const json = text ? JSON.parse(text) : {};
-    if (!response.ok) {
-      const message = json.value?.message ?? json.error ?? text;
-      throw new Error(message);
-    }
-    return json;
-  }
-}
-
-export function escapeXPathText(text) {
-  if (!text.includes("'")) {
-    return `'${text}'`;
-  }
-  if (!text.includes('"')) {
-    return `"${text}"`;
-  }
-  const parts = text.split("'").map((part) => `'${part}'`);
-  return `concat(${parts.join(', "\'", ')})`;
-}

package/template/qa/appium/package.json

@@ -1,8 +0,0 @@
-{
-  "name": "__APP_NAME__-appium",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "smoke": "node run-android-smoke.mjs"
-  }
-}

package/template/qa/appium/run-android-smoke.mjs

@@ -1,39 +0,0 @@
-// Android smoke runner — asserts the app launches and the bottom-nav shell renders.
-// Prereqs: an Appium 3.x server on http://127.0.0.1:4723 and a running emulator-5554
-// with the debug APK installed (./gradlew :composeApp:installDebug).
-import { AppiumClient } from './lib/appium-client.mjs';
-
-const APP_PACKAGE = '__PACKAGE__';
-const APP_ACTIVITY = '__PACKAGE__.MainActivity';
-
-const client = new AppiumClient({
-  serverUrl: 'http://127.0.0.1:4723',
-  capabilities: {
-    platformName: 'Android',
-    'appium:automationName': 'UiAutomator2',
-    'appium:deviceName': 'emulator-5554',
-    'appium:udid': 'emulator-5554',
-    'appium:appPackage': APP_PACKAGE,
-    'appium:appActivity': APP_ACTIVITY,
-    'appium:forceAppLaunch': true,
-    'appium:newCommandTimeout': 120,
-  },
-});
-
-async function main() {
-  await client.start();
-  try {
-    await client.waitForText('Home', 20000);
-    await client.waitForText('Profile', 10000);
-    await client.clickByText('Profile', 10000);
-    await client.waitForTextContaining('stub screen', 10000);
-    console.log('SMOKE PASS: bottom-nav shell rendered and tab switch works.');
-  } finally {
-    await client.stop();
-  }
-}
-
-main().catch((err) => {
-  console.error('SMOKE FAIL:', err.message);
-  process.exit(1);
-});

package/template/tests/appium/cmp/conftest.py

@@ -1,96 +0,0 @@
-"""
-Shared Appium session configuration for the __APP_NAME__ Android app.
-Appium 3.x + UiAutomator2. Start an Appium server on 127.0.0.1:4723 and a running
-emulator-5554 before invoking pytest.
-"""
-import base64
-import os
-import re
-import time
-
-import pytest
-import requests
-
-APPIUM_URL = "http://127.0.0.1:4723"
-CAPABILITIES = {
-    "platformName": "Android",
-    "appium:automationName": "UiAutomator2",
-    "appium:deviceName": "emulator-5554",
-    "appium:udid": "emulator-5554",
-    "appium:appPackage": "__PACKAGE__",
-    "appium:appActivity": "__PACKAGE__.MainActivity",
-    "appium:noReset": False,
-    "appium:forceAppLaunch": True,
-    "appium:newCommandTimeout": 120,
-}
-SCREENSHOTS_DIR = "qa-artifacts/appium-cmp"
-
-
-def escape_xpath(text: str) -> str:
-    if "'" not in text:
-        return f"'{text}'"
-    if '"' not in text:
-        return f'"{text}"'
-    parts = text.split("'")
-    return "concat('" + "', \"'\", '".join(parts) + "')"
-
-
-class AppiumDriver:
-    def __init__(self, session_id: str):
-        self.session_id = session_id
-        self.base = f"{APPIUM_URL}/session/{session_id}"
-
-    def _req(self, method: str, path: str, body=None, timeout: int = 30) -> dict:
-        resp = requests.request(method, self.base + path, json=body, timeout=timeout)
-        return resp.json() if resp.content else {}
-
-    def source(self) -> str:
-        return self._req("GET", "/source").get("value", "")
-
-    def _find_xpath(self, xpath: str, timeout: int = 10) -> str:
-        deadline = time.time() + timeout
-        while time.time() < deadline:
-            r = requests.post(self.base + "/element",
-                              json={"using": "xpath", "value": xpath}, timeout=10)
-            if r.status_code == 200:
-                val = r.json().get("value", {})
-                if isinstance(val, dict) and val:
-                    return next(iter(val.values()))
-            time.sleep(0.5)
-        raise TimeoutError(f"Element not found: {xpath}")
-
-    def find_by_text(self, text: str, timeout: int = 10) -> str:
-        return self._find_xpath(f"//*[@text={escape_xpath(text)}]", timeout)
-
-    def text_exists(self, text: str, timeout: int = 5) -> bool:
-        try:
-            self.find_by_text(text, timeout)
-            return True
-        except TimeoutError:
-            return False
-
-    def click_text(self, text: str, timeout: int = 10):
-        self._req("POST", f"/element/{self.find_by_text(text, timeout)}/click")
-
-    def screenshot(self, name: str = "screenshot") -> str:
-        os.makedirs(SCREENSHOTS_DIR, exist_ok=True)
-        r = self._req("GET", "/screenshot", timeout=15)
-        if r.get("value"):
-            path = f"{SCREENSHOTS_DIR}/{name}_{int(time.time())}.png"
-            with open(path, "wb") as f:
-                f.write(base64.b64decode(r["value"]))
-            return path
-        return ""
-
-
-@pytest.fixture(scope="module")
-def driver():
-    resp = requests.post(f"{APPIUM_URL}/session",
-                         json={"capabilities": {"alwaysMatch": CAPABILITIES}}, timeout=60)
-    resp.raise_for_status()
-    data = resp.json()
-    session_id = data.get("sessionId") or data.get("value", {}).get("sessionId")
-    time.sleep(5)
-    drv = AppiumDriver(session_id)
-    yield drv
-    requests.delete(f"{APPIUM_URL}/session/{session_id}", timeout=15)

package/template/tests/appium/cmp/test_smoke.py

@@ -1,17 +0,0 @@
-"""
-Smoke test: the app launches and the generic bottom-nav shell renders.
-This is the `--verify` Appium gate the scaffolder runs to prove the stamped app is alive.
-"""
-
-
-def test_bottom_nav_renders(driver):
-    # Home tab title is present on first launch.
-    assert driver.text_exists("Home", timeout=20), "Home screen did not render"
-    # Both default tabs are present in the bottom nav.
-    assert driver.text_exists("Profile", timeout=10), "Profile tab not found in bottom nav"
-
-
-def test_can_switch_to_profile_tab(driver):
-    driver.click_text("Profile", timeout=10)
-    assert driver.text_exists("This is a stub screen.", timeout=10), \
-        "Profile tab content did not render after tapping the tab"