Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Add mock client and 2 tests for networking package #935

Merged
merged 1 commit into from
Jul 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ go 1.16

require (
github.com/go-logr/logr v0.4.0
github.com/golang/mock v1.6.0
github.com/gophercloud/gophercloud v0.16.0
github.com/gophercloud/utils v0.0.0-20210323225332-7b186010c04f
github.com/onsi/ginkgo v1.16.4
Expand Down
3 changes: 3 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,8 @@ github.com/golang/mock v1.4.1/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt
github.com/golang/mock v1.4.3/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
github.com/golang/mock v1.4.4/go.mod h1:l3mdAwkq5BuhzHwde/uurv3sEJeZMXNpwsxVWU71h+4=
github.com/golang/mock v1.5.0/go.mod h1:CWnOUgYIOo4TcNZ0wHX3YZCqsaM1I1Jvs6v3mP3KVu8=
github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc=
github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs=
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
Expand Down Expand Up @@ -1178,6 +1180,7 @@ golang.org/x/tools v0.0.0-20201224043029-2b0845dc783e/go.mod h1:emZCQorbCU4vsT4f
golang.org/x/tools v0.0.0-20210105154028-b0ab187a4818/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
golang.org/x/tools v0.1.2 h1:kRBLX7v7Af8W7Gdbbc908OJcdgtK8bOz9Uaj8/F1ACA=
golang.org/x/tools v0.1.2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
Expand Down
324 changes: 324 additions & 0 deletions pkg/cloud/services/networking/client.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,324 @@
/*
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

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) {
mc := metrics.NewMetricPrometheusContext("floating_ip", "create")
fip, err := floatingips.Create(c.serviceClient, opts).Extract()
if mc.ObserveRequest(err) != nil {
return nil, err
}
return fip, nil
}

func (c networkClient) DeleteFloatingIP(id string) error {
mc := metrics.NewMetricPrometheusContext("floating_ip", "delete")
return mc.ObserveRequest(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) {
mc := metrics.NewMetricPrometheusContext("floating_ip", "update")
fip, err := floatingips.Update(c.serviceClient, id, opts).Extract()
if mc.ObserveRequest(err) != nil {
return nil, err
}
return fip, nil
}

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 {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest we consider add metrics for those kind of API call as well , but no need to be in this PR as this is a pure refactory

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) {
mc := metrics.NewMetricPrometheusContext("router", "create")
router, err := routers.Create(c.serviceClient, opts).Extract()
if mc.ObserveRequest(err) != nil {
return nil, err
}
return router, nil
}

func (c networkClient) DeleteRouter(id string) error {
mc := metrics.NewMetricPrometheusContext("router", "delete")
return mc.ObserveRequest(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) {
mc := metrics.NewMetricPrometheusContext("router", "update")
router, err := routers.Update(c.serviceClient, id, opts).Extract()
if mc.ObserveRequest(err) != nil {
return nil, err
}
return router, nil
}

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) {
mc := metrics.NewMetricPrometheusContext("security_group", "create")
group, err := groups.Create(c.serviceClient, opts).Extract()
if mc.ObserveRequest(err) != nil {
return nil, err
}
return group, nil
}

func (c networkClient) DeleteSecGroup(id string) error {
mc := metrics.NewMetricPrometheusContext("security_group", "delete")
return mc.ObserveRequest(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) {
mc := metrics.NewMetricPrometheusContext("security_group_rule", "create")
rule, err := rules.Create(c.serviceClient, opts).Extract()
if mc.ObserveRequest(err) != nil {
return nil, err
}
return rule, nil
}

func (c networkClient) DeleteSecGroupRule(id string) error {
mc := metrics.NewMetricPrometheusContext("security_group_rule", "delete")
return mc.ObserveRequest(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) {
mc := metrics.NewMetricPrometheusContext("network", "create")
net, err := networks.Create(c.serviceClient, opts).Extract()
if (mc.ObserveRequest(err)) != nil {
return nil, err
}
return net, nil
}

func (c networkClient) DeleteNetwork(id string) error {
mc := metrics.NewMetricPrometheusContext("network", "delete")
return mc.ObserveRequest(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) {
mc := metrics.NewMetricPrometheusContext("subnet", "create")
subnet, err := subnets.Create(c.serviceClient, opts).Extract()
if mc.ObserveRequest(err) != nil {
return nil, err
}
return subnet, nil
}

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()
}
Loading