Rewrite Storage Component in C++ #1384
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: linting-and-tests | |
| on: [pull_request] | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| jobs: | |
| flake8: | |
| timeout-minutes: 40 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - name: Setup mamba | |
| uses: ./.github/actions/mamba | |
| - name: Flake8 | |
| run: | | |
| micromamba run -n modyn flake8 --version | |
| micromamba run -n modyn flake8 modyn --statistics | |
| mypy-typechecking: | |
| timeout-minutes: 20 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - name: Setup mamba | |
| uses: ./.github/actions/mamba | |
| - name: Mypy | |
| run: | | |
| micromamba run -n modyn mypy --version | |
| micromamba run -n modyn mypy modyn | |
| pylint: | |
| timeout-minutes: 20 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - name: Setup mamba | |
| uses: ./.github/actions/mamba | |
| - name: Pylint | |
| run: | | |
| micromamba run -n modyn pylint --version | |
| micromamba run -n modyn pylint modyn | |
| isort: | |
| timeout-minutes: 20 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - name: Setup mamba | |
| uses: ./.github/actions/mamba | |
| - name: Isort | |
| run: | | |
| micromamba run -n modyn isort --version | |
| micromamba run -n modyn isort modyn --check --diff | |
| micromamba run -n modyn isort integrationtests --check --diff | |
| micromamba run -n modyn isort benchmark --check --diff | |
| black: | |
| timeout-minutes: 20 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - name: Setup mamba | |
| uses: ./.github/actions/mamba | |
| - name: Black | |
| run: | | |
| micromamba run -n modyn black --version | |
| micromamba run -n modyn black --check modyn --verbose --config black.toml | |
| unittests: | |
| timeout-minutes: 20 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - name: Setup mamba | |
| uses: ./.github/actions/mamba | |
| - name: Pytest | |
| run: | | |
| micromamba run -n modyn pytest modyn --cov-reset --cache-clear --cov-fail-under=90 | |
| micromamba run -n modyn pytest > pytest-coverage.txt | |
| - name: Comment coverage | |
| uses: coroo/[email protected] | |
| format: | |
| timeout-minutes: 20 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: DoozyX/[email protected] | |
| with: | |
| source: 'modyn/storage/src modyn/storage/include modyn/storage/test' | |
| extensions: 'hpp,cpp' | |
| clangFormatVersion: 16 | |
| tidy: | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-latest | |
| env: | |
| CLANG_TIDY: clang-tidy-15 | |
| RUN_CLANG_TIDY: run-clang-tidy-15 | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Install clang-tidy | |
| run: | | |
| sudo apt update | |
| sudo apt install -y clang-tidy-15 | |
| cmake --version | |
| - name: Configure CMake | |
| working-directory: ${{github.workspace}}/modyn/storage | |
| run: bash scripts/clang-tidy.sh build | |
| - name: Run clang-tidy | |
| working-directory: ${{github.workspace}}/modyn/storage | |
| run: bash scripts/clang-tidy.sh run_tidy | |
| cpp_build_and_test: | |
| name: Build + Test (C++) | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 45 | |
| outputs: | |
| line-coverage: ${{steps.run_test_with_coverage.outputs.LINE_COVERAGE}} | |
| branch-coverage: ${{steps.run_test_with_coverage.outputs.BRANCH_COVERAGE}} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| build-type: [ Release, Debug ] | |
| compiler: | |
| - { c: gcc, cxx: g++, version: 11 } | |
| - { c: gcc, cxx: g++, version: 12 } | |
| - { c: clang, cxx: clang++, version: 14 } | |
| - { c: clang, cxx: clang++, version: 16, coverage: true } | |
| include: | |
| # Currently, there is a linking error with zlib if we use clang 16 for sanitizers | |
| # Let's investigate this when clang 16 is os default - one problem could be the external clang installation | |
| - compiler: {c: clang, cxx: clang++, version: 14} | |
| build-type: Tsan | |
| - compiler: {c: clang, cxx: clang++, version: 14} | |
| build-type: Asan | |
| env: | |
| CC: ${{matrix.compiler.c}}-${{matrix.compiler.version}} | |
| CXX: ${{matrix.compiler.cxx}}-${{matrix.compiler.version}} | |
| CCACHE_BASEDIR: ${{github.workspace}}/modyn/storage | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Install ccache | |
| run: | | |
| sudo apt update | |
| sudo apt install -y ccache | |
| - name: Install clang version | |
| if: ${{ matrix.compiler.version > 14 }} | |
| uses: KyleMayes/install-llvm-action@v1 | |
| with: | |
| version: ${{ matrix.compiler.version }}.0 | |
| env: true | |
| - name: Create Build Environment | |
| run: cmake -E make_directory ${{github.workspace}}/modyn/storage/build | |
| - name: Configure CMake | |
| shell: bash | |
| working-directory: ${{github.workspace}}/modyn/storage/build | |
| # fdebug-prefix-map is for ccache to not have absolute paths interfere with caching, see https://ccache.dev/manual/3.6.html#_compiling_in_different_directories | |
| run: > | |
| cmake ${{github.workspace}}/modyn/storage | |
| -DCMAKE_BUILD_TYPE=${{matrix.build-type}} | |
| -DCMAKE_CXX_COMPILER_LAUNCHER=ccache | |
| -DCMAKE_CXX_FLAGS="-fdebug-prefix-map=${{github.workspace}}/build=." | |
| -DMODYNSTORAGE_BUILD_PLAYGROUND=ON | |
| -DMODYNSTORAGE_BUILD_TESTS=ON | |
| -DMODYNSTORAGE_TEST_COVERAGE=${{matrix.compiler.coverage && 'ON' || 'OFF'}} | |
| - name: Build | |
| working-directory: ${{github.workspace}}/modyn/storage/build | |
| shell: bash | |
| run: cmake --build . --target modynstorage modynstorage-test modyn-storage playground --config ${{matrix.build-type}} -- -j8 | |
| - name: Run tests | |
| timeout-minutes: 20 | |
| working-directory: ${{github.workspace}}/modyn/storage/build/test | |
| shell: bash | |
| env: {"TSAN_OPTIONS": "halt_on_error=1", "UBSAN_OPTIONS": "print_stacktrace=1:halt_on_error=1"} | |
| run: ./modynstorage-test | |
| # The next two steps are solely related to creating coverage reports and will only run coverage in the compiler matrix is set to true | |
| - name: Create Coverage Report | |
| if: ${{ matrix.compiler.coverage && matrix.build-type == 'Debug' }} | |
| working-directory: ${{github.workspace}}/modyn/storage/build/test | |
| run: | | |
| llvm-profdata-14 merge -sparse default.profraw -o tests.profdata | |
| llvm-cov-14 report -instr-profile tests.profdata -object modynstorage-test -ignore-filename-regex="build\/" -ignore-filename-regex="\/test\/" -show-region-summary=false | tail -1 | sed 's/%//g' | tr -s " " > output.txt | |
| llvm-cov-14 show -instr-profile tests.profdata -object modynstorage-test -format=html -output-dir=coverage -ignore-filename-regex="build\/" -ignore-filename-regex="\/test\/" -show-region-summary=false | |
| echo ::set-output name=LINE_COVERAGE::"$(cat output.txt | cut -d ' ' -f 7)" | |
| echo ::set-output name=BRANCH_COVERAGE::"$(cat output.txt | cut -d ' ' -f 10)" | |
| id: run_test_with_coverage | |
| - name: Upload HTML coverage report | |
| if: ${{ matrix.compiler.coverage && matrix.build-type == 'Debug' }} | |
| uses: actions/upload-artifact@v2 | |
| with: | |
| name: coverage-results | |
| path: ${{github.workspace}}/modyn/storage/build/test/coverage | |
| cpp_coverage_main: | |
| name: C++ Test Coverage (gets coverage of main branch, currently not main branch because no C++ on main) | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 45 | |
| env: | |
| CC: clang-16 | |
| CXX: clang++-16 | |
| outputs: | |
| line-coverage: ${{steps.run_main_test_with_coverage.outputs.LINE_COVERAGE}} | |
| branch-coverage: ${{steps.run_main_test_with_coverage.outputs.BRANCH_COVERAGE}} | |
| steps: | |
| - uses: actions/checkout@v2 | |
| #with: TODO(MaxiBoether): add after merge. | |
| # ref: main | |
| - name: Install clang 16 | |
| uses: KyleMayes/install-llvm-action@v1 | |
| with: | |
| version: 16.0 | |
| env: true | |
| - name: Create Build Environment | |
| run: | | |
| cmake -E make_directory ${{github.workspace}}/modyn/storage/build | |
| - name: Configure CMake | |
| shell: bash | |
| working-directory: ${{github.workspace}}/modyn/storage/build | |
| run: > | |
| cmake ${{github.workspace}}/modyn/storage -DCMAKE_BUILD_TYPE=Debug | |
| -DMODYNSTORAGE_BUILD_PLAYGROUND=ON -DMODYNSTORAGE_BUILD_TESTS=ON -DMODYNSTORAGE_TEST_COVERAGE=ON | |
| - name: Build | |
| working-directory: ${{github.workspace}}/modyn/storage/build | |
| shell: bash | |
| run: cmake --build . --config Debug --target modynstorage modynstorage-test -- -j8 | |
| - name: Run tests | |
| working-directory: ${{github.workspace}}/modyn/storage/build/test | |
| shell: bash | |
| run: ./modynstorage-test | |
| - name: Create Coverage Report for main branch | |
| working-directory: ${{github.workspace}}/modyn/storage/build/test | |
| run: | | |
| llvm-profdata-14 merge -sparse default.profraw -o tests.profdata | |
| llvm-cov-14 report -instr-profile tests.profdata -object modynstorage-test -ignore-filename-regex="build\/" -ignore-filename-regex="\/test\/" -show-region-summary=false | tail -1 | sed 's/%//g' | tr -s " " > output.txt | |
| echo ::set-output name=LINE_COVERAGE::"$(cat output.txt | cut -d ' ' -f 7)" | |
| echo ::set-output name=BRANCH_COVERAGE::"$(cat output.txt | cut -d ' ' -f 10)" | |
| id: run_main_test_with_coverage | |
| cpp_comment_on_pr: | |
| if: github.event.pull_request.head.repo.full_name == github.repository | |
| runs-on: self-hosted | |
| name: Comment Coverage Results | |
| needs: [ cpp_build_and_test, cpp_coverage_main ] | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Calculate changes | |
| shell: bash | |
| run: | | |
| echo ::set-output name=line-changes::"$(awk 'BEGIN {printf "%+.2f", ${{ needs.cpp_build_and_test.outputs.line-coverage }}-${{ needs.cpp_coverage_main.outputs.line-coverage }}; exit}')" | |
| echo ::set-output name=branch-changes::"$(awk 'BEGIN {printf "%+.2f", ${{ needs.cpp_build_and_test.outputs.branch-coverage }}-${{ needs.cpp_coverage_main.outputs.branch-coverage }}; exit}')" | |
| id: calculation | |
| - name: Comment on PR | |
| uses: marocchino/sticky-pull-request-comment@v2 | |
| with: | |
| message: | | |
|  <sup>(${{ steps.calculation.outputs.line-changes }} % to main)</sup> | |
|  <sup>(${{ steps.calculation.outputs.branch-changes }} % to main)</sup> | |
| ### Integration Tests ### | |
| # We have them in the same workflow because it's impossible to have a simple "if workflow A runs through completely, then workflow B should run" pipeline on Github currently | |
| # Checks whether the base container works correctly. | |
| dockerized-unittests: | |
| timeout-minutes: 60 | |
| runs-on: ubuntu-latest | |
| needs: | |
| - flake8 | |
| - mypy-typechecking | |
| - pylint | |
| - unittests | |
| - isort | |
| - black | |
| - cpp_build_and_test | |
| - tidy | |
| - format | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - name: Setup base container | |
| uses: ./.github/actions/base | |
| - name: Setup dev-requirements and run pytest within container | |
| run: docker run modynbase mamba run -n modyn bash -c "pip install -r dev-requirements.txt && echo Running pytest && pytest" | |
| # Tests whether docker-compose up starts all components successfully and integration tests run through | |
| # Only one job to reduce Github CI usage | |
| integrationtests: | |
| timeout-minutes: 60 | |
| runs-on: ubuntu-latest | |
| needs: | |
| - flake8 | |
| - mypy-typechecking | |
| - pylint | |
| - unittests | |
| - isort | |
| - black | |
| - dockerized-unittests | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - name: Start docker compose and exit when tests run through | |
| run: bash run_integrationtests.sh |