build: prepare to unit test

Adopt Technologies: * PDM - "A modern Python package and dependency manager supporting the latest PEP standards." * pyproject.toml - Used by PDM to manage project dependencies and metadata. * pytest - A nice modern unit testing framework for python. Reorganized tests, and removed local-min-max test. They were breaking and are VERY slow. They were intended to mimic those that run in CI. But those are passing. Added bin/test/units.bash to run unit tests. Place unit tests in tests/unit/. No longer supporting python < 3.9. --- Related to #119 Closes #131 Thanks to Co-authored-by: Akshar Patel <[email protected]> He performed the initial research for pyproject.toml
ourPLCC · May 1, 2024 · fe08748 · fe08748
1 parent e4b429a
commit fe08748
Show file tree

Hide file tree

Showing 24 changed files with 153 additions and 72 deletions.
diff --git a/.../test_python-3.5.10_Java-11.0.21-tem.yaml → .../test_python-3.9.19_Java-11.0.21-tem.yaml b/.../test_python-3.5.10_Java-11.0.21-tem.yaml → .../test_python-3.9.19_Java-11.0.21-tem.yaml
@@ -1,12 +1,12 @@
 ---
-name: test_python-3.5.10_Java-11.0.21-tem
+name: test_python-3.9.19_Java-11.0.21-tem
 
 on:
   pull_request:
 
 jobs:
   build:
-    name: test_python-3.5.10_Java-11.0.21-tem
+    name: test_python-3.9.19_Java-11.0.21-tem
     runs-on: ubuntu-latest
     steps:
       -
@@ -22,7 +22,7 @@ jobs:
           push: false
           build-args: |
             JAVA_VERSION=11.0.21-tem
-            PYTHON_VERSION=3.5.10
+            PYTHON_VERSION=3.9.19
       -
         name: Test
         uses: addnab/docker-run-action@v3

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+# See https://pdm-project.org/latest/usage/project/#working-with-version-control
+.pdm-python
+
 # This is created by bin/test/languages.bash. But should not be committed.
 languages/
 

diff --git a/.gitpod.yml b/.gitpod.yml
@@ -32,4 +32,9 @@ tasks:
         && sudo ./install.sh /usr/local \
         && cd .. \
         && sudo rm -rf bats-core
+      echo ""
+      echo "INSTALLING PDM"
+      curl -sSL https://pdm-project.org/install-pdm.py | python3 -
+      echo "export PATH=/workspace/.pyenv_mirror/user/current/bin:\$PATH" >> ~/.bashrc
       exec bash
+      pdm install
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ Related repositories:
 
 - [ourPLCC/languages](https://github.com/ourPLCC/languages): Languages implemented in PLCC.
 - [ourPLCC/course](https://github.com/ourPLCC/course): Course materials for
-  teaching a Programming Languages course that uses PLCC.
+  teaching a Programming Languages course the uses PLCC.
 
 ## Options for Installation and Use
 
@@ -24,7 +24,7 @@ may help you determine which option is best for you and your class.
 | ------ | ------------------- | ----------------------- | ---------- |
 | GitPod |  Web Browser | * Account on GitPod <br> * Account on hosting service (GitLab/GitHub/Bitbucket) <br> * Knowledge of above and Git | Yes |
 | Docker | Docker Desktop | Minimal understanding of Docker | Yes |
-| Native | * Bash/Linux-like environment <br> * Java >= 11 <br> * Python >= 3.5 | System administration knowledge | No |
+| Native | * Bash/Linux-like environment <br> * Java >= 11 <br> * Python >= 3.9 | System administration knowledge | No |
 
 The advantages of GitPod or Docker are (1) few or no software dependencies
 and (2) the ability to provide your class/developers a consistent development
@@ -141,7 +141,7 @@ and use it to install Java.
 
 ### Install Python
 
-Check if you have Python >= 3.5
+Check if you have Python >= 3.9
 
 ```bash
 python3 --version

diff --git a/bin/test/units.bash b/bin/test/units.bash
@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+PROJECT_ROOT="$( cd "${SCRIPT_DIR}/../.." &> /dev/null && pwd )"
+
+pdm install
+pdm test
diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,34 @@
+[project]
+name = "plcc"
+version = "8.0.0"
+description = "Programming Languages Compiler Compiler"
+authors = [
+    {name = "Tim Fossum", email = "[email protected]"},
+    {name = "Stoney Jackson", email = "[email protected]"}
+]
+dependencies = []
+requires-python = ">=3.9"
+readme = "README.md"
+license = {text = "GPL-3.0-or-later"}
+
+
+[project.scripts]
+plcc = "plcc.__main__:main"
+
+
+[build-system]
+requires = ["pdm-backend"]
+build-backend = "pdm.backend"
+
+
+[tool.pdm]
+distribution = true
+
+
+[tool.pdm.dev-dependencies]
+dev = [
+    "pytest>=8.2.0",
+]
+
+[tool.pdm.scripts]
+test = "pytest"
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/parse/parses/given-grammar.plcc → ...nd-to-end/parse/parses/given-grammar.plcc b/tests/parse/parses/given-grammar.plcc → ...nd-to-end/parse/parses/given-grammar.plcc
diff --git a/tests/parse/parses/given-program.lang → ...nd-to-end/parse/parses/given-program.lang b/tests/parse/parses/given-program.lang → ...nd-to-end/parse/parses/given-program.lang
diff --git a/tests/parse/parses/parses.bats → tests/end-to-end/parse/parses/parses.bats b/tests/parse/parses/parses.bats → tests/end-to-end/parse/parses/parses.bats
diff --git a/tests/parse/print-json-ast/expected.json → ...to-end/parse/print-json-ast/expected.json b/tests/parse/print-json-ast/expected.json → ...to-end/parse/print-json-ast/expected.json
diff --git a/...s/parse/print-json-ast/given-grammar.lang → ...d/parse/print-json-ast/given-grammar.lang b/...s/parse/print-json-ast/given-grammar.lang → ...d/parse/print-json-ast/given-grammar.lang
diff --git a/...s/parse/print-json-ast/given-program.lang → ...d/parse/print-json-ast/given-program.lang b/...s/parse/print-json-ast/given-program.lang → ...d/parse/print-json-ast/given-program.lang
diff --git a/...parse/print-json-ast/prints-json-ast.bats → ...parse/print-json-ast/prints-json-ast.bats b/...parse/print-json-ast/prints-json-ast.bats → ...parse/print-json-ast/prints-json-ast.bats
diff --git a/...ion-grammar-does-not-generate-python.bats → ...ion-grammar-does-not-generate-python.bats b/...ion-grammar-does-not-generate-python.bats → ...ion-grammar-does-not-generate-python.bats
diff --git a/...c/4-section-grammar-generates-python.bats → ...c/4-section-grammar-generates-python.bats b/...c/4-section-grammar-generates-python.bats → ...c/4-section-grammar-generates-python.bats
diff --git a/tests/plcc/detects-illegal-tokens.bats → ...d-to-end/plcc/detects-illegal-tokens.bats b/tests/plcc/detects-illegal-tokens.bats → ...d-to-end/plcc/detects-illegal-tokens.bats
diff --git a/tests/plcc/reports-version-number.bats → ...d-to-end/plcc/reports-version-number.bats b/tests/plcc/reports-version-number.bats → ...d-to-end/plcc/reports-version-number.bats
diff --git a/tests/relocate_to_temp.bash → tests/end-to-end/relocate_to_temp.bash b/tests/relocate_to_temp.bash → tests/end-to-end/relocate_to_temp.bash
diff --git a/tests/scan/scans-tokens.bats → tests/end-to-end/scan/scans-tokens.bats b/tests/scan/scans-tokens.bats → tests/end-to-end/scan/scans-tokens.bats
diff --git a/tests/local-min-max-test/README.md b/tests/local-min-max-test/README.md
diff --git a/tests/local-min-max-test/run.bash b/tests/local-min-max-test/run.bash
diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py