cps-property-generator 0.1.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fce8ef7e8df921058c7b72092dc89348196599b
-  data.tar.gz: 157741d0aad0f3c2899c00eaedcf2bd6de191a80
+  metadata.gz: 3c31e3fada8f2c72f084530355f4e90890603365
+  data.tar.gz: 552763cf891e7aabfb280c7e43cb95b0ef0fe8ec
 SHA512:
-  metadata.gz: fa0ec62cb6bbc64ce80a9d19def8851d6e8587b6e7ccf17d455e95577d9daab69285c5cd1e2883c5cb25cb52a11c647b275f62ccfd9bf385ef4366a2760550ae
-  data.tar.gz: 225a82358e08c2df7136def8ac3a8fefaacc1260b97ec1a1c74c2f90323f3e06adfaa6d6dfeb16f7a36afe2a782f5896ed5e93dcdf47317746e2a5801bfaaf67
+  metadata.gz: 588cc805729bbd8968579b8324aaaf33987ef3e19c0ed9bfb220d1892cfdf5b116aa04c244a2aa92d8d0475907725c5ad68526f2e8400257c42801680bf1b3a6
+  data.tar.gz: 6a2cabd3dcdce3ceac2a88f4f6bf5829946509a9804cb85a4142b8d0cecdb663b4a885d73970516d9143cb297d9f96ebbddd587e8cb805042d3353c4303582b3

data/README.md

@@ -24,6 +24,7 @@ In the config.yml file we need three keys set to explain our project to the gene
     * The one to one mapping or aws regions to environments.
     * The account a environment lives in.
     * Interpolations for a given environment. Interpolations will be explained in a separate section. 
+4. The `vpc` key can be added under the environment name in the environment configs if you would like to run multiple environments in the same region. If you specify a VPC in one environment then a VPC must be specified in all environments. You can only specify one VPC per environment.
     
 Here is a example config.yml
 ```yaml
@@ -108,8 +109,10 @@ encrypted:
 ###### Adding interpolations
 An interpolation is a  value that will be dynamically substituted during generation with the correct value for the environment being generated. Interpolations are declared in the config for a given environment. Once declared an interpolation can be used in a property definition by referencing it in braces. If we were to reference the domain interpolation from the example config above we would use `{domain}`.
 
+Note: values that start with an interpolation must be placed in quotes (ex. "{xxx}.xxx.xxx.{xxx}"). 
+
 ##### Step 4: Generating Your Properties (Using the CLI)
 The bin directory contains the generator.rb cli. An example of running the cli is below. The `project_path` argument specifies the path to the properties repo we are generating a uploading properties from. You must be able to create a session with s3 to upload.
 ```sh
 ./generator.rb generate --project_path "~/projects/project-properties" --upload true --upload_account "123456789012" --upload_region "us-east-1" --upload_bucket "propertiesbucket.my-cloud.com"
-```
+```

data/lib/generator/generator.rb

@@ -24,6 +24,7 @@ module PropertyGenerator
     def generate
       output = []
       @service_list.each do | service, path|
+        PropertyGenerator.config_enforcer(@configs.environment_configs)
         service_instance = PropertyGenerator::Service.new(YAML.load_file(path), @configs, @globals)
         service_instance.service
         service_instance.interpolate

data/lib/generator/service.rb

@@ -26,19 +26,20 @@ module PropertyGenerator
         #get the map of config for a env
         interpolations = @environment_configs[env]['interpolations']
 
-        #interate through the properties for an environment and gsub the config
-        @service[env].each do | property_key, property_value|
-          property_value_dup = property_value.dup
-          interpolations.each do |matcher_key, matcher_value|
-            if property_value.class == String && property_value_dup.include?("{#{matcher_key}}")
-              @service[env][property_key] = property_value_dup.gsub!("{#{matcher_key}}", matcher_value)
-            end
-          end
-        end
+        # Recursively interate through the properties for an environment and gsub the config
+        # with defined interpolations.
+        interpolate_nested_properties(@service[env], interpolations)
       end
       service
     end
 
+    def interpolate_nested_properties(service_env, interpolations)
+      interpolations.each do |matcher_key, matcher_value|
+        service_env.each { |k,v|  service_env[k] = v.gsub("{#{matcher_key}}", matcher_value) if v.class == String && v.include?("{#{matcher_key}}")}
+        service_env.values.each { |v| interpolate_nested_properties(v, interpolations)  if v.class == Hash }
+      end
+    end
+
     def merge_env_default(data, environments)
       #creates a hash of the enviornments merged with the defaults
       # {service => {env1 =>  {properties},

data/lib/helpers/helpers.rb

@@ -62,9 +62,17 @@ module PropertyGenerator
         account = environmental_configs[env]["account"]
         region = environmental_configs[env]["region"]
         json = JSON.pretty_generate({"properties" => finalized[env]})
-        FileUtils.mkdir_p("#{output_path}/#{account}/#{region}/") unless Dir.exist?("#{output_path}/#{account}/#{region}/")
-        File.write("#{output_path}/#{account}/#{region}/#{service_name}.json", json)
-        output << "#{output_path}/#{account}/#{region}/#{service_name}.json"
+        #IF users are specifing a vpc then we will drop property files under the dir that corresponds to the vpc
+        if environmental_configs[env].key?("vpc") && !environmental_configs[env]["vpc"].nil?
+          vpc_dir = "#{output_path}/#{account}/#{region}/#{environmental_configs[env]["vpc"]}"
+          FileUtils.mkdir_p("#{vpc_dir}/") unless Dir.exist?(vpc_dir)
+          File.write("#{output_path}/#{account}/#{region}/#{environmental_configs[env]["vpc"]}/#{service_name}.json", json)
+          output << "#{output_path}/#{account}/#{region}/#{environmental_configs[env]["vpc"]}/#{service_name}.json"
+        else
+          FileUtils.mkdir_p("#{output_path}/#{account}/#{region}/") unless Dir.exist?("#{output_path}/#{account}/#{region}/")
+          File.write("#{output_path}/#{account}/#{region}/#{service_name}.json", json)
+          output << "#{output_path}/#{account}/#{region}/#{service_name}.json"
+        end
       end
       output
     end
@@ -78,5 +86,17 @@ module PropertyGenerator
       obj.upload_file(file)
     end
 
+    #Force users to specify VPCs for all environments if specified for one environment.
+    #This allows us to skip having conditional logic downstream in CPS requests
+    def config_enforcer(environment_configs)
+      a_vpc_exists = false
+      environment_configs.each do |environment, config|
+        if config.key?("vpc")
+          a_vpc_exists = true
+        elsif a_vpc_exists
+          raise("If you are using VPCs then a VPC must be specified for all environments in the environment_configs")
+        end
+      end
+    end
   end
 end

data/lib/linter/report.rb

@@ -41,6 +41,9 @@ module PropertyGenerator
       end
       table = Terminal::Table.new :headings => ['Files'], :title => 'Files Failing to Load', :rows => rows, :style => {:width => 200}
       puts table
+      puts "*****************"
+      puts "Check for property values that start with an interpolated value \nIf the first character of the value is a bracket yaml will fail to load \nPlace the value in quotes"
+      puts "*****************"
     end
 
     def make_pass_table

data/lib/linter/services_linter.rb

@@ -13,17 +13,39 @@ module PropertyGenerator
     end
 
     def run_services_tests
-      tests = ['services_have_accepted_keys',
-               'service_defaults_have_no_hashes_as_values',
-               'service_environments_match_config_environments',
-               'service_environments_have_no_hashes_as_values',
-               'service_encrypted_environments_match_config_environments',
-               'service_encrypted_fields_are_correct',
-               'service_encrypted_region_field_is_accepted']
+      tests = [
+        'services_have_accepted_keys',
+        'service_environments_are_not_empty',
+        'service_defaults_have_no_hashes_as_values',
+        'service_environments_match_config_environments',
+        'service_environments_have_no_hashes_as_values',
+        'service_encrypted_environments_match_config_environments',
+        'service_encrypted_fields_are_correct',
+        'service_encrypted_region_field_is_accepted'
+      ]
       results = PropertyGenerator.test_runner(self, tests)
       results
     end
 
+    def service_environments_are_not_empty
+      status = {status: 'pass', error: ''}
+      services_empty_environments = []
+      @services.each do |path, loaded|
+        unless loaded['environments'] == nil
+          loaded['environments'].each do |environments, properties|
+            if properties == nil
+              services_empty_environments << {path => environments}
+            end
+          end
+        end
+      end
+      if services_empty_environments != []
+        status[:status] = 'fail'
+        status[:error] = "Service files #{services_empty_environments} have empty environments, these should be omitted."
+      end
+      status
+    end
+
     def services_have_accepted_keys
       status = {status: 'pass', error: ''}
       accepted_keys = ['default', 'environments', 'encrypted']
@@ -91,9 +113,11 @@ module PropertyGenerator
       @services.each do |path, loaded|
         unless loaded['environments'] == nil
           loaded['environments'].each do |environments, properties|
-            properties.each do |key, value|
-              if value.class == Hash
-                services_with_hashes_in_environments << {path => {environments => key}}
+            unless properties == nil
+              properties.each do |key, value|
+                if value.class == Hash
+                  services_with_hashes_in_environments << {path => {environments => key}}
+                end
               end
             end
           end
@@ -132,15 +156,23 @@ module PropertyGenerator
 
     def service_encrypted_fields_are_correct
       status = {status: 'pass', error: ''}
-      accepted_keys = ['region', 'encrypted']
+      accepted_keys = ['region', 'encrypted', 'service']
       services_with_unacceptable_keys = []
       @services.each do |path, loaded|
         if loaded['encrypted'] != nil
-          loaded['encrypted'].each do |environment, property|
-            if loaded['encrypted'][environment][property] != nil
-              loaded['encrypted'][environment][property].each do |ssm, keys|
-                unless loaded['encrypted'][environment][property]['$ssm'][keys].keys == accepted_keys
-                  services_with_unacceptable_keys << {path => {environment => property}}
+          loaded['encrypted'].each do |environment, properties|
+            properties.each do |property, value|
+              if value == nil
+                services_with_unacceptable_keys << {path => {environment => property}}
+              elsif value['$ssm'] == nil
+                services_with_unacceptable_keys << {path => {environment => property}}
+              else
+                if value['$ssm'] != nil
+                  value['$ssm'].keys.each do |key|
+                    unless accepted_keys.include?(key)
+                      services_with_unacceptable_keys << {path => {environment => property}}
+                    end
+                  end
                 end
               end
             end
@@ -149,7 +181,7 @@ module PropertyGenerator
       end
       if services_with_unacceptable_keys != []
         status[:status] = 'fail'
-        status[:error] = "Service files: #{services_with_unacceptable_keys} have encrypted properties with keys other than 'region' and 'encrypted'."
+        status[:error] = "Service files: #{services_with_unacceptable_keys} have encrypted properties with bad indentation or keys other than 'region' and 'encrypted'."
       end
       status
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cps-property-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.6
 platform: ruby
 authors:
 - Bryan Call