Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add script to automate build & running kani #78

Merged
merged 31 commits into from
Oct 23, 2024

Conversation

jaisnan
Copy link

@jaisnan jaisnan commented Sep 6, 2024

  1. Adds a one-click command to pull, build and run kani
  2. Adds a toml file to store the commit info about the HEAD of kani/features/verify-std
  3. Checks for caching to prevent re-pulling, and building already compatible kani binary
  4. Modifies CI to re-use this script instead of the previous script
  5. Add --kani-args to pass arguments to kani command. -p sets the working directory.
  6. Adds a CI job to test the entrypoint workflow itself.
  7. Default output-format to terse

Extras

Cleans up some print statements in the run_update_with_checks script.

Call-out

  1. This does not allow command configuration, so it essentially all proofs in the library by default, which CAN get expensive. I can very easily add a harness filter to ensure that we can process only relevent harnesses.
  2. Need to change documentation to use this command instead of using kani directly as is currently suggested.
  3. Need to consider move to python, argument parsing with bash is a bad experience.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

@jaisnan jaisnan requested a review from a team as a code owner September 6, 2024 19:11
@jaisnan jaisnan changed the title Add script to automate build Add script to automate build & running kani Sep 6, 2024
Copy link

@celinval celinval left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Jai

run-kani.sh Outdated Show resolved Hide resolved
.github/workflows/check_entrypoint.yml Outdated Show resolved Hide resolved
kani-version.toml Outdated Show resolved Hide resolved
run-kani.sh Outdated Show resolved Hide resolved
run-kani.sh Outdated Show resolved Hide resolved
@jaisnan jaisnan force-pushed the add-script-to-automate-build branch from 5ba1b85 to c18d6d5 Compare September 10, 2024 15:34
@jaisnan jaisnan requested a review from celinval September 10, 2024 17:00
.github/workflows/kani.yml Outdated Show resolved Hide resolved
.github/workflows/kani.yml Outdated Show resolved Hide resolved
.github/workflows/kani.yml Outdated Show resolved Hide resolved
.github/workflows/kani.yml Outdated Show resolved Hide resolved
.github/workflows/kani.yml Outdated Show resolved Hide resolved
scripts/run-kani.sh Outdated Show resolved Hide resolved
scripts/run-kani.sh Show resolved Hide resolved
scripts/run-kani.sh Outdated Show resolved Hide resolved
scripts/run-kani.sh Outdated Show resolved Hide resolved
scripts/run-kani.sh Outdated Show resolved Hide resolved
Co-authored-by: Michael Tautschnig <mt@debian.org>
.github/workflows/kani.yml Outdated Show resolved Hide resolved
.github/workflows/kani.yml Show resolved Hide resolved
@feliperodri feliperodri added the Maintenance Maintenance related issues for the challange label Oct 8, 2024
@jaisnan jaisnan requested a review from celinval October 22, 2024 20:41
Copy link

@celinval celinval left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Jai!

@jaisnan jaisnan merged commit 61f68cf into model-checking:main Oct 23, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance Maintenance related issues for the challange
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants