APIM: Delete subscriptions when deleting products (#3467)

* Removed Restore from tests

* Create pull Request from vscode

* Delete subscription when you delete Product

* Wrong comment

* Add recording

* Update v2/api/apimanagement/customizations/product_extensions.go

Co-authored-by: Bevan Arps <bevan.arps@outlook.com>

* Comments from PR review

---------

Co-authored-by: Bevan Arps <bevan.arps@outlook.com>

.devcontainer/devcontainer.json

@@ -16,7 +16,8 @@
 				"ms-azuretools.vscode-docker",
 				"redhat.vscode-yaml",
 				"ms-kubernetes-tools.vscode-kubernetes-tools",
-				"task.vscode-task"
+				"task.vscode-task",
+				"github.vscode-pull-request-github"
 			],
 			"settings": {
 				"terminal.integrated.defaultProfile.linux": "bash",

v2/api/apimanagement/customizations/product_extensions.go

@@ -0,0 +1,75 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+package customizations
+
+import (
+	"context"
+
+	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
+	"github.com/go-logr/logr"
+	"github.com/pkg/errors"
+	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/conversion"
+
+	storage "github.com/Azure/azure-service-operator/v2/api/apimanagement/v1api20220801storage"
+	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
+	"github.com/Azure/azure-service-operator/v2/internal/resolver"
+	"github.com/Azure/azure-service-operator/v2/internal/util/to"
+	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"
+	"github.com/Azure/azure-service-operator/v2/pkg/genruntime/extensions"
+)
+
+var _ extensions.Deleter = &ProductExtension{}
+
+func (extension *ProductExtension) Delete(
+	ctx context.Context,
+	log logr.Logger,
+	resolver *resolver.Resolver,
+	armClient *genericarmclient.GenericClient,
+	obj genruntime.ARMMetaObject,
+	next extensions.DeleteFunc) (ctrl.Result, error) {
+
+	typedObj, ok := obj.(*storage.Product)
+	if !ok {
+		return ctrl.Result{}, errors.Errorf("cannot run on unknown resource type %T, expected *apiManagement.Product", obj)
+	}
+
+	// Type assert that we are the hub type. This will fail to compile if
+	// the hub type has been changed but this extension has not been updated to match
+	var _ conversion.Hub = typedObj
+
+	productName := typedObj.GetName()
+	id, err := genruntime.GetAndParseResourceID(typedObj)
+	if err != nil {
+		return ctrl.Result{}, errors.Wrapf(err, "failed to get the ARM ResourceId for %s", productName)
+	}
+
+	if id.Parent == nil {
+		return ctrl.Result{}, errors.Wrapf(err, ". APIM Product had no parent ID: %s", id.String())
+	}
+	parentName := id.Parent.Name
+
+	// Using armClient.ClientOptions() here ensures we share the same HTTP connection, so this is not opening a new
+	// connection each time through
+	clientFactory, err := armapimanagement.NewClientFactory(id.SubscriptionID, armClient.Creds(), armClient.ClientOptions())
+	if err != nil {
+		return ctrl.Result{}, errors.Wrapf(err, "failed to create new apimClient")
+	}
+
+	// This is a synchronous operation
+	_, err = clientFactory.NewProductClient().Delete(
+		ctx,
+		id.ResourceGroupName,
+		parentName,
+		productName,
+		"*",
+		&armapimanagement.ProductClientDeleteOptions{
+			DeleteSubscriptions: to.Ptr(true),
+		})
+	if err != nil {
+		return ctrl.Result{}, errors.Wrapf(err, "failed to delete product %q", productName)
+	}
+
+	return next(ctx, log, resolver, armClient, obj)
+}

v2/internal/controllers/crd_apimanagement_20220801_test.go

@@ -51,13 +51,12 @@ func Test_ApiManagement_20220801_CRUD(t *testing.T) {
 			PublisherEmail: to.Ptr("ASO@testing.com"),
 			PublisherName:  to.Ptr("ASOTesting"),
 			Sku:            &sku,
-			Restore:        to.Ptr(true),
 		},
 	}
 
 	// APIM takes a long time to provision. When you are authoring tests in this file. I
 	// recommend you change this line to CreateResourceAndWaitWithoutCleanup.
-	tc.CreateResourcesAndWait(&service)
+	tc.CreateResourceAndWait(&service)
 
 	tc.Expect(service.Status.Id).ToNot(BeNil())
 
@@ -100,13 +99,12 @@ func Test_ApiManagement_20220801_CRUD(t *testing.T) {
 				APIM_Policy_CRUD(tc, &service)
 			},
 		},
-		// TODO: https://github.com/Azure/azure-service-operator/issues/3408
-		// testcommon.Subtest{
-		//      Name: "APIM Product CRUD",
-		//      Test: func(tc *testcommon.KubePerTestContext) {
-		//              APIM_Product_CRUD(tc, &service)
-		//      },
-		// },
+		testcommon.Subtest{
+			Name: "APIM Product CRUD",
+			Test: func(tc *testcommon.KubePerTestContext) {
+				APIM_Product_CRUD(tc, &service)
+			},
+		},
 		testcommon.Subtest{
 			Name: "APIM Api CRUD",
 			Test: func(tc *testcommon.KubePerTestContext) {
@@ -266,8 +264,9 @@ func APIM_Product_CRUD(tc *testcommon.KubePerTestContext, service client.Object)
 	tc.Expect(product.Status).ToNot(BeNil())
 	tc.Expect(product.Status.Id).ToNot(BeNil())
 
-	// The product would have created a subscription, so we need to delete that first
-	// Pass in deleteSubscription = true
+	// The product would have created a subscription automatically,
+	// we have had to extend (products_extensions.go) to pass the following option
+	// deleteSubscription = true
 
 	defer tc.DeleteResourceAndWait(&product)