test: reactions

.github/workflows/ci.yml

@@ -5,6 +5,22 @@ on:
   release: { types: [ published ] }
 
 jobs:
+  fmt:
+    name: Fmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with: { go-version: '1.22' }
+      - uses: oven-sh/setup-bun@v1
+
+      - run: make build-ui
+
+      - run: make install
+      - run: make fmt
+
+      - run: git diff --exit-code
+
   lint:
     name: Lint
     runs-on: ubuntu-latest
@@ -31,3 +47,10 @@ jobs:
       - run: make build-ui
 
       - run: make test
+
+      - run: make test-coverage
+
+      - uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage.out
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/semantic-pull-request.yml

@@ -20,6 +20,6 @@ jobs:
         with:
           scopes: |
             deps
-          subjectPattern: "^(?!deps$).+"
+          subjectPattern: ^(?![A-Z]).+$
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -34,3 +34,5 @@ dist
 pb_data
 catalyst
 catalyst_data
+
+coverage.out

.golangci.yml

@@ -12,6 +12,7 @@ linters:
     - nestif
 
     # disable
+    - bodyclose
     - depguard
     - dupl
     - err113
@@ -28,6 +29,8 @@ linters:
     - lll
     - makezero
     - mnd
+    - paralleltest
+    - perfsprint
     - prealloc
     - tagalign
     - tagliatelle

Makefile

@@ -1,9 +1,9 @@
 .PHONY: install
 install:
 	@echo "Installing..."
-	go install github.com/bombsimon/wsl/v4/cmd...@master
-	go install mvdan.cc/gofumpt@latest
-	go install github.com/daixiang0/gci@latest
+	go install github.com/bombsimon/wsl/v4/cmd...@v4.4.1
+	go install mvdan.cc/gofumpt@v0.6.0
+	go install github.com/daixiang0/gci@v0.13.4
 
 .PHONY: fmt
 fmt:
@@ -26,6 +26,13 @@ test:
 	go test -v ./...
 	cd ui && bun test
 
+.PHONY: test-coverage
+test-coverage:
+	@echo "Testing with coverage..."
+	go test -coverpkg=./... -coverprofile=coverage.out ./...
+	go tool cover -func=coverage.out
+	go tool cover -html=coverage.out
+
 .PHONY: build-ui
 build-ui:
 	@echo "Building..."

app/app.go

@@ -0,0 +1,44 @@
+package app
+
+import (
+	"os"
+	"strings"
+
+	"github.com/pocketbase/pocketbase"
+	"github.com/pocketbase/pocketbase/core"
+
+	"github.com/SecurityBrewery/catalyst/migrations"
+	"github.com/SecurityBrewery/catalyst/reaction"
+	"github.com/SecurityBrewery/catalyst/webhook"
+)
+
+func init() {
+	migrations.Register()
+}
+
+func App(dir string) *pocketbase.PocketBase {
+	app := pocketbase.NewWithConfig(pocketbase.Config{
+		DefaultDev:     dev(),
+		DefaultDataDir: dir,
+	})
+
+	BindHooks(app)
+
+	// Register additional commands
+	app.RootCmd.AddCommand(bootstrapCmd(app))
+	app.RootCmd.AddCommand(fakeDataCmd(app))
+	app.RootCmd.AddCommand(setFeatureFlagsCmd(app))
+
+	return app
+}
+
+func BindHooks(app core.App) {
+	webhook.BindHooks(app)
+	reaction.BindHooks(app)
+
+	app.OnBeforeServe().Add(addRoutes())
+}
+
+func dev() bool {
+	return strings.HasPrefix(os.Args[0], os.TempDir())
+}

app/bootstrap.go

@@ -0,0 +1,25 @@
+package app
+
+import (
+	"github.com/pocketbase/pocketbase/core"
+	"github.com/spf13/cobra"
+)
+
+func Bootstrap(app core.App) error {
+	if err := app.Bootstrap(); err != nil {
+		return err
+	}
+
+	return MigrateDBs(app)
+}
+
+func bootstrapCmd(app core.App) *cobra.Command {
+	return &cobra.Command{
+		Use: "bootstrap",
+		Run: func(_ *cobra.Command, _ []string) {
+			if err := Bootstrap(app); err != nil {
+				app.Logger().Error(err.Error())
+			}
+		},
+	}
+}

app/fakedata.go

@@ -0,0 +1,27 @@
+package app
+
+import (
+	"github.com/pocketbase/pocketbase/core"
+	"github.com/spf13/cobra"
+
+	"github.com/SecurityBrewery/catalyst/fakedata"
+)
+
+func fakeDataCmd(app core.App) *cobra.Command {
+	var userCount, ticketCount int
+
+	cmd := &cobra.Command{
+		Use: "fake-data",
+		Run: func(_ *cobra.Command, _ []string) {
+			if err := fakedata.Generate(app, userCount, ticketCount); err != nil {
+				app.Logger().Error(err.Error())
+			}
+		},
+	}
+
+	cmd.PersistentFlags().IntVar(&userCount, "users", 10, "Number of users to generate")
+
+	cmd.PersistentFlags().IntVar(&ticketCount, "tickets", 100, "Number of tickets to generate")
+
+	return cmd
+}

app/flags.go

@@ -0,0 +1,80 @@
+package app
+
+import (
+	"slices"
+
+	"github.com/pocketbase/pocketbase/core"
+	"github.com/pocketbase/pocketbase/models"
+	"github.com/spf13/cobra"
+
+	"github.com/SecurityBrewery/catalyst/migrations"
+)
+
+func Flags(app core.App) ([]string, error) {
+	records, err := app.Dao().FindRecordsByExpr(migrations.FeatureCollectionName)
+	if err != nil {
+		return nil, err
+	}
+
+	var flags []string
+
+	for _, r := range records {
+		flags = append(flags, r.GetString("name"))
+	}
+
+	return flags, nil
+}
+
+func SetFlags(app core.App, args []string) error {
+	featureCollection, err := app.Dao().FindCollectionByNameOrId(migrations.FeatureCollectionName)
+	if err != nil {
+		return err
+	}
+
+	featureRecords, err := app.Dao().FindRecordsByExpr(migrations.FeatureCollectionName)
+	if err != nil {
+		return err
+	}
+
+	var existingFlags []string
+
+	for _, featureRecord := range featureRecords {
+		// remove feature flags that are not in the args
+		if !slices.Contains(args, featureRecord.GetString("name")) {
+			if err := app.Dao().DeleteRecord(featureRecord); err != nil {
+				return err
+			}
+
+			continue
+		}
+
+		existingFlags = append(existingFlags, featureRecord.GetString("name"))
+	}
+
+	for _, arg := range args {
+		if slices.Contains(existingFlags, arg) {
+			continue
+		}
+
+		// add feature flags that are not in the args
+		record := models.NewRecord(featureCollection)
+		record.Set("name", arg)
+
+		if err := app.Dao().SaveRecord(record); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func setFeatureFlagsCmd(app core.App) *cobra.Command {
+	return &cobra.Command{
+		Use: "set-feature-flags",
+		Run: func(_ *cobra.Command, args []string) {
+			if err := SetFlags(app, args); err != nil {
+				app.Logger().Error(err.Error())
+			}
+		},
+	}
+}

app/flags_test.go

@@ -0,0 +1,41 @@
+package app_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/SecurityBrewery/catalyst/app"
+	catalystTesting "github.com/SecurityBrewery/catalyst/testing"
+)
+
+func Test_flags(t *testing.T) {
+	catalystApp, cleanup := catalystTesting.App(t)
+	defer cleanup()
+
+	got, err := app.Flags(catalystApp)
+	require.NoError(t, err)
+
+	want := []string{}
+	assert.ElementsMatch(t, want, got)
+}
+
+func Test_setFlags(t *testing.T) {
+	catalystApp, cleanup := catalystTesting.App(t)
+	defer cleanup()
+
+	require.NoError(t, app.SetFlags(catalystApp, []string{"test"}))
+
+	got, err := app.Flags(catalystApp)
+	require.NoError(t, err)
+
+	assert.ElementsMatch(t, []string{"test"}, got)
+
+	require.NoError(t, app.SetFlags(catalystApp, []string{"test2"}))
+
+	got, err = app.Flags(catalystApp)
+	require.NoError(t, err)
+
+	assert.ElementsMatch(t, []string{"test2"}, got)
+}

app/migrate.go

@@ -0,0 +1,72 @@
+package app
+
+import (
+	"strings"
+
+	"github.com/pocketbase/dbx"
+	"github.com/pocketbase/pocketbase/core"
+	"github.com/pocketbase/pocketbase/migrations"
+	"github.com/pocketbase/pocketbase/migrations/logs"
+	"github.com/pocketbase/pocketbase/tools/migrate"
+)
+
+type migration struct {
+	db         *dbx.DB
+	migrations migrate.MigrationsList
+}
+
+func MigrateDBs(app core.App) error {
+	for _, m := range []migration{
+		{db: app.DB(), migrations: migrations.AppMigrations},
+		{db: app.LogsDB(), migrations: logs.LogsMigrations},
+	} {
+		runner, err := migrate.NewRunner(m.db, m.migrations)
+		if err != nil {
+			return err
+		}
+
+		if _, err := runner.Up(); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+// this fix ignores some errors that come from upstream migrations.
+var ignoreErrors = []string{
+	"1673167670_multi_match_migrate",
+	"1660821103_add_user_ip_column",
+}
+
+func isIgnored(err error) bool {
+	for _, ignore := range ignoreErrors {
+		if strings.Contains(err.Error(), ignore) {
+			return true
+		}
+	}
+
+	return false
+}
+
+func MigrateDBsDown(app core.App) error {
+	for _, m := range []migration{
+		{db: app.DB(), migrations: migrations.AppMigrations},
+		{db: app.LogsDB(), migrations: logs.LogsMigrations},
+	} {
+		runner, err := migrate.NewRunner(m.db, m.migrations)
+		if err != nil {
+			return err
+		}
+
+		if _, err := runner.Down(len(m.migrations.Items())); err != nil {
+			if isIgnored(err) {
+				continue
+			}
+
+			return err
+		}
+	}
+
+	return nil
+}