/* Copyright 2017 the Heptio Ark contributors. 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 backup import ( "bytes" "compress/gzip" "io" "reflect" "sort" "testing" "time" "github.com/pkg/errors" "github.com/sirupsen/logrus" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/mock" "github.com/stretchr/testify/require" "k8s.io/apimachinery/pkg/api/meta" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" "k8s.io/apimachinery/pkg/labels" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/runtime/schema" "github.com/heptio/ark/pkg/apis/ark/v1" "github.com/heptio/ark/pkg/client" "github.com/heptio/ark/pkg/cloudprovider" "github.com/heptio/ark/pkg/discovery" "github.com/heptio/ark/pkg/podexec" "github.com/heptio/ark/pkg/restic" "github.com/heptio/ark/pkg/util/collections" kubeutil "github.com/heptio/ark/pkg/util/kube" arktest "github.com/heptio/ark/pkg/util/test" ) var ( trueVal = true falseVal = false truePointer = &trueVal falsePointer = &falseVal ) type fakeAction struct { selector ResourceSelector ids []string backups []v1.Backup additionalItems []ResourceIdentifier } var _ ItemAction = &fakeAction{} func newFakeAction(resource string) *fakeAction { return (&fakeAction{}).ForResource(resource) } func (a *fakeAction) Execute(item runtime.Unstructured, backup *v1.Backup) (runtime.Unstructured, []ResourceIdentifier, error) { metadata, err := meta.Accessor(item) if err != nil { return item, a.additionalItems, err } a.ids = append(a.ids, kubeutil.NamespaceAndName(metadata)) a.backups = append(a.backups, *backup) return item, a.additionalItems, nil } func (a *fakeAction) AppliesTo() (ResourceSelector, error) { return a.selector, nil } func (a *fakeAction) ForResource(resource string) *fakeAction { a.selector.IncludedResources = []string{resource} return a } func TestResolveActions(t *testing.T) { tests := []struct { name string input []ItemAction expected []resolvedAction resourcesWithErrors []string expectError bool }{ { name: "empty input", input: []ItemAction{}, expected: nil, }, { name: "resolve error", input: []ItemAction{&fakeAction{selector: ResourceSelector{LabelSelector: "=invalid-selector"}}}, expected: nil, expectError: true, }, { name: "resolved", input: []ItemAction{newFakeAction("foo"), newFakeAction("bar")}, expected: []resolvedAction{ { ItemAction: newFakeAction("foo"), resourceIncludesExcludes: collections.NewIncludesExcludes().Includes("foodies.somegroup"), namespaceIncludesExcludes: collections.NewIncludesExcludes(), selector: labels.Everything(), }, { ItemAction: newFakeAction("bar"), resourceIncludesExcludes: collections.NewIncludesExcludes().Includes("barnacles.anothergroup"), namespaceIncludesExcludes: collections.NewIncludesExcludes(), selector: labels.Everything(), }, }, }, } for _, test := range tests { t.Run(test.name, func(t *testing.T) { resources := map[schema.GroupVersionResource]schema.GroupVersionResource{ {Resource: "foo"}: {Group: "somegroup", Resource: "foodies"}, {Resource: "fie"}: {Group: "somegroup", Resource: "fields"}, {Resource: "bar"}: {Group: "anothergroup", Resource: "barnacles"}, {Resource: "baz"}: {Group: "anothergroup", Resource: "bazaars"}, } discoveryHelper := arktest.NewFakeDiscoveryHelper(false, resources) actual, err := resolveActions(test.input, discoveryHelper) gotError := err != nil if e, a := test.expectError, gotError; e != a { t.Fatalf("error: expected %t, got %t", e, a) } if test.expectError { return } assert.Equal(t, test.expected, actual) }) } } func TestGetResourceIncludesExcludes(t *testing.T) { tests := []struct { name string includes []string excludes []string resourcesWithErrors []string expectedIncludes []string expectedExcludes []string }{ { name: "no input", expectedIncludes: []string{}, expectedExcludes: []string{}, }, { name: "wildcard includes", includes: []string{"*", "asdf"}, excludes: []string{}, expectedIncludes: []string{"*"}, expectedExcludes: []string{}, }, { name: "wildcard excludes aren't allowed or resolved", includes: []string{}, excludes: []string{"*"}, expectedIncludes: []string{}, expectedExcludes: []string{}, }, { name: "resolution works", includes: []string{"foo", "fie"}, excludes: []string{"bar", "baz"}, expectedIncludes: []string{"foodies.somegroup", "fields.somegroup"}, expectedExcludes: []string{"barnacles.anothergroup", "bazaars.anothergroup"}, }, { name: "some unresolvable", includes: []string{"foo", "fie", "bad1"}, excludes: []string{"bar", "baz", "bad2"}, expectedIncludes: []string{"foodies.somegroup", "fields.somegroup"}, expectedExcludes: []string{"barnacles.anothergroup", "bazaars.anothergroup"}, }, } for _, test := range tests { t.Run(test.name, func(t *testing.T) { resources := map[schema.GroupVersionResource]schema.GroupVersionResource{ {Resource: "foo"}: {Group: "somegroup", Resource: "foodies"}, {Resource: "fie"}: {Group: "somegroup", Resource: "fields"}, {Resource: "bar"}: {Group: "anothergroup", Resource: "barnacles"}, {Resource: "baz"}: {Group: "anothergroup", Resource: "bazaars"}, } discoveryHelper := arktest.NewFakeDiscoveryHelper(false, resources) actual := getResourceIncludesExcludes(discoveryHelper, test.includes, test.excludes) sort.Strings(test.expectedIncludes) actualIncludes := actual.GetIncludes() sort.Strings(actualIncludes) if e, a := test.expectedIncludes, actualIncludes; !reflect.DeepEqual(e, a) { t.Errorf("includes: expected %v, got %v", e, a) } sort.Strings(test.expectedExcludes) actualExcludes := actual.GetExcludes() sort.Strings(actualExcludes) if e, a := test.expectedExcludes, actualExcludes; !reflect.DeepEqual(e, a) { t.Errorf("excludes: expected %v, got %v", e, a) t.Errorf("excludes: expected %v, got %v", len(e), len(a)) } }) } } func TestGetNamespaceIncludesExcludes(t *testing.T) { backup := &v1.Backup{ Spec: v1.BackupSpec{ IncludedResources: []string{"foo", "bar"}, ExcludedResources: []string{"fie", "baz"}, IncludedNamespaces: []string{"a", "b", "c"}, ExcludedNamespaces: []string{"d", "e", "f"}, TTL: metav1.Duration{Duration: 1 * time.Hour}, }, } ns := getNamespaceIncludesExcludes(backup) actualIncludes := ns.GetIncludes() sort.Strings(actualIncludes) if e, a := backup.Spec.IncludedNamespaces, actualIncludes; !reflect.DeepEqual(e, a) { t.Errorf("includes: expected %v, got %v", e, a) } actualExcludes := ns.GetExcludes() sort.Strings(actualExcludes) if e, a := backup.Spec.ExcludedNamespaces, actualExcludes; !reflect.DeepEqual(e, a) { t.Errorf("excludes: expected %v, got %v", e, a) } } var ( v1Group = &metav1.APIResourceList{ GroupVersion: "v1", APIResources: []metav1.APIResource{configMapsResource, podsResource, namespacesResource}, } configMapsResource = metav1.APIResource{ Name: "configmaps", SingularName: "configmap", Namespaced: true, Kind: "ConfigMap", Verbs: metav1.Verbs([]string{"create", "update", "get", "list", "watch", "delete"}), ShortNames: []string{"cm"}, Categories: []string{"all"}, } podsResource = metav1.APIResource{ Name: "pods", SingularName: "pod", Namespaced: true, Kind: "Pod", Verbs: metav1.Verbs([]string{"create", "update", "get", "list", "watch", "delete"}), ShortNames: []string{"po"}, Categories: []string{"all"}, } rbacGroup = &metav1.APIResourceList{ GroupVersion: "rbac.authorization.k8s.io/v1beta1", APIResources: []metav1.APIResource{rolesResource}, } rolesResource = metav1.APIResource{ Name: "roles", SingularName: "role", Namespaced: true, Kind: "Role", Verbs: metav1.Verbs([]string{"create", "update", "get", "list", "watch", "delete"}), } namespacesResource = metav1.APIResource{ Name: "namespaces", SingularName: "namespace", Namespaced: false, Kind: "Namespace", Verbs: metav1.Verbs([]string{"create", "update", "get", "list", "watch", "delete"}), } certificatesGroup = &metav1.APIResourceList{ GroupVersion: "certificates.k8s.io/v1beta1", APIResources: []metav1.APIResource{certificateSigningRequestsResource}, } certificateSigningRequestsResource = metav1.APIResource{ Name: "certificatesigningrequests", SingularName: "certificatesigningrequest", Namespaced: false, Kind: "CertificateSigningRequest", Verbs: metav1.Verbs([]string{"create", "update", "get", "list", "watch", "delete"}), ShortNames: []string{"csr"}, } extensionsGroup = &metav1.APIResourceList{ GroupVersion: "extensions/v1beta1", APIResources: []metav1.APIResource{deploymentsResource, networkPoliciesResource}, } extensionsGroupVersion = schema.GroupVersion{ Group: "extensions", Version: "v1beta1", } appsGroup = &metav1.APIResourceList{ GroupVersion: "apps/v1beta1", APIResources: []metav1.APIResource{deploymentsResource}, } appsGroupVersion = schema.GroupVersion{ Group: "apps", Version: "v1beta1", } deploymentsResource = metav1.APIResource{ Name: "deployments", SingularName: "deployment", Namespaced: true, Kind: "Deployment", Verbs: metav1.Verbs([]string{"create", "update", "get", "list", "watch", "delete"}), ShortNames: []string{"deploy"}, Categories: []string{"all"}, } networkingGroup = &metav1.APIResourceList{ GroupVersion: "networking.k8s.io/v1", APIResources: []metav1.APIResource{networkPoliciesResource}, } networkingGroupVersion = schema.GroupVersion{ Group: "networking.k8s.io", Version: "v1", } networkPoliciesResource = metav1.APIResource{ Name: "networkpolicies", SingularName: "networkpolicy", Namespaced: true, Kind: "Deployment", Verbs: metav1.Verbs([]string{"create", "update", "get", "list", "watch", "delete"}), } ) func parseLabelSelectorOrDie(s string) labels.Selector { ret, err := labels.Parse(s) if err != nil { panic(err) } return ret } func TestBackup(t *testing.T) { tests := []struct { name string backup *v1.Backup expectedNamespaces *collections.IncludesExcludes expectedResources *collections.IncludesExcludes expectedLabelSelector string expectedHooks []resourceHook backupGroupErrors map[*metav1.APIResourceList]error expectedError error }{ { name: "happy path, no actions, no label selector, no hooks, no errors", backup: &v1.Backup{ Spec: v1.BackupSpec{ // cm - shortcut in legacy api group // csr - shortcut in certificates.k8s.io api group // roles - fully qualified in rbac.authorization.k8s.io api group IncludedResources: []string{"cm", "csr", "roles"}, IncludedNamespaces: []string{"a", "b"}, ExcludedNamespaces: []string{"c", "d"}, }, }, expectedNamespaces: collections.NewIncludesExcludes().Includes("a", "b").Excludes("c", "d"), expectedResources: collections.NewIncludesExcludes().Includes("configmaps", "certificatesigningrequests.certificates.k8s.io", "roles.rbac.authorization.k8s.io"), expectedHooks: []resourceHook{}, backupGroupErrors: map[*metav1.APIResourceList]error{ v1Group: nil, certificatesGroup: nil, rbacGroup: nil, }, }, { name: "label selector", backup: &v1.Backup{ Spec: v1.BackupSpec{ LabelSelector: &metav1.LabelSelector{ MatchLabels: map[string]string{"a": "b"}, }, }, }, expectedNamespaces: collections.NewIncludesExcludes(), expectedResources: collections.NewIncludesExcludes(), expectedHooks: []resourceHook{}, expectedLabelSelector: "a=b", backupGroupErrors: map[*metav1.APIResourceList]error{ v1Group: nil, certificatesGroup: nil, rbacGroup: nil, }, }, { name: "backupGroup errors", backup: &v1.Backup{}, expectedNamespaces: collections.NewIncludesExcludes(), expectedResources: collections.NewIncludesExcludes(), expectedHooks: []resourceHook{}, backupGroupErrors: map[*metav1.APIResourceList]error{ v1Group: errors.New("v1 error"), certificatesGroup: nil, rbacGroup: errors.New("rbac error"), }, expectedError: errors.New("[v1 error, rbac error]"), }, { name: "hooks", backup: &v1.Backup{ Spec: v1.BackupSpec{ Hooks: v1.BackupHooks{ Resources: []v1.BackupResourceHookSpec{ { Name: "hook1", IncludedNamespaces: []string{"a"}, ExcludedNamespaces: []string{"b"}, IncludedResources: []string{"cm"}, ExcludedResources: []string{"roles"}, LabelSelector: &metav1.LabelSelector{ MatchLabels: map[string]string{"1": "2"}, }, Hooks: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Command: []string{"ls", "/tmp"}, }, }, }, }, }, }, }, }, expectedNamespaces: collections.NewIncludesExcludes(), expectedResources: collections.NewIncludesExcludes(), expectedHooks: []resourceHook{ { name: "hook1", namespaces: collections.NewIncludesExcludes().Includes("a").Excludes("b"), resources: collections.NewIncludesExcludes().Includes("configmaps").Excludes("roles.rbac.authorization.k8s.io"), labelSelector: parseLabelSelectorOrDie("1=2"), pre: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Command: []string{"ls", "/tmp"}, }, }, }, }, }, backupGroupErrors: map[*metav1.APIResourceList]error{ v1Group: nil, certificatesGroup: nil, rbacGroup: nil, }, }, } for _, test := range tests { t.Run(test.name, func(t *testing.T) { discoveryHelper := &arktest.FakeDiscoveryHelper{ Mapper: &arktest.FakeMapper{ Resources: map[schema.GroupVersionResource]schema.GroupVersionResource{ {Resource: "cm"}: {Group: "", Version: "v1", Resource: "configmaps"}, {Resource: "csr"}: {Group: "certificates.k8s.io", Version: "v1beta1", Resource: "certificatesigningrequests"}, {Resource: "roles"}: {Group: "rbac.authorization.k8s.io", Version: "v1beta1", Resource: "roles"}, }, }, ResourceList: []*metav1.APIResourceList{ v1Group, certificatesGroup, rbacGroup, }, } dynamicFactory := &arktest.FakeDynamicFactory{} podCommandExecutor := &arktest.MockPodCommandExecutor{} defer podCommandExecutor.AssertExpectations(t) b, err := NewKubernetesBackupper( discoveryHelper, dynamicFactory, podCommandExecutor, nil, nil, // restic backupper factory 0, // restic timeout ) require.NoError(t, err) kb := b.(*kubernetesBackupper) groupBackupperFactory := &mockGroupBackupperFactory{} defer groupBackupperFactory.AssertExpectations(t) kb.groupBackupperFactory = groupBackupperFactory groupBackupper := &mockGroupBackupper{} defer groupBackupper.AssertExpectations(t) groupBackupperFactory.On("newGroupBackupper", mock.Anything, // log test.backup, test.expectedNamespaces, test.expectedResources, dynamicFactory, discoveryHelper, map[itemKey]struct{}{}, // backedUpItems cohabitatingResources(), mock.Anything, kb.podCommandExecutor, mock.Anything, // tarWriter test.expectedHooks, mock.Anything, mock.Anything, // restic backupper mock.Anything, // pvc snapshot tracker ).Return(groupBackupper) for group, err := range test.backupGroupErrors { groupBackupper.On("backupGroup", group).Return(err) } var backupFile, logFile bytes.Buffer err = b.Backup(test.backup, &backupFile, &logFile, nil) defer func() { // print log if anything failed if t.Failed() { gzr, err := gzip.NewReader(&logFile) require.NoError(t, err) t.Log("Backup log contents:") var buf bytes.Buffer _, err = io.Copy(&buf, gzr) require.NoError(t, err) require.NoError(t, gzr.Close()) t.Log(buf.String()) } }() if test.expectedError != nil { assert.EqualError(t, err, test.expectedError.Error()) return } assert.NoError(t, err) }) } } func TestBackupUsesNewCohabitatingResourcesForEachBackup(t *testing.T) { discoveryHelper := &arktest.FakeDiscoveryHelper{ Mapper: &arktest.FakeMapper{ Resources: map[schema.GroupVersionResource]schema.GroupVersionResource{}, }, } b, err := NewKubernetesBackupper(discoveryHelper, nil, nil, nil, nil, 0) require.NoError(t, err) kb := b.(*kubernetesBackupper) groupBackupperFactory := &mockGroupBackupperFactory{} kb.groupBackupperFactory = groupBackupperFactory // assert that newGroupBackupper() is called with the result of cohabitatingResources() // passed as an argument. firstCohabitatingResources := cohabitatingResources() groupBackupperFactory.On("newGroupBackupper", mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, discoveryHelper, mock.Anything, firstCohabitatingResources, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, ).Return(&mockGroupBackupper{}) assert.NoError(t, b.Backup(&v1.Backup{}, &bytes.Buffer{}, &bytes.Buffer{}, nil)) groupBackupperFactory.AssertExpectations(t) // mutate the cohabitatingResources map that was used in the first backup to simulate // the first backup process having done so. for _, value := range firstCohabitatingResources { value.seen = true } // assert that on a second backup, newGroupBackupper() is called with the result of // cohabitatingResources() passed as an argument, that the value is not the // same as the mutated firstCohabitatingResources value, and that all of the `seen` // flags are false as they should be for a new instance secondCohabitatingResources := cohabitatingResources() groupBackupperFactory.On("newGroupBackupper", mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, discoveryHelper, mock.Anything, secondCohabitatingResources, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, ).Return(&mockGroupBackupper{}) assert.NoError(t, b.Backup(&v1.Backup{}, &bytes.Buffer{}, &bytes.Buffer{}, nil)) assert.NotEqual(t, firstCohabitatingResources, secondCohabitatingResources) for _, resource := range secondCohabitatingResources { assert.False(t, resource.seen) } groupBackupperFactory.AssertExpectations(t) } type mockGroupBackupperFactory struct { mock.Mock } func (f *mockGroupBackupperFactory) newGroupBackupper( log logrus.FieldLogger, backup *v1.Backup, namespaces, resources *collections.IncludesExcludes, dynamicFactory client.DynamicFactory, discoveryHelper discovery.Helper, backedUpItems map[itemKey]struct{}, cohabitatingResources map[string]*cohabitatingResource, actions []resolvedAction, podCommandExecutor podexec.PodCommandExecutor, tarWriter tarWriter, resourceHooks []resourceHook, snapshotService cloudprovider.SnapshotService, resticBackupper restic.Backupper, resticSnapshotTracker *pvcSnapshotTracker, ) groupBackupper { args := f.Called( log, backup, namespaces, resources, dynamicFactory, discoveryHelper, backedUpItems, cohabitatingResources, actions, podCommandExecutor, tarWriter, resourceHooks, snapshotService, resticBackupper, resticSnapshotTracker, ) return args.Get(0).(groupBackupper) } type mockGroupBackupper struct { mock.Mock } func (gb *mockGroupBackupper) backupGroup(group *metav1.APIResourceList) error { args := gb.Called(group) return args.Error(0) } func toRuntimeObject(t *testing.T, data string) runtime.Object { o, _, err := unstructured.UnstructuredJSONScheme.Decode([]byte(data), nil, nil) require.NoError(t, err) return o } func TestGetResourceHook(t *testing.T) { tests := []struct { name string hookSpec v1.BackupResourceHookSpec expected resourceHook }{ { name: "PreHooks take priority over Hooks", hookSpec: v1.BackupResourceHookSpec{ Name: "spec1", PreHooks: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Container: "a", Command: []string{"b"}, }, }, }, Hooks: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Container: "c", Command: []string{"d"}, }, }, }, }, expected: resourceHook{ name: "spec1", namespaces: collections.NewIncludesExcludes(), resources: collections.NewIncludesExcludes(), pre: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Container: "a", Command: []string{"b"}, }, }, }, }, }, { name: "Use Hooks if PreHooks isn't set", hookSpec: v1.BackupResourceHookSpec{ Name: "spec1", Hooks: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Container: "a", Command: []string{"b"}, }, }, }, }, expected: resourceHook{ name: "spec1", namespaces: collections.NewIncludesExcludes(), resources: collections.NewIncludesExcludes(), pre: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Container: "a", Command: []string{"b"}, }, }, }, }, }, { name: "Full test", hookSpec: v1.BackupResourceHookSpec{ Name: "spec1", IncludedNamespaces: []string{"ns1", "ns2"}, ExcludedNamespaces: []string{"ns3", "ns4"}, IncludedResources: []string{"foo", "fie"}, ExcludedResources: []string{"bar", "baz"}, PreHooks: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Container: "a", Command: []string{"b"}, }, }, }, PostHooks: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Container: "c", Command: []string{"d"}, }, }, }, }, expected: resourceHook{ name: "spec1", namespaces: collections.NewIncludesExcludes().Includes("ns1", "ns2").Excludes("ns3", "ns4"), resources: collections.NewIncludesExcludes().Includes("foodies.somegroup", "fields.somegroup").Excludes("barnacles.anothergroup", "bazaars.anothergroup"), pre: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Container: "a", Command: []string{"b"}, }, }, }, post: []v1.BackupResourceHook{ { Exec: &v1.ExecHook{ Container: "c", Command: []string{"d"}, }, }, }, }, }, } for _, test := range tests { t.Run(test.name, func(t *testing.T) { resources := map[schema.GroupVersionResource]schema.GroupVersionResource{ {Resource: "foo"}: {Group: "somegroup", Resource: "foodies"}, {Resource: "fie"}: {Group: "somegroup", Resource: "fields"}, {Resource: "bar"}: {Group: "anothergroup", Resource: "barnacles"}, {Resource: "baz"}: {Group: "anothergroup", Resource: "bazaars"}, } discoveryHelper := arktest.NewFakeDiscoveryHelper(false, resources) actual, err := getResourceHook(test.hookSpec, discoveryHelper) require.NoError(t, err) assert.Equal(t, test.expected, actual) }) } }