canopydb 0.2.5

Transactional key-value storage engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

name: Continuous integration

on:
  push:
    branches: [master]
  pull_request:

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true
jobs:
  check-all-targets-stable:
    name: Check all targets - Stable
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true
      - run: cargo check --all-targets
      - run: cargo check --all-targets --no-default-features

  check-all-targets-nightly:
      name: Check all targets - Nightly
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v2
        - uses: actions-rs/toolchain@v1
          with:
            profile: minimal
            toolchain: nightly
            override: true
        - run: cargo check --all-targets
        - run: cargo check --all-targets --no-default-features
        - run: cargo check --all-targets --all-features

  test-stable:
    name: Tests - Stable
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest, ubuntu-24.04-arm, windows-11-arm]
    runs-on: ${{ matrix.os }}
    env:
      RUST_TEST_THREADS: 2
      TEST_DATA_FOLDER: .
      CANOPYDB_DISABLE_FSYNC_DEFAULT: 1
    steps:
      - uses: actions/checkout@v2
      - uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true
      - run: cargo test

  test-nightly:
    name: Tests - Nightly
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest]
    runs-on: ${{ matrix.os }}
    env:
      RUST_TEST_THREADS: 2
      TEST_DATA_FOLDER: .
      CANOPYDB_DISABLE_FSYNC_DEFAULT: 1
    steps:
      - uses: actions/checkout@v2
      - uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: nightly
          override: true
      - run: cargo test --features nightly
      # no run because of shuttle feature and non-shuttle tests
      - run: cargo test --all-features --no-run

  shuttle-tests:
    name: Shuttle Tests
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true
      - run: cargo test --profile shuttle --features shuttle shuttle

  docs:
    name: Build Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: nightly
          override: true
      - run: cargo doc --package canopydb
        # Temporarily disabled due to doc_auto_cfg removal in nightly
        # env:
          # RUSTDOCFLAGS: --cfg docsrs

  fuzz-tests:
    name: Fuzz tests
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: nightly
          override: true
      - run: sudo apt-get install -y llvm-dev
      - run: cargo install cargo-fuzz
      - run: for fuzz_test in `cargo fuzz list`; do cargo fuzz run $fuzz_test -- -max_total_time=30 -timeout=5 || exit 1; done
      - run: cargo fuzz run fuzz_database -- -detect_leaks=0 -len_control=0 -max_total_time=600 -timeout=5 -jobs=2
      - run: cargo fuzz run fuzz_database --features=failpoints -- -detect_leaks=0 -len_control=0 -max_total_time=600 -timeout=5 -jobs=2
      - env:
          NUM_ACTORS: 2
          MAX_WRITERS: 2
        run: cargo fuzz run fuzz_database -- -detect_leaks=0 -len_control=0 -max_total_time=600 -timeout=5 -jobs=2
      - env:
          NUM_ACTORS: 2
          MAX_WRITERS: 2
        run: cargo fuzz run fuzz_database --features=failpoints -- -detect_leaks=0 -len_control=0 -max_total_time=600 -timeout=5 -jobs=2

  lint:
    name: Rustfmt & Clippy
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true
      - run: rustup component add rustfmt
      - uses: actions-rs/cargo@v1
        with:
          command: fmt
          args: --all -- --check
      - run: rustup component add clippy
      - uses: actions-rs/cargo@v1
        with:
          command: clippy
          args: -- -D warnings

  miri:
    runs-on: ubuntu-latest
    env:
      MIRIFLAGS: -Zmiri-disable-isolation
    steps:
    - uses: actions/checkout@v2
    - name: Install Rust toolchain
      uses: actions-rs/toolchain@v1
      with:
        profile: minimal
        toolchain: nightly
        override: true
        components: miri
    - run: cargo miri run --example basic_usage
    - run: cargo miri run --example fixed_len_key_value
    - run: cargo miri run --example one_env_many_dbs