Skip to content

Commit 26ece01

Browse files
apoelstraapoelstra
committed
Merge #78: Add fuzzing + CI
fcc9c6f test: Add Github CI (Christian Lewe) cd8cb5e feat: Add justfile (Christian Lewe) 2cb71d0 feat: Add nix flake (Christian Lewe) f782a80 doc: Add fuzz README (Christian Lewe) 96bab4d feat: Add fuzz subcrate (Christian Lewe) 6526f0d feat: Impl Arbitrary for parse tree (Christian Lewe) 65aebc8 feat: Impl Arbitrary for Pattern (Christian Lewe) c50f59c feat: Impl Arbitrary for AliasedType (Christian Lewe) 3d7fcb6 feat: Impl Arbitrary for Value (Christian Lewe) 27fcf68 feat: Impl Arbitrary for str and num types (Christian Lewe) 75c033e feat: Add ArbitraryRec trait (Christian Lewe) 6ab0c9f Cargo: Add arbitrary (Christian Lewe) Pull request description: Fixes #72 Implement fuzzing (`Arbitrary`) for the Simfony parse tree and write three fuzz targets: 1. `compile_text`: try to compile random ASCII strings; slow because of parser (#79) 2. `compile_parse_tree`: try to compile random parse trees; ~10x faster than `compile_text` and better coverage 3. `display_parse_tree`: check that `Display` → `ParseFromStr` is the identity function Write a simple CI that uses nix flakes and dev shells. This CI is not more reproducible than regular GitHub CI, but it saves me time because I already have nix infrastructure in place. I will switch the CI to something reproducible in the near future. Run the linter, unit tests (stable + MSRV) and the fuzzer in CI. For now, coverage is ignored in CI. ACKs for top commit: apoelstra: ACK fcc9c6f successfully ran local tests Tree-SHA512: bad0ea7ec838b3b31e74d2d8c8c41497e86e474e011c49b40b1dccd18bc69a4b58d238a51189517667256fe5aba2e81dc87e4c76333ab672c800c942c085ad98
2 parents 66b0b35 + fcc9c6f commit 26ece01

21 files changed

+1036
-10
lines changed

‎.github/workflows/test.yml

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: Test
2+
on:
3+
push:
4+
pull_request:
5+
jobs:
6+
check-flake:
7+
name: Check flake
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- name: Checkout
12+
uses: actions/checkout@v3
13+
14+
- name: Install nix
15+
uses: cachix/install-nix-action@v24
16+
with:
17+
github_access_token: ${{ secrets.GITHUB_TOKEN }}
18+
19+
- name: Check flake
20+
run: nix flake check --all-systems
21+
22+
test-stable:
23+
name: Test - stable toolchain
24+
runs-on: ubuntu-latest
25+
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v3
29+
30+
- name: Install nix
31+
uses: cachix/install-nix-action@v24
32+
with:
33+
github_access_token: ${{ secrets.GITHUB_TOKEN }}
34+
35+
- name: Enable Rust cache
36+
uses: Swatinem/rust-cache@v2
37+
38+
- name: Run all checks
39+
run: |
40+
nix develop .#ci --command bash -c "just check"
41+
42+
test-msrv:
43+
name: Test - MSRV toolchain
44+
runs-on: ubuntu-latest
45+
46+
steps:
47+
- name: Checkout
48+
uses: actions/checkout@v3
49+
50+
- name: Install nix
51+
uses: cachix/install-nix-action@v24
52+
with:
53+
github_access_token: ${{ secrets.GITHUB_TOKEN }}
54+
55+
- name: Enable Rust cache
56+
uses: Swatinem/rust-cache@v2
57+
58+
- name: Run unit tests
59+
run: |
60+
nix develop .#msrv --command bash -c "just test"
61+
62+
test-fuzz:
63+
name: Test - fuzzer
64+
runs-on: ubuntu-latest
65+
66+
steps:
67+
- name: Checkout
68+
uses: actions/checkout@v3
69+
70+
- name: Install nix
71+
uses: cachix/install-nix-action@v24
72+
with:
73+
github_access_token: ${{ secrets.GITHUB_TOKEN }}
74+
75+
- name: Enable Rust cache
76+
uses: Swatinem/rust-cache@v2
77+
78+
- name: Run each fuzzer for 30s
79+
run: |
80+
nix develop .#fuzz --command bash -c "just check_fuzz"

‎Cargo.lock

+37-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml

+2
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@ simplicity-lang = { git = "https://github.com/BlockstreamResearch/rust-simplicit
2828
miniscript = "11.0.0"
2929
either = "1.12.0"
3030
itertools = "0.13.0"
31+
arbitrary = { version = "1", optional = true, features = ["derive"] }
3132

3233
[target.wasm32-unknown-unknown.dependencies]
3334
getrandom = { version = "0.2", features = ["js"] }
3435

3536
[workspace]
3637
members = ["codegen"]
38+
exclude = ["fuzz"]

‎flake.lock

+96
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎flake.nix

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
{
2+
description = "Simfony";
3+
4+
inputs = {
5+
nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.05";
6+
flake-utils.url = "github:numtide/flake-utils";
7+
rust-overlay.url = "github:oxalica/rust-overlay";
8+
};
9+
10+
outputs =
11+
{ self
12+
, nixpkgs
13+
, flake-utils
14+
, rust-overlay
15+
, ...
16+
}:
17+
flake-utils.lib.eachSystem [
18+
"x86_64-linux"
19+
"aarch64-linux"
20+
"x86_64-darwin"
21+
] (system:
22+
let
23+
overlays = [
24+
(import rust-overlay)
25+
];
26+
pkgs = import nixpkgs {
27+
inherit system overlays;
28+
};
29+
mkRust = stable: version: profile: extensions: pkgs.rust-bin.${stable}.${version}.${profile}.override {
30+
inherit extensions;
31+
};
32+
defaultRust = mkRust "stable" "latest" "default" ["rust-src"];
33+
CC_wasm32_unknown_unknown = "${pkgs.llvmPackages_16.clang-unwrapped}/bin/clang-16";
34+
AR_wasm32_unknown_unknown = "${pkgs.llvmPackages_16.libllvm}/bin/llvm-ar";
35+
CFLAGS_wasm32_unknown_unknown = "-I ${pkgs.llvmPackages_16.libclang.lib}/lib/clang/16/include/";
36+
in
37+
{
38+
devShells = {
39+
default = pkgs.mkShell {
40+
buildInputs = [
41+
defaultRust
42+
pkgs.just
43+
pkgs.gdb
44+
];
45+
# Constants for IDE
46+
RUST_TOOLCHAIN = "${defaultRust}/bin";
47+
RUST_STDLIB = "${defaultRust}/lib/rustlib/src/rust";
48+
DEBUGGER = "${pkgs.gdb}";
49+
};
50+
# Temporary shells until CI has its nix derivations
51+
ci = pkgs.mkShell {
52+
buildInputs = [
53+
(mkRust "stable" "latest" "default" [])
54+
pkgs.just
55+
];
56+
};
57+
msrv = pkgs.mkShell {
58+
buildInputs = [
59+
(mkRust "stable" "1.61.0" "minimal" [])
60+
pkgs.just
61+
];
62+
};
63+
fuzz = pkgs.mkShell.override {
64+
stdenv = pkgs.clang16Stdenv;
65+
} {
66+
buildInputs = [
67+
(mkRust "nightly" "2024-07-01" "minimal" ["llvm-tools-preview"])
68+
pkgs.just
69+
pkgs.cargo-fuzz
70+
pkgs.cargo-binutils
71+
pkgs.rustfilt
72+
];
73+
# Constants for compiler
74+
inherit CC_wasm32_unknown_unknown;
75+
inherit AR_wasm32_unknown_unknown;
76+
inherit CFLAGS_wasm32_unknown_unknown;
77+
};
78+
};
79+
}
80+
);
81+
}

‎fuzz/.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
target
2+
corpus
3+
artifacts
4+
coverage

0 commit comments

Comments
 (0)