Mark an unserved API as served (#268)

It's possible that after marking an API as unserved and doing a release, there
will be a need to follow-up that release with a variation of it that does serve
that API. And maybe the commit that did the "unserve" step is buried under
other things and is not easily reverted. In that case, use the `re-serve.py`
tool.

Signed-off-by: Dean Roehrich <dean.roehrich@hpe.com>

Author: roehrich-hpe

tools/crd-bumper/pkg/git_cli.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Hewlett Packard Enterprise Development LP
+# Copyright 2024-2025 Hewlett Packard Enterprise Development LP
 # Other additional copyright holders may be indicated within.
 #
 # The entirety of this work is licensed under the Apache License,
@@ -31,13 +31,16 @@ def __init__(self, dryrun, nocommit):
             nocommit = True
         self._nocommit = nocommit
 
-    def checkout_branch(self, branch):
+    def checkout_branch(self, branch, create_branch=True):
         """Checkout a named branch."""
 
         if branch in ["main", "master", "releases/v0"]:
             raise ValueError("Branch name must not be main, master, or releases/v0")
         self.verify_clean()
-        cmd = f"git checkout -b {branch}"
+        args = ""
+        if create_branch:
+            args = "-b"
+        cmd = f"git checkout {args} {branch}"
         if self._dryrun:
             print(f"Dryrun: {cmd}")
         else:

tools/crd-bumper/pkg/unserve.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Hewlett Packard Enterprise Development LP
+# Copyright 2024-2025 Hewlett Packard Enterprise Development LP
 # Other additional copyright holders may be indicated within.
 #
 # The entirety of this work is licensed under the Apache License,
@@ -128,3 +128,79 @@ def commit(self, git, stage):
   pass.
 """
         git.commit_stage(stage, msg)
+
+
+class ReServe(Unserve):
+    """Tools to mark an API as served, after it has been marked as unserved."""
+
+    def __init__(self, dryrun, project, spoke_ver, preferred_alias):
+        super().__init__(dryrun, project, spoke_ver, preferred_alias)
+        self.in_re_serve = True
+
+    def set_served(self):
+        """
+        Remove the kubebuilder:unservedversion marker in the specified spoke API,
+        for any Kind that has it.
+        """
+
+        kinds = self._project.kinds(self._spoke_ver)
+        for kind in kinds:
+            fname = f"api/{self._spoke_ver}/{kind.lower()}_types.go"
+            if os.path.isfile(fname):
+                fu = FileUtil(self._dryrun, fname)
+                line = fu.find_in_file("+kubebuilder:unservedversion")
+                if not line:
+                    continue
+                if fu.delete_from_file(line):
+                    fu.store()
+
+    def modify_conversion_webhook_suite_test(self):
+        """
+        Modify the suite test that exercises the conversion webhook.
+
+        Update the tests for the specified spoke API.
+        """
+
+        conv_go = "internal/controller/conversion_test.go"
+        if not os.path.isfile(conv_go):
+            print(f"NOTE: Unable to find {conv_go}!")
+            return
+
+        fu = FileUtil(self._dryrun, conv_go)
+
+        # Pattern to find the "PIt()" method so we can change it to "It()".
+        pit_pat = r"^(\s+)PIt(\(.*)"
+        it_pat = r"^(\s+)It(\(.*)"
+        kinds = self._project.kinds(self._spoke_ver)
+        for kind in kinds:
+            spec = fu.find_in_file(
+                f"""PIt("reads {kind} resource via hub and via spoke {self._spoke_ver}", func()"""
+            )
+            if spec is not None:
+                newspec = spec
+                m = re.search(pit_pat, spec)
+                if m is not None:
+                    newspec = f"{m.group(1)}It{m.group(2)}"
+                    fu.replace_in_file(spec, newspec)
+
+            spec = fu.find_in_file(
+                f"""It("is unable to read {kind} resource via spoke {self._spoke_ver}", func()"""
+            )
+            if spec is not None:
+                newspec = spec
+                m = re.search(it_pat, spec)
+                if m is not None:
+                    newspec = f"{m.group(1)}PIt{m.group(2)}"
+                    fu.replace_in_file(spec, newspec)
+        fu.store()
+
+    def commit(self, git, stage):
+        """Create a commit message."""
+
+        msg = f"""Remove the unserved marker from the {self._spoke_ver} API.
+
+ACTION: Begin by running "make vet". Repair any issues that it finds.
+  Then run "make test" and continue repairing issues until the tests
+  pass.
+"""
+        git.commit_stage(stage, msg)

tools/crd-bumper/re-serve.py

@@ -0,0 +1,149 @@
+#!/usr/bin/env python3
+
+# Copyright 2025 Hewlett Packard Enterprise Development LP
+# Other additional copyright holders may be indicated within.
+#
+# The entirety of this work is licensed under the Apache License,
+# Version 2.0 (the "License"); you may not use this file except
+# in compliance with the License.
+#
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Mark the specified CRD version as served, after it had been marked as unserved."""
+
+import argparse
+import sys
+
+from pkg.conversion_gen import ConversionGen
+from pkg.git_cli import GitCLI
+from pkg.make_cmd import MakeCmd
+from pkg.project import Project
+from pkg.unserve import ReServe
+from pkg.hub_spoke_util import HubSpokeUtil
+
+WORKING_DIR = "workingspace"
+BRANCH_SUFFIX = "re-serve"
+
+PARSER = argparse.ArgumentParser()
+PARSER.add_argument(
+    "--spoke-ver",
+    type=str,
+    required=True,
+    help="Spoke API version to mark as served.",
+)
+PARSER.add_argument(
+    "--repo",
+    "-r",
+    type=str,
+    required=True,
+    help="Git repository URL which has the Go code that provides the APIs.",
+)
+PARSER.add_argument(
+    "--start-branch",
+    type=str,
+    help="Branch or tag to checkout first, if not master.",
+)
+PARSER.add_argument(
+    "--branch",
+    "-b",
+    type=str,
+    required=False,
+    help=f"Branch name to create. Default is 'api-<spoke_ver>-{BRANCH_SUFFIX}'",
+)
+PARSER.add_argument(
+    "--this-branch",
+    action="store_true",
+    dest="this_branch",
+    help="Continue working in the current branch.",
+)
+PARSER.add_argument(
+    "--dry-run",
+    "-n",
+    action="store_true",
+    dest="dryrun",
+    help="Dry run. Implies only one step.",
+)
+PARSER.add_argument(
+    "--no-commit",
+    "-C",
+    action="store_true",
+    dest="nocommit",
+    help="Skip git-commit. Implies only one step.",
+)
+PARSER.add_argument(
+    "--workdir",
+    type=str,
+    required=False,
+    default=WORKING_DIR,
+    help=f"Name for working directory. All repos will be cloned below this directory. Default: {WORKING_DIR}.",
+)
+
+
+def main():
+    """main"""
+
+    args = PARSER.parse_args()
+
+    gitcli = GitCLI(args.dryrun, args.nocommit)
+    gitcli.clone_and_cd(args.repo, args.workdir)
+    if args.start_branch is not None:
+        gitcli.checkout_branch(args.start_branch, False)
+
+    project = Project(args.dryrun)
+
+    cgen = ConversionGen(args.dryrun, project, args.spoke_ver, None, None)
+    makecmd = MakeCmd(args.dryrun, None, None, None)
+
+    if args.branch is None:
+        args.branch = f"api-{args.spoke_ver}-{BRANCH_SUFFIX}"
+    if args.this_branch:
+        print("Continuing work in current branch")
+    else:
+        print(f"Creating branch {args.branch}")
+        try:
+            gitcli.checkout_branch(args.branch)
+        except RuntimeError as ex:
+            print(str(ex))
+            print(
+                "If you are continuing in an existing branch, then specify `--this-branch`."
+            )
+            sys.exit(1)
+
+    if not HubSpokeUtil.is_spoke(args.spoke_ver):
+        print(f"API --spoke-ver {args.spoke_ver} is not a spoke.")
+        sys.exit(1)
+
+    re_serve_api(args, project, makecmd, gitcli, cgen.preferred_api_alias())
+
+
+def re_serve_api(args, project, makecmd, git, preferred_api_alias):
+    """Mark the specified API version as served."""
+
+    re_serve = ReServe(args.dryrun, project, args.spoke_ver, preferred_api_alias)
+
+    print(f"Updating files to mark API {args.spoke_ver} as served.")
+
+    re_serve.set_served()
+    re_serve.modify_conversion_webhook_suite_test()
+
+    makecmd.manifests()
+    makecmd.generate()
+    makecmd.generate_go_conversions()
+    makecmd.fmt()
+    makecmd.clean_bin()
+
+    re_serve.commit(git, "re-serve-api")
+
+
+if __name__ == "__main__":
+    main()
+
+sys.exit(0)