Clean up configurations to utilize composition instead

cmd/executionspace/main.go

@@ -23,7 +23,7 @@ import (
 	"runtime/debug"
 	"syscall"
 
-	config "github.com/eiffel-community/etos-api/internal/configs/executionspace"
+	"github.com/eiffel-community/etos-api/internal/config"
 	"github.com/eiffel-community/etos-api/internal/database/etcd"
 	"github.com/eiffel-community/etos-api/internal/executionspace/provider"
 	"github.com/eiffel-community/etos-api/internal/logging"
@@ -39,7 +39,7 @@ import (
 
 // main sets up logging and starts up the webservice.
 func main() {
-	cfg := config.Get()
+	cfg := config.NewExecutionSpaceConfig()
 	ctx := context.Background()
 
 	var hooks []logrus.Hook
@@ -120,7 +120,7 @@ func fileLogging(cfg config.Config) logrus.Hook {
 
 // remoteLogging starts a new rabbitmq publisher if the rabbitmq parameters are set
 // Warning: Must call publisher.Close() on the publisher returned from this function
-func remoteLogging(cfg config.Config) *rabbitmq.Publisher {
+func remoteLogging(cfg config.ExecutionSpaceConfig) *rabbitmq.Publisher {
 	if cfg.RabbitMQHookURL() != "" {
 		if cfg.RabbitMQHookExchangeName() == "" {
 			panic("-rabbitmq_hook_exchange (env:ETOS_RABBITMQ_EXCHANGE) must be set when using -rabbitmq_hook_url (env:ETOS_RABBITMQ_URL)")

cmd/iut/main.go

@@ -24,7 +24,7 @@ import (
 	"syscall"
 	"time"
 
-	config "github.com/eiffel-community/etos-api/internal/configs/iut"
+	"github.com/eiffel-community/etos-api/internal/config"
 	"github.com/eiffel-community/etos-api/internal/logging"
 	server "github.com/eiffel-community/etos-api/internal/server"
 	"github.com/eiffel-community/etos-api/pkg/application"
@@ -37,7 +37,7 @@ import (
 
 // main sets up logging and starts up the webserver.
 func main() {
-	cfg := config.Get()
+	cfg := config.NewIUTConfig()
 	ctx := context.Background()
 
 	var hooks []logrus.Hook

cmd/logarea/main.go

@@ -24,7 +24,7 @@ import (
 	"syscall"
 	"time"
 
-	config "github.com/eiffel-community/etos-api/internal/configs/logarea"
+	"github.com/eiffel-community/etos-api/internal/config"
 	"github.com/eiffel-community/etos-api/internal/logging"
 	"github.com/eiffel-community/etos-api/internal/server"
 	"github.com/eiffel-community/etos-api/pkg/application"
@@ -36,7 +36,7 @@ import (
 
 // main sets up logging and starts up the logarea webservice.
 func main() {
-	cfg := config.Get()
+	cfg := config.NewLogAreaConfig()
 	ctx := context.Background()
 
 	var hooks []logrus.Hook

cmd/sse/main.go

@@ -24,7 +24,7 @@ import (
 	"syscall"
 	"time"
 
-	config "github.com/eiffel-community/etos-api/internal/configs/sse"
+	"github.com/eiffel-community/etos-api/internal/config"
 	"github.com/eiffel-community/etos-api/internal/logging"
 	"github.com/eiffel-community/etos-api/internal/server"
 	"github.com/eiffel-community/etos-api/pkg/application"
@@ -37,7 +37,7 @@ import (
 
 // main sets up logging and starts up the sse webserver.
 func main() {
-	cfg := config.Get()
+	cfg := config.NewSSEConfig()
 	ctx := context.Background()
 
 	var hooks []logrus.Hook

internal/configs/base/config.go → internal/config/base.go

@@ -32,8 +32,8 @@ type Config interface {
 	DatabaseURI() string
 }
 
-// cfg implements the Config interface.
-type cfg struct {
+// baseCfg implements the Config interface.
+type baseCfg struct {
 	serviceHost   string
 	servicePort   string
 	stripPrefix   string
@@ -44,9 +44,9 @@ type cfg struct {
 	databasePort  string
 }
 
-// Get creates a config interface based on input parameters or environment variables.
-func Get() Config {
-	var conf cfg
+// load the command line vars for a base configuration.
+func load() Config {
+	var conf baseCfg
 
 	flag.StringVar(&conf.serviceHost, "address", EnvOrDefault("SERVICE_HOST", "127.0.0.1"), "Address to serve API on")
 	flag.StringVar(&conf.servicePort, "port", EnvOrDefault("SERVICE_PORT", "8080"), "Port to serve API on")
@@ -56,43 +56,41 @@ func Get() Config {
 	flag.StringVar(&conf.etosNamespace, "etosnamespace", ReadNamespaceOrEnv("ETOS_NAMESPACE"), "Path, including filename, for the log files to create.")
 	flag.StringVar(&conf.databaseHost, "databasehost", EnvOrDefault("ETOS_ETCD_HOST", "etcd-client"), "Host to the database.")
 	flag.StringVar(&conf.databasePort, "databaseport", EnvOrDefault("ETOS_ETCD_PORT", "2379"), "Port to the database.")
-
-	flag.Parse()
 	return &conf
 }
 
 // ServiceHost returns the host of the service.
-func (c *cfg) ServiceHost() string {
+func (c *baseCfg) ServiceHost() string {
 	return c.serviceHost
 }
 
 // ServicePort returns the port of the service.
-func (c *cfg) ServicePort() string {
+func (c *baseCfg) ServicePort() string {
 	return c.servicePort
 }
 
 // StripPrefix returns the prefix to strip. Empty string if no prefix.
-func (c *cfg) StripPrefix() string {
+func (c *baseCfg) StripPrefix() string {
 	return c.stripPrefix
 }
 
 // LogLevel returns the log level.
-func (c *cfg) LogLevel() string {
+func (c *baseCfg) LogLevel() string {
 	return c.logLevel
 }
 
 // LogFilePath returns the path to where log files should be stored, including filename.
-func (c *cfg) LogFilePath() string {
+func (c *baseCfg) LogFilePath() string {
 	return c.logFilePath
 }
 
 // ETOSNamespace returns the ETOS namespace.
-func (c *cfg) ETOSNamespace() string {
+func (c *baseCfg) ETOSNamespace() string {
 	return c.etosNamespace
 }
 
 // DatabaseURI returns the URI to the ETOS database.
-func (c *cfg) DatabaseURI() string {
+func (c *baseCfg) DatabaseURI() string {
 	return fmt.Sprintf("%s:%s", c.databaseHost, c.databasePort)
 }
 

internal/configs/sse/config_test.go → internal/config/base_test.go

@@ -16,7 +16,6 @@
 package config
 
 import (
-	"os"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -29,12 +28,12 @@ func TestGet(t *testing.T) {
 	logLevel := "DEBUG"
 	logFilePath := "path/to/a/file"
 
-	os.Setenv("SERVICE_HOST", serverHost)
-	os.Setenv("SERVICE_PORT", port)
-	os.Setenv("LOGLEVEL", logLevel)
-	os.Setenv("LOG_FILE_PATH", logFilePath)
+	t.Setenv("SERVICE_HOST", serverHost)
+	t.Setenv("SERVICE_PORT", port)
+	t.Setenv("LOGLEVEL", logLevel)
+	t.Setenv("LOG_FILE_PATH", logFilePath)
 
-	conf, ok := Get().(*cfg)
+	conf, ok := load().(*baseCfg)
 	assert.Truef(t, ok, "cfg returned from get is not a config interface")
 	assert.Equal(t, port, conf.servicePort)
 	assert.Equal(t, serverHost, conf.serviceHost)
@@ -46,15 +45,15 @@ type getter func() string
 
 // Test that the getters in the Cfg struct return the values from the struct.
 func TestGetters(t *testing.T) {
-	conf := &cfg{
+	conf := &baseCfg{
 		serviceHost: "127.0.0.1",
 		servicePort: "8080",
 		logLevel:    "TRACE",
 		logFilePath: "a/file/path.json",
 	}
 	tests := []struct {
 		name     string
-		cfg      *cfg
+		cfg      *baseCfg
 		function getter
 		value    string
 	}{

internal/config/executionspace.go

@@ -0,0 +1,103 @@
+// Copyright Axis Communications AB.
+//
+// For a full list of individual contributors, please see the commit history.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package config
+
+import (
+	"flag"
+	"os"
+	"time"
+
+	"github.com/sirupsen/logrus"
+)
+
+type ExecutionSpaceConfig interface {
+	Config
+	Hostname() string
+	Timeout() time.Duration
+	ExecutionSpaceWaitTimeout() time.Duration
+	RabbitMQHookURL() string
+	RabbitMQHookExchangeName() string
+	EiffelGoerURL() string
+}
+
+// executionSpaceCfg implements the ExecutionSpaceConfig interface.
+type executionSpaceCfg struct {
+	Config
+	stripPrefix               string
+	hostname                  string
+	timeout                   time.Duration
+	executionSpaceWaitTimeout time.Duration
+	rabbitmqHookURL           string
+	rabbitmqHookExchange      string
+	eiffelGoerURL             string
+}
+
+// NewExecutionSpaceConfig creates an executio nspace config interface based on input parameters or environment variables.
+func NewExecutionSpaceConfig() ExecutionSpaceConfig {
+	var conf executionSpaceCfg
+
+	defaultTimeout, err := time.ParseDuration(EnvOrDefault("REQUEST_TIMEOUT", "1m"))
+	if err != nil {
+		logrus.Panic(err)
+	}
+
+	executionSpaceWaitTimeout, err := time.ParseDuration(EnvOrDefault("EXECUTION_SPACE_WAIT_TIMEOUT", "1h"))
+	if err != nil {
+		logrus.Panic(err)
+	}
+
+	flag.StringVar(&conf.hostname, "hostname", EnvOrDefault("PROVIDER_HOSTNAME", "http://localhost"), "Host to supply to ESR for starting executors")
+	flag.DurationVar(&conf.timeout, "timeout", defaultTimeout, "Maximum timeout for requests to Execution space provider Service.")
+	flag.DurationVar(&conf.executionSpaceWaitTimeout, "executionSpaceWaitTimeout", executionSpaceWaitTimeout, "Timeout duration to wait when trying to checkout execution space(s)")
+	flag.StringVar(&conf.rabbitmqHookURL, "rabbitmq_hook_url", os.Getenv("ETOS_RABBITMQ_URL"), "URL to the ETOS rabbitmq for logs")
+	flag.StringVar(&conf.rabbitmqHookExchange, "rabbitmq_hook_exchange", os.Getenv("ETOS_RABBITMQ_EXCHANGE"), "Exchange to use for the ETOS rabbitmq for logs")
+	flag.StringVar(&conf.eiffelGoerURL, "event_repository_host", os.Getenv("EIFFEL_GOER_URL"), "Event repository URL used for Eiffel event lookup")
+	base := load()
+	flag.Parse()
+	conf.Config = base
+
+	return &conf
+}
+
+// Hostname returns the hostname to use for executors.
+func (c *executionSpaceCfg) Hostname() string {
+	return c.hostname
+}
+
+// Timeout returns the request timeout for Execution space provider Service API.
+func (c *executionSpaceCfg) Timeout() time.Duration {
+	return c.timeout
+}
+
+// ExecutionSpaceWaitTimeout returns the timeout for checking out execution spaces.
+func (c *executionSpaceCfg) ExecutionSpaceWaitTimeout() time.Duration {
+	return c.executionSpaceWaitTimeout
+}
+
+// RabbitMQHookURL returns the rabbitmq url for ETOS logs
+func (c *executionSpaceCfg) RabbitMQHookURL() string {
+	return c.rabbitmqHookURL
+}
+
+// EventRepositoryURL returns the Eiffel event repository used for event lookups
+func (c *executionSpaceCfg) EiffelGoerURL() string {
+	return c.eiffelGoerURL
+}
+
+// RabbitMQHookExchangeName returns the rabbitmq exchange name used for ETOS logs
+func (c *executionSpaceCfg) RabbitMQHookExchangeName() string {
+	return c.rabbitmqHookExchange
+}

internal/config/iut.go

@@ -0,0 +1,29 @@
+// Copyright Axis Communications AB.
+//
+// For a full list of individual contributors, please see the commit history.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package config
+
+import "flag"
+
+type IUTConfig interface {
+	Config
+}
+
+// NewIUTConfig creates an iut config interface based on input parameters or environment variables.
+func NewIUTConfig() IUTConfig {
+	cfg := load()
+	flag.Parse()
+	return cfg
+}

internal/config/logarea.go

@@ -0,0 +1,29 @@
+// Copyright Axis Communications AB.
+//
+// For a full list of individual contributors, please see the commit history.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package config
+
+import "flag"
+
+type LogAreaConfig interface {
+	Config
+}
+
+// NewLogAreaConfig creates a log area config interface based on input parameters or environment variables.
+func NewLogAreaConfig() LogAreaConfig {
+	cfg := load()
+	flag.Parse()
+	return cfg
+}

internal/config/sse.go

@@ -0,0 +1,29 @@
+// Copyright Axis Communications AB.
+//
+// For a full list of individual contributors, please see the commit history.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package config
+
+import "flag"
+
+type SSEConfig interface {
+	Config
+}
+
+// NewSSEConfig creates a sse config interface based on input parameters or environment variables.
+func NewSSEConfig() SSEConfig {
+	cfg := load()
+	flag.Parse()
+	return cfg
+}