feat: implement reproducible build and get cached image #213
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,6 +34,8 @@ import ( | |
| "github.com/go-git/go-billy/v5/memfs" | ||
| "github.com/google/go-containerregistry/pkg/authn" | ||
| "github.com/google/go-containerregistry/pkg/name" | ||
| "github.com/google/go-containerregistry/pkg/registry" | ||
| "github.com/google/go-containerregistry/pkg/v1/remote" | ||
| "github.com/google/go-containerregistry/pkg/v1/remote/transport" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
@@ -987,6 +989,252 @@ COPY %s .`, testImageAlpine, inclFile) | |
| } | ||
| } | ||
|
|
||
| func TestPushImage(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| t.Run("CacheWithoutPush", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| srv := createGitServer(t, gitServerOptions{ | ||
| files: map[string]string{ | ||
| ".devcontainer/Dockerfile": fmt.Sprintf("FROM %s\nRUN date --utc > /root/date.txt", testImageAlpine), | ||
| ".devcontainer/devcontainer.json": `{ | ||
| "name": "Test", | ||
| "build": { | ||
| "dockerfile": "Dockerfile" | ||
| }, | ||
| }`, | ||
| }, | ||
| }) | ||
|
|
||
| // Given: an empty registry | ||
| testReg := setupInMemoryRegistry(t) | ||
| testRepo := testReg + "/test" | ||
| ref, err := name.ParseReference(testRepo + ":latest") | ||
| require.NoError(t, err) | ||
| _, err = remote.Image(ref) | ||
| require.ErrorContains(t, err, "NAME_UNKNOWN", "expected image to not be present before build + push") | ||
|
|
||
| // When: we run envbuilder with GET_CACHED_IMAGE | ||
| _, err = runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("CACHE_REPO", testRepo), | ||
| envbuilderEnv("GET_CACHED_IMAGE", "1"), | ||
| }}) | ||
| require.ErrorContains(t, err, "not supported in fake build") | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // Then: it should fail to build the image and nothing should be pushed | ||
| _, err = remote.Image(ref) | ||
| require.ErrorContains(t, err, "NAME_UNKNOWN", "expected image to not be present before build + push") | ||
|
|
||
| // When: we run envbuilder with PUSH_IMAGE set | ||
| _, err = runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("CACHE_REPO", testRepo), | ||
| }}) | ||
| require.NoError(t, err) | ||
|
|
||
| // Then: the image tag should not be present, only the layers | ||
| _, err = remote.Image(ref) | ||
| require.ErrorContains(t, err, "MANIFEST_UNKNOWN", "expected image to not be present before build + push") | ||
|
|
||
| // Then: re-running envbuilder with GET_CACHED_IMAGE should succeed | ||
| _, err = runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("CACHE_REPO", testRepo), | ||
| envbuilderEnv("GET_CACHED_IMAGE", "1"), | ||
| }}) | ||
| require.NoError(t, err) | ||
| }) | ||
|
|
||
| t.Run("CacheAndPush", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| srv := createGitServer(t, gitServerOptions{ | ||
| files: map[string]string{ | ||
| ".devcontainer/Dockerfile": fmt.Sprintf("FROM %s\nRUN date --utc > /root/date.txt", testImageAlpine), | ||
| ".devcontainer/devcontainer.json": `{ | ||
| "name": "Test", | ||
| "build": { | ||
| "dockerfile": "Dockerfile" | ||
| }, | ||
| }`, | ||
| }, | ||
| }) | ||
|
|
||
| // Given: an empty registry | ||
| testReg := setupInMemoryRegistry(t) | ||
| testRepo := testReg + "/test" | ||
| ref, err := name.ParseReference(testRepo + ":latest") | ||
| require.NoError(t, err) | ||
| _, err = remote.Image(ref) | ||
| require.ErrorContains(t, err, "NAME_UNKNOWN", "expected image to not be present before build + push") | ||
|
|
||
| // When: we run envbuilder with GET_CACHED_IMAGE | ||
| _, err = runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("CACHE_REPO", testRepo), | ||
| envbuilderEnv("GET_CACHED_IMAGE", "1"), | ||
| }}) | ||
| require.ErrorContains(t, err, "not supported in fake build") | ||
| // Then: it should fail to build the image and nothing should be pushed | ||
| _, err = remote.Image(ref) | ||
| require.ErrorContains(t, err, "NAME_UNKNOWN", "expected image to not be present before build + push") | ||
|
|
||
| // When: we run envbuilder with PUSH_IMAGE set | ||
| _, err = runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("CACHE_REPO", testRepo), | ||
| envbuilderEnv("PUSH_IMAGE", "1"), | ||
| }}) | ||
| require.NoError(t, err) | ||
|
|
||
| // Then: the image should be pushed | ||
| _, err = remote.Image(ref) | ||
| require.NoError(t, err, "expected image to be present after build + push") | ||
|
|
||
| // Then: re-running envbuilder with GET_CACHED_IMAGE should succeed | ||
| _, err = runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("CACHE_REPO", testRepo), | ||
| envbuilderEnv("GET_CACHED_IMAGE", "1"), | ||
| }}) | ||
| require.NoError(t, err) | ||
| }) | ||
|
|
||
| t.Run("CacheAndPushMultistage", func(t *testing.T) { | ||
| // Currently fails with: | ||
|
There was a problem hiding this comment. Is there a way we can make this fail more gracefully? This output is rather difficult to reason about. There was a problem hiding this comment. There probably is, but I'd say we should handle it as part of #230 |
||
| // /home/coder/src/coder/envbuilder/integration/integration_test.go:1417: "error: unable to get cached image: error fake building stage: failed to optimize instructions: failed to get files used from context: failed to get fileinfo for /.envbuilder/0/root/date.txt: lstat /.envbuilder/0/root/date.txt: no such file or directory" | ||
| // /home/coder/src/coder/envbuilder/integration/integration_test.go:1156: | ||
| // Error Trace: /home/coder/src/coder/envbuilder/integration/integration_test.go:1156 | ||
| // Error: Received unexpected error: | ||
| // error: unable to get cached image: error fake building stage: failed to optimize instructions: failed to get files used from context: failed to get fileinfo for /.envbuilder/0/root/date.txt: lstat /.envbuilder/0/root/date.txt: no such file or directory | ||
| // Test: TestPushImage/CacheAndPushMultistage | ||
| t.Skip("TODO: https://github.com/coder/envbuilder/issues/230") | ||
| t.Parallel() | ||
|
|
||
| srv := createGitServer(t, gitServerOptions{ | ||
| files: map[string]string{ | ||
| "Dockerfile": fmt.Sprintf(`FROM %s AS a | ||
| RUN date --utc > /root/date.txt | ||
| FROM %s as b | ||
| COPY --from=a /root/date.txt /date.txt`, testImageAlpine, testImageAlpine), | ||
| }, | ||
| }) | ||
|
|
||
| // Given: an empty registry | ||
| testReg := setupInMemoryRegistry(t) | ||
| testRepo := testReg + "/test" | ||
| ref, err := name.ParseReference(testRepo + ":latest") | ||
| require.NoError(t, err) | ||
| _, err = remote.Image(ref) | ||
| require.ErrorContains(t, err, "NAME_UNKNOWN", "expected image to not be present before build + push") | ||
|
|
||
| // When: we run envbuilder with GET_CACHED_IMAGE | ||
| _, err = runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("CACHE_REPO", testRepo), | ||
| envbuilderEnv("GET_CACHED_IMAGE", "1"), | ||
| envbuilderEnv("DOCKERFILE_PATH", "Dockerfile"), | ||
| }}) | ||
| require.ErrorContains(t, err, "not supported in fake build") | ||
| // Then: it should fail to build the image and nothing should be pushed | ||
| _, err = remote.Image(ref) | ||
| require.ErrorContains(t, err, "NAME_UNKNOWN", "expected image to not be present before build + push") | ||
|
|
||
| // When: we run envbuilder with PUSH_IMAGE set | ||
| ctrID, err := runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("CACHE_REPO", testRepo), | ||
| envbuilderEnv("PUSH_IMAGE", "1"), | ||
| envbuilderEnv("DOCKERFILE_PATH", "Dockerfile"), | ||
| }}) | ||
| require.NoError(t, err) | ||
| // Then: The file copied from stage a should be present | ||
| out := execContainer(t, ctrID, "cat /date.txt") | ||
| require.NotEmpty(t, out) | ||
|
|
||
| // Then: the image should be pushed | ||
| _, err = remote.Image(ref) | ||
| require.NoError(t, err, "expected image to be present after build + push") | ||
|
|
||
| // Then: re-running envbuilder with GET_CACHED_IMAGE should succeed | ||
| _, err = runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("CACHE_REPO", testRepo), | ||
| envbuilderEnv("GET_CACHED_IMAGE", "1"), | ||
| envbuilderEnv("DOCKERFILE_PATH", "Dockerfile"), | ||
| }}) | ||
| require.NoError(t, err) | ||
| }) | ||
|
|
||
| t.Run("PushImageRequiresCache", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| srv := createGitServer(t, gitServerOptions{ | ||
| files: map[string]string{ | ||
| ".devcontainer/Dockerfile": fmt.Sprintf("FROM %s\nRUN date --utc > /root/date.txt", testImageAlpine), | ||
| ".devcontainer/devcontainer.json": `{ | ||
| "name": "Test", | ||
| "build": { | ||
| "dockerfile": "Dockerfile" | ||
| }, | ||
| }`, | ||
| }, | ||
| }) | ||
|
|
||
| // When: we run envbuilder with PUSH_IMAGE set but no cache repo set | ||
| _, err := runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("PUSH_IMAGE", "1"), | ||
| }}) | ||
|
|
||
| // Then: Envbuilder should fail explicitly, as it does not make sense to | ||
| // specify PUSH_IMAGE | ||
| require.ErrorContains(t, err, "--cache-repo must be set when using --push-image") | ||
| }) | ||
|
|
||
| t.Run("PushErr", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| srv := createGitServer(t, gitServerOptions{ | ||
| files: map[string]string{ | ||
| ".devcontainer/Dockerfile": fmt.Sprintf("FROM %s\nRUN date --utc > /root/date.txt", testImageAlpine), | ||
| ".devcontainer/devcontainer.json": `{ | ||
| "name": "Test", | ||
| "build": { | ||
| "dockerfile": "Dockerfile" | ||
| }, | ||
| }`, | ||
| }, | ||
| }) | ||
|
|
||
| // Given: registry is not set up (in this case, not a registry) | ||
| notRegSrv := httptest.NewServer(http.NotFoundHandler()) | ||
| notRegURL := strings.TrimPrefix(notRegSrv.URL, "http://") + "/test" | ||
|
|
||
| // When: we run envbuilder with PUSH_IMAGE set | ||
| _, err := runEnvbuilder(t, options{env: []string{ | ||
| envbuilderEnv("GIT_URL", srv.URL), | ||
| envbuilderEnv("CACHE_REPO", notRegURL), | ||
| envbuilderEnv("PUSH_IMAGE", "1"), | ||
| }}) | ||
|
|
||
| // Then: envbuilder should fail with a descriptive error | ||
| require.ErrorContains(t, err, "failed to push to destination") | ||
| }) | ||
| } | ||
|
|
||
| func setupInMemoryRegistry(t *testing.T) string { | ||
| t.Helper() | ||
| tempDir := t.TempDir() | ||
| testReg := registry.New(registry.WithBlobHandler(registry.NewDiskBlobHandler(tempDir))) | ||
| regSrv := httptest.NewServer(testReg) | ||
| t.Cleanup(func() { regSrv.Close() }) | ||
| regSrvURL, err := url.Parse(regSrv.URL) | ||
| require.NoError(t, err) | ||
| return fmt.Sprintf("localhost:%s", regSrvURL.Port()) | ||
| } | ||
|
|
||
| // TestMain runs before all tests to build the envbuilder image. | ||
| func TestMain(m *testing.M) { | ||
| checkTestRegistry() | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.