diff --git a/.cargo/config b/.cargo/config index 5823356..50df778 100644 --- a/.cargo/config +++ b/.cargo/config @@ -7,7 +7,6 @@ xclippy = [ "clippy", "--all-targets", "--", "-Wclippy::all", - "-Wclippy::match_same_arms", "-Wclippy::cast_lossless", "-Wclippy::checked_conversions", "-Wclippy::dbg_macro", @@ -15,16 +14,31 @@ xclippy = [ "-Wclippy::derive_partial_eq_without_eq", "-Wclippy::filter_map_next", "-Wclippy::flat_map_option", + "-Wclippy::from_iter_instead_of_collect", "-Wclippy::inefficient_to_string", + "-Wclippy::large_stack_arrays", "-Wclippy::large_types_passed_by_value", + "-Wclippy::macro_use_imports", "-Wclippy::manual_assert", "-Wclippy::manual_ok_or", "-Wclippy::map_flatten", "-Wclippy::map_unwrap_or", + "-Wclippy::match_same_arms", + "-Wclippy::match_wild_err_arm", "-Wclippy::needless_borrow", + "-Wclippy::needless_continue", + "-Wclippy::needless_for_each", "-Wclippy::needless_pass_by_value", + "-Wclippy::option_option", + "-Wclippy::same_functions_in_if_condition", + "-Wclippy::single_match_else", + "-Wclippy::trait_duplication_in_bounds", "-Wclippy::unnecessary_mut_passed", + "-Wclippy::unnecessary_wraps", + "-Wclippy::use_self", + "-Wnonstandard_style", "-Wrust_2018_idioms", "-Wtrivial_numeric_casts", + "-Wunused_lifetimes", "-Wunused_qualifications", -] \ No newline at end of file +] diff --git a/.config/nextest.toml b/.config/nextest.toml new file mode 100644 index 0000000..2c1df28 --- /dev/null +++ b/.config/nextest.toml @@ -0,0 +1,12 @@ +[profile.ci] +# Print out output for failing tests as soon as they fail, and also at the end +# of the run (for easy scrollability). +failure-output = "immediate-final" +# Show skipped tests in the CI output. +status-level = "skip" +# Do not cancel the test run on the first failure. +fail-fast = false +# Mark tests as slow after 5mins, kill them after 20mins +slow-timeout = { period = "300s", terminate-after = 4 } +# Retry failed tests once, marked flaky if test then passes +retries = 1 \ No newline at end of file diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index ce8438d..37418d1 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,48 +1,99 @@ -name: Tests -on: [push, pull_request] -env: - CARGO_TERM_COLOR: always +name: Rust + +on: + merge_group: + push: + branches: [dev, main] + pull_request: + types: [opened, synchronize, reopened, ready_for_review] + branches: [dev, main] + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + jobs: test: - runs-on: ubuntu-latest + runs-on: [ubuntu-latest] + strategy: + fail-fast: false + env: + RUSTFLAGS: -D warnings steps: - - name: Checkout code - uses: actions/checkout@v3 - - - name: Cache cargo build - uses: Swatinem/rust-cache@v1 + - uses: actions/checkout@v4 + with: + repository: lurk-lab/ci-workflows + - uses: ./.github/actions/ci-env + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + - uses: taiki-e/install-action@nextest + - uses: Swatinem/rust-cache@v2 + # make sure benches don't bit-rot + - name: build benches & examples + run: cargo build --benches --examples --release + - name: cargo test + run: | + cargo nextest run --release --profile ci + - name: Doctests + run: | + cargo test --doc - - name: Setup Rust - uses: actions-rs/toolchain@v1 + # Rustfmt, clippy, and doctests + lints: + runs-on: ubuntu-latest + strategy: + fail-fast: false + steps: + - uses: actions/checkout@v4 + with: + repository: lurk-lab/ci-workflows + - uses: ./.github/actions/ci-env + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable with: - toolchain: stable - override: true - profile: minimal components: rustfmt, clippy - target: wasm32-unknown-unknown - - - name: Run cargo fmt + - uses: Swatinem/rust-cache@v2 + - name: Check Rustfmt Code Style uses: actions-rs/cargo@v1 with: command: fmt args: --all -- --check + - name: Check clippy warnings + run: | + if $(cargo --list|grep -q xclippy); then + cargo xclippy -Dwarnings + else + cargo clippy -Dwarnings + fi + - name: Doctests + run: cargo test --doc --workspace - - name: Run cargo clippy - uses: actions-rs/cargo@v1 + # Check MSRV in `Cargo.toml` is valid + msrv: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 with: - command: clippy - args: --all-targets -- -D warnings - - - name: Run tests - uses: actions-rs/cargo@v1 + repository: lurk-lab/ci-workflows + - uses: ./.github/actions/ci-env + - uses: actions/checkout@v4 + - name: Install rustup + uses: actions-rs/toolchain@v1 with: - command: test - - - name: Run grumpkin_msm example - run: cargo run --release --example grumpkin_msm + toolchain: stable + override: true + - uses: Swatinem/rust-cache@v2 + - name: Install cargo-msrv + run: cargo install cargo-msrv + - name: Check Rust MSRV + run: cargo msrv verify - - name: Run pasta_msm example - run: cargo run --release --example pasta_msm + # Check documentation links aren't broken + link-checker: + uses: lurk-lab/ci-workflows/.github/workflows/links-check.yml@main + with: + fail-fast: true - - name: Check benches build - run: cargo check --benches \ No newline at end of file + # Lint dependencies for licensing and auditing issues as per https://github.com/lurk-lab/bellpepper/blob/main/deny.toml + licenses-audits: + uses: lurk-lab/ci-workflows/.github/workflows/licenses-audits.yml@main diff --git a/Cargo.toml b/Cargo.toml index d9e3723..8494b48 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -14,6 +14,7 @@ include = [ "/build.rs", "/README.md", ] +rust-version = "1.70" [features] # By default, compile with ADX extension if the host supports it. @@ -44,6 +45,10 @@ which = "^4.0" [dev-dependencies] criterion = { version = "0.3", features = [ "html_reports" ] } +[target.'cfg(target_arch = "wasm32")'.dependencies] +# see https://github.com/rust-random/rand/pull/948 +getrandom = { version = "0.2.0", default-features = false, features = ["js"] } + [[bench]] name = "grumpkin_msm" harness = false diff --git a/build.rs b/build.rs index 8d08528..b1a1371 100644 --- a/build.rs +++ b/build.rs @@ -73,9 +73,10 @@ fn common_build_configurations(cc: &mut cc::Build) { } fn determine_cc_def(target_arch: &str, default_def: &str) -> Option { - if cfg!(feature = "portable") && cfg!(feature = "force-adx") { - panic!("Cannot compile with both `portable` and `force-adx` features"); - } + assert!( + !(cfg!(feature = "portable") && cfg!(feature = "force-adx")), + "Cannot compile with both `portable` and `force-adx` features" + ); if cfg!(feature = "portable") { return Some(default_def.to_string()); diff --git a/deny.toml b/deny.toml new file mode 100644 index 0000000..99f1bf8 --- /dev/null +++ b/deny.toml @@ -0,0 +1,274 @@ +# This template contains all of the possible sections and their default values + +# Note that all fields that take a lint level have these possible values: +# * deny - An error will be produced and the check will fail +# * warn - A warning will be produced, but the check will not fail +# * allow - No warning or error will be produced, though in some cases a note +# will be + +# The values provided in this template are the default values that will be used +# when any section or field is not specified in your own configuration + +# Root options + +# If 1 or more target triples (and optionally, target_features) are specified, +# only the specified targets will be checked when running `cargo deny check`. +# This means, if a particular package is only ever used as a target specific +# dependency, such as, for example, the `nix` crate only being used via the +# `target_family = "unix"` configuration, that only having windows targets in +# this list would mean the nix crate, as well as any of its exclusive +# dependencies not shared by any other crates, would be ignored, as the target +# list here is effectively saying which targets you are building for. +targets = [ + # The triple can be any string, but only the target triples built in to + # rustc (as of 1.40) can be checked against actual config expressions + #{ triple = "x86_64-unknown-linux-musl" }, + # You can also specify which target_features you promise are enabled for a + # particular target. target_features are currently not validated against + # the actual valid features supported by the target architecture. + #{ triple = "wasm32-unknown-unknown", features = ["atomics"] }, +] +# When creating the dependency graph used as the source of truth when checks are +# executed, this field can be used to prune crates from the graph, removing them +# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate +# is pruned from the graph, all of its dependencies will also be pruned unless +# they are connected to another crate in the graph that hasn't been pruned, +# so it should be used with care. The identifiers are [Package ID Specifications] +# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html) +#exclude = [] +# If true, metadata will be collected with `--all-features`. Note that this can't +# be toggled off if true, if you want to conditionally enable `--all-features` it +# is recommended to pass `--all-features` on the cmd line instead +all-features = false +# If true, metadata will be collected with `--no-default-features`. The same +# caveat with `all-features` applies +no-default-features = false +# If set, these feature will be enabled when collecting metadata. If `--features` +# is specified on the cmd line they will take precedence over this option. +#features = [] +# When outputting inclusion graphs in diagnostics that include features, this +# option can be used to specify the depth at which feature edges will be added. +# This option is included since the graphs can be quite large and the addition +# of features from the crate(s) to all of the graph roots can be far too verbose. +# This option can be overridden via `--feature-depth` on the cmd line +feature-depth = 1 + +# This section is considered when running `cargo deny check advisories` +# More documentation for the advisories section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html +[advisories] +# The path where the advisory database is cloned/fetched into +db-path = "~/.cargo/advisory-db" +# The url(s) of the advisory databases to use +db-urls = ["https://github.com/rustsec/advisory-db"] +# The lint level for security vulnerabilities +vulnerability = "deny" +# The lint level for unmaintained crates +unmaintained = "warn" +# The lint level for crates that have been yanked from their source registry +yanked = "warn" +# The lint level for crates with security notices. Note that as of +# 2019-12-17 there are no security notice advisories in +# https://github.com/rustsec/advisory-db +notice = "warn" +# A list of advisory IDs to ignore. Note that ignored advisories will still +# output a note when they are encountered. +ignore = [ + #"RUSTSEC-0000-0000", +] +# Threshold for security vulnerabilities, any vulnerability with a CVSS score +# lower than the range specified will be ignored. Note that ignored advisories +# will still output a note when they are encountered. +# * None - CVSS Score 0.0 +# * Low - CVSS Score 0.1 - 3.9 +# * Medium - CVSS Score 4.0 - 6.9 +# * High - CVSS Score 7.0 - 8.9 +# * Critical - CVSS Score 9.0 - 10.0 +#severity-threshold = + +# If this is true, then cargo deny will use the git executable to fetch advisory database. +# If this is false, then it uses a built-in git library. +# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support. +# See Git Authentication for more information about setting up git authentication. +#git-fetch-with-cli = true + +# This section is considered when running `cargo deny check licenses` +# More documentation for the licenses section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html +[licenses] +# The lint level for crates which do not have a detectable license +unlicensed = "deny" +# List of explicitly allowed licenses +# See https://spdx.org/licenses/ for list of possible licenses +# [possible values: any SPDX 3.11 short identifier (+ optional exception)]. +allow = [ + "MIT", + "BSD-2-Clause", + "BSD-3-Clause", + "CC0-1.0", + "Apache-2.0", + "Apache-2.0 WITH LLVM-exception", + "Unicode-DFS-2016", +] +# List of explicitly disallowed licenses +# See https://spdx.org/licenses/ for list of possible licenses +# [possible values: any SPDX 3.11 short identifier (+ optional exception)]. +deny = [ + #"Nokia", +] +# Lint level for licenses considered copyleft +copyleft = "deny" +# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses +# * both - The license will be approved if it is both OSI-approved *AND* FSF +# * either - The license will be approved if it is either OSI-approved *OR* FSF +# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF +# * fsf-only - The license will be approved if is FSF *AND NOT* OSI-approved +# * neither - This predicate is ignored and the default lint level is used +allow-osi-fsf-free = "neither" +# Lint level used when no other predicates are matched +# 1. License isn't in the allow or deny lists +# 2. License isn't copyleft +# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither" +default = "deny" +# The confidence threshold for detecting a license from license text. +# The higher the value, the more closely the license text must be to the +# canonical license text of a valid SPDX license file. +# [possible values: any between 0.0 and 1.0]. +confidence-threshold = 0.8 +# Allow 1 or more licenses on a per-crate basis, so that particular licenses +# aren't accepted for every possible crate as with the normal allow list +exceptions = [ + # Each entry is the crate and version constraint, and its specific allow + # list + # inferno is only imported under the flamegraph feature + { allow = ["CDDL-1.0"], name = "inferno" }, +] + +# Some crates don't have (easily) machine readable licensing information, +# adding a clarification entry for it allows you to manually specify the +# licensing information +#[[licenses.clarify]] +# The name of the crate the clarification applies to +#name = "ring" +# The optional version constraint for the crate +#version = "*" +# The SPDX expression for the license requirements of the crate +#expression = "MIT AND ISC AND OpenSSL" +# One or more files in the crate's source used as the "source of truth" for +# the license expression. If the contents match, the clarification will be used +# when running the license check, otherwise the clarification will be ignored +# and the crate will be checked normally, which may produce warnings or errors +# depending on the rest of your configuration +#license-files = [ + # Each entry is a crate relative path, and the (opaque) hash of its contents + #{ path = "LICENSE", hash = 0xbd0eed23 } +#] + +[licenses.private] +# If true, ignores workspace crates that aren't published, or are only +# published to private registries. +# To see how to mark a crate as unpublished (to the official registry), +# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field. +ignore = false +# One or more private registries that you might publish crates to, if a crate +# is only published to private registries, and ignore is true, the crate will +# not have its license(s) checked +registries = [ + #"https://sekretz.com/registry +] + +# This section is considered when running `cargo deny check bans`. +# More documentation about the 'bans' section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html +[bans] +# Lint level for when multiple versions of the same crate are detected +multiple-versions = "warn" +# Lint level for when a crate version requirement is `*` +wildcards = "allow" +# The graph highlighting used when creating dotgraphs for crates +# with multiple versions +# * lowest-version - The path to the lowest versioned duplicate is highlighted +# * simplest-path - The path to the version with the fewest edges is highlighted +# * all - Both lowest-version and simplest-path are used +highlight = "all" +# The default lint level for `default` features for crates that are members of +# the workspace that is being checked. This can be overriden by allowing/denying +# `default` on a crate-by-crate basis if desired. +workspace-default-features = "allow" +# The default lint level for `default` features for external crates that are not +# members of the workspace. This can be overriden by allowing/denying `default` +# on a crate-by-crate basis if desired. +external-default-features = "allow" +# List of crates that are allowed. Use with care! +allow = [ + #{ name = "ansi_term", version = "=0.11.0" }, +] +# List of crates to deny +deny = [ + # Each entry the name of a crate and a version range. If version is + # not specified, all versions will be matched. + #{ name = "ansi_term", version = "=0.11.0" }, + # + # Wrapper crates can optionally be specified to allow the crate when it + # is a direct dependency of the otherwise banned crate + #{ name = "ansi_term", version = "=0.11.0", wrappers = [] }, +] + +# List of features to allow/deny +# Each entry the name of a crate and a version range. If version is +# not specified, all versions will be matched. +#[[bans.features]] +#name = "reqwest" +# Features to not allow +#deny = ["json"] +# Features to allow +#allow = [ +# "rustls", +# "__rustls", +# "__tls", +# "hyper-rustls", +# "rustls", +# "rustls-pemfile", +# "rustls-tls-webpki-roots", +# "tokio-rustls", +# "webpki-roots", +#] +# If true, the allowed features must exactly match the enabled feature set. If +# this is set there is no point setting `deny` +#exact = true + +# Certain crates/versions that will be skipped when doing duplicate detection. +skip = [ + #{ name = "ansi_term", version = "=0.11.0" }, +] +# Similarly to `skip` allows you to skip certain crates during duplicate +# detection. Unlike skip, it also includes the entire tree of transitive +# dependencies starting at the specified crate, up to a certain depth, which is +# by default infinite. +skip-tree = [ + #{ name = "ansi_term", version = "=0.11.0", depth = 20 }, +] + +# This section is considered when running `cargo deny check sources`. +# More documentation about the 'sources' section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html +[sources] +# Lint level for what to happen when a crate from a crate registry that is not +# in the allow list is encountered +unknown-registry = "warn" +# Lint level for what to happen when a crate from a git repository that is not +# in the allow list is encountered +unknown-git = "deny" +# List of URLs for allowed crate registries. Defaults to the crates.io index +# if not specified. If it is specified but empty, no registries are allowed. +allow-registry = ["https://github.com/rust-lang/crates.io-index"] +# List of URLs for allowed Git repositories +allow-git = [] + +[sources.allow-org] +# 1 or more github.com organizations to allow git sources for +github = ["lurk-lab"] +# 1 or more gitlab.com organizations to allow git sources for +# gitlab = [""] +# 1 or more bitbucket.org organizations to allow git sources for +# bitbucket = [""]