Merge pull request #200 from RWTH-EBC/190-Warn-about-wrong-orion-version #291
This file contains hidden or 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: CI for FiLiP | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| branches: | |
| - master | |
| # Add permissions for contents to allow pushing to gh-pages | |
| permissions: | |
| contents: write | |
| jobs: | |
| setup: # This job will now handle both regular tests and the coverage run | |
| runs-on: ubuntu-latest | |
| environment: unittests # Environment for unit tests | |
| strategy: | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| include: | |
| # Add a specific entry for coverage. | |
| # This will run on Python 3.11 (or choose your preferred version). | |
| # It creates an additional job in the matrix strategy. | |
| - python-version: "3.10" | |
| run_coverage: true | |
| fail-fast: false # Ensure all setups run even if one fails | |
| steps: | |
| # Step 1: Checkout correct branch | |
| - name: Checkout Code | |
| uses: actions/checkout@v4 # Updated to v4 | |
| with: | |
| ref: ${{ github.ref }} | |
| # Step 2: Debug - Verify directory structure | |
| - name: Debug - Verify Repository Structure | |
| run: | | |
| pwd | |
| ls -la | |
| # Step 3: Set up Python | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| # Step 4: Create .env file | |
| - name: Create .env file | |
| run: | | |
| cat <<EOF > .env | |
| LOG_LEVEL="INFO" | |
| CB_URL=${{ vars.CB_URL }} # Using stored environment variable | |
| ORION_LD_URL=${{ vars.ORION_LD_URL }} | |
| IOTA_JSON_URL=${{ vars.IOTA_JSON_URL }} | |
| IOTA_UL_URL=${{ vars.IOTA_UL_URL }} | |
| QL_URL=${{ vars.QL_URL }} | |
| MQTT_BROKER_URL=${{ vars.MQTT_BROKER_URL }} | |
| MQTT_BROKER_URL_INTERNAL=${{ vars.MQTT_BROKER_URL_INTERNAL }} | |
| LD_MQTT_BROKER_URL=${{ vars.LD_MQTT_BROKER_URL }} | |
| LD_MQTT_BROKER_URL_INTERNAL=${{ vars.LD_MQTT_BROKER_URL_INTERNAL }} | |
| FIWARE_SERVICE=${{ vars.FIWARE_SERVICE }} | |
| FIWARE_SERVICEPATH=${{ vars.FIWARE_SERVICEPATH }} | |
| STATIC_RECORDS=${{ vars.STATIC_RECORDS }} | |
| EOF | |
| # Step 5: Verify .env file | |
| - name: Verify .env file | |
| run: cat .env | |
| # Step 6: Start FIWARE services | |
| - name: Start FIWARE Services | |
| run: | | |
| cd filip_unittest/docker # Navigate to docker compose directory | |
| docker compose up -d | |
| cd $GITHUB_WORKSPACE # IMPORTANT: Navigate back to workspace root | |
| # Step 7: Wait for FIWARE Services | |
| - name: Wait for FIWARE Services | |
| run: | | |
| echo "Waiting for FIWARE services..." | |
| for i in {1..30}; do | |
| # Using -f to fail on server errors, -s for silent | |
| (curl -sf http://localhost:1026/version) && \ | |
| (curl -sf http://localhost:1027/version) && \ | |
| (curl -sf http://localhost:4061/version) && \ | |
| (curl -sf http://localhost:4041/version) && \ | |
| (curl -sf http://localhost:8668/version) && \ | |
| echo "All services are up." && break | |
| echo "Attempt $i: Services not fully ready, sleeping 5s..." | |
| sleep 5 | |
| if [ $i -eq 30 ]; then | |
| echo "Timeout: FIWARE services did not start within 150 seconds." | |
| # Optional: print status of containers | |
| docker ps -a | |
| # Optional: print logs of containers if they are named predictably | |
| # docker logs <container_name_orion> | |
| exit 1 | |
| fi | |
| done | |
| # Step 8: Install dependencies | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install setuptools wheel | |
| pip install .[semantics] # Install current package | |
| pip install pytest | |
| if [[ "${{ matrix.run_coverage }}" == "true" ]]; then | |
| pip install coverage coverage-badge | |
| fi | |
| # Step 9: Debug - Show Running Docker Containers | |
| - name: Debug - Show Running Docker Containers | |
| run: docker ps -a | |
| # Step 10: Run Tests | |
| - name: Run tests | |
| run: | | |
| if [[ "${{ matrix.run_coverage }}" == "true" ]]; then | |
| echo "Running tests with coverage for Python ${{ matrix.python-version }}" | |
| # Using --source=. to focus coverage on your project's code | |
| coverage run --source=. -m pytest tests | |
| else | |
| echo "Running tests for Python ${{ matrix.python-version }}" | |
| python -m pytest tests | |
| fi | |
| continue-on-error: true | |
| # --- Steps for Coverage Reporting (only run if matrix.run_coverage is true) --- | |
| # Step 1: Generate the HTML report first | |
| - name: Generate HTML coverage report | |
| if: matrix.run_coverage | |
| run: coverage html -d coverage_html_report | |
| # Step 2: Generate the badge and place it *inside* the HTML report directory | |
| - name: Generate coverage badge | |
| if: matrix.run_coverage | |
| run: coverage-badge -o coverage_html_report/badge.svg | |
| # Step 3: Upload the combined report as a build artifact | |
| - name: Upload coverage report as artifact | |
| if: matrix.run_coverage | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-report-html-py${{ matrix.python-version }} | |
| path: coverage_html_report/ | |
| # * remove .gitignore if found | |
| - name: Remove .gitignore from coverage report | |
| if: matrix.run_coverage | |
| run: rm -f coverage_html_report/.gitignore | |
| continue-on-error: true | |
| # Step 4: Deploy the entire coverage_html_report folder to gh-pages | |
| - name: Deploy coverage report to gh-pages | |
| # This condition deploys only when running on the specified branch. | |
| if: ${{ matrix.run_coverage && github.ref == 'refs/heads/master' }} | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| personal_token: ${{ secrets.WORKFLOW_TOKEN }} | |
| publish_branch: gh-pages | |
| # The directory to publish. Its entire content will be deployed. | |
| publish_dir: ./coverage_html_report | |
| # The target directory on the gh-pages branch. | |
| destination_dir: docs/coverage | |
| # Keep this 'true' if you have other content on the gh-pages branch. | |
| # Set to 'false' if this report is the ONLY thing on the branch. | |
| keep_files: true | |
| user_name: 'github-actions[bot]' | |
| user_email: 'github-actions[bot]@users.noreply.github.com' | |
| commit_message: 'docs: Update coverage report and badge [CI]' |