APIGOV-32421 - strip unwanted tags

Author: dgghinea

pkg/apic/servicebody.go

@@ -55,6 +55,7 @@ type ServiceBody struct {
 	ardName                      string
 	uniqueARD                    bool
 	ignoreSpecBasesCreds         bool
+	ignoreSpecTags               []string
 	stripOASExtensions           bool
 	stripOASServersBeforePublish bool
 	specHash                     string

pkg/apic/servicebuilder.go

@@ -55,6 +55,7 @@ type ServiceBuilder interface {
 	AddCredentialRequestDefinition(credentialRequestDefName string) ServiceBuilder
 	SetAccessRequestDefinitionName(accessRequestDefName string, isUnique bool) ServiceBuilder
 	SetIgnoreSpecBasedCreds(ignore bool) ServiceBuilder
+	SetIgnoreSpecTags(tags []string) ServiceBuilder
 	SetStripOASExtensions(strip bool) ServiceBuilder
 	SetStripOASServersBeforePublish() ServiceBuilder
 
@@ -383,6 +384,14 @@ func (b *serviceBodyBuilder) Build() (ServiceBody, error) {
 	if b.serviceBody.stripOASServersBeforePublish {
 		b.serviceBody.originalSpecHash = b.serviceBody.specHash
 		val.stripEndpoints()
+	}
+
+	if len(b.serviceBody.ignoreSpecTags) > 0 {
+		b.serviceBody.originalSpecHash = b.serviceBody.specHash
+		val.stripTags(b.serviceBody.ignoreSpecTags)
+	}
+
+	if b.serviceBody.stripOASServersBeforePublish || len(b.serviceBody.ignoreSpecTags) > 0 {
 		b.serviceBody.SpecDefinition = val.GetSpecBytes()
 		newHash, _ := util.ComputeHash(val.GetSpecBytes())
 		b.serviceBody.specHash = fmt.Sprintf("%v", newHash)
@@ -435,6 +444,11 @@ func (b *serviceBodyBuilder) SetIgnoreSpecBasedCreds(ignore bool) ServiceBuilder
 	return b
 }
 
+func (b *serviceBodyBuilder) SetIgnoreSpecTags(tags []string) ServiceBuilder {
+	b.serviceBody.ignoreSpecTags = tags
+	return b
+}
+
 func (b *serviceBodyBuilder) SetStripOASServersBeforePublish() ServiceBuilder {
 	b.serviceBody.stripOASServersBeforePublish = true
 	return b

pkg/apic/servicebuilder_test.go

@@ -85,6 +85,7 @@ func TestServiceBodySetters(t *testing.T) {
 		SetIgnoreSpecBasedCreds(true).
 		SetStripOASExtensions(true).
 		SetStripOASServersBeforePublish().
+		SetIgnoreSpecTags([]string{"tag1"}).
 		SetInstanceLifecycle("stage", "active", "").
 		SetServiceEndpoints(ep)
 
@@ -142,6 +143,7 @@ func TestServiceBodySetters(t *testing.T) {
 	assert.NotNil(t, instanceLifecycle)
 	assert.Equal(t, "stage", instanceLifecycle.Stage)
 	assert.Equal(t, "active", instanceLifecycle.ReleaseState.Name)
+	assert.Equal(t, []string{"tag1"}, sb.ignoreSpecTags)
 
 	sb, err = serviceBuilder.
 		SetSourceDataplaneType(GitHub, true).
@@ -262,4 +264,21 @@ func TestServiceBodyBuilderWithLargeSpec(t *testing.T) {
 	assert.Nil(t, err)
 	assert.NotNil(t, sb)
 	assert.NotEqual(t, sb.originalSpecHash, sb.specHash)
+
+	// SetIgnoreSpecTags strips matching top-level OAS tags from the spec before publishing.
+	// The original hash is computed before stripping, so it must differ from the final spec hash.
+	sb, err = serviceBuilder.
+		SetIgnoreSpecTags([]string{"pet", "store", "user"}).
+		Build()
+	assert.Nil(t, err)
+	assert.NotNil(t, sb)
+	assert.NotEqual(t, sb.originalSpecHash, sb.specHash)
+
+	// A tag name that does not exist in the spec leaves hashes equal (spec is unchanged).
+	sb, err = serviceBuilder.
+		SetIgnoreSpecTags([]string{"nonexistent-tag"}).
+		Build()
+	assert.Nil(t, err)
+	assert.NotNil(t, sb)
+	assert.Equal(t, sb.originalSpecHash, sb.specHash)
 }

pkg/apic/specoas2processor.go

@@ -85,6 +85,19 @@ func (p *oas2SpecProcessor) stripEndpoints() {
 	p.spec.Schemes = []string{}
 }
 
+func (p *oas2SpecProcessor) stripTags(tags []string) {
+	if len(tags) == 0 {
+		return
+	}
+	for _, tagName := range tags {
+		for i := len(p.spec.Tags) - 1; i >= 0; i-- {
+			if p.spec.Tags[i].Name == tagName {
+				p.spec.Tags = append(p.spec.Tags[:i], p.spec.Tags[i+1:]...)
+			}
+		}
+	}
+}
+
 func (p *oas2SpecProcessor) ParseAuthInfo() {
 	authPolicies := []string{}
 	keyInfo := []APIKeyInfo{}

pkg/apic/specoas3processor.go

@@ -285,6 +285,19 @@ func (p *oas3SpecProcessor) stripEndpoints() {
 	p.spec.Servers = []*openapi3.Server{}
 }
 
+func (p *oas3SpecProcessor) stripTags(tags []string) {
+	if len(tags) == 0 {
+		return
+	}
+	for _, tagName := range tags {
+		for i := len(p.spec.Tags) - 1; i >= 0; i-- {
+			if p.spec.Tags[i].Name == tagName {
+				p.spec.Tags = append(p.spec.Tags[:i], p.spec.Tags[i+1:]...)
+			}
+		}
+	}
+}
+
 func (p *oas3SpecProcessor) GetSpecBytes() []byte {
 	s, _ := json.Marshal(p.spec)
 	return s

pkg/apic/specparser.go

@@ -58,6 +58,7 @@ type OasSpecProcessor interface {
 	GetResourceType() string
 	GetVersion() string
 	stripEndpoints()
+	stripTags([]string)
 }
 
 // SpecResourceParser -

pkg/config/centralconfig.go

@@ -228,6 +228,7 @@ type CentralConfig interface {
 	GetManagedEnvironments() []string
 	GetProvisioningRetryCount() int
 	IsInstanceValidationEnabled() bool
+	GetIgnoreSpecTags() []string
 }
 
 // CentralConfiguration - Structure to hold the central config
@@ -268,6 +269,7 @@ type CentralConfiguration struct {
 	CredentialConfig          CredentialConfig      `config:"credential"`
 	ProvisioningRetryCount    int                   `config:"provisioningRetryCount"`
 	InstanceValidatorEnabled  bool                  `config:"instanceValidatorEnabled"`
+	IgnoreSpecTags            []string              `config:"ignoreSpecTags"`
 	managedEnvironments       []string
 	JobExecutionTimeout       time.Duration
 	environmentID             string
@@ -695,6 +697,10 @@ func (c *CentralConfiguration) IsInstanceValidationEnabled() bool {
 	return c.InstanceValidatorEnabled
 }
 
+func (c *CentralConfiguration) GetIgnoreSpecTags() []string {
+	return c.IgnoreSpecTags
+}
+
 const (
 	pathRegion                    = "central.region"
 	pathTenantID                  = "central.organizationID"
@@ -740,6 +746,7 @@ const (
 	pathProvisioningRetryCount    = "central.provisioningRetryCount"
 	pathErrorSamplingEnabled      = "central.errorSamplingEnabled"
 	pathInstanceValidatorEnabled  = "central.instanceValidatorEnabled"
+	pathIgnoreSpecTags            = "central.ignoreSpecTags"
 )
 
 // ValidateCfg - Validates the config, implementing IConfigInterface
@@ -933,6 +940,7 @@ func AddCentralConfigProperties(props properties.Properties, agentType AgentType
 		AddUsageReportingProperties(props)
 		props.AddBoolProperty(pathErrorSamplingEnabled, false, "Controls whether error sampling is enabled")
 	} else {
+		props.AddStringSliceProperty(pathIgnoreSpecTags, []string{}, "Controls whether an agent has instance validation enabled")
 		props.AddStringProperty(pathAdditionalTags, "", "Additional Tags to Add to discovered APIs when publishing to Amplify Central")
 		props.AddBoolProperty(pathAppendEnvironmentToTitle, true, "When true API titles and descriptions will be appended with environment name")
 		props.AddIntProperty(pathProvisioningRetryCount, 0, "The number of retries, in case it fails, for any provisioning event", properties.WithUpperLimitInt(3))
@@ -1015,6 +1023,7 @@ func ParseCentralConfig(props properties.Properties, agentType AgentType) (Centr
 		cfg.MigrationSettings = ParseMigrationConfig(props)
 		cfg.CredentialConfig = newCredentialConfig()
 		cfg.CredentialConfig.SetAllowedOAuthMethods(props.StringSlicePropertyValue(pathCredentialsOAuthMethods))
+		cfg.IgnoreSpecTags = props.StringSlicePropertyValue(pathIgnoreSpecTags)
 	}
 	if cfg.AgentName == "" && cfg.Environment != "" && agentType.ToShortString() != "" {
 		cfg.AgentName = cfg.Environment + "-" + agentType.ToShortString()