MAJOR: add aspell as additional check for spelling errors

Author: oktalz

.aspell.yml

@@ -0,0 +1,3 @@
+mode: subject
+allowed:
+  - aspell

.github/workflows/actions.yaml

@@ -32,6 +32,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: ["go_build"]
     steps:
+    - name: Install Aspell
+      run: sudo apt-get update && sudo apt-get install -y aspell aspell-en
     - uses: actions/checkout@v4
     - name: Set up Go
       uses: actions/setup-go@v4
@@ -51,6 +53,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: ["go_build"]
     steps:
+    - name: Install Aspell
+      run: sudo apt-get update && sudo apt-get install -y aspell aspell-en
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0

Dockerfile

@@ -1,10 +1,11 @@
-FROM golang:alpine as builder
+FROM golang:alpine AS builder
 RUN mkdir /build
 ADD . /build/
 WORKDIR /build
 RUN go build -o check
 
 FROM alpine:latest
+RUN apk --no-cache add aspell aspell-en
 COPY --from=builder /build/check /check
 WORKDIR /
 ENTRYPOINT ["/check"]

aspell/aspell.go

@@ -0,0 +1,71 @@
+package aspell
+
+import (
+	"bytes"
+	"fmt"
+	"log"
+	"os/exec"
+	"slices"
+	"strings"
+)
+
+type Aspell struct {
+	Mode         mode     `yaml:"mode"`
+	AllowedWords []string `yaml:"allowed"`
+}
+
+func (a Aspell) checkSingle(data string) error {
+	var words []string
+	var badWords []string
+
+	checkRes, err := checkWithAspellExec(data)
+	if checkRes != "" {
+		words = strings.Split(checkRes, "\n")
+	}
+	if err != nil {
+		return err
+	}
+
+	for _, word := range words {
+		if len(word) < 1 {
+			continue
+		}
+		if !slices.Contains(a.AllowedWords, word) {
+			badWords = append(badWords, word)
+		}
+	}
+
+	if len(badWords) > 0 {
+		return fmt.Errorf("aspell: %s", badWords)
+	}
+	return nil
+}
+
+func (a Aspell) Check(content []string) error {
+	var response string
+	for _, subject := range content {
+		if err := a.checkSingle(subject); err != nil {
+			response += fmt.Sprintf("%s\n", err)
+		}
+	}
+	if len(response) > 0 {
+		return fmt.Errorf("%s", response)
+	}
+	return nil
+}
+
+func checkWithAspellExec(subject string) (string, error) {
+	cmd := exec.Command("aspell", "--list")
+	cmd.Stdin = strings.NewReader(subject)
+
+	var stdout, stderr bytes.Buffer
+	cmd.Stdout = &stdout
+	cmd.Stderr = &stderr
+	err := cmd.Run()
+	if err != nil {
+		log.Printf("aspell error: %s, stderr: %s", err, stderr.String())
+		return "", err
+	}
+
+	return stdout.String() + stderr.String(), nil
+}

aspell/aspell_test.go

@@ -0,0 +1,31 @@
+package aspell
+
+import "testing"
+
+func Test_checkWithAspell(t *testing.T) {
+	aspell := Aspell{
+		Mode:         modeSubject,
+		AllowedWords: []string{"config"},
+	}
+	tests := []struct {
+		name    string
+		subject string
+		wantErr bool
+	}{
+		{"OK", "BUG/MEDIUM: config: add default location of path to the configuration file", false},
+		{"error - flie", "BUG/MEDIUM: config: add default location of path to the configuration flie", true},
+		{"error - locatoin", "CLEANUP/MEDIUM: config: add default locatoin of path to the configuration file", true},
+		{"error - locatoin+flie", "CLEANUP/MEDIUM: config: add default locatoin of path to the configuration flie", true},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err := aspell.checkSingle(tt.subject)
+			if tt.wantErr && err == nil {
+				t.Errorf("checkWithAspell() error = %v, wantErr %v", err, tt.wantErr)
+			}
+			if !tt.wantErr && err != nil {
+				t.Errorf("checkWithAspell() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}

aspell/mode.go

@@ -0,0 +1,10 @@
+package aspell
+
+type mode string
+
+const (
+	modeDisabled mode = "disabled"
+	modeSubject  mode = "subject"
+	modeCommit   mode = "commit"
+	// modeAll     mode = "all"
+)

aspell/new.go

@@ -0,0 +1,37 @@
+package aspell
+
+import (
+	"fmt"
+	"log"
+	"os"
+
+	"gopkg.in/yaml.v3"
+)
+
+func New(filename string) (Aspell, error) {
+	var data []byte
+	var err error
+	if data, err = os.ReadFile(filename); err != nil {
+		log.Printf("warning: aspell exceptions file not found (%s)", err)
+	}
+
+	var aspell Aspell
+	err = yaml.Unmarshal(data, &aspell)
+	if err != nil {
+		return Aspell{}, err
+	}
+
+	switch aspell.Mode {
+	case modeDisabled:
+	case modeSubject:
+	case modeCommit:
+	case "":
+		aspell.Mode = modeSubject
+	default:
+		return Aspell{}, fmt.Errorf("invalid mode: %s", aspell.Mode)
+	}
+
+	log.Printf("aspell mode set to %s", aspell.Mode)
+
+	return aspell, nil
+}

check.go

@@ -14,11 +14,13 @@ import (
 	"unicode"
 	"unicode/utf8"
 
+	"check-commit/aspell"
+
 	"github.com/google/go-github/v56/github"
 
 	"github.com/xanzy/go-gitlab"
 	"golang.org/x/oauth2"
-	yaml "gopkg.in/yaml.v2"
+	yaml "gopkg.in/yaml.v3"
 )
 
 type patchTypeT struct {
@@ -401,6 +403,11 @@ func main() {
 		repoPath = os.Args[1]
 	}
 
+	aspellCheck, err := aspell.New(path.Join(repoPath, ".aspell.yml"))
+	if err != nil {
+		log.Fatalf("error reading aspell exceptions: %s", err)
+	}
+
 	commitPolicy, err := LoadCommitPolicy(path.Join(repoPath, ".check-commit.yml"))
 	if err != nil {
 		log.Fatalf("error reading configuration: %s", err)
@@ -425,5 +432,11 @@ func main() {
 		log.Fatalf("%s\n", commitPolicy.HelpText)
 	}
 
+	err = aspellCheck.Check(subjects)
+	if err != nil {
+		log.Fatalf("%s\n", err)
+		log.Printf("encountered one or more commit message spelling errors\n")
+	}
+
 	log.Printf("check completed without errors\n")
 }

check_different_policy_test.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"testing"
 
-	yaml "gopkg.in/yaml.v2"
+	yaml "gopkg.in/yaml.v3"
 )
 
 const customConf = `

go.mod

@@ -6,16 +6,13 @@ require (
 	github.com/google/go-github/v56 v56.0.0
 	github.com/xanzy/go-gitlab v0.107.0
 	golang.org/x/oauth2 v0.21.0
-	gopkg.in/yaml.v2 v2.4.0
+	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
-	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
-	golang.org/x/net v0.27.0 // indirect
+	golang.org/x/sys v0.22.0 // indirect
 	golang.org/x/time v0.5.0 // indirect
-	google.golang.org/appengine v1.6.8 // indirect
-	google.golang.org/protobuf v1.34.2 // indirect
 )