Merge pull request #48 from form3tech-oss/fmatavelli-update-go

chore: update go to v1.25

Author: fabiomatavelli-f3

.gitattributes

@@ -0,0 +1 @@
+vendor/** linguist-generated

.github/workflows/ci.yaml

@@ -1,36 +1,40 @@
 name: CI
-on:
-  push:
-    branches:
-      - master
-    tags:
-      - v*.*.*
-  pull_request:
+
+on: [pull_request]
+
+permissions:
+  id-token: write
+  contents: write
+  pull-requests: write
+
+defaults:
+  run:
+    shell: bash
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  TF_ACC: 1
+  COMMIT_MESSAGE_PREFIX: "[skip ci]"
+  GITHUB_TOKEN: ${{ github.token }}
+  GITHUB_USERNAME: "github-actions[bot]"
+  GITHUB_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"
 
 jobs:
-  build_test:
+  tests:
     runs-on: ubuntu-latest
-    env:
-      TF_ACC: 1
-      GITHUB_TOKEN: ${{ secrets.TF_PROVIDER_GITHUBFILE_GITHUB_TOKEN }}
     steps:
-      - name: Checkout Code
-        uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0
-      - name: Setup Golang
-        uses: actions/setup-go@4d34df0c2316fe8122ab82dc22947d607c0c91f9 # v4.0.0
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Set up Go
+        uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
         with:
-          go-version-file: go.mod
-      - name: Make
-        run: make
-  publish:
-    if: startsWith(github.ref, 'refs/tags/')
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0
-      - name: Setup Golang
-        uses: actions/setup-go@4d34df0c2316fe8122ab82dc22947d607c0c91f9 # v4.0.0
-      - name: Goreleaser
-        run: ./scripts/goreleaser.sh
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          go-version-file: 'go.mod'
+          cache: true
+
+      - name: Tests
+        run: |
+          make test

.github/workflows/release.yaml

@@ -0,0 +1,15 @@
+name: release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  tag-release:
+    uses: form3tech/tfe-providers-gh-workflows/.github/workflows/release.yml@v0.2.10
+    secrets: inherit
+    permissions:
+      id-token: write
+      contents: write
+

.gitignore

@@ -1,4 +1,3 @@
 .idea/
 bin/
 dist/
-vendor/

Makefile

@@ -16,8 +16,8 @@ vet:
 
 .PHONY: test
 test:
-	GITHUB_EMAIL=$(GITHUB_EMAIL) \
-	GITHUB_USERNAME=$(GITHUB_USERNAME) \
-	COMMIT_MESSAGE_PREFIX=$(COMMIT_MESSAGE_PREFIX) \
-	TF_ACC=$(TF_ACC) \
+	GITHUB_EMAIL="$(GITHUB_EMAIL)" \
+	GITHUB_USERNAME="$(GITHUB_USERNAME)" \
+	COMMIT_MESSAGE_PREFIX="$(COMMIT_MESSAGE_PREFIX)" \
+	TF_ACC="$(TF_ACC)" \
 	go test -count 1 -v ./...

githubfile/resource_file.go

@@ -17,6 +17,7 @@ package githubfile
 import (
 	"context"
 	"fmt"
+	"log"
 	"strings"
 	"time"
 
@@ -99,6 +100,7 @@ func resourceFileCreateOrUpdate(s string, d *schema.ResourceData, m interface{})
 	if err := commit.CreateCommit(context.Background(), c.githubClient, &commit.CommitOptions{
 		RepoOwner:                   f.repositoryOwner,
 		RepoName:                    f.repositoryName,
+		Branch:                      f.branch,
 		CommitMessage:               formatCommitMessage(c.commitMessagePrefix, s, f.path),
 		GpgPassphrase:               c.gpgPassphrase,
 		GpgPrivateKey:               c.gpgSecretKey,
@@ -119,6 +121,18 @@ func resourceFileDelete(d *schema.ResourceData, m interface{}) error {
 	c := m.(*providerConfiguration)
 	f := expandFile(d)
 
+	// Check if the repository is archived. If so, skip the delete operation
+	// and just remove the resource from state, since archived repositories
+	// cannot be modified.
+	repo, _, err := c.githubClient.Repositories.Get(context.Background(), f.repositoryOwner, f.repositoryName)
+	if err != nil {
+		return fmt.Errorf("failed to retrieve repository %s/%s: %v", f.repositoryOwner, f.repositoryName, err)
+	}
+	if repo.GetArchived() {
+		log.Printf("[WARN] Repository %s/%s is archived, skipping file deletion and removing %q from state", f.repositoryOwner, f.repositoryName, f.path)
+		return nil
+	}
+
 	// Check whether the file exists.
 	fileContent, err := ghfileutils.GetFile(context.Background(),
 		c.githubClient,
@@ -154,6 +168,7 @@ func resourceFileDelete(d *schema.ResourceData, m interface{}) error {
 	if err := commit.CreateCommit(context.Background(), c.githubClient, &commit.CommitOptions{
 		RepoOwner:                   f.repositoryOwner,
 		RepoName:                    f.repositoryName,
+		Branch:                      f.branch,
 		CommitMessage:               formatCommitMessage(c.commitMessagePrefix, "Delete %q.", f.path),
 		GpgPassphrase:               c.gpgPassphrase,
 		GpgPrivateKey:               c.gpgSecretKey,

githubfile/resource_file_test.go

@@ -17,33 +17,106 @@ package githubfile
 import (
 	"context"
 	"fmt"
+	"math/rand"
+	"net/http"
+	"net/http/httptest"
+	"net/url"
+	"os"
 	"testing"
 
+	"github.com/form3tech-oss/go-github-utils/pkg/branch"
 	ghfileutils "github.com/form3tech-oss/go-github-utils/pkg/file"
+	"github.com/google/go-github/v54/github"
 	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/terraform"
+	"golang.org/x/oauth2"
 )
 
 const (
-	testAccFileCreate = `
+	testRepoOwner = "form3tech-oss"
+	testRepoName  = "terraform-provider-githubfile"
+)
+
+var testBranchName string
+
+func newGitHubClient() *github.Client {
+	token := os.Getenv("GITHUB_TOKEN")
+	ts := oauth2.StaticTokenSource(&oauth2.Token{AccessToken: token})
+	tc := oauth2.NewClient(context.Background(), ts)
+	return github.NewClient(tc)
+}
+
+func TestMain(m *testing.M) {
+	testBranchName = fmt.Sprintf("acc-test-%d", rand.Int63())
+
+	code := m.Run()
+
+	// Cleanup: delete the test branch if it was created
+	if os.Getenv("GITHUB_TOKEN") != "" {
+		cleanupTestBranch()
+	}
+
+	os.Exit(code)
+}
+
+func cleanupTestBranch() {
+	client := newGitHubClient()
+	ref := fmt.Sprintf("refs/heads/%s", testBranchName)
+	_, err := client.Git.DeleteRef(context.Background(), testRepoOwner, testRepoName, ref)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "failed to delete test branch %s: %v\n", testBranchName, err)
+	}
+}
+
+func createTestBranch(t *testing.T) {
+	t.Helper()
+
+	client := newGitHubClient()
+	ctx := context.Background()
+
+	// Get the SHA for the default branch (master)
+	sha, err := branch.GetSHAForBranch(ctx, client, testRepoOwner, testRepoName, "master")
+	if err != nil {
+		t.Fatalf("failed to get SHA for master branch: %v", err)
+	}
+
+	// Create the test branch
+	ref := &github.Reference{
+		Ref: github.String(fmt.Sprintf("refs/heads/%s", testBranchName)),
+		Object: &github.GitObject{
+			SHA: github.String(sha),
+		},
+	}
+	_, _, err = client.Git.CreateRef(ctx, testRepoOwner, testRepoName, ref)
+	if err != nil {
+		t.Fatalf("failed to create test branch %s: %v", testBranchName, err)
+	}
+}
+
+func testAccFileCreateConfig() string {
+	return fmt.Sprintf(`
 resource "githubfile_file" "foo" {
-    repository_owner = "form3tech-oss"
-    repository_name  = "terraform-provider-githubfile-test"
-	branch           = "master"
-	path             = "foo/bar/baz/README.md"
-	contents         = "foo\nbar\nbaz"
+    repository_owner = "%s"
+    repository_name  = "%s"
+    branch           = "%s"
+    path             = "foo/bar/baz/README.md"
+    contents         = "foo\nbar\nbaz"
+}
+`, testRepoOwner, testRepoName, testBranchName)
 }
-`
-	testAccFileUpdate = `
+
+func testAccFileUpdateConfig() string {
+	return fmt.Sprintf(`
 resource "githubfile_file" "foo" {
-    repository_owner = "form3tech-oss"
-    repository_name  = "terraform-provider-githubfile-test"
-	branch           = "master"
-	path             = "foo/bar/baz/README.md"
-	contents         = "foo\nbar\nqux"
+    repository_owner = "%s"
+    repository_name  = "%s"
+    branch           = "%s"
+    path             = "foo/bar/baz/README.md"
+    contents         = "foo\nbar\nqux"
+}
+`, testRepoOwner, testRepoName, testBranchName)
 }
-`
-)
 
 func TestAccResourceFile_basic(t *testing.T) {
 	var (
@@ -55,18 +128,19 @@ func TestAccResourceFile_basic(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck: func() {
 			testAccPreCheck(t)
+			createTestBranch(t)
 		},
 		IDRefreshName: resourceName,
 		Providers:     testAccProviders,
 		CheckDestroy:  testAccCheckFileDestroy,
 		Steps: []resource.TestStep{
 			{
-				Config: testAccFileCreate,
+				Config: testAccFileCreateConfig(),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					testAccCheckFileExists(resourceName, &before),
-					resource.TestCheckResourceAttr(resourceName, repositoryNameAttributeName, "terraform-provider-githubfile-test"),
-					resource.TestCheckResourceAttr(resourceName, repositoryOwnerAttributeName, "form3tech-oss"),
-					resource.TestCheckResourceAttr(resourceName, branchAttributeName, "master"),
+					resource.TestCheckResourceAttr(resourceName, repositoryNameAttributeName, testRepoName),
+					resource.TestCheckResourceAttr(resourceName, repositoryOwnerAttributeName, testRepoOwner),
+					resource.TestCheckResourceAttr(resourceName, branchAttributeName, testBranchName),
 					resource.TestCheckResourceAttr(resourceName, pathAttributeName, "foo/bar/baz/README.md"),
 					resource.TestCheckResourceAttr(resourceName, contentsAttributeName, "foo\nbar\nbaz"),
 				),
@@ -77,12 +151,12 @@ func TestAccResourceFile_basic(t *testing.T) {
 				ImportStateVerify: true,
 			},
 			{
-				Config: testAccFileUpdate,
+				Config: testAccFileUpdateConfig(),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					testAccCheckFileExists(resourceName, &before),
-					resource.TestCheckResourceAttr(resourceName, repositoryNameAttributeName, "terraform-provider-githubfile-test"),
-					resource.TestCheckResourceAttr(resourceName, repositoryOwnerAttributeName, "form3tech-oss"),
-					resource.TestCheckResourceAttr(resourceName, branchAttributeName, "master"),
+					resource.TestCheckResourceAttr(resourceName, repositoryNameAttributeName, testRepoName),
+					resource.TestCheckResourceAttr(resourceName, repositoryOwnerAttributeName, testRepoOwner),
+					resource.TestCheckResourceAttr(resourceName, branchAttributeName, testBranchName),
 					resource.TestCheckResourceAttr(resourceName, pathAttributeName, "foo/bar/baz/README.md"),
 					resource.TestCheckResourceAttr(resourceName, contentsAttributeName, "foo\nbar\nqux"),
 				),
@@ -137,3 +211,82 @@ func testAccCheckFileDestroy(s *terraform.State) error {
 	}
 	return nil
 }
+
+// newTestResourceData creates a schema.ResourceData with the file resource schema
+// populated from the given raw values, suitable for unit testing.
+func newTestResourceData(t *testing.T, values map[string]interface{}) *schema.ResourceData {
+	t.Helper()
+	return schema.TestResourceDataRaw(t, resourceFile().Schema, values)
+}
+
+// newMockGitHubClient creates a github.Client pointing at the given httptest.Server.
+func newMockGitHubClient(server *httptest.Server) *github.Client {
+	client := github.NewClient(server.Client())
+	serverURL, _ := url.Parse(server.URL + "/")
+	client.BaseURL = serverURL
+	return client
+}
+
+func TestResourceFileDelete_ArchivedRepo(t *testing.T) {
+	// Set up a mock HTTP server that returns an archived repository
+	mux := http.NewServeMux()
+	mux.HandleFunc("/repos/test-owner/test-repo", func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Content-Type", "application/json")
+		fmt.Fprint(w, `{"id":1,"name":"test-repo","full_name":"test-owner/test-repo","archived":true}`)
+	})
+	server := httptest.NewServer(mux)
+	defer server.Close()
+
+	config := &providerConfiguration{
+		githubClient: newMockGitHubClient(server),
+	}
+
+	d := newTestResourceData(t, map[string]interface{}{
+		repositoryOwnerAttributeName: "test-owner",
+		repositoryNameAttributeName:  "test-repo",
+		branchAttributeName:          "main",
+		pathAttributeName:            "some/file.txt",
+		contentsAttributeName:        "some content",
+	})
+	d.SetId("test-owner/test-repo:main:some/file.txt")
+
+	// Delete should succeed without error — archived repo skips deletion
+	err := resourceFileDelete(d, config)
+	if err != nil {
+		t.Fatalf("expected no error for archived repo deletion, got: %v", err)
+	}
+}
+
+func TestResourceFileDelete_NonArchivedRepo_FileNotFound(t *testing.T) {
+	// Set up a mock HTTP server that returns a non-archived repository
+	// and a 404 for the file content (file doesn't exist)
+	mux := http.NewServeMux()
+	mux.HandleFunc("/repos/test-owner/test-repo", func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Content-Type", "application/json")
+		fmt.Fprint(w, `{"id":1,"name":"test-repo","full_name":"test-owner/test-repo","archived":false}`)
+	})
+	mux.HandleFunc("/repos/test-owner/test-repo/contents/some/file.txt", func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusNotFound)
+	})
+	server := httptest.NewServer(mux)
+	defer server.Close()
+
+	config := &providerConfiguration{
+		githubClient: newMockGitHubClient(server),
+	}
+
+	d := newTestResourceData(t, map[string]interface{}{
+		repositoryOwnerAttributeName: "test-owner",
+		repositoryNameAttributeName:  "test-repo",
+		branchAttributeName:          "main",
+		pathAttributeName:            "some/file.txt",
+		contentsAttributeName:        "some content",
+	})
+	d.SetId("test-owner/test-repo:main:some/file.txt")
+
+	// Delete should succeed — file not found is treated as already deleted
+	err := resourceFileDelete(d, config)
+	if err != nil {
+		t.Fatalf("expected no error when file not found on non-archived repo, got: %v", err)
+	}
+}