Uplift to use x/events (#35)

* move to events.ChangeMessage

Signed-off-by: Matt Siwiec <[email protected]>

* move to x/events

Signed-off-by: Matt Siwiec <[email protected]>

* help target

Signed-off-by: Matt Siwiec <[email protected]>

* nats jetstream

Signed-off-by: Matt Siwiec <[email protected]>

* changes to support event integration testing

Signed-off-by: Matt Siwiec <[email protected]>

* use appConfig, remove prefix checks

Signed-off-by: Matt Siwiec <[email protected]>

---------

Signed-off-by: Matt Siwiec <[email protected]>

Author: rizzza

.devcontainer/devcontainer.json

@@ -8,7 +8,7 @@
                 "dev",
                 "haproxy",
                 "nats-auth",
-                "nats-server"
+                "nats"
         ],
         "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
         "customizations": {

.devcontainer/docker-compose.yaml

@@ -1,9 +1,12 @@
 services:
   dev:
+    image: devcontainer
     build:
       context: .
       dockerfile: Dockerfile
     command: sleep infinity
+    depends_on:
+      - nats-init
     volumes:
       - ..:/workspaces:cached
       - nats-auth:/etc/nats-auth
@@ -12,29 +15,61 @@ services:
     #   - "127.0.0.1:2222:2222"
     # Use "forwardPorts" in **devcontainer.json** to forward a port locally.
     # (Adding the "ports" property to this file will not forward from a Codespace.)
+
   haproxy:
     build:
       context: .
       dockerfile: Dockerfile.haproxy
     network_mode: service:dev
+
   nats-auth:
     image: natsio/nats-box:0.13.8
     command:
       - /tmp/configure-nats
     volumes:
       - nats-auth:/etc/nats-auth
       - ./setup-scripts:/tmp
-  nats-server:
+
+  nats:
     image: nats:alpine
+    restart: unless-stopped
     command:
+      - --jetstream
       - -c
       - /etc/nats/resolver.conf
       - -D
     depends_on:
       - nats-auth
-    network_mode: service:dev
     volumes:
       - nats-auth:/etc/nats
 
+  nats-init:
+    image: devcontainer
+    depends_on:
+      - nats
+    restart: on-failure
+    command:
+      [
+        "nats",
+        "stream",
+        "--server=nats",
+        "add",
+        "loadbalancer-manager-haproxy",
+        "--subjects=com.infratographer.>",
+        "--storage=memory",
+        "--replicas=1",
+        "--retention=limits",
+        "--discard=old",
+        "--max-msgs=-1",
+        "--max-msgs-per-subject=-1",
+        "--max-bytes=-1",
+        "--max-age=-1",
+        "--max-msg-size=-1",
+        "--dupe-window='2m0s'",
+        "--no-allow-rollup",
+        "--deny-delete",
+        "--deny-purge"
+      ]
+
 volumes:
   nats-auth:

.devcontainer/setup-scripts/configure-nats

@@ -1,4 +1,6 @@
-#!/bin/sh
+#!/usr/bin/env sh
+
+set -e
 
 echo "Creating NATS Operator"
 nsc add operator -n TEST-OPERATOR --sys --generate-signing-key
@@ -14,4 +16,4 @@ mkdir /etc/nats-auth
 nsc generate config --mem-resolver --sys-account SYS > /etc/nats-auth/resolver.conf
 
 echo "Save NATS User creds"
-nsc generate creds -n MANAGER > /etc/nats-auth/manager.creds
+nsc generate creds -n MANAGER > /etc/nats-auth/manager.creds

Makefile

@@ -1,37 +1,40 @@
 all: lint test
-PHONY: test coverage lint golint clean vendor docker-up docker-down unit-test
+PHONY: test unit-test coverage lint golint clean build vendor
 GOOS=linux
 APP_NAME=loadbalancer-manager-haproxy
 
+help: Makefile ## Print help
+	@grep -h "##" $(MAKEFILE_LIST) | grep -v grep | sed -e 's/:.*##/#/' | column -c 2 -t -s#
+
 test: | lint unit-test
 
-unit-test:
+unit-test: ## Run unit tests
 	@echo Running unit tests...
 	@go test -cover -short -tags testtools ./...
 
-coverage:
+coverage: ## Run unit tests with coverage
 	@echo Generating coverage report...
 	@go test ./... -race -coverprofile=coverage.out -covermode=atomic -tags testtools -p 1
 	@go tool cover -func=coverage.out
 	@go tool cover -html=coverage.out
 
-lint: golint
+lint: golint ## Runs linting
 
 golint: | vendor
 	@echo Linting Go files...
 	@golangci-lint run --build-tags "-tags testtools"
 
-build:
+build: ## Build the binary
 	@go mod download
 	@CGO_ENABLED=0 GOOS=linux go build -mod=readonly -v -o bin/${APP_NAME}
 
-clean:
+clean: ## Clean up all the things
 	@echo Cleaning...
 	@rm -f bin/${APP_NAME}
 	@rm -rf ./dist/
 	@rm -rf coverage.out
 	@go clean -testcache
 
-vendor:
+vendor: ## Vendors dependencies
 	@go mod download
 	@go mod tidy

cmd/errors.go

@@ -3,24 +3,26 @@ package cmd
 import "errors"
 
 var (
-	// ErrNATSURLRequired is returned when a NATS url is missing
-	ErrNATSURLRequired = errors.New("nats url is required and cannot be empty")
+	// ErrSubscriberURLRequired is returned when a event subscriber url is missing
+	ErrSubscriberURLRequired = errors.New("nats url is required and cannot be empty")
 
-	// ErrNATSSubjectPrefixRequired is returned when a NATS subject prefix is missing
-	ErrNATSSubjectPrefixRequired = errors.New("nats subject prefix is required and cannot be empty")
+	// ErrSubscriberPrefixRequired is returned when a NATS subject prefix is missing
+	ErrSubscriberPrefixRequired = errors.New("env LOADBALANCER_MANAGER_HAPROXY_EVENTS_SUBSCRIBER_PREFIX is required and cannot be empty")
+
+	ErrSubscriberTopicsRequired = errors.New("event-topics is required and cannot be empty")
 
 	// ErrNATSAuthRequired is returned when a NATS auth method is missing
-	ErrNATSAuthRequired = errors.New("nats creds are required and cannot be empty")
+	ErrNATSAuthRequired = errors.New("env LOADBALANCER_MANAGER_HAPROXY_EVENTS_SUBSCRIBER_NATS_CREDSFILE is required and cannot be empty")
 
 	// ErrHAProxyBaseConfigRequired is returned when the base HAProxy config is missing
-	ErrHAProxyBaseConfigRequired = errors.New("base haproxy config is required and cannot be empty")
+	ErrHAProxyBaseConfigRequired = errors.New("base-haproxy-config is required and cannot be empty")
 
 	// ErrLBAPIURLRequired is returned when the LB API url is missing
-	ErrLBAPIURLRequired = errors.New("loadbalancer api url is required and cannot be empty")
+	ErrLBAPIURLRequired = errors.New("loadbalancer-api-url is required and cannot be empty")
 
 	// ErrLBIDRequired is the loadbalancer id to watch for changes on the msg queue
-	ErrLBIDRequired = errors.New("loadbalancer gidx is required and cannot be empty")
+	ErrLBIDRequired = errors.New("loadbalancer-id is required and cannot be empty")
 
 	// ErrLBIDInvalid is returned when the loadbalancer gidx is invalid
-	ErrLBIDInvalid = errors.New("loadbalancer gidx is invalid")
+	ErrLBIDInvalid = errors.New("loadbalancer-id (gidx) is invalid")
 )

cmd/root.go

@@ -2,16 +2,22 @@
 package cmd
 
 import (
+	"fmt"
+	"os"
 	"strings"
 
 	homedir "github.com/mitchellh/go-homedir"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 	"go.uber.org/zap"
+
+	"go.infratographer.com/x/loggingx"
+	"go.infratographer.com/x/versionx"
+
+	"go.infratographer.com/loadbalancer-manager-haproxy/internal/config"
 )
 
-// TODO: update app name
 const appName = "loadbalancer-manager-haproxy"
 
 var (
@@ -37,14 +43,11 @@ func init() {
 
 	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/."+appName+".yaml)")
 
-	rootCmd.PersistentFlags().Bool("debug", false, "enable debug logging")
-	viperBindFlag("logging.debug", rootCmd.PersistentFlags().Lookup("debug"))
-
-	rootCmd.PersistentFlags().Bool("pretty", false, "enable pretty (human readable) logging output")
-	viperBindFlag("logging.pretty", rootCmd.PersistentFlags().Lookup("pretty"))
+	// Logging flags
+	loggingx.MustViperFlags(viper.GetViper(), rootCmd.PersistentFlags())
 
-	rootCmd.PersistentFlags().Bool("development", false, "enable development settings")
-	viperBindFlag("development", rootCmd.PersistentFlags().Lookup("development"))
+	// Register version command
+	versionx.RegisterCobraCommand(rootCmd, func() { versionx.PrintVersion(logger) })
 }
 
 // initConfig reads in config file and ENV variables if set.
@@ -63,12 +66,13 @@ func initConfig() {
 	}
 
 	viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_", "-", "_"))
-	// TODO: This needs to match [a-z]+, this may not be true for your app name
 	viper.SetEnvPrefix("loadbalancer-manager-haproxy")
 
 	viper.AutomaticEnv() // read in environment variables that match
 
-	setupLogging()
+	setupAppConfig()
+
+	logger = loggingx.InitLogger(appName, config.AppConfig.Logging)
 
 	// If a config file is found, read it in.
 	err := viper.ReadInConfig()
@@ -79,25 +83,15 @@ func initConfig() {
 	}
 }
 
-func setupLogging() {
-	cfg := zap.NewProductionConfig()
-	if viper.GetBool("logging.pretty") {
-		cfg = zap.NewDevelopmentConfig()
-	}
-
-	if viper.GetBool("logging.debug") {
-		cfg.Level = zap.NewAtomicLevelAt(zap.DebugLevel)
-	} else {
-		cfg.Level = zap.NewAtomicLevelAt(zap.InfoLevel)
-	}
-
-	l, err := cfg.Build()
+// setupAppConfig loads our config.AppConfig struct with the values bound by
+// viper. Then, anywhere we need these values, we can just return to AppConfig
+// instead of performing viper.GetString(...), viper.GetBool(...), etc.
+func setupAppConfig() {
+	err := viper.Unmarshal(&config.AppConfig)
 	if err != nil {
-		panic(err)
+		fmt.Printf("unable to decode app config: %s", err)
+		os.Exit(1)
 	}
-
-	logger = l.Sugar().With("app", appName)
-	defer logger.Sync() //nolint:errcheck
 }
 
 // viperBindFlag provides a wrapper around the viper bindings that handles error checks