tests: config tests

Author: holysoles

.github/workflows/main.yml

@@ -0,0 +1,90 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+env:
+      GO_VERSION: 1.23
+      CGO_ENABLED: 0
+
+jobs:
+  lint:
+    name: Go Lint
+    runs-on: ubuntu-latest
+    env:
+      GOLANGCI_LINT_VERSION: v2.5.0
+    defaults:
+      run:
+        working-directory: ${{ github.workspace }}/go/src/github.com/${{ github.repository }}
+
+    steps:
+      # https://github.com/marketplace/actions/setup-go-environment
+      - name: Set up Go ${{ env.GO_VERSION }}
+        uses: actions/setup-go@bfdd3570ce990073878bf10f6b2d79082de49492 # v2
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      # https://github.com/marketplace/actions/checkout
+      - name: Check out code
+        uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2
+        with:
+          path: go/src/github.com/${{ github.repository }}
+          fetch-depth: 0
+
+      # https://golangci-lint.run/usage/install#other-ci
+      - name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }}
+        run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
+
+      - name: Setup GOPATH
+        run: go env -w GOPATH=${{ github.workspace }}/go
+
+      - name: gofmt
+        run: |
+          if [ "$(gofmt -s -l . | wc -l)" -gt 0 ]; then
+            gofmt -s -d .
+            exit 1
+          fi
+
+      - name: Golangci-lint
+        run: make lint
+
+  test:
+    name: Go Tests
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ${{ github.workspace }}/go/src/github.com/${{ github.repository }}
+
+    steps:
+      - name: Set up Go ${{ env.GO_VERSION }}
+        uses: actions/setup-go@bfdd3570ce990073878bf10f6b2d79082de49492 # v2
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: Check out code
+        uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2
+        with:
+          path: go/src/github.com/${{ github.repository }}
+          fetch-depth: 0
+
+      - name: Cache Go modules
+        uses: actions/cache@6f8efc29b200d32929f49075959781ed54ec270c # v3
+        with:
+          path: ${{ github.workspace }}/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+
+      - name: Setup GOPATH
+        run: go env -w GOPATH=${{ github.workspace }}/go
+
+      - name: Run tests
+        run: make test
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,3 +1,5 @@
+coverage.out
+
 lib/
 containers/
 currunt

Makefile

@@ -5,6 +5,12 @@ default: build run
 build:
 	CGO_ENABLED=0 go build
 
+test:
+	go test -v -cover -coverprofile=coverage.out ./...
+
+lint:
+	golangci-lint run
+
 run:	
 	sudo ./currunt run -image ghcr.io/holysoles/ginrcon@sha256:f1a0a09ad95ae203006e2d57a38e5bf2e257a7fdbd449d81ff32796c06cc5871 -interactive -tty -entrypoint "/bin/sh"
 

main.go

@@ -71,7 +71,7 @@ func main() {
 			os.Exit(1)
 		}
 
-		config, err := config.Load()
+		config, err := config.Load("")
 		if err != nil {
 			fmt.Printf("error loading config: %s\n", err)
 			os.Exit(1)

pkg/config/config.go

@@ -7,7 +7,6 @@ import (
 )
 
 const (
-	//	DOCKER_CONFIG_PATH = "/root/.docker/config.json"
 	DOCKER_CONFIG_PATH = "/home/patrick/.docker/config.json"
 	IMAGE_LIB          = "./lib"
 )
@@ -17,21 +16,25 @@ type AuthConfig struct {
 }
 type CurruntConfig struct {
 	Auths       map[string]AuthConfig `json:"auths"`
-	LibraryPath string                `json:library_path`
+	LibraryPath string                `json:"library_path"`
 }
 
-func Load() (CurruntConfig, error) {
-	cPath := DOCKER_CONFIG_PATH
-
+// Load returns the Currunt Configuration, loaded from the DOCKER_CONFIG_PATH constant.
+func Load(path string) (CurruntConfig, error) {
 	var c CurruntConfig
 	c.LibraryPath = IMAGE_LIB
-	_, err := os.Stat(cPath)
-	// no config file is okay
-	if err != nil {
-		return c, nil
+
+	if path == "" {
+		path = DOCKER_CONFIG_PATH
+	} else {
+		// should exist if specified
+		_, err := os.Stat(path)
+		if err != nil {
+			return c, nil
+		}
 	}
 
-	cF, err := os.Open(cPath)
+	cF, err := os.OpenFile(path, os.O_CREATE|os.O_RDONLY, 0666)
 	if err != nil {
 		return c, err
 	}

pkg/config/config_test.go

@@ -0,0 +1,19 @@
+package config
+
+import (
+	"testing"
+)
+
+func TestLoadDefault(t *testing.T) {
+	_, err := Load("")
+	if err != nil {
+		t.Errorf("unexpected error loading configuration file: %v", err)
+	}
+}
+
+func TestLoadBadPath(t *testing.T) {
+	_, err := Load("/notexist.config")
+	if err != nil {
+		t.Errorf("unexpected error loading configuration file: %v", err)
+	}
+}

pkg/oci/image.go

@@ -404,7 +404,7 @@ func PullImage(i string, config config.CurruntConfig) (string, error) {
 	// check if we were provided an index digest. If so, get the image digest
 	_, err = getManifest(&client, &headers, image, iPath, regInfo)
 	if err != nil {
-		fmt.Println("DEBUG: looking up image index, provided digest apparently not manifest: %v", err)
+		fmt.Printf("DEBUG: looking up image index, provided digest apparently not manifest: %v\n", err)
 		mIdx, err := getManifestIndex(&client, &headers, &image, &regInfo)
 		if err != nil {
 			return imageID, err