Merge pull request #115 from deploymenttheory/dev

ShocOne · web-flow · commit 429b9ad315d6 · 2024-04-01T01:20:29.000+01:00
Added redirect handler
diff --git a/apihandlers/msgraph/msgraph_api_error_messages.go b/apihandlers/msgraph/msgraph_api_error_messages.go
@@ -1,5 +1,5 @@
-// graph_api_error_messages.go
-package graph
+// msgraph_api_error_messages.go
+package msgraph
 
 import (
 	"bytes"
diff --git a/apihandlers/msgraph/msgraph_api_exceptions.go b/apihandlers/msgraph/msgraph_api_exceptions.go
@@ -1,5 +1,5 @@
-// graph_api_exceptions.go
-package graph
+// msgraph_api_exceptions.go
+package msgraph
 
 import (
 	_ "embed"
@@ -25,7 +25,7 @@ var configMap ConfigMap
 
 // Embedded Resources
 //
-//go:embed graph_api_exceptions_configuration.json
+//go:embed msgraph_api_exceptions_configuration.json
 var graph_api_exceptions_configuration []byte
 
 // init is invoked automatically on package initialization and is responsible for
diff --git a/apihandlers/msgraph/msgraph_api_exceptions_configuration.json b/apihandlers/msgraph/msgraph_api_exceptions_configuration.json
diff --git a/apihandlers/msgraph/msgraph_api_handler.go b/apihandlers/msgraph/msgraph_api_handler.go
@@ -1,5 +1,5 @@
-// graph_api_handler.go
-package graph
+// msgraph_api_handler.go
+package msgraph
 
 import "github.com/deploymenttheory/go-api-http-client/logger"
 
diff --git a/apihandlers/msgraph/msgraph_api_handler_constants.go b/apihandlers/msgraph/msgraph_api_handler_constants.go
@@ -1,5 +1,5 @@
-// graph_api_handler_constants.go
-package graph
+// msgraph_api_handler_constants.go
+package msgraph
 
 // Endpoint constants represent the URL suffixes used for graph API token interactions.
 const (
diff --git a/apihandlers/msgraph/msgraph_api_headers.go b/apihandlers/msgraph/msgraph_api_headers.go
@@ -1,5 +1,5 @@
-// graph_api_headers.go
-package graph
+// msgraph_api_headers.go
+package msgraph
 
 import (
 	"strings"
diff --git a/apihandlers/msgraph/msgraph_api_request.go b/apihandlers/msgraph/msgraph_api_request.go
@@ -1,5 +1,5 @@
-// graph_api_request.go
-package graph
+// msgraph_api_request.go
+package msgraph
 
 import (
 	"bytes"
diff --git a/apihandlers/msgraph/msgraph_api_response.go b/apihandlers/msgraph/msgraph_api_response.go
@@ -1,5 +1,5 @@
-// graph_api_response.go
-package graph
+// msgraph_api_response.go
+package msgraph
 
 import (
 	"encoding/json"
diff --git a/apihandlers/msgraph/msgraph_api_url.go b/apihandlers/msgraph/msgraph_api_url.go
@@ -1,5 +1,5 @@
-// graph_api_url.go
-package graph
+// msgraph_api_url.go
+package msgraph
 
 import (
 	"fmt"
diff --git a/httpclient/httpclient_api_handler.go b/httpclient/httpclient_api_handler.go
@@ -4,8 +4,8 @@ package httpclient
 import (
 	"net/http"
 
-	"github.com/deploymenttheory/go-api-http-client/apihandlers/graph"
 	"github.com/deploymenttheory/go-api-http-client/apihandlers/jamfpro"
+	"github.com/deploymenttheory/go-api-http-client/apihandlers/msgraph"
 	"github.com/deploymenttheory/go-api-http-client/logger"
 	"go.uber.org/zap"
 )
@@ -44,8 +44,8 @@ func LoadAPIHandler(apiType string, log logger.Logger) (APIHandler, error) {
 		}
 		log.Info("API handler loaded successfully", zap.String("APIType", apiType))
 
-	case "graph":
-		apiHandler = &graph.GraphAPIHandler{
+	case "msgraph":
+		apiHandler = &msgraph.GraphAPIHandler{
 			// Initialize with necessary parameters
 		}
 		log.Info("API handler loaded successfully", zap.String("APIType", apiType))
diff --git a/httpclient/httpclient_api_handler_test.go b/httpclient/httpclient_api_handler_test.go
@@ -6,8 +6,8 @@ import (
 	"net/http"
 	"testing"
 
-	"github.com/deploymenttheory/go-api-http-client/apihandlers/graph"
 	"github.com/deploymenttheory/go-api-http-client/apihandlers/jamfpro"
+	"github.com/deploymenttheory/go-api-http-client/apihandlers/msgraph"
 	"github.com/deploymenttheory/go-api-http-client/logger"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
@@ -115,7 +115,7 @@ func TestLoadAPIHandler(t *testing.T) {
 		wantErr  bool
 	}{
 		{"Load JamfPro Handler", "jamfpro", &jamfpro.JamfAPIHandler{}, false},
-		{"Load Graph Handler", "graph", &graph.GraphAPIHandler{}, false},
+		{"Load Graph Handler", "msgraph", &msgraph.GraphAPIHandler{}, false},
 		{"Unsupported API Type", "unknown", nil, true},
 	}
 
diff --git a/httpclient/httpclient_request.go b/httpclient/httpclient_request.go
@@ -8,6 +8,7 @@ import (
 	"time"
 
 	"github.com/deploymenttheory/go-api-http-client/logger"
+	"github.com/deploymenttheory/go-api-http-client/redirecthandler"
 	"github.com/deploymenttheory/go-api-http-client/status"
 	"github.com/google/uuid"
 	"go.uber.org/zap"
@@ -17,8 +18,10 @@ import (
 // This function serves as a dispatcher, deciding whether to execute the request with or without retry logic based on the
 // idempotency of the HTTP method. Idempotent methods (GET, PUT, DELETE) are executed with retries to handle transient errors
 // and rate limits, while non-idempotent methods (POST, PATCH) are executed without retries to avoid potential side effects
-// of duplicating non-idempotent operations. function uses an instance of a logger implementing the logger.Logger interface, used to log informational messages, warnings, and
-// errors encountered during the execution of the request.
+// of duplicating non-idempotent operations. The function uses an instance of a logger implementing the logger.Logger interface,
+// used to log informational messages, warnings, and errors encountered during the execution of the request.
+// It also applies redirect handling to the client if configured, allowing the client to follow redirects up to a maximum
+// number of times.
 
 // Parameters:
 // - method: A string representing the HTTP method to be used for the request. This method determines the execution path
@@ -59,9 +62,12 @@ import (
 //   including maximum retry attempts and total retry duration.
 
 func (c *Client) DoRequest(method, endpoint string, body, out interface{}) (*http.Response, error) {
-
 	log := c.Logger
 
+	// Apply redirect handling to the client with MaxRedirects set to 10
+	redirectHandler := redirecthandler.NewRedirectHandler(log, 10)
+	redirectHandler.WithRedirectHandling(c.httpClient)
+
 	if IsIdempotentHTTPMethod(method) {
 		return c.executeRequestWithRetries(method, endpoint, body, out)
 	} else if IsNonIdempotentHTTPMethod(method) {
diff --git a/logger/zaplogger_logger_test.go b/logger/zaplogger_logger_test.go
@@ -11,10 +11,6 @@ import (
 	"go.uber.org/zap/zapcore"
 )
 
-// osExit is a variable that holds a reference to os.Exit function.
-// It allows overriding os.Exit in tests to prevent exiting the test runner.
-var osExit = os.Exit
-
 // TestDefaultLogger_SetLevel tests the SetLevel method of defaultLogger
 func TestDefaultLogger_SetLevel(t *testing.T) {
 	logger := zap.NewNop()
@@ -64,151 +60,6 @@ func TestDefaultLogger_GetLogLevel(t *testing.T) {
 	}
 }
 
-/*
-// TestDefaultLogger_Debug verifies that the Debug method of the defaultLogger struct correctly
-// invokes the underlying zap.Logger's Debug method when the log level is set to allow Debug messages.
-// The test uses a mockLogger to simulate the zap.Logger behavior, allowing verification of method calls
-// without actual logging output. This ensures that the Debug method adheres to the expected behavior
-// based on the current log level setting, providing confidence in the logging logic's correctness.
-func TestDefaultLogger_Debug(t *testing.T) {
-	mockLogger := NewMockLogger()
-	dLogger := &defaultLogger{logger: mockLogger.Logger, logLevel: LogLevelDebug}
-
-	expectedMessage := "test message"
-	mockLogger.On("Debug", expectedMessage, mock.Anything).Once()
-
-	dLogger.Debug(expectedMessage)
-
-	mockLogger.AssertExpectations(t)
-}
-
-// TestDefaultLogger_Info verifies the Info method of the defaultLogger struct.
-// It ensures that Info logs messages at the Info level when the logger's level allows for it.
-// The test uses a mockLogger to intercept and verify the call to the underlying zap.Logger's Info method.
-func TestDefaultLogger_Info(t *testing.T) {
-	mockLogger := NewMockLogger()
-	dLogger := &defaultLogger{logger: mockLogger.Logger, logLevel: LogLevelInfo}
-
-	expectedMessage := "info message"
-	mockLogger.On("Info", expectedMessage, mock.Anything).Once()
-
-	dLogger.Info(expectedMessage)
-
-	mockLogger.AssertExpectations(t)
-}
-
-// TestDefaultLogger_Warn verifies the Warn method of the defaultLogger struct.
-// This test checks that Warn correctly logs messages at the Warn level based on the logger's current level.
-// The behavior is validated using a mockLogger to capture and assert the call to the zap.Logger's Warn method.
-func TestDefaultLogger_Warn(t *testing.T) {
-	mockLogger := NewMockLogger()
-	dLogger := &defaultLogger{logger: mockLogger.Logger, logLevel: LogLevelWarn}
-
-	expectedMessage := "warn message"
-	mockLogger.On("Warn", expectedMessage, mock.Anything).Once()
-
-	dLogger.Warn(expectedMessage)
-
-	mockLogger.AssertExpectations(t)
-}
-
-// TestDefaultLogger_Error checks the functionality of the Error method in the defaultLogger struct.
-// It ensures that Error logs messages at the Error level and returns an error as expected.
-// The test utilizes a mockLogger to track and affirm the invocation of zap.Logger's Error method.
-func TestDefaultLogger_Error(t *testing.T) {
-	mockLogger := NewMockLogger()
-	dLogger := &defaultLogger{logger: mockLogger.Logger, logLevel: LogLevelError}
-
-	expectedErrorMsg := "error message"
-	// Mock the Error method to return nil, indicating no error
-	mockLogger.On("Error", expectedErrorMsg, mock.Anything).Once().Return(fmt.Errorf("error message"))
-
-	err := dLogger.Error(expectedErrorMsg)
-
-	assert.NoError(t, err) // Check that the error returned is nil
-	mockLogger.AssertExpectations(t)
-}
-
-// TestDefaultLogger_Panic ensures the Panic method of the defaultLogger behaves correctly.
-// This test verifies that Panic logs messages at the Panic level and triggers a panic as expected.
-// Due to the nature of panic, this test needs to recover from the panic to verify the behavior.
-func TestDefaultLogger_Panic(t *testing.T) {
-	mockLogger := NewMockLogger()
-	dLogger := &defaultLogger{logger: mockLogger.Logger, logLevel: LogLevelPanic}
-
-	expectedMessage := "panic message"
-	mockLogger.On("Panic", expectedMessage, mock.Anything).Once()
-
-	// Assert that calling Panic method triggers a panic
-	assert.Panics(t, func() { dLogger.Panic(expectedMessage) }, "The Panic method should trigger a panic")
-
-	mockLogger.AssertExpectations(t)
-}
-
-
-// TestDefaultLogger_Fatal verifies the Fatal method of the defaultLogger struct.
-// It ensures that Fatal logs messages at the Fatal level and exits the application with a non-zero status code.
-// The test utilizes a mockLogger to capture and assert the call to the zap.Logger's Fatal method.
-func TestDefaultLogger_Fatal(t *testing.T) {
-	mockLogger := NewMockLogger()
-	dLogger := &defaultLogger{logger: mockLogger.Logger, logLevel: LogLevelFatal}
-
-	expectedFatalMsg := "fatal message"
-	// Use mock.Anything for fields argument to avoid strict matching issues
-	mockLogger.On("Fatal", expectedFatalMsg, mock.Anything).Once()
-
-	// Replace os.Exit temporarily to capture exit status
-	oldExit := osExit
-	var exitStatus int
-	osExit = func(code int) {
-		exitStatus = code
-	}
-	// Ensure the original os.Exit is restored after this test
-	defer func() { osExit = oldExit }()
-
-	// Execute the Fatal method, which is expected to call os.Exit
-	dLogger.Fatal(expectedFatalMsg)
-
-	// Verify the exit status is set as expected
-	assert.Equal(t, 1, exitStatus, "Expected non-zero exit status")
-
-	// Confirm that the mock logger's expectations are met
-	mockLogger.AssertExpectations(t)
-}
-*/
-// Debug mocks the Debug method of the Logger interface
-func (m *MockLogger) Debug(msg string, fields ...zapcore.Field) {
-	m.Called(msg, fields)
-}
-
-// Info mocks the Info method of the Logger interface
-func (m *MockLogger) Info(msg string, fields ...zapcore.Field) {
-	m.Called(msg, fields)
-}
-
-// Warn mocks the Warn method of the Logger interface
-func (m *MockLogger) Warn(msg string, fields ...zapcore.Field) {
-	m.Called(msg, fields)
-}
-
-// Error mocks the Error method of the Logger interface
-func (m *MockLogger) Error(msg string, fields ...zapcore.Field) error {
-	args := m.Called(msg, fields)
-	return args.Error(0)
-}
-
-// With mocks the With method of the Logger interface
-func (m *MockLogger) With(fields ...zapcore.Field) Logger {
-	args := m.Called(fields)
-	return args.Get(0).(Logger)
-}
-
-// GetLogLevel mocks the GetLogLevel method of the Logger interface
-func (m *MockLogger) GetLogLevel() LogLevel {
-	args := m.Called()
-	return args.Get(0).(LogLevel)
-}
-
 // TestGetLoggerBasedOnEnv tests the GetLoggerBasedOnEnv function for different environment settings
 func TestGetLoggerBasedOnEnv(t *testing.T) {
 	tests := []struct {
diff --git a/logger/zaplogger_mocklogger.go b/logger/zaplogger_mocklogger.go
diff --git a/mocklogger/mocklogger.go b/mocklogger/mocklogger.go
diff --git a/redirecthandler/redirecthandler.go b/redirecthandler/redirecthandler.go
diff --git a/redirecthandler/redirecthandler_test.go b/redirecthandler/redirecthandler_test.go
diff --git a/status/status.go b/status/status.go

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@ package httpclient`
`4`	`4`	`import (`
`5`	`5`	`"net/http"`
`6`	`6`
`7`		`- "github.com/deploymenttheory/go-api-http-client/apihandlers/graph"`
`8`	`7`	`"github.com/deploymenttheory/go-api-http-client/apihandlers/jamfpro"`
	`8`	`+ "github.com/deploymenttheory/go-api-http-client/apihandlers/msgraph"`
`9`	`9`	`"github.com/deploymenttheory/go-api-http-client/logger"`
`10`	`10`	`"go.uber.org/zap"`
`11`	`11`	`)`
`@@ -44,8 +44,8 @@ func LoadAPIHandler(apiType string, log logger.Logger) (APIHandler, error) {`
`44`	`44`	`}`
`45`	`45`	`log.Info("API handler loaded successfully", zap.String("APIType", apiType))`
`46`	`46`
`47`		`- case "graph":`
`48`		`- apiHandler = &graph.GraphAPIHandler{`
	`47`	`+ case "msgraph":`
	`48`	`+ apiHandler = &msgraph.GraphAPIHandler{`
`49`	`49`	`// Initialize with necessary parameters`
`50`	`50`	`}`
`51`	`51`	`log.Info("API handler loaded successfully", zap.String("APIType", apiType))`