CI starter (#5)

Added CI

Author: elshize

.github/workflows/ci.yml

@@ -0,0 +1,90 @@
+name: CI
+on:
+    pull_request:
+    push:
+        branches:
+            - main
+
+env:
+  RUST_LOG: info
+  RUST_BACKTRACE: 1
+
+jobs:
+    test-versions:
+        name: Test Rust ${{ matrix.rust }}
+        runs-on: ubuntu-latest
+        strategy:
+            fail-fast: false
+            matrix:
+              rust: [stable, beta, nightly]
+        steps:
+            - uses: actions/checkout@v2
+            - uses: hecrj/setup-rust-action@v1
+              with:
+                  rust-version: ${{ matrix.rust }}
+            - run: cargo test --verbose --workspace
+    cargo-check:
+        name: Check for warnings
+        runs-on: ubuntu-latest
+        env:
+            RUSTFLAGS: -Dwarnings
+        steps:
+            - uses: actions/checkout@v2
+            - uses: hecrj/setup-rust-action@v1
+            - run: cargo check --workspace --all-targets --verbose
+    clippy:
+        name: Lint with Clippy
+        runs-on: ubuntu-latest
+        env:
+            RUSTFLAGS: -Dwarnings
+        steps:
+            - uses: actions/checkout@v2
+            - uses: hecrj/setup-rust-action@v1
+              with:
+                components: clippy
+            - run: cargo clippy --workspace --all-targets --verbose
+    rustfmt:
+        name: Verify code formatting
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v2
+          - uses: hecrj/setup-rust-action@v1
+            with:
+              components: rustfmt
+          - run: cargo fmt --all -- --check
+    check-rustdoc-links:
+        name: Check intra-doc links
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: hecrj/setup-rust-action@v1
+              with:
+                  rust-version: nightly
+            - run: cargo rustdoc -- -D warnings
+    # code-coverage:
+    #     name: Run code coverage
+    #     runs-on: ubuntu-latest
+    #     env:
+    #         RUSTFLAGS: -Zinstrument-coverage
+    #     steps:
+    #         - uses: actions/checkout@v2
+    #         - uses: hecrj/setup-rust-action@v1
+    #           with:
+    #               rust-version: nightly
+    #         - name: Cache LLVM and Clang
+    #           id: cache-llvm
+    #           uses: actions/cache@v2
+    #           with:
+    #               path: ${{ runner.temp }}/llvm
+    #               key: llvm-10.0
+    #         - name: Install LLVM and Clang
+    #           uses: KyleMayes/install-llvm-action@v1
+    #           with:
+    #               version: "10.0"
+    #               directory: ${{ runner.temp }}/llvm
+    #               cached: ${{ steps.cache-llvm.outputs.cache-hit }}
+    #         - run: sudo apt-get install -y libtinfo-dev libtinfo5 build-essential
+    #         - run: wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add -
+    #         - run: cargo install rustfilt
+    #         - run: echo "PATH=/home/runner/.cargo/bin:$PATH" >> $GITHUB_ENV
+    #         - run: ./codecov.sh --check

codecov.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+set +xe
+
+REQUIRED=100
+
+cargo clean
+RUSTFLAGS="-Zinstrument-coverage" cargo test --lib --no-run
+tests="target/debug/deps/$(ls target/debug/deps | grep -e "^simrs-[a-z0-9]*$")"
+$tests
+cat default.profraw > all.profraw
+
+RUSTFLAGS="-Zinstrument-coverage" cargo build --examples
+objects=""
+examples="$(ls target/debug/examples | grep -e ".*-[a-z0-9]*$")"
+for example in $examples; do
+    ./target/debug/examples/$example 2>&1 > /dev/null
+    objects="$objects -object ./target/debug/examples/$example"
+    cat default.profraw >> all.profraw
+done
+
+llvm-profdata merge -sparse all.profraw -o default.profdata
+if ! [[ $1 = "--check" ]]; then
+    llvm-cov report -Xdemangler=rustfilt $tests $objects -instr-profile=default.profdata
+    llvm-cov show -Xdemangler=rustfilt $tests $objects -instr-profile=default.profdata \
+        -show-line-counts-or-regions \
+        -format=html > cov.html
+else
+    llvm-cov export -Xdemangler=rustfilt $tests $objects -instr-profile=default.profdata \
+        > lcov.json
+    percent=$(jq '.data[].totals.lines.percent' lcov.json)
+    if (( percent < $REQUIRED )); then
+        echo "Required ${REQUIRED}% line coverage. Coverage detected: $percent"
+        exit 1
+    else
+        echo "Success!"
+    fi
+fi

examples/simulation.rs

@@ -77,7 +77,9 @@ impl Component for Consumer {
             ConsumerEvent::Received => {
                 if busy {
                     if let Some(product) = state.recv(self.incoming) {
-                        state.get_mut(self.working_on).map(|w| *w = Some(product));
+                        if let Some(w) = state.get_mut(self.working_on) {
+                            *w = Some(product);
+                        }
                         scheduler.schedule(self.interval(), self_id, ConsumerEvent::Finished);
                     }
                 }

src/lib.rs

@@ -348,7 +348,7 @@ impl Simulation {
 
     /// Runs the entire simulation from start to end.
     /// This function might not terminate if the end condition is not satisfied.
-    pub fn run<F: Fn(&Simulation) -> ()>(&mut self, step_function: F) {
+    pub fn run<F: Fn(&Simulation)>(&mut self, step_function: F) {
         while self.step() {
             step_function(self)
         }