add GitHub integration test (#114)

vladopajic · Nov 11, 2024 · 99c4bea · 99c4bea
1 parent 0cfd077
commit 99c4bea
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 6 deletions.
diff --git a/.github/.testcoverage.yml b/.github/.testcoverage.yml
@@ -4,10 +4,7 @@ profile: cover.short.profile,cover.long.profile
 local-prefix: "github.com/vladopajic/go-test-coverage/v2"
 threshold:
   file: 100
-  total: 95
-override:
-  - threshold: 50
-    path: badgestorer/github.go$
+  total: 100
 exclude:
   paths:
     - main\.go$
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -16,6 +16,8 @@ jobs:
           go-version-file: go.mod
 
       - name: test
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed for GitHub badge storer integration test
         run: make test
 
       - name: check test coverage

diff --git a/pkg/testcoverage/badgestorer/github.go b/pkg/testcoverage/badgestorer/github.go
@@ -65,12 +65,12 @@ func (s *githubStorer) Store(data []byte) (bool, error) {
 		return updateBadge(nil)
 	}
 
-	if err != nil {
+	if err != nil { // coverage-ignore
 		return false, fmt.Errorf("get badge content: %w", err)
 	}
 
 	content, err := fc.GetContent()
-	if err != nil {
+	if err != nil { // coverage-ignore
 		return false, fmt.Errorf("decode badge content: %w", err)
 	}
 

diff --git a/pkg/testcoverage/badgestorer/github_test.go b/pkg/testcoverage/badgestorer/github_test.go
@@ -1,13 +1,18 @@
 package badgestorer_test
 
 import (
+	"context"
+	"os"
 	"testing"
 
+	"github.com/google/go-github/v56/github"
 	"github.com/stretchr/testify/assert"
 
 	. "github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/badgestorer"
 )
 
+const envGitToken = "GITHUB_TOKEN" //nolint:gosec // false-positive
+
 func Test_Github_Error(t *testing.T) {
 	t.Parallel()
 
@@ -27,3 +32,76 @@ func Test_Github_Error(t *testing.T) {
 	assert.Error(t, err)
 	assert.False(t, updated)
 }
+
+func Test_Github(t *testing.T) {
+	t.Parallel()
+
+	if testing.Short() {
+		return
+	}
+
+	if getEnv(envGitToken) == "" {
+		t.Skipf("%v env variable not set", envGitToken)
+		return
+	}
+
+	data := []byte{1, 2, 3, 4, 5, 6, 7, 8, 9, 0}
+	cfg := Git{
+		Token:      getEnv(envGitToken),
+		Owner:      "vladopajic",
+		Repository: "go-test-coverage",
+		Branch:     "badges-integration-test",
+		FileName:   "badge.svg",
+	}
+	s := NewGithub(cfg)
+
+	// put badge
+	updated, err := s.Store(data)
+	assert.NoError(t, err)
+	assert.True(t, updated)
+
+	// put badge again - no change
+	updated, err = s.Store(data)
+	assert.NoError(t, err)
+	assert.False(t, updated)
+
+	// put badge again - expect change
+	updated, err = s.Store(append(data, byte(1)))
+	assert.NoError(t, err)
+	assert.True(t, updated)
+
+	deleteFile(t, cfg)
+}
+
+func getEnv(key string) string {
+	value, _ := os.LookupEnv(key)
+	return value
+}
+
+func deleteFile(t *testing.T, cfg Git) {
+	t.Helper()
+
+	client := github.NewClient(nil).WithAuthToken(cfg.Token)
+
+	fc, _, _, err := client.Repositories.GetContents(
+		context.Background(),
+		cfg.Owner,
+		cfg.Repository,
+		cfg.FileName,
+		&github.RepositoryContentGetOptions{Ref: cfg.Branch},
+	)
+	assert.NoError(t, err)
+
+	_, _, err = client.Repositories.DeleteFile(
+		context.Background(),
+		cfg.Owner,
+		cfg.Repository,
+		cfg.FileName,
+		&github.RepositoryContentFileOptions{
+			Message: github.String("delete testing badge " + cfg.FileName),
+			Branch:  &cfg.Branch,
+			SHA:     fc.SHA,
+		},
+	)
+	assert.NoError(t, err)
+}