Add clippy to CI

This patch adds clippy to the CI and fixes all current clippy warnings.
Nitrokey · Feb 15, 2025 · f2788f3 · f2788f3
1 parent 84d6c5b
commit f2788f3
Show file tree

Hide file tree

Showing 15 changed files with 30 additions and 14 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -42,3 +42,17 @@ jobs:
         components: "rustfmt"
     - name: Run rustfmt
       run: cargo fmt -- --check
+
+  clippy:
+    name: Run clippy
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: actions-rs/toolchain@v1
+      with:
+        profile: minimal
+        toolchain: stable
+        override: true
+        components: "clippy"
+    - name: Run clippy
+      run: cargo clippy --all-features --all-targets
diff --git a/generator/src/main/resources/crust/lib.mustache b/generator/src/main/resources/crust/lib.mustache
@@ -1,3 +1,7 @@
+// ureq v2 has a large error type, thus our errors are large too.
+// This will be fixed by updating to ureq v3.
+#![allow(clippy::result_large_err)]
+
 #[macro_use]
 extern crate serde_derive;
 

diff --git a/generator/src/main/resources/crust/model.mustache b/generator/src/main/resources/crust/model.mustache
@@ -7,7 +7,9 @@
 
 {{!-- for enum schemas --}}
 {{#isEnum}}
-/// {{{description}}}
+{{#description}}
+/// {{{.}}}
+{{/description}}
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum {{{classname}}} {
 {{#allowableValues}}
@@ -93,7 +95,9 @@ impl {{{classname}}} {
 {{!-- for properties that are of enum type --}}
 {{#vars}}
 {{#isEnum}}
-/// {{{description}}}
+{{#description}}
+/// {{{.}}}
+{{/description}}
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum {{{enumName}}} {
 {{#allowableValues}}

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,3 +1,7 @@
+// ureq v2 has a large error type, thus our errors are large too.
+// This will be fixed by updating to ureq v3.
+#![allow(clippy::result_large_err)]
+
 #[macro_use]
 extern crate serde_derive;
 

diff --git a/src/models/decrypt_mode.rs b/src/models/decrypt_mode.rs
@@ -8,7 +8,6 @@
  * Generated by: https://openapi-generator.tech
  */
 
-///
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum DecryptMode {
     #[serde(rename = "RAW")]

diff --git a/src/models/encrypt_mode.rs b/src/models/encrypt_mode.rs
@@ -8,7 +8,6 @@
  * Generated by: https://openapi-generator.tech
  */
 
-///
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum EncryptMode {
     #[serde(rename = "AES_CBC")]

diff --git a/src/models/key_mechanism.rs b/src/models/key_mechanism.rs
@@ -8,7 +8,6 @@
  * Generated by: https://openapi-generator.tech
  */
 
-///
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum KeyMechanism {
     #[serde(rename = "RSA_Decryption_RAW")]

diff --git a/src/models/key_type.rs b/src/models/key_type.rs
@@ -8,7 +8,6 @@
  * Generated by: https://openapi-generator.tech
  */
 
-///
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum KeyType {
     #[serde(rename = "RSA")]

diff --git a/src/models/log_level.rs b/src/models/log_level.rs
@@ -8,7 +8,6 @@
  * Generated by: https://openapi-generator.tech
  */
 
-///
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum LogLevel {
     #[serde(rename = "debug")]

diff --git a/src/models/sign_mode.rs b/src/models/sign_mode.rs
@@ -8,7 +8,6 @@
  * Generated by: https://openapi-generator.tech
  */
 
-///
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum SignMode {
     #[serde(rename = "PKCS1")]

diff --git a/src/models/switch.rs b/src/models/switch.rs
@@ -8,7 +8,6 @@
  * Generated by: https://openapi-generator.tech
  */
 
-///
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum Switch {
     #[serde(rename = "on")]

diff --git a/src/models/system_state.rs b/src/models/system_state.rs
@@ -8,7 +8,6 @@
  * Generated by: https://openapi-generator.tech
  */
 
-///
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum SystemState {
     #[serde(rename = "Unprovisioned")]

diff --git a/src/models/tls_key_type.rs b/src/models/tls_key_type.rs
@@ -8,7 +8,6 @@
  * Generated by: https://openapi-generator.tech
  */
 
-///
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum TlsKeyType {
     #[serde(rename = "RSA")]

diff --git a/src/models/user_role.rs b/src/models/user_role.rs
@@ -8,7 +8,6 @@
  * Generated by: https://openapi-generator.tech
  */
 
-///
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
 pub enum UserRole {
     #[serde(rename = "Administrator")]

diff --git a/tests/basic.rs b/tests/basic.rs
@@ -201,7 +201,7 @@ async fn test_restore() {
 }
 
 fn list_keys(config: &Configuration) -> BTreeSet<String> {
-    default_api::keys_get(&config, None)
+    default_api::keys_get(config, None)
         .unwrap()
         .entity
         .into_iter()
@@ -210,7 +210,7 @@ fn list_keys(config: &Configuration) -> BTreeSet<String> {
 }
 
 fn list_namespaces(config: &Configuration) -> BTreeSet<String> {
-    default_api::namespaces_get(&config)
+    default_api::namespaces_get(config)
         .unwrap()
         .entity
         .into_iter()