BUILDANDTEST.md

Build and testing instructions

Setup

1. Clone the repo to your local directory
2. Change to the installation directory

To build the generator and run the JUnit tests

mvn clean install

The JUnit tests conduct string comparisons of Python generated from Rune samples expected results.

All tests should pass.

To run the Python Unit Tests

Assuming the build and tests successfully complete and Python 3.11+ is installed.

test/python_unit_tests/run_python_unit_tests.sh

All tests should pass

To test that the generated code successfully deserializes and serializes

These tests implement the common standards found in the Rune Common Repo.

1. Get the test Rune and JSON files

test/serialization/get_serialization_source.sh

2. Generate Python from Rune definitions

mvn clean install

3. Run the tests

test/serialization/run_serialization_tests.sh

All tests are expected to pass.

Testing leverages serialization_test.py which can be used to test a directory of JSON or a specific file.

To use this script:

1. From the [Project Root], setup the environment:

build/setup_python.sh
source .pyenv/bin/activate

2. Then execute the script to get help instructions:

python test/serialization_test/serialization.py -h

3. To clean up the environment, execute the following from the Python project root:

deactivate
build/cleanup_python_env.sh