fix(codebuild): setting Cache.none() renders nothing in the template

When implementing caching in CodeBuild, we made the default cache `Cache.none()`, and, for that reason, do not render anything in the template for that type of cache. However, that does not work well with the CodeBuild API, which interprets the lack of a property as the signal to leave it unchanged. Which means it's not possible currently to disable caching on a Project once it has been enabled once. Fix this by differentiating between the case of "no Cache has been provided", and "the none() Cache has been provided". Closes aws#18165
skinny85 · Dec 31, 2021 · 898905b · 898905b
1 parent 7df4a58
commit 898905b
Show file tree

Hide file tree

Showing 3 changed files with 120 additions and 82 deletions.
diff --git a/packages/@aws-cdk/aws-codebuild/lib/cache.ts b/packages/@aws-cdk/aws-codebuild/lib/cache.ts
@@ -37,7 +37,13 @@ export enum LocalCacheMode {
  */
 export abstract class Cache {
   public static none(): Cache {
-    return { _toCloudFormation: () => undefined, _bind: () => { return; } };
+    return {
+      _toCloudFormation(): CfnProject.ProjectCacheProperty | undefined {
+        return { type: 'NO_CACHE' };
+      },
+      _bind(): void {
+      },
+    };
   }
 
   /**

diff --git a/packages/@aws-cdk/aws-codebuild/test/codebuild.test.ts b/packages/@aws-cdk/aws-codebuild/test/codebuild.test.ts
@@ -155,6 +155,9 @@ describe('default properties', () => {
               'ComputeType': 'BUILD_GENERAL1_SMALL',
             },
             'EncryptionKey': 'alias/aws/s3',
+            'Cache': {
+              'Type': 'NO_CACHE',
+            },
           },
         },
       },
@@ -335,6 +338,9 @@ describe('default properties', () => {
               'Type': 'CODECOMMIT',
             },
             'EncryptionKey': 'alias/aws/s3',
+            'Cache': {
+              'Type': 'NO_CACHE',
+            },
           },
         },
       },
@@ -539,6 +545,9 @@ describe('default properties', () => {
               'Type': 'S3',
             },
             'EncryptionKey': 'alias/aws/s3',
+            'Cache': {
+              'Type': 'NO_CACHE',
+            },
           },
         },
       },

diff --git a/packages/@aws-cdk/aws-codebuild/test/project.test.ts b/packages/@aws-cdk/aws-codebuild/test/project.test.ts
@@ -1,4 +1,4 @@
-import { objectLike, ResourcePart, arrayWith } from '@aws-cdk/assert-internal';
+import { ABSENT, objectLike, ResourcePart, arrayWith } from '@aws-cdk/assert-internal';
 import '@aws-cdk/assert-internal/jest';
 import * as ec2 from '@aws-cdk/aws-ec2';
 import * as iam from '@aws-cdk/aws-iam';
@@ -292,103 +292,126 @@ describe('BitBucket source', () => {
   });
 });
 
-test('project with s3 cache bucket', () => {
-  // GIVEN
-  const stack = new cdk.Stack();
+describe('caching', () => {
+  test('using Cache.none() results in NO_CACHE in the template', () => {
+    // GIVEN
+    const stack = new cdk.Stack();
 
-  // WHEN
-  new codebuild.Project(stack, 'Project', {
-    source: codebuild.Source.s3({
-      bucket: new s3.Bucket(stack, 'SourceBucket'),
-      path: 'path',
-    }),
-    cache: codebuild.Cache.bucket(new s3.Bucket(stack, 'Bucket'), {
-      prefix: 'cache-prefix',
-    }),
+    // WHEN
+    new codebuild.PipelineProject(stack, 'Project', {
+      cache: codebuild.Cache.none(),
+    });
+
+    // THEN
+    expect(stack).toHaveResourceLike('AWS::CodeBuild::Project', {
+      Cache: {
+        Type: 'NO_CACHE',
+        Location: ABSENT,
+      },
+    });
   });
 
-  // THEN
-  expect(stack).toHaveResourceLike('AWS::CodeBuild::Project', {
-    Cache: {
-      Type: 'S3',
-      Location: {
-        'Fn::Join': [
-          '/',
-          [
-            {
-              'Ref': 'Bucket83908E77',
-            },
-            'cache-prefix',
+  test('project with s3 cache bucket', () => {
+    // GIVEN
+    const stack = new cdk.Stack();
+
+    // WHEN
+    new codebuild.Project(stack, 'Project', {
+      source: codebuild.Source.s3({
+        bucket: new s3.Bucket(stack, 'SourceBucket'),
+        path: 'path',
+      }),
+      cache: codebuild.Cache.bucket(new s3.Bucket(stack, 'Bucket'), {
+        prefix: 'cache-prefix',
+      }),
+    });
+
+    // THEN
+    expect(stack).toHaveResourceLike('AWS::CodeBuild::Project', {
+      Cache: {
+        Type: 'S3',
+        Location: {
+          'Fn::Join': [
+            '/',
+            [
+              {
+                'Ref': 'Bucket83908E77',
+              },
+              'cache-prefix',
+            ],
           ],
-        ],
+        },
       },
-    },
+    });
   });
-});
 
-test('s3 codebuild project with sourceVersion', () => {
-  // GIVEN
-  const stack = new cdk.Stack();
+  test('s3 codebuild project with sourceVersion', () => {
+    // GIVEN
+    const stack = new cdk.Stack();
 
-  // WHEN
-  new codebuild.Project(stack, 'Project', {
-    source: codebuild.Source.s3({
-      bucket: new s3.Bucket(stack, 'Bucket'),
-      path: 'path',
-      version: 's3version',
-    }),
-    cache: codebuild.Cache.local(codebuild.LocalCacheMode.CUSTOM, codebuild.LocalCacheMode.DOCKER_LAYER,
-      codebuild.LocalCacheMode.SOURCE),
-  });
+    // WHEN
+    new codebuild.Project(stack, 'Project', {
+      source: codebuild.Source.s3({
+        bucket: new s3.Bucket(stack, 'Bucket'),
+        path: 'path',
+        version: 's3version',
+      }),
+      cache: codebuild.Cache.local(codebuild.LocalCacheMode.CUSTOM, codebuild.LocalCacheMode.DOCKER_LAYER,
+        codebuild.LocalCacheMode.SOURCE),
+    });
 
-  // THEN
-  expect(stack).toHaveResource('AWS::CodeBuild::Project', {
-    SourceVersion: 's3version',
+    // THEN
+    expect(stack).toHaveResource('AWS::CodeBuild::Project', {
+      SourceVersion: 's3version',
+    });
   });
-});
 
-test('project with local cache modes', () => {
-  // GIVEN
-  const stack = new cdk.Stack();
+  test('project with local cache modes', () => {
+    // GIVEN
+    const stack = new cdk.Stack();
 
-  // WHEN
-  new codebuild.Project(stack, 'Project', {
-    source: codebuild.Source.s3({
-      bucket: new s3.Bucket(stack, 'Bucket'),
-      path: 'path',
-    }),
-    cache: codebuild.Cache.local(codebuild.LocalCacheMode.CUSTOM, codebuild.LocalCacheMode.DOCKER_LAYER,
-      codebuild.LocalCacheMode.SOURCE),
-  });
+    // WHEN
+    new codebuild.Project(stack, 'Project', {
+      source: codebuild.Source.s3({
+        bucket: new s3.Bucket(stack, 'Bucket'),
+        path: 'path',
+      }),
+      cache: codebuild.Cache.local(codebuild.LocalCacheMode.CUSTOM, codebuild.LocalCacheMode.DOCKER_LAYER,
+        codebuild.LocalCacheMode.SOURCE),
+    });
 
-  // THEN
-  expect(stack).toHaveResourceLike('AWS::CodeBuild::Project', {
-    Cache: {
-      Type: 'LOCAL',
-      Modes: [
-        'LOCAL_CUSTOM_CACHE',
-        'LOCAL_DOCKER_LAYER_CACHE',
-        'LOCAL_SOURCE_CACHE',
-      ],
-    },
+    // THEN
+    expect(stack).toHaveResourceLike('AWS::CodeBuild::Project', {
+      Cache: {
+        Type: 'LOCAL',
+        Modes: [
+          'LOCAL_CUSTOM_CACHE',
+          'LOCAL_DOCKER_LAYER_CACHE',
+          'LOCAL_SOURCE_CACHE',
+        ],
+      },
+    });
   });
-});
 
-test('project by default has no cache modes', () => {
-  // GIVEN
-  const stack = new cdk.Stack();
+  test('project by default has cache type set to NO_CACHE', () => {
+    // GIVEN
+    const stack = new cdk.Stack();
 
-  // WHEN
-  new codebuild.Project(stack, 'Project', {
-    source: codebuild.Source.s3({
-      bucket: new s3.Bucket(stack, 'Bucket'),
-      path: 'path',
-    }),
-  });
+    // WHEN
+    new codebuild.Project(stack, 'Project', {
+      source: codebuild.Source.s3({
+        bucket: new s3.Bucket(stack, 'Bucket'),
+        path: 'path',
+      }),
+    });
 
-  // THEN
-  expect(stack).not.toHaveResourceLike('AWS::CodeBuild::Project', {
-    Cache: {},
+    // THEN
+    expect(stack).toHaveResourceLike('AWS::CodeBuild::Project', {
+      Cache: {
+        Type: 'NO_CACHE',
+        Location: ABSENT,
+      },
+    });
   });
 });