disable ./x test for now #1901
Workflow file for this run
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: Kani | |
| on: | |
| workflow_dispatch: | |
| merge_group: | |
| pull_request: | |
| branches: [ main ] | |
| push: | |
| paths: | |
| - 'library/**' | |
| - '.github/workflows/kani.yml' | |
| - 'scripts/run-kani.sh' | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| check-kani-on-std: | |
| name: Verify std library (partition ${{ matrix.partition }}) | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| partition: [1, 2, 3, 4] | |
| include: | |
| - os: ubuntu-latest | |
| base: ubuntu | |
| - os: macos-latest | |
| base: macos | |
| fail-fast: false | |
| env: | |
| # Define the index of this particular worker [1-WORKER_TOTAL] | |
| WORKER_INDEX: ${{ matrix.partition }} | |
| # Total number of workers running this step | |
| WORKER_TOTAL: 4 | |
| steps: | |
| - name: Remove unnecessary software to free up disk space | |
| if: matrix.os == 'ubuntu-latest' | |
| run: | | |
| # inspired by https://github.com/easimon/maximize-build-space/blob/master/action.yml | |
| df -h | |
| sudo rm -rf /usr/share/dotnet /usr/local/lib/android /usr/local/.ghcup | |
| df -h | |
| # Step 1: Check out the repository | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| with: | |
| path: head | |
| submodules: true | |
| - name: Apply stdarch patch | |
| run: cd head/library/stdarch && patch -p1 < ../../stdarch.patch | |
| # Step 2: Install jq | |
| - name: Install jq | |
| if: matrix.os == 'ubuntu-latest' | |
| run: sudo apt-get install -y jq | |
| # Step 3: Run Kani on the std library (default configuration) | |
| - name: Run Kani Verification | |
| run: head/scripts/run-kani.sh --path ${{github.workspace}}/head | |
| kani_autoharness: | |
| name: Verify std library using autoharness | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| include: | |
| - os: ubuntu-latest | |
| base: ubuntu | |
| - os: macos-latest | |
| base: macos | |
| fail-fast: false | |
| steps: | |
| - name: Remove unnecessary software to free up disk space | |
| if: matrix.os == 'ubuntu-latest' | |
| run: | | |
| # inspired by https://github.com/easimon/maximize-build-space/blob/master/action.yml | |
| df -h | |
| sudo rm -rf /usr/share/dotnet /usr/local/lib/android /usr/local/.ghcup | |
| df -h | |
| # Step 1: Check out the repository | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Apply stdarch patch | |
| run: cd library/stdarch && patch -p1 < ../../stdarch.patch | |
| # Step 2: Run Kani autoharness on the std library for selected functions. | |
| # Uses "--include-pattern" to make sure we do not try to run across all | |
| # possible functions as that may take a lot longer than expected. Instead, | |
| # explicitly list all functions (or prefixes thereof) the proofs of which | |
| # are known to pass. | |
| # Notes: | |
| # - We use >::disjoint_bitor (and >::unchecked_disjoint_bitor) as pattern | |
| # as whitespace is not supported, cf. | |
| # https://github.com/model-checking/kani/issues/4046 | |
| # - core_arch::x86::__m128d::as_f64x2 is just one example of hundreds of | |
| # core_arch::x86:: functions that are known to verify successfully. | |
| - name: Run Kani Verification | |
| run: | | |
| scripts/run-kani.sh --run autoharness --kani-args \ | |
| --include-pattern ">::disjoint_bitor" \ | |
| --include-pattern ">::unchecked_disjoint_bitor" \ | |
| --include-pattern alloc::__default_lib_allocator:: \ | |
| --include-pattern alloc::layout::Layout::from_size_align \ | |
| --include-pattern ascii::ascii_char::AsciiChar::from_u8 \ | |
| --include-pattern char::convert::from_u32_unchecked \ | |
| --include-pattern core_arch::x86::__m128d::as_f64x2 \ | |
| --include-pattern "num::nonzero::NonZero::<i8>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<i16>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<i32>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<i64>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<i128>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<isize>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<u8>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<u16>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<u32>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<u64>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<u128>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<usize>::count_ones" \ | |
| --include-pattern "num::nonzero::NonZero::<i8>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<i16>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<i32>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<i64>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<i128>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<isize>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<u8>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<u16>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<u32>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<u64>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<u128>::rotate_" \ | |
| --include-pattern "num::nonzero::NonZero::<usize>::rotate_" \ | |
| --include-pattern ptr::align_offset::mod_inv \ | |
| --include-pattern ptr::alignment::Alignment::as_nonzero \ | |
| --include-pattern ptr::alignment::Alignment::as_usize \ | |
| --include-pattern ptr::alignment::Alignment::log2 \ | |
| --include-pattern ptr::alignment::Alignment::mask \ | |
| --include-pattern ptr::alignment::Alignment::new \ | |
| --include-pattern ptr::alignment::Alignment::new_unchecked \ | |
| --include-pattern time::Duration::from_micros \ | |
| --include-pattern time::Duration::from_millis \ | |
| --include-pattern time::Duration::from_nanos \ | |
| --include-pattern time::Duration::from_secs \ | |
| --exclude-pattern time::Duration::from_secs_f \ | |
| --include-pattern unicode::unicode_data::conversions::to_ \ | |
| --exclude-pattern ::precondition_check \ | |
| --harness-timeout 10m \ | |
| --default-unwind 1000 \ | |
| --jobs=3 --output-format=terse | tee autoharness-verification.log | |
| gzip autoharness-verification.log | |
| - name: Upload Autoharness Verification Log | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ matrix.os }}-autoharness-verification.log.gz | |
| path: autoharness-verification.log.gz | |
| if-no-files-found: error | |
| # Aggressively short retention: we don't really need these | |
| retention-days: 3 | |
| run_kani_metrics: | |
| name: Kani Metrics | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| include: | |
| - os: ubuntu-latest | |
| base: ubuntu | |
| - os: macos-latest | |
| base: macos | |
| fail-fast: true | |
| steps: | |
| - name: Remove unnecessary software to free up disk space | |
| if: matrix.os == 'ubuntu-latest' | |
| run: | | |
| # inspired by https://github.com/easimon/maximize-build-space/blob/master/action.yml | |
| df -h | |
| sudo rm -rf /usr/share/dotnet /usr/local/lib/android /usr/local/.ghcup | |
| df -h | |
| # Step 1: Check out the repository | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| # The Kani metrics collection uses a Python script (kani_std_analysis.py), so make sure Python is installed | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.x' | |
| # Step 2: Run list on the std library | |
| - name: Run Kani Metrics | |
| run: | | |
| scripts/run-kani.sh --run metrics --with-autoharness | |
| pushd /tmp/std_lib_analysis | |
| tar czf results.tar.gz results | |
| popd | |
| - name: Upload kani-list.json | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ matrix.os }}-kani-list.json | |
| path: kani-list.json | |
| if-no-files-found: error | |
| # Aggressively short retention: we don't really need these | |
| retention-days: 3 | |
| - name: Upload scanner results | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ matrix.os }}-results.tar.gz | |
| path: /tmp/std_lib_analysis/results.tar.gz | |
| if-no-files-found: error | |
| # Aggressively short retention: we don't really need these | |
| retention-days: 3 | |
| run-log-analysis: | |
| name: Build JSON from logs | |
| needs: [run_kani_metrics, kani_autoharness] | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| include: | |
| - os: ubuntu-latest | |
| base: ubuntu | |
| - os: macos-latest | |
| base: macos | |
| fail-fast: false | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: false | |
| - name: Download log | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: ${{ matrix.os }}-autoharness-verification.log.gz | |
| - name: Download kani-list.json | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: ${{ matrix.os }}-kani-list.json | |
| - name: Download scanner results | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: ${{ matrix.os }}-results.tar.gz | |
| - name: Run log parser | |
| run: | | |
| gunzip autoharness-verification.log.gz | |
| tar xzf results.tar.gz | |
| python3 scripts/kani-std-analysis/log_parser.py \ | |
| --kani-list-file kani-list.json \ | |
| --analysis-results-dir results/ \ | |
| autoharness-verification.log \ | |
| -o results.json | |
| - name: Upload JSON | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ matrix.os }}-results.json | |
| path: results.json | |
| if-no-files-found: error | |
| run-kani-list: | |
| name: Kani List | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Step 1: Check out the repository | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| with: | |
| path: head | |
| submodules: true | |
| - name: Apply stdarch patch | |
| run: cd head/library/stdarch && patch -p1 < ../../stdarch.patch | |
| # Step 2: Run list on the std library | |
| - name: Run Kani List | |
| run: | | |
| head/scripts/run-kani.sh --run list --with-autoharness --path ${{github.workspace}}/head | |
| # remove duplicate white space to reduce file size (GitHub permits at | |
| # most one 1MB) | |
| ls -l ${{github.workspace}}/head/kani-list.md | |
| perl -p -i -e 's/ +/ /g' ${{github.workspace}}/head/kani-list.md | |
| ls -l ${{github.workspace}}/head/kani-list.md | |
| # Step 3: Add output to job summary | |
| - name: Add Kani List output to job summary | |
| uses: actions/github-script@v6 | |
| with: | |
| script: | | |
| const fs = require('fs'); | |
| const kaniOutput = fs.readFileSync('${{github.workspace}}/head/kani-list.md', 'utf8'); | |
| await core.summary | |
| .addHeading('Kani List Output', 2) | |
| .addRaw(kaniOutput, false) | |
| .write(); | |
| run-autoharness-analyzer: | |
| name: Kani Autoharness Analyzer | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Step 1: Check out the repository | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Apply stdarch patch | |
| run: cd library/stdarch && patch -p1 < ../../stdarch.patch | |
| # Step 2: Run autoharness analyzer on the std library | |
| - name: Run Autoharness Analyzer | |
| run: scripts/run-kani.sh --run autoharness-analyzer | |
| # Step 3: Add output to job summary | |
| - name: Add Autoharness Analyzer output to job summary | |
| run: | | |
| pushd scripts/autoharness_analyzer | |
| echo "# Autoharness Failure Summary" >> "$GITHUB_STEP_SUMMARY" | |
| echo "## Crate core, all functions" >> "$GITHUB_STEP_SUMMARY" | |
| cat core_autoharness_data.md >> "$GITHUB_STEP_SUMMARY" | |
| echo "## Crate core, unsafe functions" >> "$GITHUB_STEP_SUMMARY" | |
| cat core_autoharness_data.md >> "$GITHUB_STEP_SUMMARY" | |
| echo "## Crate std, all functions" >> "$GITHUB_STEP_SUMMARY" | |
| cat std_autoharness_data.md >> "$GITHUB_STEP_SUMMARY" | |
| echo "## Crate std, unsafe functions" >> "$GITHUB_STEP_SUMMARY" | |
| cat std_unsafe_autoharness_data.md >> "$GITHUB_STEP_SUMMARY" | |
| popd |