Merge pull request #6 from vshn/change/framework

Extend framework to support multiple functions

Author: zugao

.gitignore

@@ -3,8 +3,7 @@
 /.github/release-notes.md
 
 # Build
-# TODO: Adjust binary file name
-/go-bootstrap
+/appcat-comp-functions
 *.out
 
 # Docs

Dockerfile

@@ -1,14 +1,25 @@
+FROM golang:1.20-alpine as Build
+
+ARG INSTANCE=""
+
+WORKDIR /app
+
+COPY . ./
+RUN go mod download
+
+RUN cd "cmd/$INSTANCE" && CGO_ENABLED=0 go build -o functionio .
+
 FROM docker.io/library/alpine:3.17 as runtime
 
+ARG INSTANCE=""
+
 RUN \
   apk add --update --no-cache \
-    bash \
-    curl \
-    ca-certificates \
-    tzdata
-
-# TODO: Adjust binary file name
-ENTRYPOINT ["go-bootstrap"]
-COPY go-bootstrap /usr/bin/
+  bash \
+  curl \
+  ca-certificates \
+  tzdata
 
-USER 65536:0
+ENTRYPOINT ["functionio"]
+CMD ["--log-level", "1"]
+COPY --from=Build /app/cmd/$INSTANCE/functionio /usr/bin/

Makefile

@@ -23,17 +23,30 @@ golangci_bin = $(go_bin)/golangci-lint
 help: ## Show this help
 	@grep -E -h '\s##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
 
+## BUILD an instance
 .PHONY: build
 build: build-bin build-docker ## All-in-one build
 
 .PHONY: build-bin
 build-bin: export CGO_ENABLED = 0
 build-bin: fmt vet ## Build binary
-	@go build -o $(BIN_FILENAME) .
+	@go build -o $(PROJECT_ROOT_DIR)/cmd/$(instance)/$(BIN_FILENAME) $(PROJECT_ROOT_DIR)/cmd/$(instance)
 
 .PHONY: build-docker
-build-docker: build-bin ## Build docker image
-	$(DOCKER_CMD) build -t $(CONTAINER_IMG) .
+build-docker: ## Build docker image
+	$(DOCKER_CMD) build -t $(CONTAINER_IMG) --build-arg INSTANCE=$(instance) .
+
+## BUILD all instances
+.PHONY: build-all
+build-all: build-bin-all build-docker-all ## All-in-one build for all instances
+
+.PHONY: build-bin-all
+build-bin-all: recursive_target=build-bin
+build-bin-all: $(instances) ## Build binaries
+
+.PHONY: build-docker-all
+build-docker-all: recursive_target=build-docker
+build-docker-all: $(instances) ## Build docker images
 
 .PHONY: test
 test: test-go ## All-in-one test
@@ -68,8 +81,18 @@ generate: ## Generate additional code and artifacts
 
 .PHONY: clean
 clean: kind-clean ## Cleans local build artifacts
-	docker rmi $(CONTAINER_IMG) || true
+clean: recursive_target=.clean-build-img
+clean: $(instances)
 	rm -rf docs/node_modules $(docs_out_dir) dist .cache $(WORK_DIR)
 
+.PHONY: .clean-build-img
+.clean-build-img:
+	docker rmi $(CONTAINER_IMG) -f || true
+	rm $(PROJECT_ROOT_DIR)/cmd/$(instance)/$(BIN_FILENAME)
+
 $(golangci_bin): | $(go_bin)
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b "$(go_bin)"
+
+.PHONY: $(instances)
+$(instances):
+	$(MAKE) $(recursive_target) -e instance=$(basename $(@F))

Makefile.vars.mk

@@ -1,24 +1,28 @@
 ## These are some common variables for Make
 
 PROJECT_ROOT_DIR = .
-# TODO: Adjust project meta
-PROJECT_NAME ?= go-bootstrap
+PROJECT_NAME ?= appcat-comp-functions
 PROJECT_OWNER ?= vshn
 
 WORK_DIR = $(PWD)/.work
 
+## BUILD
+instance ?= vshn-postgres-func
+instances ?= vshn-postgres-func
+
 ## BUILD:go
-BIN_FILENAME ?= $(PROJECT_NAME)
+BIN_FILENAME ?= $(instance)
 go_bin ?= $(WORK_DIR)/bin
 $(go_bin):
 	@mkdir -p $@
 
 ## BUILD:docker
 DOCKER_CMD ?= docker
 
+## BUILD:docker VSHN Postgres
 IMG_TAG ?= latest
 # Image URL to use all building/pushing image targets
-CONTAINER_IMG ?= ghcr.io/$(PROJECT_OWNER)/$(PROJECT_NAME):$(IMG_TAG)
+CONTAINER_IMG ?= ghcr.io/$(PROJECT_OWNER)/$(BIN_FILENAME):$(IMG_TAG)
 
 
 ## KIND:setup

README.md

@@ -1,118 +1,46 @@
-# go-bootstrap
+# appcat-comp-functions
 
-[![Build](https://img.shields.io/github/actions/workflow/status/vshn/go-bootstrap/.github/workflows/test.yml?branch=master)][build]
-![Go version](https://img.shields.io/github/go-mod/go-version/vshn/go-bootstrap)
-[![Version](https://img.shields.io/github/v/release/vshn/go-bootstrap)][releases]
-[![GitHub downloads](https://img.shields.io/github/downloads/vshn/go-bootstrap/total)][releases]
+[![Build](https://img.shields.io/github/actions/workflow/status/vshn/appcat-comp-functions/.github/workflows/test.yml?branch=master)][build]
+![Go version](https://img.shields.io/github/go-mod/go-version/vshn/appcat-comp-functions)
+[![Version](https://img.shields.io/github/v/release/vshn/appcat-comp-functions)][releases]
+[![GitHub downloads](https://img.shields.io/github/downloads/vshn/appcat-comp-functions/total)][releases]
 
-[build]: https://github.com/vshn/go-bootstrap/actions?query=workflow%3ATest
-[releases]: https://github.com/vshn/go-bootstrap/releases
+[build]: https://github.com/vshn/appcat-comp-functions/actions?query=workflow%3ATest
+[releases]: https://github.com/vshn/appcat-comp-functions/releases
+## Repository structure
 
-Template repository for common Go setups
+This repository will build different docker images for different services. For that reason some folder structure is bound to the name of the service.
 
-## Features
-
-* GitHub Workflows
-  - Build (Go & Docker image)
-  - Test
-  - Lint (Go & GolangCI)
-  - Release (Goreleaser & Changelog generator)
-
-* GitHub issue templates
-  - PR template
-  - Issue templates using GitHub issue forms
-
-* Goreleaser
-  - Go build for `amd64`, `armv8`
-  - Docker build for `latest` and `vx.y.z` tags
-  - Push Docker image to GitHub's registry `ghcr.io`
-
-* Antora documentation
-  - Build default documentation with VSHN styling
-  - Publish to GitHub Pages by default (opt-out)
-  - Automated with GitHub workflows to build in `master` branch and (pre-)releases.
-  - Available `make` targets are prefixed with `docs-`
-
-* Local Kubernetes environment
-  - Setup Kubernetes-In-Docker (kind)
-  - Prepares a kubeconfig file in `.kind/`
-  - Optionally install NGINX as ingress controller
-  - Available `make` targets are prefixed with `kind-`
-
-* CLI and logging framework
-  - To help get you started with CLI subcommands, flags and environment variables
-  - If you don't need subcommands, remove `example_command.go` and adjust `cli.App` settings in `main.go`
-
-## TODO's after generating from this template
-
-TIP: You can search for these tasks using `grep -n -r "TODO:" .`
-
-1. `go.mod`: Adjust module name.
-1. `.goreleaser.yml`: Adjust Docker image location in `dockers` and `docker_manifests` parameters.
-1. `.gitignore`: Adjust binary file name.
-1. `Dockerfile`: Adjust binary file name.
-1. `Makefile.vars.mk`: Adjust project meta.
-1. `.github/ISSUE_TEMPLATE/config.yml` (optional): Enable forwarding questions to GitHub Discussions or other page.
-1. `docs/antora.yml`: Adjust project meta.
-1. `docs/antora-playbook.yml`: Adjust project meta.
-1. `docs/modules/pages/index.adoc`: Edit start page.
-1. `docs/modules/nav.adoc`: Edit navigation.
-1. `main.go`: Adjust variables.
-1. Edit this README (including badges links)
-1. Start hacking in `example_command.go`.
-
-After completing a task, you can remove the comment in the files.
-
-## Other repository settings
-
-1. GitHub Settings
-   - "Options > Wiki" (disable)
-   - "Options > Allow auto-merge" (enable)
-   - "Options > Automatically delete head branches" (enable)
-   - "Collaborators & Teams > Add Teams and users to grant maintainer permissions
-   - "Branches > Branch protection rules":
-     - Branch name pattern: `master`
-     - Require status check to pass before merging: `["lint"]` (you may need to push come commits first)
-   - "Pages > Source": Branch `gh-pages`
-
-1. GitHub Issue labels
-   - "Issues > Labels > New Label" for the following labels with color suggestions:
-     - `change` (`#D93F0B`)
-     - `dependency` (`#ededed`)
-     - `breaking` (`#FBCA04`)
-
-## Antora documentation
-
-This template comes with an Antora documentation module to help you create Asciidoctor documentation.
-By default, it is automatically published to GitHub Pages in `gh-pages` branch, however it can also be included in external Antora playbooks.
-
-### Setup GitHub Pages
+```
+.
+├── cmd
+│   ├── vshn-postgres-func
+│   └── vshn-redis-func
+├── kind
+├── functions
+│   ├── vshn-common-func
+│   ├── vshn-postgres-func
+│   └── vshn-redis-func
+├── runtime
+└── test
+```
 
-Once you generated a new repository using this template, the initial commit automatically runs a Job that creates the documentation in the `gh-pages` branch.
-All you need to do is then to enable Pages in the settings.
+- `./cmd` contains the entry point boilerplate for each service.
+- `./pkg/functions` contains the actual logic for the function. Each transform should be in its own package.
 
-The `gh-pages` branch is a parent-less commit that only contains the Antora-generated files.
+## Add a new function
 
-However, if that's not the case or if you are setting up Antora in an existing repository, here's how you can achieve the same, but make sure to **commit or stash current changes first!**
-```bash
-current_branch=$(git rev-parse --abbrev-ref HEAD)
-initial_commit=$(git rev-list --max-parents=0 HEAD | tail -n 1)
-git switch --create gh-pages $initial_commit
-git rm -r --cached .
-git commit -m "Prepare gh-pages branch"
-git push --set-upstream origin gh-pages
-git switch -f $current_branch
-```
+The framework is designed to easily add new composition functions to any AppCat service.
 
-And you're done!
-GitHub automatically recognizes activity and sets up Pages if there's a `gh-pages` branch.
+To add a new function to PostgreSQL by VSHN:
 
----
+- Create a new package under `./pkg/functions/vshn-postgres-func`
+- Add the transform function to the list in `./cmd/vshn-postgres-func`
+- implement the actual `transform()` function by using the helper functions from `io.go`
 
-If you want to skip deployment to GitHub Pages you need to delete specific files and references:
-`rm -f .github/workflows/docs.yml docs/package*.json docs/antora-playbook.yml docs/antora-build.mk`.
-Also don't forget to delete the branch and disable Pages in the repository settings.
+This architecture allows us to run all the functions with a single command. But for debugging and development purpose it's possible to run each function seperately, by using the `--function` flag.
 
----
+## Manually testing a function
+To test a function you can leverage the FunctionIO file in the `./test` folder.
 
-If you want to remove documentation completely simply run `rm -rf docs .github/workflows/docs.yml`.
+`cat test/function-io.yaml | go run cmd/vshn-postgres-func/main.go --function myfunction > test.yaml`

cmd/vshn-postgres-func/main.go

@@ -0,0 +1,54 @@
+package main
+
+import (
+	"fmt"
+	vp "github.com/vshn/appcat-comp-functions/functions/vshn-postgres-func"
+	"github.com/vshn/appcat-comp-functions/runtime"
+	"os"
+
+	"github.com/urfave/cli/v2"
+	vshnv1 "github.com/vshn/component-appcat/apis/vshn/v1"
+)
+
+var postgresFunctions = []runtime.Transform[vshnv1.VSHNPostgreSQL, *vshnv1.VSHNPostgreSQL]{
+	{
+		Name:          "dummy",
+		TransformFunc: vp.Transform,
+	},
+}
+
+func main() {
+	app := newApp()
+	err := app.Run(os.Args)
+	// If required flags aren't set, it will return with error before we could set up logging
+	if err != nil {
+		_, _ = fmt.Fprintf(os.Stderr, "%v\n", err)
+		os.Exit(1)
+	}
+}
+
+func newApp() *cli.App {
+	app := &cli.App{
+		Name:    vp.AI.AppName,
+		Usage:   vp.AI.AppLongName,
+		Version: fmt.Sprintf("%s, revision=%s, date=%s", vp.AI.Version, vp.AI.Commit, vp.AI.Date),
+		Action:  run,
+		Flags: []cli.Flag{
+			runtime.NewLogLevelFlag(),
+			runtime.NewLogFormatFlag(),
+			runtime.NewFunctionFlag(),
+		},
+	}
+	return app
+}
+
+func run(ctx *cli.Context) error {
+	err := runtime.SetupLogging(vp.AI, ctx)
+	if err != nil {
+		return err
+	}
+
+	_ = runtime.LogMetadata(ctx, vp.AI)
+
+	return runtime.RunCommand(ctx, postgresFunctions)
+}

docs/antora-playbook.yml

@@ -1,8 +1,7 @@
 site:
-  # TODO: Adjust project meta
-  title: Go Bootstrap
-  start_page: go-bootstrap::index.adoc
-  url: https://vshn.github.io/go-bootstrap
+  title: AppCat Composition Functions
+  start_page: appcat-comp-functions::index.adoc
+  url: https://vshn.github.io/appcat-comp-functions
 content:
   sources:
     - url: ../antora

docs/antora.yml

@@ -1,5 +1,4 @@
-# TODO: Adjust project meta
-name: go-bootstrap
+name: appcat-comp-functions
 title: Go Bootstrap
 version: master
 start_page: ROOT:index.adoc