cps-property-generator 0.1.1

data/lib/linter/config_linter.rb

@@ -0,0 +1,106 @@
+module PropertyGenerator
+  require 'yaml'
+  class ConfigLinter
+
+    attr_accessor :configs
+
+    def initialize(path)
+      @configs = check_for_config(path)
+    end
+
+    def run_config_tests
+      if @configs == {}
+        tests = ['config_file_is_present']
+      else
+        tests = ['config_has_correct_keys',
+                 'environment_configs_match_environments_list',
+                 'environment_configs_have_matching_region_and_account_values',
+                 'environment_configs_have_well_formatted_interpolations',
+                 'config_file_is_present']
+      end
+      results = PropertyGenerator.test_runner(self, tests)
+      results
+    end
+
+    def check_for_config(path)
+      #Tries to load the config file - if is unable to load config.yml it returns an empty hash
+      #Empty hash is returned so that the rest of the files are still able to be linted instead of stopping at this point.
+      begin
+        YAML.load_file(path)
+      rescue
+        {}
+      end
+    end
+
+    def config_file_is_present
+      status = {status: 'pass', error: ''}
+      if @configs == {}
+        status[:status] = 'fail'
+        status[:error] = "Config.yml file is missing, it is required."
+      end
+      status
+    end
+
+    def config_has_correct_keys
+      status = {status: 'pass', error: ''}
+      config_keys = ['environments', 'accounts',
+                     'environment_configs']
+      if @configs.keys != config_keys
+        status[:status] = 'fail'
+        status[:error] = "Config keys should be 'environments', 'accounts', and 'environment_configs'."
+      end
+      status
+    end
+
+    def environment_configs_match_environments_list
+      status = {status: 'pass', error: ''}
+      if @configs['environments'] != @configs['environment_configs'].keys
+        status[:status] = 'fail'
+        status[:error] = "Environments in environment_configs do not match environments listed in config environments."
+      end
+      status
+    end
+
+    def environment_configs_have_matching_region_and_account_values
+      status = {status: 'pass', error: ''}
+      environments_missmatch_values = []
+      any_missmatches = false
+      @configs['environment_configs'].keys.each do |environment|
+        unless @configs['environments'].include?(@configs['environment_configs'][environment]['region']) && @configs['accounts'].include?(@configs['environment_configs'][environment]['account'])
+          environments_missmatch_values << environment
+          any_missmatches = true
+        end
+        if any_missmatches
+          status[:status] = 'fail'
+          status[:error] = "Environments: #{environments_missmatch_values} in environment_configs have a region or account value not listed in top level."
+        end
+      end
+      status
+    end
+
+    def environment_configs_have_well_formatted_interpolations
+      status = {status: 'pass', error: ''}
+      environments_with_bad_interpolations = []
+      any_mistakes = false
+      @configs['environment_configs'].keys.each do |environment|
+        if @configs['environment_configs'][environment]['interpolations'].class == Hash
+          @configs['environment_configs'][environment]['interpolations'].each do |interpolation, value|
+            if value.class != String && value.class != Integer && value.class != Float && value.class != Fixnum
+              environments_with_bad_interpolations << {environment => interpolation}
+              any_mistakes = true
+            end
+          end
+        else
+          environments_with_bad_interpolations << environment
+          any_mistakes = true
+        end
+      end
+      if any_mistakes
+        status[:status] = 'fail'
+        status[:error] = "Incorrectly formatted interpolations in Environments: #{environments_with_bad_interpolations}"
+      end
+      status
+    end
+
+  end
+end

data/lib/linter/globals_linter.rb

@@ -0,0 +1,84 @@
+module PropertyGenerator
+  require 'yaml'
+  class GlobalsLinter
+
+    def initialize(path, configs)
+      @configs = configs
+      @globals = {}
+      valid_paths = PropertyGenerator.valid_paths(path)
+      valid_paths.each do |file_path|
+          @globals[file_path] = YAML.load_file(file_path)
+      end
+    end
+
+    def run_globals_tests
+      tests = ['globals_load_as_hashes',
+               'globals_have_no_hashes_as_values',
+               'globals_are_defined_for_valid_environemnts',
+               ]
+      results = PropertyGenerator.test_runner(self, tests)
+      results
+    end
+
+    def globals_load_as_hashes
+      status = {status: 'pass', error: ''}
+      non_hash_globals = []
+      @globals.each do |path, loaded|
+        if loaded.class != Hash
+          non_hash_globals << path
+        end
+      end
+      if non_hash_globals != []
+        status[:status] = 'fail'
+        status[:error] = "Global files #{non_hash_globals} are not being loaded as hashes."
+      end
+      status
+    end
+
+    def globals_have_no_hashes_as_values
+      status = {status: 'pass', error: ''}
+      globals_with_hash_props = []
+      @globals.each do |path, loaded|
+        if loaded.class == Hash
+          loaded.each do |key, value|
+            if value.class == Hash
+              globals_with_hash_props << {path => key}
+            end
+          end
+        end
+      end
+      if globals_with_hash_props != []
+        status[:status] = 'fail'
+        status[:error] = "Globals #{globals_with_hash_props} have values that are hashes."
+      end
+      status
+    end
+
+    def globals_are_defined_for_valid_environemnts
+      status = {status: 'pass', error: ''}
+      ignore_list = ['globals.yml']
+      globals_with_invalid_environments = []
+      accounts = []
+      if @configs['accounts'] != nil
+        @configs['accounts'].each do |account|
+          accounts << account.to_s
+        end
+        @globals.each do |path, loaded|
+          unless @configs['environments'].include?((path.split('/')[(path.split('/')).length - 1]).split('.')[0]) || accounts.include?((path.split('/')[(path.split('/')).length - 1]).split('.')[0])
+            globals_with_invalid_environments << path unless ignore_list.include?(path.split('/')[(path.split('/')).length - 1])
+          end
+        end
+        if globals_with_invalid_environments != []
+          status[:status] = 'warn'
+          status[:error] = "Files #{globals_with_invalid_environments} do not have names matching a declared environment."
+        end
+      else
+        status[:status] = 'warn'
+        status[:error] = "Accounts list in config file is missing."
+      end
+      status
+    end
+
+
+  end
+end

data/lib/linter/linter.rb

@@ -0,0 +1,35 @@
+module PropertyGenerator
+  require_relative 'config_linter.rb'
+  require_relative 'globals_linter.rb'
+  require_relative 'services_linter.rb'
+  require_relative 'report.rb'
+  class Linter
+
+    def initialize(path)
+      ignore_list = ['README.md']
+      invalid_paths = PropertyGenerator.invalid_paths(path, ignore_list)
+      @config_linter = PropertyGenerator::ConfigLinter.new(path+"/config/config.yml")
+      @globals_linter = PropertyGenerator::GlobalsLinter.new(path+"/globals/", @config_linter.configs)
+      @services_linter = PropertyGenerator::ServicesLinter.new(path+"/services/", @config_linter.configs)
+      @report = PropertyGenerator::Report.new(invalid_paths)
+    end
+
+    def run_tests
+      config_report = @config_linter.run_config_tests
+      globals_report = @globals_linter.run_globals_tests
+      service_linter = @services_linter.run_services_tests
+      @report.add_report(config_report)
+      @report.add_report(globals_report)
+      @report.add_report(service_linter)
+    end
+
+    def fail_check
+      @report.has_a_test_failed
+    end
+
+    def display_report
+      @report.display_report
+    end
+
+  end
+end

data/lib/linter/report.rb

@@ -0,0 +1,76 @@
+module PropertyGenerator
+  require 'terminal-table'
+
+  class Report
+    def initialize(files_failing_load)
+      @files_failing_load = files_failing_load
+      @full_report = {}
+    end
+
+    def add_report(report)
+      @full_report = @full_report.merge(report)
+    end
+
+    def display_report
+      if @files_failing_load != []
+        make_failing_to_load_table
+      end
+      make_pass_table
+      make_warn_table
+      make_fail_table
+    end
+
+    def has_a_test_failed
+      @full_report.each do |test, status|
+        if status[:status] == 'fail' || @files_failing_load != []
+          return true
+        else
+          return false
+        end
+      end
+    end
+
+    def make_failing_to_load_table
+      rows = []
+      @files_failing_load.each do |failed|
+        rows << [failed]
+      end
+      table = Terminal::Table.new :headings => ['Files'], :title => 'Files Failing to Load', :rows => rows, :style => {:width => 200}
+      puts table
+    end
+
+    def make_pass_table
+      rows = []
+      @full_report.each do |test,status|
+        if status[:status] == 'pass'
+          rows << [test.gsub('_', ' ')]
+        end
+      end
+      table = Terminal::Table.new :headings => ['Test'], :title => 'Passing Tests', :rows => rows, :style => {:width => 200}
+      puts table
+    end
+
+    def make_warn_table
+      rows = []
+      @full_report.each do |test,status|
+        if status[:status] == 'warn'
+          rows << [test.gsub('_', ' '), status[:error].scan(/.{1,90}/).join("\n")]
+        end
+      end
+      table = Terminal::Table.new :headings => ['Test', 'Error'], :title => 'Warning Tests', :rows => rows, :style => {:width => 200}
+      puts table
+    end
+
+    def make_fail_table
+      rows = []
+      @full_report.each do |test,status|
+        if status[:status] == 'fail'
+          rows << [test.gsub('_', ' '), status[:error].scan(/.{1,90}/).join("\n")]
+        end
+      end
+      table = Terminal::Table.new :headings => ['Test', 'Error'], :title => 'Failing Tests', :rows => rows, :style => {:width => 200}
+      puts table
+    end
+
+  end
+end

data/lib/linter/services_linter.rb

@@ -0,0 +1,186 @@
+module PropertyGenerator
+  require 'yaml'
+  class ServicesLinter
+
+    def initialize(path, configs)
+      @configs = configs
+      @services = {}
+      valid_paths = PropertyGenerator.valid_paths(path)
+      valid_paths.each do |file_path|
+        @services[file_path] = YAML.load_file(file_path)
+      end
+    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']
+      results = PropertyGenerator.test_runner(self, tests)
+      results
+    end
+
+    def services_have_accepted_keys
+      status = {status: 'pass', error: ''}
+      accepted_keys = ['default', 'environments', 'encrypted']
+      services_with_unacceptable_keys = []
+      @services.each do |path, loaded|
+        loaded.keys.each do |service_key|
+          unless accepted_keys.include?(service_key)
+            services_with_unacceptable_keys << {path => service_key}
+          end
+        end
+      end
+      if services_with_unacceptable_keys != []
+        status[:status] = 'fail'
+        status[:error] = "Service files: #{services_with_unacceptable_keys} have keys other than 'default', 'environments', or 'encrypted'."
+      end
+      status
+    end
+
+    def service_defaults_have_no_hashes_as_values
+      status = {status: 'pass', error: ''}
+      services_with_hashes_in_defaults = []
+      @services.each do |path, loaded|
+        unless loaded['default'] == nil
+          loaded['default'].each do |defaultkey, defaultvalue|
+            if defaultvalue.class == Hash
+              services_with_hashes_in_defaults << {path => defaultkey}
+            end
+          end
+        end
+      end
+      if services_with_hashes_in_defaults != []
+        status[:status] = 'fail'
+        status[:error] = "Service files: #{services_with_hashes_in_defaults} have default properties with values as hashes."
+      end
+      status
+    end
+
+    def service_environments_match_config_environments
+      status = {status: 'pass', error: ''}
+      missmatched_environments = []
+      @services.each do |path, loaded|
+        if loaded['environments'] != nil
+          loaded['environments'].keys.each do |environment|
+            if @configs['environments'] != nil
+              unless @configs['environments'].include?(environment)
+                missmatched_environments << {path => environment}
+              end
+            else
+              status[:status] = 'warn'
+              status[:error] = "Environments list in config file is missing."
+            end
+          end
+        end
+      end
+      if missmatched_environments != []
+        status[:status] = 'warn'
+        status[:error] = "Service files: #{missmatched_environments} have environments not matching config list."
+      end
+      status
+    end
+
+    def service_environments_have_no_hashes_as_values
+      status = {status: 'pass', error: ''}
+      services_with_hashes_in_environments = []
+      @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}}
+              end
+            end
+          end
+        end
+      end
+      if services_with_hashes_in_environments != []
+        status[:status] = 'fail'
+        status[:error] = "Service files #{services_with_hashes_in_environments} have environment properties with values as hashes."
+      end
+      status
+    end
+
+    def service_encrypted_environments_match_config_environments
+      status = {status: 'pass', error: ''}
+      missmatched_environments = []
+      @services.each do |path, loaded|
+        if loaded['encrypted'] != nil
+          loaded['encrypted'].keys.each do |environment|
+            if @configs['environments'] != nil
+              unless @configs['environments'].include?(environment)
+                missmatched_environments << {path => environment}
+              end
+            else
+              status[:status] = 'warn'
+              status[:error] = "Environments list in config file is missing."
+            end
+          end
+        end
+      end
+      if missmatched_environments != []
+        status[:status] = 'warn'
+        status[:error] = "Service files: #{missmatched_environments} have encrypted environments not matching config list."
+      end
+      status
+    end
+
+    def service_encrypted_fields_are_correct
+      status = {status: 'pass', error: ''}
+      accepted_keys = ['region', 'encrypted']
+      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}}
+                end
+              end
+            end
+          end
+        end
+      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'."
+      end
+      status
+    end
+
+    def service_encrypted_region_field_is_accepted
+      status = {status: 'pass', error: ''}
+      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|
+                if @configs['environments'] != nil
+                  unless @configs['environments'].include?(loaded['encrypted'][environment][property]['$ssm'][keys]['region'])
+                    services_with_unacceptable_keys << {path => {environment => property}}
+                  end
+                else
+                  status[:status] = 'warn'
+                  status[:error] = "Environments list in config file is missing."
+                end
+              end
+            end
+          end
+        end
+      end
+      if services_with_unacceptable_keys != []
+        status[:status] = 'warn'
+        status[:error] = "Service files: #{services_with_unacceptable_keys} have encrypted properties a region field not matching a declared environment in the configs."
+      end
+      status
+    end
+
+
+  end
+end