zephyr-bridge

Reusable Node.js package for:

• fetching Zephyr Scale BDD test scripts and writing .feature files
• publishing Cucumber JSON execution reports to Zephyr Scale

Install

npm install zephyr-bridge

CLI usage

You can use the single zephyr-bridge command with subcommands, or call the direct binaries.

Unified CLI

zephyr-bridge fetch-tests <baseUrl> <projectKey> <accessToken> [outputDir]
zephyr-bridge publish-report <baseUrl> <projectKey> <accessToken> [htmlReportUrl] [reportDir]

Examples:

zephyr-bridge fetch-tests https://api.zephyrscale.smartbear.com/v2 WMS <token> ./src/test/java/zephyr_features
zephyr-bridge publish-report https://api.zephyrscale.smartbear.com/v2 WMS <token> https://example/reports/latest ./target/reports

Direct CLI commands

Fetch tests

zephyr-fetch-tests <baseUrl> <projectKey> <accessToken> [outputDir]

Example:

zephyr-fetch-tests https://api.zephyrscale.smartbear.com/v2 WMS <token> ./src/test/java/zephyr_features

Publish report

zephyr-publish-report <baseUrl> <projectKey> <accessToken> [htmlReportUrl] [reportDir]

Example:

zephyr-publish-report https://api.zephyrscale.smartbear.com/v2 WMS <token> https://example/reports/latest ./target/reports

Library usage

const { exportBddTestCases, uploadCucumberResults } = require('zephyr-bridge');

await exportBddTestCases({
  baseUrl: 'https://api.zephyrscale.smartbear.com/v2',
  projectKey: 'WMS',
  accessToken: process.env.ZEPHYR_TOKEN,
  outputDir: './src/test/java/zephyr_features'
});

await uploadCucumberResults({
  baseUrl: 'https://api.zephyrscale.smartbear.com/v2',
  projectKey: 'WMS',
  accessToken: process.env.ZEPHYR_TOKEN,
  htmlReportUrl: 'https://example/reports/latest',
  reportDir: './target/reports'
});

Publish to npm

1. Review package.json and bump version when needed.
2. Verify the published contents:

npm run pack:check

3. Login with npm:

npm login

4. Run tests:

npm test

5. Publish:

npm publish --access public

If you later switch to a scoped package (for example @your-org/zephyr-bridge), keep --access public.