@diffblue/cover-client

Diffblue Cover client library - Node.js API for Diffblue Cover

The Diffblue Cover client library provides a programmatic interface and CLI for communicating with the Diffblue Cover API.

Installation

Using npm:

npm install @diffblue/cover-client

Usage

To use Diffblue Cover to run an analysis and produce test files you will need to provide a JAR file of your compiled code and the path to a directory where you want test files to be written.

In Node.js (using promises):

const Analysis = require('@diffblue/cover-client').Analysis;
const fs = require('fs');

const analysis = new Analysis('https://your-cover-api-domain.com');
const buildFile = fs.createReadStream('./build.jar');
// This is a sample settings object that will not run a useful analysis.
// You can omit the settings parameter when calling `run` to start an analysis with default settings.
const settings = { phases: { firstPhase: { timeout: 10 }}};
const options = { outputTests: './tests' };

analysis.run({ build: buildFile }, settings, options)
.then((results) => {
  console.log(`Analysis ended with the status: ${analysis.status}.`);
  console.log(`Produced ${results.length} tests in total.`);
  console.log(`Test files written to ${options.outputTests}.`);
});

In Typescript (using async/await):

import Analysis from '@diffblue/cover-client';
import { createReadStream } from 'fs';

const analysis = new Analysis('https://your-cover-api-domain.com');
const buildFile = createReadStream('./build.jar');
// This is a sample settings object that will not run a useful analysis.
// You can omit the settings parameter when calling `run` to start an analysis with default settings.
const settings = { phases: { firstPhase: { timeout: 10 }}};
const options = { outputTests: './tests' };

(async () => {
  const results = await analysis.run({ build: buildFile }, settings, options);
  console.log(`Analysis ended with the status: ${analysis.status}.`);
  console.log(`Produced ${results.length} tests in total.`);
  console.log(`Test files written to ${options.outputTests}.`);
})();

For more detailed usage, see the programmatic interface documentation.

Full documentation

• Programmatic interface
  • Object orientated interface
    • Instantiation
      • Resume an analysis
    • Usage
      • Run an analysis (object orientated)
        • Stop polling for results
      • Start an analysis (object orientated)
      • Get analysis status (object orientated)
      • Get analysis results (object orientated)
      • Cancel an analysis (object orientated)
      • Get default analysis settings (object orientated)
      • Get API version (object orientated)
      • Write test files to disk (object orientated)
    • Result pagination
    • Lifecycle
  • Low level bindings
    • Start an analysis (low level)
    • Get analysis status (low level)
    • Get analysis results (low level)
    • Cancel an analysis (low level)
    • Get default analysis settings (low level)
    • Get API version (low level)
    • Low level options
      • Ignore https rejection
  • Combining results into test classes
    • Write test files to disk
    • Generate a new test class
    • Merge results into an existing test class
    • Filter results
    • Group results
• Command line interface
• Tests and checks
  • Linting
  • Unit tests
  • CLI tests
  • Copyright checker
  • License checker
  • Integration tests
    • Mock API
• Release procedure
• Utilities
  • Create Release
  • Changelog
• Code standards
  • File naming
  • Branches
  • Coding style
  • Code documentation
• Contributing guidelines

Copyright 2019 Diffblue Limited. All Rights Reserved.