Refactor: aggregate variables into a structure

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
-## [0.0.5, unreleased] - 2023-XX-XX
+## [0.0.8, unreleased] - 2023-xx-xx
+### Changed
+- Refactoring
+  - Refactoring for internal code. For example, introduce network struct.
+
+## [0.0.5 - 0.0.7] - 2023-10-12
 ### Added
 - GitHub Actions workflow for [gosec](https://github.com/securego/gosec).
   - Fix gosec issue

Makefile

@@ -7,6 +7,9 @@ test: ## Run unit tests
 test-examples: ## Run unit tests for examples directory
 	make -C examples test
 
+clean: ## Clean up
+	rm -f coverage.out coverage.html
+
 .DEFAULT_GOAL := help
 help:  ## Show this help
 	@grep -E '^[0-9a-zA-Z_-]+[[:blank:]]*:.*?## .*$$' $(MAKEFILE_LIST) | sort \

assert.go

@@ -324,13 +324,13 @@ type labeledContent struct {
 // NoopVerifier is a verifier that does not perform verification
 type NoopVerifier struct{}
 
+var _ Verifier = NoopVerifier{}
+
 // True is always true
 func (n NoopVerifier) True(_ TestingT, _ bool, _ ...interface{}) bool {
 	return true
 }
 
-var _ Verifier = NoopVerifier{}
-
 // Equal does not perform any assertion and always returns true
 func (n NoopVerifier) Equal(_ TestingT, _, _ interface{}, _ ...interface{}) bool {
 	return true

authentication.go

@@ -0,0 +1,44 @@
+package spectest
+
+import "fmt"
+
+// basicAuth is represents the basic auth credentials
+type basicAuth struct {
+	// userName is the userName for basic auth
+	userName string
+	// password is the password for basic auth
+	password string
+}
+
+// newBasicAuth creates a new basic auth
+func newBasicAuth(userName, password string) basicAuth {
+	return basicAuth{
+		userName: userName,
+		password: password,
+	}
+}
+
+// isUserNameEmpty returns true if the userName is empty
+func (b basicAuth) isUserNameEmpty() bool {
+	return b.userName == ""
+}
+
+// isPasswordEmpty returns true if the password is empty
+func (b basicAuth) isPasswordEmpty() bool {
+	return b.password == ""
+}
+
+// auth will authenticate the user
+// auth will return an error if the user is not authenticated
+func (b basicAuth) auth(userName, password string) error {
+	if b.userName != userName {
+		return fmt.Errorf("basic auth request username '%s' did not match mock username '%s'",
+			userName, b.userName)
+	}
+
+	if b.password != password {
+		return fmt.Errorf("basic auth request password '%s' did not match mock password '%s'",
+			password, b.password)
+	}
+	return nil
+}

authentication_test.go

@@ -0,0 +1,69 @@
+package spectest
+
+import "testing"
+
+func TestBasicAuthAuth(t *testing.T) {
+	type fields struct {
+		userName string
+		password string
+	}
+	type args struct {
+		userName string
+		password string
+	}
+	tests := []struct {
+		name    string
+		fields  fields
+		args    args
+		wantErr bool
+	}{
+		{
+			name: "auth with valid credentials",
+			fields: fields{
+				userName: "user",
+				password: "password",
+			},
+			args: args{
+				userName: "user",
+				password: "password",
+			},
+			wantErr: false,
+		},
+		{
+			name: "auth with invalid credentials. bad password",
+			fields: fields{
+				userName: "user",
+				password: "password",
+			},
+			args: args{
+				userName: "user",
+				password: "invalid-password",
+			},
+			wantErr: true,
+		},
+		{
+			name: "auth with invalid credentials. bad user name",
+			fields: fields{
+				userName: "user",
+				password: "password",
+			},
+			args: args{
+				userName: "invalid-user",
+				password: "password",
+			},
+			wantErr: true,
+		},
+	}
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			b := &basicAuth{
+				userName: tt.fields.userName,
+				password: tt.fields.password,
+			}
+			if err := b.auth(tt.args.userName, tt.args.password); (err != nil) != tt.wantErr {
+				t.Errorf("basicAuth.auth() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}

debug.go

@@ -2,17 +2,103 @@ package spectest
 
 import (
 	"fmt"
+	"net/http"
+	"net/http/httputil"
 	"strings"
 )
 
+// debug is used to enable/disable debug logging
+type debug struct {
+	enabled bool
+}
+
+// newDebug creates a new debug setting
+func newDebug() *debug {
+	return &debug{}
+}
+
+// enable will enable debug logging
+func (d *debug) enable() {
+	d.enabled = true
+}
+
+// disable will disable debug logging
+func (d *debug) disable() {
+	d.enabled = false
+}
+
+// isEnable returns true if debug logging is enabled
+func (d *debug) isEnable() bool {
+	return d.enabled
+}
+
+// dumpResponse is used to dump the response.
+// If debug logging is disabled, this method will do nothing.
+func (d *debug) dumpRequest(req *http.Request) {
+	if !d.isEnable() {
+		return
+	}
+	requestDump, err := httputil.DumpRequest(req, true)
+	if err == nil {
+		debugLog(requestDebugPrefix(), "inbound http request", string(requestDump))
+	}
+	// TODO: handle error
+}
+
+// dumpResponse is used to dump the response.
+// If debug logging is disabled, this method will do nothing.
+func (d *debug) dumpResponse(res *http.Response) {
+	if !d.isEnable() {
+		return
+	}
+	responseDump, err := httputil.DumpResponse(res, true)
+	if err == nil {
+		debugLog(responseDebugPrefix(), "final response", string(responseDump))
+	}
+	// TODO: handle error
+}
+
+// duration is used to print the duration of the test.
+// If debug logging is disabled, this method will do nothing.
+func (d *debug) duration(interval *Interval) {
+	if !d.isEnable() {
+		return
+	}
+	fmt.Printf("Duration: %s\n", interval.Duration())
+}
+
+// mock is used to print the request and response from the mock.
+func (d *debug) mock(res *http.Response, req *http.Request) {
+	if !d.isEnable() {
+		return
+	}
+
+	requestDump, err := httputil.DumpRequestOut(req, true)
+	if err == nil {
+		debugLog(requestDebugPrefix(), "request to mock", string(requestDump))
+	}
+
+	if res != nil {
+		responseDump, err := httputil.DumpResponse(res, true)
+		if err == nil {
+			debugLog(responseDebugPrefix(), "response from mock", string(responseDump))
+		}
+	} else {
+		debugLog(responseDebugPrefix(), "response from mock", "")
+	}
+}
+
+// debugLog is used to print debug information
 func debugLog(prefix, header, msg string) {
 	fmt.Printf("\n%s %s\n%s\n", prefix, header, msg)
 }
 
+// requestDebugLog is used to print debug information for the request
 func requestDebugPrefix() string {
 	return fmt.Sprintf("%s>", strings.Repeat("-", 10))
 }
 
+// responseDebugLog is used to print debug information for the response
 func responseDebugPrefix() string {
 	return fmt.Sprintf("<%s", strings.Repeat("-", 10))
 }