agentq-webdriverio 1.0.2 → 1.0.3

package/README.md

@@ -1 +1,113 @@
-# agentq-webdriverio
+# AgentQ for WebdriverIO
+
+Integrate WebdriverIO (TypeScript) with AgentQ AI for AI-driven automation and automated test-result reporting.
+
+## Installation
+
+```bash
+npm install agentq-webdriverio
+```
+
+## Configuration
+
+### 1. AgentQ config (AI steps)
+
+Create `agentq.config.json` in your project root with your company API key (from your account profile; you must sign in first):
+
+```json
+{
+  "TOKEN": "YOUR_API_KEY"
+}
+```
+
+Or export it as an environment variable:
+
+```bash
+export AGENTQ_TOKEN="YOUR_API_KEY"
+```
+
+### 2. Environment variables (result reporting)
+
+Set these in `.env` or your CI environment. The recommended way is the company API key — the same key as above, no email/password needed:
+
+```bash
+AGENTQ_API_KEY=your_company_api_key   # from your AgentQ profile
+AGENTQ_PROJECT_ID=your_project_id
+AGENTQ_TESTRUN_ID=your_testrun_id
+AGENTQ_EMAIL=your_email               # optional: results show this member as "Created By" (owner or invited member of the key's company)
+```
+
+Email/password login is still supported as a fallback (when no API key is set):
+
+```bash
+AGENTQ_EMAIL=your_email
+AGENTQ_PASSWORD=your_password
+```
+
+### 3. WebdriverIO hooks (`wdio.conf.ts`)
+
+```typescript
+import { initAgentQ, handleTestConclusion } from 'agentq-webdriverio';
+
+export const config: WebdriverIO.Config = {
+  // ... other config
+
+  before: function () {
+    initAgentQ(browser);
+  },
+
+  afterTest: async function (test, context, { error, duration, passed }) {
+    await handleTestConclusion(
+      test.title,
+      passed ? 'passed' : 'failed',
+      Date.now() - duration,
+      error?.message
+    );
+  },
+};
+```
+
+## Usage
+
+Prefix test titles with the AgentQ test case ID (e.g. `17-`) — results are matched to test cases by that numeric prefix:
+
+```typescript
+import { q, test } from 'agentq-webdriverio';
+
+describe('AI Automation Flow', () => {
+  test('17-should login using AI instructions', async () => {
+    await browser.url('https://the-internet.herokuapp.com/login');
+
+    await q('user fill username tomsmith');
+    await q('user fill password SuperSecretPassword!');
+    await q('user click login button');
+
+    const flashAlert = await $('#flash');
+    await expect(flashAlert).toHaveText(
+      expect.stringContaining('You logged into a secure area!')
+    );
+  });
+});
+```
+
+## Test Run Sync (pull test suite & push results)
+
+Pull a test suite from a test run and report each test's status back to AgentQ:
+
+```bash
+npx agentq-pull-testcase -- --tcid=YOUR_TC_ID
+npx agentq-pull-testsuite -- --testrunid=YOUR_TESTRUN_ID
+```
+
+Then run the generated specs:
+
+```bash
+npx wdio run ./wdio.conf.ts
+```
+
+> Tip for CI (e.g. GitHub Actions): store `AGENTQ_API_KEY` as a secret and export it in the workflow. API key auth skips the login endpoint entirely.
+
+## Plans and Rate Limits
+
+- Free: Free of charge
+- Pro & Enterprise: visit [www.agentq.id](https://www.agentq.id) or contact support@agentq.id to upgrade your plan.

package/dist/index.js

@@ -29,7 +29,8 @@ Object.defineProperty(exports, "uploadArtifact", { enumerable: true, get: functi
 async function handleTestConclusion(testTitle, status, startTime, errorDetails) {
     const tcId = parseInt(testTitle.split('-')[0]);
     if (!isNaN(tcId) && process.env.AGENTQ_TESTRUN_ID) {
-        if (!cachedAccessToken) {
+        // With AGENTQ_API_KEY set, requests use X-API-Key and no login is needed.
+        if (!process.env.AGENTQ_API_KEY && !cachedAccessToken) {
             cachedAccessToken = await (0, testResult_2.getAccessToken)();
         }
         const executionTime = (Date.now() - startTime) / 1000;

package/dist/pull-testcase.js

@@ -14,6 +14,7 @@ const config = {
     apiBaseUrl: process.env.AGENTQ_API_URL || 'https://backend-app.agentq.id',
     projectId: `${process.env.AGENTQ_PROJECT_ID}`,
     testRunId: `${process.env.AGENTQ_TESTRUN_ID}`,
+    apiKey: process.env.AGENTQ_API_KEY || null,
     authEndpoint: '/auth/login',
     authData: {
         email: `${process.env.AGENTQ_EMAIL}`,
@@ -21,6 +22,33 @@ const config = {
     },
     outputDir: path_1.default.join(process.cwd(), 'tests')
 };
+// Identify ourselves instead of the default axios/x.y UA, which bot
+// protections (e.g. Cloudflare) commonly flag in CI environments.
+let pkgVersion = '';
+try {
+    pkgVersion = require('../package.json').version;
+}
+catch { /* best effort */ }
+const USER_AGENT = `agentq-webdriverio${pkgVersion ? `/${pkgVersion}` : ''}`;
+// API key auth (X-API-Key) when AGENTQ_API_KEY is set, otherwise the
+// Bearer token obtained from email/password login.
+function authHeaders(accessToken) {
+    const headers = {
+        'accept': 'application/json',
+        'User-Agent': USER_AGENT
+    };
+    if (config.apiKey) {
+        headers['X-API-Key'] = config.apiKey;
+        // Optional attribution: see testResult.ts getAuthHeaders.
+        if (process.env.AGENTQ_EMAIL) {
+            headers['X-Actor-Email'] = process.env.AGENTQ_EMAIL;
+        }
+    }
+    else if (accessToken) {
+        headers['Authorization'] = `Bearer ${accessToken}`;
+    }
+    return headers;
+}
 // Parse command line arguments more robustly
 function parseArgs() {
     const args = process.argv.slice(2);
@@ -63,12 +91,18 @@ if (!fs_1.default.existsSync(config.outputDir)) {
     fs_1.default.mkdirSync(config.outputDir, { recursive: true });
 }
 async function getAccessToken() {
+    if (!process.env.AGENTQ_EMAIL || !process.env.AGENTQ_PASSWORD) {
+        console.error('Error: No credentials provided.');
+        console.error('Set AGENTQ_API_KEY (recommended), or AGENTQ_EMAIL and AGENTQ_PASSWORD.');
+        process.exit(1);
+    }
     try {
         console.log(`Authenticating with: ${config.apiBaseUrl}${config.authEndpoint}`);
         const response = await axios_1.default.post(`${config.apiBaseUrl}${config.authEndpoint}`, config.authData, {
             headers: {
                 'accept': 'application/json',
-                'Content-Type': 'application/json'
+                'Content-Type': 'application/json',
+                'User-Agent': USER_AGENT
             }
         });
         return response.data.access_token;
@@ -92,10 +126,7 @@ async function fetchTestCase(tcId, accessToken) {
     try {
         console.log(`Fetching test case from: ${config.apiBaseUrl}/projects/${config.projectId}/test-cases/tcId/${tcId}`);
         const response = await axios_1.default.get(`${config.apiBaseUrl}/projects/${config.projectId}/test-cases/tcId/${tcId}`, {
-            headers: {
-                'accept': 'application/json',
-                'Authorization': `Bearer ${accessToken}`
-            }
+            headers: authHeaders(accessToken)
         });
         return response.data;
     }
@@ -119,10 +150,7 @@ async function fetchTestSuite(testRunId, accessToken) {
         const apiUrl = `${config.apiBaseUrl}/projects/${config.projectId}/test-runs/${testRunId}/test-results?page=1&limit=10000`;
         console.log(`Fetching test suite results from: ${apiUrl}`);
         const response = await axios_1.default.get(apiUrl, {
-            headers: {
-                'accept': 'application/json',
-                'Authorization': `Bearer ${accessToken}`
-            }
+            headers: authHeaders(accessToken)
         });
         return response.data;
     }
@@ -225,13 +253,21 @@ ${expectationCode}
     console.log(`✅ Created: ${filePath}`);
     return filePath;
 }
+// Resolve auth once: API key needs no login round-trip.
+async function resolveAccessToken() {
+    if (config.apiKey) {
+        console.log(`🔑 Using AGENTQ_API_KEY for authentication.`);
+        return null;
+    }
+    const accessToken = await getAccessToken();
+    console.log(`🔑 Successfully obtained access token.`);
+    return accessToken;
+}
 // Main execution
 (async () => {
     if (tcId) {
         console.log(`🔍 Fetching test case with tcId: ${tcId}`);
-        // Get the access token
-        const accessToken = await getAccessToken();
-        console.log(`🔑 Successfully obtained access token.`);
+        const accessToken = await resolveAccessToken();
         // Fetch the test case using the access token
         const testCase = await fetchTestCase(tcId, accessToken);
         console.log(`📄 Found test case: ${testCase.title}`);
@@ -241,9 +277,7 @@ ${expectationCode}
     }
     else if (testRunId) {
         console.log(`🔍 Fetching test suite results for testRunId: ${testRunId}`);
-        // Get the access token
-        const accessToken = await getAccessToken();
-        console.log(`🔑 Successfully obtained access token.`);
+        const accessToken = await resolveAccessToken();
         // Fetch the test suite results
         const testSuiteResponse = await fetchTestSuite(testRunId, accessToken);
         const testResults = testSuiteResponse.results;

package/dist/testResult.d.ts

@@ -1,4 +1,5 @@
 import { TestResult } from './types';
+export declare function getAuthHeaders(): Promise<Record<string, string>>;
 export declare function getAccessToken(): Promise<string>;
 export declare function exportTestResult(tcId: string, testRunId: string, result: Partial<TestResult>): Promise<any>;
 export declare function uploadArtifact(testRunId: string, testResultId: string, type: 'screenshot' | 'video', filePath: string): Promise<any>;

package/dist/testResult.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAuthHeaders = getAuthHeaders;
 exports.getAccessToken = getAccessToken;
 exports.exportTestResult = exportTestResult;
 exports.uploadArtifact = uploadArtifact;
@@ -16,17 +17,50 @@ dotenv.config({ quiet: true });
 const config = {
     apiBaseUrl: process.env.AGENTQ_API_URL || 'https://backend-app.agentq.id',
     projectId: `${process.env.AGENTQ_PROJECT_ID}`,
+    apiKey: process.env.AGENTQ_API_KEY || null,
     authEndpoint: '/auth/login',
     authData: {
         email: `${process.env.AGENTQ_EMAIL}`,
         password: `${process.env.AGENTQ_PASSWORD}`
     }
 };
+// Identify ourselves instead of the default axios/x.y UA, which bot
+// protections (e.g. Cloudflare) commonly flag in CI environments.
+let pkgVersion = '';
+try {
+    pkgVersion = require('../package.json').version;
+}
+catch { /* best effort */ }
+const USER_AGENT = `agentq-webdriverio${pkgVersion ? `/${pkgVersion}` : ''}`;
 let cachedToken = null;
+// API key auth (X-API-Key) when AGENTQ_API_KEY is set, otherwise the
+// Bearer token obtained from email/password login.
+async function getAuthHeaders() {
+    const headers = {
+        'accept': 'application/json',
+        'User-Agent': USER_AGENT
+    };
+    if (config.apiKey) {
+        headers['X-API-Key'] = config.apiKey;
+        // Optional attribution: with API key auth, AGENTQ_EMAIL names the company
+        // member shown as "Created By" on pushed results (no password needed).
+        if (process.env.AGENTQ_EMAIL) {
+            headers['X-Actor-Email'] = process.env.AGENTQ_EMAIL;
+        }
+        return headers;
+    }
+    headers['Authorization'] = `Bearer ${await getAccessToken()}`;
+    return headers;
+}
 async function getAccessToken() {
     if (cachedToken) {
         return cachedToken;
     }
+    if (!process.env.AGENTQ_EMAIL || !process.env.AGENTQ_PASSWORD) {
+        console.error('Error: No credentials provided.');
+        console.error('Set AGENTQ_API_KEY (recommended), or AGENTQ_EMAIL and AGENTQ_PASSWORD.');
+        process.exit(1);
+    }
     try {
         // console.log(`Authenticating with: ${config.apiBaseUrl}${config.authEndpoint}`);
         const response = await axios_1.default.post(`${config.apiBaseUrl}${config.authEndpoint}`, config.authData, {
@@ -54,14 +88,13 @@ async function getAccessToken() {
     }
 }
 async function exportTestResult(tcId, testRunId, result) {
-    const accessToken = await getAccessToken();
+    const authHeaders = await getAuthHeaders();
     const apiUrl = `${config.apiBaseUrl}/projects/${config.projectId}/test-runs/${testRunId}/test-results/tcId/${tcId}`;
     try {
         // console.log(`Pushing test result to: ${apiUrl}`);
         const response = await axios_1.default.patch(apiUrl, result, {
             headers: {
-                'accept': 'application/json',
-                'Authorization': `Bearer ${accessToken}`,
+                ...authHeaders,
                 'Content-Type': 'application/json'
             }
         });
@@ -84,7 +117,7 @@ async function exportTestResult(tcId, testRunId, result) {
     }
 }
 async function uploadArtifact(testRunId, testResultId, type, filePath) {
-    const accessToken = await getAccessToken();
+    const authHeaders = await getAuthHeaders();
     const apiUrl = `${config.apiBaseUrl}/projects/${config.projectId}/test-runs/${testRunId}/test-results/${testResultId}/${type}`;
     if (!fs_1.default.existsSync(filePath)) {
         console.warn(`⚠️ Artifact file not found: ${filePath}`);
@@ -100,7 +133,7 @@ async function uploadArtifact(testRunId, testResultId, type, filePath) {
         // console.log(`Uploading ${type} to: ${apiUrl}`);
         const response = await axios_1.default.post(apiUrl, formData, {
             headers: {
-                'Authorization': `Bearer ${accessToken}`,
+                ...authHeaders,
                 'Content-Type': 'multipart/form-data'
             }
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agentq-webdriverio",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {

package/agentq.config.json

@@ -1,3 +0,0 @@
-{
-  "TOKEN": "efe9c3a612d6196c369c41de02fd63a8d1da8b9f00640daabf799bd01e7b6c1c"
-}