feat(cli): Add hwlib feature flags (#421)

* chore: fix .code-workspace file

the extensions and settings should be outside the folders section

* feat: add cli feature flag

* feat: add pybindings feature flag

* chore: bump hwlib version

* ci: add --all-features flag

* ci: add pybindings feature to maturin

* docs: you can run maturin from the client directory

now that the rust library is not in a workspace, you can run maturin from the client directory

Author: pedro-avalos

.github/workflows/test_client.yaml

@@ -38,13 +38,13 @@ jobs:
         with:
           toolchain: stable
           components: rustfmt, clippy
-      - run: cargo build
-      - run: cargo check
+      - run: cargo build --all-features
+      - run: cargo check --all-features
       - run: cargo fmt --all -- --check
       - run: cargo clippy --all-features --verbose
-      - run: cargo clippy --tests --verbose
+      - run: cargo clippy --all-features --tests --verbose
       - name: Run cargo test
-        run: cargo test
+        run: cargo test --all-features
 
   py-bindings-test:
     name: Test Python bindings

client/CONTRIBUTING.md

@@ -42,13 +42,7 @@ environment to be configured to work with it:
 virtualenv venv
 source venv/bin/activate
 pip install maturin
-```
-
-Then run the following commands:
-
-```shell
-cd hwlib
-maturin develop
+maturin develop --features pybindings
 ```
 
 Now you can use the library in your Python code. The library requires root
@@ -71,7 +65,6 @@ and Python code. To execute them, run the following commands:
 - Run Python tests: You need to have [`tox`][tox] (`pip install tox`). Then you
   can run Python tests with `$ tox`
 
-
 [snap]: https://snapcraft.io/hwctl
 [snapcraft]: https://github.com/canonical/snapcraft
 [pyo3]: https://github.com/PyO3/pyo3

client/Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "hwlib"
 description = "Tool for checking Ubuntu hardware certification status"
-version = "0.10.0"
+version = "0.10.1"
 edition = "2021"
 authors = [
     "Canonical Hardware Certification <[email protected]>",
@@ -20,17 +20,22 @@ crate-type = ["cdylib", "rlib"]
 [[bin]]
 name = "hwctl"
 path = "bin/hwctl.rs"
+features = ["cli"]
 
 [dependencies]
 anyhow = "~1.0.0"
-clap = { version = "4.5.41", features = ["derive", "env"] }
+clap = { version = "4.5.41", features = ["derive", "env"], optional = true }
 minreq = { version = "2.14.0", features = ["native-tls", "json-using-serde"], default-features = false }
 os-release = { version = "0.1.0" }
-pyo3 = { version = "0.26.0", features = ["extension-module"] }
+pyo3 = { version = "0.26.0", features = ["extension-module"], optional = true }
 serde = { version = "~1.0.0", features = ["derive"] }
 serde_json = "~1.0.0"
 smbios-lib = "0.9.0"
 
 [dev-dependencies]
 pretty_assertions = "1.4.1"
 simple_test_case = "1.2.0"
+
+[features]
+cli = ["clap"]
+pybindings = ["pyo3"]

client/Cargo.toml

@@ -40,6 +40,7 @@ apps:
 parts:
   hwctl:
     plugin: rust
+    rust-features: ["cli"]
     source: .
     build-packages:
       - jq

client/snapcraft.yaml

@@ -25,6 +25,7 @@ pub mod collectors;
 mod constants;
 mod helpers;
 pub mod models;
+#[cfg(feature = "pybindings")]
 pub mod py_bindings;
 
 use anyhow::Result;

client/src/lib.rs

@@ -10,7 +10,7 @@ deps =
     pytest
     maturin
 commands_pre =
-    {envbindir}/maturin develop
+    {envbindir}/maturin develop --features pybindings
 commands =
     {envbindir}/python -m black --check pytests/
     {envbindir}/python -m ruff check pytests/

client/tox.ini

@@ -1,28 +1,21 @@
 {
-    "folders": [
-        {
-            "name": "Server",
-            "path": "server",
-            "extensions": {
-                "recommendations": [
-                    "ms-python.python"
-                ]
-            },
-            "settings": {
-                "python.pythonPath": "server/.venv/bin/python"
-            }
-        },
-        {
-            "name": "hwlib",
-            "path": "client",
-            "extensions": {
-                "recommendations": [
-                    "matklad.rust-analyzer"
-                ]
-            },
-            "settings": {
-                "rust-analyzer.linkedProjects": ["client/Cargo.toml"]
-            }
-        }
+  "folders": [
+    {
+      "name": "Server",
+      "path": "server",
+    },
+    {
+      "name": "Client",
+      "path": "client",
+    }
+  ],
+  "extensions": {
+    "recommendations": [
+      "ms-python.python",
+      "rust-lang.rust-analyzer"
     ]
-}
+  },
+  "settings": {
+    "rust-analyzer.cargo.features": "all",
+  },
+}