specshield 2.0.1 → 3.1.1

package/src/commands/bdct.js

@@ -7,6 +7,7 @@ const path = require('path');
 const fsExtra = require('fs-extra');
 const logger = require('../utils/logger');
 const { getStoredApiKey } = require('../config/localConfig');
+const { applyBdctDefaults } = require('../core/projectConfig');
 const {
   publishProviderSpec,
   publishConsumerContract,
@@ -31,6 +32,24 @@ function requireToken(token) {
   }
 }
 
+/**
+ * Fill missing CLI options from `.specshield.yml` if one is present, then
+ * verify every required field for `command` is set. Exits 2 with a friendly
+ * message if anything is missing.
+ */
+function withProjectDefaults(opts, command) {
+  try {
+    applyBdctDefaults(opts, command);
+  } catch (err) {
+    if (err.code === 'MISSING_REQUIRED_OPTIONS') {
+      logger.error(err.message);
+      process.exit(2);
+    }
+    throw err;
+  }
+  return opts;
+}
+
 function fmtDate(iso) {
   if (!iso) return chalk.gray('—');
   try {
@@ -51,6 +70,26 @@ function hr() {
   return chalk.gray('  ─────────────────────────────────────────────────────');
 }
 
+/**
+ * Flatten a verification result's mismatches.
+ * Current backend returns `resultJson` (JSON string of [{endpoint,status,mismatches:[...]}]).
+ * Tolerate older shapes that put a flat array on `issues` or `mismatches`.
+ */
+function flattenMismatches(result) {
+  if (!result) return [];
+  if (Array.isArray(result.issues)) return result.issues;
+  if (Array.isArray(result.mismatches)) return result.mismatches;
+  if (typeof result.resultJson === 'string' && result.resultJson.length > 0) {
+    try {
+      const parsed = JSON.parse(result.resultJson);
+      if (Array.isArray(parsed)) {
+        return parsed.flatMap(ep => Array.isArray(ep.mismatches) ? ep.mismatches : []);
+      }
+    } catch { /* fall through */ }
+  }
+  return [];
+}
+
 /** Strip ANSI escape codes for length measurement */
 function stripAnsi(str) {
   return str.replace(/\[[0-9;]*m/g, '');
@@ -79,16 +118,17 @@ function printTable(headers, rows) {
 
 const publishProviderCommand = new Command('publish-provider')
   .description('Publish a provider OpenAPI spec to the BDCT registry')
-  .requiredOption('--spec <path>', 'Path to provider spec file (YAML or JSON)')
-  .requiredOption('--provider <name>', 'Provider service name')
-  .requiredOption('--version <ver>', 'Provider version tag')
+  .option('--spec <path>',     'Path to provider spec file (YAML or JSON)')
+  .option('--provider <name>', 'Provider service name')
+  .option('--version <ver>',   'Provider version tag')
+  .option('--org <key>',       'Organization key')
   .option('--env <environment>', 'Environment label (e.g. staging, production)')
-  .option('--org <key>', 'Organization key')
   .option('--branch <branch>', 'Git branch name')
-  .option('--json', 'Output raw JSON')
-  .option('--server <url>', 'SpecShield server URL')
+  .option('--json',            'Output raw JSON')
+  .option('--server <url>',    'SpecShield server URL')
   .option('--api-token <token>', 'API token (overrides env / stored config)')
   .action(async (opts) => {
+    withProjectDefaults(opts, 'publish-provider');
     const token = await resolveApiToken(opts);
     requireToken(token);
 
@@ -110,12 +150,12 @@ const publishProviderCommand = new Command('publish-provider')
 
     try {
       const result = await publishProviderSpec(opts.server, token, {
-        provider:    opts.provider,
-        version:     opts.version,
+        orgKey:       opts.org,
+        providerName: opts.provider,
+        version:      opts.version,
         specContent,
-        env:         opts.env    || null,
-        orgKey:      opts.org    || null,
-        branch:      opts.branch || null,
+        environment:  opts.env    || null,
+        branch:       opts.branch || null,
       });
       if (spinner) spinner.stop();
 
@@ -131,7 +171,11 @@ const publishProviderCommand = new Command('publish-provider')
       process.stdout.write(`  Provider    : ${chalk.white(opts.provider)}\n`);
       process.stdout.write(`  Version     : ${chalk.cyan(opts.version)}\n`);
       if (opts.env)        process.stdout.write(`  Environment : ${opts.env}\n`);
-      if (result.publishedAt) process.stdout.write(`  Published At: ${fmtDate(result.publishedAt)}\n`);
+      const publishedAt = result.createdAt || result.publishedAt;
+      if (publishedAt) process.stdout.write(`  Published At: ${fmtDate(publishedAt)}\n`);
+      if (typeof result.verificationsTriggered === 'number') {
+        process.stdout.write(`  Verifications triggered: ${chalk.cyan(result.verificationsTriggered)}\n`);
+      }
       process.stdout.write('\n');
     } catch (err) {
       if (spinner) spinner.fail('Publish failed');
@@ -144,16 +188,17 @@ const publishProviderCommand = new Command('publish-provider')
 
 const publishConsumerCommand = new Command('publish-consumer')
   .description('Publish a consumer contract to the BDCT registry')
-  .requiredOption('--contract <path>', 'Path to consumer contract file (OpenAPI YAML/JSON or Pact JSON)')
-  .requiredOption('--consumer <name>', 'Consumer service name')
-  .requiredOption('--provider <name>', 'Provider service name')
-  .requiredOption('--version <ver>', 'Consumer version tag')
-  .option('--org <key>', 'Organization key')
-  .option('--format <fmt>', 'Contract format: OPENAPI | PACT', 'OPENAPI')
-  .option('--json', 'Output raw JSON')
-  .option('--server <url>', 'SpecShield server URL')
+  .option('--contract <path>', 'Path to consumer contract file (OpenAPI YAML/JSON or Pact JSON)')
+  .option('--consumer <name>', 'Consumer service name')
+  .option('--provider <name>', 'Provider service name')
+  .option('--version <ver>',   'Consumer version tag')
+  .option('--org <key>',       'Organization key')
+  .option('--format <fmt>',    'Contract format: OPENAPI | PACT', 'OPENAPI')
+  .option('--json',            'Output raw JSON')
+  .option('--server <url>',    'SpecShield server URL')
   .option('--api-token <token>', 'API token (overrides env / stored config)')
   .action(async (opts) => {
+    withProjectDefaults(opts, 'publish-consumer');
     const token = await resolveApiToken(opts);
     requireToken(token);
 
@@ -175,12 +220,12 @@ const publishConsumerCommand = new Command('publish-consumer')
 
     try {
       const result = await publishConsumerContract(opts.server, token, {
-        consumer:        opts.consumer,
-        provider:        opts.provider,
+        orgKey:          opts.org,
+        consumerName:    opts.consumer,
+        providerName:    opts.provider,
         version:         opts.version,
         contractContent,
-        orgKey:          opts.org    || null,
-        format:          opts.format || 'OPENAPI',
+        contractFormat:  opts.format || 'OPENAPI',
       });
       if (spinner) spinner.stop();
 
@@ -197,7 +242,11 @@ const publishConsumerCommand = new Command('publish-consumer')
       process.stdout.write(`  Provider    : ${chalk.white(opts.provider)}\n`);
       process.stdout.write(`  Version     : ${chalk.cyan(opts.version)}\n`);
       process.stdout.write(`  Format      : ${opts.format || 'OPENAPI'}\n`);
-      if (result.publishedAt) process.stdout.write(`  Published At: ${fmtDate(result.publishedAt)}\n`);
+      const consumerPublishedAt = result.createdAt || result.publishedAt;
+      if (consumerPublishedAt) process.stdout.write(`  Published At: ${fmtDate(consumerPublishedAt)}\n`);
+      if (typeof result.verificationsTriggered === 'number') {
+        process.stdout.write(`  Verifications triggered: ${chalk.cyan(result.verificationsTriggered)}\n`);
+      }
       process.stdout.write('\n');
       process.stdout.write(chalk.gray(`  ➜  Run: specshield bdct verify --consumer ${opts.consumer} --provider ${opts.provider}\n`));
       process.stdout.write('\n');
@@ -212,16 +261,17 @@ const publishConsumerCommand = new Command('publish-consumer')
 
 const verifyCommand = new Command('verify')
   .description('Verify consumer-provider contract compatibility')
-  .requiredOption('--consumer <name>', 'Consumer service name')
-  .requiredOption('--provider <name>', 'Provider service name')
-  .option('--consumer-version <ver>', 'Consumer version to verify')
-  .option('--provider-version <ver>', 'Provider version to verify against')
-  .option('--env <environment>', 'Environment label')
-  .option('--org <key>', 'Organization key')
-  .option('--json', 'Output raw JSON')
-  .option('--server <url>', 'SpecShield server URL')
-  .option('--api-token <token>', 'API token')
+  .option('--consumer <name>',         'Consumer service name')
+  .option('--provider <name>',         'Provider service name')
+  .option('--consumer-version <ver>',  'Consumer version to verify')
+  .option('--provider-version <ver>',  'Provider version to verify against')
+  .option('--org <key>',               'Organization key')
+  .option('--env <environment>',       'Environment label')
+  .option('--json',                    'Output raw JSON')
+  .option('--server <url>',            'SpecShield server URL')
+  .option('--api-token <token>',       'API token')
   .action(async (opts) => {
+    withProjectDefaults(opts, 'verify');
     const token = await resolveApiToken(opts);
     requireToken(token);
 
@@ -229,23 +279,23 @@ const verifyCommand = new Command('verify')
 
     try {
       const result = await verify(opts.server, token, {
-        consumer:        opts.consumer,
-        provider:        opts.provider,
-        consumerVersion: opts.consumerVersion || null,
-        providerVersion: opts.providerVersion || null,
-        env:             opts.env             || null,
-        orgKey:          opts.org             || null,
+        orgKey:          opts.org,
+        consumerName:    opts.consumer,
+        consumerVersion: opts.consumerVersion,
+        providerName:    opts.provider,
+        providerVersion: opts.providerVersion,
+        environment:     opts.env || null,
       });
       if (spinner) spinner.stop();
 
+      const status  = String(result.status || result.result || '').toUpperCase();
+      const success = status === 'COMPATIBLE';
+
       if (opts.json) {
         process.stdout.write(JSON.stringify(result, null, 2) + '\n');
-        return;
+        process.exit(success ? 0 : 1);
       }
 
-      const status  = String(result.status || result.result || '').toUpperCase();
-      const success = status === 'COMPATIBLE';
-
       process.stdout.write('\n');
       if (success) {
         process.stdout.write(chalk.green.bold('  ✔  COMPATIBLE') + '\n');
@@ -262,14 +312,26 @@ const verifyCommand = new Command('verify')
         process.stdout.write(`  Verified At     : ${fmtDate(result.verifiedAt || result.completedAt)}\n`);
       }
 
-      const issues = result.issues || result.mismatches || [];
+      // Backend returns resultJson as a JSON string of [{endpoint, status, mismatches:[...]}].
+      // Older shapes also accepted: top-level issues / mismatches arrays.
+      const issues = flattenMismatches(result);
       if (issues.length > 0) {
         process.stdout.write('\n');
         process.stdout.write(chalk.red.bold('  Issues') + '\n');
         process.stdout.write(hr() + '\n');
         for (const issue of issues) {
-          process.stdout.write(`  ${chalk.red('●')} ${chalk.bold(issue.type || issue.mismatchType || 'MISMATCH')} at ${chalk.gray(issue.path || '$')}\n`);
-          if (issue.message) process.stdout.write(`    ${chalk.gray(issue.message)}\n`);
+          const sev = (issue.severity || 'ERROR').toUpperCase();
+          const marker = sev === 'WARNING' ? chalk.yellow('⚠') : chalk.red('●');
+          const type = issue.type || issue.mismatchType || 'MISMATCH';
+          const loc  = issue.field || issue.path || issue.endpoint || '$';
+          process.stdout.write(`  ${marker} ${chalk.bold(type)} at ${chalk.gray(loc)}\n`);
+          if (issue.consumerExpects && issue.providerProvides) {
+            process.stdout.write(`    ${chalk.gray(`consumer: ${issue.consumerExpects}, provider: ${issue.providerProvides}`)}\n`);
+          } else if (issue.consumerExpects) {
+            process.stdout.write(`    ${chalk.gray(`expected: ${issue.consumerExpects}`)}\n`);
+          } else if (issue.message) {
+            process.stdout.write(`    ${chalk.gray(issue.message)}\n`);
+          }
         }
         process.stdout.write('\n');
       }
@@ -287,14 +349,15 @@ const verifyCommand = new Command('verify')
 
 const canIDeployCommand = new Command('can-i-deploy')
   .description('Check if a service version is safe to deploy')
-  .requiredOption('--service <name>', 'Service name (consumer or provider)')
-  .requiredOption('--version <ver>', 'Service version to check')
+  .option('--service <name>',    'Service name (consumer or provider)')
+  .option('--version <ver>',     'Service version to check')
+  .option('--org <key>',         'Organization key')
   .option('--env <environment>', 'Target environment (e.g. qa, staging, production)')
-  .option('--org <key>', 'Organization key')
-  .option('--json', 'Output raw JSON')
-  .option('--server <url>', 'SpecShield server URL')
+  .option('--json',              'Output raw JSON')
+  .option('--server <url>',      'SpecShield server URL')
   .option('--api-token <token>', 'API token')
   .action(async (opts) => {
+    withProjectDefaults(opts, 'can-i-deploy');
     const token = await resolveApiToken(opts);
     requireToken(token);
 
@@ -302,21 +365,21 @@ const canIDeployCommand = new Command('can-i-deploy')
 
     try {
       const result = await canIDeploy(opts.server, token, {
+        org:     opts.org,
         service: opts.service,
         version: opts.version,
         env:     opts.env || null,
-        org:     opts.org || null,
       });
       if (spinner) spinner.stop();
 
+      const deployable = result.deployable ?? result.allowed ?? false;
+      const envLabel   = opts.env ? ` in ${opts.env}` : '';
+
       if (opts.json) {
         process.stdout.write(JSON.stringify(result, null, 2) + '\n');
-        return;
+        process.exit(deployable ? 0 : 1);
       }
 
-      const deployable = result.deployable ?? result.allowed ?? false;
-      const envLabel   = opts.env ? ` in ${opts.env}` : '';
-
       process.stdout.write('\n');
       if (deployable) {
         process.stdout.write(chalk.green.bold('  ✔  PASS') + chalk.white(`: ${opts.service} v${opts.version} is deployable${envLabel}\n`));
@@ -360,7 +423,7 @@ const canIDeployCommand = new Command('can-i-deploy')
 
 const listCommand = new Command('list')
   .description('List BDCT verification history')
-  .option('--org <key>', 'Filter by organization key')
+  .option('--org <key>', 'Organization key')
   .option('--consumer <name>', 'Filter by consumer service name')
   .option('--provider <name>', 'Filter by provider service name')
   .option('--env <environment>', 'Filter by environment')
@@ -370,6 +433,7 @@ const listCommand = new Command('list')
   .option('--server <url>', 'SpecShield server URL')
   .option('--api-token <token>', 'API token')
   .action(async (opts) => {
+    withProjectDefaults(opts, 'list');
     const token = await resolveApiToken(opts);
     requireToken(token);
 
@@ -439,6 +503,7 @@ const matrixCommand = new Command('matrix')
   .option('--server <url>', 'SpecShield server URL')
   .option('--api-token <token>', 'API token')
   .action(async (opts) => {
+    withProjectDefaults(opts, 'matrix');
     const token = await resolveApiToken(opts);
     requireToken(token);
 
@@ -456,7 +521,8 @@ const matrixCommand = new Command('matrix')
         return;
       }
 
-      // Expected matrix shape: { consumers: string[], providers: string[], cells: { [consumer]: { [provider]: string } } }
+      // Backend matrix shape: { consumers: string[], providers: string[],
+      //                        cells: { "<consumer>__<provider>": "<STATUS>" } }
       const consumers = matrix.consumers || [];
       const providers = matrix.providers || [];
       const cells     = matrix.cells     || {};
@@ -475,7 +541,7 @@ const matrixCommand = new Command('matrix')
       const headers = ['Consumer \\ Provider', ...providers];
       const rows = consumers.map(consumer => {
         const providerCells = providers.map(provider => {
-          const status = (cells[consumer] && cells[consumer][provider]) || 'UNKNOWN';
+          const status = cells[`${consumer}__${provider}`] || 'UNKNOWN';
           return compatBadge(status);
         });
         return [chalk.white(consumer), ...providerCells];
@@ -497,15 +563,13 @@ const matrixCommand = new Command('matrix')
 
 const listProvidersCommand = new Command('list-providers')
   .description('List published provider specs')
-  .option('--org <key>', 'Filter by organization key')
+  .option('--org <key>',       'Organization key')
   .option('--provider <name>', 'Filter by provider service name')
-  .option('--env <environment>', 'Filter by environment')
-  .option('--page <n>', 'Page number (0-based)', '0')
-  .option('--size <n>', 'Page size', '20')
-  .option('--json', 'Output raw JSON')
-  .option('--server <url>', 'SpecShield server URL')
+  .option('--json',            'Output raw JSON')
+  .option('--server <url>',    'SpecShield server URL')
   .option('--api-token <token>', 'API token')
   .action(async (opts) => {
+    withProjectDefaults(opts, 'list-providers');
     const token = await resolveApiToken(opts);
     requireToken(token);
 
@@ -515,9 +579,6 @@ const listProvidersCommand = new Command('list-providers')
       const page = await listProviderSpecs(opts.server, token, {
         org:      opts.org,
         provider: opts.provider,
-        env:      opts.env,
-        page:     parseInt(opts.page, 10) || 0,
-        size:     parseInt(opts.size, 10)  || 20,
       });
       if (spinner) spinner.stop();
 
@@ -543,11 +604,11 @@ const listProvidersCommand = new Command('list-providers')
         ['ID', 'Provider', 'Version', 'Environment', 'Branch', 'Published At'],
         items.map(s => [
           chalk.cyan(String(s.id ?? '—')),
-          s.provider || s.providerName || '—',
+          s.providerName || s.provider || '—',
           chalk.cyan(s.version || '—'),
-          s.env || s.environment || '—',
+          s.environment || s.env || '—',
           chalk.gray(s.branch || '—'),
-          fmtDate(s.publishedAt),
+          fmtDate(s.createdAt || s.publishedAt),
         ])
       );
 
@@ -566,15 +627,14 @@ const listProvidersCommand = new Command('list-providers')
 
 const listConsumersCommand = new Command('list-consumers')
   .description('List published consumer contracts')
-  .option('--org <key>', 'Filter by organization key')
+  .option('--org <key>',       'Organization key')
   .option('--consumer <name>', 'Filter by consumer service name')
   .option('--provider <name>', 'Filter by provider service name')
-  .option('--page <n>', 'Page number (0-based)', '0')
-  .option('--size <n>', 'Page size', '20')
-  .option('--json', 'Output raw JSON')
-  .option('--server <url>', 'SpecShield server URL')
+  .option('--json',            'Output raw JSON')
+  .option('--server <url>',    'SpecShield server URL')
   .option('--api-token <token>', 'API token')
   .action(async (opts) => {
+    withProjectDefaults(opts, 'list-consumers');
     const token = await resolveApiToken(opts);
     requireToken(token);
 
@@ -585,8 +645,6 @@ const listConsumersCommand = new Command('list-consumers')
         org:      opts.org,
         consumer: opts.consumer,
         provider: opts.provider,
-        page:     parseInt(opts.page, 10) || 0,
-        size:     parseInt(opts.size, 10)  || 20,
       });
       if (spinner) spinner.stop();
 
@@ -612,11 +670,11 @@ const listConsumersCommand = new Command('list-consumers')
         ['ID', 'Consumer', 'Provider', 'Version', 'Format', 'Published At'],
         items.map(c => [
           chalk.cyan(String(c.id ?? '—')),
-          c.consumer || c.consumerName || '—',
-          c.provider || c.providerName || '—',
+          c.consumerName || c.consumer || '—',
+          c.providerName || c.provider || '—',
           chalk.cyan(c.version || '—'),
-          c.format || '—',
-          fmtDate(c.publishedAt),
+          c.contractFormat || c.format || '—',
+          fmtDate(c.createdAt || c.publishedAt),
         ])
       );