Add more unit tests to increase coverage #1318
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
| name: Build and run all integrated tests (examples) | |
| on: | |
| push: | |
| branches: "*" | |
| pull_request: | |
| branches: "*" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }} | |
| cancel-in-progress: true | |
| jobs: | |
| build-runtime: | |
| strategy: | |
| matrix: | |
| enable_jit: | |
| - true | |
| - false | |
| container: | |
| - image: ubuntu-2204 | |
| name: ubuntu | |
| - image: fedora-39 | |
| name: fedora | |
| runs-on: ubuntu-22.04 | |
| container: | |
| image: "manjusakalza/bpftime-base-image:${{matrix.container.image}}" | |
| options: --privileged | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| submodules: 'recursive' | |
| - name: Install lcov (Ubuntu) | |
| if: ${{matrix.container.name=='ubuntu'}} | |
| run: | | |
| apt-get install -y lcov tree | |
| - name: Install lcov (Fedora) | |
| if: ${{matrix.container.name =='fedora'}} | |
| run: | | |
| dnf install -y lcov tree | |
| - name: Build and install runtime (with llvm-jit) | |
| if: ${{matrix.enable_jit}} | |
| run: | | |
| cmake -Bbuild -DCMAKE_BUILD_TYPE:STRING=RelWithDebInfo \ | |
| -DBPFTIME_LLVM_JIT=1 \ | |
| -DTEST_LCOV=YES \ | |
| -DBUILD_BPFTIME_DAEMON=1 \ | |
| -DCMAKE_CXX_FLAGS="-DDEFAULT_LOGGER_OUTPUT_PATH='\"console\"'" | |
| cmake --build build --config RelWithDebInfo --target install -j | |
| - name: Build and install runtime (without llvm-jit) | |
| if: ${{!matrix.enable_jit}} | |
| run: | | |
| cmake -Bbuild -DCMAKE_BUILD_TYPE:STRING=RelWithDebInfo \ | |
| -DBPFTIME_LLVM_JIT=0 \ | |
| -DTEST_LCOV=YES \ | |
| -DBUILD_BPFTIME_DAEMON=1 \ | |
| -DCMAKE_CXX_FLAGS="-DDEFAULT_LOGGER_OUTPUT_PATH='\"console\"'" | |
| cmake --build build --config RelWithDebInfo --target install -j | |
| - name: Build basic examples | |
| run: | | |
| make -C example -j | |
| - name: Package gcno files | |
| run: | | |
| find . -type f -name "*.gcno" | tar --create --gzip --file=gcno_files.tar.gz --files-from=- | |
| ls -la | |
| pwd | |
| tree . | |
| - name: Upload gcno file | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: gcno-files-${{matrix.enable_jit && 'jit' || 'no-jit'}}-${{matrix.container.name}} | |
| include-hidden-files: true | |
| path: | | |
| ./gcno_files.tar.gz | |
| - name: Upload build results (without jit) | |
| uses: actions/upload-artifact@v4 | |
| if: ${{!matrix.enable_jit}} | |
| with: | |
| name: runtime-package-no-jit-${{matrix.container.name}} | |
| include-hidden-files: true | |
| path: | | |
| ~/.bpftime | |
| - name: Upload build results (with jit) | |
| uses: actions/upload-artifact@v4 | |
| if: ${{matrix.enable_jit}} | |
| with: | |
| name: runtime-package-jit-${{matrix.container.name}} | |
| include-hidden-files: true | |
| path: | | |
| ~/.bpftime | |
| build-and-test: | |
| runs-on: ubuntu-22.04 | |
| needs: [build-runtime] | |
| container: | |
| image: "manjusakalza/bpftime-base-image:${{matrix.container.image}}" | |
| options: " ${{matrix.privilege_options.options}}" | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| exclude: | |
| - privilege_options: | |
| enable: false | |
| examples: | |
| syscall_trace: true | |
| - privilege_options: | |
| enable: false | |
| examples: | |
| path: tailcall_minimal | |
| - privilege_options: | |
| enable: false | |
| examples: | |
| path: malloc | |
| privilege_options: | |
| - options: "--privileged -v /sys/kernel/debug/:/sys/kernel/debug:rw -v /sys/kernel/tracing:/sys/kernel/tracing:rw" | |
| enable: true | |
| - options: "" | |
| enable: false | |
| container: | |
| - image: ubuntu-2204 | |
| name: ubuntu | |
| - image: fedora-39 | |
| name: fedora | |
| enable_jit: | |
| - true | |
| - false | |
| examples: | |
| - path: libbpf-tools/opensnoop | |
| executable: ./opensnoop | |
| victim: ./victim | |
| syscall_trace: true | |
| expected_str: " 0 test.txt" | |
| - path: libbpf-tools/statsnoop | |
| executable: ./statsnoop | |
| victim: ./victim | |
| syscall_trace: true | |
| expected_str: "victim 0 0 /sys" | |
| - path: malloc | |
| executable: ./malloc | |
| victim: ./victim | |
| syscall_trace: false | |
| expected_str: "malloc calls: " | |
| - path: minimal | |
| executable: ./uprobe | |
| victim: ./victim | |
| syscall_trace: false | |
| expected_str: "" | |
| - path: opensnoop | |
| executable: ./opensnoop | |
| victim: ./victim | |
| syscall_trace: true | |
| expected_str: " 0 test.txt" | |
| - path: sslsniff | |
| executable: ./sslsniff | |
| victim: /bin/wget https://www.google.com | |
| syscall_trace: false | |
| expected_str: "----- DATA -----" | |
| - path: libbpf-tools/bashreadline | |
| executable: ./readline | |
| victim: /bin/bash | |
| syscall_trace: false | |
| expected_str: "info" | |
| - path: libbpf-tools/syscount | |
| executable: ./syscount | |
| victim: /bin/bash | |
| syscall_trace: false | |
| expected_str: "info" | |
| - path: libbpf-tools/funclatency | |
| executable: ./funclatency -i 1 ./victim:plus | |
| victim: ./victim | |
| syscall_trace: false | |
| expected_str: "|*" | |
| - path: libbpf-tools/mountsnoop | |
| executable: ./mountsnoop | |
| victim: ./victim | |
| syscall_trace: true | |
| expected_str: mount( | |
| - path: libbpf-tools/sigsnoop | |
| executable: ./sigsnoop | |
| victim: ./victim | |
| syscall_trace: true | |
| expected_str: "victim 0 -1 0" | |
| - path: tailcall_minimal | |
| executable: ./tailcall_minimal | |
| victim: ./victim | |
| syscall_trace: false | |
| expected_str: "See /sys/kernel/debug/tracing/trace_pipe for output (15)" | |
| - path: usdt_minimal | |
| executable: ./usdt_minimal | |
| victim: ./victim | |
| syscall_trace: false | |
| expected_str: "bpf:" | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| submodules: 'recursive' | |
| - name: Download prebuilt runtime (with jit) | |
| if: ${{matrix.enable_jit}} | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: runtime-package-jit-${{matrix.container.name}} | |
| path: ~/.bpftime | |
| - name: Download prebuilt runtime (without jit) | |
| if: ${{!matrix.enable_jit}} | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: runtime-package-no-jit-${{matrix.container.name}} | |
| path: ~/.bpftime | |
| - name: Download gcno files | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: gcno-files-${{matrix.enable_jit && 'jit' || 'no-jit'}}-${{matrix.container.name}} | |
| path: . | |
| - name: Extract gcno files | |
| run: | | |
| ls -lah . | |
| tar -zxvf gcno_files.tar.gz | |
| pwd | |
| - name: Install which(required by funclatency on fedora) | |
| if: ${{matrix.container.name=='fedora' && matrix.examples.path=='libbpf-tools/funclatency'}} | |
| run: | | |
| yum install -y which | |
| - name: Set permissions | |
| run: | | |
| chmod +x ~/.bpftime/* | |
| - name: Show downloaded artifacts | |
| run: | | |
| ls ~/.bpftime | |
| - uses: actions/checkout@v2 | |
| with: | |
| submodules: 'recursive' | |
| - name: Build test assets | |
| run: | | |
| make -C example/${{matrix.examples.path}} -j | |
| - name: Test CLI - show help | |
| run: | | |
| export PATH=$PATH:~/.bpftime | |
| bpftime --help | |
| - name: Test CLI - attach by running (syscall_trace) | |
| if: matrix.examples.syscall_trace | |
| shell: bash | |
| run: | | |
| ROOT=$(pwd) | |
| cd example/${{matrix.examples.path}} | |
| python3 $ROOT/.github/script/run_example.py "${{matrix.examples.executable}}" "${{matrix.examples.victim}}" "${{matrix.examples.expected_str}}" "/github/home/.bpftime/bpftime -i /github/home/.bpftime" 1 | |
| - name: Test CLI - attach by running (uprobe) | |
| if: '!matrix.examples.syscall_trace' | |
| shell: bash | |
| run: | | |
| ROOT=$(pwd) | |
| cd example/${{matrix.examples.path}} | |
| python3 $ROOT/.github/script/run_example.py "${{matrix.examples.executable}}" "${{matrix.examples.victim}}" "${{matrix.examples.expected_str}}" "/github/home/.bpftime/bpftime -i /github/home/.bpftime" 0 | |
| - name: Generate example coverage (Ubuntu) | |
| if: "matrix.container.image == 'ubuntu-2204'" | |
| run: | | |
| apt-get install -y gpg lcov | |
| lcov --capture --directory . --directory .github --directory /github/home/.bpftime --output-file coverage-example.info --gcov-tool $(which gcov-12) | |
| lcov --remove coverage-example.info '/usr/*' --output-file coverage-example.info | |
| lcov --list coverage-example.info | |
| - name: Generate example coverage (Fedora) | |
| if: "matrix.container.image == 'fedora-39'" | |
| run: | | |
| dnf install -y lcov | |
| lcov --capture --directory . --directory .github --directory /github/home/.bpftime --output-file coverage-example.info | |
| lcov --remove coverage-example.info '/usr/*' --output-file coverage-example.info | |
| lcov --list coverage-example.info | |
| - name: Upload example coverage | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-example-${{matrix.container.name}}-${{matrix.enable_jit}}-${{matrix.examples.path}} | |
| include-hidden-files: false | |
| path: | | |
| ./coverage-example.info | |
| - uses: codecov/codecov-action@v4 | |
| with: | |
| fail_ci_if_error: true # optional (default = false) | |
| files: ./coverage-example.info | |
| flags: coverage-example-${{matrix.container.name}}-${{matrix.enable_jit}}-${{matrix.examples.path}} | |
| token: ${{ secrets.CODECOV_TOKEN }} # required | |
| verbose: true # optional (default = false) | |
| - name: Setup tmate session | |
| # Setup SSH when manually triggered and failing, so we can debug CI more conveniently | |
| if: "${{ failure() && github.event_name == 'workflow_dispatch' }}" | |
| uses: mxschmitt/action-tmate@v3 | |
| with: | |
| limit-access-to-actor: true |