Alter existing "deprecated" function to return all migration notices (#159)

This commit is contained in:
Sandeep Rajan 2019-05-13 16:19:36 -04:00 committed by Chris O'Haver
parent 5960d7facb
commit 709b136563
7 changed files with 19 additions and 122 deletions

View file

@ -12,18 +12,11 @@ import (
"github.com/coredns/deployment/kubernetes/migration/corefile"
)
// Deprecated returns a list of deprecated plugins or directives present in the Corefile. Each Notice returned is a
// warning, e.g. "plugin 'foo' is deprecated." An empty list returned means there are no deprecated plugins/options
// present in the Corefile.
// Deprecated returns a list of deprecated, removed, ignored and new default plugins or directives present in the Corefile.
// Each Notice returned is a warning, e.g. "plugin 'foo' is deprecated." An empty list returned means there are no
// deprecated, removed, ignored or new default plugins/options present in the Corefile.
func Deprecated(fromCoreDNSVersion, toCoreDNSVersion, corefileStr string) ([]Notice, error) {
return getStatus(fromCoreDNSVersion, toCoreDNSVersion, corefileStr, deprecated)
}
// Removed returns a list of removed plugins or directives present in the Corefile. Each Notice returned is a warning,
// e.g. "plugin 'foo' is no longer supported." An empty list returned means there are no removed plugins/options
// present in the Corefile.
func Removed(fromCoreDNSVersion, toCoreDNSVersion, corefileStr string) ([]Notice, error) {
return getStatus(fromCoreDNSVersion, toCoreDNSVersion, corefileStr, removed)
return getStatus(fromCoreDNSVersion, toCoreDNSVersion, corefileStr, all)
}
// Unsupported returns a list of plugins that are not recognized/supported by the migration tool (but may still be valid in CoreDNS).
@ -57,10 +50,10 @@ func getStatus(fromCoreDNSVersion, toCoreDNSVersion, corefileStr, status string)
if !present {
continue
}
if vp.status == status {
if vp.status != "" {
notices = append(notices, Notice{
Plugin: p.Name,
Severity: status,
Severity: vp.status,
Version: v,
ReplacedBy: vp.replacedBy,
Additional: vp.additional,
@ -86,8 +79,8 @@ func getStatus(fromCoreDNSVersion, toCoreDNSVersion, corefileStr, status string)
if !present {
continue
}
if vo.status == status {
notices = append(notices, Notice{Plugin: p.Name, Option: o.Name, Severity: status, Version: v})
if vo.status != "" {
notices = append(notices, Notice{Plugin: p.Name, Option: o.Name, Severity: vo.status, Version: v})
continue
}
}

View file

@ -14,7 +14,7 @@ func TestMigrate(t *testing.T) {
expectedCorefile string
}{
{
name: "Remove invalid proxy option",
name: "Remove invalid proxy option",
fromVersion: "1.1.3",
toVersion: "1.2.6",
deprecations: true,
@ -56,7 +56,7 @@ func TestMigrate(t *testing.T) {
`,
},
{
name: "Migrate from proxy to forward and handle Kubernetes deprecations",
name: "Migrate from proxy to forward and handle Kubernetes deprecations",
fromVersion: "1.3.1",
toVersion: "1.5.0",
deprecations: true,
@ -96,7 +96,7 @@ func TestMigrate(t *testing.T) {
`,
},
{
name: "add missing loop and ready plugins",
name: "add missing loop and ready plugins",
fromVersion: "1.1.3",
toVersion: "1.5.0",
deprecations: true,
@ -132,7 +132,6 @@ func TestMigrate(t *testing.T) {
}
`,
},
}
for _, testCase := range testCases {
@ -155,6 +154,7 @@ func TestDeprecated(t *testing.T) {
startCorefile := `.:53 {
errors
health
ready
kubernetes cluster.local in-addr.arpa ip6.arpa {
pods insecure
upstream
@ -172,48 +172,12 @@ func TestDeprecated(t *testing.T) {
expected := []Notice{
{Plugin: "kubernetes", Option: "upstream", Severity: deprecated, Version: "1.4.0"},
{Plugin: "proxy", Severity: deprecated, ReplacedBy: "forward", Version: "1.4.0"},
}
result, err := Deprecated("1.3.1", "1.5.0", startCorefile)
if err != nil {
t.Fatal(err)
}
if len(result) != len(expected) {
t.Fatalf("expected to find %v deprecations; got %v", len(expected), len(result))
}
for i, dep := range expected {
if result[i].ToString() != dep.ToString() {
t.Errorf("expected to get '%v'; got '%v'", dep.ToString(), result[i].ToString())
}
}
}
func TestRemoved(t *testing.T) {
startCorefile := `.:53 {
errors
health
kubernetes cluster.local in-addr.arpa ip6.arpa {
pods insecure
upstream
fallthrough in-addr.arpa ip6.arpa
}
prometheus :9153
proxy . /etc/resolv.conf
cache 30
loop
reload
loadbalance
}
`
expected := []Notice{
{Plugin: "ready", Severity: newdefault, Version: "1.5.0"},
{Option: "upstream", Plugin: "kubernetes", Severity: ignored, Version: "1.5.0"},
{Plugin: "proxy", Severity: removed, ReplacedBy: "forward", Version: "1.5.0"},
}
result, err := Removed("1.3.1", "1.5.0", startCorefile)
result, err := Deprecated("1.3.1", "1.5.0", startCorefile)
if err != nil {
t.Fatal(err)

View file

@ -41,4 +41,5 @@ const (
removed = "removed" // plugin/option has been removed from CoreDNS
unsupported = "unsupported" // plugin/option is not supported by the migration tool
newdefault = "newdefault" // plugin/option was added to the default corefile
all = "all" // all plugin/option that are deprecated, ignored, removed and new defaults.
)