feat(aws-codebuild): allow github sourceversion branch

packages/@aws-cdk/aws-codebuild/lib/project.ts

@@ -537,6 +537,13 @@ export interface ProjectProps extends CommonProjectProps {
    */
   readonly secondarySources?: ISource[];
 
+  /**
+   * The secondary source versions for the Project.   *
+   * @default - No secondary source versions (they default to latest).
+   * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-sourceversion
+   */
+  readonly secondarySourceVersions?: CfnProject.ProjectSourceVersionProperty[];
+
   /**
    * The secondary artifacts for the Project.
    * Can also be added after the Project has been created by using the {@link Project#addSecondaryArtifact} method.
@@ -626,7 +633,7 @@ export class Project extends ProjectBase {
    * @returns an array of {@link CfnProject.EnvironmentVariableProperty} instances
    */
   public static serializeEnvVariables(environmentVariables: { [name: string]: BuildEnvironmentVariable }):
-      CfnProject.EnvironmentVariableProperty[] {
+    CfnProject.EnvironmentVariableProperty[] {
     return Object.keys(environmentVariables).map(name => ({
       name,
       type: environmentVariables[name].type || BuildEnvironmentVariableType.PLAINTEXT,
@@ -654,6 +661,7 @@ export class Project extends ProjectBase {
   private readonly source: ISource;
   private readonly buildImage: IBuildImage;
   private readonly _secondarySources: CfnProject.SourceProperty[];
+  private readonly _secondarySourceVersions: CfnProject.ProjectSourceVersionProperty[];
   private readonly _secondaryArtifacts: CfnProject.ArtifactsProperty[];
   private _encryptionKey?: kms.IKey;
 
@@ -698,6 +706,7 @@ export class Project extends ProjectBase {
     }
 
     this._secondarySources = [];
+    this._secondarySourceVersions = [];
     for (const secondarySource of props.secondarySources || []) {
       this.addSecondarySource(secondarySource);
     }
@@ -725,8 +734,10 @@ export class Project extends ProjectBase {
       name: this.physicalName,
       timeoutInMinutes: props.timeout && props.timeout.toMinutes(),
       secondarySources: Lazy.anyValue({ produce: () => this.renderSecondarySources() }),
+      secondarySourceVersions: Lazy.anyValue({ produce: () => this.renderSecondarySourceVersions() }),
       secondaryArtifacts: Lazy.anyValue({ produce: () => this.renderSecondaryArtifacts() }),
       triggers: sourceConfig.buildTriggers,
+      sourceVersion: sourceConfig.sourceVersion,
       vpcConfig: this.configureVpc(props),
     });
 
@@ -756,7 +767,12 @@ export class Project extends ProjectBase {
     if (!secondarySource.identifier) {
       throw new Error('The identifier attribute is mandatory for secondary sources');
     }
-    this._secondarySources.push(secondarySource.bind(this, this).sourceProperty);
+    const secondarySourceConfig = secondarySource.bind(this, this);
+    this._secondarySources.push(secondarySourceConfig.sourceProperty);
+    this._secondarySourceVersions.push({
+      sourceIdentifier: secondarySource.identifier,
+      sourceVersion: secondarySourceConfig.sourceVersion,
+    });
   }
 
   /**
@@ -788,7 +804,7 @@ export class Project extends ProjectBase {
       const keyStack = Stack.of(options.artifactBucket.encryptionKey);
       const projectStack = Stack.of(this);
       if (!(options.artifactBucket.encryptionKey instanceof kms.Key &&
-          (keyStack.account !== projectStack.account || keyStack.region !== projectStack.region))) {
+        (keyStack.account !== projectStack.account || keyStack.region !== projectStack.region))) {
         this.encryptionKey = options.artifactBucket.encryptionKey;
       }
     }
@@ -893,6 +909,12 @@ export class Project extends ProjectBase {
       : this._secondarySources;
   }
 
+  private renderSecondarySourceVersions(): CfnProject.ProjectSourceVersionProperty[] | undefined {
+    return this._secondarySourceVersions.length === 0
+    ? undefined
+    : this._secondarySourceVersions;
+  }
+
   private renderSecondaryArtifacts(): CfnProject.ArtifactsProperty[] | undefined {
     return this._secondaryArtifacts.length === 0
       ? undefined
@@ -983,8 +1005,8 @@ export class Project extends ProjectBase {
     const artifactsType = artifacts.type;
 
     if ((sourceType === CODEPIPELINE_SOURCE_ARTIFACTS_TYPE ||
-        artifactsType === CODEPIPELINE_SOURCE_ARTIFACTS_TYPE) &&
-        (sourceType !== artifactsType)) {
+      artifactsType === CODEPIPELINE_SOURCE_ARTIFACTS_TYPE) &&
+      (sourceType !== artifactsType)) {
       throw new Error('Both source and artifacts must be set to CodePipeline');
     }
   }
@@ -1124,7 +1146,7 @@ class ArmBuildImage implements IBuildImage {
   public validate(buildEnvironment: BuildEnvironment): string[] {
     const ret = [];
     if (buildEnvironment.computeType &&
-        buildEnvironment.computeType !== ComputeType.LARGE) {
+      buildEnvironment.computeType !== ComputeType.LARGE) {
       ret.push(`ARM images only support ComputeType '${ComputeType.LARGE}' - ` +
         `'${buildEnvironment.computeType}' was given`);
     }

packages/@aws-cdk/aws-codebuild/lib/source.ts

@@ -19,6 +19,13 @@ export interface SourceConfig {
   readonly sourceProperty: CfnProject.SourceProperty;
 
   readonly buildTriggers?: CfnProject.ProjectTriggersProperty;
+
+  /**
+   * `AWS::CodeBuild::Project.SourceVersion`
+   * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-sourceversion
+   * @default the latest version
+   */
+  readonly sourceVersion?: string;
 }
 
 /**
@@ -471,6 +478,14 @@ abstract class ThirdPartyGitSource extends GitSource {
  */
 export interface CodeCommitSourceProps extends GitSourceProps {
   readonly repository: codecommit.IRepository;
+
+  /**
+   *  The commit ID, branch, or Git tag to use.
+   *
+   * @example 'mybranch'
+   * @default the default branch's HEAD commit ID is used
+   */
+  readonly sourceVersion?: string;
 }
 
 /**
@@ -479,10 +494,12 @@ export interface CodeCommitSourceProps extends GitSourceProps {
 class CodeCommitSource extends GitSource {
   public readonly type = CODECOMMIT_SOURCE_TYPE;
   private readonly repo: codecommit.IRepository;
+  private readonly sourceVersion?: string;
 
   constructor(props: CodeCommitSourceProps) {
     super(props);
     this.repo = props.repository;
+    this.sourceVersion = props.sourceVersion;
   }
 
   public bind(_scope: Construct, project: IProject): SourceConfig {
@@ -498,6 +515,7 @@ class CodeCommitSource extends GitSource {
         ...superConfig.sourceProperty,
         location: this.repo.repositoryCloneUrlHttp,
       },
+      sourceVersion: this.sourceVersion,
     };
   }
 }
@@ -508,6 +526,13 @@ class CodeCommitSource extends GitSource {
 export interface S3SourceProps extends SourceProps {
   readonly bucket: s3.IBucket;
   readonly path: string;
+
+  /**
+   *  The version ID of the object that represents the build input ZIP file to use.
+   *
+   * @default latest
+   */
+  readonly sourceVersion?: string;
 }
 
 /**
@@ -517,11 +542,13 @@ class S3Source extends Source {
   public readonly type = S3_SOURCE_TYPE;
   private readonly bucket: s3.IBucket;
   private readonly path: string;
+  private readonly sourceVersion?: string;
 
   constructor(props: S3SourceProps) {
     super(props);
     this.bucket = props.bucket;
     this.path = props.path;
+    this.sourceVersion = props.sourceVersion;
   }
 
   public bind(_scope: Construct, project: IProject): SourceConfig {
@@ -533,6 +560,7 @@ class S3Source extends Source {
         ...superConfig.sourceProperty,
         location: `${this.bucket.bucketName}/${this.path}`,
       },
+      sourceVersion: this.sourceVersion,
     };
   }
 }
@@ -554,18 +582,29 @@ export interface GitHubSourceProps extends ThirdPartyGitSourceProps {
    * @example 'aws-cdk'
    */
   readonly repo: string;
+
+  /**
+   * The commit ID, pull request ID, branch name, or tag name that corresponds to
+   * the version of the source code you want to build
+   *
+   * @example 'pr/25'
+   * @default the default branch's HEAD commit ID is used
+   */
+  readonly sourceVersion?: string;
 }
 
 /**
  * GitHub Source definition for a CodeBuild project.
  */
 class GitHubSource extends ThirdPartyGitSource {
   public readonly type = GITHUB_SOURCE_TYPE;
+  private readonly sourceVersion?: string;
   private readonly httpsCloneUrl: string;
 
   constructor(props: GitHubSourceProps) {
     super(props);
     this.httpsCloneUrl = `https://github.com/${props.owner}/${props.repo}.git`;
+    this.sourceVersion = props.sourceVersion;
   }
 
   public bind(_scope: Construct, project: IProject): SourceConfig {
@@ -575,6 +614,7 @@ class GitHubSource extends ThirdPartyGitSource {
         ...superConfig.sourceProperty,
         location: this.httpsCloneUrl,
       },
+      sourceVersion: this.sourceVersion,
       buildTriggers: superConfig.buildTriggers,
     };
   }
@@ -595,6 +635,15 @@ export interface GitHubEnterpriseSourceProps extends ThirdPartyGitSourceProps {
    * @default false
    */
   readonly ignoreSslErrors?: boolean;
+
+  /**
+   * The commit ID, pull request ID, branch name, or tag name that corresponds to
+   * the version of the source code you want to build
+   *
+   * @example 'pr/25'
+   * @default the default branch's HEAD commit ID is used
+   */
+  readonly sourceVersion?: string;
 }
 
 /**
@@ -604,11 +653,13 @@ class GitHubEnterpriseSource extends ThirdPartyGitSource {
   public readonly type = GITHUB_ENTERPRISE_SOURCE_TYPE;
   private readonly httpsCloneUrl: string;
   private readonly ignoreSslErrors?: boolean;
+  private readonly sourceVersion?: string;
 
   constructor(props: GitHubEnterpriseSourceProps) {
     super(props);
     this.httpsCloneUrl = props.httpsCloneUrl;
     this.ignoreSslErrors = props.ignoreSslErrors;
+    this.sourceVersion = props.sourceVersion;
   }
 
   public bind(_scope: Construct, _project: IProject): SourceConfig {
@@ -619,6 +670,7 @@ class GitHubEnterpriseSource extends ThirdPartyGitSource {
         location: this.httpsCloneUrl,
         insecureSsl: this.ignoreSslErrors,
       },
+      sourceVersion: this.sourceVersion,
       buildTriggers: superConfig.buildTriggers,
     };
   }
@@ -641,6 +693,14 @@ export interface BitBucketSourceProps extends ThirdPartyGitSourceProps {
    * @example 'aws-cdk'
    */
   readonly repo: string;
+
+  /**
+   *  The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build
+   *
+   * @example 'mybranch'
+   * @default the default branch's HEAD commit ID is used
+   */
+  readonly sourceVersion?: string;
 }
 
 /**
@@ -649,10 +709,12 @@ export interface BitBucketSourceProps extends ThirdPartyGitSourceProps {
 class BitBucketSource extends ThirdPartyGitSource {
   public readonly type = BITBUCKET_SOURCE_TYPE;
   private readonly httpsCloneUrl: any;
+  private readonly sourceVersion?: string;
 
   constructor(props: BitBucketSourceProps) {
     super(props);
     this.httpsCloneUrl = `https://bitbucket.org/${props.owner}/${props.repo}.git`;
+    this.sourceVersion = props.sourceVersion;
   }
 
   public bind(_scope: Construct, _project: IProject): SourceConfig {
@@ -672,6 +734,7 @@ class BitBucketSource extends ThirdPartyGitSource {
         ...superConfig.sourceProperty,
         location: this.httpsCloneUrl,
       },
+      sourceVersion: this.sourceVersion,
       buildTriggers: superConfig.buildTriggers,
     };
   }

packages/@aws-cdk/aws-codebuild/test/integ.project-secondary-sources-artifacts.expected.json

@@ -209,6 +209,11 @@
             "SourceIdentifier": "AddSource1",
             "Type": "S3"
           }
+        ],
+        "SecondarySourceVersions": [
+          {
+            "SourceIdentifier": "AddSource1"
+          }
         ]
       }
     }

packages/@aws-cdk/aws-codebuild/test/test.codebuild.ts

@@ -865,6 +865,76 @@ export = {
     },
   },
 
+  'secondary source versions': {
+    'allow secondary source versions'(test: Test) {
+      const stack = new cdk.Stack();
+      const bucket = new s3.Bucket(stack, 'MyBucket');
+      const project = new codebuild.Project(stack, 'MyProject', {
+        source: codebuild.Source.s3({
+          bucket,
+          path: 'some/path',
+        }),
+      });
+
+      project.addSecondarySource(codebuild.Source.s3({
+        bucket,
+        path: 'another/path',
+        identifier: 'source1',
+        sourceVersion: 'someversion'
+      }));
+
+      expect(stack).to(haveResourceLike('AWS::CodeBuild::Project', {
+        "SecondarySources": [
+          {
+            "SourceIdentifier": "source1",
+            "Type": "S3",
+          },
+        ],
+        "SecondarySourceVersions": [
+          {
+            "SourceIdentifier": "source1",
+            "SourceVersion": "someversion"
+          }
+        ]
+      }));
+
+      test.done();
+    },
+
+    'allow not to specify secondary source versions'(test: Test) {
+      const stack = new cdk.Stack();
+      const bucket = new s3.Bucket(stack, 'MyBucket');
+      const project = new codebuild.Project(stack, 'MyProject', {
+        source: codebuild.Source.s3({
+          bucket,
+          path: 'some/path',
+        }),
+      });
+
+      project.addSecondarySource(codebuild.Source.s3({
+        bucket,
+        path: 'another/path',
+        identifier: 'source1',
+      }));
+
+      expect(stack).to(haveResourceLike('AWS::CodeBuild::Project', {
+        "SecondarySources": [
+          {
+            "SourceIdentifier": "source1",
+            "Type": "S3",
+          },
+        ],
+        "SecondarySourceVersions": [
+          {
+            "SourceIdentifier": "source1",
+          }
+        ]
+      }));
+
+      test.done();
+    },
+  },
+
   'secondary artifacts': {
     'require providing an identifier when creating a Project'(test: Test) {
       const stack = new cdk.Stack();