cfhighlander 0.2.1.alpha.27 → 0.2.1.alpha.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc0e66ec10442d67a675f046539b949e2b2a1a2d77b777a469015c889173020d
-  data.tar.gz: de465ad3600e11b5147f8c888d6e59d908acc10a2996cfcbb300e73f6821da96
+  metadata.gz: 243c9e2f57eb637952b598302942a48d166a3189e0a4a7698d918224cd3193ce
+  data.tar.gz: d20c212d3b8a47a6f64e530ec412644a49f5c6ea3d0c93e506b7aa87cc6347f8
 SHA512:
-  metadata.gz: 3a935570dbe5ccc7e506a5a1467aef5b2c1233a3a8b7e362f1b7a29283d54574f8cba53d1a91ac54a72c46c9416d0945594b59ebdfc86933814f84d9d78997e0
-  data.tar.gz: 882d53c4237694d3d3cf89f971fcbb1aa57dd0202d80dbe3ab659b8ecf054d6fda8d246460efa8968a0cbc4bf08ef0a6e3d0d48bb259166937d2305d857ad3f7
+  metadata.gz: afbb5e1be2f09e04e577f335a6f3e1155a7ef1688064966253b594199cbe48491e7fb5d49c8efcc9780b736471f51d290b2c510b1718efc3f40f479b94e16648
+  data.tar.gz: 23d771ecf5399a83d25bfd77f3ac3d1c6d5d0989f1f455d54c23a0f04b11015726446f38b1e0645339465735efdfe09d2ccb5cefae9a7f63817598aa56af33d7

data/bin/cfhighlander.rb

@@ -22,11 +22,11 @@ class HighlanderCli < Thor
 
   desc 'configcompile component[@version]', 'Compile Highlander components configuration'
 
-  def configcompile(component_name)
+  def configcompile(template_name)
 
     # find and load component
     component_loader = Highlander::Factory::ComponentFactory.new
-    component = component_loader.findComponent(component_name)
+    component = component_loader.loadComponentFromTemplate(template_name)
     component.load
 
     # compile cfndsl template
@@ -117,14 +117,14 @@ class HighlanderCli < Thor
   method_option :version, :type => :string, :required => false, :default => nil, :aliases => '-v',
       :desc => 'Distribution component version, defaults to latest'
 
-  def publish(component_name)
+  def publish(template_name)
     component_version = options[:version]
     distribution_bucket = options[:dstbucket]
     distribution_prefix = options[:dstprefix]
 
     # find and load component
     component_loader = Highlander::Factory::ComponentFactory.new
-    component = component_loader.findComponent(component_name)
+    component = component_loader.loadComponentFromTemplate(template_name)
     component.version = component_version
     component.distribution_bucket = distribution_bucket unless distribution_bucket.nil?
     component.distribution_prefix = distribution_prefix unless distribution_prefix.nil?
@@ -137,7 +137,7 @@ class HighlanderCli < Thor
 end
 
 # build component from passed cli options
-def build_component(options, component_name)
+def build_component(options, template_name)
 
   component_version = options[:version]
   distribution_bucket = options[:dstbucket]
@@ -145,7 +145,7 @@ def build_component(options, component_name)
 
   # find and load component
   component_loader = Highlander::Factory::ComponentFactory.new
-  component = component_loader.findComponent(component_name)
+  component = component_loader.loadComponentFromTemplate(template_name)
   component.version = component_version unless component_version.nil?
   component.distribution_bucket = distribution_bucket unless distribution_bucket.nil?
   component.distribution_prefix = distribution_prefix unless distribution_prefix.nil?

data/lib/highlander.dsl.component.rb

@@ -66,9 +66,10 @@ module Highlander
 
         # load component
         factory = Highlander::Factory::ComponentFactory.new(@component_sources)
-        @component_loaded = factory.findComponent(
+        @component_loaded = factory.loadComponentFromTemplate(
             @template,
-            @template_version
+            @template_version,
+            @name
         )
         @component_loaded.config.extend @config
 
@@ -176,7 +177,7 @@ module Highlander
         key_name = nil
 
         # priority 0: stack-level parameter of map name
-        stack_param_mapname = component.parameters.param_list.find { |p| p.name == mappings_name }
+        stack_param_mapname = component.parameters.param_list.find {|p| p.name == mappings_name}
         unless stack_param_mapname.nil?
           key_name = "Ref('#{mappings_name}')"
         end
@@ -195,7 +196,7 @@ module Highlander
           # could still be nil after this line
         end
 
-        value =  mapping_value(component: component,
+        value = mapping_value(component: component,
             provider_name: mappings_name,
             value_name: param.mapAttribute,
             key_name: key_name
@@ -223,10 +224,10 @@ module Highlander
 
         if resource_name.nil?
           # find by component
-          resource = component.components.find { |c| c.name == component_name }
+          resource = component.components.find {|c| c.name == component_name}
           resource_name = resource.name unless resource.nil?
           if resource_name.nil?
-            resource = component.components.find { |c| c.template == component_name }
+            resource = component.components.find {|c| c.template == component_name}
             resource_name = resource.name unless resource.nil?
           end
         end

data/lib/highlander.dsl.rb

@@ -54,8 +54,12 @@ module Highlander
       end
 
       def Name(name)
-        @name = name
-        @config['component_name'] = name
+        # nested components always have their name dictated by parent
+        # component, defaulting to template name
+        if (not @config.key? 'nested_component')
+          @name = name
+          @config['component_name'] = name
+        end
       end
 
       def Description(description)
@@ -78,7 +82,7 @@ module Highlander
       end
 
 
-      def Component(name:, template:, param_values: {}, config: {}, export_config: {}, &block)
+      def Component(template:, name: template, param_values: {}, config: {}, export_config: {}, &block)
         puts "Initialize #{name} with template #{template}"
 
         # load component
@@ -147,7 +151,7 @@ module Highlander
       def loadComponents()
 
         # empty config overrides to start with
-        @config_overrides = Hash[@components.collect { |c| [c.name, {}] }]
+        @config_overrides = Hash[@components.collect { |c| [c.name, {'nested_component' => true}] }]
         @named_components = Hash[@components.collect { |c| [c.name, c] }]
 
         # populate overrides with master config defined overrides
@@ -257,7 +261,11 @@ module Highlander
         if (@config.key? 'components')
           @config['components'].each { |component_name, component_config|
             if component_config.key?('config')
-              @config_overrides[component_name].extend(component_config['config'])
+              if @config_overrides.key? component_name
+                @config_overrides[component_name].extend(component_config['config'])
+              else
+                STDERR.puts("WARN: Overriding config for non-existing component #{component_name}")
+              end
             end
           }
         end
@@ -368,9 +376,9 @@ module Highlander
         build_distribution_url
       end
 
-      def name=(value)
-        self.Name(value)
-      end
+      # def name=(value)
+      #   self.Name(value)
+      # end
 
       def build_distribution_url
         if not (@distribution_bucket.nil? or @distribution_prefix.nil?)
@@ -406,6 +414,7 @@ def HighlanderComponent(&block)
 
   unless @version.nil?
     instance.version = @version
+    instance.config['component_version'] = @version
   end
 
   unless @distribution_bucket.nil?
@@ -415,10 +424,9 @@ def HighlanderComponent(&block)
     instance.DistributionPrefix(@distribution_prefix)
   end
 
+  instance.name = @template
   instance.instance_eval(&block)
-  if instance.name.nil?
-    instance.name = @name
-  end
+
 
   # load sub-components
   instance.loadComponents

data/lib/highlander.factory.rb

@@ -18,6 +18,7 @@ module Highlander
           :cfndsl_content,
           :mappings,
           :name,
+          :template,
           :version,
           :distribution_bucket,
           :distribution_prefix,
@@ -25,11 +26,14 @@ module Highlander
           :cfndsl_ext_files,
           :lambda_src_files
 
-      def initialize(component_name, component_dir)
+      def initialize(component_template_name,
+          component_template_version,
+          component_name, component_dir)
+        @template = component_template_name
         @name = component_name
         @component_dir = component_dir
         @mappings = {}
-        @version = nil
+        @version = component_template_version
         @distribution_bucket = nil
         @distribution_prefix = nil
         @component_files = []
@@ -65,11 +69,10 @@ module Highlander
         end
 
 
-        @highlander_dsl_path = "#{@component_dir}/#{@name}.highlander.rb"
-        @cfndsl_path = "#{@component_dir}/#{@name}.cfndsl.rb"
-        candidate_config_path = "#{@component_dir}/#{@name}.config.yaml"
+        @highlander_dsl_path = "#{@component_dir}/#{@template}.highlander.rb"
+        @cfndsl_path = "#{@component_dir}/#{@template}.cfndsl.rb"
         candidate_mappings_path = "#{@component_dir}/*.mappings.yaml"
-        candidate_dynamic_mappings_path = "#{@component_dir}/#{@name}.mappings.rb"
+        candidate_dynamic_mappings_path = "#{@component_dir}/#{@template}.mappings.rb"
 
         @cfndsl_ext_files += Dir["#{@component_dir}/ext/cfndsl/*.rb"]
         @lambda_src_files += Dir["#{@component_dir}/lambdas/**/*"].find_all {|p| not File.directory? p}
@@ -80,6 +83,7 @@ module Highlander
 
         @config.extend config_override unless config_override.nil?
         @config['component_version'] = @version unless @version.nil?
+        @config['component_name'] = @name
         # allow override of components
         # config_override.each do |key, value|
         #   @config[key] = value
@@ -101,17 +105,10 @@ module Highlander
         # 1st pass - parse the file
         @component_files << @highlander_dsl_path
         @highlander_dsl = eval(File.read(@highlander_dsl_path), binding)
-
         # set version if not defined
         @highlander_dsl.ComponentVersion(@version) unless @version.nil?
 
 
-        # Handle name and description defaults if they are not specified
-        # in template itself
-        if @highlander_dsl.name.nil?
-          @highlander_dsl.name = @name
-        end
-
         if @highlander_dsl.description.nil?
           @highlander_dsl.Description("#{@highlander_dsl.name} - #{@highlander_dsl.version}")
         end
@@ -160,46 +157,46 @@ module Highlander
         @component_sources = component_sources
       end
 
-      def findComponentDefault(component_name, component_version)
+      def findTemplateDefault(template_name, component_version)
         default_lookup_url = 'https://github.com/theonestack'
         default_lookup_url = ENV['HIGHLANDER_DEFAULT_COMPONENT_GIT_LOOKUP'] if ENV.key? 'HIGHLANDER_DEFAULT_COMPONENT_GIT_LOOKUP'
 
-        git_url = "#{default_lookup_url}/hl-component-#{component_name}"
+        git_url = "#{default_lookup_url}/hl-component-#{template_name}"
 
         if component_version.nil? or component_version.empty? or component_version == 'latest'
           branch = 'master'
         else
           branch = component_version
         end
-        local_path = "#{LOCAL_HIGHLANDER_CACHE_LOCATION}/#{component_name}/#{component_version}"
-        return findComponentGit(local_path, component_name, component_version, git_url, branch)
+        local_path = "#{LOCAL_HIGHLANDER_CACHE_LOCATION}/#{template_name}/#{component_version}"
+        return findTemplateGit(local_path, template_name, component_version, git_url, branch)
 
       end
 
-      def findComponentGit(local_path, component_name, component_version, git_url, branch)
+      def findTemplateGit(cache_path, component_name, component_version, git_url, branch)
         begin
-          local_path = "#{local_path}/" unless local_path.end_with? '/'
+          cache_path = "#{cache_path}/" unless cache_path.end_with? '/'
           # if this is snapshot, clean local cache
           if branch.end_with? '.snapshot'
             branch = branch.gsub('.snapshot', '')
-            FileUtils.rmtree local_path if File.exist? local_path and File.directory? local_path
+            FileUtils.rmtree cache_path if File.exist? cache_path and File.directory? cache_path
           end
 
           # if local cache exists, return from cache
-          if not Dir.glob("#{local_path}*.highlander.rb").empty?
+          if not Dir.glob("#{cache_path}*.highlander.rb").empty?
             # if cache exists, just return from cache
-            component_name = Dir.glob("#{local_path}*.highlander.rb")[0].gsub(local_path, '').gsub('.highlander.rb','')
-            return component_name, local_path
+            component_name = Dir.glob("#{cache_path}*.highlander.rb")[0].gsub(cache_path, '').gsub('.highlander.rb', '')
+            return component_name, cache_path
           end
 
           # shallow clone
           puts "Trying to load #{component_name}/#{component_version} from #{git_url}##{branch} ... "
           clone_opts = { depth: 1 }
           clone_opts[:branch] = branch if not (branch.nil? or branch.empty?)
-          Git.clone git_url, local_path, clone_opts
-          puts "\t .. cached in #{local_path}\n"
+          Git.clone git_url, cache_path, clone_opts
+          puts "\t .. cached in #{cache_path}\n"
           # return from cache once it's cloned
-          return findComponentGit(local_path, component_name, component_version, git_url, branch)
+          return findTemplateGit(cache_path, component_name, component_version, git_url, branch)
         rescue Exception => e
           STDERR.puts "Failed to resolve component #{component_name}@#{component_version} from #{git_url}"
           STDERR.puts e
@@ -207,7 +204,7 @@ module Highlander
         end
       end
 
-      def findComponentS3(s3_location, component_name, component_version)
+      def findTemplateS3(s3_location, component_name, component_version)
         parts = s3_location.split('/')
         bucket = parts[2]
         prefix = parts[3]
@@ -243,42 +240,44 @@ module Highlander
         end
       end
 
-      def findComponentGitTemplate(component_name, component_version)
-        if component_name.include? '#'
-          parts = component_name.split('#')
-          component_name = parts[0]
-          component_version = parts[1]
+      # will try and locate template based on git template location
+      # if template location is not git repo, returns nil
+      def tryFindTemplateGit(template_location, template_version)
+        if template_location.include? '#'
+          parts = template_location.split('#')
+          template_location = parts[0]
+          template_version = parts[1]
         end
 
         # avoid any nres
-        component_version = '' if component_version.nil?
+        template_version = '' if template_version.nil?
 
         # if empty or latest branch is empty
-        if component_version.empty? or component_version == 'latest' or component_version == 'latest.snapshot'
+        if template_version.empty? or template_version == 'latest' or template_version == 'latest.snapshot'
           branch = ''
         else
           # otherwise component version is actual branch
-          branch = component_version
+          branch = template_version
         end
 
 
         git_url = nil
-        if component_name.start_with? 'git:'
-          git_url = component_name.gsub('git:', '')
-        elsif component_name.start_with? 'github:'
-          git_url = "https://github.com/#{component_name.gsub('github:', '')}"
-        elsif component_name.start_with? 'github.com:'
-          git_url = "https://github.com/#{component_name.gsub('github.com:', '')}"
+        if template_location.start_with? 'git:'
+          git_url = template_location.gsub('git:', '')
+        elsif template_location.start_with? 'github:'
+          git_url = "https://github.com/#{template_location.gsub('github:', '')}"
+        elsif template_location.start_with? 'github.com:'
+          git_url = "https://github.com/#{template_location.gsub('github.com:', '')}"
         end
 
-        local_path = "#{LOCAL_HIGHLANDER_CACHE_LOCATION}/#{component_name}/#{component_version}"
+        local_path = "#{LOCAL_HIGHLANDER_CACHE_LOCATION}/#{template_location}/#{template_version}"
 
         if not git_url.nil?
-          component_name, location = findComponentGit(local_path, component_name, component_version, git_url, branch)
+          template_name, location = findTemplateGit(local_path, template_location, template_version, git_url, branch)
           if location.nil?
-            raise "Could not resolve component #{component_name}@#{component_version}"
+            raise "Could not resolve component #{template_location}@#{template_version}"
           else
-            return component_name, location
+            return template_name, template_version, location
           end
         end
 
@@ -287,69 +286,74 @@ module Highlander
 
       # Find component and given list of sources
       # @return [Highlander::Factory::Component]
-      def findComponent(component_name, component_version = nil)
+      def loadComponentFromTemplate(template_name, template_version = nil, component_name = nil)
 
-        component_version_s = component_version.nil? ? 'latest' : component_version
-        component_version = nil if component_version == 'latest'
+        component_version_s = template_version.nil? ? 'latest' : template_version
+        template_version = nil if template_version == 'latest'
+        component_name = template_name if component_name.nil?
 
-        if component_name.include? '@' and (not component_name.start_with? 'git')
-          parts = component_name.split('@')
-          component_name = parts[0]
-          component_version = parts[1]
+        if template_name.include? '@' and (not template_name.start_with? 'git')
+          parts = template_name.split('@')
+          template_name = parts[0]
+          template_version = parts[1]
+          component_version_s = template_version
         end
 
         # if component specified as git location
-        new_name, candidate_git = findComponentGitTemplate(component_name, component_version_s)
-        return buildComponent(new_name, candidate_git) unless candidate_git.nil?
+        new_template_name, new_version, candidate_git = tryFindTemplateGit(template_name, component_version_s)
+        return buildComponentFromLocation(new_template_name, new_version, component_name, candidate_git) unless candidate_git.nil?
 
         # if not git but has .snapshot lookup in default
-        if (not component_version.nil?) and component_version.end_with? '.snapshot'
-          new_name, default_candidate = findComponentDefault(component_name, component_version_s)
-          return buildComponent(new_name, default_candidate) unless default_candidate.nil?
+        if (not template_version.nil?) and template_version.end_with? '.snapshot'
+          new_template_name, default_candidate = findTemplateDefault(template_name, component_version_s)
+          return buildComponentFromLocation(new_template_name, template_version, component_name, default_candidate) unless default_candidate.nil?
         end
 
         # try in all of the component source
         @component_sources.each do |source|
-          component_full_name = "#{component_name}@#{component_version.nil? ? 'latest' : component_version}"
+          component_full_name = "#{template_name}@#{template_version.nil? ? 'latest' : template_version}"
           # TODO handle http(s) sources and their download to local
           if source.start_with?('http')
             raise StandardError, 'http(s) sources not supported yet'
           elsif source.start_with?('s3://')
             # s3 candidate
 
-            s3_candidate = findComponentS3(source, component_name, component_version_s)
+            s3_candidate = findTemplateS3(source, template_name, component_version_s)
             if not s3_candidate.nil?
               # at this point all component files are download to local file system and consumed from there
-              return buildComponent(component_name, s3_candidate)
+              return buildComponentFromLocation(template_name, template_version, component_name, s3_candidate)
             end
 
           else
             # file system candidate
-            candidate = "#{source}/#{component_name}"
-            candidate = "#{candidate}/#{component_version}" unless component_version.nil?
-            candidate_hl_path = "#{candidate}/#{component_name}.highlander.rb"
-            candidate2_hl_path = "#{source}/#{component_name}.highlander.rb"
+            candidate = "#{source}/#{template_name}"
+            candidate = "#{candidate}/#{template_version}" unless template_version.nil?
+            candidate_hl_path = "#{candidate}/#{template_name}.highlander.rb"
+            candidate2_hl_path = "#{source}/#{template_name}.highlander.rb"
             puts "Trying to load #{component_full_name} from #{candidate} ... "
             if File.exist?(candidate_hl_path)
-              return buildComponent(component_name, candidate)
+              return buildComponentFromLocation(template_name, template_version, component_name, candidate)
             end
             puts "Trying to load #{component_full_name} from #{source} ... "
             if File.exist?(candidate2_hl_path)
-              return buildComponent(component_name, source)
+              return buildComponentFromLocation(template_name, template_version, component_name, source)
             end unless component_version_s != 'latest'
           end
         end
 
         # try default component source on github
-        component_name, default_candidate = findComponentDefault(component_name, component_version_s)
-        return buildComponent(component_name, default_candidate) unless default_candidate.nil?
+        template_name, default_candidate = findTemplateDefault(template_name, component_version_s)
+        return buildComponentFromLocation(template_name, template_version, component_name, default_candidate) unless default_candidate.nil?
 
-        raise StandardError, "highlander template #{component_name}@#{component_version_s} not located" +
+        raise StandardError, "highlander template #{template_name}@#{component_version_s} not located" +
             " in sources #{@component_sources}"
       end
 
-      def buildComponent(component_name, component_dir)
-        component = Component.new(component_name, component_dir)
+      def buildComponentFromLocation(template_name,
+          template_version,
+          component_name,
+          template_location)
+        component = Component.new(template_name, template_version,  component_name, template_location)
         component.load_config
         return component
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfhighlander
 version: !ruby/object:Gem::Version
-  version: 0.2.1.alpha.27
+  version: 0.2.1.alpha.29
 platform: ruby
 authors:
 - Nikola Tosic
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline