refactor(tests): use a separate database webhookx_test for test

Author: vm-001

Dockerfile

@@ -14,6 +14,8 @@ FROM alpine:3.15
 COPY --from=build-env /go/src/webhookx-io/webhookx/webhookx /usr/local/bin
 
 EXPOSE 9600
+EXPOSE 9601
+EXPOSE 9602
 
 
 CMD ["webhookx", "start"]

app/app.go

@@ -218,10 +218,11 @@ func (app *Application) initialize() error {
 			Dispatcher: dispatcher,
 			EventBus:   app.bus,
 		}
-		if cfg.AccessLog.Enabled() {
+		if cfg.AccessLog.Enabled {
 			accessLogger, err := accesslog.NewAccessLogger("admin", accesslog.Options{
-				File:   cfg.AccessLog.File,
-				Format: string(cfg.AccessLog.Format),
+				File:    cfg.AccessLog.File,
+				Format:  string(cfg.AccessLog.Format),
+				Colored: cfg.AccessLog.Colored,
 			})
 			if err != nil {
 				return err
@@ -247,10 +248,11 @@ func (app *Application) initialize() error {
 			Srv:         app.srv,
 			RateLimiter: ratelimiter.NewRedisLimiter(client),
 		}
-		if cfg.AccessLog.Enabled() {
+		if cfg.AccessLog.Enabled {
 			accessLogger, err := accesslog.NewAccessLogger("proxy", accesslog.Options{
-				File:   cfg.AccessLog.File,
-				Format: string(cfg.AccessLog.Format),
+				File:    cfg.AccessLog.File,
+				Format:  string(cfg.AccessLog.Format),
+				Colored: cfg.AccessLog.Colored,
 			})
 			if err != nil {
 				return err
@@ -268,10 +270,11 @@ func (app *Application) initialize() error {
 
 	if cfg.Status.IsEnabled() {
 		var accessLogger accesslog.AccessLogger
-		if cfg.AccessLog.Enabled() {
+		if cfg.AccessLog.Enabled {
 			accessLogger, err = accesslog.NewAccessLogger("status", accesslog.Options{
-				File:   cfg.AccessLog.File,
-				Format: string(cfg.AccessLog.Format),
+				File:    cfg.AccessLog.File,
+				Format:  string(cfg.AccessLog.Format),
+				Colored: cfg.AccessLog.Colored,
 			})
 			if err != nil {
 				return err

cmd/admin_dump.go

@@ -70,7 +70,7 @@ func newAdminDumpCmd() *cobra.Command {
 	}
 
 	dump.Flags().StringVarP(&workspace, "workspace", "", "default", "Set a specific workspace.")
-	dump.Flags().StringVarP(&addr, "addr", "", defaultAdminURL, "HTTP address of WebhookX's Admin API.")
+	dump.Flags().StringVarP(&addr, "addr", "", AdminURL, "HTTP address of WebhookX's Admin API.")
 	dump.Flags().IntVarP(&timeout, "timeout", "", 10, "Set the request timeout for the client to connect with WebhookX (in seconds).")
 
 	return dump

cmd/admin_sync.go

@@ -80,7 +80,7 @@ func newAdminSyncCmd() *cobra.Command {
 	}
 
 	sync.Flags().StringVarP(&workspace, "workspace", "", "default", "Set a specific workspace.")
-	sync.Flags().StringVarP(&addr, "addr", "", defaultAdminURL, "HTTP address of WebhookX's Admin API.")
+	sync.Flags().StringVarP(&addr, "addr", "", AdminURL, "HTTP address of WebhookX's Admin API.")
 	sync.Flags().IntVarP(&timeout, "timeout", "", 10, "Set the request timeout for the client to connect with WebhookX (in seconds).")
 
 	return sync

cmd/root.go

@@ -6,8 +6,8 @@ import (
 	"os"
 )
 
-const (
-	defaultAdminURL = "http://localhost:9601"
+var (
+	AdminURL = "http://localhost:9601"
 )
 
 var (
@@ -18,11 +18,15 @@ var (
 
 func initConfig() {
 	var err error
+
+	var options config.Options
 	if configurationFile != "" {
-		cfg, err = config.InitWithFile(configurationFile)
-	} else {
-		cfg, err = config.Init()
+		buf, err := os.ReadFile(configurationFile)
+		cobra.CheckErr(err)
+		options.YAML = buf
 	}
+
+	cfg, err = config.New(&options)
 	cobra.CheckErr(err)
 
 	err = cfg.Validate()

config.yml

@@ -1,14 +1,18 @@
 # ------------------------------------
-# WebhookX Configuration YAML file
+# WebhookX Configuration YAML File
 # ------------------------------------
+
 log:
-  file: /dev/stdout     # Specifies the log file.
   level: info           # Supported values: debug, info, warn, and error.
   format: text          # Supported values: text, json.
+  colored: true         # Enables colorized logs when using text format.
+  file: ''              # By default, logs are written to stdout.
 
-access_log:             # Access Log
-  file: /dev/stdout     # Specifies the log file.
+access_log:
+  enabled: true         # Enables access log.
   format: text          # Supported values: text, json.
+  colored: true         # Enables colorized logs when using text format.
+  file: ''              # By default, logs are written to stdout.
 
 database:
   host: localhost
@@ -20,24 +24,28 @@ database:
                                   # Connection uri parameters.
                                   # See https://www.postgresql.org/docs/current/libpq-connect.html for more information.
   max_pool_size: 40               # Specifies the maximum number of connections.
-  max_lifetime: 1800              # Specifies the maximum lifetime (in seconds) for a connection.
+  max_lifetime: 1800              # Specifies the maximum lifetime (in seconds) of a connection.
 
 redis:
   host: localhost
   port: 6379
   password:
   database: 0
+  max_pool_size: 0                # Specifies the maximum number of connections.
+                                  # Default is 10 connections per available CPU.
+
 
 #------------------------------------------------------------------------------
-# PROXY
+# Proxy
+# The Proxy ingests events.
 #------------------------------------------------------------------------------
 proxy:
   listen: 0.0.0.0:9600
-  tls:                              # TLS configuration
-    cert: ''                        # The path to TLS certificate. Example: /path/to/server.cert
-    key: ''                         # The path to TLS certificate key. Example: /path/to/server.key
-  timeout_read: 10                  # Specifies the maximum time (in seconds) for reading request. 0 disables timeout.
-  timeout_write: 10                 # Specifies the maximum time (in seconds) for writing response. 0 disables timeout.
+  #tls:                             # TLS configuration
+  #  cert: /path/to/server.crt      # The path to TLS certificate.
+  #  key: /path/to/server.key       # The path to TLS certificate key.
+  timeout_read: 10                  # Specifies the maximum time (in seconds) for reading the request. 0 disables timeout.
+  timeout_write: 10                 # Specifies the maximum time (in seconds) for writing the response. 0 disables timeout.
   max_request_body_size: 1048576    # Specifies the maximum request body size. Default is 1048576.
   response:                         # Default HTTP response
     code: 200
@@ -50,17 +58,20 @@ proxy:
       port: 6379
       password:
       database: 0
+    max_pool_size: 0                # Specifies the maximum number of connections.
+                                    # Default value is 10 connections per every available CPU.
+
 
 #------------------------------------------------------------------------------
 # Admin API
 # The Admin API provides RESTful APIs for managing entities.
 #------------------------------------------------------------------------------
 admin:
   listen: 127.0.0.1:9601
-  debug_endpoints: false             # Whether to expose debugging and profiling endpoints.
+  debug_endpoints: false             # Whether to expose debugging and profiling endpoints (via pprof).
                                      # See https://pkg.go.dev/net/http/pprof for more information.
   #tls:                              # TLS configuration
-  #  cert: /path/to/server.crt       # The Path to TLS certificate.
+  #  cert: /path/to/server.crt       # The path to TLS certificate.
   #  key: /path/to/server.key        # The path to TLS certificate key.
 
 #------------------------------------------------------------------------------
@@ -69,7 +80,7 @@ admin:
 #------------------------------------------------------------------------------
 status:
   listen: 127.0.0.1:9602
-  debug_endpoints: true              # Whether to expose debugging and profiling endpoints.
+  debug_endpoints: true              # Whether to expose debugging and profiling endpoints (via pprof).
                                      # See https://pkg.go.dev/net/http/pprof for more information.
 
 #------------------------------------------------------------------------------
@@ -79,7 +90,7 @@ status:
 worker:
   enabled: true                     # Whether to enable the Worker.
   deliverer:
-    timeout: 60000                  # Sets the request timeout (in milliseconds) for delivery requests.
+    timeout: 60000                  # Specifies the request timeout (in milliseconds) for delivery requests.
     acl:                            # Access Control List (ACL) defines rules to control outbound network access.
                                     # A rule is a string of IPv4, IPv6, CIDR, hostname, or pre-configured group.
                                     # A hostname can contain a wildcard prefix (*.) represents its subdomains, and Unicode
@@ -105,12 +116,14 @@ worker:
                                     # Example of HTTPS: https://<host>:<port>
     #proxy_tls_cert:                # Path to the client certificate file used for mTLS proxy authentication.
     #proxy_tls_key:                 # Path to the client private key file used for mTLS proxy authentication.
-    #proxy_tls_ca_cert:             # Path to the CA certificate file used to verify the HTTPS proxy’s certificate.
+    #proxy_tls_ca_cert:             # Path to the CA certificate file used to verify the HTTPS proxy's certificate.
     #proxy_tls_verify: true         # Whether to verify the proxy server's TLS certificate.
 
-  pool:
-    size: 10000                     # pool size, default to 10000.
-    concurrency: 0                  # pool concurrency, default to 100 * CPUs
+  pool:                             # Pool defines an in-memory (goroutine) pool used for event delivery.
+    size: 10000                     # Specifies the size of pool.
+                                    # Defaults to 10000.
+    concurrency: 0                  # Specifies the maximum number of concurrent deliveries.
+                                    # Default value is 100 per every available CPU.
 
 #------------------------------------------------------------------------------
 # Cluster
@@ -119,37 +132,51 @@ worker:
                                     # This allows some nodes in the cluster to run as the control plane
                                     # and others to run as the data plane.
                                     #
-                                    # supported values are:
+                                    # Supported values:
                                     #
                                     # - `standalone`: disable cluster mode.
                                     # - `cp`: this node runs as the control plane.
                                     #   It connects to the database to provide entity management.
                                     # - `dp_proxy`: this node runs as the Proxy data plane.
                                     # - `dp_worker`: this node runs as the Worker data plane.
 
-anonymous_reports: true             # sends anonymous data such as software version to WebhookX.
+anonymous_reports: true             # Sends anonymous data to help improve WebhookX.
 
 
 #------------------------------------------------------------------------------
-# METRICS
+# Metrics
 #------------------------------------------------------------------------------
 metrics:
-  attributes:                                   # global attributes for each metric
-    env: prod
-  #exports: [ opentelemetry ]                   # list of enabled vendor exports. supported value are opentelemetry
-  push_interval: 10                             # interval(in seconds) at which metrics are sent to the OpenTelemetry Collector
+  #attributes:                                  # Specifies the custom attributes in key-value pair for each metric.
+  #  foo: bar
+  #exports:                                     # The list of enabled vendor exports. Supported value: opentelemetry.
+  #  - opentelemetry
+  push_interval: 10                             # Specifies the interval (in seconds) at which metrics are sent to the OpenTelemetry Collector
   opentelemetry:
     protocol: http/protobuf                     # Supported values: http/protobuf, grpc.
-    endpoint: http://localhost:4318/v1/metrics  # http/protobuf(http://localhost:4318/v1/metrics), grpc(localhost:4317)
+    endpoint: http://localhost:4318/v1/metrics  #
+                                                # Example of http/protobuf:
+                                                #   protocol: http/protobuf
+                                                #   endpoint: http://localhost:4318/v1/metrics
+                                                # Example of grpc:
+                                                #   protocol: grpc
+                                                #   endpoint: localhost:4317
 
 #------------------------------------------------------------------------------
-# TRACING
+# Tracing
 #------------------------------------------------------------------------------
 tracing:
   enabled: false
-  attributes:                                   # global attributes for each trace
-    env: prod
-  sampling_rate: 1.0
+  #attributes:                                  # Specifies the custom attributes in key-value pair for each trace.
+  #  foo: bar
+  sampling_rate: 1                              # Specifies the trace sampling rate.
+                                                # Example: `0.01`, samples 1% of traces.
   opentelemetry:
-    protocol: http/protobuf                     # Supported value: http/protobuf, grpc.
-    endpoint: http://localhost:4318/v1/traces   # http/protobuf(http://localhost:4318/v1/traces), grpc(localhost:4317)
+    protocol: http/protobuf                     # Supported values: http/protobuf, grpc.
+    endpoint: http://localhost:4318/v1/traces   #
+                                                # Example of http/protobuf:
+                                                #   protocol: http/protobuf
+                                                #   endpoint: http://localhost:4318/v1/traces
+                                                # Example of grpc:
+                                                #   protocol: grpc
+                                                #   endpoint: localhost:4317

config/access_log.go

@@ -6,8 +6,10 @@ import (
 )
 
 type AccessLogConfig struct {
-	File   string    `yaml:"file" json:"file" default:"/dev/stdout"`
-	Format LogFormat `yaml:"format" json:"format" default:"text"`
+	Enabled bool      `yaml:"enabled" json:"enabled" default:"true"`
+	Format  LogFormat `yaml:"format" json:"format" default:"text"`
+	Colored bool      `yaml:"colored" json:"colored" default:"true"`
+	File    string    `yaml:"file" json:"file"`
 }
 
 func (cfg AccessLogConfig) Validate() error {
@@ -16,7 +18,3 @@ func (cfg AccessLogConfig) Validate() error {
 	}
 	return nil
 }
-
-func (cfg AccessLogConfig) Enabled() bool {
-	return cfg.File != ""
-}

config/config.go

@@ -6,8 +6,6 @@ import (
 	"github.com/creasty/defaults"
 	"github.com/webhookx-io/webhookx/pkg/envconfig"
 	"gopkg.in/yaml.v3"
-	"io"
-	"os"
 	"slices"
 )
 
@@ -86,35 +84,23 @@ func (cfg Config) Validate() error {
 	return nil
 }
 
-func Init() (*Config, error) {
-	var cfg Config
-	if err := defaults.Set(&cfg); err != nil {
-		return nil, err
-	}
-
-	err := envconfig.Process("WEBHOOKX", &cfg)
-	if err != nil {
-		return nil, err
-	}
-
-	return &cfg, nil
+type Options struct {
+	YAML []byte
 }
 
-func InitWithFile(filename string) (*Config, error) {
+func New(opts *Options) (*Config, error) {
 	var cfg Config
-	if err := defaults.Set(&cfg); err != nil {
-		return nil, err
-	}
-
-	f, err := os.Open(filename)
+	err := defaults.Set(&cfg)
 	if err != nil {
 		return nil, err
 	}
-	defer f.Close()
-	decoder := yaml.NewDecoder(f)
-	err = decoder.Decode(&cfg)
-	if err != nil && err != io.EOF {
-		return nil, err
+
+	if opts != nil {
+		if len(opts.YAML) > 0 {
+			if err := yaml.Unmarshal(opts.YAML, &cfg); err != nil {
+				return nil, err
+			}
+		}
 	}
 
 	err = envconfig.Process("WEBHOOKX", &cfg)