Provide local testing functionality

[JR-1991]

Changes this PR introduces

• Adds local testing functionality using Docker
• Users can run tests via the run-tests.sh script
• Python versions can be specified via the -p flag

Why this change is required

• Local tests require a working Dataverse instance
• GitHub testing workflow should be reflected

ToDos

• Add a description on how to run single tests
  • How to retrieve the API_TOKEN and SERVER_URL without the provided script

How to run the tests

In order to run the tests, you need to have a Dataverse instance running. We have prepared a shell script that will start a Dataverse instance using Docker that runs all tests in a clean environment. To run the tests, execute the following command:

# Defaults to Python 3.11
./run_tests.sh

# To run the tests with a specific Python version
./run_tests.sh -p 3.8

Once finished, you can find the test results in the dv/unit-tests.log file and in the terminal.

Manual setup

If you want to run single tests you need to manually set up the environment and set up the necessary environment variables. Please follow the instructions below.

1. Start the Dataverse instance

docker compose \
    -f ./docker/docker-compose-base.yml \
    --env-file local-test.env \
    up -d

2. Set up the environment variables

export BASE_URL=http://localhost:8080
export DV_VERSION=6.2 # or any other version
export $(grep "API_TOKEN" "dv/bootstrap.exposed.env")
export API_TOKEN_SUPERUSER=$API_TOKEN

3. Run the test(s) with pytest

python -m pytest -v

Closes #169

[poikilotherm]

A note here: wouldn't it make sense to require folks to run the integration tests using pytest on their machine (potentially using poetry) and use sth like Testcontainers for Python to run a Compose config?

It's the same thing as within the upstream codebase: using Testcontainers lets you regain control over service dependencies from within testing and not rely on outside control scripts.

[JR-1991]

I agree, running Dataverse and tests independently would be great! I've gone with this solution mainly due to retrieving the API Token and ingesting it into the testing workflow. It replicates what the Dataverse action does and leaves the "technicalities" to the bash script.

My main concern with going for an independent solution would be that users still need a way to extract the API Token into their environment for tests to run successfully. Effectively, this would always require some intermediate script since I am not able to hardcode this into tests.

Thanks for the repo! Maybe re-structuring the tests around Testcontainers and parsing the logs could work. I will check the repo out tomorrow - Enough "Nachtschicht" for today 😁

[pdurbin]

Hey @kuriwaki and @wibeasley you might want something like this for https://github.com/IQSS/dataverse-client-r

[JR-1991]

@poikilotherm @pdurbin, I just wanted to give you a quick update. I've been working on the README.md file and added new instructions to make things easier for everyone. I have added instructions on how to run all tests at once in a shell script, as was initially proposed in this PR. The docs also include a recipe on how to set up everything manually if one wants to run single tests.

Can you test or review the recent additions?