build and coverage settings

Author: rickb777

.github/workflows/go.yml

@@ -1,27 +1,36 @@
 # This workflow will build a golang project
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+# For more information see:
+#  https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+#  https://github.com/marketplace/actions/coveralls-github-action
 
 name: Go
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ main ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ main ]
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Set up Go
-      uses: actions/setup-go@v4
-      with:
-        go-version: '1.24'
+      - name: Set up Go 1.24.x
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.24'
 
-    - name: Test
-      run: go test ./...
+      - name: Set up Mage
+        run: go install tool
 
-    - name: Vet
-      run: go vet ./...
+      - name: Test
+        run: mage build coverage
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@v2
+        with:
+          file: coverage.out
+          format: golang
+          debug: false

.gitignore

@@ -7,7 +7,7 @@
 _obj
 _test
 
-test.out
+*.out
 
 *.cgo1.go
 *.cgo2.c

README.md

@@ -3,6 +3,7 @@
 [![GoDoc](https://img.shields.io/badge/api-Godoc-blue.svg)](http://pkg.go.dev/github.com/rickb777/acceptable)
 [![Go Report Card](https://goreportcard.com/badge/github.com/rickb777/acceptable)](https://goreportcard.com/report/github.com/rickb777/acceptable)
 [![Build](https://github.com/rickb777/acceptable/actions/workflows/go.yml/badge.svg)](https://github.com/rickb777/acceptable/actions)
+[![Coverage](https://coveralls.io/repos/github/rickb777/acceptable/badge.svg?branch=main)](https://coveralls.io/github/rickb777/acceptable?branch=main)
 [![Issues](https://img.shields.io/github/issues/rickb777/acceptable.svg)](https://github.com/rickb777/acceptable/issues)
 
 This is a library that handles `Accept` headers, which form the basis of content negotiation in HTTP server applications written in Go. It provides an implementation of the proactive server-driven content negotiation algorithm specified in [RFC-7231 section 5.3](https://tools.ietf.org/html/rfc7231#section-5.3).

build.sh

@@ -1,4 +1,5 @@
 #!/bin/bash -ex
 cd "$(dirname "$0")"
 go install tool
-mage
+mage build coverage
+cat report.out

magefiles/build.go

@@ -7,15 +7,11 @@ package main
 
 import (
 	"github.com/magefile/mage/sh"
-	"io/fs"
 	"log"
 	"os"
-	"path/filepath"
-	"slices"
-	"strings"
 )
 
-var Default = Coverage
+var Default = Build
 
 func Build() error {
 	if err := sh.RunV("go", "test", "./..."); err != nil {
@@ -30,63 +26,34 @@ func Build() error {
 	return nil
 }
 
-// runs all the unit tests and reports the test coverage
 func Coverage() error {
-	if err := Build(); err != nil {
+	if err := sh.RunV("go", "test", "-cover", "./...", "-coverprofile", "coverage.out", "-coverpkg", "./..."); err != nil {
 		return err
 	}
-	for _, dir := range listOfFoldersContainingTests() {
-		if err := sh.RunV("go", "test", "-covermode=count", "-coverprofile="+dir+"test.out", packageName(dir)); err != nil {
-			return err
-		}
-		if err := sh.RunV("go", "tool", "cover", "-func="+dir+"test.out"); err != nil {
-			return err
-		}
+	if err := sh.RunV("go", "tool", "cover", "-func", "coverage.out", "-o", "report.out"); err != nil {
+		return err
 	}
 	return nil
 }
 
-// tests the module on both amd64 and i386 architectures
+// tests the module on both amd64 and i386 architectures for Linux and Windows
 func CrossCompile() error {
+	win := "build"
+	linux := "test"
+	if os.Getenv("GOOS") == "windows" {
+		win = "test"
+		linux = "build"
+	}
+	log.Printf("Testing on Windows\n")
+	if err := sh.RunWithV(map[string]string{"GOOS": "windows"}, "go", win, "./..."); err != nil {
+		return err
+	}
 	for _, arch := range []string{"amd64", "386"} {
-		log.Printf("Testing on %s\n", arch)
-		env := map[string]string{"GOARCH": arch}
-		if _, err := sh.Exec(env, os.Stdout, os.Stderr, "go", "test", "./..."); err != nil {
+		log.Printf("Testing on Linux/%s\n", arch)
+		env := map[string]string{"GOOS": "linux", "GOARCH": arch}
+		if _, err := sh.Exec(env, os.Stdout, os.Stderr, "go", linux, "./..."); err != nil {
 			return err
 		}
-		log.Printf("%s is good.\n\n", arch)
 	}
 	return nil
 }
-
-func listOfFoldersContainingTests() []string {
-	root, _ := os.Getwd()
-	fileSystem := os.DirFS(root)
-	set := map[string]struct{}{}
-
-	fs.WalkDir(fileSystem, ".", func(path string, d fs.DirEntry, err error) error {
-		if err != nil {
-			log.Fatal(err)
-		}
-		if strings.HasSuffix(path, "_test.go") {
-			dir, _ := filepath.Split(path)
-			set[dir] = struct{}{}
-		}
-		return nil
-	})
-
-	list := make([]string, 0, len(set))
-	for dir := range set {
-		list = append(list, dir)
-	}
-	slices.Sort(list)
-	return list
-}
-
-func packageName(dir string) string {
-	dir, _ = strings.CutSuffix(dir, "/")
-	if dir == "" {
-		return dir
-	}
-	return "./" + dir
-}