Feat: HEALTH_SERVER_ADDRESS

internal/configuration/health.go

@@ -3,12 +3,15 @@ package configuration
 import (
 	"strings"
 
+	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/golibs/os"
 	"github.com/qdm12/golibs/params"
 )
 
 // Health contains settings for the healthcheck and health server.
 type Health struct {
-	OpenVPN HealthyWait
+	ServerAddress string
+	OpenVPN       HealthyWait
 }
 
 func (settings *Health) String() string {
@@ -18,6 +21,8 @@ func (settings *Health) String() string {
 func (settings *Health) lines() (lines []string) {
 	lines = append(lines, lastIndent+"Health:")
 
+	lines = append(lines, indent+lastIndent+"Server address: "+settings.ServerAddress)
+
 	lines = append(lines, indent+lastIndent+"OpenVPN:")
 	for _, line := range settings.OpenVPN.lines() {
 		lines = append(lines, indent+indent+line)
@@ -26,7 +31,23 @@ func (settings *Health) lines() (lines []string) {
 	return lines
 }
 
+// Read is to be used for the healthcheck query mode.
+func (settings *Health) Read(env params.Env, os os.OS, logger logging.Logger) (err error) {
+	reader := newReader(env, os, logger)
+	return settings.read(reader)
+}
+
 func (settings *Health) read(r reader) (err error) {
+	var warning string
+	settings.ServerAddress, warning, err = r.env.ListeningAddress(
+		"HEALTH_SERVER_ADDRESS", params.Default("127.0.0.1:9999"))
+	if warning != "" {
+		r.logger.Warn("health server address: " + warning)
+	}
+	if err != nil {
+		return err
+	}
+
 	settings.OpenVPN.Initial, err = r.env.Duration("HEALTH_OPENVPN_DURATION_INITIAL", params.Default("6s"))
 	if err != nil {
 		return err

internal/configuration/health_test.go

@@ -6,6 +6,7 @@ import (
 	"time"
 
 	"github.com/golang/mock/gomock"
+	"github.com/qdm12/golibs/logging/mock_logging"
 	"github.com/qdm12/golibs/params/mock_params"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -15,7 +16,7 @@ func Test_Health_String(t *testing.T) {
 	t.Parallel()
 
 	var health Health
-	const expected = "|--Health:\n   |--OpenVPN:\n      |--Initial duration: 0s"
+	const expected = "|--Health:\n   |--Server address: \n   |--OpenVPN:\n      |--Initial duration: 0s"
 
 	s := health.String()
 
@@ -32,12 +33,14 @@ func Test_Health_lines(t *testing.T) {
 		"empty": {
 			lines: []string{
 				"|--Health:",
+				"   |--Server address: ",
 				"   |--OpenVPN:",
 				"      |--Initial duration: 0s",
 			},
 		},
 		"filled settings": {
 			settings: Health{
+				ServerAddress: "address:9999",
 				OpenVPN: HealthyWait{
 					Initial:  time.Second,
 					Addition: time.Minute,
@@ -45,6 +48,7 @@ func Test_Health_lines(t *testing.T) {
 			},
 			lines: []string{
 				"|--Health:",
+				"   |--Server address: address:9999",
 				"   |--OpenVPN:",
 				"      |--Initial duration: 1s",
 				"      |--Addition duration: 1m0s",
@@ -74,19 +78,35 @@ func Test_Health_read(t *testing.T) {
 		openvpnInitialErr       error
 		openvpnAdditionDuration time.Duration
 		openvpnAdditionErr      error
+		serverAddress           string
+		serverAddressWarning    string
+		serverAddressErr        error
 		expected                Health
 		err                     error
 	}{
 		"success": {
 			openvpnInitialDuration:  time.Second,
 			openvpnAdditionDuration: time.Minute,
+			serverAddress:           "127.0.0.1:9999",
 			expected: Health{
+				ServerAddress: "127.0.0.1:9999",
 				OpenVPN: HealthyWait{
 					Initial:  time.Second,
 					Addition: time.Minute,
 				},
 			},
 		},
+		"listening address error": {
+			openvpnInitialDuration:  time.Second,
+			openvpnAdditionDuration: time.Minute,
+			serverAddress:           "127.0.0.1:9999",
+			serverAddressWarning:    "warning",
+			serverAddressErr:        errDummy,
+			expected: Health{
+				ServerAddress: "127.0.0.1:9999",
+			},
+			err: errDummy,
+		},
 		"initial error": {
 			openvpnInitialDuration:  time.Second,
 			openvpnInitialErr:       errDummy,
@@ -120,17 +140,29 @@ func Test_Health_read(t *testing.T) {
 			ctrl := gomock.NewController(t)
 
 			env := mock_params.NewMockEnv(ctrl)
-			env.EXPECT().
-				Duration("HEALTH_OPENVPN_DURATION_INITIAL", gomock.Any()).
-				Return(testCase.openvpnInitialDuration, testCase.openvpnInitialErr)
-			if testCase.openvpnInitialErr == nil {
+			logger := mock_logging.NewMockLogger(ctrl)
+
+			env.EXPECT().ListeningAddress("HEALTH_SERVER_ADDRESS", gomock.Any()).
+				Return(testCase.serverAddress, testCase.serverAddressWarning,
+					testCase.serverAddressErr)
+			if testCase.serverAddressWarning != "" {
+				logger.EXPECT().Warn("health server address: " + testCase.serverAddressWarning)
+			}
+
+			if testCase.serverAddressErr == nil {
 				env.EXPECT().
-					Duration("HEALTH_OPENVPN_DURATION_ADDITION", gomock.Any()).
-					Return(testCase.openvpnAdditionDuration, testCase.openvpnAdditionErr)
+					Duration("HEALTH_OPENVPN_DURATION_INITIAL", gomock.Any()).
+					Return(testCase.openvpnInitialDuration, testCase.openvpnInitialErr)
+				if testCase.openvpnInitialErr == nil {
+					env.EXPECT().
+						Duration("HEALTH_OPENVPN_DURATION_ADDITION", gomock.Any()).
+						Return(testCase.openvpnAdditionDuration, testCase.openvpnAdditionErr)
+				}
 			}
 
 			r := reader{
-				env: env,
+				env:    env,
+				logger: logger,
 			}
 
 			var health Health

internal/configuration/settings_test.go

@@ -38,6 +38,7 @@ func Test_Settings_lines(t *testing.T) {
 				"   |--Process group ID: 0",
 				"   |--Timezone: NOT SET ⚠️ - it can cause time related issues",
 				"|--Health:",
+				"   |--Server address: ",
 				"   |--OpenVPN:",
 				"      |--Initial duration: 0s",
 				"|--HTTP control server:",