feat: testing and cleanup

features
- significant unit test coverage
- some refactors to accommodate testing
- e2e tests
- GHA workflows to do all testing and linting
- bandit
- safety
- flake8
- isort
- ruff
- mypy

fixes for ci/cd

more fixes

test fixes

more test fixes

sudo

more e2e

more fixes

further improvements

improve e2e testing

get better logs

give it some time, and drop testing for mimic3

get mimic running for e2e testing

sudo it

more e2e attempted fixes

another approach for e2e fixes

better logic

more special sam work, force v1

sam is very special

more attempted fixes

another approach

branch

piper tests

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+branch = True
+source = ovos_tts_plugin_server
+omit =
+    */version.py

.github/workflows/e2e_tests.yml

@@ -0,0 +1,62 @@
+name: End-to-End Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master, dev]
+
+jobs:
+  e2e-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - plugin: "ovos-tts-plugin-piper"
+            # image: "ghcr.io/openvoiceos/piper-tts-server:dev" # TODO: This doesn't exist yet
+            image: "ghcr.io/mikejgray/piper-tts-server:dev"
+          - plugin: "ovos-tts-plugin-espeakng"
+            image: "ghcr.io/openvoiceos/espeakng:dev"
+          - plugin: "ovos-tts-plugin-mimic"
+            image: "ghcr.io/openvoiceos/mimic:dev"
+          - plugin: "ovos-tts-plugin-beepspeak"
+            image: "ghcr.io/openvoiceos/beepspeak-tts-server:master"
+          - plugin: "ovos-tts-plugin-sam"
+            image: "ghcr.io/openvoiceos/sam:dev"
+
+    env:
+      PLUGIN_TO_TEST: ${{ matrix.plugin }}
+
+    services:
+      sam:
+        image: ${{ matrix.image }}
+        ports:
+          - 9666:9666
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Cache Python packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt', '**/requirements-e2e.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          pip install -U -r requirements.txt
+          pip install -U --pre -r requirements-e2e.txt
+          pip install .
+
+      - name: E2E Tests
+        run: |
+          pytest tests/e2e.py

.github/workflows/publish_alpha.yml

@@ -29,4 +29,4 @@ jobs:
       alpha_var: VERSION_ALPHA
       build_var: VERSION_BUILD
       minor_var: VERSION_MINOR
-      major_var: VERSION_MAJOR
+      major_var: VERSION_MAJOR

.github/workflows/unit_tests.yml

@@ -1,10 +1,49 @@
 name: Unit Tests
 on:
-  push:
+  pull_request:
+    branches:
+      - master
+      - dev
   workflow_dispatch:
 
 jobs:
-  py_build_tests:
-    uses: neongeckocom/.github/.github/workflows/python_build_tests.yml@master
-    with:
-      python_version: "3.8"
+  unit-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8, 3.9, "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Cache Python dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-python-${{ matrix.python-version }}-${{ hashFiles('**/requirements.txt', '**/requirements-dev.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-python-${{ matrix.python-version }}-
+            ${{ runner.os }}-python-
+
+      - name: Install dependencies
+        run: |-
+          pip install -r requirements.txt
+          pip install -r requirements-dev.txt
+          pip install .
+
+      - name: Lint
+        run: |-
+          black --line-length=119 .
+          bandit -ll -r ovos_tts_plugin_server
+          flake8 --max-line-length=119 ovos_tts_plugin_server
+          isort --profile black .
+          ruff ovos_tts_plugin_server
+          mypy --ignore-missing-imports --exclude tests ovos_tts_plugin_server
+          safety check --ignore=58755 --continue-on-error
+
+      - name: Test
+        run: pytest

.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+.DS_Store
+.vscode/