Adding more documentation #342
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Continuous Test | |
| on: | |
| push: | |
| branches: | |
| - 'main' | |
| pull_request: {} | |
| jobs: | |
| lint: | |
| environment: continuous_test | |
| strategy: | |
| matrix: | |
| # Run for Python 3.8 only for now | |
| python-version: ['3.8'] | |
| os: [ubuntu-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install dependencies | |
| run: | | |
| pip install isort flake8 interrogate | |
| echo "## CI/CD Summary :rocket:" >> $GITHUB_STEP_SUMMARY | |
| echo "-------------------------" >> $GITHUB_STEP_SUMMARY | |
| - name: Check imports with isort | |
| run: | | |
| # Show the diffs for debugging | |
| isort -c dasf/ | |
| if [[ $? -ne 0 ]] ; then | |
| echo "* **isort results:**" >> $GITHUB_STEP_SUMMARY | |
| echo "```diff" >> $GITHUB_STEP_SUMMARY | |
| isort -c --df dasf/ >> $GITHUB_STEP_SUMMARY | |
| echo "```" >> $GITHUB_STEP_SUMMARY | |
| exit 1 | |
| else | |
| echo "* **isort results:** :white_check_mark:" >> $GITHUB_STEP_SUMMARY | |
| exit 0 | |
| fi | |
| - name: Lint with flake8 | |
| run: | | |
| # stop the build if there are Python syntax errors or undefined names | |
| flake8 dasf/ --count --select=E9,F63,F7,F82 --show-source --statistics | |
| # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide | |
| flake8 dasf/ --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics | |
| if [[ $? -ne 0 ]] ; then | |
| echo "* **flake8 results:**" >> $GITHUB_STEP_SUMMARY | |
| echo "```python" >> $GITHUB_STEP_SUMMARY | |
| flake8 dasf/ --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics >> $GITHUB_STEP_SUMMARY | |
| echo "```" >> $GITHUB_STEP_SUMMARY | |
| exit 1 | |
| else | |
| echo "* **flake8 results:** :white_check_mark:" >> $GITHUB_STEP_SUMMARY | |
| exit 0 | |
| fi | |
| - name: Doc lint with interrogate | |
| run: | | |
| echo "* **interrogate results:** $(interrogate -i --fail-under=15 dasf/ | cut -d: -d" " -f4)" >> $GITHUB_STEP_SUMMARY | |
| # We should have at least 80% of docs covered | |
| interrogate -vv -i --fail-under=45 --badge-format svg -g . -e build/ -e tests/ | |
| test_cpu: | |
| runs-on: ubuntu-latest | |
| environment: continuous_test | |
| needs: [lint] | |
| container: | |
| image: docker.io/jcfaracco/dasf:cpu_ci | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Run test cases | |
| run: | | |
| pytest tests/ | |
| test_gpu: | |
| runs-on: ubuntu-latest | |
| environment: continuous_test | |
| needs: [lint] | |
| # Skip this test for PRs due to dangerous code submitted. | |
| if: ${{ github.event_name != 'pull_request' }} | |
| steps: | |
| - name: Checkout 🛎 | |
| uses: actions/checkout@master | |
| - name: Setup SSH | |
| run: | | |
| mkdir -p ~/.ssh/ | |
| echo "${{ secrets.CLUSTER_SSH_PRIV_KEY }}" > ~/.ssh/id_rsa | |
| echo "${{ secrets.CLUSTER_SSH_PUB_KEY }}" > ~/.ssh/id_rsa.pub | |
| chmod 600 ~/.ssh/id_rsa | |
| chmod 600 ~/.ssh/id_rsa.pub | |
| ssh-keyscan -H ${{ secrets.CLUSTER_ADDRESS }} >> ~/.ssh/known_hosts | |
| - name: Test SSH connection | |
| run: | | |
| ssh -T ${{ secrets.CLUSTER_USER }}@${{ secrets.CLUSTER_ADDRESS }} -p 8686 > /dev/null | |
| - name: Pull latest docker image | |
| run: | | |
| ssh ${{ secrets.CLUSTER_USER }}@${{ secrets.CLUSTER_ADDRESS }} -p 8686 "ssh ${{ secrets.CLUSTER_GPU_ID }} \"docker pull jcfaracco/dasf:gpu\"" | |
| - name: Run test cases remotely | |
| run: | | |
| ssh ${{ secrets.CLUSTER_USER }}@${{ secrets.CLUSTER_ADDRESS }} -p 8686 "ssh ${{ secrets.CLUSTER_GPU_ID }} \"docker run --rm --gpus all jcfaracco/dasf:gpu sh -c 'pip3 install pytest parameterized pytest-cov pip --upgrade && rm -rf dasf-core && git clone https://github.com/discovery-unicamp/dasf-core.git && cd dasf-core/ && pip3 uninstall dasf -y && pip3 install . && pytest --cov dasf/ tests/ && cd -'\"" |