add integration test (#2)

Author: vladopajic

.github/workflows/integration-test.yml

@@ -0,0 +1,90 @@
+name: integration-test
+on: [push]
+jobs:
+  test:
+    name: test
+    permissions:
+      contents: write
+      packages: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: setup go
+        uses: actions/setup-go@v3
+        with:
+          go-version-file: go.mod
+
+      - name: Set action image version to dev
+        run: |
+          yq e -i '.runs.image = "docker://ghcr.io/vladopajic/go-test-coverage:dev"' action.yml
+          image=$(yq '.runs.image' action.yml)
+          echo "Image: $image"
+
+      - name: Setup buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to GitHub container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          push: true
+          build-args: |
+            VERSION=dev
+          tags: |
+            ghcr.io/vladopajic/go-test-coverage:dev
+
+      - name: generate test coverage
+        run: go test ./... -coverprofile=./cover.out -covermode=atomic
+
+      - name: Test total coverage 0% (config)
+        uses: ./
+        with:
+          config: ./.github/workflows/testdata/zero.yml
+
+      - name: Test total coverage 100% (config)
+        uses: ./
+        id: should-fail-1
+        continue-on-error: true
+        with:
+          config: ./.github/workflows/testdata/total100.yml
+      
+      - name: Check previous step failed
+        if: steps.should-fail-1.outcome != 'failure'
+        shell: bash
+        run: |
+          echo "Previous step should have failed"
+          exit 1
+
+      - name: Test total coverage 0% (inputs)
+        uses: ./
+        with:
+          profile: cover.out
+          local-prefix: "github.com/vladopajic/go-test-coverage"
+          threshold-file: 0
+          threshold-package: 0
+          threshold-total: 0
+
+      - name: Test total coverage 100% (inputs)
+        uses: ./
+        id: should-fail-2
+        continue-on-error: true
+        with:
+          profile: cover.out
+          local-prefix: "github.com/vladopajic/go-test-coverage"
+          threshold-file: 0
+          threshold-package: 0
+          threshold-total: 100
+      
+      - name: Check previous step failed
+        if: steps.should-fail-2.outcome != 'failure'
+        shell: bash
+        run: |
+          echo "Previous step should have failed"
+          exit 1

.github/workflows/test.yml

@@ -13,10 +13,3 @@ jobs:
           go-version-file: go.mod
       - name: test
         run: go test -timeout=30s -race -count=10 -failfast ./...
-      - name: test (report coverage)
-        run: go test ./... -coverprofile=./cover.out -covermode=atomic
-      - name: upload code coverage
-        uses: codecov/codecov-action@v3.1.0
-        if: contains(github.ref, 'main')
-        with:
-          file: ./cover.out

.github/workflows/testdata/total100.yml

@@ -0,0 +1,9 @@
+# This file is used for integration tests
+
+profile: cover.out
+github-action-output: true
+local-refix: "github.com/vladopajic/go-test-coverage"
+threshold:
+  file: 0
+  package: 0
+  total: 100

.github/workflows/testdata/zero.yml

@@ -0,0 +1,9 @@
+# This file is used for integration tests
+
+profile: cover.out
+github-action-output: true
+local-refix: "github.com/vladopajic/go-test-coverage"
+threshold:
+  file: 0
+  package: 0
+  total: 0

action.yml

@@ -5,26 +5,32 @@ inputs:
   config:
     description: Path of configuration file.
     required: false
+    default: "''"
     type: string
   profile:
     description: Path of coverage profile file.
     required: false
+    default: "''"
     type: string
   local-prefix:
     description: When specified reported file paths will not contain local prefix in the output.
     required: false
+    default: "''"
     type: string
   threshold-file:
     description: The minimum coverage that each file should have.
     required: false
+    default: 0
     type: number
   threshold-package:
     description: The minimum coverage that each package should have.
     required: false
+    default: 0
     type: number
   threshold-total:
     description: The minimum total coverage project should have.
     required: false
+    default: 50
     type: number
 outputs:
   total_coverage:

go.mod

@@ -4,8 +4,13 @@ go 1.20
 
 require (
 	github.com/alexflint/go-arg v1.4.3
+	github.com/stretchr/testify v1.7.0
 	golang.org/x/tools v0.5.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 
-require github.com/alexflint/go-scalar v1.1.0 // indirect
+require (
+	github.com/alexflint/go-scalar v1.1.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+)

main.go

@@ -40,9 +40,9 @@ func (args) Version() string {
 func (a *args) toConfig() testcoverage.Config {
 	cfg := testcoverage.NewConfig()
 
-	cfg.Profile = a.Profile
+	cfg.Profile = fromMagicToEmpty(a.Profile)
 	cfg.GithubActionOutput = a.GithubActionOutput
-	cfg.LocalPrefix = a.LocalPrefix
+	cfg.LocalPrefix = fromMagicToEmpty(a.LocalPrefix)
 	cfg.Threshold.File = a.ThresholdFile
 	cfg.Threshold.Package = a.ThresholdPackage
 	cfg.Threshold.Total = a.ThresholdTotal
@@ -93,8 +93,9 @@ func readConfig() (testcoverage.Config, error) {
 	}
 	arg.MustParse(&cmdArgs)
 
-	if cmdArgs.ConfigPath != "" {
-		err := testcoverage.ConfigFromFile(&cfg, cmdArgs.ConfigPath)
+	cfgPath := fromMagicToEmpty(cmdArgs.ConfigPath)
+	if cfgPath != "" {
+		err := testcoverage.ConfigFromFile(&cfg, cfgPath)
 		if err != nil {
 			return testcoverage.Config{}, fmt.Errorf("failed loading config from file: %w", err)
 		}
@@ -108,3 +109,11 @@ func readConfig() (testcoverage.Config, error) {
 
 	return cfg, nil
 }
+
+func fromMagicToEmpty(s string) string {
+	if s == `''` {
+		return ""
+	}
+
+	return s
+}

pkg/testcoverage/config_test.go

@@ -0,0 +1,74 @@
+package testcoverage_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	. "github.com/vladopajic/go-test-coverage/pkg/testcoverage"
+)
+
+func Test_NewConfig(t *testing.T) {
+	t.Parallel()
+
+	cfg := NewConfig()
+
+	assert.Empty(t, cfg.Profile)
+	assert.Empty(t, cfg.LocalPrefix)
+	assert.False(t, cfg.GithubActionOutput)
+	assert.Equal(t, DefaultFileThreshold, cfg.Threshold.File)
+	assert.Equal(t, DefaultPackageThreshold, cfg.Threshold.Package)
+	assert.Equal(t, DefaultTotalThreshold, cfg.Threshold.Total)
+}
+
+func Test_Config_Validate(t *testing.T) {
+	t.Parallel()
+
+	newValidCfg := func() Config {
+		cfg := NewConfig()
+		cfg.Profile = "cover.out"
+
+		return cfg
+	}
+
+	cfg := newValidCfg()
+	assert.NoError(t, cfg.Validate())
+
+	cfg = newValidCfg()
+	cfg.Profile = ""
+	assert.ErrorIs(t, cfg.Validate(), ErrCoverageProfileNotSpecified)
+
+	cfg = newValidCfg()
+	cfg.Threshold.File = 101
+	assert.ErrorIs(t, cfg.Validate(), ErrThresholdNotInRange)
+
+	cfg = newValidCfg()
+	cfg.Threshold.File = -1
+	assert.ErrorIs(t, cfg.Validate(), ErrThresholdNotInRange)
+
+	cfg = newValidCfg()
+	cfg.Threshold.Package = 101
+	assert.ErrorIs(t, cfg.Validate(), ErrThresholdNotInRange)
+
+	cfg = newValidCfg()
+	cfg.Threshold.Package = -1
+	assert.ErrorIs(t, cfg.Validate(), ErrThresholdNotInRange)
+
+	cfg = newValidCfg()
+	cfg.Threshold.Total = 101
+	assert.ErrorIs(t, cfg.Validate(), ErrThresholdNotInRange)
+
+	cfg = newValidCfg()
+	cfg.Threshold.Total = -1
+	assert.ErrorIs(t, cfg.Validate(), ErrThresholdNotInRange)
+}
+
+func Test_ConfigFromFile(t *testing.T) {
+	t.Parallel()
+
+	cfg := NewConfig()
+	cfgBefore := NewConfig()
+	err := ConfigFromFile(&cfg, t.TempDir())
+	assert.Error(t, err)
+	assert.Equal(t, cfgBefore, cfg)
+}

pkg/testcoverage/export_test.go

@@ -0,0 +1,7 @@
+package testcoverage
+
+const (
+	DefaultFileThreshold    = defaultFileThreshold
+	DefaultPackageThreshold = defaultPackageThreshold
+	DefaultTotalThreshold   = defaultTotalThreshold
+)