Add ProviderClient.DeepCopy, ServiceClient.DeepCopy

stephenfin · stephenfin · commit 33b87441d516 · 2025-08-07T17:11:00.000+01:00
Signed-off-by: Stephen Finucane &lt;stephenfin@redhat.com&gt;
diff --git a/provider_client.go b/provider_client.go
@@ -139,6 +139,38 @@ func (f *reauthFuture) Get() error {
 	return f.err
 }
 
+// DeepCopy creates a deep copy of the ProviderClient.
+func (client *ProviderClient) DeepCopy() *ProviderClient {
+	newClient := &ProviderClient{
+		IdentityBase:      client.IdentityBase,
+		IdentityEndpoint:  client.IdentityEndpoint,
+		TokenID:           client.TokenID,
+		EndpointLocator:   client.EndpointLocator,
+		HTTPClient:        client.HTTPClient,
+		ReauthFunc:        client.ReauthFunc,
+		RetryBackoffFunc:  client.RetryBackoffFunc,
+		RetryFunc:         client.RetryFunc,
+		Throwaway:         client.Throwaway,
+		MaxBackoffRetries: client.MaxBackoffRetries,
+		authResult:        client.authResult,
+	}
+
+	if len(client.UserAgent.prepend) > 0 {
+		newClient.UserAgent.prepend = make([]string, len(client.UserAgent.prepend))
+		copy(newClient.UserAgent.prepend, client.UserAgent.prepend)
+	}
+
+	if client.mut != nil {
+		newClient.mut = new(sync.RWMutex)
+	}
+
+	if client.reauthmut != nil {
+		newClient.reauthmut = new(reauthlock)
+	}
+
+	return newClient
+}
+
 // AuthenticatedHeaders returns a map of HTTP headers that are common for all
 // authenticated service requests. Blocks if Reauthenticate is in progress.
 func (client *ProviderClient) AuthenticatedHeaders() (m map[string]string) {
diff --git a/service_client.go b/service_client.go
@@ -3,6 +3,7 @@ package gophercloud
 import (
 	"context"
 	"io"
+	"maps"
 	"net/http"
 	"strings"
 )
@@ -60,6 +61,27 @@ func (client *ServiceClient) initReqOpts(JSONBody any, JSONResponse any, opts *R
 	}
 }
 
+// DeepCopy creates a deep copy of the ServiceClient.
+func (client *ServiceClient) DeepCopy() *ServiceClient {
+	newClient := &ServiceClient{
+		Endpoint:     client.Endpoint,
+		ResourceBase: client.ResourceBase,
+		Type:         client.Type,
+		Microversion: client.Microversion,
+	}
+
+	if client.ProviderClient != nil {
+		newClient.ProviderClient = client.ProviderClient.DeepCopy()
+	}
+
+	if client.MoreHeaders != nil {
+		newClient.MoreHeaders = make(map[string]string, len(client.MoreHeaders))
+		maps.Copy(newClient.MoreHeaders, client.MoreHeaders)
+	}
+
+	return newClient
+}
+
 // Get calls `Request` with the "GET" HTTP verb.
 func (client *ServiceClient) Get(ctx context.Context, url string, JSONResponse any, opts *RequestOpts) (*http.Response, error) {
 	if opts == nil {
