test: fix tests locally on windows, additional dev setup directions (#129)

* chore: try running tests on windows runner too

* chore: turn off running tests on windows runners (fails, seems like it tries to run other containers as windows)

* fix: multi target upload true in sample config so tests pass out the gates

* fix: make logging test platform-agnostic

* chore: additional setup directions, improved local testing experience

Author: budak7273

.gitignore

@@ -65,4 +65,6 @@ vendor/
 /.direnv
 
 /config*.json
-!config.sample.json
+!config.sample.json
+
+coverage.txt

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "ethan-reesor.exp-vscode-go"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "exp-vscode-go.testExplorer.enable": true
+}

README.md

@@ -38,11 +38,16 @@ The Satisfactory Mod Repository backend API - a Go-based service providing REST
    mise run api
    ```
 
-If running `api` produces errors about the database failing to apply migrations,
-you may have switched branches without cleaning up after database changes you were working on.
-The easiest way to get back from this state
-is to delete the `postgres` Docker container
-and delete all not-in-use volumes so it creates a fresh one.
+   If running `api` produces errors about the database failing to apply migrations,
+   you may have switched branches without cleaning up after database changes you were working on.
+   The easiest way to get back from this state
+   is to delete the `postgres` Docker container
+   and delete all not-in-use volumes so it creates a fresh one.
+
+3. Set up the Configuration File
+
+   Create a copy of `config.sample.json` as `config.json` and fill in the required fields.
+   See the [Configuration](#configuration) section for details.
 
 ## Development Commands
 
@@ -54,7 +59,7 @@ mise run generate
 mise run api
 
 # Testing
-mise run test
+mise run localtest
 mise run coverage
 
 # Linting
@@ -68,6 +73,17 @@ mise run teardown  # Stop services
 mise activate pwsh | Out-String | Invoke-Expression
 ```
 
+### Local Testing
+
+To run specific tests:
+
+- In VSCode, the [Go Companion](https://marketplace.visualstudio.com/items?itemName=ethan-reesor.exp-vscode-go) suggested extension adds Go test support to VSCode's testing integration.
+  Note you may need to reload VSCode (`Developer: Reload Window`) after adding or removing tests.
+- From the command line, use `go test -v run TestNameHere`
+
+To run all tests on your local machine, use `mise run localtest`, which excludes the verbose flag for easier human parsing of test output.
+It is expected for the command to output `[no test files]` for packages with no tests.
+
 ### Database Access
 
 The development docker compose also includes a pgadmin container for testing database related stuff
@@ -101,16 +117,17 @@ You can view tables via `Servers >(name)> Databases > postgres > Schemas > publi
 
 ## Configuration
 
-Create `config.json` or use environment variables with `REPO_` prefix.
+Create `config.json`, or use environment variables with `REPO_` prefix.
+A sample is provided: `config.sample.json`.
 
 **Required services:**
 
 1. **PostgreSQL** - Database (dev: port 5432)
 2. **Redis** - Cache/sessions (dev: port 6379)  
 3. **MinIO** - Object storage (dev: ports 9000/9001)
-4. **OAuth providers** - GitHub, Google, Facebook
-5. **PASETO keys** - Generate with `go run cmd/paseto/main.go`
-6. **VirusTotal API key** - For mod scanning
+4. **OAuth providers** - GitHub, Google, Facebook. For testing purposes, [setting up just GitHub](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) is the easiest.
+5. **PASETO keys** - Generate these with `go run cmd/paseto/main.go`
+6. **VirusTotal API key** - For mod scanning. Optional for testing.
 
 **Development services** are started automatically with `mise run setup`. MinIO configuration is included in the setup task.
 

config.sample.json

@@ -56,7 +56,7 @@
   },
 
   "feature_flags": {
-    "allow_multi_target_upload": false
+    "allow_multi_target_upload": true
   },
 
   "loki_endpoint": "http://localhost:3100/loki/api/v1/push",

logging/log_test.go

@@ -2,14 +2,11 @@ package logging
 
 import (
 	"bytes"
-	"context"
-	"log/slog"
+	"path/filepath"
 	"regexp"
-	"sync"
 	"testing"
 
 	"github.com/MarvinJWendt/testza"
-	"github.com/Vilsol/slox"
 	"github.com/spf13/viper"
 )
 
@@ -18,29 +15,18 @@ func TestLoggingDev(t *testing.T) {
 
 	testza.AssertNoError(t, SetupLogger(buffer))
 
-	slog.Info("A: 1")
-	slox.Info(context.Background(), "B: 2")
-
-	func() {
-		slox.Info(context.Background(), "C: 3")
-	}()
-
-	var wg sync.WaitGroup
-	wg.Add(1)
-	go func() {
-		defer wg.Done()
-		slox.Info(context.Background(), "D: 4")
-	}()
-	wg.Wait()
+	PrintLoggingDummies()
 
 	out := regexp.MustCompile(`\x1b\[\d+m`).ReplaceAll(buffer.Bytes(), []byte{})
 
 	lines := bytes.Split(out, []byte("\n"))
 
-	testza.AssertContains(t, string(lines[0]), "INF logging/log_test.go:21 A: 1 service=api")
-	testza.AssertContains(t, string(lines[1]), "INF logging/log_test.go:22 B: 2 service=api")
-	testza.AssertContains(t, string(lines[2]), "INF logging/log_test.go:25 C: 3 service=api")
-	testza.AssertContains(t, string(lines[3]), "INF logging/log_test.go:32 D: 4 service=api")
+	path := filepath.Join("logging", "logging_dummies.go")
+
+	testza.AssertContains(t, string(lines[0]), "INF "+path+":16 A: 1 service=api")
+	testza.AssertContains(t, string(lines[1]), "INF "+path+":17 B: 2 service=api")
+	testza.AssertContains(t, string(lines[2]), "INF "+path+":20 C: 3 service=api")
+	testza.AssertContains(t, string(lines[3]), "INF "+path+":27 D: 4 service=api")
 
 	if t.Failed() {
 		println(buffer.String())
@@ -53,27 +39,14 @@ func TestLoggingProd(t *testing.T) {
 
 	testza.AssertNoError(t, SetupLogger(buffer))
 
-	slog.Info("A: 1")
-	slox.Info(context.Background(), "B: 2")
-
-	func() {
-		slox.Info(context.Background(), "C: 3")
-	}()
-
-	var wg sync.WaitGroup
-	wg.Add(1)
-	go func() {
-		defer wg.Done()
-		slox.Info(context.Background(), "D: 4")
-	}()
-	wg.Wait()
+	PrintLoggingDummies()
 
 	lines := bytes.Split(buffer.Bytes(), []byte("\n"))
 
-	testza.AssertTrue(t, regexp.MustCompile(`\{"time":".+?","level":"INFO","source":\{"function":"github.com/satisfactorymodding/smr-api/logging.TestLoggingProd","file":".*?/logging/log_test.go","line":56},"msg":"A: 1"}`).Match(lines[0]))
-	testza.AssertTrue(t, regexp.MustCompile(`\{"time":".+?","level":"INFO","source":\{"function":"github.com/satisfactorymodding/smr-api/logging.TestLoggingProd","file":".*?/logging/log_test.go","line":57},"msg":"B: 2"}`).Match(lines[1]))
-	testza.AssertTrue(t, regexp.MustCompile(`\{"time":".+?","level":"INFO","source":\{"function":"github.com/satisfactorymodding/smr-api/logging.TestLoggingProd.func1","file":".*?/logging/log_test.go","line":60},"msg":"C: 3"}`).Match(lines[2]))
-	testza.AssertTrue(t, regexp.MustCompile(`\{"time":".+?","level":"INFO","source":\{"function":"github.com/satisfactorymodding/smr-api/logging.TestLoggingProd.func2","file":".*?/logging/log_test.go","line":67},"msg":"D: 4"}`).Match(lines[3]))
+	testza.AssertTrue(t, regexp.MustCompile(`\{"time":".+?","level":"INFO","source":\{"function":"github.com/satisfactorymodding/smr-api/logging.PrintLoggingDummies","file":".*?/logging/logging_dummies.go","line":16},"msg":"A: 1"}`).Match(lines[0]))
+	testza.AssertTrue(t, regexp.MustCompile(`\{"time":".+?","level":"INFO","source":\{"function":"github.com/satisfactorymodding/smr-api/logging.PrintLoggingDummies","file":".*?/logging/logging_dummies.go","line":17},"msg":"B: 2"}`).Match(lines[1]))
+	testza.AssertTrue(t, regexp.MustCompile(`\{"time":".+?","level":"INFO","source":\{"function":"github.com/satisfactorymodding/smr-api/logging.PrintLoggingDummies.func1","file":".*?/logging/logging_dummies.go","line":20},"msg":"C: 3"}`).Match(lines[2]))
+	testza.AssertTrue(t, regexp.MustCompile(`\{"time":".+?","level":"INFO","source":\{"function":"github.com/satisfactorymodding/smr-api/logging.PrintLoggingDummies.func2","file":".*?/logging/logging_dummies.go","line":27},"msg":"D: 4"}`).Match(lines[3]))
 
 	if t.Failed() {
 		println(buffer.String())

logging/logging_dummies.go

@@ -0,0 +1,30 @@
+package logging
+
+import (
+	"context"
+	"log/slog"
+	"sync"
+
+	"github.com/Vilsol/slox"
+)
+
+// PrintLoggingDummies logs messages for testing purposes.
+// It's in a separate file from the actual logging tests because the tests care
+// about what file line numbers the calls are from. Having them in a separate file
+// makes editing the tests easier without breaking the line numbers.
+func PrintLoggingDummies() {
+	slog.Info("A: 1")
+	slox.Info(context.Background(), "B: 2")
+
+	func() {
+		slox.Info(context.Background(), "C: 3")
+	}()
+
+	var wg sync.WaitGroup
+	wg.Add(1)
+	go func() {
+		defer wg.Done()
+		slox.Info(context.Background(), "D: 4")
+	}()
+	wg.Wait()
+}

mise.toml

@@ -12,7 +12,11 @@ protoc-gen-go-grpc = "1.5.1"
 run = "go run cmd/api/serve.go"
 
 [tasks.test]
-run = "go test -p 1 -v -timeout 1h ./..."
+run = "go test -parallel 1 -v -timeout 1h ./..."
+
+# Run the tests without the verbose flag so it is easier to parse the output for local development
+[tasks.localtest]
+run = "go test -parallel 1 -timeout 1h ./..."
 
 [tasks.coverage]
 run = "go test -v -coverprofile=coverage.txt -covermode=atomic -coverpkg=./... -p 1 -timeout 1h ./..."