docs framing_sv2
#3029
Workflow file for this run
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
| # Performs test coverage of project's libraries using cargo-tarpaulin and the message-generator, | |
| # and generates results using codecov.io. | |
| # The following flags are set inside `tarpaulin.toml`: | |
| # `features = "..."`: Includes the code with the listed features. The following features result in a | |
| # tarpaulin error and are NOT included: derive, alloc, arbitrary-derive, attributes, and | |
| # with_serde | |
| # `run-types = [ "Lib" ]`: Only tests the package's library unit tests. Includes protocols, and utils (without the | |
| # exclude-files flag, it includes this example because it contains a lib.rs file) | |
| # `exclude-files = [ "examples/*" ]`: Excludes all projects in examples directory (specifically added to | |
| # ignore examples that that contain a lib.rs file like interop-cpp) | |
| # `timeout = "120s"`: If unresponsive for 120 seconds, action will fail | |
| # `fail-under = 20`: If code coverage is less than 20%, action will fail | |
| # `out = ["Xml"]`: Required for codecov.io to generate coverage result | |
| # All message-generator test flags are in tests in test/message-generator/test | |
| # This test loops through every test in test/message-generator/test, and runs each one, collecting | |
| # code coverage data for anything in the roles/ directory that is relevant to SV2(pool, mining-proxy) | |
| name: Test Coverage | |
| on: | |
| push: | |
| branches: [ main, dev ] | |
| pull_request: | |
| branches: [ main, dev ] | |
| jobs: | |
| tarpaulin-test: | |
| name: Tarpaulin Test | |
| runs-on: ubuntu-latest | |
| container: | |
| image: xd009642/tarpaulin:0.27.1-nightly | |
| options: --security-opt seccomp=unconfined | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Generate code coverage | |
| run: | | |
| ./tarpaulin.sh | |
| - name: Archive Tarpaulin code coverage results | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: tarpaulin-report | |
| path: | | |
| protocols/cobertura.xml | |
| roles/cobertura.xml | |
| utils/cobertura.xml | |
| message-generator-test: | |
| needs: tarpaulin-test | |
| name: MG Test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: 1.75.0 | |
| override: true | |
| components: llvm-tools-preview | |
| - name: Log data from rustc | |
| run: rustc -Vv | |
| - name: Install cargo-llvm-cov | |
| uses: taiki-e/install-action@cargo-llvm-cov | |
| - name: Pre build everything | |
| run: | | |
| cargo build --manifest-path=benches/Cargo.toml | |
| cargo build --manifest-path=common/Cargo.toml | |
| cargo build --manifest-path=protocols/Cargo.toml | |
| cargo build --manifest-path=roles/Cargo.toml | |
| cargo build --manifest-path=utils/Cargo.toml | |
| - name: Run message generator tests | |
| run: sh ./message-generator-tests.sh | |
| - name: Archive MG code coverage results | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: coverage-report | |
| path: 'target/*.xml' | |
| - name: Archive log files | |
| if: always() | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: logs | |
| path: './utils/message-generator/*.log' | |
| # codecov: | |
| # needs: message-generator-test | |
| # name: Codecov Upload | |
| # runs-on: ubuntu-latest | |
| # steps: | |
| # - name: Checkout repository | |
| # uses: actions/checkout@v3 | |
| # - name: Download all workflow run artifacts | |
| # uses: actions/download-artifact@v3 | |
| # - name: Display structure of downloaded files | |
| # run: ls -R | |
| # - name: Upload to codecov.io | |
| # uses: codecov/codecov-action@v3 | |
| # with: | |
| # files: coverage-report/*.xml, tarpaulin-report/*.xml | |
| # fail_ci_if_error: true | |
| # token: ${{ secrets.CODECOV_TOKEN }} |