#26: Added user guide

.github/workflows/check-packaging.yml

@@ -15,31 +15,31 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-  
+
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]
         with:
           python-version: ${{ matrix.python-version }}
-  
-      - name: Install Lua environment
-        run: ./scripts/install_lua_environment.sh
-  
+
+      - name: Install Development Environment
+        run: poetry run -- nox -s install_dev_env
+
       - name: Poetry install
-        run: ./scripts/run_in_dev_env.sh poetry install
-  
+        run: poetry run -- nox -s run_in_dev_env -- poetry install
+
       - name: Run packaging update
         # re-generates / amalgate the lua script
         # refactor pre-commit as nox task
         # and call in pre-commit
         run: bash ./githooks/pre-commit
-  
+
       - name: Show changes on working copy
         # check if re-generated lua script is still up-to-date
         run: git status --porcelain=v1 -uno
-  
+
       - name: Show diff on working copy
         run: git diff --cached
-  
+
       - name: Check if packaging changed
         run: |
           [ -z "$(git status --porcelain=v1 -uno 2>/dev/null)" ]

.github/workflows/checks.yml

@@ -16,6 +16,8 @@ jobs:
 
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]
+        with:
+          python-version: "3.10"
 
   lint-job:
     name: Linting (Python-${{ matrix.python-version }})

.github/workflows/tests-integration-db.yml

@@ -38,8 +38,8 @@ jobs:
         with:
           python-version: ${{ inputs.python-version }}
 
-      - name: Install Lua environment
-        run: poetry run -- nox -s install_lua_environment
+      - name: Install Development Environment
+        run: poetry run -- nox -s install_dev_env
 
       - name: Poetry install
         run: poetry run -- nox -s run_in_dev_env -- poetry install

.github/workflows/tests-unit.yml

@@ -19,8 +19,8 @@ jobs:
         with:
           python-version: ${{ inputs.python-version }}
 
-      - name: Install Lua environment
-        run: poetry run -- nox -s install_lua_environment
+      - name: Install Development Environment
+        run: poetry run -- nox -s install_dev_env
 
       - name: Poetry install
         run: poetry run -- nox -s run_in_dev_env -- poetry install

doc/changes/changes_0.1.0.md

@@ -55,6 +55,7 @@ Code name:
 ### Documentation
 
 * #9: Added README file
+* #26: Added user guide
 
 ## Dependency Updates
 

doc/developer_guide/developer_guide.md

@@ -1,8 +1,66 @@
 # Developer Guide
 
-
-In this developer guide we explain how you can build this project.
+The developer guide explains how to maintain and develop the Advanced Analytics Framework (AAF).
 
 * [developer_environment](developer_environment.md)
-* [building_documentation](building_documentation.md)
 
+## Building and Installing the AAF Script Language Container (SLC)
+
+The following command builds the SLC for the AAF
+
+```shell
+poetry run nox -s build_language_container
+```
+
+Installing the SLC ins described in the [AAF User Guide](../user_guide/user_guide.md#script-language-container-slc).
+
+## Running Tests
+
+AAF comes with different automated tests implemented in different programming languages and requiring different environments:
+
+| Language | Category                        | Database | Environment |
+|----------|---------------------------------|----------|-------------|
+| Python   | Unit tests                      | no       | poetry      |
+| Python   | Integration tests with database | yes      | _dev_env_   |
+| Python   | Integration tests w/o database  | no       | _dev_env_   |
+| Lua      | Unit tests                      | no       | _dev_env_   |
+
+### Development Environment
+
+For tests marked with Environment _dev_env_ you need to
+* Setup a Development Environment
+* Add the AAF to it
+* Run the tests in the Development Environment
+
+The Development Environment
+* Activates AAF's conda environment containing a specific versino of Lua
+* Sets the environment variables `LUA_PATH`, `LUA_CPATH`, and `PATH` for executing lua scripts
+
+The following commands install the Development Environment and add the AAF
+```shell
+poetry run -- nox -s install_dev_env
+poetry run -- nox -s run_in_dev_env -- poetry install
+```
+
+### Python Unit Tests
+
+You can execute the unit tests without special preparation in the regular poetry environment:
+
+```shell
+poetry run pytest tests/unit_tests
+```
+
+### Python Integration Tests with and w/o database
+
+The following commands run integration tests w/o and with database
+```shell
+poetry run -- nox -s run_python_test -- -- tests/integration_tests/without_db/
+poetry run -- nox -s run_python_test -- -- --backend=onprem tests/integration_tests/with_db/
+```
+
+### Lua Unit Tests
+
+The following command executes the Lua Unit Tests:
+```shell
+poety run nox -s run_lua_unit_tests
+```