Merge pull request #1247 from RoadieHQ/sc-18900-allow-multiple-aws-pr…

…oviders Add uniqueness to AWS providers to allow multiple configuration if wanted.
RoadieHQ · Feb 9, 2024 · 08702a0 · 08702a0
2 parents 5676860 + f67229d
commit 08702a0
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 17 deletions.
diff --git a/.changeset/nine-carrots-rescue.md b/.changeset/nine-carrots-rescue.md
@@ -0,0 +1,5 @@
+---
+'@roadiehq/catalog-backend-module-aws': patch
+---
+
+Add uniqueness to AWS providers to allow multiple configuration if wanted.
diff --git a/plugins/backend/catalog-backend-module-aws/src/providers/AWSDynamoDbTableProvider.ts b/plugins/backend/catalog-backend-module-aws/src/providers/AWSDynamoDbTableProvider.ts
@@ -26,7 +26,10 @@ import { arnToName } from '../utils/arnToName';
  * Provides entities from AWS DynamoDB service.
  */
 export class AWSDynamoDbTableProvider extends AWSEntityProvider {
-  static fromConfig(config: Config, options: { logger: winston.Logger }) {
+  static fromConfig(
+    config: Config,
+    options: { logger: winston.Logger; providerId?: string },
+  ) {
     const accountId = config.getString('accountId');
     const roleArn = config.getString('roleArn');
     const externalId = config.getOptionalString('externalId');
@@ -39,7 +42,7 @@ export class AWSDynamoDbTableProvider extends AWSEntityProvider {
   }
 
   getProviderName(): string {
-    return `aws-dynamo-db-table-${this.accountId}`;
+    return `aws-dynamo-db-table-${this.accountId}-${this.providerId ?? 0}`;
   }
 
   async run(): Promise<void> {

diff --git a/plugins/backend/catalog-backend-module-aws/src/providers/AWSEC2Provider.ts b/plugins/backend/catalog-backend-module-aws/src/providers/AWSEC2Provider.ts
@@ -25,7 +25,10 @@ import { ANNOTATION_AWS_EC2_INSTANCE_ID } from '../annotations';
  * Provides entities from AWS Elastic Compute Cloud.
  */
 export class AWSEC2Provider extends AWSEntityProvider {
-  static fromConfig(config: Config, options: { logger: winston.Logger }) {
+  static fromConfig(
+    config: Config,
+    options: { logger: winston.Logger; providerId?: string },
+  ) {
     const accountId = config.getString('accountId');
     const roleArn = config.getString('roleArn');
     const externalId = config.getOptionalString('externalId');
@@ -38,7 +41,7 @@ export class AWSEC2Provider extends AWSEntityProvider {
   }
 
   getProviderName(): string {
-    return `aws-ec2-provider-${this.accountId}`;
+    return `aws-ec2-provider-${this.accountId}-${this.providerId ?? 0}`;
   }
 
   async run(): Promise<void> {

diff --git a/plugins/backend/catalog-backend-module-aws/src/providers/AWSEKSClusterProvider.ts b/plugins/backend/catalog-backend-module-aws/src/providers/AWSEKSClusterProvider.ts
@@ -29,7 +29,10 @@ import { arnToName } from '../utils/arnToName';
  * Provides entities from AWS EKS Cluster service.
  */
 export class AWSEKSClusterProvider extends AWSEntityProvider {
-  static fromConfig(config: Config, options: { logger: winston.Logger }) {
+  static fromConfig(
+    config: Config,
+    options: { logger: winston.Logger; providerId?: string },
+  ) {
     const accountId = config.getString('accountId');
     const roleArn = config.getString('roleArn');
     const externalId = config.getOptionalString('externalId');
@@ -42,7 +45,7 @@ export class AWSEKSClusterProvider extends AWSEntityProvider {
   }
 
   getProviderName(): string {
-    return `aws-eks-cluster-${this.accountId}`;
+    return `aws-eks-cluster-${this.accountId}-${this.providerId ?? 0}`;
   }
 
   async run(): Promise<void> {

diff --git a/plugins/backend/catalog-backend-module-aws/src/providers/AWSEntityProvider.ts b/plugins/backend/catalog-backend-module-aws/src/providers/AWSEntityProvider.ts
@@ -33,20 +33,22 @@ export abstract class AWSEntityProvider implements EntityProvider {
   protected readonly roleArn: string;
   private readonly externalId?: string;
   protected readonly region: string;
+  protected readonly providerId?: string;
   protected readonly logger: winston.Logger;
   protected connection?: EntityProviderConnection;
 
   public abstract getProviderName(): string;
 
   protected constructor(
     account: AccountConfig,
-    options: { logger: winston.Logger },
+    options: { logger: winston.Logger; providerId?: string },
   ) {
     this.accountId = account.accountId;
     this.roleArn = account.roleArn;
     this.externalId = account.externalId;
     this.region = account.region;
     this.logger = options.logger;
+    this.providerId = options.providerId;
   }
 
   protected getCredentials() {

diff --git a/plugins/backend/catalog-backend-module-aws/src/providers/AWSIAMRoleProvider.ts b/plugins/backend/catalog-backend-module-aws/src/providers/AWSIAMRoleProvider.ts
@@ -27,7 +27,10 @@ import { ARN } from 'link2aws';
  * Provides entities from AWS IAM Role service.
  */
 export class AWSIAMRoleProvider extends AWSEntityProvider {
-  static fromConfig(config: Config, options: { logger: winston.Logger }) {
+  static fromConfig(
+    config: Config,
+    options: { logger: winston.Logger; providerId?: string },
+  ) {
     const accountId = config.getString('accountId');
     const roleArn = config.getString('roleArn');
     const externalId = config.getOptionalString('externalId');
@@ -40,7 +43,7 @@ export class AWSIAMRoleProvider extends AWSEntityProvider {
   }
 
   getProviderName(): string {
-    return `aws-iam-role-${this.accountId}`;
+    return `aws-iam-role-${this.accountId}-${this.providerId ?? 0}`;
   }
 
   async run(): Promise<void> {

diff --git a/plugins/backend/catalog-backend-module-aws/src/providers/AWSIAMUserProvider.ts b/plugins/backend/catalog-backend-module-aws/src/providers/AWSIAMUserProvider.ts
@@ -27,7 +27,10 @@ import { ARN } from 'link2aws';
  * Provides entities from AWS IAM User service.
  */
 export class AWSIAMUserProvider extends AWSEntityProvider {
-  static fromConfig(config: Config, options: { logger: winston.Logger }) {
+  static fromConfig(
+    config: Config,
+    options: { logger: winston.Logger; providerId?: string },
+  ) {
     const accountId = config.getString('accountId');
     const roleArn = config.getString('roleArn');
     const externalId = config.getOptionalString('externalId');
@@ -40,7 +43,7 @@ export class AWSIAMUserProvider extends AWSEntityProvider {
   }
 
   getProviderName(): string {
-    return `aws-iam-user-${this.accountId}`;
+    return `aws-iam-user-${this.accountId}-${this.providerId ?? 0}`;
   }
 
   async run(): Promise<void> {

diff --git a/plugins/backend/catalog-backend-module-aws/src/providers/AWSLambdaFunctionProvider.test.ts b/plugins/backend/catalog-backend-module-aws/src/providers/AWSLambdaFunctionProvider.test.ts
@@ -109,9 +109,9 @@ describe('AWSLambdaFunctionProvider', () => {
                   'amazon.com/lambda-function-arn':
                     'arn:aws:lambda:eu-west-1:123456789012:function:my-function',
                   'backstage.io/managed-by-location':
-                    'aws-lambda-function-123456789012:arn:aws:iam::123456789012:role/role1',
+                    'aws-lambda-function-123456789012-0:arn:aws:iam::123456789012:role/role1',
                   'backstage.io/managed-by-origin-location':
-                    'aws-lambda-function-123456789012:arn:aws:iam::123456789012:role/role1',
+                    'aws-lambda-function-123456789012-0:arn:aws:iam::123456789012:role/role1',
                   'backstage.io/view-url':
                     'https://eu-west-1.console.aws.amazon.com/lambda/home?region=eu-west-1#/functions/my-function',
                 },

diff --git a/plugins/backend/catalog-backend-module-aws/src/providers/AWSLambdaFunctionProvider.ts b/plugins/backend/catalog-backend-module-aws/src/providers/AWSLambdaFunctionProvider.ts
@@ -30,7 +30,10 @@ import { ARN } from 'link2aws';
  * Provides entities from AWS Lambda Function service.
  */
 export class AWSLambdaFunctionProvider extends AWSEntityProvider {
-  static fromConfig(config: Config, options: { logger: winston.Logger }) {
+  static fromConfig(
+    config: Config,
+    options: { logger: winston.Logger; providerId?: string },
+  ) {
     const accountId = config.getString('accountId');
     const roleArn = config.getString('roleArn');
     const externalId = config.getOptionalString('externalId');
@@ -43,7 +46,7 @@ export class AWSLambdaFunctionProvider extends AWSEntityProvider {
   }
 
   getProviderName(): string {
-    return `aws-lambda-function-${this.accountId}`;
+    return `aws-lambda-function-${this.accountId}-${this.providerId ?? 0}`;
   }
 
   async run(): Promise<void> {

diff --git a/plugins/backend/catalog-backend-module-aws/src/providers/AWSS3BucketProvider.ts b/plugins/backend/catalog-backend-module-aws/src/providers/AWSS3BucketProvider.ts
@@ -27,7 +27,10 @@ import { ARN } from 'link2aws';
  * Provides entities from AWS S3 Bucket service.
  */
 export class AWSS3BucketProvider extends AWSEntityProvider {
-  static fromConfig(config: Config, options: { logger: winston.Logger }) {
+  static fromConfig(
+    config: Config,
+    options: { logger: winston.Logger; providerId?: string },
+  ) {
     const accountId = config.getString('accountId');
     const roleArn = config.getString('roleArn');
     const externalId = config.getOptionalString('externalId');
@@ -40,7 +43,7 @@ export class AWSS3BucketProvider extends AWSEntityProvider {
   }
 
   getProviderName(): string {
-    return `aws-s3-bucket-${this.accountId}`;
+    return `aws-s3-bucket-${this.accountId}-${this.providerId ?? 0}`;
   }
 
   async run(): Promise<void> {