Merge pull request #128 from deploymenttheory/dev

Added test coverage for refactored http client

Author: ShocOne

.github/workflows/test.yml

@@ -23,12 +23,4 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Run tests
-        run: go test -v -count=1 -race -shuffle=on -coverprofile=coverage.txt ./...
-
-      - name: Upload Coverage
-        uses: codecov/codecov-action@v4
-        continue-on-error: true
-        with:
-          token: ${{secrets.CODECOV_TOKEN}}
-          file: ./coverage.txt
-          fail_ci_if_error: false
+        run: go test -v -count=1 -race -shuffle=on -coverprofile=coverage.txt ./...

httpclient/httpclient_auth_method.go renamed to httpclient/auth_method.go

@@ -0,0 +1,72 @@
+package httpclient
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestDetermineAuthMethod(t *testing.T) {
+	tests := []struct {
+		name         string
+		authConfig   AuthConfig
+		expectedAuth string
+		expectError  bool
+	}{
+		{
+			name: "Valid OAuth credentials",
+			authConfig: AuthConfig{
+				ClientID:     "123e4567-e89b-12d3-a456-426614174000", // Valid UUID format
+				ClientSecret: "validSecretWith16Chars",               // Ensure it's at least 16 characters
+			},
+			expectedAuth: "oauth",
+			expectError:  false,
+		},
+		{
+			name: "Valid Bearer credentials",
+			authConfig: AuthConfig{
+				Username: "validUsername",
+				Password: "validPassword",
+			},
+			expectedAuth: "bearer",
+			expectError:  false,
+		},
+		{
+			name: "Invalid OAuth credentials",
+			authConfig: AuthConfig{
+				ClientID:     "invalidClientID",
+				ClientSecret: "invalidClientSecret",
+			},
+			expectedAuth: "unknown",
+			expectError:  true,
+		},
+		{
+			name: "Invalid Bearer credentials",
+			authConfig: AuthConfig{
+				Username: "invalidUser",
+				Password: "short",
+			},
+			expectedAuth: "unknown",
+			expectError:  true,
+		},
+		{
+			name:         "Missing credentials",
+			authConfig:   AuthConfig{},
+			expectedAuth: "unknown",
+			expectError:  true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			authMethod, err := DetermineAuthMethod(tt.authConfig)
+
+			if tt.expectError {
+				assert.Error(t, err)
+			} else {
+				assert.NoError(t, err)
+			}
+			assert.Equal(t, tt.expectedAuth, authMethod)
+		})
+	}
+}

httpclient/auth_method_test.go

@@ -1,4 +1,4 @@
-// http_client.go
+// httpclient/client.go
 /* The `http_client` package provides a configurable HTTP client tailored for interacting with specific APIs.
 It supports different authentication methods, including "bearer" and "oauth". The client is designed with a
 focus on concurrency management, structured error handling, and flexible configuration options.

httpclient/httpclient_client.go renamed to httpclient/client.go

@@ -1,3 +1,5 @@
+// httpclient/client_configuration.go
+// Description: This file contains functions to load and validate configuration values from a JSON file or environment variables.
 package httpclient
 
 import (

httpclient/httpclient_client_configuration.go renamed to httpclient/client_configuration.go

@@ -0,0 +1,97 @@
+package httpclient
+
+import (
+	"os"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestLoadConfigFromFile(t *testing.T) {
+	// Create a temporary file
+	tmpFile, err := os.CreateTemp("", "config-*.json")
+	assert.NoError(t, err)
+	defer os.Remove(tmpFile.Name()) // Clean up the file after test
+
+	// Write updated JSON configuration to the temp file
+	configJSON := `{
+		"Auth": {
+			"ClientID": "787xxxxd-98bb-xxxx-8d17-xxx0f8cbfb7b",
+			"ClientSecret": "xxxxxxxxxxxxx"
+		},
+		"Environment": {
+			"InstanceName": "lbgsandbox",
+			"OverrideBaseDomain": "",
+			"APIType": "jamfpro"
+		},
+		"ClientOptions": {
+			"LogLevel": "LogLevelDebug",
+			"LogOutputFormat": "console",
+			"LogConsoleSeparator": "  ",
+			"HideSensitiveData": true,
+			"EnableDynamicRateLimiting": true,
+			"MaxRetryAttempts": 5,
+			"MaxConcurrentRequests": 3,
+			"EnableCookieJar": true,
+			"FollowRedirects": true,
+			"MaxRedirects": 5
+		}
+	}`
+	_, err = tmpFile.WriteString(configJSON)
+	assert.NoError(t, err)
+	assert.NoError(t, tmpFile.Close())
+
+	// Test loading from the temp file
+	config, err := LoadConfigFromFile(tmpFile.Name())
+	assert.NoError(t, err)
+	assert.Equal(t, "787xxxxd-98bb-xxxx-8d17-xxx0f8cbfb7b", config.Auth.ClientID)
+	assert.Equal(t, "xxxxxxxxxxxxx", config.Auth.ClientSecret)
+	assert.Equal(t, "lbgsandbox", config.Environment.InstanceName)
+	assert.Equal(t, "jamfpro", config.Environment.APIType)
+	assert.Equal(t, "LogLevelDebug", config.ClientOptions.LogLevel)
+	assert.Equal(t, "console", config.ClientOptions.LogOutputFormat)
+	assert.Equal(t, "  ", config.ClientOptions.LogConsoleSeparator)
+	assert.True(t, config.ClientOptions.HideSensitiveData)
+	assert.True(t, config.ClientOptions.EnableDynamicRateLimiting)
+	assert.Equal(t, 5, config.ClientOptions.MaxRetryAttempts)
+	assert.Equal(t, 3, config.ClientOptions.MaxConcurrentRequests)
+	assert.True(t, config.ClientOptions.EnableCookieJar)
+	assert.True(t, config.ClientOptions.FollowRedirects)
+	assert.Equal(t, 5, config.ClientOptions.MaxRedirects)
+}
+
+func TestGetEnvOrDefault(t *testing.T) {
+	const envKey = "TEST_ENV_VAR"
+	defer os.Unsetenv(envKey)
+
+	// Scenario 1: Environment variable is set
+	expectedValue := "test_value"
+	os.Setenv(envKey, expectedValue)
+	assert.Equal(t, expectedValue, getEnvOrDefault(envKey, "default_value"))
+
+	// Scenario 2: Environment variable is not set
+	assert.Equal(t, "default_value", getEnvOrDefault("NON_EXISTENT_ENV_VAR", "default_value"))
+}
+
+func TestParseBool(t *testing.T) {
+	assert.True(t, parseBool("true"))
+	assert.False(t, parseBool("false"))
+	assert.False(t, parseBool("invalid_value"))
+}
+
+func TestParseInt(t *testing.T) {
+	assert.Equal(t, 42, parseInt("42", 10))
+	assert.Equal(t, 10, parseInt("invalid_value", 10))
+}
+
+func TestParseDuration(t *testing.T) {
+	assert.Equal(t, 5*time.Minute, parseDuration("5m", 1*time.Minute))
+	assert.Equal(t, 1*time.Minute, parseDuration("invalid_value", 1*time.Minute))
+}
+
+func TestSetLoggerDefaultValues(t *testing.T) {
+	config := &ClientConfig{ClientOptions: ClientOptions{}}
+	setLoggerDefaultValues(config)
+	assert.Equal(t, ",", config.ClientOptions.LogConsoleSeparator)
+}