Merge pull request #118 from elisasre/chore/mage-improvements

mage command layout and CI adjustments
elisasre · Oct 17, 2023 · 9a22421 · 9a22421
2 parents 00f0a4f + 1428c47
commit 9a22421
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 32 deletions.
diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml
@@ -31,28 +31,29 @@ jobs:
           password: ${{ secrets.QUAY_TOKEN }}
 
       - name: Run unit tests
-        run: mage unittest
+        run: mage go:unittest
 
       - name: Upload test coverage to codecov
         uses: elisa-actions/codecov-action@v4-elisa
         with:
           url: https://codecov.csf.elisa.fi
 
       - name: Lint
-        env:
-          GOLANGCI_LINT_FLAGS: --out-format=github-actions
-        run: mage lint
+        run: mage go:lint
+
+      - name: Vuln check
+        run: mage go:vulncheck
 
       - name: Build binary
-        run: mage build
+        run: mage go:build
 
       - name: Build image
         env:
           DOCKER_IMAGE_TAGS: sha-${{ github.sha }}
-        run: mage image
+        run: mage docker:image
 
       - name: Push image
-        run: mage pushImage
+        run: mage docker:pushImage
 
       - name: Update batch
         env:

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -21,25 +21,29 @@ jobs:
         uses: docker/setup-buildx-action@v3
 
       - name: Run unit tests
-        run: mage unittest
+        run: mage go:unittest
 
       - name: Upload test coverage to codecov
         uses: elisa-actions/codecov-action@v4-elisa
         with:
           url: https://codecov.csf.elisa.fi
 
       - name: Lint
-        env:
-          GOLANGCI_LINT_FLAGS: --out-format=github-actions
-        run: mage lint
+        run: mage go:lint
+
+      - name: Vuln check
+        run: mage go:vulncheck
+
+      - name: License check
+        run: mage go:licensecheck
 
       - name: Build binary
-        run: mage build
+        run: mage go:build
 
       - name: Build image
         env:
           DOCKER_IMAGE_TAGS: sha-${{ github.event.pull_request.head.sha }}
-        run: mage image
+        run: mage docker:image
 
   automerge:
     needs: [build]

diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,5 @@
+run:
+  timeout: 5m
+
+output:
+  format: github-actions
diff --git a/magefiles/mage.go b/magefiles/mage.go
@@ -7,6 +7,7 @@ import (
 	"os"
 
 	"github.com/elisasre/mageutil"
+	"github.com/magefile/mage/mg"
 )
 
 const (
@@ -15,47 +16,48 @@ const (
 	ImageName = "quay.io/elisaoyj/networkpolicy-controller"
 )
 
+type (
+	Go        mg.Namespace
+	Docker    mg.Namespace
+	Workspace mg.Namespace
+)
+
 // Build binaries for executables under ./cmd
-func Build(ctx context.Context) error {
+func (Go) Build(ctx context.Context) error {
 	return mageutil.BuildAll(ctx)
 }
 
-// UnitTest whole repo
-func UnitTest(ctx context.Context) error {
+// UnitTest runs unit tests for whole repo
+func (Go) UnitTest(ctx context.Context) error {
 	return mageutil.UnitTest(ctx)
 }
 
-// IntegrationTest whole repo
-func IntegrationTest(ctx context.Context) error {
-	return mageutil.IntegrationTest(ctx, "./cmd/"+AppName)
-}
-
-// Lint all go files.
-func Lint(ctx context.Context) error {
+// Lint runs lint for all go files
+func (Go) Lint(ctx context.Context) error {
 	return mageutil.LintAll(ctx)
 }
 
-// VulnCheck all go files.
-func VulnCheck(ctx context.Context) error {
+// VulnCheck runs vuln check for all packages
+func (Go) VulnCheck(ctx context.Context) error {
 	return mageutil.VulnCheckAll(ctx)
 }
 
-// LicenseCheck all files.
-func LicenseCheck(ctx context.Context) error {
+// LicenseCheck checks licences of all packages
+func (Go) LicenseCheck(ctx context.Context) error {
 	return mageutil.LicenseCheck(ctx, os.Stdout, mageutil.CmdDir+AppName)
 }
 
 // Clean removes all files ignored by git
-func Clean(ctx context.Context) error {
+func (Workspace) Clean(ctx context.Context) error {
 	return mageutil.Clean(ctx)
 }
 
-// Image creates docker image.
-func Image(ctx context.Context) error {
+// Image creates docker image
+func (Docker) Image(ctx context.Context) error {
 	return mageutil.DockerBuildDefault(ctx, ImageName, RepoURL)
 }
 
-// PushImage creates docker image.
-func PushImage(ctx context.Context) error {
+// PushImage pushes docker image
+func (Docker) PushImage(ctx context.Context) error {
 	return mageutil.DockerPushAllTags(ctx, ImageName)
 }