refactor: move webhook and api to http folder

Signed-off-by: Nico Braun <[email protected]>
bluebrown · Jan 20, 2024 · 791d880 · 791d880
1 parent 5108830
commit 791d880
Show file tree

Hide file tree

Showing 15 changed files with 44 additions and 105 deletions.
diff --git a/.github/check.sh b/.github/check.sh
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -o nounset -o errexit -o errtrace -o pipefail
+
+go mod tidy
+go generate ./...
+go fmt ./...
+git diff --exit-code
+go test -vet=all ./...
diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml
@@ -2,9 +2,7 @@ name: check
 on:
   workflow_dispatch: {}
   pull_request: {}
-  push:
-    branches:
-    - main
+  push: {}
 permissions:
   contents: read
   pull-requests: read
@@ -18,13 +16,4 @@ jobs:
       with:
         go-version: '1.21.5'
         cache: false
-    - name: install deps
-      run: go mod download
-    - name: run checks
-      run: make check
-    - name: golangci-lint
-      uses: golangci/golangci-lint-action@v3
-      with:
-        version: v1.54
-        only-new-issues: true
-        install-mode: "binary"
+    - run: bash .github/check.sh
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 .artifacts/
 .local/
+.tmp/
diff --git a/Makefile b/Makefile
@@ -1,31 +1,11 @@
 .SILENT:
 .PHONY: install check lint test vet generate testinfra dev
-
 bin=.local/bin
-INSTALL_DIR ?= $(CURDIR)/$(bin)
-
-RELEASE_TAG ?= $(shell git describe --tags --always --dirty)
-
-image:
-	docker build -t docker.io/bluebrown/kobold:$(RELEASE_TAG) -f build/Dockerfile .
 
-install:
-	GOBIN=$(INSTALL_DIR) go install -ldflags '-w -s' ./cmd/...
+export RELEASE_TAG ?= $(shell git describe --tags --always --dirty)
 
-check:
-	go mod tidy
-	$(MAKE) generate
-	go fmt ./...
-	git diff --exit-code
-	go vet ./...
-	go test ./...
-
-generate:
-	go generate ./...
-
-dbshell:
-	docker run --rm -ti -v /home/blue/.config/kobold:/tmp \
-		--entrypoint sqlite3 kobold /tmp/kobold.sqlite3
+artifacts:
+	bash build/artifacts.sh
 
 testinfra: $(bin)/skaffold
 	bash -x e2e/kind/up.sh
@@ -38,4 +18,3 @@ $(bin)/skaffold:
 	mkdir -p $(bin)
 	curl -fsSL https://storage.googleapis.com/skaffold/releases/latest/skaffold-linux-amd64 \
 	| install /dev/stdin $(bin)/skaffold
-
diff --git a/build/.swaggo b/build/.swaggo
@@ -1,2 +1,2 @@
 replace github.com/volatiletech/null/v8.String string
-replace git.GitPackageURI string
+replace git.PackageURI string
diff --git a/build/artifacts.sh b/build/artifacts.sh
@@ -5,6 +5,8 @@ out="${1:-.artifacts}"
 out="${out%/}"
 tag="${RELEASE_TAG:-dev}"
 
+echo "Building artifacts in $out" >&2
+
 script_dir="$(dirname "$(readlink -f "$0")")"
 cd "$script_dir/.."
 
@@ -14,6 +16,8 @@ td="build/.tmp"
 trap 'rm -rf "$td"' EXIT
 mkdir -p "$td" && rm -rf "${td:?}"/*
 
+echo "Building manifests..." >&2
+
 cd "$td"
 kustomize create
 kustomize edit add resource "../kube"
@@ -23,9 +27,13 @@ kustomize edit set label "app.kubernetes.io/version:$tag"
 cd -
 kustomize build "$td" >"$out/manifests.yaml"
 
+echo "Building OCI image..." >&2
+
 docker build -f build/Dockerfile -t "docker.io/bluebrown/kobold:$tag" .
 docker save "docker.io/bluebrown/kobold:$tag" >"$out/oci.tar"
 
+echo "Building binaries..." >&2
+
 GOBIN="$script_dir/../$out" go install ./cmd/...
 
 for f in $out/*; do
@@ -36,3 +44,5 @@ for f in $out/*; do
     mv "$f" "$out/kobold-${f##*/}"
   fi
 done
+
+echo "Done" >&2
diff --git a/build/generate.go b/build/generate.go
@@ -3,4 +3,4 @@
 package build
 
 //go:generate go run github.com/sqlc-dev/sqlc/cmd/sqlc generate
-//go:generate go run github.com/swaggo/swag/cmd/swag init --dir ../api/ --output ../api/docs/ --generalInfo handler.go --parseDependency github.com/bluebrown/kobold/store
+//go:generate go run github.com/swaggo/swag/cmd/swag init --dir ../http/api/ --output ../http/api/docs/ --generalInfo handler.go --parseDependency github.com/bluebrown/kobold/store/model
diff --git a/cmd/server/main.go b/cmd/server/main.go
@@ -14,12 +14,12 @@ import (
 	"golang.org/x/sync/errgroup"
 	_ "modernc.org/sqlite"
 
-	"github.com/bluebrown/kobold/api"
 	"github.com/bluebrown/kobold/config"
+	"github.com/bluebrown/kobold/http/api"
+	"github.com/bluebrown/kobold/http/webhook"
 	"github.com/bluebrown/kobold/store"
 	"github.com/bluebrown/kobold/store/schema"
 	"github.com/bluebrown/kobold/task"
-	"github.com/bluebrown/kobold/webhook"
 )
 
 func init() {

diff --git a/git/pkguri.go b/git/pkguri.go
@@ -62,7 +62,7 @@ func (uri *PackageURI) Scan(value interface{}) error {
 	case []byte:
 		b = v
 	default:
-		return fmt.Errorf("cannot convert %T to GitPackageURI", value)
+		return fmt.Errorf("cannot convert %T to PackageURI", value)
 	}
 	return uri.UnmarshalText(b)
 }

diff --git a/api/docs/docs.go → http/api/docs/docs.go b/api/docs/docs.go → http/api/docs/docs.go
@@ -498,20 +498,6 @@ const docTemplate = `{
                 }
             }
         },
-        "git.PackageURI": {
-            "type": "object",
-            "properties": {
-                "pkg": {
-                    "type": "string"
-                },
-                "ref": {
-                    "type": "string"
-                },
-                "repo": {
-                    "type": "string"
-                }
-            }
-        },
         "model.Channel": {
             "type": "object",
             "properties": {
@@ -556,7 +542,7 @@ const docTemplate = `{
                     "type": "string"
                 },
                 "repo_uri": {
-                    "$ref": "#/definitions/git.PackageURI"
+                    "type": "string"
                 }
             }
         },
@@ -583,7 +569,7 @@ const docTemplate = `{
                     "type": "string"
                 },
                 "repo_uri": {
-                    "$ref": "#/definitions/git.PackageURI"
+                    "type": "string"
                 },
                 "status": {
                     "type": "string"
@@ -631,7 +617,7 @@ const docTemplate = `{
                     "type": "string"
                 },
                 "repo_uri": {
-                    "$ref": "#/definitions/git.PackageURI"
+                    "type": "string"
                 },
                 "status": {
                     "type": "string"
@@ -667,7 +653,7 @@ const docTemplate = `{
                     "type": "string"
                 },
                 "repo_uri": {
-                    "$ref": "#/definitions/git.PackageURI"
+                    "type": "string"
                 },
                 "status": {
                     "type": "string"

diff --git a/api/docs/swagger.json → http/api/docs/swagger.json b/api/docs/swagger.json → http/api/docs/swagger.json
@@ -487,20 +487,6 @@
                 }
             }
         },
-        "git.PackageURI": {
-            "type": "object",
-            "properties": {
-                "pkg": {
-                    "type": "string"
-                },
-                "ref": {
-                    "type": "string"
-                },
-                "repo": {
-                    "type": "string"
-                }
-            }
-        },
         "model.Channel": {
             "type": "object",
             "properties": {
@@ -545,7 +531,7 @@
                     "type": "string"
                 },
                 "repo_uri": {
-                    "$ref": "#/definitions/git.PackageURI"
+                    "type": "string"
                 }
             }
         },
@@ -572,7 +558,7 @@
                     "type": "string"
                 },
                 "repo_uri": {
-                    "$ref": "#/definitions/git.PackageURI"
+                    "type": "string"
                 },
                 "status": {
                     "type": "string"
@@ -620,7 +606,7 @@
                     "type": "string"
                 },
                 "repo_uri": {
-                    "$ref": "#/definitions/git.PackageURI"
+                    "type": "string"
                 },
                 "status": {
                     "type": "string"
@@ -656,7 +642,7 @@
                     "type": "string"
                 },
                 "repo_uri": {
-                    "$ref": "#/definitions/git.PackageURI"
+                    "type": "string"
                 },
                 "status": {
                     "type": "string"

diff --git a/api/docs/swagger.yaml → http/api/docs/swagger.yaml b/api/docs/swagger.yaml → http/api/docs/swagger.yaml
@@ -6,15 +6,6 @@ definitions:
       message:
         type: string
     type: object
-  git.PackageURI:
-    properties:
-      pkg:
-        type: string
-      ref:
-        type: string
-      repo:
-        type: string
-    type: object
   model.Channel:
     properties:
       decoder_name:
@@ -44,7 +35,7 @@ definitions:
       post_hook_name:
         type: string
       repo_uri:
-        $ref: '#/definitions/git.PackageURI'
+        type: string
     type: object
   model.PipelineRunListRow:
     properties:
@@ -62,7 +53,7 @@ definitions:
       post_hook:
         type: string
       repo_uri:
-        $ref: '#/definitions/git.PackageURI'
+        type: string
       status:
         type: string
       timestamp: {}
@@ -94,7 +85,7 @@ definitions:
       post_hook:
         type: string
       repo_uri:
-        $ref: '#/definitions/git.PackageURI'
+        type: string
       status:
         type: string
       timestamp: {}
@@ -118,7 +109,7 @@ definitions:
       post_hook_name:
         type: string
       repo_uri:
-        $ref: '#/definitions/git.PackageURI'
+        type: string
       status:
         type: string
       task_group_fingerprint:

diff --git a/api/handler.go → http/api/handler.go b/api/handler.go → http/api/handler.go
@@ -11,7 +11,7 @@ import (
 	"github.com/gorilla/schema"
 	httpSwagger "github.com/swaggo/http-swagger/v2"
 
-	"github.com/bluebrown/kobold/api/docs"
+	"github.com/bluebrown/kobold/http/api/docs"
 	"github.com/bluebrown/kobold/store/model"
 )
 

diff --git a/webhook/handler.go → http/webhook/handler.go b/webhook/handler.go → http/webhook/handler.go
diff --git a/todo.md b/todo.md
@@ -8,7 +8,8 @@ would be more solid, if we didnt have to rely on the user to do this.
 
 ## starlark files
 
-store starlark scripts in file instead of db
+store starlark scripts in file instead of db? This would make it more easy to mount
+custom scripts into the container
 
 ## generic pipeline handler
 
@@ -34,15 +35,3 @@ allow to configure the commit and pr messages
 some tools split image references across fields (e.g. image and tag). This
 should be supported by kobold. There could be another option tag to specify what
 part of the image ref should be set.
-
-## option to truncate tables
-
-when the config file is reads, the tables will be updated. But it will never
-delete entries that are not present in the config file. This could lead to
-unwanted pipelines runs. There should be an option to truncate the tables before
-updating them.
-
-## track noop changes
-
-not every pipeline run leads to actual changes in a git repo. This could be
-tracked as additional field in the database and as prometheus metric.