feat: add remote_repo_build_mode envbuilder option

Author: johnstcn

GNUmakefile

@@ -36,7 +36,7 @@ test-registry: test-registry-container test-images-pull test-images-push
 test-registry-container: .registry-cache
 	if ! curl -fsSL http://localhost:5000/v2/_catalog > /dev/null 2>&1; then \
 		docker rm -f tfprov-envbuilder-registry && \
-		docker run -d -p 5000:5000 --name envbuilder-registry --volume $(PWD)/.registry-cache:/var/lib/registry registry:2; \
+		docker run -d -p 5000:5000 --name tfprov-envbuilder-registry --volume $(PWD)/.registry-cache:/var/lib/registry registry:2; \
 	fi
 
 # Pulls images referenced in integration tests and pushes them to the local cache.

docs/resources/cached_image.md

@@ -41,6 +41,7 @@ The cached image resource can be used to retrieve a cached image produced by env
 - `git_username` (String) (Envbuilder option) The username to use for Git authentication. This is optional.
 - `ignore_paths` (List of String) (Envbuilder option) The comma separated list of paths to ignore when building the workspace.
 - `insecure` (Boolean) (Envbuilder option) Bypass TLS verification when cloning and pulling from container registries.
+- `remote_repo_build_mode` (Boolean) (Envbuilder option) RemoteRepoBuildMode uses the remote repository as the source of truth when building the image. Enabling this option ignores user changes to local files and they will not be reflected in the image. This can be used to improve cache utilization when multiple users are working on the same repository.
 - `ssl_cert_base64` (String) (Envbuilder option) The content of an SSL cert file. This is useful for self-signed certificates.
 - `verbose` (Boolean) (Envbuilder option) Enable verbose output.
 - `workspace_folder` (String) (Envbuilder option) path to the workspace folder that will be built. This is optional.

internal/provider/cached_image_resource.go

@@ -73,6 +73,7 @@ type CachedImageResourceModel struct {
 	GitUsername          types.String `tfsdk:"git_username"`
 	IgnorePaths          types.List   `tfsdk:"ignore_paths"`
 	Insecure             types.Bool   `tfsdk:"insecure"`
+	RemoteRepoBuildMode  types.Bool   `tfsdk:"remote_repo_build_mode"`
 	SSLCertBase64        types.String `tfsdk:"ssl_cert_base64"`
 	Verbose              types.Bool   `tfsdk:"verbose"`
 	WorkspaceFolder      types.String `tfsdk:"workspace_folder"`
@@ -206,6 +207,13 @@ func (r *CachedImageResource) Schema(ctx context.Context, req resource.SchemaReq
 				MarkdownDescription: "(Envbuilder option) Bypass TLS verification when cloning and pulling from container registries.",
 				Optional:            true,
 			},
+			"remote_repo_build_mode": schema.BoolAttribute{
+				MarkdownDescription: "(Envbuilder option) RemoteRepoBuildMode uses the remote repository as the source of truth when building the image. Enabling this option ignores user changes to local files and they will not be reflected in the image. This can be used to improve cache utilization when multiple users are working on the same repository.",
+				Optional:            true,
+				PlanModifiers: []planmodifier.Bool{
+					boolplanmodifier.RequiresReplace(),
+				},
+			},
 			"ssl_cert_base64": schema.StringAttribute{
 				MarkdownDescription: "(Envbuilder option) The content of an SSL cert file. This is useful for self-signed certificates.",
 				Optional:            true,
@@ -482,6 +490,7 @@ func (r *CachedImageResource) runCacheProbe(ctx context.Context, data CachedImag
 		GitPassword:          data.GitPassword.ValueString(),
 		GitSSHPrivateKeyPath: data.GitSSHPrivateKeyPath.ValueString(),
 		GitHTTPProxyURL:      data.GitHTTPProxyURL.ValueString(),
+		RemoteRepoBuildMode:  data.RemoteRepoBuildMode.ValueBool(),
 		SSLCertBase64:        data.SSLCertBase64.ValueString(),
 
 		// Other options

internal/provider/provider_test.go

@@ -38,10 +38,11 @@ var testAccProtoV6ProviderFactories = map[string]func() (tfprotov6.ProviderServe
 
 // testDependencies contain information about stuff the test depends on.
 type testDependencies struct {
-	BuilderImage string
-	CacheRepo    string
-	ExtraEnv     map[string]string
-	Repo         testGitRepoSSH
+	BuilderImage        string
+	CacheRepo           string
+	ExtraEnv            map[string]string
+	Repo                testGitRepoSSH
+	RemoteRepoBuildMode bool
 }
 
 // Config generates a valid Terraform config file from the dependencies.
@@ -59,6 +60,7 @@ resource "envbuilder_cached_image" "test" {
 	}
 	git_url                  = {{ quote .Repo.URL }}
 	git_ssh_private_key_path = {{ quote .Repo.Key }}
+	remote_repo_build_mode   = {{ .RemoteRepoBuildMode }}
 	verbose                  = true
 	workspace_folder         = {{ quote .Repo.Dir }}
 }`
@@ -91,10 +93,11 @@ func setup(ctx context.Context, t testing.TB, files map[string]string) testDepen
 	gitRepo := serveGitRepoSSH(ctx, t, repoDir)
 
 	return testDependencies{
-		BuilderImage: envbuilderImageRef,
-		CacheRepo:    reg + "/test",
-		ExtraEnv:     make(map[string]string),
-		Repo:         gitRepo,
+		BuilderImage:        envbuilderImageRef,
+		CacheRepo:           reg + "/test",
+		ExtraEnv:            make(map[string]string),
+		Repo:                gitRepo,
+		RemoteRepoBuildMode: true,
 	}
 }