-
Notifications
You must be signed in to change notification settings - Fork 261
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add mock client and 2 tests for networking package
Refactors the Service in the networking package to use a client with CRUD functions for manipulating OpenStack resources. This interface is combined with mockgen code generation to make the package unit testable. Two tests are added to illustrate how writing tests for the package will work.
- Loading branch information
Showing
10 changed files
with
1,039 additions
and
151 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
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
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,282 @@ | ||
| /* | ||
| Copyright 2021 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package networking | ||
|
|
||
| //go:generate mockgen -destination=mock_client/client.go -package=mock_client sigs.k8s.io/cluster-api-provider-openstack/pkg/cloud/services/networking NetworkClient | ||
| //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt mock_client/client.go > mock_client/_client.go && mv mock_client/_client.go mock_client/client.go" | ||
|
|
||
| import ( | ||
| "github.com/gophercloud/gophercloud" | ||
| "github.com/gophercloud/gophercloud/openstack/networking/v2/extensions/attributestags" | ||
| "github.com/gophercloud/gophercloud/openstack/networking/v2/extensions/layer3/floatingips" | ||
| "github.com/gophercloud/gophercloud/openstack/networking/v2/extensions/layer3/routers" | ||
| "github.com/gophercloud/gophercloud/openstack/networking/v2/extensions/security/groups" | ||
| "github.com/gophercloud/gophercloud/openstack/networking/v2/extensions/security/rules" | ||
| "github.com/gophercloud/gophercloud/openstack/networking/v2/networks" | ||
| "github.com/gophercloud/gophercloud/openstack/networking/v2/ports" | ||
| "github.com/gophercloud/gophercloud/openstack/networking/v2/subnets" | ||
|
|
||
| "sigs.k8s.io/cluster-api-provider-openstack/pkg/metrics" | ||
| ) | ||
|
|
||
| type NetworkClient interface { | ||
| ListFloatingIP(opts floatingips.ListOptsBuilder) ([]floatingips.FloatingIP, error) | ||
| CreateFloatingIP(opts floatingips.CreateOptsBuilder) (*floatingips.FloatingIP, error) | ||
| DeleteFloatingIP(id string) error | ||
| GetFloatingIP(id string) (*floatingips.FloatingIP, error) | ||
| UpdateFloatingIP(id string, opts floatingips.UpdateOptsBuilder) (*floatingips.FloatingIP, error) | ||
|
|
||
| ListPort(opts ports.ListOptsBuilder) ([]ports.Port, error) | ||
| CreatePort(opts ports.CreateOptsBuilder) (*ports.Port, error) | ||
| DeletePort(id string) error | ||
| GetPort(id string) (*ports.Port, error) | ||
| UpdatePort(id string, opts ports.UpdateOptsBuilder) (*ports.Port, error) | ||
|
|
||
| ListRouter(opts routers.ListOpts) ([]routers.Router, error) | ||
| CreateRouter(opts routers.CreateOptsBuilder) (*routers.Router, error) | ||
| DeleteRouter(id string) error | ||
| GetRouter(id string) (*routers.Router, error) | ||
| UpdateRouter(id string, opts routers.UpdateOptsBuilder) (*routers.Router, error) | ||
| AddRouterInterface(id string, opts routers.AddInterfaceOptsBuilder) (*routers.InterfaceInfo, error) | ||
| RemoveRouterInterface(id string, opts routers.RemoveInterfaceOptsBuilder) (*routers.InterfaceInfo, error) | ||
|
|
||
| ListSecGroup(opts groups.ListOpts) ([]groups.SecGroup, error) | ||
| CreateSecGroup(opts groups.CreateOptsBuilder) (*groups.SecGroup, error) | ||
| DeleteSecGroup(id string) error | ||
| GetSecGroup(id string) (*groups.SecGroup, error) | ||
| UpdateSecGroup(id string, opts groups.UpdateOptsBuilder) (*groups.SecGroup, error) | ||
|
|
||
| ListSecGroupRule(opts rules.ListOpts) ([]rules.SecGroupRule, error) | ||
| CreateSecGroupRule(opts rules.CreateOptsBuilder) (*rules.SecGroupRule, error) | ||
| DeleteSecGroupRule(id string) error | ||
| GetSecGroupRule(id string) (*rules.SecGroupRule, error) | ||
|
|
||
| ListNetwork(opts networks.ListOptsBuilder) ([]networks.Network, error) | ||
| CreateNetwork(opts networks.CreateOptsBuilder) (*networks.Network, error) | ||
| DeleteNetwork(id string) error | ||
| GetNetwork(id string) (*networks.Network, error) | ||
| UpdateNetwork(id string, opts networks.UpdateOptsBuilder) (*networks.Network, error) | ||
|
|
||
| ListSubnet(opts subnets.ListOptsBuilder) ([]subnets.Subnet, error) | ||
| CreateSubnet(opts subnets.CreateOptsBuilder) (*subnets.Subnet, error) | ||
| DeleteSubnet(id string) error | ||
| GetSubnet(id string) (*subnets.Subnet, error) | ||
| UpdateSubnet(id string, opts subnets.UpdateOptsBuilder) (*subnets.Subnet, error) | ||
|
|
||
| ReplaceAllAttributesTags(resourceType string, resourceID string, opts attributestags.ReplaceAllOptsBuilder) ([]string, error) | ||
| } | ||
|
|
||
| type networkClient struct { | ||
| serviceClient *gophercloud.ServiceClient | ||
| } | ||
|
|
||
| func (c networkClient) AddRouterInterface(id string, opts routers.AddInterfaceOptsBuilder) (*routers.InterfaceInfo, error) { | ||
| mc := metrics.NewMetricPrometheusContext("server_os_interface", "create") | ||
| interfaceInfo, err := routers.AddInterface(c.serviceClient, id, opts).Extract() | ||
| if mc.ObserveRequest(err) != nil { | ||
| return nil, err | ||
| } | ||
| return interfaceInfo, nil | ||
| } | ||
|
|
||
| func (c networkClient) RemoveRouterInterface(id string, opts routers.RemoveInterfaceOptsBuilder) (*routers.InterfaceInfo, error) { | ||
| mc := metrics.NewMetricPrometheusContext("server_os_interface", "delete") | ||
| interfaceInfo, err := routers.RemoveInterface(c.serviceClient, id, opts).Extract() | ||
| if mc.ObserveRequestIgnoreNotFound(err) != nil { | ||
| return nil, err | ||
| } | ||
| return interfaceInfo, nil | ||
| } | ||
|
|
||
| func (c networkClient) ReplaceAllAttributesTags(resourceType string, resourceID string, opts attributestags.ReplaceAllOptsBuilder) ([]string, error) { | ||
| return attributestags.ReplaceAll(c.serviceClient, resourceType, resourceID, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) ListRouter(opts routers.ListOpts) ([]routers.Router, error) { | ||
| mc := metrics.NewMetricPrometheusContext("router", "list") | ||
| allPages, err := routers.List(c.serviceClient, opts).AllPages() | ||
| if mc.ObserveRequest(err) != nil { | ||
| return nil, err | ||
| } | ||
| return routers.ExtractRouters(allPages) | ||
| } | ||
|
|
||
| func (c networkClient) ListFloatingIP(opts floatingips.ListOptsBuilder) ([]floatingips.FloatingIP, error) { | ||
| mc := metrics.NewMetricPrometheusContext("floating_ip", "list") | ||
| allPages, err := floatingips.List(c.serviceClient, opts).AllPages() | ||
| if mc.ObserveRequest(err) != nil { | ||
| return nil, err | ||
| } | ||
| return floatingips.ExtractFloatingIPs(allPages) | ||
| } | ||
|
|
||
| func (c networkClient) CreateFloatingIP(opts floatingips.CreateOptsBuilder) (*floatingips.FloatingIP, error) { | ||
| return floatingips.Create(c.serviceClient, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) DeleteFloatingIP(id string) error { | ||
| return floatingips.Delete(c.serviceClient, id).ExtractErr() | ||
| } | ||
|
|
||
| func (c networkClient) GetFloatingIP(id string) (*floatingips.FloatingIP, error) { | ||
| mc := metrics.NewMetricPrometheusContext("floating_ip", "list") | ||
| fip, err := floatingips.Get(c.serviceClient, id).Extract() | ||
| if mc.ObserveRequest(err) != nil { | ||
| return nil, err | ||
| } | ||
| return fip, nil | ||
| } | ||
|
|
||
| func (c networkClient) UpdateFloatingIP(id string, opts floatingips.UpdateOptsBuilder) (*floatingips.FloatingIP, error) { | ||
| return floatingips.Update(c.serviceClient, id, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) ListPort(opts ports.ListOptsBuilder) ([]ports.Port, error) { | ||
| mc := metrics.NewMetricPrometheusContext("port", "list") | ||
| allPages, err := ports.List(c.serviceClient, opts).AllPages() | ||
| if mc.ObserveRequest(err) != nil { | ||
| return nil, err | ||
| } | ||
| return ports.ExtractPorts(allPages) | ||
| } | ||
|
|
||
| func (c networkClient) CreatePort(opts ports.CreateOptsBuilder) (*ports.Port, error) { | ||
| return ports.Create(c.serviceClient, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) DeletePort(id string) error { | ||
| return ports.Delete(c.serviceClient, id).ExtractErr() | ||
| } | ||
|
|
||
| func (c networkClient) GetPort(id string) (*ports.Port, error) { | ||
| return ports.Get(c.serviceClient, id).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) UpdatePort(id string, opts ports.UpdateOptsBuilder) (*ports.Port, error) { | ||
| return ports.Update(c.serviceClient, id, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) CreateRouter(opts routers.CreateOptsBuilder) (*routers.Router, error) { | ||
| return routers.Create(c.serviceClient, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) DeleteRouter(id string) error { | ||
| return routers.Delete(c.serviceClient, id).ExtractErr() | ||
| } | ||
|
|
||
| func (c networkClient) GetRouter(id string) (*routers.Router, error) { | ||
| return routers.Get(c.serviceClient, id).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) UpdateRouter(id string, opts routers.UpdateOptsBuilder) (*routers.Router, error) { | ||
| return routers.Update(c.serviceClient, id, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) ListSecGroup(opts groups.ListOpts) ([]groups.SecGroup, error) { | ||
| mc := metrics.NewMetricPrometheusContext("group", "list") | ||
| allPages, err := groups.List(c.serviceClient, opts).AllPages() | ||
| if mc.ObserveRequest(err) != nil { | ||
| return nil, err | ||
| } | ||
| return groups.ExtractGroups(allPages) | ||
| } | ||
|
|
||
| func (c networkClient) CreateSecGroup(opts groups.CreateOptsBuilder) (*groups.SecGroup, error) { | ||
| return groups.Create(c.serviceClient, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) DeleteSecGroup(id string) error { | ||
| return groups.Delete(c.serviceClient, id).ExtractErr() | ||
| } | ||
|
|
||
| func (c networkClient) GetSecGroup(id string) (*groups.SecGroup, error) { | ||
| return groups.Get(c.serviceClient, id).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) UpdateSecGroup(id string, opts groups.UpdateOptsBuilder) (*groups.SecGroup, error) { | ||
| return groups.Update(c.serviceClient, id, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) ListSecGroupRule(opts rules.ListOpts) ([]rules.SecGroupRule, error) { | ||
| allPages, err := rules.List(c.serviceClient, opts).AllPages() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return rules.ExtractRules(allPages) | ||
| } | ||
|
|
||
| func (c networkClient) CreateSecGroupRule(opts rules.CreateOptsBuilder) (*rules.SecGroupRule, error) { | ||
| return rules.Create(c.serviceClient, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) DeleteSecGroupRule(id string) error { | ||
| return rules.Delete(c.serviceClient, id).ExtractErr() | ||
| } | ||
|
|
||
| func (c networkClient) GetSecGroupRule(id string) (*rules.SecGroupRule, error) { | ||
| return rules.Get(c.serviceClient, id).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) ListNetwork(opts networks.ListOptsBuilder) ([]networks.Network, error) { | ||
| mc := metrics.NewMetricPrometheusContext("network", "list") | ||
| allPages, err := networks.List(c.serviceClient, opts).AllPages() | ||
| if mc.ObserveRequest(err) != nil { | ||
| return nil, err | ||
| } | ||
| return networks.ExtractNetworks(allPages) | ||
| } | ||
|
|
||
| func (c networkClient) CreateNetwork(opts networks.CreateOptsBuilder) (*networks.Network, error) { | ||
| return networks.Create(c.serviceClient, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) DeleteNetwork(id string) error { | ||
| return networks.Delete(c.serviceClient, id).ExtractErr() | ||
| } | ||
|
|
||
| func (c networkClient) GetNetwork(id string) (*networks.Network, error) { | ||
| return networks.Get(c.serviceClient, id).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) UpdateNetwork(id string, opts networks.UpdateOptsBuilder) (*networks.Network, error) { | ||
| return networks.Update(c.serviceClient, id, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) ListSubnet(opts subnets.ListOptsBuilder) ([]subnets.Subnet, error) { | ||
| mc := metrics.NewMetricPrometheusContext("subnet", "list") | ||
| allPages, err := subnets.List(c.serviceClient, opts).AllPages() | ||
| if mc.ObserveRequest(err) != nil { | ||
| return nil, err | ||
| } | ||
| return subnets.ExtractSubnets(allPages) | ||
| } | ||
|
|
||
| func (c networkClient) CreateSubnet(opts subnets.CreateOptsBuilder) (*subnets.Subnet, error) { | ||
| return subnets.Create(c.serviceClient, opts).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) DeleteSubnet(id string) error { | ||
| return subnets.Delete(c.serviceClient, id).ExtractErr() | ||
| } | ||
|
|
||
| func (c networkClient) GetSubnet(id string) (*subnets.Subnet, error) { | ||
| return subnets.Get(c.serviceClient, id).Extract() | ||
| } | ||
|
|
||
| func (c networkClient) UpdateSubnet(id string, opts subnets.UpdateOptsBuilder) (*subnets.Subnet, error) { | ||
| return subnets.Update(c.serviceClient, id, opts).Extract() | ||
| } |
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
Oops, something went wrong.