Skip to content

Commit 8328c79

Browse files
AbogicalAbogical
authored
fix(ecr-assets): incorrect handling of nested excludes in .dockerignore (#34810)
### Issue #13636 Closes #13636. ### Reason for this change Fixes a bug where asset copying does not correctly process .dockerignore files. CDK did not copy files excluded by a nested exclude pattern in `.dockerignore`. ### Description of changes Added a new method in `DockerIgnoreStrategy` that determines whether a directory is fully or partially ignored. The method is `DockerIgnoreStrategy.completelyIgnores` and if it returns true, it means that the directory is ignored AND that all of its children are ignored as well. For directories that are ignored but not "completely" ignored, the copyDirectory function will still walk through them. As this changes the behaviour of asset copying, this can potientally be a breaking change. Therefore, a new feature flag is added which enables this fix. The feature flag is `DOCKER_IGNORE_NESTED_EXCLUDE_FIX`. ### Describe any new or updated permissions being added No new permissions are added. ### Description of how you validated changes Unit tests and integration tests are added. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 6c661e5 commit 8328c79

File tree

19 files changed

+555
-432
lines changed

19 files changed

+555
-432
lines changed

‎packages/@aws-cdk-testing/framework-integ/test/aws-ecr-assets/test/demo-image-dockerignore/.dockerignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
**
2+
!build/**/*.py
3+
build/extra/extra.py

‎packages/@aws-cdk-testing/framework-integ/test/aws-ecr-assets/test/demo-image-dockerignore/Dockerfile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
FROM public.ecr.aws/lambda/python:3.6
2+
EXPOSE 8000
3+
WORKDIR /src
4+
ADD . /src
5+
CMD python3 build/main/index.py

‎packages/@aws-cdk-testing/framework-integ/test/aws-ecr-assets/test/demo-image-dockerignore/bin.py

Whitespace-only changes.

‎packages/@aws-cdk-testing/framework-integ/test/aws-ecr-assets/test/demo-image-dockerignore/build/extra/extra.py

Whitespace-only changes.

‎packages/@aws-cdk-testing/framework-integ/test/aws-ecr-assets/test/demo-image-dockerignore/build/main/index.py

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#!/usr/bin/python
2+
import sys
3+
import textwrap
4+
import http.server
5+
import socketserver
6+
7+
PORT = 8000
8+
9+
10+
class Handler(http.server.SimpleHTTPRequestHandler):
11+
def do_GET(self):
12+
self.send_response(200)
13+
self.send_header('Content-Type', 'text/html')
14+
self.end_headers()
15+
self.wfile.write(textwrap.dedent('''\
16+
<!doctype html>
17+
<html><head><title>It works</title></head>
18+
<body>
19+
<h1>Hello from the integ test container</h1>
20+
<p>This container got built and started as part of the integ test.</p>
21+
<img src="https://media.giphy.com/media/nFjDu1LjEADh6/giphy.gif">
22+
</body>
23+
''').encode('utf-8'))
24+
25+
26+
def main():
27+
httpd = http.server.HTTPServer(("", PORT), Handler)
28+
print("serving at port", PORT)
29+
httpd.serve_forever()
30+
31+
32+
if __name__ == '__main__':
33+
main()

‎packages/@aws-cdk-testing/framework-integ/test/aws-ecr-assets/test/integ.assets-docker.js.snapshot/asset.7937f4f8197a9feee726dbb5f91b41ff615930260bf8e300bf64d070886e3183/.dockerignore

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/@aws-cdk-testing/framework-integ/test/aws-ecr-assets/test/integ.assets-docker.js.snapshot/asset.7937f4f8197a9feee726dbb5f91b41ff615930260bf8e300bf64d070886e3183/Dockerfile

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/@aws-cdk-testing/framework-integ/test/aws-ecr-assets/test/integ.assets-docker.js.snapshot/asset.7937f4f8197a9feee726dbb5f91b41ff615930260bf8e300bf64d070886e3183/build/main/index.py

Lines changed: 33 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/@aws-cdk-testing/framework-integ/test/aws-ecr-assets/test/integ.assets-docker.js.snapshot/cdk.out

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/@aws-cdk-testing/framework-integ/test/aws-ecr-assets/test/integ.assets-docker.js.snapshot/integ-assets-docker.assets.json

Lines changed: 22 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)