(CLOUD-184, CLOUD-205) Avoid ambiguity when using the AWS_REGION envi…

…ronment var
puppetlabs-toy-chest · Jan 24, 2017 · 4cc3c39 · 4cc3c39
1 parent eb0d5a1
commit 4cc3c39
Show file tree

Hide file tree

Showing 36 changed files with 70 additions and 90 deletions.
diff --git a/lib/puppet/type/cloudwatch_alarm.rb b/lib/puppet/type/cloudwatch_alarm.rb
@@ -1,4 +1,4 @@
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:cloudwatch_alarm) do
   @doc = 'Type representing an AWS CloudWatch Alarm.'

diff --git a/lib/puppet/type/ec2_autoscalinggroup.rb b/lib/puppet/type/ec2_autoscalinggroup.rb
@@ -1,5 +1,5 @@
 require_relative '../../puppet_x/puppetlabs/property/tag.rb'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 require 'puppet/property/boolean'
 
 Puppet::Type.newtype(:ec2_autoscalinggroup) do

diff --git a/lib/puppet/type/ec2_elastic_ip.rb b/lib/puppet/type/ec2_elastic_ip.rb
@@ -1,4 +1,4 @@
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_elastic_ip) do
   @doc = "Type representing an Elastic IP and it's association."

diff --git a/lib/puppet/type/ec2_instance.rb b/lib/puppet/type/ec2_instance.rb
@@ -1,4 +1,5 @@
 require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_instance) do
   @doc = 'Type representing an EC2 instance.'
@@ -93,12 +94,8 @@ def insync?(is)
     end
   end
 
-  newproperty(:region) do
+  newproperty(:region, :parent => PuppetX::Property::AwsRegion) do
     desc 'The region in which to launch the instance.'
-    validate do |value|
-      fail 'region should not contain spaces' if value =~ /\s/
-      fail 'region should be a String' unless value.is_a?(String)
-    end
   end
 
   newproperty(:image_id) do

diff --git a/lib/puppet/type/ec2_launchconfiguration.rb b/lib/puppet/type/ec2_launchconfiguration.rb
@@ -1,4 +1,4 @@
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_launchconfiguration) do
   @doc = 'Type representing an EC2 launch configuration.'

diff --git a/lib/puppet/type/ec2_scalingpolicy.rb b/lib/puppet/type/ec2_scalingpolicy.rb
@@ -1,4 +1,4 @@
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_scalingpolicy) do
   @doc = 'Type representing an EC2 scaling policy.'

diff --git a/lib/puppet/type/ec2_securitygroup.rb b/lib/puppet/type/ec2_securitygroup.rb
@@ -1,5 +1,5 @@
-require_relative '../../puppet_x/puppetlabs/property/tag'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 require_relative '../../puppet_x/puppetlabs/aws_ingress_rules_parser'
 
 Puppet::Type.newtype(:ec2_securitygroup) do

diff --git a/lib/puppet/type/ec2_vpc.rb b/lib/puppet/type/ec2_vpc.rb
@@ -1,5 +1,5 @@
-require_relative '../../puppet_x/puppetlabs/property/tag'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_vpc) do
   @doc = 'A type representing an AWS VPC.'

diff --git a/lib/puppet/type/ec2_vpc_customer_gateway.rb b/lib/puppet/type/ec2_vpc_customer_gateway.rb
@@ -1,5 +1,5 @@
-require_relative '../../puppet_x/puppetlabs/property/tag'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_vpc_customer_gateway) do
   @doc = 'Type representing an AWS VPC customer gateways.'

diff --git a/lib/puppet/type/ec2_vpc_dhcp_options.rb b/lib/puppet/type/ec2_vpc_dhcp_options.rb
@@ -1,5 +1,5 @@
-require_relative '../../puppet_x/puppetlabs/property/tag'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_vpc_dhcp_options) do
   @doc = 'Type representing a DHCP option set for AWS VPC.'
@@ -20,10 +20,6 @@
 
   newproperty(:region, :parent => PuppetX::Property::AwsRegion) do
     desc 'The region in which to assign the DHCP option set.'
-    validate do |value|
-      fail 'region should not contain spaces' if value =~ /\s/
-      fail 'region should be a String' unless value.is_a?(String)
-    end
   end
 
   newproperty(:domain_name, :array_matching => :all) do

diff --git a/lib/puppet/type/ec2_vpc_internet_gateway.rb b/lib/puppet/type/ec2_vpc_internet_gateway.rb
@@ -1,5 +1,5 @@
-require_relative '../../puppet_x/puppetlabs/property/tag'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_vpc_internet_gateway) do
   @doc = 'Type representing an EC2 VPC Internet Gateway.'

diff --git a/lib/puppet/type/ec2_vpc_routetable.rb b/lib/puppet/type/ec2_vpc_routetable.rb
@@ -1,5 +1,5 @@
-require_relative '../../puppet_x/puppetlabs/property/tag'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_vpc_routetable) do
   @doc = 'Type representing a VPC route table.'

diff --git a/lib/puppet/type/ec2_vpc_subnet.rb b/lib/puppet/type/ec2_vpc_subnet.rb
@@ -1,5 +1,5 @@
-require_relative '../../puppet_x/puppetlabs/property/tag'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_vpc_subnet) do
   @doc = 'Type representing a VPC Subnet.'

diff --git a/lib/puppet/type/ec2_vpc_vpn.rb b/lib/puppet/type/ec2_vpc_vpn.rb
@@ -1,5 +1,5 @@
-require_relative '../../puppet_x/puppetlabs/property/tag'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_vpc_vpn) do
   @doc = 'Type representing an AWS Virtual Private Networks.'

diff --git a/lib/puppet/type/ec2_vpc_vpn_gateway.rb b/lib/puppet/type/ec2_vpc_vpn_gateway.rb
@@ -1,5 +1,5 @@
-require_relative '../../puppet_x/puppetlabs/property/tag'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:ec2_vpc_vpn_gateway) do
   @doc = 'A type representing a VPN gateway.'

diff --git a/lib/puppet/type/elb_loadbalancer.rb b/lib/puppet/type/elb_loadbalancer.rb
@@ -1,5 +1,5 @@
-require_relative '../../puppet_x/puppetlabs/property/tag'
-require_relative '../../puppet_x/puppetlabs/property/region'
+require_relative '../../puppet_x/puppetlabs/property/tag.rb'
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
 
 Puppet::Type.newtype(:elb_loadbalancer) do
   @doc = 'Type representing an ELB load balancer.'

diff --git a/lib/puppet/type/rds_db_parameter_group.rb b/lib/puppet/type/rds_db_parameter_group.rb
@@ -1,3 +1,5 @@
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
+
 Puppet::Type.newtype(:rds_db_parameter_group) do
   @doc = 'Type representing an RDS DB Parameter group.'
 
@@ -22,12 +24,8 @@
     end
   end
 
-  newproperty(:region) do
+  newproperty(:region, :parent => PuppetX::Property::AwsRegion) do
     desc 'The region in which to create the db_parameter_group.'
-    validate do |value|
-      fail 'region should be a String' unless value.is_a?(String)
-      fail 'region should not contain spaces' if value =~ /\s/
-    end
   end
 
 end
diff --git a/lib/puppet/type/rds_db_securitygroup.rb b/lib/puppet/type/rds_db_securitygroup.rb
@@ -1,3 +1,5 @@
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
+
 Puppet::Type.newtype(:rds_db_securitygroup) do
   @doc = 'Type representing an RDS instance.'
 
@@ -32,12 +34,8 @@
     end
   end
 
-  newproperty(:region) do
+  newproperty(:region, :parent => PuppetX::Property::AwsRegion) do
     desc 'The region in which to create the db_securitygroup.'
-    validate do |value|
-      fail 'region should be a String' unless value.is_a?(String)
-      fail 'region should not contain spaces' if value =~ /\s/
-    end
   end
 
   newproperty(:ip_ranges, :array_matching => :all) do

diff --git a/lib/puppet/type/rds_instance.rb b/lib/puppet/type/rds_instance.rb
@@ -1,3 +1,5 @@
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
+
 Puppet::Type.newtype(:rds_instance) do
   @doc = 'Type representing an RDS instance.'
 
@@ -49,12 +51,8 @@
 Not applicable. Must be null.'
   end
 
-  newproperty(:region) do
+  newproperty(:region, :parent => PuppetX::Property::AwsRegion) do
     desc 'The region in which to launch the instance.'
-    validate do |value|
-      fail 'region should be a String' unless value.is_a?(String)
-      fail 'region should not contain spaces' if value =~ /\s/
-    end
   end
 
   newproperty(:db_instance_class) do

diff --git a/lib/puppet/type/sqs_queue.rb b/lib/puppet/type/sqs_queue.rb
@@ -1,3 +1,5 @@
+require_relative '../../puppet_x/puppetlabs/property/region.rb'
+
 Puppet::Type.newtype(:sqs_queue) do
   @doc = "Type representing a SQS Queue"
   ensurable
@@ -43,13 +45,8 @@
      munge(&:to_s)
   end
 
-  newproperty(:region) do
+  newproperty(:region, :parent => PuppetX::Property::AwsRegion) do
     desc 'The name of the region in which the SQS queue is located'
-    validate do |value|
-      fail 'region should be a String' unless value.is_a?(String)
-      fail 'You must provide a non-blank region name for SQS Queues' if value.nil? || value.empty?
-      fail 'The name of a region should contain only alphanumeric characters or dashes' unless value =~ /^([a-zA-Z]+-+)+\d$/
-    end
   end
 
   newproperty(:visibility_timeout) do

diff --git a/lib/puppet_x/puppetlabs/property/region.rb b/lib/puppet_x/puppetlabs/property/region.rb
@@ -3,10 +3,9 @@ module Property
     class AwsRegion < Puppet::Property
       validate do |value|
         name = resource[:name]
-        fail 'region should not contain spaces' if value =~ /\s/
-        fail 'region should not be blank' if value == ''
         fail 'region should be a String' unless value.is_a?(String)
-        if !ENV['AWS_REGION'].nil? && ENV['AWS_REGION'] != value
+        fail 'region should be a valid AWS region' unless value =~ /^([a-z]{2}-[a-z]{4,}-\d)$/
+        if ENV['AWS_REGION'] && ENV['AWS_REGION'] != value
           fail "if using AWS_REGION environment variable it must match the specified region value for #{name}"
         end
       end

diff --git a/spec/unit/provider/rds_instance/v2_spec.rb b/spec/unit/provider/rds_instance/v2_spec.rb
@@ -12,7 +12,7 @@
     Puppet::Type.type(:rds_instance).new(
       ensure: 'present',
       name: 'awesome-db-5',
-      region: 'us-west-1',
+      region: 'sa-east-1',
       db_name:  'mysqldbname3',
       engine: 'mysql',
       engine_version: '5.6.19a',

diff --git a/spec/unit/type/ec2_elastic_ip_spec.rb b/spec/unit/type/ec2_elastic_ip_spec.rb
@@ -45,7 +45,7 @@
   it 'should require a region to be specified' do
     expect {
       type_class.new({ name: '10.0.0.1', region: '' })
-    }.to raise_error(Puppet::Error, /region should not be blank/)
+    }.to raise_error(Puppet::Error, /region should be a valid AWS region/)
   end
 
   it 'should require an instance to be specified' do

diff --git a/spec/unit/type/ec2_securitygroup_spec.rb b/spec/unit/type/ec2_securitygroup_spec.rb
@@ -42,7 +42,7 @@
   it 'should require region to not contain spaces' do
     expect {
       type_class.new({name: 'name', region: 'invalid region'})
-    }.to raise_error(Puppet::Error, /region should not contain spaces/)
+    }.to raise_error(Puppet::Error, /region should be a valid AWS region/)
   end
 
   [

diff --git a/spec/unit/type/ec2_vpc_customer_gateway_spec.rb b/spec/unit/type/ec2_vpc_customer_gateway_spec.rb
@@ -42,7 +42,7 @@
   it 'region should not contain spaces' do
     expect {
       type_class.new(:name => 'sample', :region => 'sa east 1')
-    }.to raise_error(Puppet::ResourceError, /region should not contain spaces/)
+    }.to raise_error(Puppet::ResourceError, /region should be a valid AWS region/)
   end
 
   it 'the ASN should be a number' do

diff --git a/spec/unit/type/ec2_vpc_dhcp_options_spec.rb b/spec/unit/type/ec2_vpc_dhcp_options_spec.rb
@@ -44,7 +44,7 @@
   it 'region should not contain spaces' do
     expect {
       type_class.new(:name => 'sample', :region => 'sa east 1')
-    }.to raise_error(Puppet::ResourceError, /region should not contain spaces/)
+    }.to raise_error(Puppet::ResourceError, /region should be a valid AWS region/)
   end
 
   ['8.8.8.8','2.2.2.2'].each do |value|

diff --git a/spec/unit/type/ec2_vpc_internet_gateway_spec.rb b/spec/unit/type/ec2_vpc_internet_gateway_spec.rb
@@ -39,7 +39,7 @@
   it 'region should not contain spaces' do
     expect {
       type_class.new(:name => 'sample', :region => 'sa east 1')
-    }.to raise_error(Puppet::ResourceError, /region should not contain spaces/)
+    }.to raise_error(Puppet::ResourceError, /region should be a valid AWS region/)
   end
 
   [

diff --git a/spec/unit/type/ec2_vpc_routetable_spec.rb b/spec/unit/type/ec2_vpc_routetable_spec.rb
@@ -40,7 +40,7 @@
   it 'region should not contain spaces' do
     expect {
       type_class.new(:name => 'sample', :region => 'sa east 1')
-    }.to raise_error(Puppet::ResourceError, /region should not contain spaces/)
+    }.to raise_error(Puppet::ResourceError, /region should be a valid AWS region/)
   end
 
   it 'routes should contain a cidr' do

diff --git a/spec/unit/type/ec2_vpc_spec.rb b/spec/unit/type/ec2_vpc_spec.rb
@@ -57,7 +57,7 @@
   it 'region should not contain spaces' do
     expect {
       type_class.new(:name => 'sample', :region => 'sa east 1')
-    }.to raise_error(Puppet::ResourceError, /region should not contain spaces/)
+    }.to raise_error(Puppet::ResourceError, /region should be a valid AWS region/)
   end
 
   it 'should order tags on output' do

diff --git a/spec/unit/type/ec2_vpc_subnet_spec.rb b/spec/unit/type/ec2_vpc_subnet_spec.rb
@@ -42,7 +42,7 @@
   it 'region should not contain spaces' do
     expect {
       type_class.new(:name => 'sample', :region => 'sa east 1')
-    }.to raise_error(Puppet::ResourceError, /region should not contain spaces/)
+    }.to raise_error(Puppet::ResourceError, /region should be a valid AWS region/)
   end
 
   [

diff --git a/spec/unit/type/ec2_vpc_vpn_gateway_spec.rb b/spec/unit/type/ec2_vpc_vpn_gateway_spec.rb
@@ -42,7 +42,7 @@
   it 'region should not contain spaces' do
     expect {
       type_class.new(:name => 'sample', :region => 'sa east 1')
-    }.to raise_error(Puppet::ResourceError, /region should not contain spaces/)
+    }.to raise_error(Puppet::ResourceError, /region should be a valid AWS region/)
   end
 
   it 'should default type to ipsec.1' do

diff --git a/spec/unit/type/ec2_vpc_vpn_spec.rb b/spec/unit/type/ec2_vpc_vpn_spec.rb
@@ -65,7 +65,7 @@
   it 'region should not contain spaces' do
     expect {
       type_class.new(:name => 'sample', :region => 'sa east 1')
-    }.to raise_error(Puppet::ResourceError, /region should not contain spaces/)
+    }.to raise_error(Puppet::ResourceError, /region should be a valid AWS region/)
   end
 
   [

diff --git a/spec/unit/type/rds_db_parameter_group_spec.rb b/spec/unit/type/rds_db_parameter_group_spec.rb
@@ -39,7 +39,7 @@
   it 'should require a valid looking region' do
     expect {
       type_class.new({:name => 'sample', :region => 'definitely invalid'})
-    }.to raise_error(Puppet::Error, /region should not contain spaces/)
+    }.to raise_error(Puppet::Error, /region should be a valid AWS region/)
   end
 
   [

diff --git a/spec/unit/type/rds_db_securitygroup_spec.rb b/spec/unit/type/rds_db_securitygroup_spec.rb
@@ -47,7 +47,7 @@
   it 'should require a valid looking region' do
     expect {
       type_class.new({:name => 'sample', :region => 'definitely invalid'})
-    }.to raise_error(Puppet::Error, /region should not contain spaces/)
+    }.to raise_error(Puppet::Error, /region should be a valid AWS region/)
   end
 
   [

diff --git a/spec/unit/type/rds_instance_spec.rb b/spec/unit/type/rds_instance_spec.rb
@@ -60,7 +60,7 @@
   it 'region should not contain spaces' do
     expect {
       type_class.new(:name => 'sample', :region => 'sa east 1')
-    }.to raise_error(Puppet::ResourceError, /region should not contain spaces/)
+    }.to raise_error(Puppet::ResourceError, /region should be a valid AWS region/)
   end
 
   it 'IOPS must be an integer' do