Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpmonette/apexcov
Generates public Apex test coverage reports for your Force.com open-source projects
https://github.com/jpmonette/apexcov
apex code-coverage forcedotcom golang lcov salesforce unit-testing
Last synced: about 2 months ago
JSON representation
Generates public Apex test coverage reports for your Force.com open-source projects
- Host: GitHub
- URL: https://github.com/jpmonette/apexcov
- Owner: jpmonette
- License: mit
- Created: 2017-04-08T13:01:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-08T17:55:24.000Z (over 6 years ago)
- Last Synced: 2024-06-20T08:01:27.713Z (6 months ago)
- Topics: apex, code-coverage, forcedotcom, golang, lcov, salesforce, unit-testing
- Language: Go
- Homepage: http://blogue.jpmonette.net/2017/04/09/apex-test-coverage-with-coveralls/
- Size: 9.77 KB
- Stars: 11
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# apexcov
Maintaining a well-tested codebase is mission-critical. `apexcov` generates public [Apex](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_intro_what_is_apex.htm) test coverage reports for your [Force.com](https://force.com) open-source projects.
[](https://circleci.com/gh/jpmonette/apexcov)
## Installation
```sh
$ go get -u github.com/jpmonette/apexcov
```
## Usage
To generate your test coverage report:
```sh
$ apexcov --username="[email protected]" --password="my-password"
```
You can shorten the command by setting the global options as environment variables:
- `APEXCOV_INSTANCE`: Salesforce instance URL
- `APEXCOV_USERNAME`: Account username
- `APEXCOV_PASSWORD`: Account password
### Coveralls
#### Travis CI
Add this to your `.travis.yml`:
```yaml
env:
- GOPATH=$HOME/go PATH=$GOPATH/bin:$PATH
before_script:
- npm install -g coveralls
- go get github.com/jpmonette/apexcov
script:
- apexcov
- codeclimate-test-reporter < ./coverage/lcov.info
```
(make sure you set your `COVERALLS_REPO_TOKEN` environment variable)
#### CircleCI
Add this to your `circle.yml`:
```yaml
machine:
pre:
- npm install -g coveralls
- go get -u github.com/jpmonette/apexcov
test:
post:
- apexcov
- cat ./coverage/lcov.info | coveralls
```
### Code Climate
#### Travis CI
Add this to your `.travis.yml`:
```yaml
env:
- GOPATH=$HOME/go PATH=$GOPATH/bin:$PATH
- CC_TEST_REPORTER_ID=YOUR_CODE_CLIMATE_REPORTER_ID
before_script:
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
- chmod +x ./cc-test-reporter
- go get github.com/jpmonette/apexcov
- ./cc-test-reporter before-build
script:
- apexcov
- ./cc-test-reporter format-coverage -t lcov ./coverage/lcov.info
- ./cc-test-reporter upload-coverage
```
#### CircleCI 1.0
Add this to your `circle.yml`:
```yaml
machine:
pre:
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
- chmod +x ./cc-test-reporter
- go get -u github.com/jpmonette/apexcov
test:
post:
- apexcov
- ./cc-test-reporter format-coverage -t lcov ./coverage/lcov.info
- ./cc-test-reporter upload-coverage
```
(make sure you set your `CC_TEST_REPORTER_ID` environment variable)
#### CircleCI 2.0
Add this to your `.circleci/config.yml`:
```yaml
build:
environment:
CC_TEST_REPORTER_ID: YOUR_CODE_CLIMATE_REPORTER_ID
steps:
- go get -u github.com/jpmonette/apexcov
- run: curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
- run: chmod +x ./cc-test-reporter
- apexcov
- ./cc-test-reporter format-coverage -t lcov ./coverage/lcov.info
- ./cc-test-reporter upload-coverage
```
## Help
```sh
NAME:
apexcov - a Test Coverage Generator for Apex
USAGE:
apexcov [global options] command [command options] [arguments...]
VERSION:
1.0.0
AUTHOR:
Jean-Philippe Monette
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--instance value Salesforce instance to use (default: "https://login.salesforce.com")
--username value Username of the Salesforge org
--password value Password of the Salesforge org
--help, -h show help
--version, -v print the version
```
## License
This application is distributed under the MIT license found in the [LICENSE](./LICENSE)
file.