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.

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

docs: Adds testing notes #219

Merged
merged 1 commit into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
```