Refactor deprecation check to shared crdmanagement package (#4856)

For future re-use

Author: matthchr

v2/cmd/asoctl/internal/crd/cleaner.go

@@ -8,7 +8,6 @@ package crd
 import (
 	"context"
 	"fmt"
-	"regexp"
 	"strings"
 	"time"
 
@@ -96,7 +95,7 @@ func (c *Cleaner) Run(ctx context.Context) error {
 
 	for _, crd := range crds {
 		asoCRDsSeen++
-		newStoredVersions, deprecatedVersions := getDeprecatedStorageVersions(crd)
+		newStoredVersions, deprecatedVersions := crdmanagement.GetDeprecatedStorageVersions(crd)
 
 		// If there is no new version found other than the matched version, we short circuit here, as there is no updated version found in the CRDs
 		if len(newStoredVersions) <= 0 {
@@ -263,42 +262,3 @@ func (c *Cleaner) getObjectsForMigration(ctx context.Context, crd apiextensions.
 
 	return list, nil
 }
-
-var deprecatedVersionRegexp = regexp.MustCompile(`((v1alpha1api|v1beta)\d{8}(preview)?(storage)?|v1beta1)`) // handcrafted (non-ARM) resources have v1beta1 version
-
-// deprecatedVersionsMap is a map of crd name to a collection of deprecated versions
-var deprecatedVersionsMap = map[string][]string{
-	"trustedaccessrolebindings.containerservice.azure.com": {"v1api20230202previewstorage"},
-}
-
-func isVersionDeprecated(crd apiextensions.CustomResourceDefinition, version string) bool {
-	if deprecatedVersionRegexp.MatchString(version) {
-		return true
-	}
-
-	for _, deprecatedVersion := range deprecatedVersionsMap[crd.Name] {
-		if deprecatedVersion == version {
-			return true
-		}
-	}
-
-	return false
-}
-
-// getDeprecatedStorageVersions returns a new list of storedVersions by removing the deprecated versions
-func getDeprecatedStorageVersions(crd apiextensions.CustomResourceDefinition) ([]string, []string) {
-	storedVersions := crd.Status.StoredVersions
-
-	newStoredVersions := make([]string, 0, len(storedVersions))
-	var removedVersions []string
-	for _, version := range storedVersions {
-		if isVersionDeprecated(crd, version) {
-			removedVersions = append(removedVersions, version)
-			continue
-		}
-
-		newStoredVersions = append(newStoredVersions, version)
-	}
-
-	return newStoredVersions, removedVersions
-}

v2/internal/crdmanagement/deprecation.go

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT license.
+ */
+
+package crdmanagement
+
+import (
+	"regexp"
+
+	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+)
+
+var deprecatedVersionRegexp = regexp.MustCompile(`((v1alpha1api|v1beta)\d{8}(preview)?(storage)?|v1beta1)`) // handcrafted (non-ARM) resources have v1beta1 version
+
+// deprecatedVersionsMap is a map of crd name to a collection of deprecated versions
+var deprecatedVersionsMap = map[string][]string{
+	"trustedaccessrolebindings.containerservice.azure.com": {"v1api20230202previewstorage"},
+}
+
+// IsVersionDeprecated checks if a given version of a CRD is deprecated.
+func IsVersionDeprecated(crd apiextensions.CustomResourceDefinition, version string) bool {
+	if deprecatedVersionRegexp.MatchString(version) {
+		return true
+	}
+
+	for _, deprecatedVersion := range deprecatedVersionsMap[crd.Name] {
+		if deprecatedVersion == version {
+			return true
+		}
+	}
+
+	return false
+}
+
+// GetDeprecatedStorageVersions returns a new list of storedVersions by removing the deprecated versions
+// The first return value is the list of versions that are NOT deprecated.
+// The second return value is the list of versions that ARE deprecated.
+func GetDeprecatedStorageVersions(crd apiextensions.CustomResourceDefinition) ([]string, []string) {
+	storedVersions := crd.Status.StoredVersions
+
+	newStoredVersions := make([]string, 0, len(storedVersions))
+	var removedVersions []string
+	for _, version := range storedVersions {
+		if IsVersionDeprecated(crd, version) {
+			removedVersions = append(removedVersions, version)
+			continue
+		}
+
+		newStoredVersions = append(newStoredVersions, version)
+	}
+
+	return newStoredVersions, removedVersions
+}