add CloneRepository class with fromCodeCommit() support

Author: pahud

packages/@aws-cdk/aws-cloud9/lib/environment.ts

@@ -1,3 +1,4 @@
+import * as codecommit from '@aws-cdk/aws-codecommit';
 import * as ec2 from '@aws-cdk/aws-ec2';
 import * as cdk from '@aws-cdk/core';
 import { CfnEnvironmentEC2 } from '../lib/cloud9.generated';
@@ -20,7 +21,6 @@ export interface IEc2Environment extends cdk.IResource {
    * @attribute environmentE2Arn
    */
   readonly ec2EnvironmentArn: string;
-
 }
 
 /**
@@ -67,38 +67,21 @@ export interface Ec2EnvironmentProps {
    *
    * @default - do not clone any repository
    */
-  readonly clonedRepositories?: Cloud9Repository[];
+  // readonly clonedRepositories?: Cloud9Repository[];
+  readonly clonedRepositories?: CloneRepositoryConfig[];
 }
 
 /**
- * Repository provider
+ * The configuration for repository cloning
  */
-export enum Cloud9RepositoryProvider {
+export interface CloneRepositoryConfig {
   /**
-   * AWS CodeCommit
+   * The URL of the git repository
    */
-  AWS_CODECOMMIT
-}
+  readonly repositoryUrl: string;
 
-/**
- * The interface of the codecommit repository for Cloud9 environment
- */
-export interface Cloud9Repository {
   /**
-   * Repository provider
-   * @default AWS_CODECOMMIT
-   */
-  readonly provider?: Cloud9RepositoryProvider;
-
-  /**
-   * Repository URL
-   */
-  readonly url: string;
-
-  /**
-   * The path within the development environment's default file system location to clone the AWS CodeCommit
-   * repository into. For example, `/REPOSITORY_NAME` would clone the repository into the
-   * `/home/USER_NAME/environment/REPOSITORY_NAME` directory in the environment.
+   * The target path of the cloud9 environment to clone the repository to
    */
   readonly clonePath: string;
 }
@@ -167,7 +150,7 @@ export class Ec2Environment extends cdk.Resource implements IEc2Environment {
       instanceType: props.instanceType?.toString() ?? ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.MICRO).toString(),
       subnetId: this.vpc.selectSubnets(vpcSubnets).subnetIds[0],
       repositories: props.clonedRepositories ? props.clonedRepositories.map(r => ({
-        repositoryUrl: r.url,
+        repositoryUrl: r.repositoryUrl,
         pathComponent: r.clonePath,
       })) : undefined,
     });
@@ -177,3 +160,18 @@ export class Ec2Environment extends cdk.Resource implements IEc2Environment {
     this.ideUrl = `https://${this.stack.region}.console.aws.amazon.com/cloud9/ide/${this.environmentId}`;
   }
 }
+
+/**
+ * The class with static methods generating `CloneRepositoryConfig` for different repository providers
+ */
+export class CloneRepository {
+  /**
+   * import repository to cloud9 environment from AWS CodeCommit
+   */
+  public static fromCodeCommit(repository: codecommit.IRepository, path: string): CloneRepositoryConfig {
+    return {
+      repositoryUrl: repository.repositoryCloneUrlHttp,
+      clonePath: path,
+    };
+  }
+}

packages/@aws-cdk/aws-cloud9/package.json

@@ -72,12 +72,14 @@
   },
   "dependencies": {
     "@aws-cdk/core": "0.0.0",
+    "@aws-cdk/aws-codecommit": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",
     "constructs": "^3.0.2"
   },
   "homepage": "https://github.com/aws/aws-cdk",
   "peerDependencies": {
     "@aws-cdk/core": "0.0.0",
+    "@aws-cdk/aws-codecommit": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",
     "constructs": "^3.0.2"
   },

packages/@aws-cdk/aws-cloud9/test/cloud9.environment.test.ts

@@ -71,13 +71,12 @@ test('throw error when subnetSelection not specified and the provided VPC has no
 
 test('can use CodeCommit repositories', () => {
   // WHEN
+  const repo = codecommit.Repository.fromRepositoryName(stack, 'Repo', 'foo');
+
   new cloud9.Ec2Environment(stack, 'C9Env', {
     vpc,
     clonedRepositories: [
-      {
-        url: codecommit.Repository.fromRepositoryName(stack, 'Repo', 'foo').repositoryCloneUrlHttp,
-        clonePath: '/foo',
-      },
+      cloud9.CloneRepository.fromCodeCommit(repo, '/foo'),
     ],
   });
   // THEN

packages/@aws-cdk/aws-cloud9/test/integ.cloud9.ts

@@ -20,11 +20,9 @@ export class Cloud9Env extends cdk.Stack {
     // create a cloud9 ec2 environment in a new VPC
     const c9env = new cloud9.Ec2Environment(this, 'C9Env', {
       vpc,
+      // clone repositories into the environment
       clonedRepositories: [
-        {
-          url: repo.repositoryCloneUrlHttp,
-          clonePath: '/foo',
-        },
+        cloud9.CloneRepository.fromCodeCommit(repo, '/foo'),
       ],
     });
     new cdk.CfnOutput(this, 'URL', { value: c9env.ideUrl });