-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor GCEClient: wrap compute.Service in an interface for mocking …
…GCP compute This change creates a ComputeService implementation which has a runtime implementation that wraps the compute.Service. The MachineActuator is changed to make use of the ComputeService through a new interface named GCEClientComputeService. This will enable creating tests that mock GCP Compute Service calls to control MachineActuator behavior.
- Loading branch information
Showing
3 changed files
with
246 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| package clients | ||
|
|
||
| import ( | ||
| compute "google.golang.org/api/compute/v1" | ||
| "net/http" | ||
| "net/url" | ||
| ) | ||
|
|
||
| // ComputeService is a pass through wrapper for google.golang.org/api/compute/v1/compute | ||
| // The purpose of the ComputeService's wrap of the GCE client is to enable tests to mock this struct and control behavior. | ||
| type ComputeService struct { | ||
| service *compute.Service | ||
| } | ||
|
|
||
| func NewComputeService(client *http.Client) (*ComputeService, error) { | ||
| service, err := compute.New(client) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &ComputeService{ | ||
| service: service, | ||
| }, nil | ||
| } | ||
|
|
||
| func NewComputeServiceForURL(client *http.Client, baseURL string) (*ComputeService, error) { | ||
| computeService, err := NewComputeService(client) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| url, err := url.Parse(computeService.service.BasePath) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| computeService.service.BasePath = baseURL + url.Path | ||
| return computeService, err | ||
| } | ||
|
|
||
| // A pass through wrapper for compute.Service.Images.Get(...) | ||
| func (c *ComputeService) ImagesGet(project string, image string) (*compute.Image, error) { | ||
| return c.service.Images.Get(project, image).Do() | ||
| } | ||
|
|
||
| // A pass through wrapper for compute.Service.Images.GetFromFamily(...) | ||
| func (c *ComputeService) ImagesGetFromFamily(project string, family string) (*compute.Image, error) { | ||
| return c.service.Images.GetFromFamily(project, family).Do() | ||
| } | ||
|
|
||
| // A pass through wrapper for compute.Service.Instances.Delete(...) | ||
| func (c *ComputeService) InstancesDelete(project string, zone string, targetInstance string) (*compute.Operation, error) { | ||
| return c.service.Instances.Delete(project, zone, targetInstance).Do() | ||
| } | ||
|
|
||
| // A pass through wrapper for compute.Service.Instances.Get(...) | ||
| func (c *ComputeService) InstancesGet(project string, zone string, instance string) (*compute.Instance, error) { | ||
| return c.service.Instances.Get(project, zone, instance).Do() | ||
| } | ||
|
|
||
| // A pass through wrapper for compute.Service.Instances.Insert(...) | ||
| func (c *ComputeService) InstancesInsert(project string, zone string, instance *compute.Instance) (*compute.Operation, error) { | ||
| return c.service.Instances.Insert(project, zone, instance).Do() | ||
| } | ||
|
|
||
| // A pass through wrapper for compute.Service.ZoneOperations.Get(...) | ||
| func (c *ComputeService) ZoneOperationsGet(project string, zone string, operation string) (*compute.Operation, error) { | ||
| return c.service.ZoneOperations.Get(project, zone, operation).Do() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| package clients_test | ||
|
|
||
| import ( | ||
| compute "google.golang.org/api/compute/v1" | ||
| "encoding/json" | ||
| "google.golang.org/api/googleapi" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "sigs.k8s.io/cluster-api/cloud/google/clients" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestImagesGet(t *testing.T) { | ||
| mux, server, client := createMuxServerAndClient() | ||
| defer server.Close() | ||
| responseImage := compute.Image{ | ||
| Name: "imageName", | ||
| ArchiveSizeBytes: 544, | ||
| } | ||
| mux.Handle("/compute/v1/projects/projectName/global/images/imageName", handler(nil, &responseImage)) | ||
| image, err := client.ImagesGet("projectName", "imageName") | ||
| if err != nil { | ||
| t.Errorf("unexpected error: %v", err) | ||
| } | ||
| if image == nil { | ||
| t.Error("expected a valid image") | ||
| } | ||
| if "imageName" != image.Name { | ||
| t.Errorf("expected imageName got %v", image.Name) | ||
| } | ||
| if image.ArchiveSizeBytes != int64(544) { | ||
| t.Errorf("expected %v got %v", image.ArchiveSizeBytes, 544) | ||
| } | ||
| } | ||
|
|
||
| func TestImagesGetFromFamily(t *testing.T) { | ||
| mux, server, client := createMuxServerAndClient() | ||
| defer server.Close() | ||
| responseImage := compute.Image{ | ||
| Name: "imageName", | ||
| ArchiveSizeBytes: 544, | ||
| } | ||
| mux.Handle("/compute/v1/projects/projectName/global/images/family/familyName", handler(nil, &responseImage)) | ||
| image, err := client.ImagesGetFromFamily("projectName", "familyName") | ||
| if err != nil { | ||
| t.Errorf("unexpected error: %v", err) | ||
| } | ||
| if image == nil { | ||
| t.Error("expected a valid image") | ||
| } | ||
| if "imageName" != image.Name { | ||
| t.Errorf("expected imageName got %v", image.Name) | ||
| } | ||
| if image.ArchiveSizeBytes != int64(544) { | ||
| t.Errorf("expected %v got %v", image.ArchiveSizeBytes, 544) | ||
| } | ||
| } | ||
|
|
||
| func TestInstancesDelete(t *testing.T) { | ||
| mux, server, client := createMuxServerAndClient() | ||
| defer server.Close() | ||
| responseOperation := compute.Operation{ | ||
| Id: 4501, | ||
| } | ||
| mux.Handle("/compute/v1/projects/projectName/zones/zoneName/instances/instanceName", handler(nil, &responseOperation)) | ||
| op, err := client.InstancesDelete("projectName", "zoneName", "instanceName") | ||
| if err != nil { | ||
| t.Errorf("unexpected error: %v", err) | ||
| } | ||
| if op == nil { | ||
| t.Error("expected a valid operation") | ||
| } | ||
| if responseOperation.Id != uint64(4501) { | ||
| t.Errorf("expected %v got %v", responseOperation.Id, 4501) | ||
| } | ||
| } | ||
|
|
||
| func TestInstancesGet(t *testing.T) { | ||
| mux, server, client := createMuxServerAndClient() | ||
| defer server.Close() | ||
| responseInstance := compute.Instance{ | ||
| Name: "instanceName", | ||
| Zone: "zoneName", | ||
| } | ||
| mux.Handle("/compute/v1/projects/projectName/zones/zoneName/instances/instanceName", handler(nil, &responseInstance)) | ||
| instance, err := client.InstancesGet("projectName", "zoneName", "instanceName") | ||
| if err != nil { | ||
| t.Errorf("unexpected error: %v", err) | ||
| } | ||
| if instance == nil { | ||
| t.Error("expected a valid instance") | ||
| } | ||
| if "instanceName" != instance.Name { | ||
| t.Errorf("expected instanceName got %v", instance.Name) | ||
| } | ||
| if "zoneName" != instance.Zone { | ||
| t.Errorf("expected zoneName got %v", instance.Zone) | ||
| } | ||
| } | ||
|
|
||
| func TestInstancesInsert(t *testing.T) { | ||
| mux, server, client := createMuxServerAndClient() | ||
| defer server.Close() | ||
| responseOperation := compute.Operation{ | ||
| Id: 3001, | ||
| } | ||
| mux.Handle("/compute/v1/projects/projectName/zones/zoneName/instances", handler(nil, &responseOperation)) | ||
| op, err := client.InstancesInsert("projectName", "zoneName", nil) | ||
| if err != nil { | ||
| t.Errorf("unexpected error: %v", err) | ||
| } | ||
| if op == nil { | ||
| t.Error("expected a valid operation") | ||
| } | ||
| if responseOperation.Id != uint64(3001) { | ||
| t.Errorf("expected %v got %v", responseOperation.Id, 3001) | ||
| } | ||
| } | ||
|
|
||
| func createMuxServerAndClient() (*http.ServeMux, *httptest.Server, *clients.ComputeService) { | ||
| mux := http.NewServeMux() | ||
| server := httptest.NewServer(mux) | ||
| client, _ := clients.NewComputeServiceForURL(server.Client(), server.URL) | ||
| return mux, server, client | ||
| } | ||
|
|
||
| func handler(err *googleapi.Error, obj interface{}) http.HandlerFunc { | ||
| return func(w http.ResponseWriter, req *http.Request) { | ||
| handleTestRequest(w, err, obj) | ||
| } | ||
| } | ||
|
|
||
| func handleTestRequest(w http.ResponseWriter, handleErr *googleapi.Error, obj interface{}) { | ||
| if handleErr != nil { | ||
| http.Error(w, errMsg(handleErr), handleErr.Code) | ||
| return | ||
| } | ||
| res, err := json.Marshal(obj) | ||
| if err != nil { | ||
| http.Error(w, "json marshal error", http.StatusInternalServerError) | ||
| return | ||
| } | ||
| w.Write(res) | ||
| } | ||
|
|
||
| func errMsg(e *googleapi.Error) string { | ||
| res, err := json.Marshal(&errorReply{e}) | ||
| if err != nil { | ||
| return "json marshal error" | ||
| } | ||
| return string(res) | ||
| } | ||
|
|
||
| type errorReply struct { | ||
| Error *googleapi.Error `json:"error"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters