Initial commit

Author: McSwitch

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: Build
+
+on:
+  pull_request:
+    branches: ['main']
+
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.16.x
+
+      - run: |
+          go generate -v .
+          CGO_ENABLED=0 GOOS=linux go build ./...

.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  goreleaser:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.16.x
+
+      - run: |
+          go generate -v .
+          CGO_ENABLED=0 GOOS=linux go build -o build
+          go test -run=^$ ./...
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Test
+
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    branches: ['main']
+
+jobs:
+
+  test:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.16.x
+
+      - run: |
+          go generate -v .
+          go test -coverprofile=coverage.txt -covermode=atomic -race ./...
+
+      - uses: codecov/codecov-action@v1

.gitignore

@@ -0,0 +1,4 @@
+.idea
+cmd/base.meta.go
+service/base.meta.go
+build

Dockerfile

@@ -0,0 +1,4 @@
+FROM scratch
+ADD build /
+ENTRYPOINT ["/build"]
+CMD ["run"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Uniform
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,98 @@
+# base-service
+A templated starting point for uniform microservices
+
+### Getting Started
+First step is to compile resources and metadata into the project's source-code:
+```
+go generate
+```
+This will create a file `service/meta.go` which is ignored by the `.gitignore` and contains the project's resources and metadata.
+Create `.description` file to override the description as pulled from Github.
+
+### CLI Commands
+
+cmd command example `cmd/command.example-one.go`:
+```
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+	"service/service"
+)
+
+var exampleOneCmd = &cobra.Command{
+	Use:   "command:example-one",
+	Short: "Request the running " + service.AppName + " to execute the example-one command",
+	Long:  "Request the running " + service.AppName + " to execute the example-one command",
+	Run: func(cmd *cobra.Command, args []string) {
+		service.Command("example-one", natsUri, compileNatsOptions())
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(exampleOneCmd)
+}
+```
+
+service command example `service/command.example-one.go`:
+```
+package service
+
+import (
+	"github.com/go-diary/diary"
+	"github.com/go-uniform/uniform"
+)
+
+func init() {
+	subscribe(local(command("example-one")), exampleOne)
+}
+
+func exampleOne(r uniform.IRequest, p diary.IPage) {
+	// todo: write logic here
+}
+```
+
+### Background Worker Process
+
+Use a CLI Command and add it to a scheduled cronjob to avoid the background process from being executed multiple times when scaling service instances.
+In other words this will work like a sync.Mutex but across all running instances of the given service, allowing us to add as many service instances as we need.
+
+### Routines
+
+service action example `service/routine.example-two.go`:
+```
+package service
+
+import (
+	"github.com/go-diary/diary"
+	"github.com/go-uniform/uniform"
+)
+
+func init() {
+	subscribe(local("example-two"), exampleTwo)
+}
+
+func exampleTwo(r uniform.IRequest, p diary.IPage) {
+	// todo: write logic here
+}
+```
+
+### Events
+
+service event example `service/event.example-three.go`:
+```
+package service
+
+import (
+	"github.com/go-diary/diary"
+	"github.com/go-uniform/uniform"
+)
+
+func init() {
+	subscribe(local("example-three"), exampleThree)
+}
+
+func exampleThree(r uniform.IRequest, p diary.IPage) {
+	// todo: write logic here
+}
+```

cmd/base.command.go

@@ -0,0 +1,16 @@
+package cmd
+
+import (
+	"fmt"
+	"github.com/spf13/cobra"
+	"service/service"
+)
+
+func Command(name string, handler func(cmd *cobra.Command, args []string)) *cobra.Command {
+	return &cobra.Command{
+		Use:   fmt.Sprintf("command:%s", name),
+		Short: fmt.Sprintf("Request the running %s to execute the %s command", service.AppName, name),
+		Long:  fmt.Sprintf("Request the running %s to execute the %s command", service.AppName, name),
+		Run:   handler,
+	}
+}

cmd/base.execute.go

@@ -0,0 +1,63 @@
+package cmd
+
+import (
+	"crypto/tls"
+	"fmt"
+	"github.com/nats-io/go-nats"
+	"github.com/spf13/cobra"
+	"os"
+	"service/service"
+)
+
+var natsUri string
+var natsCert string
+var natsKey string
+var level string
+var rate int
+var limit int
+var test bool
+var disableTls bool
+
+var rootCmd = &cobra.Command{
+	Use:   service.AppName,
+	Short: service.AppDescription,
+	Long:  service.AppDescription,
+	Run: func(cmd *cobra.Command, args []string) {
+		if err := cmd.Help(); err != nil {
+			panic(err)
+		}
+	},
+}
+
+func init() {
+	rootCmd.PersistentFlags().StringVarP(&natsUri, "nats", "n", nats.DefaultURL, "The nats cluster URI")
+	rootCmd.PersistentFlags().StringVarP(&natsCert, "nats-cert", "", "/etc/ssl/certs/ssl-bundle.crt", "The nats cluster TLS certificate file path")
+	rootCmd.PersistentFlags().StringVarP(&natsKey, "nats-key", "", "/etc/ssl/private/ssl.key", "The nats cluster TLS key file path")
+	rootCmd.PersistentFlags().BoolVar(&disableTls, "disable-tls", false, "A flag indicating if service should disable tls encryption")
+}
+
+func compileNatsOptions() []nats.Option {
+	var natsOptions = make([]nats.Option, 0)
+	if !disableTls {
+		cert, err := tls.LoadX509KeyPair(natsCert, natsKey)
+		if err != nil {
+			panic(err)
+		}
+		config := &tls.Config{
+			// since NATS backbone for Fluid will always be on a private line we must skip host verification step
+			InsecureSkipVerify: true,
+
+			Certificates: []tls.Certificate{cert},
+			MinVersion:   tls.VersionTLS12,
+		}
+		natsOptions = append(natsOptions, nats.Secure(config))
+	}
+	return natsOptions
+}
+
+func Execute() {
+	if err := rootCmd.Execute(); err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+}

cmd/base.version.go

@@ -0,0 +1,20 @@
+package cmd
+
+import (
+	"fmt"
+	"github.com/spf13/cobra"
+	"service/service"
+)
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Show " + service.AppName + " version information",
+	Long:  "Show " + service.AppName + " version information",
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("%s version %s, build %s\n", service.AppName, service.AppVersion, service.AppCommit)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}

cmd/command.ping.go

@@ -0,0 +1,13 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+	"service/service"
+)
+
+func init() {
+	rootCmd.AddCommand(Command("ping", func(cmd *cobra.Command, args []string) {
+		service.InitializeDiary(test, level, rate)
+		service.Command("ping", natsUri, compileNatsOptions(), map[string]string{})
+	}))
+}

cmd/run.go

@@ -0,0 +1,28 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+	"service/service"
+)
+
+var runCmd = &cobra.Command{
+	Use:   "run",
+	Short: "Run " + service.AppName + " service",
+	Long:  "Run " + service.AppName + " service",
+	Run: func(cmd *cobra.Command, args []string) {
+		service.InitializeDiary(test, level, rate)
+		service.Execute(limit, test, natsUri, compileNatsOptions(), service.M{
+			// todo: add custom args here
+		})
+	},
+}
+
+func init() {
+	runCmd.Flags().StringVarP(&level, "lvl", "l", "trace", "The logging level ['trace', 'debug', 'info', 'notice', 'warning', 'error', 'fatal'] that service is running in")
+	runCmd.Flags().IntVarP(&rate, "rate", "r", 1000, "The sample rate of the trace logs used for performance auditing [set to -1 to log every trace]")
+	runCmd.Flags().IntVarP(&limit, "limit", "x", 1000, "The messages per second that each topic worker will be limited to [set to 0 or less for maximum throughput]")
+	runCmd.Flags().BoolVar(&test, "test", false, "A flag indicating if service should enter into test mode")
+	runCmd.Flags().BoolVar(&disableTls, "disable-tls", false, "A flag indicating if service should disable tls encryption")
+
+	rootCmd.AddCommand(runCmd)
+}