Coverage, CI updates, lints (#20)

Author: nyurik

.github/workflows/ci.yml

@@ -14,48 +14,40 @@ defaults:
     shell: bash
 
 jobs:
-  test:
-    name: Test
+  ci:
+    name: CI
     runs-on: ubuntu-latest
     steps:
+      #############################################################
+      ## Full test
+      ##
+      - if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
+        uses: Swatinem/rust-cache@v2
       - uses: taiki-e/install-action@v2
         with: { tool: just }
       - uses: actions/checkout@v4
-      - name: Ensure this crate has not yet been published (on release)
-        if: github.event_name == 'release'
+      - if: github.event_name == 'release'
+        name: Ensure this crate has not yet been published (on release)
         run: just check-if-published
-      - uses: Swatinem/rust-cache@v2
-        if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
-      - run: just ci-test
+      - run: RUST_BACKTRACE=1 just ci-test
       - name: Check semver
         uses: obi1kenobi/cargo-semver-checks-action@v2
-
-  msrv:
-    name: Test MSRV
-    runs-on: ubuntu-latest
-    steps:
-      - uses: taiki-e/install-action@v2
-        with: { tool: just }
-      - uses: actions/checkout@v4
-      - uses: Swatinem/rust-cache@v2
-        if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
-      - name: Read crate metadata
-        id: metadata
-        run: echo "rust-version=$(sed -ne 's/rust-version *= *\"\(.*\)\"/\1/p' Cargo.toml)" >> $GITHUB_OUTPUT
+      #############################################################
+      ## Test MSRV
+      ##
+      - name: Read MSRV
+        id: msrv
+        run: echo "value=$(sed -ne 's/rust-version *= *\"\(.*\)\"/\1/p' Cargo.toml)" >> $GITHUB_OUTPUT
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: ${{ steps.metadata.outputs.rust-version }}
+          toolchain: ${{ steps.msrv.outputs.value }}
       - run: just ci-test-msrv
-
-  publish:
-    name: Publish to crates.io
-    if: startsWith(github.ref, 'refs/tags/')
-    needs: [ test, msrv ]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Publish to crates.io
+      #############################################################
+      ## Publish to crates.io
+      ##
+      - if: startsWith(github.ref, 'refs/tags/')
+        name: Publish to crates.io
         run: cargo publish
         env:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

.github/workflows/coverage.yml

@@ -0,0 +1,31 @@
+name: Code coverage
+
+on:
+  push:
+    branches: [ main ]
+    paths-ignore: [ '**.md' ]
+  pull_request:
+    branches: [ main ]
+    paths-ignore: [ '**.md' ]
+  workflow_dispatch:
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    env:
+      CARGO_TERM_COLOR: always
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+      - uses: Swatinem/rust-cache@v2
+
+      - uses: taiki-e/install-action@v2
+        with: { tool: 'just,cargo-llvm-cov' }
+      - name: Generate code coverage
+        run: just ci-coverage
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: target/llvm-cov/codecov.info
+          fail_ci_if_error: true

.gitignore

@@ -1,19 +1,12 @@
+**/*.rs.bk
+*.pdb
 .idea
 .vscode
-venv
-
-### Rust template
-# Generated by Cargo
-# will have compiled files and executables
 debug/
 target/
+temp/
+tmp/
+venv/
 
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+# This is a library, no lock
 Cargo.lock
-
-# These are backup files generated by rustfmt
-**/*.rs.bk
-
-# MSVC Windows builds of rustc generate these, which store debugging information
-*.pdb

LICENSE-MIT

@@ -1,7 +1,7 @@
 MIT License
 
 Copyright (c) 2021 Ashcon Mohseninia
-Copyright (c) 2023-2025 Yuri Astrakhan
+Copyright (c) 2023-2025 Yuri Astrakhan <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -5,6 +5,7 @@
 [![docs.rs](https://img.shields.io/docsrs/automotive_diag)](https://docs.rs/automotive_diag)
 [![crates.io license](https://img.shields.io/crates/l/automotive_diag)](https://github.com/nyurik/automotive_diag/blob/main/LICENSE-APACHE)
 [![CI build](https://github.com/nyurik/automotive_diag/actions/workflows/ci.yml/badge.svg)](https://github.com/nyurik/automotive_diag/actions)
+[![Codecov](https://img.shields.io/codecov/c/github/nyurik/automotive_diag)](https://app.codecov.io/gh/nyurik/automotive_diag)
 
 This crate provides low-level `no_std` structs and enums of
 the [Unified Diagnostic Services](https://en.wikipedia.org/wiki/Unified_Diagnostic_Services) (ISO-14229-1),

justfile

@@ -8,11 +8,19 @@ clean:
     cargo clean
     rm -f Cargo.lock
 
-# Update all dependencies, including the breaking changes. Requires nightly toolchain (install with `rustup install nightly`)
+# Update all dependencies, including breaking changes. Requires nightly toolchain (install with `rustup install nightly`)
 update:
     cargo +nightly -Z unstable-options update --breaking
     cargo update
 
+# Find unused dependencies. Install it with `cargo install cargo-udeps`
+udeps:
+    cargo +nightly udeps --all-targets --workspace --all-features
+
+# Check semver compatibility with prior published version. Install it with `cargo install cargo-semver-checks`
+semver *ARGS:
+    cargo semver-checks {{ARGS}}
+
 # Find the minimum supported Rust version (MSRV) using cargo-msrv extension, and update Cargo.toml
 msrv:
     cargo msrv find --write-msrv --ignore-lockfile
@@ -47,9 +55,19 @@ check:
     RUSTFLAGS='-D warnings' cargo check --workspace --all-targets
     RUSTFLAGS='-D warnings' cargo check --no-default-features --features with-uds --all-targets
 
+# Generate code coverage report
+coverage *ARGS="--no-clean --open":
+    cargo llvm-cov --workspace --all-targets --include-build-script {{ARGS}}
+
+# Generate code coverage report to upload to codecov.io
+ci-coverage: && \
+            (coverage '--codecov --output-path target/llvm-cov/codecov.info')
+    # ATTENTION: the full file path above is used in the CI workflow
+    mkdir -p target/llvm-cov
+
 # Run all tests
 test:
-    RUSTFLAGS='-D warnings' cargo test
+    RUSTFLAGS='-D warnings' cargo test --workspace --all-targets
     RUSTFLAGS='-D warnings' cargo test --no-default-features --features with-kwp2000
     RUSTFLAGS='-D warnings' cargo test --no-default-features --features with-obd2
     RUSTFLAGS='-D warnings' cargo test --no-default-features --features with-uds