Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Apiary reporter #68

Merged
merged 1 commit into from
Jun 2, 2014
Merged

Apiary reporter #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 31 additions & 0 deletions ApiaryReporter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Rest reporter

### Activation

Rest reporter is activated by exposing environment variables withs token and suite.

- DREDD_REST_TOKEN ... Authentication token used for reporting
- DREDD_REST_SUITE ... API Suite reporting to
- DREDD_REST_URL ... Upstream API base URL. Default to https://api.apiary.io
- DREDD_REST_DEBUG ... Turn on debugging messages

### Passing test run details with env varirables

> json_dot.notation ... ENV VAIRABLE || default value

- agent ... DREDD_AGENT || process.env['USER']
- hostname ... DREDD_HOSTNAME || os.hostname
- agentEnvironment.ci ... CI || undefined
- agentEnvironment.name ... CI_NAME || undefined
- agentEnvironment.bulidId ... CI_BUILD_ID || undefined
- agentEnvironment.buildNumber ... CI_BUILD_NUMBER || undefined
- agentEnvironment.jobId ... CI_JOB_ID || undefined
- agentEnvironment.jobNumber ... CI_JOB_NUMBER || undefined

See [Rest Reporting API documentation][doc] and it's [Apiary documentation](apiarydoc) for more information about reporting data strucutres and API.

[doc]: https://github.com/apiaryio/dredd/blob/netmilk/rest-reporter/RestReportingApiBlueprint.md
[apiarydoc]: http://docs.reportingmock.apiary.io/