fix(stackable-versioned): Check whether to skip all from impls when versioning a module (#926)

* fix(stackable-versioned): Check whether to skip all from impls when versioning a module

* test(stackable-versioned): Ensure from impls are skipped when versioning a module with applicable skip options

* chore(stackable-versioned): Correctly name a test

* chore(stackable-versioned): Update changelog

* chore(stackable-versioned): Remove space from test filename

Author: NickLarsenNZ

crates/stackable-versioned-macros/fixtures/inputs/default/skip_from_field.rs renamed to crates/stackable-versioned-macros/fixtures/inputs/default/skip_from_for_version.rs

@@ -0,0 +1,14 @@
+#[versioned(
+    version(name = "v1alpha1"),
+    version(name = "v1beta1"),
+    options(skip(from))
+)]
+// ---
+pub(crate) mod versioned {
+    pub struct Foo {
+        bar: usize,
+
+        #[versioned(added(since = "v1beta1"))]
+        baz: bool,
+    }
+}

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

@@ -0,0 +1,21 @@
+#[versioned(
+    version(name = "v1alpha1"),
+    version(name = "v1beta1", skip(from)),
+    version(name = "v1")
+)]
+// ---
+pub(crate) mod versioned {
+    pub struct Foo {
+        bar: usize,
+
+        #[versioned(added(since = "v1beta1"))]
+        baz: bool,
+    }
+
+    pub struct Bar {
+        foo: usize,
+
+        #[versioned(added(since = "v1beta1"))]
+        faz: bool,
+    }
+}

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

@@ -182,6 +182,8 @@ impl ChangesetExt for BTreeMap<Version, ItemStatus> {
                             ty,
                             ..
                         } => (ident, ty, *previously_deprecated),
+                        // TODO (@NickLarsenNZ): Explain why it is unreachable, as it can be reached during testing.
+                        // To reproduce, use an invalid version, eg: #[versioned(deprecated(since = "v99"))]
                         _ => unreachable!(),
                     };
 

crates/stackable-versioned-macros/fixtures/snapshots/stackable_versioned_macros__test__default_snapshots@skip_from_field.rs.snap renamed to crates/stackable-versioned-macros/fixtures/snapshots/stackable_versioned_macros__test__default_snapshots@skip_from_for_version.rs.snap

@@ -22,6 +22,7 @@ pub(crate) struct Module {
     versions: Vec<VersionDefinition>,
     containers: Vec<Container>,
     preserve_module: bool,
+    skip_from: bool,
     ident: IdentString,
     vis: Visibility,
 }
@@ -31,13 +32,15 @@ impl Module {
     pub(crate) fn new(
         ModuleInput { ident, vis, .. }: ModuleInput,
         preserve_module: bool,
+        skip_from: bool,
         versions: Vec<VersionDefinition>,
         containers: Vec<Container>,
     ) -> Self {
         Self {
             ident: ident.into(),
             preserve_module,
             containers,
+            skip_from,
             versions,
             vis,
         }
@@ -77,11 +80,13 @@ impl Module {
             for container in &self.containers {
                 container_definitions.extend(container.generate_definition(version));
 
-                from_impls.extend(container.generate_from_impl(
-                    version,
-                    versions.peek().copied(),
-                    self.preserve_module,
-                ));
+                if !self.skip_from {
+                    from_impls.extend(container.generate_from_impl(
+                        version,
+                        versions.peek().copied(),
+                        self.preserve_module,
+                    ));
+                }
 
                 // Generate Kubernetes specific code which is placed outside of the container
                 // definition.

crates/stackable-versioned-macros/fixtures/snapshots/stackable_versioned_macros__test__default_snapshots@skip_from_module.rs.snap

@@ -507,6 +507,12 @@ fn versioned_impl(attrs: proc_macro2::TokenStream, input: Item) -> proc_macro2::
 
             let versions: Vec<VersionDefinition> = (&module_attributes).into();
             let preserve_modules = module_attributes.preserve_module.is_present();
+            let skip_from = module_attributes
+                .common_root_arguments
+                .options
+                .skip
+                .as_ref()
+                .map_or(false, |opts| opts.from.is_present());
 
             let module_span = item_mod.span();
             let module_input = ModuleInput {
@@ -541,7 +547,14 @@ fn versioned_impl(attrs: proc_macro2::TokenStream, input: Item) -> proc_macro2::
                 containers.push(container);
             }
 
-            Module::new(module_input, preserve_modules, versions, containers).generate_tokens()
+            Module::new(
+                module_input,
+                preserve_modules,
+                skip_from,
+                versions,
+                containers,
+            )
+            .generate_tokens()
         }
         Item::Enum(item_enum) => {
             let container_attributes: StandaloneContainerAttributes =

crates/stackable-versioned-macros/fixtures/snapshots/stackable_versioned_macros__test__default_snapshots@skip_from_module_for_version.rs.snap

@@ -31,6 +31,7 @@ All notable changes to this project will be documented in this file.
 - Correctly emit Kubernetes code when macro is used on modules ([#912]).
 - Use `.into()` on all field conversions ([#925]).
 - Remove invalid type comparison on field conversion because the semantics are unknown ([#925]).
+- Check whether to skip all from impls when versioning a module ([#926]).
 
 [#891]: https://github.com/stackabletech/operator-rs/pull/891
 [#912]: https://github.com/stackabletech/operator-rs/pull/912
@@ -42,6 +43,7 @@ All notable changes to this project will be documented in this file.
 [#923]: https://github.com/stackabletech/operator-rs/pull/923
 [#924]: https://github.com/stackabletech/operator-rs/pull/924
 [#925]: https://github.com/stackabletech/operator-rs/pull/925
+[#926]: https://github.com/stackabletech/operator-rs/pull/926
 
 ## [0.4.1] - 2024-10-23