Skip to content

Couple CONTRIB improvements #9

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

Merged
rjrudin merged 1 commit into from
Jul 14, 2023
+11 −4
Merged

Couple CONTRIB improvements #9

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ env
__pycache__
.venv
venv
.idea
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,27 @@ Before running any tests, first deploy the test application:

- Use Java 8 or higher
- `cd test-app`
- Verify that the host/port/username/admin in `gradle.properties` work for your ML install
- Create a file named `gradle-local.properties` and add `mlPassword=` to it, with the value of the property being
your admin user's password.
- Verify that the host/port/username in `gradle.properties` work for your MarkLogic installation.
- Run `./gradlew -i mlDeploy`
- `cd ..`

Then run all the tests:

pytest

To run an individual test with logging to stdout:
To run an individual test:

pytest -s tests/test_search.py
pytest tests/test_search.py

To run an individual test method:

pytest -s test/test_search.py::test_search
pytest test/test_search.py::test_search

Note that due to the pytest config in the `pyproject.toml` file, all
[Python logging](https://docs.python.org/3/howto/logging.html) should appear immediately
as tests are executed.

## Testing the client in a Python shell

Expand Down