From 7d2d951f27b2c9e9525f522959cd4648e6057e7b Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 3 May 2017 17:31:46 -0400 Subject: [PATCH] Rename VersionSet to Constraints VersionSet is a wrapper around version.Contraints, so rename it it as such. --- command/providers.go | 2 +- moduledeps/dependencies.go | 4 +- moduledeps/module.go | 10 ++-- moduledeps/module_test.go | 6 +-- plugin/discovery/requirements.go | 4 +- plugin/discovery/version_set.go | 37 +++++++-------- terraform/module_dependencies.go | 12 ++--- terraform/module_dependencies_test.go | 68 +++++++++++++-------------- terraform/test_failure | 9 ++++ 9 files changed, 79 insertions(+), 73 deletions(-) create mode 100644 terraform/test_failure diff --git a/command/providers.go b/command/providers.go index 03bf6feae..6928faaf6 100644 --- a/command/providers.go +++ b/command/providers.go @@ -94,7 +94,7 @@ func providersCommandPopulateTreeNode(node treeprint.Tree, deps *moduledeps.Modu for _, name := range names { dep := deps.Providers[moduledeps.ProviderInstance(name)] - versionsStr := dep.Versions.String() + versionsStr := dep.Constraints.String() if versionsStr != "" { versionsStr = " " + versionsStr } diff --git a/moduledeps/dependencies.go b/moduledeps/dependencies.go index fa999ab2f..87c8431ea 100644 --- a/moduledeps/dependencies.go +++ b/moduledeps/dependencies.go @@ -13,8 +13,8 @@ type Providers map[ProviderInstance]ProviderDependency // instance, including both the set of allowed versions and the reason for // the dependency. type ProviderDependency struct { - Versions discovery.VersionSet - Reason ProviderDependencyReason + Constraints discovery.Constraints + Reason ProviderDependencyReason } // ProviderDependencyReason is an enumeration of reasons why a dependency might be diff --git a/moduledeps/module.go b/moduledeps/module.go index f54f06bfc..d09c19738 100644 --- a/moduledeps/module.go +++ b/moduledeps/module.go @@ -114,9 +114,9 @@ func (m *Module) PluginRequirements() discovery.PluginRequirements { // by using Intersection to merge the version sets. pty := inst.Type() if existing, exists := ret[pty]; exists { - ret[pty] = existing.Intersection(dep.Versions) + ret[pty] = existing.Intersection(dep.Constraints) } else { - ret[pty] = dep.Versions + ret[pty] = dep.Constraints } } return ret @@ -163,7 +163,7 @@ func (m *Module) Equal(other *Module) bool { } // Can't use reflect.DeepEqual on this provider structure because - // the nested VersionSet objects contain function pointers that + // the nested Constraints objects contain function pointers that // never compare as equal. So we'll need to walk it the long way. for inst, dep := range m.Providers { if _, exists := other.Providers[inst]; !exists { @@ -174,10 +174,10 @@ func (m *Module) Equal(other *Module) bool { return false } - // VersionSets are not too easy to compare robustly, so + // Constraints are not too easy to compare robustly, so // we'll just use their string representations as a proxy // for now. - if dep.Versions.String() != other.Providers[inst].Versions.String() { + if dep.Constraints.String() != other.Providers[inst].Constraints.String() { return false } } diff --git a/moduledeps/module_test.go b/moduledeps/module_test.go index 63d907d38..630f3cd8b 100644 --- a/moduledeps/module_test.go +++ b/moduledeps/module_test.go @@ -192,13 +192,13 @@ func TestModulePluginRequirements(t *testing.T) { Name: "root", Providers: Providers{ "foo": ProviderDependency{ - Versions: discovery.ConstraintStr(">=1.0.0").MustParse(), + Constraints: discovery.ConstraintStr(">=1.0.0").MustParse(), }, "foo.bar": ProviderDependency{ - Versions: discovery.ConstraintStr(">=2.0.0").MustParse(), + Constraints: discovery.ConstraintStr(">=2.0.0").MustParse(), }, "baz": ProviderDependency{ - Versions: discovery.ConstraintStr(">=3.0.0").MustParse(), + Constraints: discovery.ConstraintStr(">=3.0.0").MustParse(), }, }, } diff --git a/plugin/discovery/requirements.go b/plugin/discovery/requirements.go index e82909540..4f0857aa6 100644 --- a/plugin/discovery/requirements.go +++ b/plugin/discovery/requirements.go @@ -4,8 +4,8 @@ package discovery // kind) that are required to exist and have versions within the given // corresponding sets. // -// PluginRequirements is a map from plugin name to VersionSet. -type PluginRequirements map[string]VersionSet +// PluginRequirements is a map from plugin name to Constraints. +type PluginRequirements map[string]Constraints // Merge takes the contents of the receiver and the other given requirements // object and merges them together into a single requirements structure diff --git a/plugin/discovery/version_set.go b/plugin/discovery/version_set.go index 3dce045b4..73eae7591 100644 --- a/plugin/discovery/version_set.go +++ b/plugin/discovery/version_set.go @@ -9,18 +9,18 @@ import ( // obtain a real Constraint object, or discover that it is invalid. type ConstraintStr string -// Parse transforms a ConstraintStr into a VersionSet if it is +// Parse transforms a ConstraintStr into a Constraints if it is // syntactically valid. If it isn't then an error is returned instead. -func (s ConstraintStr) Parse() (VersionSet, error) { +func (s ConstraintStr) Parse() (Constraints, error) { raw, err := version.NewConstraint(string(s)) if err != nil { - return VersionSet{}, err + return Constraints{}, err } - return VersionSet{raw}, nil + return Constraints{raw}, nil } // MustParse is like Parse but it panics if the constraint string is invalid. -func (s ConstraintStr) MustParse() VersionSet { +func (s ConstraintStr) MustParse() Constraints { ret, err := s.Parse() if err != nil { panic(err) @@ -28,33 +28,30 @@ func (s ConstraintStr) MustParse() VersionSet { return ret } -// VersionSet represents a set of versions which any given Version is either +// Constraints represents a set of versions which any given Version is either // a member of or not. -type VersionSet struct { - // Internally a version set is actually a list of constraints that - // *remove* versions from the set. Thus a VersionSet with an empty - // Constraints list would be one that contains *all* versions. +type Constraints struct { raw version.Constraints } -// AllVersions is a VersionSet containing all versions -var AllVersions VersionSet +// AllVersions is a Constraints containing all versions +var AllVersions Constraints func init() { - AllVersions = VersionSet{ + AllVersions = Constraints{ raw: make(version.Constraints, 0), } } // Has returns true if the given version is in the receiving set. -func (s VersionSet) Has(v Version) bool { +func (s Constraints) Has(v Version) bool { return s.raw.Check(v.raw) } -// Intersection combines the receving set with the given other set to produce a -// set that is the intersection of both sets, which is to say that it contains -// only the versions that are members of both sets. -func (s VersionSet) Intersection(other VersionSet) VersionSet { +// Intersection combines the receiving set with the given other set to produce +// a set that is the intersection of both sets, which is to say that resulting +// constraints contain only the versions that are members of both. +func (s Constraints) Intersection(other Constraints) Constraints { raw := make(version.Constraints, 0, len(s.raw)+len(other.raw)) // Since "raw" is a list of constraints that remove versions from the set, @@ -63,11 +60,11 @@ func (s VersionSet) Intersection(other VersionSet) VersionSet { raw = append(raw, s.raw...) raw = append(raw, other.raw...) - return VersionSet{raw} + return Constraints{raw} } // String returns a string representation of the set members as a set // of range constraints. -func (s VersionSet) String() string { +func (s Constraints) String() string { return s.raw.String() } diff --git a/terraform/module_dependencies.go b/terraform/module_dependencies.go index ffc6920c8..b9f44a0e8 100644 --- a/terraform/module_dependencies.go +++ b/terraform/module_dependencies.go @@ -62,8 +62,8 @@ func moduleTreeConfigDependencies(root *module.Tree, inheritProviders map[string versionSet = discovery.ConstraintStr(pCfg.Version).MustParse() } providers[inst] = moduledeps.ProviderDependency{ - Versions: versionSet, - Reason: moduledeps.ProviderDependencyExplicit, + Constraints: versionSet, + Reason: moduledeps.ProviderDependencyExplicit, } } @@ -84,8 +84,8 @@ func moduleTreeConfigDependencies(root *module.Tree, inheritProviders map[string } providers[inst] = moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: reason, + Constraints: discovery.AllVersions, + Reason: reason, } } @@ -146,8 +146,8 @@ func moduleTreeMergeStateDependencies(root *moduledeps.Module, state *State) { module.Providers = make(moduledeps.Providers) } module.Providers[inst] = moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyFromState, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyFromState, } } } diff --git a/terraform/module_dependencies_test.go b/terraform/module_dependencies_test.go index 6fced8a80..e63739f81 100644 --- a/terraform/module_dependencies_test.go +++ b/terraform/module_dependencies_test.go @@ -40,12 +40,12 @@ func TestModuleTreeDependencies(t *testing.T) { Name: "root", Providers: moduledeps.Providers{ "foo": moduledeps.ProviderDependency{ - Versions: discovery.ConstraintStr(">=1.0.0").MustParse(), - Reason: moduledeps.ProviderDependencyExplicit, + Constraints: discovery.ConstraintStr(">=1.0.0").MustParse(), + Reason: moduledeps.ProviderDependencyExplicit, }, "foo.bar": moduledeps.ProviderDependency{ - Versions: discovery.ConstraintStr(">=2.0.0").MustParse(), - Reason: moduledeps.ProviderDependencyExplicit, + Constraints: discovery.ConstraintStr(">=2.0.0").MustParse(), + Reason: moduledeps.ProviderDependencyExplicit, }, }, Children: nil, @@ -58,8 +58,8 @@ func TestModuleTreeDependencies(t *testing.T) { Name: "root", Providers: moduledeps.Providers{ "foo": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyExplicit, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyExplicit, }, }, Children: nil, @@ -72,12 +72,12 @@ func TestModuleTreeDependencies(t *testing.T) { Name: "root", Providers: moduledeps.Providers{ "foo": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyImplicit, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyImplicit, }, "foo.baz": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyImplicit, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyImplicit, }, }, Children: nil, @@ -90,8 +90,8 @@ func TestModuleTreeDependencies(t *testing.T) { Name: "root", Providers: moduledeps.Providers{ "foo": moduledeps.ProviderDependency{ - Versions: discovery.ConstraintStr(">=1.0.0").MustParse(), - Reason: moduledeps.ProviderDependencyExplicit, + Constraints: discovery.ConstraintStr(">=1.0.0").MustParse(), + Reason: moduledeps.ProviderDependencyExplicit, }, }, Children: nil, @@ -104,12 +104,12 @@ func TestModuleTreeDependencies(t *testing.T) { Name: "root", Providers: moduledeps.Providers{ "foo": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyExplicit, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyExplicit, }, "bar": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyExplicit, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyExplicit, }, }, Children: []*moduledeps.Module{ @@ -117,12 +117,12 @@ func TestModuleTreeDependencies(t *testing.T) { Name: "child", Providers: moduledeps.Providers{ "foo": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyInherited, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyInherited, }, "baz": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyImplicit, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyImplicit, }, }, Children: []*moduledeps.Module{ @@ -130,12 +130,12 @@ func TestModuleTreeDependencies(t *testing.T) { Name: "grandchild", Providers: moduledeps.Providers{ "foo": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyExplicit, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyExplicit, }, "bar": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyInherited, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyInherited, }, }, }, @@ -163,8 +163,8 @@ func TestModuleTreeDependencies(t *testing.T) { Name: "root", Providers: moduledeps.Providers{ "foo": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyFromState, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyFromState, }, }, Children: nil, @@ -209,16 +209,16 @@ func TestModuleTreeDependencies(t *testing.T) { Name: "root", Providers: moduledeps.Providers{ "foo": moduledeps.ProviderDependency{ - Versions: discovery.ConstraintStr(">=1.0.0").MustParse(), - Reason: moduledeps.ProviderDependencyExplicit, + Constraints: discovery.ConstraintStr(">=1.0.0").MustParse(), + Reason: moduledeps.ProviderDependencyExplicit, }, "foo.bar": moduledeps.ProviderDependency{ - Versions: discovery.ConstraintStr(">=2.0.0").MustParse(), - Reason: moduledeps.ProviderDependencyExplicit, + Constraints: discovery.ConstraintStr(">=2.0.0").MustParse(), + Reason: moduledeps.ProviderDependencyExplicit, }, "baz": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyFromState, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyFromState, }, }, Children: []*moduledeps.Module{ @@ -229,8 +229,8 @@ func TestModuleTreeDependencies(t *testing.T) { Name: "grandchild", Providers: moduledeps.Providers{ "banana": moduledeps.ProviderDependency{ - Versions: discovery.AllVersions, - Reason: moduledeps.ProviderDependencyFromState, + Constraints: discovery.AllVersions, + Reason: moduledeps.ProviderDependencyFromState, }, }, }, diff --git a/terraform/test_failure b/terraform/test_failure new file mode 100644 index 000000000..5d3ad1ac4 --- /dev/null +++ b/terraform/test_failure @@ -0,0 +1,9 @@ +--- FAIL: TestContext2Plan_moduleProviderInherit (0.01s) + context_plan_test.go:552: bad: []string{"child"} +map[string]dag.Vertex{} +"module.middle.null" +map[string]dag.Vertex{} +"module.middle.module.inner.null" +map[string]dag.Vertex{} +"aws" +FAIL