Skip to content

Commit

Permalink
fix(servicecatalogappregistry): Remove deprecated resource in Applica…
Browse files Browse the repository at this point in the history 
…tion Construct (aws#25095)

BREAKING CHANGE: this change will deprecated **associateStack** and **associateAttributeGroup** in Application Construct. 
The user who are using these two method need to update to use alternative method.
For associateStack, the alternative method is **associateApplicationWithStack**
For associateAttributeGroup, the alternative method is **AttributeGroup.associateWith**

The user who are using these two method need to update to use alternative method. For associateStack, the alternative method is **associateApplicationWithStack** For associateAttributeGroup, the alternative method is **AttributeGroup.associateWith**

Purpose of this PR:

we need to remove deprecated resource before we moving into stable version The method that we remove is: associateStack and associateAttributeGroup

CHANGES:

1. in lib/application.ts, we remove these two methods and update their corresponding interface
2. in test/ application.test.ts & test/integ.application.ts, we update application.test.ts and integ.application.ts to remove these two methods' related test


*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
@yingdon-amazon
yingdon-amazon authored Apr 17, 2023
1 parent d3da4c0 commit 9222f21
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 338 deletions.
52 changes: 0 additions & 52 deletions packages/@aws-cdk/aws-servicecatalogappregistry-alpha/lib/application.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,29 +56,13 @@ export interface IApplication extends cdk.IResource {
*/
readonly applicationName?: string;

/**
* Associate this application with an attribute group.
*
* @param attributeGroup AppRegistry attribute group
*/
associateAttributeGroup(attributeGroup: IAttributeGroup): void;

/**
* Create an attribute group and associate this application with the created attribute group.
*
* @param id name of the AttributeGroup construct to be created.
* @param attributeGroupProps AppRegistry attribute group props
*/
addAttributeGroup(id: string, attributeGroupProps: AttributeGroupAssociationProps): IAttributeGroup;

/**
* Associate this application with a CloudFormation stack.
*
* @deprecated Use `associateApplicationWithStack` instead.
* @param stack a CFN stack
*/
associateStack(stack: cdk.Stack): void;

/**
* Associate a Cloudformation statck with the application in the given stack.
*
Expand Down Expand Up @@ -128,23 +112,6 @@ abstract class ApplicationBase extends cdk.Resource implements IApplication {
private readonly associatedAttributeGroups: Set<string> = new Set();
private readonly associatedResources: Set<string> = new Set();

/**
* Associate an attribute group with application
* If the attribute group is already associated, it will ignore duplicate request.
*
* @deprecated Use `AttributeGroup.associateWith` instead.
*/
public associateAttributeGroup(attributeGroup: IAttributeGroup): void {
if (!this.associatedAttributeGroups.has(attributeGroup.node.addr)) {
const hashId = this.generateUniqueHash(attributeGroup.node.addr);
new CfnAttributeGroupAssociation(this, `AttributeGroupAssociation${hashId}`, {
application: this.applicationId,
attributeGroup: attributeGroup.attributeGroupId,
});
this.associatedAttributeGroups.add(attributeGroup.node.addr);
}
}

/**
* Create an attribute group and associate this application with the created attribute group.
*/
Expand All @@ -162,25 +129,6 @@ abstract class ApplicationBase extends cdk.Resource implements IApplication {
return attributeGroup;
}

/**
* Associate a stack with the application
* If the resource is already associated, it will ignore duplicate request.
* A stack can only be associated with one application.
*
* @deprecated Use `associateApplicationWithStack` instead.
*/
public associateStack(stack: cdk.Stack): void {
if (!this.associatedResources.has(stack.node.addr)) {
const hashId = this.generateUniqueHash(stack.node.addr);
new CfnResourceAssociation(this, `ResourceAssociation${hashId}`, {
application: this.applicationId,
resource: stack.stackId,
resourceType: 'CFN_STACK',
});
this.associatedResources.add(stack.node.addr);
}
}

/**
* Associate stack with the application in the stack passed as parameter.
*
Expand Down
86 changes: 0 additions & 86 deletions packages/@aws-cdk/aws-servicecatalogappregistry-alpha/test/application.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,20 +146,6 @@ describe('Application', () => {
});
});

test('associate attribute group', () => {
const attributeGroup = new appreg.AttributeGroup(stack, 'AttributeGroup', {
attributeGroupName: 'AttributeGroupName',
attributes: {},
});

application.associateAttributeGroup(attributeGroup);

Template.fromStack(stack).hasResourceProperties('AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation', {
Application: { 'Fn::GetAtt': ['MyApplication5C63EC1D', 'Id'] },
AttributeGroup: { 'Fn::GetAtt': ['AttributeGroup409C6335', 'Id'] },
});
}),

test('associate new attribute group', () => {
application.addAttributeGroup('AttributeGroup', {
attributeGroupName: 'AttributeGroupName',
Expand All @@ -183,78 +169,6 @@ describe('Application', () => {
},
},
});
}),

test('duplicate attribute group association are idempotent', () => {
const attributeGroup = new appreg.AttributeGroup(stack, 'AttributeGroup', {
attributeGroupName: 'attributeGroupName',
attributes: { key: 'value' },
});

// If these were not idempotent, the second call would produce an error for duplicate construct ID.
application.associateAttributeGroup(attributeGroup);
application.associateAttributeGroup(attributeGroup);

Template.fromStack(stack).resourceCountIs('AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation', 1);
}),

test('multiple applications and attribute groups can associate', () => {
const application2 = new appreg.Application(stack, 'MyApplication2', {
applicationName: 'MyApplication2',
});

const attributeGroup1 = new appreg.AttributeGroup(stack, 'AttributeGroup', {
attributeGroupName: 'attributeGroupName',
attributes: { key: 'value' },
});

const attributeGroup2 = new appreg.AttributeGroup(stack, 'AttributeGroup2', {
attributeGroupName: 'attributeGroupName2',
attributes: { key: 'value' },
});

application.associateAttributeGroup(attributeGroup1);
application.associateAttributeGroup(attributeGroup2);

application2.associateAttributeGroup(attributeGroup1);
application2.associateAttributeGroup(attributeGroup2);

Template.fromStack(stack).resourceCountIs('AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation', 4);
}),

test('associate resource', () => {
const resource = new cdk.Stack(stack, 'MyStack');

application.associateStack(resource);

Template.fromStack(stack).hasResourceProperties('AWS::ServiceCatalogAppRegistry::ResourceAssociation', {
Application: { 'Fn::GetAtt': ['MyApplication5C63EC1D', 'Id'] },
Resource: { 'Fn::ImportValue': 'MyStack:ExportsOutputRefAWSStackIdB2DD5BAA' },
});
}),

test('associate resource on imported application', () => {
const resource = new cdk.Stack(stack, 'MyStack');

const importedApplication = appreg.Application.fromApplicationArn(stack, 'ImportedApplication',
'arn:aws:servicecatalog:us-east-1:123456789012:/applications/0bqmvxvgmry0ecc4mjhwypun6i');

importedApplication.associateStack(resource);

Template.fromStack(stack).hasResourceProperties('AWS::ServiceCatalogAppRegistry::ResourceAssociation', {
Application: '0bqmvxvgmry0ecc4mjhwypun6i',
Resource: { 'Fn::ImportValue': 'MyStack:ExportsOutputRefAWSStackIdB2DD5BAA' },
});
}),

test('duplicate resource assocations are idempotent', () => {
const resource = new cdk.Stack(stack, 'MyStack');

// If these were not idempotent, the second call would produce an error for duplicate construct ID.
application.associateStack(resource);
application.associateStack(resource);

Template.fromStack(stack).resourceCountIs('AWS::ServiceCatalogAppRegistry::ResourceAssociation', 1);
});
});

Expand Down
4 changes: 2 additions & 2 deletions ...est/integ.application.js.snapshot/integ-servicecatalogappregistry-application.assets.json
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"version": "31.0.0",
"files": {
"461d235e9497deb16b9209be4a927c7d0dc7aa06d668e38bfb19a90db8e4a4b2": {
"f33c45795986ec36a911c738213b5076f0382d4e57e6ed43ea411e2014880ae2": {
"source": {
"path": "integ-servicecatalogappregistry-application.template.json",
"packaging": "file"
},
"destinations": {
"current_account-current_region": {
"bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
"objectKey": "461d235e9497deb16b9209be4a927c7d0dc7aa06d668e38bfb19a90db8e4a4b2.json",
"objectKey": "f33c45795986ec36a911c738213b5076f0382d4e57e6ed43ea411e2014880ae2.json",
"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
}
}
Expand Down
55 changes: 0 additions & 55 deletions ...t/integ.application.js.snapshot/integ-servicecatalogappregistry-application.template.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,6 @@
"Description": "My application description"
}
},
"TestApplicationResourceAssociationd232b63e52a8414E905D": {
"Type": "AWS::ServiceCatalogAppRegistry::ResourceAssociation",
"Properties": {
"Application": {
"Fn::GetAtt": [
"TestApplication2FBC585F",
"Id"
]
},
"Resource": {
"Ref": "AWS::StackId"
},
"ResourceType": "CFN_STACK"
}
},
"TestApplicationAttributeGroupAssociation4ba7f5842818B8EE1C6F": {
"Type": "AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation",
"Properties": {
"Application": {
"Fn::GetAtt": [
"TestApplication2FBC585F",
"Id"
]
},
"AttributeGroup": {
"Fn::GetAtt": [
"TestAttributeGroupB1CB284F",
"Id"
]
}
}
},
"TestApplicationmyAnotherAttributeGroup375F79DB": {
"Type": "AWS::ServiceCatalogAppRegistry::AttributeGroup",
"Properties": {
Expand Down Expand Up @@ -105,29 +73,6 @@
]
}
},
"TestAttributeGroupB1CB284F": {
"Type": "AWS::ServiceCatalogAppRegistry::AttributeGroup",
"Properties": {
"Attributes": {
"stage": "alpha",
"teamMembers": [
"markI",
"markII",
"markIII"
],
"public": false,
"publishYear": 2021,
"plannedRoadMap": {
"alpha": "some time",
"beta": "another time",
"gamma": "penultimate time",
"release": "go time"
}
},
"Name": "myAttributeGroup",
"Description": "my attribute group description"
}
},
"MyRoleF48FFE04": {
"Type": "AWS::IAM::Role",
"Properties": {
Expand Down
47 changes: 28 additions & 19 deletions ...-cdk/aws-servicecatalogappregistry-alpha/test/integ.application.js.snapshot/manifest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"validateOnSynth": false,
"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}",
"cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}",
"stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/461d235e9497deb16b9209be4a927c7d0dc7aa06d668e38bfb19a90db8e4a4b2.json",
"stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/f33c45795986ec36a911c738213b5076f0382d4e57e6ed43ea411e2014880ae2.json",
"requiresBootstrapStackVersion": 6,
"bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
"additionalDependencies": [
Expand All @@ -39,18 +39,6 @@
"data": "TestApplication2FBC585F"
}
],
"/integ-servicecatalogappregistry-application/TestApplication/ResourceAssociationd232b63e52a8": [
{
"type": "aws:cdk:logicalId",
"data": "TestApplicationResourceAssociationd232b63e52a8414E905D"
}
],
"/integ-servicecatalogappregistry-application/TestApplication/AttributeGroupAssociation4ba7f5842818": [
{
"type": "aws:cdk:logicalId",
"data": "TestApplicationAttributeGroupAssociation4ba7f5842818B8EE1C6F"
}
],
"/integ-servicecatalogappregistry-application/TestApplication/myAnotherAttributeGroup/Resource": [
{
"type": "aws:cdk:logicalId",
Expand All @@ -69,12 +57,6 @@
"data": "TestApplicationMyShareIdE1044482"
}
],
"/integ-servicecatalogappregistry-application/TestAttributeGroup/Resource": [
{
"type": "aws:cdk:logicalId",
"data": "TestAttributeGroupB1CB284F"
}
],
"/integ-servicecatalogappregistry-application/MyRole/Resource": [
{
"type": "aws:cdk:logicalId",
Expand All @@ -92,6 +74,33 @@
"type": "aws:cdk:logicalId",
"data": "CheckBootstrapVersion"
}
],
"TestApplicationResourceAssociationd232b63e52a8414E905D": [
{
"type": "aws:cdk:logicalId",
"data": "TestApplicationResourceAssociationd232b63e52a8414E905D",
"trace": [
"!!DESTRUCTIVE_CHANGES: WILL_DESTROY"
]
}
],
"TestApplicationAttributeGroupAssociation4ba7f5842818B8EE1C6F": [
{
"type": "aws:cdk:logicalId",
"data": "TestApplicationAttributeGroupAssociation4ba7f5842818B8EE1C6F",
"trace": [
"!!DESTRUCTIVE_CHANGES: WILL_DESTROY"
]
}
],
"TestAttributeGroupB1CB284F": [
{
"type": "aws:cdk:logicalId",
"data": "TestAttributeGroupB1CB284F",
"trace": [
"!!DESTRUCTIVE_CHANGES: WILL_DESTROY"
]
}
]
},
"displayName": "integ-servicecatalogappregistry-application"
Expand Down
Loading

0 comments on commit 9222f21

Please sign in to comment.