{"id":22351861,"url":"https://github.com/screwdriver-cd/coverage-base","last_synced_at":"2026-02-12T01:39:28.712Z","repository":{"id":48824376,"uuid":"131906633","full_name":"screwdriver-cd/coverage-base","owner":"screwdriver-cd","description":"Base class defining the interface for code coverage implementations","archived":false,"fork":false,"pushed_at":"2025-02-20T00:01:10.000Z","size":58,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-10-06T13:31:40.948Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://cd.screwdriver.cd/pipelines/705","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/screwdriver-cd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-05-02T21:14:41.000Z","updated_at":"2025-02-19T23:59:39.000Z","dependencies_parsed_at":"2025-04-12T17:45:02.358Z","dependency_job_id":"1c0da83e-df8b-479b-89de-065f1af1d679","html_url":"https://github.com/screwdriver-cd/coverage-base","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/screwdriver-cd/coverage-base","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fcoverage-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fcoverage-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fcoverage-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fcoverage-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/screwdriver-cd","download_url":"https://codeload.github.com/screwdriver-cd/coverage-base/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fcoverage-base/sbom","scorecard":{"id":806223,"data":{"date":"2025-08-11","repo":{"name":"github.com/screwdriver-cd/coverage-base","commit":"feb370d1c8e2363d8f29944fa3e54f11918553e2"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.8,"checks":[{"name":"Code-Review","score":9,"reason":"Found 18/19 approved changesets -- score normalized to 9","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 25 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T11:50:04.274Z","repository_id":48824376,"created_at":"2025-08-23T11:50:04.275Z","updated_at":"2025-08-23T11:50:04.275Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29352973,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T01:03:07.613Z","status":"ssl_error","status_checked_at":"2026-02-12T01:00:51.346Z","response_time":97,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-04T12:16:06.538Z","updated_at":"2026-02-12T01:39:28.697Z","avatar_url":"https://github.com/screwdriver-cd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Coverage Base\n[![Version][npm-image]][npm-url] ![Downloads][downloads-image] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] ![License][license-image]\n\n\u003e Base class defining the interface for coverage upload implementations\n\n## Usage\n\n```bash\nnpm install screwdriver-coverage-base\n```\n\n## Interface\nThis is an interface for uploading code coverage results from a Screwdriver build to a code coverage server.\n\n### getAccessToken\n##### Required Parameters\n| Parameter        | Type  |  Description |\n| :--------------- | :---- | :----------- |\n| config           | Object |             |\n| config.buildCredentials | Object | Information stored in the build JWT token |\n| config.projectKey | String | Project key (can be directly passed in with just startTime and endTime) |\n| config.scope | String | Coverage scope (pipeline or job) |\n| config.username | String | Project username |\n\n##### Expected Outcome\nThe `getAccessToken` function should resolve a Promise with an access token that build can use to talk to the code coverage server.\n\n### getInfo\n##### Required Parameters\n| Parameter        | Type   |  Description |\n| :--------------- | :----- | :----------- |\n| config           | Object |              |\n| config.jobId     | String | The unique ID for a job |\n| config.jobName   | String | The Screwdriver job name |\n| config.pipelineId | String | The unique ID for a pipeline |\n| config.pipelineName | String | The Screwdriver pipeline name |\n| config.prNum     | String | The pull request number |\n| config.startTime | String | The job start time |\n| config.endTime   | String | The job end time |\n| config.projectKey | String | Project key (can be directly passed in with just startTime and endTime) |\n| config.prParentJobId | String | PR parent job ID |\n| config.scope | String | Coverage scope (pipeline or job) |\n\n##### Expected Outcome\nThe `getInfo` function should resolve a Promise with an object with metadata about the project coverage.\n\n### getUploadCoverageCmd\n##### Required Parameters\n| Parameter        | Type   |  Description |\n| :--------------- | :----- | :----------- |\n| config           | Object |              |\n| config.build     | String | The build    |\n| config.job       | String | The job      |\n| config.pipeline  | String | The pipeline |\n\n##### Expected Outcome\nThe `getUploadCoverageCmd` function should resolve a Promise with a string of shell commands to upload code coverage results.\n\n## Extending\nTo extend the base class, the functions to override are:\n1. `_getAccessToken`\n1. `_getInfo`\n1. `_getUploadCoverageCmd`\n\n\n## Testing\n\n```bash\nnpm test\n```\n\n## Related links\nSee the [coverage-bookend](https://github.com/screwdriver-cd/coverage-bookend)\n\n## License\n\nCode licensed under the BSD 3-Clause license. See LICENSE file for terms.\n\n[npm-image]: https://img.shields.io/npm/v/screwdriver-coverage-base.svg\n[npm-url]: https://npmjs.org/package/screwdriver-coverage-base\n[downloads-image]: https://img.shields.io/npm/dt/screwdriver-coverage-base.svg\n[license-image]: https://img.shields.io/npm/l/screwdriver-coverage-base.svg\n[issues-image]: https://img.shields.io/github/issues/screwdriver-cd/coverage-base.svg\n[issues-url]: https://github.com/screwdriver-cd/coverage-base/issues\n[status-image]: https://cd.screwdriver.cd/pipelines/705/badge\n[status-url]: https://cd.screwdriver.cd/pipelines/705\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrewdriver-cd%2Fcoverage-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscrewdriver-cd%2Fcoverage-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrewdriver-cd%2Fcoverage-base/lists"}