@testcollab/cli 1.5.0 → 1.7.0

package/README.md

@@ -85,6 +85,20 @@ tc report \
 | `--result-file <path>` | Yes | Path to the result file |
 | `--api-key <key>` | No | TestCollab API key (or set `TESTCOLLAB_TOKEN` env var) |
 | `--api-url <url>` | No | API base URL override (default: `https://api.testcollab.io`). Use `https://api-eu.testcollab.io` for EU region. |
+| `--skip-missing` | No | Mark test cases in the test plan but not in the result file as **skipped** |
+
+#### `--skip-missing`
+
+By default, test cases in the test plan that don't appear in the result file are left untouched. When `--skip-missing` is passed, these unmatched cases are automatically marked as **skipped**. This is useful when your result file only contains the tests that actually ran, and you want the full test plan status to reflect that anything not executed was skipped.
+
+```bash
+tc report \
+  --project 123 \
+  --test-plan-id 555 \
+  --format junit \
+  --result-file ./results.xml \
+  --skip-missing
+```
 
 #### Mapping test cases
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testcollab/cli",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "Command-line interface for TestCollab operations",
   "main": "src/index.js",
   "bin": {

package/src/commands/report.js

@@ -216,7 +216,8 @@ export function extractTestCaseIdFromTitle(title) {
 function extractTestCaseIdFromMochawesomeTest(testData) {
   const testTitle = String(testData?.title || '').trim();
   const fullTitle = String(testData?.fullTitle || '').trim();
-  return extractTestCaseIdFromTitle(testTitle) || extractTestCaseIdFromTitle(fullTitle);
+  // Prefer fullTitle because some reporters shorten `title` and keep the canonical ID in fullTitle.
+  return extractTestCaseIdFromTitle(fullTitle) || extractTestCaseIdFromTitle(testTitle);
 }
 
 function prepareMochawesomeRunRecord(testData) {
@@ -527,6 +528,7 @@ class TcApiClient {
   buildUrl(endpoint) {
     const normalized = endpoint.startsWith('/') ? endpoint : `/${endpoint}`;
     const separator = normalized.includes('?') ? '&' : '?';
+    // console.log("build url", `${this.baseApiUrl}${normalized}${separator}token=${encodeURIComponent(this.accessToken)}`);
     return `${this.baseApiUrl}${normalized}${separator}token=${encodeURIComponent(this.accessToken)}`;
   }
 
@@ -832,7 +834,8 @@ async function uploadUsingReporterFlow({
   apiUrl,
   hasConfig,
   resultsToUpload,
-  unresolvedIds
+  unresolvedIds,
+  skipMissing = false
 }) {
   const tcApiInstance = new TcApiClient({
     accessToken: apiKey,
@@ -871,14 +874,21 @@ async function uploadUsingReporterFlow({
 
   await tcApiInstance.getTestplanConfigs();
 
+  const userData = await tcApiInstance.getUserInfo();
+  if (!userData || !userData.id) {
+    throw new Error('User could not be fetched for this API key.');
+  }
+
   const casesAssigned = await tcApiInstance.getAssignedCases();
   console.log({ 'Total assigned cases found': Array.isArray(casesAssigned) ? casesAssigned.length : 0 });
 
   const unmatchedCaseIds = new Set();
   const unmatchedConfigIds = new Set();
+  const matchedExecCaseIds = new Set();
   let matched = 0;
   let updated = 0;
   let errors = 0;
+  let skippedMissing = 0;
 
   const configIds = Object.keys(resultsToUpload);
 
@@ -909,6 +919,7 @@ async function uploadUsingReporterFlow({
         }
 
         matched += 1;
+        matchedExecCaseIds.add(execCase.id);
 
         const updatePayload = buildUpdatePayload({
           execCase,
@@ -948,10 +959,54 @@ async function uploadUsingReporterFlow({
     }
   }
 
+  // --skip-missing: mark all assigned cases not present in the result file as skipped
+  if (skipMissing) {
+    const missingCases = casesAssigned.filter(
+      (assignedCase) => assignedCase && assignedCase.id && !matchedExecCaseIds.has(assignedCase.id)
+    );
+
+    if (missingCases.length) {
+      console.log(`\n⏭️  --skip-missing: marking ${missingCases.length} unmatched test case(s) as skipped...`);
+    }
+
+    for (const execCase of missingCases) {
+      try {
+        const skipPayload = {
+          id: execCase.id,
+          test_plan_test_case: execCase.test_plan_test_case?.id || execCase.test_plan_test_case,
+          project: projectId,
+          status: RUN_RESULT_MAP.skip,
+          test_plan: testPlanId
+        };
+
+        if (execCase.test_plan_config && execCase.test_plan_config.id) {
+          skipPayload.test_plan_config = execCase.test_plan_config.id;
+        }
+
+        if (Array.isArray(execCase?.test_case_revision?.steps) && execCase.test_case_revision.steps.length) {
+          skipPayload.step_wise_result = execCase.test_case_revision.steps.map((step) => ({
+            ...step,
+            status: RUN_RESULT_MAP.skip
+          }));
+        }
+
+        const updateResult = await tcApiInstance.updateCaseRunResult(execCase.id, skipPayload);
+        if (updateResult && updateResult.id) {
+          skippedMissing += 1;
+        } else {
+          errors += 1;
+        }
+      } catch {
+        errors += 1;
+      }
+    }
+  }
+
   return {
     matched,
     updated,
     errors,
+    skippedMissing,
     unresolvedIds: unique(unresolvedIds || []),
     unmatchedCaseIds: unique([...unmatchedCaseIds]),
     unmatchedConfigIds: unique([...unmatchedConfigIds])
@@ -994,6 +1049,9 @@ function validateRequiredOptions({ apiKey, project, testPlanId }) {
 function logUploadSummary(formatLabel, summary) {
   console.log(`✅ ${formatLabel} report processed (${summary.matched || 0} matched, ${summary.updated || 0} updated)`);
 
+  if (summary.skippedMissing) {
+    console.log(`⏭️  ${summary.skippedMissing} test case(s) not in result file marked as skipped`);
+  }
   if (summary.unresolvedIds?.length) {
     console.warn(`⚠️  ${summary.unresolvedIds.length} testcase(s) missing TestCollab ID`);
   }
@@ -1022,7 +1080,8 @@ export async function report(options) {
     testPlanId,
     format,
     resultFile,
-    apiUrl
+    apiUrl,
+    skipMissing
   } = options;
 
   // Resolve API key: --api-key flag takes precedence, then TESTCOLLAB_TOKEN env var
@@ -1069,7 +1128,8 @@ export async function report(options) {
         apiUrl,
         hasConfig: parsedReport.hasConfig,
         resultsToUpload: parsedReport.resultsToUpload,
-        unresolvedIds: parsedReport.unresolvedIds
+        unresolvedIds: parsedReport.unresolvedIds,
+        skipMissing: Boolean(skipMissing)
       });
 
       logUploadSummary('JUnit', summary);
@@ -1098,7 +1158,8 @@ export async function report(options) {
       apiUrl,
       hasConfig: parsedReport.hasConfig,
       resultsToUpload: parsedReport.resultsToUpload,
-      unresolvedIds: parsedReport.unresolvedIds
+      unresolvedIds: parsedReport.unresolvedIds,
+      skipMissing: Boolean(skipMissing)
     });
 
     logUploadSummary('Mochawesome', summary);

package/src/index.js

@@ -51,6 +51,7 @@ program
   .requiredOption('--format <type>', 'Result format: mochawesome or junit')
   .requiredOption('--result-file <path>', 'Path to test result file')
   .option('--api-url <url>', 'TestCollab API base URL override', 'https://api.testcollab.io')
+  .option('--skip-missing', 'Mark test cases in the test plan but not in the result file as skipped', false)
   .action(report);
 
 // Add specgen command