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.

Sign up for GitHub

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

Jump to bottom

Add pkg/common/operator & pkg/common/typed to make resource joins much cleaner. #517

Merged
merged 3 commits into from
Nov 26, 2018
Merged

Add pkg/common/operator & pkg/common/typed to make resource joins much cleaner. #517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f48729e
Add pkg/common/typed for easier use of Store API for
rramkumar1 Oct 19, 2018
de70cac
Add pkg/common/operator for easier joining of resources
rramkumar1 Oct 19, 2018
b357d0c
Integrate pkg/common/typed and pkg/common/operator into existing code
rramkumar1 Oct 19, 2018
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
36 changes: 0 additions & 36 deletions pkg/backendconfig/backendconfig.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ package backendconfig
import (
"errors"

"github.com/golang/glog"

apiv1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/tools/cache"
Expand Down Expand Up @@ -50,40 +48,6 @@ func CRDMeta() *crd.CRDMeta {
return meta
}

// GetServicesForBackendConfig returns all services that reference the given
// BackendConfig.
func GetServicesForBackendConfig(svcLister cache.Store, backendConfig *backendconfigv1beta1.BackendConfig) []*apiv1.Service {
svcs := []*apiv1.Service{}
for _, obj := range svcLister.List() {
svc := obj.(*apiv1.Service)
if svc.Namespace != backendConfig.Namespace {
continue
}
backendConfigNames, err := annotations.FromService(svc).GetBackendConfigs()
if err != nil {
// If the user did not provide the annotation at all, then we
// do not want to log an error.
if err != annotations.ErrBackendConfigAnnotationMissing {
glog.Errorf("Failed to get BackendConfig names from service %s/%s: %v", svc.Namespace, svc.Name, err)
}
continue
}
if backendConfigNames != nil {
if backendConfigNames.Default == backendConfig.Name {
svcs = append(svcs, svc)
continue
}
for _, backendConfigName := range backendConfigNames.Ports {
if backendConfigName == backendConfig.Name {
svcs = append(svcs, svc)
break
}
}
}
}
return svcs
}

// GetBackendConfigForServicePort returns the corresponding BackendConfig for
// the given ServicePort if specified.
func GetBackendConfigForServicePort(backendConfigLister cache.Store, svc *apiv1.Service, svcPort *apiv1.ServicePort) (*backendconfigv1beta1.BackendConfig, error) {
Expand Down
259 changes: 13 additions & 246 deletions pkg/backendconfig/backendconfig_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,244 +22,11 @@ import (
"testing"

apiv1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/client-go/tools/cache"

"k8s.io/ingress-gce/pkg/annotations"
backendconfigv1beta1 "k8s.io/ingress-gce/pkg/apis/backendconfig/v1beta1"
)

var (
testBackendConfig = &backendconfigv1beta1.BackendConfig{
ObjectMeta: metav1.ObjectMeta{
Name: "config-test",
Namespace: "test",
},
}

svcWithoutConfig = &apiv1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "svc-no-config",
Namespace: "test",
},
Spec: apiv1.ServiceSpec{
Ports: []apiv1.ServicePort{
{Name: "port1"},
},
},
}

svcWithTestConfig = &apiv1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "svc-test-config",
Namespace: "test",
Annotations: map[string]string{
annotations.BackendConfigKey: `{"ports": {"port1": "config-test"}}`,
},
},
Spec: apiv1.ServiceSpec{
Ports: []apiv1.ServicePort{
{Name: "port1"},
},
},
}

svcWithTestConfigPortNumber = &apiv1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "svc-test-config-port-number",
Namespace: "test",
Annotations: map[string]string{
annotations.BackendConfigKey: `{"ports": {"443": "config-test"}}`,
},
},
Spec: apiv1.ServiceSpec{
Ports: []apiv1.ServicePort{
{Port: 443},
},
},
}

svcWithTestConfigMismatchPort = &apiv1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "svc-test-config-mismatch-port",
Namespace: "test",
Annotations: map[string]string{
annotations.BackendConfigKey: `{"ports": {"port2": "config-test"}}`,
},
},
Spec: apiv1.ServiceSpec{
Ports: []apiv1.ServicePort{
{Name: "port1"},
},
},
}

svcWithDefaultTestConfig = &apiv1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "svc-default-test-config",
Namespace: "test",
Annotations: map[string]string{
annotations.BackendConfigKey: `{"default": "config-test"}`,
},
},
Spec: apiv1.ServiceSpec{
Ports: []apiv1.ServicePort{
{Name: "port1"},
},
},
}

svcWithTestConfigOtherNamespace = &apiv1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "svc-test-config",
Namespace: "other-namespace",
Annotations: map[string]string{
annotations.BackendConfigKey: `{"ports": {"port1": "config-test"}}`,
},
},
Spec: apiv1.ServiceSpec{
Ports: []apiv1.ServicePort{
{Name: "port1"},
},
},
}

svcWithOtherConfig = &apiv1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "svc-other-config",
Namespace: "test",
Annotations: map[string]string{
annotations.BackendConfigKey: `{"ports": {"port1": "config-other"}}`,
},
},
Spec: apiv1.ServiceSpec{
Ports: []apiv1.ServicePort{
{Name: "port1"},
},
},
}

svcWithDefaultOtherConfig = &apiv1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "svc-default-other-config",
Namespace: "test",
Annotations: map[string]string{
annotations.BackendConfigKey: `{"default": "config-other"}`,
},
},
Spec: apiv1.ServiceSpec{
Ports: []apiv1.ServicePort{
{Name: "port1"},
},
},
}

svcWithInvalidConfig = &apiv1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "svc-invalid-config",
Namespace: "test",
Annotations: map[string]string{
annotations.BackendConfigKey: `invalid`,
},
},
Spec: apiv1.ServiceSpec{
Ports: []apiv1.ServicePort{
{Name: "port1"},
},
},
}
)

func TestGetServicesForBackendConfig(t *testing.T) {
testCases := []struct {
desc string
listFunc func() []interface{}
expectedSvcs []*apiv1.Service
}{
{
desc: "should filter service with no backend config",
listFunc: func() []interface{} {
return []interface{}{svcWithoutConfig}
},
},
{
desc: "should include service with test backend config",
listFunc: func() []interface{} {
return []interface{}{svcWithTestConfig}
},
expectedSvcs: []*apiv1.Service{svcWithTestConfig},
},
{
desc: "should include service with default test backend config",
listFunc: func() []interface{} {
return []interface{}{svcWithDefaultTestConfig}
},
expectedSvcs: []*apiv1.Service{svcWithDefaultTestConfig},
},
{
desc: "should filter service with test backend config in a different namespace",
listFunc: func() []interface{} {
return []interface{}{svcWithTestConfigOtherNamespace}
},
},
{
desc: "should filter service with a different backend config",
listFunc: func() []interface{} {
return []interface{}{svcWithOtherConfig}
},
},
{
desc: "should filter service with a different default backend config",
listFunc: func() []interface{} {
return []interface{}{svcWithDefaultOtherConfig}
},
},
{
desc: "should filter service with invalid backend config",
listFunc: func() []interface{} {
return []interface{}{svcWithInvalidConfig}
},
},
{
desc: "mixed together: should only include services with corresponding backend config",
listFunc: func() []interface{} {
return []interface{}{
svcWithoutConfig,
svcWithTestConfig,
svcWithDefaultTestConfig,
svcWithTestConfigOtherNamespace,
svcWithOtherConfig,
svcWithDefaultOtherConfig,
svcWithInvalidConfig,
}
},
expectedSvcs: []*apiv1.Service{
svcWithTestConfig,
svcWithDefaultTestConfig,
},
},
}

for _, tc := range testCases {
fakeStore := &cache.FakeCustomStore{
ListFunc: tc.listFunc,
}
svcs := GetServicesForBackendConfig(fakeStore, testBackendConfig)
if !sets.NewString(convertServicesToNamespacedNames(svcs)...).Equal(sets.NewString(convertServicesToNamespacedNames(tc.expectedSvcs)...)) {
t.Errorf("%s: unexpected services, got %v, want %v", tc.desc, svcs, tc.expectedSvcs)
}
}
}

func convertServicesToNamespacedNames(svcs []*apiv1.Service) []string {
svcNames := []string{}
for _, svc := range svcs {
svcNames = append(svcNames, fmt.Sprintf("%s:%s", svc.Namespace, svc.Name))
}
return svcNames
}

func TestGetBackendConfigForServicePort(t *testing.T) {
testCases := []struct {
desc string
Expand All @@ -271,45 +38,45 @@ func TestGetBackendConfigForServicePort(t *testing.T) {
}{
{
desc: "service port name with backend config",
svc: svcWithTestConfig,
svc: SvcWithTestConfig,
svcPort: &apiv1.ServicePort{Name: "port1"},
getFunc: func(obj interface{}) (interface{}, bool, error) {
return testBackendConfig, true, nil
return TestBackendConfig, true, nil
},
expectedConfig: testBackendConfig,
expectedConfig: TestBackendConfig,
},
{
desc: "service port number with backend config",
svc: svcWithTestConfigPortNumber,
svc: SvcWithTestConfigPortNumber,
svcPort: &apiv1.ServicePort{Port: 443},
getFunc: func(obj interface{}) (interface{}, bool, error) {
return testBackendConfig, true, nil
return TestBackendConfig, true, nil
},
expectedConfig: testBackendConfig,
expectedConfig: TestBackendConfig,
},
{
desc: "service with default backend config",
svc: svcWithDefaultTestConfig,
svc: SvcWithDefaultTestConfig,
svcPort: &apiv1.ServicePort{Name: "port1"},
getFunc: func(obj interface{}) (interface{}, bool, error) {
return testBackendConfig, true, nil
return TestBackendConfig, true, nil
},
expectedConfig: testBackendConfig,
expectedConfig: TestBackendConfig,
},
{
desc: "service with no backend config",
svc: svcWithoutConfig,
svc: SvcWithoutConfig,
expectedConfig: nil,
},
{
desc: "service with backend config but port doesn't match",
svc: svcWithTestConfigMismatchPort,
svc: SvcWithTestConfigMismatchPort,
svcPort: &apiv1.ServicePort{Name: "port1"},
expectedErr: ErrNoBackendConfigForPort,
},
{
desc: "service port matches backend config but config not exist",
svc: svcWithTestConfig,
svc: SvcWithTestConfig,
svcPort: &apiv1.ServicePort{Name: "port1"},
getFunc: func(obj interface{}) (interface{}, bool, error) {
return nil, false, nil
Expand All @@ -318,7 +85,7 @@ func TestGetBackendConfigForServicePort(t *testing.T) {
},
{
desc: "service port matches backend config but failed to retrieve config",
svc: svcWithTestConfig,
svc: SvcWithTestConfig,
svcPort: &apiv1.ServicePort{Name: "port1"},
getFunc: func(obj interface{}) (interface{}, bool, error) {
return nil, false, fmt.Errorf("internal error")
Expand Down
Loading