1go-github tests
2===============
3
4This directory contains additional test suites beyond the unit tests already in
5[../github](../github). Whereas the unit tests run very quickly (since they
6don't make any network calls) and are run by Travis on every commit, the tests
7in this directory are only run manually.
8
9The test packages are:
10
11integration
12-----------
13
14This will exercise the entire go-github library (or at least as much as is
15practical) against the live GitHub API. These tests will verify that the
16library is properly coded against the actual behavior of the API, and will
17(hopefully) fail upon any incompatible change in the API.
18
19Because these tests are running using live data, there is a much higher
20probability of false positives in test failures due to network issues, test
21data having been changed, etc.
22
23These tests send real network traffic to the GitHub API and will exhaust the
24default unregistered rate limit (60 requests per hour) very quickly.
25Additionally, in order to test the methods that modify data, a real OAuth token
26will need to be present. While the tests will try to be well-behaved in terms
27of what data they modify, it is **strongly** recommended that these tests only
28be run using a dedicated test account.
29
30Run tests using:
31
32 GITHUB_AUTH_TOKEN=XXX go test -v -tags=integration ./integration
33
34Additionally there are a set of integration tests for the Authorizations API.
35These tests require a GitHub user (username and password), and also that a
36[GitHub Application](https://github.com/settings/applications/new) (with
37attendant Client ID and Client Secret) be available. Then, to execute just the
38Authorization tests:
39
40 GITHUB_USERNAME='<GH_USERNAME>' GITHUB_PASSWORD='<GH_PASSWORD>' GITHUB_CLIENT_ID='<CLIENT_ID>' GITHUB_CLIENT_SECRET='<CLIENT_SECRET>' go test -v -tags=integration -run=Authorizations ./integration
41
42If some or all of these environment variables are not available, certain of the
43Authorization integration tests will be skipped.
44
45fields
46------
47
48This will identify the fields being returned by the live GitHub API that are
49not currently being mapped into the relevant Go data type. Sometimes fields
50are deliberately not mapped, so the results of this tool should just be taken
51as a hint.
52
53This test sends real network traffic to the GitHub API and will exhaust the
54default unregistered rate limit (60 requests per hour) very quickly.
55Additionally, some data is only returned for authenticated API calls. Unlike
56the integration tests above, these tests only read data, so it's less
57imperative that these be run using a dedicated test account (though you still
58really should).
59
60Run the fields tool using:
61
62 GITHUB_AUTH_TOKEN=XXX go run ./fields/fields.go
View as plain text