@testmonitor/testmonitor-cli 0.0.1

package/LICENSE.md

@@ -0,0 +1 @@
+Copyright (c) 2025 TestMonitor | we are Cerios B.V. <info@testmonitor.com>

package/README.md

@@ -0,0 +1,95 @@
+# TestMonitor CLI
+
+TestMonitor CLI (`testmonitor-cli`) is a command-line tool to submit JUnit XML test results to a JSON API.
+
+## Installation
+
+Simply install the package by using NPM or Yarn:
+
+```sh
+npm install -g testmonitor-cli
+```
+
+or
+
+```sh
+yarn global add testmonitor-cli
+```
+
+This installs the TestMonitor CLI tool globally on your system.
+
+## Authentication
+
+TestMonitor CLI requires authentication via an API token. Set the token as an environment variable:
+
+```sh
+export TESTMONITOR_TOKEN=<your_api_token>
+```
+
+On Windows (PowerShell):
+
+```sh
+$env:TESTMONITOR_TOKEN="<your_api_token>"
+```
+
+## Usage
+
+Once you've setup your TestMonitor token, you can start submitting JUnit reports:
+
+```sh
+testmonitor-cli submit -d <TESTMONITOR_DOMAIN> -i <INTEGRATION_ID> -f <FILE_PATH>
+```
+
+For example:
+
+```sh
+testmonitor-cli submit -d domain.testmonitor.com -i 12345-abcdef-67890-ghijkl -f results.xml
+```
+
+## Commands
+
+### `submit`
+
+Submit a JUnit XML test report.
+
+**Options:**
+```sh
+-d, --domain <domain>       TestMonitor domain (required)
+-i, --integration-id <id>   Integration ID (required)
+-f, --file <path>           Path to JUnit XML file (required)
+```
+
+## Development
+
+Clone the repository and install dependencies:
+
+```sh
+git clone https://github.com/testmonitor/testmonitor-cli.git
+cd testmonitor-cli
+npm install
+```
+
+Run locally:
+```sh
+node index.js submit -d api.testmonitor.com -i 12345-abcdef-67890-ghijkl -f test-results.xml
+```
+
+Run tests:
+```sh
+npm test
+```
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags](https://github.com/testmonitor/testmonitor/tags)
+and the [releases](https://github.com/testmonitor/testmonitor/releases) on this repository.
+
+## Authors
+
+* **Thijs Kok** - *Lead developer* - [ThijsKok](https://github.com/thijskok)
+* **Stephan Grootveld** - *Developer* - [Stefanius](https://github.com/stefanius)
+* **Frank Keulen** - *Developer* - [FrankIsGek](https://github.com/frankisgek)
+
+## License
+
+TestMonitor is a commercial product, provided as a SaaS application to the customers of TestManagement BV.

package/actions/SubmitReport.js

@@ -0,0 +1,83 @@
+import fs from 'fs';
+import axios from 'axios';
+import FormData from 'form-data';
+import chalk from 'chalk';
+import { table, getBorderCharacters } from 'table';
+
+export class SubmitReport {
+  constructor({ domain, apiKey, integrationId, file, name, type, milestoneId, milestoneName, preserveNames, skipRootSuite, testEnvironmentId }) {
+    this.domain = domain;
+    this.apiKey = apiKey;
+    this.integrationId = integrationId;
+    this.file = file;
+    this.name = name;
+    this.type = type;
+    this.milestoneId = milestoneId;
+    this.milestoneName = milestoneName;
+    this.preserveNames = preserveNames;
+    this.skipRootSuite = skipRootSuite;
+    this.testEnvironmentId = testEnvironmentId;
+  }
+
+  async run() {
+    const formData = new FormData();
+
+    // Required
+    formData.append('integration_id', this.integrationId);
+    formData.append('report', fs.createReadStream(this.file));
+
+    // Optional
+    const optional = {
+      name: this.name,
+      type: this.type,
+      milestone: this.milestoneName,
+      milestone_id: this.milestoneId,
+      preserve_names: this.preserveNames ? 1: null,
+      skip_root_suite: this.skipRootSuite ? 1 : null,
+      test_environment_id: this.testEnvironmentId,
+    };
+
+    for (const [key, value] of Object.entries(optional)) {
+      if (value !== undefined && value !== null) {
+        formData.append(key, value);
+      }
+    }
+
+    try {
+      const response = await axios.post(
+        `https://${this.domain}/api/v1/reporters/junit/submit`,
+        formData,
+        {
+          headers: {
+            ...formData.getHeaders(),
+            Authorization: `Bearer ${this.apiKey}`,
+          },
+        }
+      );
+
+      const { data } = response.data;
+
+      const config = {
+        border: getBorderCharacters('ramac'),
+        singleLine: true,
+      };
+
+      const rows = [
+        [chalk.bold('File'), data.name],
+        [chalk.bold('Date'), data.created_at],
+        [chalk.bold('ID'), data.test_run.id],
+        [chalk.bold('Code'), data.test_run.code],
+        [chalk.bold('Name'), data.test_run.name],
+        [chalk.bold('URL'), data.test_run.links.show],
+      ];
+
+      console.log(table(rows, config));
+
+      console.log('Report submitted ' + chalk.green('successfully') + '.');
+    } catch (error) {
+      const message = error.response?.data?.message || error.message;
+      console.error(chalk.red('Error') + ': ' + message);
+      process.exit(1);
+    }
+  }
+}

package/commands/submit.js

@@ -0,0 +1,64 @@
+import { Command } from 'commander';
+import { SubmitReport } from '../actions/SubmitReport.js';
+import fs from 'fs';
+import chalk from 'chalk';
+import 'dotenv/config';
+
+const submitCommand = new Command('submit')
+  .description('Submit a JUnit XML file to your TestMonitor instance.')
+  .helpOption('-h, --help', 'Display help for command')
+  .requiredOption('-d, --domain <domain>', 'Your TestMonitor domain name (e.g., mydomain.testmonitor.com)')
+  .requiredOption('-i, --integration-id <id>', 'The JUnit integration ID')
+  .requiredOption('-f, --file <path>', 'Path to your JUnit XML file')
+  .option('-m, --milestone-id <id>', 'The milestone ID for the new test run (required if not configured in your JUnit configuration)')
+  .option('-o, --milestone-name <name>', 'Finds or creates a milestone matching the name for the new test run')
+  .option('-n, --name <name>', 'The name for the new test run (will be auto-generated if not provided)')
+  .option('-p, --preserve-names', 'Preserve test case names exactly as they appear in the XML file.')
+  .option('-s, --skip-root-suite', 'Skip the root test suite and start from its nested suites.')
+  .option('-e, --test-environment-id <id>', 'The test environment ID for the new test run')
+  .option('-t, --type <type>', 'The automation test type (cypress, playwright, phpunit, selenium)')
+  .option('-v, --verbose', 'Output additional debug information')
+  .action(async (options) => {
+    const {
+      domain,
+      integrationId,
+      file,
+      name,
+      milestoneId,
+      milestoneName,
+      preserveNames,
+      skipRootSuite,
+      testEnvironmentId,
+      type,
+      verbose
+    } = options;
+
+    const apiKey = process.env.TESTMONITOR_TOKEN;
+
+    if (!apiKey) {
+      console.error(chalk.red('Error') + ': TESTMONITOR_TOKEN environment variable is not set.');
+      process.exit(1);
+    }
+
+    if (!fs.existsSync(file)) {
+      console.error(chalk.red('Error') + `: File not found at path ${file}`);
+      process.exit(1);
+    }
+
+    const action = new SubmitReport({
+      domain,
+      apiKey,
+      integrationId,
+      file,
+      name,
+      type,
+      milestoneId,
+      milestoneName,
+      preserveNames,
+      skipRootSuite,
+      testEnvironmentId
+    });
+    await action.run();
+  });
+
+export default submitCommand;

package/index.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import submitCommand from './commands/submit.js';
+import 'dotenv/config';
+
+const program = new Command();
+
+program
+    .name('testmonitor-cli')
+    .version('0.0.1')
+    .description('CLI tool for interacting with the TestMonitor API.');
+
+program.addCommand(submitCommand);
+
+program.on('option:verbose', function () {
+  process.env.VERBOSE = this.opts().verbose;
+});
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@testmonitor/testmonitor-cli",
+  "version": "0.0.1",
+  "description": "TestMonitor CLI tool",
+  "keywords": [
+    "testmonitor",
+    "cli"
+  ],
+  "homepage": "https://www.testmonitor.com/",
+  "bugs": {
+    "url": "https://github.com/testmonitor/testmonitor-cli/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/testmonitor/testmonitor-cli.git"
+  },
+  "author": "TestMonitor | we are Cerios B.V.",
+  "main": "index.js",
+  "bin": {
+    "testmonitor-cli": "index.js"
+  },
+  "scripts": {
+    "start": "node index.js",
+    "lint": "eslint .",
+    "test": "mocha"
+  },
+  "dependencies": {
+    "axios": "^1.7.9",
+    "chalk": "^5.4.1",
+    "commander": "^13.1.0",
+    "dotenv": "^16.4.7",
+    "table": "^6.9.0"
+  },
+  "devDependencies": {
+    "chai": "^5.2.0",
+    "eslint": "^9.21.0",
+    "mocha": "^11.1.0",
+    "sinon": "^19.0.2"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}