fix comments

Author: jwtty

pkg/clients/azure/compute/vmsizerecommenderclient.go

@@ -27,41 +27,36 @@ const (
 	recommendationsPathTemplate = "/subscriptions/%s/providers/Microsoft.Compute/locations/%s/vmSizeRecommendations/vmAttributeBased/generate"
 )
 
-// AttributeBasedVMSizeRecommenderClient is an interface for interacting with the Azure Attribute-Based VM Size Recommender API.
-type AttributeBasedVMSizeRecommenderClient interface {
-	// GenerateAttributeBasedRecommendations generates VM size recommendations based on attributes.
-	GenerateAttributeBasedRecommendations(ctx context.Context, req *computev1.GenerateAttributeBasedRecommendationsRequest) (*computev1.GenerateAttributeBasedRecommendationsResponse, error)
-}
-
-var _ AttributeBasedVMSizeRecommenderClient = &attributeBasedVMSizeRecommenderClient{}
-
-// attributeBasedVMSizeRecommenderClient implements the AttributeBasedVMSizeRecommenderClient interface
-// for interacting with Azure Attribute-Based VM Size Recommender API.
-type attributeBasedVMSizeRecommenderClient struct {
+// AttributeBasedVMSizeRecommenderClient accesses Azure Attribute-Based VM Size Recommender API
+// to provide VM size recommendations based on specified attributes.
+type AttributeBasedVMSizeRecommenderClient struct {
 	// baseURL is the base URL of the http(s) requests to the attribute-based VM size recommender service endpoint.
 	baseURL string
 	// httpClient is the HTTP client used for making requests.
 	httpClient *http.Client
 }
 
-// NewAttributeBasedVMSizeRecommenderClient creates a new attribute-based VM size recommender client.
+// NewAttributeBasedVMSizeRecommenderClient creates a new AttributeBasedVMSizeRecommenderClient.
 // The serverAddress is the remote Azure Attribute-Based VM Size Recommender service endpoint.
 // Both serverAddress and httpClient must be provided.
-func NewAttributeBasedVMSizeRecommenderClient(serverAddress string, httpClient *http.Client) (AttributeBasedVMSizeRecommenderClient, error) {
+func NewAttributeBasedVMSizeRecommenderClient(
+	serverAddress string,
+	httpClient *http.Client,
+) (*AttributeBasedVMSizeRecommenderClient, error) {
 	if len(serverAddress) == 0 {
 		return nil, fmt.Errorf("serverAddress cannot be empty")
 	}
 	if httpClient == nil {
 		return nil, fmt.Errorf("httpClient cannot be nil")
 	}
-	return &attributeBasedVMSizeRecommenderClient{
+	return &AttributeBasedVMSizeRecommenderClient{
 		baseURL:    serverAddress,
 		httpClient: httpClient,
 	}, nil
 }
 
 // GenerateAttributeBasedRecommendations generates VM size recommendations based on attributes.
-func (c *attributeBasedVMSizeRecommenderClient) GenerateAttributeBasedRecommendations(
+func (c *AttributeBasedVMSizeRecommenderClient) GenerateAttributeBasedRecommendations(
 	ctx context.Context,
 	req *computev1.GenerateAttributeBasedRecommendationsRequest,
 ) (*computev1.GenerateAttributeBasedRecommendationsResponse, error) {

pkg/clients/azure/compute/vmsizerecommenderclient_test.go

@@ -26,7 +26,7 @@ func TestNewAttributeBasedVMSizeRecommenderClient(t *testing.T) {
 		name          string
 		serverAddress string
 		httpClient    *http.Client
-		wantClient    *attributeBasedVMSizeRecommenderClient
+		wantClient    *AttributeBasedVMSizeRecommenderClient
 		wantErr       bool
 	}{
 		{
@@ -47,7 +47,7 @@ func TestNewAttributeBasedVMSizeRecommenderClient(t *testing.T) {
 			name:          "with both server address and HTTP client",
 			serverAddress: "https://example.com",
 			httpClient:    http.DefaultClient,
-			wantClient: &attributeBasedVMSizeRecommenderClient{
+			wantClient: &AttributeBasedVMSizeRecommenderClient{
 				baseURL:    "https://example.com",
 				httpClient: http.DefaultClient,
 			},
@@ -59,16 +59,11 @@ func TestNewAttributeBasedVMSizeRecommenderClient(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			got, gotErr := NewAttributeBasedVMSizeRecommenderClient(tt.serverAddress, tt.httpClient)
 			if (gotErr != nil) != tt.wantErr {
-				t.Errorf("NewClient() error = %v, wantErr %v", gotErr, tt.wantErr)
+				t.Errorf("NewAttributeBasedVMSizeRecommenderClient() error = %v, wantErr %v", gotErr, tt.wantErr)
 			}
-			gotClient, ok := got.(*attributeBasedVMSizeRecommenderClient)
-			if !ok && tt.wantClient != nil {
-				t.Errorf("NewClient() got type %T, want *attributeBasedVMSizeRecommenderClient", got)
-				return
-			}
-			if diff := cmp.Diff(tt.wantClient, gotClient,
-				cmp.AllowUnexported(attributeBasedVMSizeRecommenderClient{})); diff != "" {
-				t.Errorf("NewClient() mismatch (-want +got):\n%s", diff)
+			if diff := cmp.Diff(tt.wantClient, got,
+				cmp.AllowUnexported(AttributeBasedVMSizeRecommenderClient{})); diff != "" {
+				t.Errorf("NewAttributeBasedVMSizeRecommenderClient() mismatch (-want +got):\n%s", diff)
 			}
 		})
 	}