Base class defining the interface for code coverage implementations
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.editorconfig
.eslintignore
.eslintrc.yaml
.gitignore
.npmignore
CONTRIBUTING.md
LICENSE
README.md
index.js
package-lock.json
package.json
screwdriver.yaml

README.md

Coverage Base

Version Downloads Build Status Open Issues Dependency Status License

Base class defining the interface for coverage upload implementations

Usage

npm install screwdriver-coverage-base

Interface

This is an interface for uploading code coverage results from a Screwdriver build to a code coverage server.

getAccessToken

Required Parameters
Parameter Type Description
buildCredentials Object Information stored in the build JWT token
Expected Outcome

The getAccessToken function should resolve a Promise with an access token that build can use to talk to the code coverage server.

getInfo

Required Parameters
Parameter Type Description
config Object
config.buildId String The unique ID for a build
config.jobId String The unique ID for a job
config.startTime String The job start time
config.endTime String The job end time
Expected Outcome

The getInfo function should resolve a Promise with an object with metadata about the project coverage.

getUploadCoverageCmd

Expected Outcome

The getUploadCoverageCmd function should resolve a Promise with a string of shell commands to upload code coverage results.

Extending

To extend the base class, the functions to override are:

  1. _getAccessToken
  2. _getInfo
  3. _getUploadCoverageCmd

Testing

npm test

Related links

See the coverage-bookend

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.