feat(vcr): add public repository option (#572)

* add public repository resource

* fix docs

Author: AndyW22

client/vcr_repository.go

@@ -15,6 +15,7 @@ type VCRRepository struct {
 	ID        string `json:"id"`
 	Name      string `json:"name"`
 	ProjectID string `json:"projectId"`
+	Public    bool   `json:"public"`
 	URL       string `json:"-"`
 	TeamID    string `json:"-"`
 }
@@ -133,6 +134,48 @@ func (c *Client) GetVCRRepository(ctx context.Context, request GetVCRRepositoryR
 	return res, nil
 }
 
+type UpdateVCRRepositoryRequest struct {
+	TeamID    string `json:"-"`
+	ProjectID string `json:"-"`
+	IDOrName  string `json:"-"`
+	Public    bool   `json:"public"`
+}
+
+func (c *Client) UpdateVCRRepository(ctx context.Context, request UpdateVCRRepositoryRequest) (res VCRRepository, err error) {
+	url := fmt.Sprintf("%s/v1/vcr/repository/%s?projectId=%s", c.baseURL, request.IDOrName, request.ProjectID)
+	if c.TeamID(request.TeamID) != "" {
+		url = fmt.Sprintf("%s&teamId=%s", url, c.TeamID(request.TeamID))
+	}
+	payload := string(mustMarshal(request))
+	tflog.Info(ctx, "updating vcr repository", map[string]any{
+		"url":     url,
+		"payload": payload,
+	})
+	var out vcrRepositoryResponse
+	err = c.doRequest(clientRequest{
+		ctx:    ctx,
+		method: "PATCH",
+		url:    url,
+		body:   payload,
+	}, &out)
+	if err != nil {
+		return res, err
+	}
+	res = out.repository()
+	if res.Name == "" {
+		res.Name = request.IDOrName
+	}
+	if res.ProjectID == "" {
+		res.ProjectID = request.ProjectID
+	}
+	res.TeamID = c.TeamID(request.TeamID)
+	res.URL, err = c.vcrRepositoryURL(ctx, request.TeamID, res.ProjectID, res.Name)
+	if err != nil {
+		return res, err
+	}
+	return res, nil
+}
+
 type DeleteVCRRepositoryRequest struct {
 	TeamID    string `json:"-"`
 	ProjectID string `json:"-"`

client/vcr_repository_test.go

@@ -0,0 +1,60 @@
+package client
+
+import (
+	"context"
+	"encoding/json"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+)
+
+func TestUpdateVCRRepository(t *testing.T) {
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		switch r.URL.Path {
+		case "/v1/vcr/repository/repo_123":
+			if r.Method != http.MethodPatch {
+				t.Fatalf("method = %s, want PATCH", r.Method)
+			}
+			if projectID := r.URL.Query().Get("projectId"); projectID != "prj_123" {
+				t.Fatalf("projectId = %q, want prj_123", projectID)
+			}
+			if teamID := r.URL.Query().Get("teamId"); teamID != "team_123" {
+				t.Fatalf("teamId = %q, want team_123", teamID)
+			}
+			var body map[string]any
+			if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
+				t.Fatalf("Decode() error = %v", err)
+			}
+			if len(body) != 1 || body["public"] != true {
+				t.Fatalf("body = %#v, want only public=true", body)
+			}
+			_, _ = w.Write([]byte(`{"repository":{"id":"repo_123","projectId":"prj_123","name":"example","public":true}}`))
+		case "/v2/teams/team_123":
+			_, _ = w.Write([]byte(`{"id":"team_123","slug":"acme"}`))
+		case "/v10/projects/prj_123":
+			_, _ = w.Write([]byte(`{"id":"prj_123","name":"storefront"}`))
+		default:
+			http.NotFound(w, r)
+		}
+	}))
+	t.Cleanup(server.Close)
+
+	repository, err := New("TOKEN").WithBaseURL(server.URL).UpdateVCRRepository(context.Background(), UpdateVCRRepositoryRequest{
+		TeamID:    "team_123",
+		ProjectID: "prj_123",
+		IDOrName:  "repo_123",
+		Public:    true,
+	})
+	if err != nil {
+		t.Fatalf("UpdateVCRRepository() error = %v", err)
+	}
+	if !repository.Public {
+		t.Fatal("repository.Public = false, want true")
+	}
+	if repository.URL != "vcr.vercel.com/acme/storefront/example" {
+		t.Fatalf("repository.URL = %q, want vcr.vercel.com/acme/storefront/example", repository.URL)
+	}
+	if repository.TeamID != "team_123" {
+		t.Fatalf("repository.TeamID = %q, want team_123", repository.TeamID)
+	}
+}

docs/data-sources/vcr_repository.md

@@ -39,4 +39,5 @@ data "vercel_vcr_repository" "example" {
 ### Read-Only
 
 - `id` (String) The ID of the VCR Repository.
+- `public` (Boolean) Whether the repository is pullable by any Vercel team.
 - `url` (String) The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. `vcr.vercel.com/team-slug/project-slug/repository-name`). Use it to push and pull images with Docker-compatible tooling.

docs/resources/vcr_repository.md

@@ -27,6 +27,7 @@ resource "vercel_project" "example" {
 resource "vercel_vcr_repository" "example" {
   project_id = vercel_project.example.id
   name       = "my-repository"
+  public     = true
 }
 ```
 
@@ -40,6 +41,7 @@ resource "vercel_vcr_repository" "example" {
 
 ### Optional
 
+- `public` (Boolean) Whether the repository is pullable by any Vercel team. Private repositories are only accessible within the same project. Defaults to `false`.
 - `team_id` (String) The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
 
 ### Read-Only

examples/resources/vercel_vcr_repository/resource.tf

@@ -5,4 +5,5 @@ resource "vercel_project" "example" {
 resource "vercel_vcr_repository" "example" {
   project_id = vercel_project.example.id
   name       = "my-repository"
+  public     = true
 }

vercel/data_source_vcr_repository.go

@@ -71,6 +71,10 @@ used by Vercel Functions and Vercel Sandbox.
 				Description: "The name of the repository.",
 				Required:    true,
 			},
+			"public": schema.BoolAttribute{
+				Computed:    true,
+				Description: "Whether the repository is pullable by any Vercel team.",
+			},
 			"url": schema.StringAttribute{
 				Computed:    true,
 				Description: "The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. `vcr.vercel.com/team-slug/project-slug/repository-name`). Use it to push and pull images with Docker-compatible tooling.",
@@ -109,6 +113,7 @@ func (d *vcrRepositoryDataSource) Read(ctx context.Context, req datasource.ReadR
 		"team_id":    res.TeamID,
 		"project_id": res.ProjectID,
 		"name":       res.Name,
+		"public":     res.Public,
 	})
 
 	diags = resp.State.Set(ctx, convertResponseToVCRRepository(res))

vercel/data_source_vcr_repository_test.go

@@ -20,6 +20,7 @@ func TestAcc_VCRRepositoryDataSource(t *testing.T) {
 					resource.TestCheckResourceAttrSet("data.vercel_vcr_repository.test", "id"),
 					resource.TestCheckResourceAttrSet("data.vercel_vcr_repository.test", "project_id"),
 					resource.TestCheckResourceAttr("data.vercel_vcr_repository.test", "name", fmt.Sprintf("test-acc-%s", projectSuffix)),
+					resource.TestCheckResourceAttr("data.vercel_vcr_repository.test", "public", "false"),
 					resource.TestCheckResourceAttrSet("data.vercel_vcr_repository.test", "url"),
 				),
 			},

vercel/resource_vcr_repository.go

@@ -8,6 +8,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
@@ -88,6 +89,12 @@ used by Vercel Functions and Vercel Sandbox. Images are pushed to and pulled fro
 					),
 				},
 			},
+			"public": schema.BoolAttribute{
+				Optional:    true,
+				Computed:    true,
+				Default:     booldefault.StaticBool(false),
+				Description: "Whether the repository is pullable by any Vercel team. Private repositories are only accessible within the same project. Defaults to `false`.",
+			},
 			"url": schema.StringAttribute{
 				Computed:      true,
 				Description:   "The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. `vcr.vercel.com/team-slug/project-slug/repository-name`). Use it to push and pull images with Docker-compatible tooling.",
@@ -102,6 +109,7 @@ type VCRRepository struct {
 	TeamID    types.String `tfsdk:"team_id"`
 	ProjectID types.String `tfsdk:"project_id"`
 	Name      types.String `tfsdk:"name"`
+	Public    types.Bool   `tfsdk:"public"`
 	URL       types.String `tfsdk:"url"`
 }
 
@@ -117,6 +125,7 @@ func convertResponseToVCRRepository(res client.VCRRepository) VCRRepository {
 		TeamID:    types.StringValue(res.TeamID),
 		ProjectID: types.StringValue(res.ProjectID),
 		Name:      types.StringValue(res.Name),
+		Public:    types.BoolValue(res.Public),
 		URL:       types.StringValue(res.URL),
 	}
 }
@@ -141,11 +150,31 @@ func (r *vcrRepositoryResource) Create(ctx context.Context, req resource.CreateR
 		)
 		return
 	}
+	if res.Public != plan.Public.ValueBool() {
+		idOrName := res.ID
+		if idOrName == "" {
+			idOrName = res.Name
+		}
+		res, err = r.client.UpdateVCRRepository(ctx, client.UpdateVCRRepositoryRequest{
+			TeamID:    res.TeamID,
+			ProjectID: res.ProjectID,
+			IDOrName:  idOrName,
+			Public:    plan.Public.ValueBool(),
+		})
+		if err != nil {
+			resp.Diagnostics.AddError(
+				"Error updating newly created VCR Repository",
+				fmt.Sprintf("Could not set visibility for newly created VCR Repository, unexpected error: %s", err),
+			)
+			return
+		}
+	}
 
 	tflog.Info(ctx, "created vcr repository", map[string]any{
 		"team_id":    res.TeamID,
 		"project_id": res.ProjectID,
 		"name":       res.Name,
+		"public":     res.Public,
 	})
 
 	diags = resp.State.Set(ctx, convertResponseToVCRRepository(res))
@@ -186,18 +215,53 @@ func (r *vcrRepositoryResource) Read(ctx context.Context, req resource.ReadReque
 		"team_id":    res.TeamID,
 		"project_id": res.ProjectID,
 		"name":       res.Name,
+		"public":     res.Public,
 	})
 
 	diags = resp.State.Set(ctx, convertResponseToVCRRepository(res))
 	resp.Diagnostics.Append(diags...)
 }
 
-// Update is never called as all attributes force a replacement.
 func (r *vcrRepositoryResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
-	resp.Diagnostics.AddError(
-		"Error updating VCR Repository",
-		"VCR Repositories cannot be updated. Any change requires the repository to be replaced.",
-	)
+	var plan VCRRepository
+	diags := req.Plan.Get(ctx, &plan)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	res, err := r.client.UpdateVCRRepository(ctx, client.UpdateVCRRepositoryRequest{
+		TeamID:    plan.TeamID.ValueString(),
+		ProjectID: plan.ProjectID.ValueString(),
+		IDOrName:  plan.ID.ValueString(),
+		Public:    plan.Public.ValueBool(),
+	})
+	if client.NotFound(err) {
+		resp.State.RemoveResource(ctx)
+		return
+	}
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error updating VCR Repository",
+			fmt.Sprintf("Could not update VCR Repository %s %s %s, unexpected error: %s",
+				plan.TeamID.ValueString(),
+				plan.ProjectID.ValueString(),
+				plan.Name.ValueString(),
+				err,
+			),
+		)
+		return
+	}
+
+	tflog.Info(ctx, "updated vcr repository", map[string]any{
+		"team_id":    res.TeamID,
+		"project_id": res.ProjectID,
+		"name":       res.Name,
+		"public":     res.Public,
+	})
+
+	diags = resp.State.Set(ctx, convertResponseToVCRRepository(res))
+	resp.Diagnostics.Append(diags...)
 }
 
 func (r *vcrRepositoryResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {

vercel/resource_vcr_repository_test.go

@@ -11,7 +11,7 @@ import (
 	"github.com/vercel/terraform-provider-vercel/v5/client"
 )
 
-func testCheckVCRRepositoryExists(testClient *client.Client, teamID string, n string) resource.TestCheckFunc {
+func testCheckVCRRepositoryExists(testClient *client.Client, teamID string, expectedPublic bool, n string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		rs, ok := s.RootModule().Resources[n]
 		if !ok {
@@ -25,14 +25,17 @@ func testCheckVCRRepositoryExists(testClient *client.Client, teamID string, n st
 		projectID := rs.Primary.Attributes["project_id"]
 		name := rs.Primary.Attributes["name"]
 
-		_, err := testClient.GetVCRRepository(context.TODO(), client.GetVCRRepositoryRequest{
+		repository, err := testClient.GetVCRRepository(context.TODO(), client.GetVCRRepositoryRequest{
 			TeamID:    teamID,
 			ProjectID: projectID,
 			IDOrName:  name,
 		})
 		if client.NotFound(err) {
 			return fmt.Errorf("test failed because the vcr repository %s %s %s - %s could not be found", teamID, projectID, name, rs.Primary.ID)
 		}
+		if err == nil && repository.Public != expectedPublic {
+			return fmt.Errorf("vcr repository public = %t, want %t", repository.Public, expectedPublic)
+		}
 		return err
 	}
 }
@@ -44,15 +47,23 @@ func TestAcc_VCRRepositoryResource(t *testing.T) {
 		CheckDestroy:             testAccProjectDestroy(testClient(t), "vercel_project.test", testTeam(t)),
 		Steps: []resource.TestStep{
 			{
-				Config: cfg(testAccVCRRepository(projectSuffix)),
+				Config: cfg(testAccVCRRepository(projectSuffix, false)),
 				Check: resource.ComposeAggregateTestCheckFunc(
-					testCheckVCRRepositoryExists(testClient(t), testTeam(t), "vercel_vcr_repository.test"),
+					testCheckVCRRepositoryExists(testClient(t), testTeam(t), false, "vercel_vcr_repository.test"),
 					resource.TestCheckResourceAttrSet("vercel_vcr_repository.test", "id"),
 					resource.TestCheckResourceAttrSet("vercel_vcr_repository.test", "project_id"),
 					resource.TestCheckResourceAttr("vercel_vcr_repository.test", "name", fmt.Sprintf("test-acc-%s", projectSuffix)),
+					resource.TestCheckResourceAttr("vercel_vcr_repository.test", "public", "false"),
 					resource.TestCheckResourceAttrSet("vercel_vcr_repository.test", "url"),
 				),
 			},
+			{
+				Config: cfg(testAccVCRRepository(projectSuffix, true)),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testCheckVCRRepositoryExists(testClient(t), testTeam(t), true, "vercel_vcr_repository.test"),
+					resource.TestCheckResourceAttr("vercel_vcr_repository.test", "public", "true"),
+				),
+			},
 			{
 				ResourceName:      "vercel_vcr_repository.test",
 				ImportState:       true,
@@ -78,7 +89,7 @@ func getVCRRepositoryImportID(n string) resource.ImportStateIdFunc {
 	}
 }
 
-func testAccVCRRepository(projectSuffix string) string {
+func testAccVCRRepository(projectSuffix string, public bool) string {
 	return fmt.Sprintf(`
 resource "vercel_project" "test" {
   name = "test-acc-vcr-repo-%[1]s"
@@ -87,6 +98,7 @@ resource "vercel_project" "test" {
 resource "vercel_vcr_repository" "test" {
   project_id = vercel_project.test.id
   name       = "test-acc-%[1]s"
+  public     = %[2]t
 }
-`, projectSuffix)
+`, projectSuffix, public)
 }