feat(stackable-versioned): Add support for modules (#891)

* chore: Add changelog entry

* chore: Update PR link in changelog

* refactor: Modularize token generation

This separates token generation code to be more
modular. Depending on the context, individual
parts of the code need to be placed in different
locations.

Two major refactors are the change of macro input
as well as moving module generation out of the
struct definition generation.

This commit doesn't include changes for enum
generation. This will be done in a separate commit.

* refactor: Use fully qualified From path

* refactor: Adjust enum generation code

* feat: Add support for modules

This commit contains a major rework of most parts of the attribute
macro to support attaching it to modules. Most of the previously
existing features are already in place. There are only two missing
features which will be added in follow-up commits: version specific
doc comments and merged CRD YAML support. Because of that, some
snapshot tests are failing.

* fix: Correctly emit automatically_derived and deprecated attributes

* fix: Skip From impls for enum if options are set

* fix: Correctly emit doc commens

* fix: Correctly emit merged_crd code

* fix: Correctly skip merged_crd generation

This also adds a test to validate that the relevant code is not
generated of the skip option is set.

* chore: Fix clippy errors

* test: Add module snapshot tests

* test: Update basic Kubernetes snapshot test

* doc: Fix doc comment links

* chore: Remove unused strum dependency

* ci(pre-commit): Update rust version and use stackabletech/actions/run-pre-commit

* fix: Correctly report missing Spec suffix

* test: Update compile-fail test cases

* chore: Update changelog

* ci(pre-commit): Add rust-src component

* ci(build): Bump Rust version

* chore: Apply suggestions

Co-authored-by: Nick <[email protected]>

* chore(test): Add comment about empty versioned attribute

* chore: Add missing doc comments for supported K8s arguments

* chore: Replace unwrap with expect

* chore: Adjust FIXME comment

* chore: Add explanation comment

* chore: Remove outdated comments

* chore: Add doc comment to validate_added_action function

* chore: Replace mustn't with must not in error message

* chore: Use concrete type instead of generic type in BTreeMapExt impl

* chore: Add doc comments

---------

Co-authored-by: Nick <[email protected]>

Author: Techassi

.github/workflows/build.yml

@@ -17,7 +17,7 @@ env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: '0'
   CARGO_PROFILE_DEV_DEBUG: '0'
-  RUST_TOOLCHAIN_VERSION: "1.81.0"
+  RUST_TOOLCHAIN_VERSION: "1.82.0"
   RUSTFLAGS: "-D warnings"
   RUSTDOCFLAGS: "-D warnings"
   RUST_LOG: "info"

.github/workflows/pr_pre-commit.yaml

@@ -6,7 +6,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
-  RUST_TOOLCHAIN_VERSION: "1.81.0"
+  RUST_TOOLCHAIN_VERSION: "1.82.0"
   HADOLINT_VERSION: "v1.17.6"
 
 jobs:
@@ -16,29 +16,10 @@ jobs:
       - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
+      - uses: stackabletech/actions/run-pre-commit@9bd13255f286e4b7a654617268abe1b2f37c3e0a # v0.3.0
         with:
-          python-version: '3.12'
-      - uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
-          components: rustfmt,clippy
-      - name: Setup Hadolint
-        shell: bash
-        run: |
-          set -euo pipefail
-
-          LOCATION_DIR="$HOME/.local/bin"
-          LOCATION_BIN="$LOCATION_DIR/hadolint"
-
-          SYSTEM=$(uname -s)
-          ARCH=$(uname -m)
-
-          mkdir -p "$LOCATION_DIR"
-          curl -sL -o "${LOCATION_BIN}" "https://github.com/hadolint/hadolint/releases/download/${{ env.HADOLINT_VERSION }}/hadolint-$SYSTEM-$ARCH"
-          chmod 700 "${LOCATION_BIN}"
-
-          echo "$LOCATION_DIR" >> "$GITHUB_PATH"
-      - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
-        with:
-          extra_args: "--from-ref ${{ github.event.pull_request.base.sha }} --to-ref ${{ github.event.pull_request.head.sha }}"
+          rust: ${{ env.RUST_TOOLCHAIN_VERSION }}
+          # rust-src is required for trybuild stderr output comparison to work
+          # for our cases.
+          # See: https://github.com/dtolnay/trybuild/issues/236#issuecomment-1620950759
+          rust-components: rustfmt,clippy,rust-src

Cargo.lock

@@ -38,7 +38,6 @@ itertools.workspace = true
 k8s-openapi = { workspace = true, optional = true }
 kube = { workspace = true, optional = true }
 proc-macro2.workspace = true
-strum.workspace = true
 syn.workspace = true
 quote.workspace = true
 

crates/stackable-versioned-macros/Cargo.toml

@@ -0,0 +1,23 @@
+#[versioned(
+    version(name = "v1alpha1"),
+    version(name = "v1"),
+    version(name = "v2alpha1")
+)]
+// ---
+pub(crate) mod versioned {
+    pub struct Foo {
+        bar: usize,
+
+        #[versioned(added(since = "v1"))]
+        baz: bool,
+
+        #[versioned(deprecated(since = "v2alpha1"))]
+        deprecated_foo: String,
+    }
+
+    // The following attribute is just to ensure no strange behavior occurs.
+    #[versioned]
+    pub struct Bar {
+        baz: String,
+    }
+}

crates/stackable-versioned-macros/fixtures/inputs/default/module.rs

@@ -0,0 +1,23 @@
+#[versioned(
+    version(name = "v1alpha1"),
+    version(name = "v1"),
+    version(name = "v2alpha1"),
+    preserve_module
+)]
+// ---
+pub(crate) mod versioned {
+    pub struct Foo {
+        bar: usize,
+
+        #[versioned(added(since = "v1"))]
+        baz: bool,
+
+        #[versioned(deprecated(since = "v2alpha1"))]
+        deprecated_foo: String,
+    }
+
+    #[versioned]
+    pub struct Bar {
+        baz: String,
+    }
+}

crates/stackable-versioned-macros/fixtures/inputs/default/module_preserve.rs

@@ -0,0 +1,22 @@
+#[versioned(
+    version(name = "v1alpha1"),
+    version(name = "v1beta1"),
+    version(name = "v1"),
+    k8s(
+        group = "stackable.tech",
+        singular = "foo",
+        plural = "foos",
+        namespaced,
+        skip(merged_crd)
+    )
+)]
+// ---
+#[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
+pub struct FooSpec {
+    #[versioned(
+        added(since = "v1beta1"),
+        changed(since = "v1", from_name = "bah", from_type = "u16")
+    )]
+    bar: usize,
+    baz: bool,
+}