Merge pull request #536 from RocketPy-Team/develop

ENH: update master with develop for version 1.2.0

Author: Gui-FernandesBR

.github/auto-assign.yml

@@ -1,22 +1,2 @@
-# Set to true to add reviewers to PRs
-addReviewers: true
-
 # Set to 'author' to add PR's author as a assignee
 addAssignees: author
-
-# A list of reviewers to be added to PRs (GitHub user name)
-reviewers:
-  - Gui-FernandesBR
-  - giovaniceotto
-  - MateusStano
-  - phmbressan
-
-# A number of reviewers added to the PR
-# Set 0 to add all the reviewers (default: 0)
-numberOfReviewers: 0
-
-# A list of keywords to be skipped the process if PR's title include it
-skipKeywords:
-  - wip
-  - work in progress
-  - draft

.github/pull_request_template.md

@@ -16,7 +16,7 @@
 - [ ] Tests for the changes have been added (if needed)
 - [ ] Docs have been reviewed and added / updated
 - [ ] Lint (`black rocketpy/ tests/`) has passed locally 
-- [ ] All tests (`pytest --runslow`) have passed locally
+- [ ] All tests (`pytest tests -m slow --runslow`) have passed locally
 - [ ] `CHANGELOG.md` has been updated (if relevant)
 
 ## Current behavior

.github/workflows/codecov.yml

@@ -0,0 +1,35 @@
+coverage:
+  status:
+    project:
+      default:
+        # basic
+        target: auto
+        threshold: 1%
+        base: auto
+        flags:
+          - unit
+        paths:
+          - "rocketpy"
+        # advanced settings
+        branches:
+          - master
+          - develop
+        if_ci_failed: error #success, failure, error, ignore
+        informational: false
+        only_pulls: false
+    patch:
+      default:
+        # basic
+        target: auto
+        threshold: 1%
+        base: auto
+        # advanced
+        branches:
+          - master
+          - develop
+        if_ci_failed: error #success, failure, error, ignore
+        only_pulls: false
+        flags:
+          - "unit"
+        paths:
+          - "rocketpy"

.github/workflows/lint_black.yaml

@@ -19,7 +19,7 @@ jobs:
           python-version: 3.8
 
       - name: Install Python dependencies
-        run: pip install black
+        run: pip install black[jupyter]
 
       - name: Run linters
         uses: wearerequired/lint-action@v1

.github/workflows/test_pytest.yaml

@@ -1,4 +1,4 @@
-name: PyTest
+name: Tests
 
 on:
   pull_request:
@@ -7,58 +7,72 @@ on:
       - "**.py"
       - ".github/**"
 
+defaults:
+  run:
+    shell: bash
+
 jobs:
-  fail_if_pr_is_draft:
-    if: github.event.pull_request.draft == true
-    runs-on: ubuntu-18.04
-    steps:
-      - name: Fails in order to indicate that pull request needs to be marked as ready to review and unit tests workflow needs to pass.
-        run: exit 1
-  pytest_and_doctest:
+  Pytest:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os:
-          - ubuntu-latest
-          - macos-latest
-          - windows-latest
-        python-version:
-          - 3.8
-          - 3.12
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.8, 3.12]
     env:
       OS: ${{ matrix.os }}
       PYTHON: ${{ matrix.python-version }}
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python ${{ matrix.python-version }}
+      - uses: actions/checkout@v4
+      - name: Set up Python
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-      - name: Build RocketPy (without optional dependencies)
-        run: |
-          pip install .
-      - name: Import rocketpy in python and test if it works
-        run: |
-          python -c "import sys, rocketpy; print(f'{rocketpy.__name__} running on Python {sys.version}')"
-      - name: Install optional dependencies
-        run: |
-          pip install -r requirements-tests.txt
-      - name: Test with pytest
-        run: |
-          pytest --cov=rocketpy --cov-report=xml
-          cd rocketpy
-          pytest --doctest-modules --cov=rocketpy --cov-report=xml
-      - name: Upload coverage report to Codecov
-        uses: codecov/codecov-action@v3
+
+      - name: Cache Python dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements-tests.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install rocketpy
+        run: pip install .
+
+      - name: Test importing rocketpy
+        run: python -c "import sys, rocketpy; print(f'{rocketpy.__name__} running on Python {sys.version}')"
+
+      - name: Install test dependencies
+        run: pip install -r requirements-tests.txt
+
+      - name: Run Unit Tests
+        run: pytest tests/unit --cov=rocketpy
+
+      - name: Run Integration Tests
+        run: pytest $(find tests -maxdepth 1 -name "*.py") --cov=rocketpy --cov-append
+
+      - name: Run Documentation Tests
+        run: pytest rocketpy --doctest-modules --cov=rocketpy --cov-append
+
+      - name: Run Acceptance Tests
+        run: pytest tests/acceptance --cov=rocketpy --cov-append --cov-report=xml
+
+      - name: Upload coverage to artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage
+          path: coverage.xml
+
+  CodecovUpload:
+    needs: Pytest
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download all coverage reports
+        uses: actions/download-artifact@v2
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v2
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          directory: ./coverage/reports/
-          env_vars: OS,PYTHON
-          fail_ci_if_error: true
-          files: ./coverage.xml, ./rocketpy/coverage.xml
-          flags: unittests
-          name: codecov-umbrella
-          verbose: true
+          files: |
+            coverage.xml

.github/workflows/upload-to-codecov.yml

@@ -0,0 +1,29 @@
+name: Upload to Codecov
+
+on:
+  workflow_call:
+    inputs:
+      codecov_token:
+        required: true
+        type: string
+      os:
+        required: true
+        type: string
+      python:
+        required: true
+        type: string
+
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Upload coverage report to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ inputs.codecov_token }}
+          directory: ./coverage/reports/
+          env_vars: OS,PYTHON
+          files: ./coverage.xml, ./rocketpy/coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          verbose: true

.gitignore

@@ -36,7 +36,7 @@ MANIFEST
 pip-log.txt
 pip-delete-this-directory.txt
 
-# Unit test / coverage reports
+# Unit test / coverage reports / lints reports
 htmlcov/
 .tox/
 .nox/
@@ -50,6 +50,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+.pylint-report.txt
 
 # Translations
 *.mo

.pylintrc

@@ -187,6 +187,31 @@ function-naming-style=snake_case
 # Good variable names which should always be accepted, separated by a comma.
 good-names=FlightPhases,
            WindroseAxes,
+           barometric_height_ISA,
+           grain_I_33_initial,
+           convert_units_Functions,
+           Ix_volume,
+           Iy_volume,
+           Iz_volume,
+           Kn,
+           Kn_source,
+           I_dot,
+           I_CM,
+           Rdot,
+           Dx,
+           Dy,
+           Dz,
+           requires_netCDF4,
+           I_11_without_motor,
+           I_22_without_motor,
+           I_33_without_motor,
+           I_12_without_motor,
+           I_13_without_motor,
+           I_23_without_motor,
+           HTML,
+           fin_set_NACA,
+           fin_set_E473,
+           HIRESW_dictionary,
 
 
 # Good variable names regexes, separated by a comma. If names match any regex,
@@ -436,6 +461,7 @@ disable=raw-checker-failed,
         no-else-return,
         inconsistent-return-statements,
         unspecified-encoding,
+        no-member, # because we use funcify_method decorator
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option