chore: Add rustfmt config (#956)

* chore: Add rustfmt config, apply formatting to code

* chore: Adjust pre-commit config file

Pre-commit now uses a local hook to validate formatting of Rust code.

* ci: Use nightly toolchain for pre-commit workflow

* test: Fix stderr output after test code changes

* chore: Apply suggestion

Co-authored-by: Sebastian Bernauer <[email protected]>

---------

Co-authored-by: Sebastian Bernauer <[email protected]>

Author: Techassi

.github/workflows/pr_pre-commit.yaml

@@ -6,7 +6,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
-  RUST_TOOLCHAIN_VERSION: "1.82.0"
+  RUST_TOOLCHAIN_VERSION: "nightly-2025-01-15"
   HADOLINT_VERSION: "v1.17.6"
 
 jobs:

.pre-commit-config.yaml

@@ -15,8 +15,6 @@ repos:
   - repo: https://github.com/doublify/pre-commit-rust
     rev: eeee35a89e69d5772bdee97db1a6a898467b686e # 1.0
     hooks:
-      - id: fmt
-        args: ["--all", "--", "--check"]
       - id: clippy
         args: ["--all-targets", "--", "-D", "warnings"]
   - repo: https://github.com/adrienverge/yamllint
@@ -53,3 +51,11 @@ repos:
         entry: .scripts/verify_crate_versions.sh
         stages: [pre-commit, pre-merge-commit, manual]
         pass_filenames: false
+
+      - id: rustfmt
+        name: rustfmt
+        language: system
+        # Pinning to a specific rustc version, so that we get consistent formatting
+        entry: cargo +nightly-2025-01-15 fmt --all -- --check
+        stages: [pre-commit]
+        pass_filenames: false

crates/k8s-version/src/api_version.rs

@@ -1,9 +1,8 @@
 use std::{cmp::Ordering, fmt::Display, str::FromStr};
 
-use snafu::{ResultExt, Snafu};
-
 #[cfg(feature = "darling")]
 use darling::FromMeta;
+use snafu::{ResultExt, Snafu};
 
 use crate::{Group, ParseGroupError, ParseVersionError, Version};
 
@@ -102,13 +101,12 @@ impl ApiVersion {
 
 #[cfg(test)]
 mod test {
-    use super::*;
-    use crate::Level;
-
-    use rstest::rstest;
-
     #[cfg(feature = "darling")]
     use quote::quote;
+    use rstest::rstest;
+
+    use super::*;
+    use crate::Level;
 
     #[cfg(feature = "darling")]
     fn parse_meta(tokens: proc_macro2::TokenStream) -> ::std::result::Result<syn::Meta, String> {

crates/k8s-version/src/level.rs

@@ -7,11 +7,10 @@ use std::{
     sync::LazyLock,
 };
 
-use regex::Regex;
-use snafu::{OptionExt, ResultExt, Snafu};
-
 #[cfg(feature = "darling")]
 use darling::FromMeta;
+use regex::Regex;
+use snafu::{OptionExt, ResultExt, Snafu};
 
 static LEVEL_REGEX: LazyLock<Regex> = LazyLock::new(|| {
     Regex::new(r"^(?P<identifier>[a-z]+)(?P<version>\d+)$").expect("failed to compile level regex")
@@ -158,14 +157,13 @@ impl FromMeta for Level {
 
 #[cfg(test)]
 mod test {
+    #[cfg(feature = "darling")]
+    use quote::quote;
     use rstest::rstest;
     use rstest_reuse::*;
 
     use super::*;
 
-    #[cfg(feature = "darling")]
-    use quote::quote;
-
     #[cfg(feature = "darling")]
     fn parse_meta(tokens: proc_macro2::TokenStream) -> ::std::result::Result<syn::Meta, String> {
         let attribute: syn::Attribute = syn::parse_quote!(#[#tokens]);

crates/k8s-version/src/version.rs

@@ -1,10 +1,9 @@
 use std::{cmp::Ordering, fmt::Display, num::ParseIntError, str::FromStr, sync::LazyLock};
 
-use regex::Regex;
-use snafu::{OptionExt, ResultExt, Snafu};
-
 #[cfg(feature = "darling")]
 use darling::FromMeta;
+use regex::Regex;
+use snafu::{OptionExt, ResultExt, Snafu};
 
 use crate::{Level, ParseLevelError};
 
@@ -117,14 +116,13 @@ impl Version {
 
 #[cfg(test)]
 mod test {
+    #[cfg(feature = "darling")]
+    use quote::quote;
     use rstest::rstest;
     use rstest_reuse::{apply, template};
 
     use super::*;
 
-    #[cfg(feature = "darling")]
-    use quote::quote;
-
     #[cfg(feature = "darling")]
     fn parse_meta(tokens: proc_macro2::TokenStream) -> ::std::result::Result<syn::Meta, String> {
         let attribute: syn::Attribute = syn::parse_quote!(#[#tokens]);

crates/stackable-certs/src/keys/ecdsa.rs

@@ -40,12 +40,11 @@ impl SigningKey {
 }
 
 impl CertificateKeypair for SigningKey {
-    type SigningKey = p256::ecdsa::SigningKey;
+    type Error = Error;
     type Signature = ecdsa::der::Signature<NistP256>;
+    type SigningKey = p256::ecdsa::SigningKey;
     type VerifyingKey = p256::ecdsa::VerifyingKey;
 
-    type Error = Error;
-
     fn signing_key(&self) -> &Self::SigningKey {
         &self.0
     }

crates/stackable-certs/src/keys/rsa.rs

@@ -60,10 +60,10 @@ impl SigningKey {
 }
 
 impl CertificateKeypair for SigningKey {
-    type SigningKey = rsa::pkcs1v15::SigningKey<sha2::Sha256>;
+    type Error = Error;
     type Signature = rsa::pkcs1v15::Signature;
+    type SigningKey = rsa::pkcs1v15::SigningKey<sha2::Sha256>;
     type VerifyingKey = rsa::pkcs1v15::VerifyingKey<sha2::Sha256>;
-    type Error = Error;
 
     fn signing_key(&self) -> &Self::SigningKey {
         &self.0

crates/stackable-certs/src/lib.rs

@@ -21,6 +21,8 @@
 #[cfg(feature = "rustls")]
 use std::ops::Deref;
 
+use snafu::Snafu;
+use x509_cert::{spki::EncodePublicKey, Certificate};
 #[cfg(feature = "rustls")]
 use {
     p256::pkcs8::EncodePrivateKey,
@@ -29,9 +31,6 @@ use {
     x509_cert::der::Encode,
 };
 
-use snafu::Snafu;
-use x509_cert::{spki::EncodePublicKey, Certificate};
-
 use crate::keys::CertificateKeypair;
 
 pub mod ca;

crates/stackable-operator/src/builder/configmap.rs

@@ -1,6 +1,7 @@
+use std::collections::BTreeMap;
+
 use k8s_openapi::{api::core::v1::ConfigMap, apimachinery::pkg::apis::meta::v1::ObjectMeta};
 use snafu::{OptionExt, Snafu};
-use std::collections::BTreeMap;
 
 type Result<T, E = Error> = std::result::Result<T, E>;
 
@@ -64,10 +65,10 @@ impl ConfigMapBuilder {
 
 #[cfg(test)]
 mod tests {
-    use crate::builder::{configmap::ConfigMapBuilder, meta::ObjectMetaBuilder};
-
     use std::collections::BTreeMap;
 
+    use crate::builder::{configmap::ConfigMapBuilder, meta::ObjectMetaBuilder};
+
     #[test]
     fn configmap_builder() {
         let mut data = BTreeMap::new();

crates/stackable-operator/src/builder/meta.rs

@@ -311,9 +311,10 @@ impl OwnerReferenceBuilder {
 
 #[cfg(test)]
 mod tests {
+    use k8s_openapi::api::core::v1::Pod;
+
     use super::*;
     use crate::builder::meta::ObjectMetaBuilder;
-    use k8s_openapi::api::core::v1::Pod;
 
     #[test]
     fn objectmeta_builder() {

crates/stackable-operator/src/builder/pdb.rs

@@ -209,10 +209,9 @@ mod tests {
     use schemars::JsonSchema;
     use serde::{Deserialize, Serialize};
 
+    use super::*;
     use crate::builder::meta::{ObjectMetaBuilder, OwnerReferenceBuilder};
 
-    use super::PodDisruptionBudgetBuilder;
-
     #[test]
     pub fn normal_build() {
         #[allow(deprecated)]

crates/stackable-operator/src/builder/pod/container.rs

@@ -1,8 +1,5 @@
 use std::fmt;
 
-#[cfg(doc)]
-use {k8s_openapi::api::core::v1::PodSpec, std::collections::BTreeMap};
-
 use indexmap::IndexMap;
 use k8s_openapi::api::core::v1::{
     ConfigMapKeySelector, Container, ContainerPort, EnvVar, EnvVarSource, Lifecycle,
@@ -11,6 +8,8 @@ use k8s_openapi::api::core::v1::{
 };
 use snafu::{ResultExt as _, Snafu};
 use tracing::instrument;
+#[cfg(doc)]
+use {k8s_openapi::api::core::v1::PodSpec, std::collections::BTreeMap};
 
 use crate::{
     commons::product_image_selection::ResolvedProductImage,

crates/stackable-operator/src/builder/pod/mod.rs

@@ -12,9 +12,11 @@ use k8s_openapi::{
 use snafu::{OptionExt, ResultExt, Snafu};
 use tracing::{instrument, warn};
 
-use crate::kvp::Labels;
 use crate::{
-    builder::meta::ObjectMetaBuilder,
+    builder::{
+        meta::ObjectMetaBuilder,
+        pod::volume::{ListenerOperatorVolumeSourceBuilder, ListenerReference, VolumeBuilder},
+    },
     commons::{
         affinity::StackableAffinity,
         product_image_selection::ResolvedProductImage,
@@ -23,11 +25,10 @@ use crate::{
             LIMIT_REQUEST_RATIO_CPU, LIMIT_REQUEST_RATIO_MEMORY,
         },
     },
+    kvp::Labels,
     time::Duration,
 };
 
-use self::volume::{ListenerOperatorVolumeSourceBuilder, ListenerReference, VolumeBuilder};
-
 pub mod container;
 pub mod resources;
 pub mod security;
@@ -633,6 +634,7 @@ mod tests {
     };
     use rstest::*;
 
+    use super::*;
     use crate::builder::{
         meta::ObjectMetaBuilder,
         pod::{
@@ -641,8 +643,6 @@ mod tests {
         },
     };
 
-    use super::*;
-
     // A simple [`Container`] with a name and image.
     #[fixture]
     fn dummy_container() -> Container {

crates/stackable-operator/src/builder/pod/security.rs

@@ -70,6 +70,7 @@ impl SecurityContextBuilder {
         sc.level = Some(level.into());
         self
     }
+
     pub fn se_linux_role(&mut self, role: impl Into<String>) -> &mut Self {
         let sc = self
             .security_context
@@ -201,6 +202,7 @@ impl PodSecurityContextBuilder {
             ));
         self
     }
+
     pub fn se_linux_role(&mut self, role: &str) -> &mut Self {
         self.pod_security_context.se_linux_options =
             Some(self.pod_security_context.se_linux_options.clone().map_or(
@@ -215,6 +217,7 @@ impl PodSecurityContextBuilder {
             ));
         self
     }
+
     pub fn se_linux_type(&mut self, type_: &str) -> &mut Self {
         self.pod_security_context.se_linux_options =
             Some(self.pod_security_context.se_linux_options.clone().map_or(
@@ -229,6 +232,7 @@ impl PodSecurityContextBuilder {
             ));
         self
     }
+
     pub fn se_linux_user(&mut self, user: &str) -> &mut Self {
         self.pod_security_context.se_linux_options =
             Some(self.pod_security_context.se_linux_options.clone().map_or(
@@ -335,9 +339,10 @@ impl PodSecurityContextBuilder {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
     use k8s_openapi::api::core::v1::{PodSecurityContext, SELinuxOptions, SeccompProfile, Sysctl};
 
+    use super::*;
+
     #[test]
     fn security_context_builder() {
         let mut builder = PodSecurityContextBuilder::new();

crates/stackable-operator/src/builder/pod/volume.rs

@@ -8,7 +8,6 @@ use k8s_openapi::{
     },
     apimachinery::pkg::api::resource::Quantity,
 };
-
 use snafu::{ResultExt, Snafu};
 use tracing::warn;
 
@@ -568,10 +567,12 @@ impl ListenerOperatorVolumeSourceBuilder {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use k8s_openapi::apimachinery::pkg::api::resource::Quantity;
     use std::collections::BTreeMap;
 
+    use k8s_openapi::apimachinery::pkg::api::resource::Quantity;
+
+    use super::*;
+
     #[test]
     fn builder() {
         let mut volume_builder = VolumeBuilder::new("name");

crates/stackable-operator/src/cli.rs

@@ -284,13 +284,14 @@ fn resolve_path<'a>(
 
 #[cfg(test)]
 mod tests {
-    use super::*;
+    use std::{env, fs::File};
+
     use clap::Parser;
     use rstest::*;
-    use std::env;
-    use std::fs::File;
     use tempfile::tempdir;
 
+    use super::*;
+
     const USER_PROVIDED_PATH: &str = "user_provided_path_properties.yaml";
     const DEPLOY_FILE_PATH: &str = "deploy_config_spec_properties.yaml";
     const DEFAULT_FILE_PATH: &str = "default_file_path_properties.yaml";