controller_test.go 4.68 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
Copyright 2017 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 controller

import (
20
	"context"
21
	"errors"
22
	"reflect"
23 24
	"testing"

25 26 27 28 29
	"sigs.k8s.io/external-dns/endpoint"
	"sigs.k8s.io/external-dns/internal/testutils"
	"sigs.k8s.io/external-dns/plan"
	"sigs.k8s.io/external-dns/provider"
	"sigs.k8s.io/external-dns/registry"
30 31 32

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
33 34
)

35 36
// mockProvider returns mock endpoints and validates changes.
type mockProvider struct {
37
	RecordsStore  []*endpoint.Endpoint
38 39
	ExpectChanges *plan.Changes
}
40

41
// Records returns the desired mock endpoints.
42
func (p *mockProvider) Records(ctx context.Context) ([]*endpoint.Endpoint, error) {
43
	return p.RecordsStore, nil
44 45
}

46
// ApplyChanges validates that the passed in changes satisfy the assumtions.
47
func (p *mockProvider) ApplyChanges(ctx context.Context, changes *plan.Changes) error {
48
	if len(changes.Create) != len(p.ExpectChanges.Create) {
49 50 51
		return errors.New("number of created records is wrong")
	}

52
	for i := range changes.Create {
53
		if changes.Create[i].DNSName != p.ExpectChanges.Create[i].DNSName || !changes.Create[i].Targets.Same(p.ExpectChanges.Create[i].Targets) {
54 55 56 57 58
			return errors.New("created record is wrong")
		}
	}

	for i := range changes.UpdateNew {
59
		if changes.UpdateNew[i].DNSName != p.ExpectChanges.UpdateNew[i].DNSName || !changes.UpdateNew[i].Targets.Same(p.ExpectChanges.UpdateNew[i].Targets) {
60 61 62 63 64
			return errors.New("delete record is wrong")
		}
	}

	for i := range changes.UpdateOld {
65
		if changes.UpdateOld[i].DNSName != p.ExpectChanges.UpdateOld[i].DNSName || !changes.UpdateOld[i].Targets.Same(p.ExpectChanges.UpdateOld[i].Targets) {
66 67 68
			return errors.New("delete record is wrong")
		}
	}
69

70
	for i := range changes.Delete {
71
		if changes.Delete[i].DNSName != p.ExpectChanges.Delete[i].DNSName || !changes.Delete[i].Targets.Same(p.ExpectChanges.Delete[i].Targets) {
72 73
			return errors.New("delete record is wrong")
		}
74 75
	}

76 77 78
	if !reflect.DeepEqual(ctx.Value(provider.RecordsContextKey), p.RecordsStore) {
		return errors.New("context is wrong")
	}
79 80 81
	return nil
}

82
// newMockProvider creates a new mockProvider returning the given endpoints and validating the desired changes.
83
func newMockProvider(endpoints []*endpoint.Endpoint, changes *plan.Changes) provider.Provider {
84
	dnsProvider := &mockProvider{
85 86 87 88 89 90 91
		RecordsStore:  endpoints,
		ExpectChanges: changes,
	}

	return dnsProvider
}

92 93
// TestRunOnce tests that RunOnce correctly orchestrates the different components.
func TestRunOnce(t *testing.T) {
94
	// Fake some desired endpoints coming from our source.
95 96 97
	source := new(testutils.MockSource)
	source.On("Endpoints").Return([]*endpoint.Endpoint{
		{
98 99 100
			DNSName:    "create-record",
			RecordType: endpoint.RecordTypeA,
			Targets:    endpoint.Targets{"1.2.3.4"},
101
		},
102
		{
103 104 105
			DNSName:    "update-record",
			RecordType: endpoint.RecordTypeA,
			Targets:    endpoint.Targets{"8.8.4.4"},
106 107
		},
	}, nil)
108 109

	// Fake some existing records in our DNS provider and validate some desired changes.
110
	provider := newMockProvider(
111
		[]*endpoint.Endpoint{
112
			{
113 114 115
				DNSName:    "update-record",
				RecordType: endpoint.RecordTypeA,
				Targets:    endpoint.Targets{"8.8.8.8"},
116 117
			},
			{
118 119 120
				DNSName:    "delete-record",
				RecordType: endpoint.RecordTypeA,
				Targets:    endpoint.Targets{"4.3.2.1"},
121 122 123
			},
		},
		&plan.Changes{
124
			Create: []*endpoint.Endpoint{
125
				{DNSName: "create-record", RecordType: endpoint.RecordTypeA, Targets: endpoint.Targets{"1.2.3.4"}},
126
			},
127
			UpdateNew: []*endpoint.Endpoint{
128
				{DNSName: "update-record", RecordType: endpoint.RecordTypeA, Targets: endpoint.Targets{"8.8.4.4"}},
129
			},
130
			UpdateOld: []*endpoint.Endpoint{
131
				{DNSName: "update-record", RecordType: endpoint.RecordTypeA, Targets: endpoint.Targets{"8.8.8.8"}},
132
			},
133
			Delete: []*endpoint.Endpoint{
134
				{DNSName: "delete-record", RecordType: endpoint.RecordTypeA, Targets: endpoint.Targets{"4.3.2.1"}},
135 136 137
			},
		},
	)
138

139 140
	r, err := registry.NewNoopRegistry(provider)
	require.NoError(t, err)
Yerken's avatar
Yerken committed
141

142 143
	// Run our controller once to trigger the validation.
	ctrl := &Controller{
144
		Source:   source,
Yerken's avatar
Yerken committed
145
		Registry: r,
146
		Policy:   &plan.SyncPolicy{},
147 148
	}

149
	assert.NoError(t, ctrl.RunOnce(context.Background()))
150

151 152
	// Validate that the mock source was called.
	source.AssertExpectations(t)
153
}