@aqa-pulse/cli 0.1.0 → 0.2.0

package/README.md

@@ -5,26 +5,74 @@ CLI для подключения Playwright-проектов к AQA Pulse бе
 ## Команды
 
 ```bash
+aqa-pulse upload-from-config --config .aqa-pulse.yml
 aqa-pulse upload-report --generate-source-facts --repo-root "$CI_PROJECT_DIR"
 aqa-pulse merge-reports --project-kind ui --output test-results/dashboard/ui-merged.json test-results/dashboard/ui-*.json
 aqa-pulse generate-source-facts --report test-results/dashboard/data.json --repo-root .
 ```
 
+## .aqa-pulse.yml
+
+Минимальный конфиг для одного готового отчета:
+
+```yaml
+projectDir: Playwright
+reportPath: test-results/dashboard/data.json
+repoRoot: .
+```
+
+Конфиг для merge нескольких отчетов и последующего upload:
+
+```yaml
+projectDir: Playwright
+repoRoot: .
+
+merge:
+  projectKind: ui
+  output: test-results/dashboard/ui-merged.json
+  allowMissing: true
+  inputs:
+    - test-results/dashboard/ui-purchase.json
+    - test-results/dashboard/ui-cpu.json
+    - test-results/dashboard/ui-first.json
+    - test-results/dashboard/ui-second.json
+```
+
+Пути считаются относительно `projectDir`. Если `projectDir` не указан, пути считаются относительно папки, где лежит `.aqa-pulse.yml`.
+
 ## GitLab CI
 
+В GitLab CI/CD Variables храни:
+
+```text
+AQA_PULSE_BASE_URL
+AQA_PULSE_WORKSPACE_SLUG
+AQA_PULSE_WORKSPACE_API_KEY
+```
+
+В `.gitlab-ci.yml` можно подключить общий template из репозитория AQA Pulse:
+
 ```yaml
-variables:
-  AQA_PULSE_BASE_URL: "https://aqa-pulse.example.com"
-  AQA_PULSE_WORKSPACE_SLUG: "autotests-main"
-  AQA_PULSE_REPORT_PATH: "Playwright/test-results/dashboard/data.json"
-
-script:
-  - npm ci
-  - npm test
-  - npx @aqa-pulse/cli upload-report --generate-source-facts --repo-root "$CI_PROJECT_DIR"
+include:
+  - project: 'your-group/AQAPulse'
+    ref: main
+    file: '/aqa-pulse-server/template/gitlab/aqa-pulse-upload.gitlab-ci.yml'
+
+aqa pulse upload:
+  extends: .aqa_pulse_upload_from_config
+  needs:
+    - job: playwright tests
+      artifacts: true
 ```
 
-`AQA_PULSE_WORKSPACE_API_KEY` лучше хранить в GitLab CI/CD Variables.
+Test job должна сохранить report/artifacts, например:
+
+```yaml
+artifacts:
+  when: always
+  paths:
+    - Playwright/test-results/dashboard
+```
 
 ## Публикация
 
@@ -33,11 +81,3 @@ script:
 ```bash
 npm publish --access public
 ```
-
-GitLab Package Registry:
-
-```bash
-echo "@aqa-pulse:registry=${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/npm/" > .npmrc
-echo "//${CI_SERVER_HOST}/api/v4/projects/${CI_PROJECT_ID}/packages/npm/:_authToken=${CI_JOB_TOKEN}" >> .npmrc
-npm publish
-```

package/bin/aqa-pulse.js

@@ -12,6 +12,8 @@ const commandMap = {
     merge: '../dist/backend/merge-reports.js',
     'generate-source-facts': '../dist/backend/generate-source-facts.js',
     'source-facts': '../dist/backend/generate-source-facts.js',
+    'upload-from-config': '../dist/backend/upload-from-config.js',
+    config: '../dist/backend/upload-from-config.js',
 }
 
 if (command === '--help' || command === '-h') {
@@ -39,11 +41,13 @@ function printHelp() {
     console.log('')
     console.log('Использование:')
     console.log('  aqa-pulse upload-report [--report <path>] [--generate-source-facts] [--repo-root <path>]')
+    console.log('  aqa-pulse upload-from-config [--config .aqa-pulse.yml]')
     console.log('  aqa-pulse merge-reports --project-kind ui|api --output <path> [--allow-missing] <input...>')
     console.log('  aqa-pulse generate-source-facts [--report <path>] [--out <path>] [--repo-root <path>]')
     console.log('')
     console.log('Короткие алиасы:')
     console.log('  aqa-pulse upload')
+    console.log('  aqa-pulse config')
     console.log('  aqa-pulse merge')
     console.log('  aqa-pulse source-facts')
 }

package/dist/backend/upload-from-config.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/backend/upload-from-config.js

@@ -0,0 +1,287 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
+const node_child_process_1 = require("node:child_process");
+const error_utils_1 = require("../shared/error-utils");
+if (require.main === module) {
+    void main();
+}
+async function main() {
+    try {
+        const cliOptions = parseCliOptions(process.argv.slice(2));
+        const configPath = resolveConfigPath(cliOptions.configPath);
+        const config = readConfig(configPath);
+        const commands = buildCommands(config, configPath);
+        if (cliOptions.json || cliOptions.dryRun) {
+            process.stdout.write(`${JSON.stringify({
+                configPath,
+                commands: commands.map((command) => ({
+                    command: path.basename(command.filePath),
+                    args: command.args,
+                })),
+            }, null, 2)}\n`);
+        }
+        if (cliOptions.dryRun) {
+            return;
+        }
+        for (const command of commands) {
+            runNodeCommand(command.filePath, command.args);
+        }
+    }
+    catch (error) {
+        console.error(`Ошибка AQA Pulse upload-from-config: ${(0, error_utils_1.getErrorMessage)(error)}`);
+        process.exitCode = 1;
+    }
+}
+function parseCliOptions(args) {
+    if (args.includes('--help') || args.includes('-h')) {
+        printHelp();
+        process.exit(0);
+    }
+    const options = { json: false, dryRun: false };
+    for (let index = 0; index < args.length; index += 1) {
+        const currentArg = args[index];
+        if (currentArg === '--json') {
+            options.json = true;
+            continue;
+        }
+        if (currentArg === '--dry-run') {
+            options.dryRun = true;
+            continue;
+        }
+        if (currentArg === '--config') {
+            const nextArg = args[index + 1];
+            if (!nextArg || nextArg.startsWith('--')) {
+                throw new Error('Для --config нужно передать путь к .aqa-pulse.yml.');
+            }
+            options.configPath = nextArg;
+            index += 1;
+            continue;
+        }
+        throw new Error(`Неизвестный аргумент: ${currentArg}`);
+    }
+    return options;
+}
+function resolveConfigPath(configPath) {
+    if (configPath) {
+        const resolved = path.resolve(process.cwd(), configPath);
+        if (!fs.existsSync(resolved)) {
+            throw new Error(`Не найден config: ${resolved}`);
+        }
+        return resolved;
+    }
+    for (const fileName of ['.aqa-pulse.yml', '.aqa-pulse.yaml', '.aqa-pulse.json']) {
+        const candidate = path.resolve(process.cwd(), fileName);
+        if (fs.existsSync(candidate)) {
+            return candidate;
+        }
+    }
+    throw new Error('Не найден .aqa-pulse.yml, .aqa-pulse.yaml или .aqa-pulse.json. Передай путь через --config.');
+}
+function readConfig(configPath) {
+    const content = fs.readFileSync(configPath, 'utf8');
+    if (configPath.endsWith('.json')) {
+        return JSON.parse(content);
+    }
+    return parseSimpleYaml(content);
+}
+function buildCommands(config, configPath) {
+    const configDirectory = path.dirname(configPath);
+    const projectRoot = resolveConfigPathValue(configDirectory, config.projectDir ?? '.');
+    const repoRoot = resolveConfigPathValue(projectRoot, config.upload?.repoRoot ?? config.repoRoot ?? '.');
+    const mergeConfig = config.merge;
+    const commands = [];
+    let reportPath = config.upload?.reportPath ?? config.reportPath ?? 'test-results/dashboard/data.json';
+    if (mergeConfig) {
+        const projectKind = requireText(mergeConfig.projectKind, 'merge.projectKind');
+        const output = requireText(mergeConfig.output, 'merge.output');
+        const inputs = Array.isArray(mergeConfig.inputs) ? mergeConfig.inputs : [];
+        if (inputs.length === 0) {
+            throw new Error('merge.inputs должен содержать хотя бы один report.');
+        }
+        const outputPath = resolveConfigPathValue(projectRoot, output);
+        const mergeArgs = [
+            '--project-kind',
+            projectKind,
+            '--output',
+            outputPath,
+        ];
+        if (mergeConfig.allowMissing === true) {
+            mergeArgs.push('--allow-missing');
+        }
+        mergeArgs.push(...inputs.map((inputPath) => resolveConfigPathValue(projectRoot, inputPath)));
+        commands.push({ filePath: path.resolve(__dirname, 'merge-reports.js'), args: mergeArgs });
+        reportPath = output;
+    }
+    const uploadArgs = [
+        '--report',
+        resolveConfigPathValue(projectRoot, reportPath),
+        '--repo-root',
+        repoRoot,
+    ];
+    if (config.baseUrl) {
+        uploadArgs.push('--base-url', config.baseUrl);
+    }
+    if (config.workspaceSlug) {
+        uploadArgs.push('--workspace-slug', config.workspaceSlug);
+    }
+    if (config.workspaceApiKey) {
+        uploadArgs.push('--workspace-api-key', config.workspaceApiKey);
+    }
+    const sourceFactsPath = config.upload?.sourceFactsPath ?? config.sourceFactsPath;
+    if (sourceFactsPath) {
+        uploadArgs.push('--source-facts', resolveConfigPathValue(projectRoot, sourceFactsPath));
+    }
+    const generateSourceFacts = config.upload?.generateSourceFacts ?? config.generateSourceFacts ?? true;
+    if (generateSourceFacts) {
+        uploadArgs.push('--generate-source-facts');
+    }
+    commands.push({ filePath: path.resolve(__dirname, 'upload-report.js'), args: uploadArgs });
+    return commands;
+}
+function runNodeCommand(filePath, args) {
+    const result = (0, node_child_process_1.spawnSync)(process.execPath, [filePath, ...args], {
+        stdio: 'inherit',
+        env: process.env,
+    });
+    if (result.error) {
+        throw result.error;
+    }
+    if ((result.status ?? 1) !== 0) {
+        process.exit(result.status ?? 1);
+    }
+}
+function resolveConfigPathValue(baseDirectory, value) {
+    return path.isAbsolute(value) ? value : path.resolve(baseDirectory, value);
+}
+function requireText(value, label) {
+    if (typeof value !== 'string' || value.trim().length === 0) {
+        throw new Error(`Нужно указать ${label}.`);
+    }
+    return value.trim();
+}
+function parseSimpleYaml(content) {
+    const root = {};
+    const stack = [{ indent: -1, value: root }];
+    const lines = content.split(/\r?\n/);
+    for (const rawLine of lines) {
+        const withoutComment = stripYamlComment(rawLine);
+        if (!withoutComment.trim()) {
+            continue;
+        }
+        const indent = withoutComment.match(/^\s*/)?.[0].length ?? 0;
+        const line = withoutComment.trim();
+        while (stack.length > 1 && indent <= stack[stack.length - 1].indent) {
+            stack.pop();
+        }
+        const parent = stack[stack.length - 1].value;
+        if (line.startsWith('- ')) {
+            if (!Array.isArray(parent)) {
+                throw new Error(`YAML list item без родительского массива: ${line}`);
+            }
+            parent.push(parseYamlScalar(line.slice(2).trim()));
+            continue;
+        }
+        const separatorIndex = line.indexOf(':');
+        if (separatorIndex === -1) {
+            throw new Error(`Не удалось разобрать строку YAML: ${line}`);
+        }
+        if (Array.isArray(parent)) {
+            throw new Error(`YAML object внутри массива пока не поддерживается: ${line}`);
+        }
+        const key = line.slice(0, separatorIndex).trim();
+        const rawValue = line.slice(separatorIndex + 1).trim();
+        if (rawValue.length > 0) {
+            parent[key] = parseYamlScalar(rawValue);
+            continue;
+        }
+        const nextMeaningfulLine = findNextMeaningfulLine(lines, rawLine);
+        const child = nextMeaningfulLine?.trim().startsWith('- ') ? [] : {};
+        parent[key] = child;
+        stack.push({ indent, value: child });
+    }
+    return root;
+}
+function findNextMeaningfulLine(lines, currentRawLine) {
+    const startIndex = lines.indexOf(currentRawLine) + 1;
+    for (let index = startIndex; index < lines.length; index += 1) {
+        const candidate = stripYamlComment(lines[index]);
+        if (candidate.trim()) {
+            return candidate;
+        }
+    }
+    return null;
+}
+function stripYamlComment(line) {
+    const hashIndex = line.indexOf('#');
+    return hashIndex === -1 ? line : line.slice(0, hashIndex);
+}
+function parseYamlScalar(value) {
+    const normalized = value.trim();
+    if (normalized === 'true') {
+        return true;
+    }
+    if (normalized === 'false') {
+        return false;
+    }
+    if (normalized === 'null') {
+        return null;
+    }
+    if ((normalized.startsWith('"') && normalized.endsWith('"')) || (normalized.startsWith("'") && normalized.endsWith("'"))) {
+        return normalized.slice(1, -1);
+    }
+    return normalized;
+}
+function printHelp() {
+    console.log('aqa-pulse upload-from-config [--config .aqa-pulse.yml] [--dry-run] [--json]');
+    console.log('');
+    console.log('Пример .aqa-pulse.yml:');
+    console.log('  projectDir: Playwright');
+    console.log('  reportPath: test-results/dashboard/data.json');
+    console.log('  repoRoot: .');
+    console.log('');
+    console.log('Пример с merge:');
+    console.log('  projectDir: Playwright');
+    console.log('  repoRoot: .');
+    console.log('  merge:');
+    console.log('    projectKind: ui');
+    console.log('    output: test-results/dashboard/ui-merged.json');
+    console.log('    allowMissing: true');
+    console.log('    inputs:');
+    console.log('      - test-results/dashboard/ui-purchase.json');
+    console.log('      - test-results/dashboard/ui-cpu.json');
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aqa-pulse/cli",
-  "version": "0.1.0",
-  "description": "CLI для загрузки Playwright reports в AQA Pulse",
+  "version": "0.2.0",
+  "description": "CLI для загрузки отчетов в AQA Pulse",
   "license": "UNLICENSED",
   "type": "commonjs",
   "bin": {