Implement unit tests (#76)

RobPasMue · web-flow · commit df0feec162e0 · 2023-02-08T08:29:47.000+01:00
* Minor change to project description

* Including testing section

* Errors on workflow

* Increase pre-commit hooks

* Consider also .github folder in pre-commit

* Setting up proper dependencies between jobs

* Always upload server logs

* START command windows

* Upload artifact with different names

* New trial with windows cmd

* Trying to solve vale warning

* Using pythonw approach

* Checking if server runs at all...

* Caching tests dependencies

* Trying to emulate nohup approach Windows

* Typo in workflow

* Typo in workflow

* Trying different approach

* Other trial

* Try doing it all at once

* Even the process for Linux/Windows

* Not needed any more

* Remove sklearn dep
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -20,15 +20,6 @@ concurrency:
 
 jobs:
 
-  style:
-    name: Code style
-    runs-on: ubuntu-latest
-    steps:
-      - name: PyAnsys code style checks
-        uses: pyansys/actions/code-style@v3
-        with:
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}
-
   docs-style:
     name: Documentation Style Check
     runs-on: ubuntu-latest
@@ -38,6 +29,46 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    needs: [docs-style]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          cache: 'pip'
+          cache-dependency-path: 'pyproject.toml'
+
+      - name: Install packages for documentation build
+        run: |
+          sudo apt-get install xvfb pandoc
+          pip install --upgrade build
+          pip install .[doc]
+
+      - name: Build the documentation
+        run: |
+          xvfb-run make -C doc html
+
+      - name: Upload HTML documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: documentation-html
+          path: doc/_build/html
+          retention-days: 7
+
+  style:
+    name: Code style
+    runs-on: ubuntu-latest
+    steps:
+      - name: PyAnsys code style checks
+        uses: pyansys/actions/code-style@v3
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
   smoke-tests:
     name: Build and Smoke tests
     runs-on: ${{ matrix.os }}
@@ -57,40 +88,64 @@ jobs:
           operating-system: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
 
-  docs:
-    name: Documentation
-    runs-on: ubuntu-latest
-    needs: [docs-style]
+  tests:
+    name: Testing
+    runs-on: ${{ matrix.os }}
+    needs: [smoke-tests]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+    
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
+      - name: Set up Python
         uses: actions/setup-python@v4
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           cache: 'pip'
           cache-dependency-path: 'pyproject.toml'
 
-      - name: Install packages for documentation build
+      - name: Install ansys-dyna-core (with test requirements)
         run: |
-          sudo apt-get install xvfb pandoc
-          pip install --upgrade build
-          pip install .[doc]
+          pip install -e .[tests]
 
-      - name: Build the documentation
+      - name: Run tests (Windows)
+        if: runner.os == 'Windows'
         run: |
-          xvfb-run make -C doc html
+          Start-Job -ScriptBlock {cd ${{ github.workspace }}\src\ansys\dyna\core\pre\Server\;python kwserver.py >> server_output.txt}
+          Start-Sleep -Seconds 10
+          pytest
 
-      - name: Upload HTML documentation
+      - name: Run tests (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          cd src/ansys/dyna/core/pre/Server
+          python kwserver.py > server_output.txt &
+          sleep 10
+          cd -
+          pytest
+
+      - name: Upload the server logs
+        if: always()
         uses: actions/upload-artifact@v3
         with:
-          name: documentation-html
-          path: doc/_build/html
+          name: server-logs-${{ runner.os }}
+          path: src/ansys/dyna/core/pre/Server/server_output.txt
+
+      - name: Upload coverage results
+        if: runner.os == 'Linux'
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-html
+          path: .cov/html
           retention-days: 7
 
   package:
     name: Package library
-    needs: [docs]
+    needs: [docs, tests]
     runs-on: ubuntu-latest
     steps:
       - name: Build library source and wheel artifacts
@@ -114,7 +169,7 @@ jobs:
     name: Upload dev documentation
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
-    needs: [docs]
+    needs: [package]
     steps:
       - name: Deploy the latest documentation
         uses: pyansys/actions/doc-deploy-dev@v3
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,7 @@
 files: |
     (?x)(
-        ^src/ansys/
+        ^src/ansys/ |
+        ^.github/
     )
 exclude: |
     (?x)^(
@@ -14,12 +15,18 @@ exclude: |
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 23.1.0
+  rev: 23.1.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
   hooks:
   - id: black
     args:
       - --line-length=120 
 
+- repo: https://github.com/adamchainz/blacken-docs
+  rev: 1.13.0
+  hooks:
+  - id: blacken-docs
+    additional_dependencies: [black==23.1.0]
+
 - repo: https://github.com/codespell-project/codespell
   rev: v2.2.2
   hooks:
@@ -39,4 +46,15 @@ repos:
   - id: isort
     args:
       - --line-length=120
-      
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-merge-conflict
+  - id: debug-statements
+
+# this validates our github workflow files
+- repo: https://github.com/python-jsonschema/check-jsonschema
+  rev: 0.21.0
+  hooks:
+    - id: check-github-workflows
diff --git a/doc/source/Resources/pydyna_post.rst b/doc/source/Resources/pydyna_post.rst
@@ -1,5 +1,5 @@
-PyDPF-post for LS-DYNA
-======================
+Using PyDPF-post for LS-DYNA
+============================
 
 Operators
 ~~~~~~~~~
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 name = "ansys-dyna-core"
 version = "0.2.dev0"
-description = "Python interface to LSDYNA Service"
+description = "Python interface to LS-DYNA Service"
 readme = "README.rst"
 requires-python = ">=3.7,<4"
 license = {file = "LICENSE"}
@@ -41,7 +41,6 @@ tests = [
     "pytest-cov==4.0.0",
     "codecov==2.1.12",
     "joblib==1.2.0",
-    "sklearn==0.0.post1",
     "pandas==1.5.2",
     "openpyxl==3.0.10",
     "scikit-learn==1.2.1",
