Skip to content

Commit b11cc10

Browse files
committed
update readme
1 parent 2d74049 commit b11cc10

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,9 @@ pip install -e .[dev]
4646

4747
Run the tests:
4848

49-
Export usernames, passwords, and set test options.
49+
Export usernames, passwords, and test options.
5050

51-
Note that IPR tests will try to use the BCGSC production GraphKB API by default.
52-
If you want to test interaction with a different instance, you will need to
53-
set the GraphKB variables.
51+
IPR_URL and GRAPHKB_URL values must also be set.
5452

5553
Set EXCLUDE vars to 1 if you don't want to run these tests.
5654
ONCOKB and BCGSC tests are enabled by default.
@@ -67,11 +65,12 @@ export EXCLUDE_ONCOKB_TESTS=1
6765
```
6866

6967
If you want to run tests that upload reports to a live IPR instance,
70-
specify the url of the IPR API you want to use and set the test var to 1.
68+
specify the url of the IPR API you want to use and set the test var
69+
INCLUDE_UPLOAD_TESTS to 1.
7170
These tests are disabled by default.
7271

7372
The created reports are deleted by default. If you want to keep them,
74-
set DELETE_UPLOAD_TEST_REPORTS to 0 in the env.
73+
set DELETE_UPLOAD_TEST_REPORTS to 0.
7574

7675
```bash
7776
export IPR_TEST_URL='http://localhost:8081/api'
@@ -84,14 +83,16 @@ pytest tests
8483
```
8584

8685
### JSON Validate and Upload to IPR
86+
An IPR_URL must be provided either as an environment variable or an arg.
87+
8788
If you only want to validate the json content, use
8889
```bash
89-
ipr --password $IPR_PASS -c 'path/to/content.json' --validate_json
90+
ipr --password $IPR_PASS -c 'path/to/content.json' --validate_json --ipr_url $IPR_URL
9091
```
9192

9293
If you only want to upload the json directly to ipr and skip all the preprocessing, use
9394
```bash
94-
ipr --password $IPR_PASS -c 'path/to/content.json' --upload_json
95+
ipr --password $IPR_PASS -c 'path/to/content.json' --upload_json --ipr_url $IPR_URL
9596
```
9697

9798
## Documentation

0 commit comments

Comments
 (0)