fix(aws-codebuild): allow passing oauth token to GitHubEnterpriseSource (#908)

eaddingtonwhite · Elad Ben-Israel · commit c23da9153e67 · 2018-10-12T10:37:44.000+03:00
diff --git a/packages/@aws-cdk/aws-codebuild/lib/source.ts b/packages/@aws-cdk/aws-codebuild/lib/source.ts
@@ -72,38 +72,57 @@ export class CodePipelineSource extends BuildSource {
   }
 }
 
+export interface GithubSourceProps {
+  /**
+   * The git url to clone for this code build project.
+   */
+  cloneUrl: string;
+
+  /**
+   * The oAuthToken used to authenticate when cloning source git repo.
+   */
+  oauthToken: cdk.Secret;
+
+}
+
 /**
  * GitHub Source definition for a CodeBuild project
  */
 export class GitHubSource extends BuildSource {
-  constructor(private readonly httpscloneUrl: string, private readonly oauthToken: any) {
+  private cloneUrl: string;
+  private oauthToken: cdk.Secret;
+  constructor(props: GithubSourceProps) {
     super();
-    this.httpscloneUrl = httpscloneUrl;
-    this.oauthToken = oauthToken;
+    this.cloneUrl = props.cloneUrl;
+    this.oauthToken = props.oauthToken;
   }
 
   public toSourceJSON(): cloudformation.ProjectResource.SourceProperty {
     return {
       type: SourceType.GitHub,
       auth: this.oauthToken != null ? { type: 'OAUTH', resource: this.oauthToken } : undefined,
-      location: this.httpscloneUrl
+      location: this.cloneUrl
     };
   }
 }
 
 /**
- * GitHub Enterprice Source definition for a CodeBuild project
+ * GitHub Enterprise Source definition for a CodeBuild project
  */
 export class GitHubEnterpriseSource extends BuildSource {
-  constructor(private readonly cloneUrl: string) {
+  private cloneUrl: string;
+  private oauthToken: cdk.Secret;
+  constructor(props: GithubSourceProps) {
     super();
-    this.cloneUrl = cloneUrl;
+    this.cloneUrl = props.cloneUrl;
+    this.oauthToken = props.oauthToken;
   }
 
   public toSourceJSON(): cloudformation.ProjectResource.SourceProperty {
     return {
       type: SourceType.GitHubEnterPrise,
       location: this.cloneUrl,
+      auth: this.oauthToken != null ? { type: 'OAUTH', resource: this.oauthToken } : undefined,
     };
   }
 }
diff --git a/packages/@aws-cdk/aws-codebuild/test/test.project.ts b/packages/@aws-cdk/aws-codebuild/test/test.project.ts
@@ -34,7 +34,7 @@ export = {
     // WHEN
     new codebuild.Project(stack, 'Project', {
       source: new codebuild.CodePipelineSource(),
-      buildSpec: { phases: [ 'say hi' ] }
+      buildSpec: { phases: ['say hi'] }
     });
 
     // THEN
@@ -47,6 +47,60 @@ export = {
     test.done();
   },
 
+  'github auth test'(test: Test) {
+    // GIVEN
+    const stack = new cdk.Stack();
+
+    // WHEN
+    new codebuild.Project(stack, 'Project', {
+      source: new codebuild.GitHubSource({
+        cloneUrl: "https://github.com/testowner/testrepo",
+        oauthToken: new cdk.Secret("test_oauth_token")
+      })
+    });
+
+    // THEN
+    expect(stack).to(haveResource('AWS::CodeBuild::Project', {
+      Source: {
+        Type: "GITHUB",
+        Auth: {
+          Type: 'OAUTH',
+          Resource: 'test_oauth_token'
+        },
+        Location: 'https://github.com/testowner/testrepo'
+      }
+    }));
+
+    test.done();
+  },
+
+  'github enterprise auth test'(test: Test) {
+    // GIVEN
+    const stack = new cdk.Stack();
+
+    // WHEN
+    new codebuild.Project(stack, 'Project', {
+      source: new codebuild.GitHubEnterpriseSource({
+        cloneUrl: "https://github.testcompany.com/testowner/testrepo",
+        oauthToken: new cdk.Secret("test_oauth_token")
+      })
+    });
+
+    // THEN
+    expect(stack).to(haveResource('AWS::CodeBuild::Project', {
+      Source: {
+        Type: "GITHUB_ENTERPRISE",
+        Auth: {
+          Type: 'OAUTH',
+          Resource: 'test_oauth_token'
+        },
+        Location: 'https://github.testcompany.com/testowner/testrepo'
+      }
+    }));
+
+    test.done();
+  },
+
   'construct from asset'(test: Test) {
     // GIVEN
     const stack = new cdk.Stack();
@@ -70,10 +124,12 @@ export = {
           {
             Name: "SCRIPT_S3_KEY",
             Type: "PLAINTEXT",
-            Value: { "Fn::Join": [ "", [
-              { "Fn::Select": [ 0, { "Fn::Split": [ "||", { Ref: "AssetS3VersionKeyA852DDAE" } ] } ] },
-              { "Fn::Select": [ 1, { "Fn::Split": [ "||", { Ref: "AssetS3VersionKeyA852DDAE" } ] } ] }
-            ] ] }
+            Value: {
+              "Fn::Join": ["", [
+                { "Fn::Select": [0, { "Fn::Split": ["||", { Ref: "AssetS3VersionKeyA852DDAE" }] }] },
+                { "Fn::Select": [1, { "Fn::Split": ["||", { Ref: "AssetS3VersionKeyA852DDAE" }] }] }
+              ]]
+            }
           }
         ],
       },
