tests: upgraded tarpaulin and added derive macro coverage (#1466)

* tests: upgraded tarpaulin and added derive macro coverage

Upgraded tarpaulin to new the new maintainer, added coverage for derive
macro, and added an example.

Fixes: #1144

Signed-off-by: tyrone-wu <[email protected]>

* pin commit for git dependencies and appease deny.toml

Signed-off-by: tyrone-wu <[email protected]>

---------

Signed-off-by: tyrone-wu <[email protected]>

.github/workflows/coverage.yml

@@ -17,11 +17,15 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          override: true
+        uses: dtolnay/rust-toolchain@stable
       - uses: Swatinem/rust-cache@v2
+      # - name: Install tarpaulin
+      #   uses: taiki-e/install-action@v2
+      #   with:
+      #     tool: cargo-tarpaulin
+      - name: Install tarpaulin # Use dev tarpaulin from git repo for now, until it's pushed to release
+        run: |
+          rustup run stable cargo install --git https://github.com/xd009642/tarpaulin.git --rev 2b05ebd4f809eeeeb590f68efb8e62758eb59214 cargo-tarpaulin
       - uses: AbsaOSS/k3d-action@v2
         name: "Create Single Cluster"
         with:
@@ -31,8 +35,7 @@ jobs:
             -p 10250:10250
             --k3s-arg "--no-deploy=traefik,servicelb,metrics-server@server:*"
       - name: Run cargo-tarpaulin
-        uses: actions-rs/[email protected]
-        with:
-          version: '0.18.5'
-          out-type: Xml
-      - uses: codecov/codecov-action@v3
+        run: |
+          rustup run stable cargo tarpaulin -o xml --skip-clean
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3

deny.toml

@@ -51,7 +51,7 @@ license-files = [
 unknown-registry = "deny"
 unknown-git = "deny"
 allow-registry = ["https://github.com/rust-lang/crates.io-index"]
-allow-git = []
+allow-git = ["https://github.com/tyrone-wu/runtime-macros.git"]
 
 [bans]
 multiple-versions = "deny"

justfile

@@ -88,7 +88,7 @@ k3d:
     --k3s-arg "--disable=traefik,servicelb,metrics-server@server:*" \
     --k3s-arg '--kubelet-arg=eviction-hard=imagefs.available<1%,nodefs.available<1%@agent:*' \
     --k3s-arg '--kubelet-arg=eviction-minimum-reclaim=imagefs.available=1%,nodefs.available=1%@agent:*' \
-    --k3s-arg '--kube-apiserver-arg=feature-gates=WatchList=true'
+    --k3s-arg '--kube-apiserver-arg=feature-gates=WatchList=true@server:*'
 
 ## RELEASE RELATED
 

kube-derive/Cargo.toml

@@ -33,3 +33,4 @@ schemars = { workspace = true, features = ["chrono"] }
 chrono.workspace = true
 trybuild.workspace = true
 assert-json-diff.workspace = true
+runtime-macros = { git = "https://github.com/tyrone-wu/runtime-macros.git", rev = "e31f4de52e078d41aba4792a7ea30139606c1362" }

kube-derive/src/custom_resource.rs

@@ -599,8 +599,9 @@ fn to_plural(word: &str) -> String {
 
 #[cfg(test)]
 mod tests {
+    use std::{env, fs};
+
     use super::*;
-    // TODO Unit test `derive`
 
     #[test]
     fn test_parse_default() {
@@ -616,4 +617,18 @@ mod tests {
         assert_eq!(kube_attrs.kind, "Foo".to_string());
         assert!(kube_attrs.namespaced);
     }
+
+    #[test]
+    fn test_derive_crd() {
+        let path = env::current_dir().unwrap().join("tests").join("crd_enum_test.rs");
+        let file = fs::File::open(path).unwrap();
+        runtime_macros::emulate_derive_macro_expansion(file, &[("CustomResource", derive)]).unwrap();
+
+        let path = env::current_dir()
+            .unwrap()
+            .join("tests")
+            .join("crd_schema_test.rs");
+        let file = fs::File::open(path).unwrap();
+        runtime_macros::emulate_derive_macro_expansion(file, &[("CustomResource", derive)]).unwrap();
+    }
 }

tarpaulin.toml

@@ -7,21 +7,18 @@
 
 [one_pass_coverage]
 workspace = true
-features = "kube/derive kube/runtime kube/ws"
+all-features = true
 color = "Always"
 ignored = true
 timeout = "600s"
 exclude = ["e2e"]
-# NB: proc macro code is not picked up by tarpaulin - so could maybe skip kube-derive completely
-excluded_files = ["kube-derive/tests"]
+include-tests = true
 # NB: skipping Doctests because they are slow to build and generally marked no_run
 run-types = ["Tests"]
-ignore_tests = true
 
 # We could potentially pass in examples here
 # but: they don't help in covering kube-derive, and they force a full recompile
-#[example_pass]
-#features = "default"
-#packages = ["kube-examples"]
-#excluded_files = ["examples/"]
-#example = ["crd_derive_schema"]
+[example_pass]
+packages = ["kube-examples"]
+exclude-files = ["examples/"]
+example = ["crd_derive_schema"]