Add plural names support to GetOpTypeAndResourceNameFromOpID (#223)

Issue #, if available: [#999](aws-controllers-k8s/community#999)

Description of changes:
* Heuristic to guess resource name will not singularize the resource, if defined in generator resource config. This is to support resources like EC2's DhcpOptions where there is no singular form of the resource.
* unit test

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Author: brycahta

pkg/model/op.go

@@ -18,6 +18,8 @@ import (
 
 	awssdkmodel "github.com/aws/aws-sdk-go/private/model/api"
 	"github.com/gertd/go-pluralize"
+
+	ackgenconfig "github.com/aws-controllers-k8s/code-generator/pkg/generate/config"
 )
 
 type OpType int
@@ -43,26 +45,42 @@ type OperationMap map[OpType]map[string]*awssdkmodel.Operation
 
 // GetOpTypeAndResourceNameFromOpID guesses the resource name and type of
 // operation from the OperationID
-func GetOpTypeAndResourceNameFromOpID(opID string) (OpType, string) {
+func GetOpTypeAndResourceNameFromOpID(
+	opID string,
+	cfg *ackgenconfig.Config,
+) (OpType, string) {
 	pluralize := pluralize.NewClient()
 	if strings.HasPrefix(opID, "CreateOrUpdate") {
 		return OpTypeReplace, strings.TrimPrefix(opID, "CreateOrUpdate")
 	} else if strings.HasPrefix(opID, "BatchCreate") {
 		resName := strings.TrimPrefix(opID, "BatchCreate")
 		if pluralize.IsPlural(resName) {
-			return OpTypeCreateBatch, pluralize.Singular(resName)
+			// Do not singularize "pluralized singular" resources
+			// like EC2's DhcpOptions, if defined in generator config's list of
+			// resources.
+			if _, exists := cfg.Resources[resName]; !exists {
+				return OpTypeCreateBatch, pluralize.Singular(resName)
+			}
 		}
 		return OpTypeCreateBatch, resName
 	} else if strings.HasPrefix(opID, "CreateBatch") {
 		resName := strings.TrimPrefix(opID, "CreateBatch")
 		if pluralize.IsPlural(resName) {
-			return OpTypeCreateBatch, pluralize.Singular(resName)
+			if _, exists := cfg.Resources[resName]; !exists {
+				return OpTypeCreateBatch, pluralize.Singular(resName)
+			}
 		}
 		return OpTypeCreateBatch, resName
 	} else if strings.HasPrefix(opID, "Create") {
 		resName := strings.TrimPrefix(opID, "Create")
 		if pluralize.IsPlural(resName) {
-			return OpTypeCreateBatch, pluralize.Singular(resName)
+			// If resName exists in the generator configuration's list of
+			// resources, then just return OpTypeCreate and the resource name.
+			// This handles "pluralized singular" resource names like EC2's
+			// DhcpOptions.
+			if _, exists := cfg.Resources[resName]; !exists {
+				return OpTypeCreateBatch, pluralize.Singular(resName)
+			}
 		}
 		return OpTypeCreate, resName
 	} else if strings.HasPrefix(opID, "Modify") {
@@ -74,7 +92,10 @@ func GetOpTypeAndResourceNameFromOpID(opID string) (OpType, string) {
 	} else if strings.HasPrefix(opID, "Describe") {
 		resName := strings.TrimPrefix(opID, "Describe")
 		if pluralize.IsPlural(resName) {
-			return OpTypeList, pluralize.Singular(resName)
+			if _, exists := cfg.Resources[resName]; !exists {
+				return OpTypeList, pluralize.Singular(resName)
+			}
+			return OpTypeList, resName
 		}
 		return OpTypeGet, resName
 	} else if strings.HasPrefix(opID, "Get") {
@@ -85,12 +106,20 @@ func GetOpTypeAndResourceNameFromOpID(opID string) (OpType, string) {
 		}
 		resName := strings.TrimPrefix(opID, "Get")
 		if pluralize.IsPlural(resName) {
-			return OpTypeList, pluralize.Singular(resName)
+			if _, exists := cfg.Resources[resName]; !exists {
+				return OpTypeList, pluralize.Singular(resName)
+			}
+			return OpTypeList, resName
 		}
 		return OpTypeGet, resName
 	} else if strings.HasPrefix(opID, "List") {
 		resName := strings.TrimPrefix(opID, "List")
-		return OpTypeList, pluralize.Singular(resName)
+		if pluralize.IsPlural(resName) {
+			if _, exists := cfg.Resources[resName]; !exists {
+				return OpTypeList, pluralize.Singular(resName)
+			}
+		}
+		return OpTypeList, resName
 	} else if strings.HasPrefix(opID, "Set") {
 		if strings.HasSuffix(opID, "Attributes") {
 			resName := strings.TrimPrefix(opID, "Set")

pkg/model/op_test.go

@@ -16,13 +16,17 @@ package model_test
 import (
 	"testing"
 
-	"github.com/aws-controllers-k8s/code-generator/pkg/model"
 	"github.com/stretchr/testify/assert"
+
+	"github.com/aws-controllers-k8s/code-generator/pkg/model"
+	"github.com/aws-controllers-k8s/code-generator/pkg/testutil"
 )
 
 func TestGetOpTypeAndResourceNameFromOpID(t *testing.T) {
 	assert := assert.New(t)
 
+	g := testutil.NewModelForService(t, "s3")
+
 	tests := []struct {
 		opID       string
 		expOpType  model.OpType
@@ -103,9 +107,54 @@ func TestGetOpTypeAndResourceNameFromOpID(t *testing.T) {
 			model.OpTypeUnknown,
 			"PauseEC2Instance",
 		},
+		// Heuristic should incorrectly parse DhcpOptions ops
+		// due to resource not being in s3's generator config
+		{
+			"CreateDhcpOptions",
+			model.OpTypeCreateBatch,
+			"DhcpOption",
+		},
+		{
+			"DescribeDhcpOptions",
+			model.OpTypeList,
+			"DhcpOption",
+		},
+	}
+	for _, test := range tests {
+		ot, resName := model.GetOpTypeAndResourceNameFromOpID(test.opID, g.GetConfig())
+		assert.Equal(test.expOpType, ot, test.opID)
+		assert.Equal(test.expResName, resName, test.opID)
+	}
+}
+
+func TestGetOpTypeAndResourceNameFromOpID_PluralSingular(t *testing.T) {
+	assert := assert.New(t)
+
+	g := testutil.NewModelForService(t, "ec2")
+
+	tests := []struct {
+		opID       string
+		expOpType  model.OpType
+		expResName string
+	}{
+		{
+			"CreateDhcpOptions",
+			model.OpTypeCreate,
+			"DhcpOptions",
+		},
+		{
+			"DescribeDhcpOptions",
+			model.OpTypeList,
+			"DhcpOptions",
+		},
+		{
+			"DeleteDhcpOptions",
+			model.OpTypeDelete,
+			"DhcpOptions",
+		},
 	}
 	for _, test := range tests {
-		ot, resName := model.GetOpTypeAndResourceNameFromOpID(test.opID)
+		ot, resName := model.GetOpTypeAndResourceNameFromOpID(test.opID, g.GetConfig())
 		assert.Equal(test.expOpType, ot, test.opID)
 		assert.Equal(test.expResName, resName, test.opID)
 	}

pkg/model/sdk_helper.go

@@ -382,7 +382,7 @@ func (a *SDKAPI) APIInterfaceTypeName() string {
 
 // Override the operation type and/or resource name if specified in config
 func getOpTypeAndResourceName(opID string, cfg *ackgenconfig.Config) ([]OpType, string) {
-	opType, resName := GetOpTypeAndResourceNameFromOpID(opID)
+	opType, resName := GetOpTypeAndResourceNameFromOpID(opID, cfg)
 	opTypes := []OpType{opType}
 
 	if cfg == nil {

pkg/testdata/models/apis/ec2/0000-00-00/generator.yaml

@@ -1,6 +1,7 @@
 ignore:
   field_paths:
     - CreateVpcInput.DryRun
+    - CreateDhcpOptionsInput.DryRun
   resource_names:
     - AccountAttribute
     - CapacityReservation
@@ -10,6 +11,7 @@ ignore:
     - CustomerGateway
     - DefaultSubnet
     - DefaultVpc
+    #- DhcpOptions
     - EgressOnlyInternetGateway
     - Fleet
     - FpgaImage
@@ -63,4 +65,7 @@ ignore:
 
 operations:
   CreateVpcEndpoint:
-    output_wrapper_field_path: VpcEndpoint
+    output_wrapper_field_path: VpcEndpoint
+
+resources:
+  DhcpOptions: