cfhighlander 0.11.2 → 0.12.0.alpha.1586682642

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f82df7084cf7c58397cb4cc64b52e6cefec73d0e61a1de64b954da08babef64d
-  data.tar.gz: be93a1b33e5f3d66bb7602ef69a2ce9e94dafdf2a64bf8c95a36291ca58bb3ca
+  metadata.gz: 02bbde329ed3125c83f384cca69be0862a1230a790a37f4c76f12701d5cd2fc1
+  data.tar.gz: 9ac2c3a65c60e09326d55c8232933bf2478bb5d55fbff40d4a9059e602443049
 SHA512:
-  metadata.gz: 4517f26c01442c90af9626adcd0f0eb4f6a8dc4a1d395e98b7e779842a351e9578c18dc23c4451a38f9e90dab5720e3afaf29f9866661eefcfad9a3deec7c0bb
-  data.tar.gz: 7be5c2cedebae06a69228dc0e03f90cd5962bd8a95799b5e81f4cae6a7210979bc75847019e38b2a62ba68d4873705741a606126d5432884ecfd724f60bd0145
+  metadata.gz: 8dfe1520ed5ccf4962db0aa59353e027b4e7f50b23f36f0b73e1d4298a73cab78a35ee7fb8677f73fc0b647371d964c665fcbdac1b21218602f1f638af1b7414
+  data.tar.gz: eba6515819000dc62cd07e5d53bdbe1438e94f36b867abd1fefe4d8fb076b4ec70e0e8c94e0875175e1f9eea4c2c31bbb60b1127dc56230e62d5253345021880

data/README.md

@@ -301,6 +301,16 @@ compiled cloudformation templates). Same CLI / DSL options apply as for *cfpubli
 
 ## Component configuration
 
+### Default configuration values
+
+Within each template, following configuration values are available by default in both cfhl and cfndsl templates
+
+- `template_name` - Name of the cfhighlander template
+- `template_verison` - Version of the cfhighlander component template used
+- `template_dir` - Disk location of the cfhighlander template. Can be used to reference local files within component, and does work with component inheritance
+
+### Defining and overriding configuration
+
 There are 4 levels of component configuration
 
 - Component local config file `component.config.yaml` (lowest priority)

data/lib/cfhighlander.dsl.subcomponent.rb

@@ -81,7 +81,7 @@ module Cfhighlander
         build_distribution_url
 
         # load component
-        factory = Cfhighlander::Factory::ComponentFactory.new(@component_sources)
+        factory = Cfhighlander::Factory::ComponentFactory.new(@component_sources, parent.template_dir)
         @component_loaded = factory.loadComponentFromTemplate(
             @template,
             @template_version,

data/lib/cfhighlander.dsl.template.rb

@@ -2,7 +2,7 @@
 
 extensions_folder = "#{File.dirname(__FILE__)}/../hl_ext"
 
-Dir["#{extensions_folder}/*.rb"].each {|f|
+Dir["#{extensions_folder}/*.rb"].each { |f|
   require f
 }
 
@@ -36,7 +36,8 @@ module Cfhighlander
           :distribution_prefix,
           :lambda_functions_keys,
           :description,
-          :dependson_components
+          :dependson_components,
+          :template_dir
 
       attr_reader :conditions,
           :subcomponents,
@@ -61,6 +62,7 @@ module Cfhighlander
         @extended_template = nil
         # execution blocks for subcomponents
         @subcomponents_exec = {}
+        @template_dir = nil
       end
 
       # DSL statements
@@ -85,6 +87,11 @@ module Cfhighlander
         @config['description'] = description
       end
 
+      def template_dir=(value)
+        @template_dir = value
+        @config['template_dir'] = value
+      end
+
       def Parameters(&block)
         @parameters.config = @config
         @parameters.instance_eval(&block) unless block.nil?
@@ -100,7 +107,7 @@ module Cfhighlander
 
       def DynamicMappings(providerName)
         maps = mappings_provider_maps(providerName, self.config)
-        maps.each {|name, map| addMapping(name, map)} unless maps.nil?
+        maps.each { |name, map| addMapping(name, map) } unless maps.nil?
       end
 
       def DependsOn(template)
@@ -131,7 +138,7 @@ module Cfhighlander
         end
 
         name = template if name.nil?
-        
+
         # load component
         component = Cfhighlander::Dsl::Subcomponent.new(self,
             name,
@@ -205,8 +212,8 @@ module Cfhighlander
       def loadComponents
 
         # empty config overrides to start with
-        @config_overrides = Hash[@subcomponents.collect {|c| [c.name, { 'nested_component' => true }]}]
-        @named_components = Hash[@subcomponents.collect {|c| [c.name, c]}]
+        @config_overrides = Hash[@subcomponents.collect { |c| [c.name, { 'nested_component' => true }] }]
+        @named_components = Hash[@subcomponents.collect { |c| [c.name, c] }]
 
         # populate overrides with master config defined overrides
         load_configfile_component_config
@@ -308,14 +315,14 @@ module Cfhighlander
       end
 
       def apply_config_overrides
-        @config_overrides.each {|component_name, component_override|
+        @config_overrides.each { |component_name, component_override|
           @named_components[component_name].component_loaded.config.extend(component_override)
         }
       end
 
       def load_configfile_component_config
         if (@config.key? 'components')
-          @config['components'].each {|component_name, component_config|
+          @config['components'].each { |component_name, component_config|
             if component_config.key?('config')
               if @config_overrides.key? component_name
                 @config_overrides[component_name].extend(component_config['config'])
@@ -330,28 +337,28 @@ module Cfhighlander
       def apply_config_exports
         # first export from master to all children
         if ((@config.key? 'config_export') and (@config['config_export']['global']))
-          @config['config_export']['global'].each {|global_export_key|
+          @config['config_export']['global'].each { |global_export_key|
             if @config.key? global_export_key
-              @config_overrides.each {|cname, co|
+              @config_overrides.each { |cname, co|
                 co[global_export_key] = @config[global_export_key]
               }
             end
           }
         end
 
-        @subcomponents.each {|component|
+        @subcomponents.each { |component|
           cl = component.component_loaded
           if ((not cl.config.nil?) and (cl.config.key? 'config_export'))
 
             # global config
             if cl.config['config_export'].key? 'global'
-              cl.config['config_export']['global'].each {|global_export_key|
+              cl.config['config_export']['global'].each { |global_export_key|
 
                 # global config is exported to parent and every component
                 if cl.config.key? global_export_key
 
                   # cname is for component name, co for component override
-                  @config_overrides.each {|cname, co|
+                  @config_overrides.each { |cname, co|
 
                     # if templates are different e.g don't export from vpc to vpc
                     config_receiver_component = @named_components[cname]
@@ -377,7 +384,7 @@ module Cfhighlander
             end
 
             if cl.config['config_export'].key? 'component'
-              cl.config['config_export']['component'].each {|component_name, export_keys|
+              cl.config['config_export']['component'].each { |component_name, export_keys|
                 # check if there is configuration of export from this component
                 # and if there is export configuration for given component name
 
@@ -386,7 +393,7 @@ module Cfhighlander
                   if @config_overrides.key? component.export_config[component_name]
                     # override the config
                     real_component_name = component.export_config[component_name]
-                    export_keys.each {|export_component_key|
+                    export_keys.each { |export_component_key|
                       puts("Exporting config for key=#{export_component_key} from #{component.name} to #{real_component_name}")
                       if not @config_overrides[real_component_name].key? export_component_key
                         @config_overrides[real_component_name][export_component_key] = {}
@@ -397,7 +404,7 @@ module Cfhighlander
                     STDERR.puts("Trying to export configuration for non-existant component #{component.export_config[component_name]}")
                   end
                 elsif @config_overrides.key? component_name
-                  export_keys.each {|export_component_key|
+                  export_keys.each { |export_component_key|
                     puts("Exporting config for key=#{export_component_key} from #{component.name} to #{component_name}")
                     if not @config_overrides[component_name].key? export_component_key
                       @config_overrides[component_name][export_component_key] = {}
@@ -417,7 +424,7 @@ module Cfhighlander
       end
 
       def load_explicit_component_config
-        @component_configs.each {|component_name, component_config|
+        @component_configs.each { |component_name, component_config|
           @config_overrides[component_name].extend(component_config)
         }
 
@@ -441,7 +448,7 @@ module Cfhighlander
         if not (@distribution_bucket.nil? or @distribution_prefix.nil?)
           @distribute_url = "https://#{@distribution_bucket}.s3.amazonaws.com/#{@distribution_prefix}"
           @distribute_url = "#{@distribute_url}/#{@version}" unless @version.nil?
-          @subcomponents.each {|component|
+          @subcomponents.each { |component|
             component.distribute_bucket = @distribution_bucket unless @distribution_bucket.nil?
             component.distribute_prefix = @distribution_prefix unless @distribution_prefix.nil?
             component.version = @version unless @version.nil?
@@ -481,6 +488,7 @@ def CfhighlanderTemplate(&block)
 
 
   instance.name = @template.template_name
+  instance.template_dir = @template.template_location
   instance.instance_eval(&block)
 
   unless @distribution_bucket.nil?

data/lib/cfhighlander.factory.rb

@@ -13,8 +13,8 @@ module Cfhighlander
 
       attr_accessor :component_sources
 
-      def initialize(component_sources = [])
-        @template_finder = Cfhighlander::Factory::TemplateFinder.new(component_sources)
+      def initialize(component_sources = [], parent_path=nil)
+        @template_finder = Cfhighlander::Factory::TemplateFinder.new(component_sources, parent_path)
         @component_sources = component_sources
       end
 

data/lib/cfhighlander.factory.templatefinder.rb

@@ -8,8 +8,9 @@ module Cfhighlander
 
     class TemplateFinder
 
-      def initialize(component_sources = [])
-        ## First look in local $PWD/components folder
+      def initialize(component_sources = [], parent_path = nil)
+        ## First look in parent path and it's components folder
+        ## Then look in local $PWD/components folder
         ## Then search for cached $HOME/.highlander/components
         ## Then search in sources given by dsl
         default_locations = [
@@ -17,10 +18,13 @@ module Cfhighlander
             File.expand_path('components'),
             File.expand_path('.'),
         ]
+
         default_locations << ENV['CFHIGHLANDER_WORKDIR'] if ENV.key? 'CFHIGHLANDER_WORKDIR'
         default_locations.each do |predefined_path|
           component_sources.unshift(predefined_path)
         end
+        component_sources.unshift "#{parent_path}/components" if parent_path
+        component_sources.unshift parent_path if parent_path
 
         @component_sources = component_sources
       end
@@ -97,7 +101,7 @@ module Cfhighlander
           })
           # if code execution got so far we consider file exists and download it locally
           component_files = s3.list_objects_v2({ bucket: bucket, prefix: s3_prefix })
-          component_files.contents.each {|s3_object|
+          component_files.contents.each { |s3_object|
             file_name = s3_object.key.gsub(s3_prefix, '')
             destination_file = "#{local_destination}/#{file_name}"
             destination_dir = File.dirname(destination_file)
@@ -236,6 +240,7 @@ module Cfhighlander
       end
 
       def build_meta(template_name, template_version, template_location)
+        template_location = template_location[0..-2] if template_location.end_with? File::SEPARATOR
         return Cfhighlander::Model::TemplateMetadata.new(
             template_name: template_name,
             template_version: template_version,

data/lib/cfhighlander.model.component.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'securerandom'
 
 module Cfhighlander
 
@@ -131,6 +132,7 @@ module Cfhighlander
         @config['component_name'] = @name
         @config['template_name'] = @template.template_name
         @config['template_version'] = @template.template_version
+        @config['template_dir'] = @template.template_location
 
         Dir[candidate_mappings_path].each do |mapping_file|
           mappings = YAML.load(File.read(mapping_file))
@@ -188,11 +190,17 @@ module Cfhighlander
 
           # extend cfndsl, first comes parent, than child
           # this allows for child component to shadow parent component
-          # defined resources
+          # defined resources. While cfhl evaluation will use parent's template_dir configuration
+          # value, for cfndsl, as this is lower level, will resolve in child component template_dir configuration
+          # we need to ensure both parent and child components have access to their template_dir variables
+          new_template_dir_var = "template_dir_#{SecureRandom.hex[0..8]}"
+          extended_component.cfndsl_content.gsub!('template_dir', new_template_dir_var)
+          @config[new_template_dir_var] = extended_component.template.template_location
           @cfndsl_content = extended_component.cfndsl_content + @cfndsl_content
 
           @parent_dsl = extended_component.highlander_dsl
 
+          # in case of hldsl or cfndsl refering to template_dir
         end
       end
 
@@ -221,7 +229,6 @@ module Cfhighlander
           cfhl_script += ("\n#{key} = #{val.inspect}\n")
         end
         cfhl_script += File.read(@highlander_dsl_path)
-
         cfhl_dsl = eval(cfhl_script, binding)
         if not cfhl_dsl.extended_template.nil?
           @parent_template = cfhl_dsl.extended_template
@@ -239,6 +246,7 @@ module Cfhighlander
         @cfn_model = value.as_json
         @cfn_model_raw = JSON.parse(@cfn_model.to_json)
       end
+
       def eval_cfndsl
         compiler = Cfhighlander::Compiler::ComponentCompiler.new self
         compiler.lambda_mock_resolve = true

data/lib/cfhighlander.version.rb

@@ -1,3 +1,3 @@
 module Cfhighlander
-  VERSION="0.11.2".freeze
+  VERSION="0.12.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfhighlander
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0.alpha.1586682642
 platform: ruby
 authors:
 - Nikola Tosic
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -277,9 +277,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.7