Skip to content

Commit

Permalink
docs: Adds testing notes
Browse files Browse the repository at this point in the history
  • Loading branch information
ntlhui committed Sep 18, 2024
1 parent 77d047e commit 9a3cc63
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.10.11
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1114,3 +1114,27 @@ Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)

The manual labels provided for this dataset are automatically downloaded as a .csv when
the repository is cloned.

## Testing
Tests require E4E NAS credentials. These must be provided as a JSON file, or as an environment variable.

If provided as a JSON file, this file must be placed at `${workspaceFolder}/credentials.json`, and have the following structure:
```
{
"username": "e4e_nas_user",
"password": "e4e_nas_password"
}
```

If provided as an environment variable, the variable must be named `NAS_CREDS` and must have the following structure:
```
{"username":"e4e_nas_user","password":"e4e_nas_password"}
```

Any account used must have read access to the following share:
- //e4e-nas.ucsd.edu/temp

Execute `pytest` as follows:
```
python -m pytest pyha_tests
```

0 comments on commit 9a3cc63

Please sign in to comment.