coral_core 0.1.10 → 0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.2.1)
+    diff-lcs (1.2.4)
     git (1.2.5)
     jeweler (1.8.4)
       bundler (~> 1.0)
@@ -10,7 +10,7 @@ GEM
       rdoc
     json (1.7.7)
     log4r (1.1.10)
-    rake (10.0.3)
+    rake (10.0.4)
     rdoc (3.12.2)
       json (~> 1.4)
     rspec (2.13.0)
@@ -20,8 +20,8 @@ GEM
     rspec-core (2.13.1)
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.0)
-    yard (0.8.5.2)
+    rspec-mocks (2.13.1)
+    yard (0.8.6.1)
 
 PLATFORMS
   ruby

data/VERSION

@@ -1 +1 @@
-0.1.10
+0.2.0

data/coral_core.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "coral_core"
-  s.version = "0.1.10"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adrian Webb"]
-  s.date = "2013-03-15"
+  s.date = "2013-05-09"
   s.description = "= coral_core\n\nThis library provides core data elements and utilities used in other Coral gems.\n\nThe Coral core library contains functionality that is utilized by other\nCoral gems by providing basic utilities like Git, Shell, Disk, and Data\nmanipulation libraries, a UI system, and a core data model that supports\nEvents, Commands, Repositories, and Memory (version controlled JSON \nobjects).  This library is only used as a starting point for other systems.\n\nNote:  This library is still very early in development!\n\n== Contributing to coral_core\n \n* Check out the latest {major}.{minor} branch to make sure the feature hasn't \n  been implemented or the bug hasn't been fixed yet.\n* Check out the issue tracker to make sure someone already hasn't requested \n  it and/or contributed it.\n* Fork the project.\n* Start a feature/bugfix branch.\n* Commit and push until you are happy with your contribution.\n* Make sure to add tests for it. This is important so I don't break it in a \n  future version unintentionally.\n* Please try not to mess with the Rakefile, version, or history. If you want \n  to have your own version, or is otherwise necessary, that is fine, but \n  please isolate to its own commit so I can cherry-pick around it.\n\n== Copyright\n\nLicensed under GPLv3.  See LICENSE.txt for further details.\n\nCopyright (c) 2013  Adrian Webb <adrian.webb@coraltech.net>\nCoral Technology Group LLC"
   s.email = "adrian.webb@coraltech.net"
   s.extra_rdoc_files = [
@@ -27,12 +27,19 @@ Gem::Specification.new do |s|
     "coral_core.gemspec",
     "lib/coral_core.rb",
     "lib/coral_core/command.rb",
+    "lib/coral_core/config.rb",
     "lib/coral_core/core.rb",
     "lib/coral_core/event.rb",
     "lib/coral_core/event/regexp_event.rb",
     "lib/coral_core/interface.rb",
     "lib/coral_core/memory.rb",
     "lib/coral_core/repository.rb",
+    "lib/coral_core/resource.rb",
+    "lib/coral_core/template.rb",
+    "lib/coral_core/template/environment.rb",
+    "lib/coral_core/template/json.rb",
+    "lib/coral_core/template/wrapper.rb",
+    "lib/coral_core/template/yaml.rb",
     "lib/coral_core/util/data.rb",
     "lib/coral_core/util/disk.rb",
     "lib/coral_core/util/git.rb",
@@ -40,6 +47,7 @@ Gem::Specification.new do |s|
     "lib/coral_core/util/git/lib.rb",
     "lib/coral_core/util/git/remote.rb",
     "lib/coral_core/util/shell.rb",
+    "lib/hiera_backend.rb",
     "spec/coral_core/interface_spec.rb",
     "spec/coral_mock_input.rb",
     "spec/coral_test_kernel.rb",

data/lib/coral_core/config.rb

@@ -0,0 +1,239 @@
+
+module Coral
+class Config < Core
+  
+  #-----------------------------------------------------------------------------
+  # Global configuration
+
+  @@properties = {}
+  
+  #---
+  
+  def self.properties
+    return @@properties
+  end
+  
+  #---
+  
+  def self.set_property(name, value)
+    @@properties[name] = value  
+  end
+  
+  #-----------------------------------------------------------------------------
+  # Hiera configuration
+  
+  @@hiera = nil
+  
+  #---
+  
+  def self.hiera_config
+    config_file = Puppet.settings[:hiera_config]
+    config      = {}
+
+    if File.exist?(config_file)
+      config = Hiera::Config.load(config_file)
+    else
+      ui.warning "Config file #{config_file} not found, using Hiera defaults"
+    end
+
+    config[:logger] = 'puppet'
+    return config
+  end
+  
+  #---
+
+  def self.hiera
+    @@hiera = Hiera.new(:config => hiera_config) unless @@hiera
+    return @@hiera
+  end
+  
+  #---
+
+  def hiera
+    return self.class.hiera
+  end
+  
+  #-----------------------------------------------------------------------------
+  # Configuration lookup
+      
+  def self.initialized?(options = {})
+    config = Config.ensure(options)
+    begin
+      require 'hiera_puppet'
+      
+      scope       = config.get(:scope, {})
+      
+      sep         = config.get(:sep, '::')
+      prefix      = config.get(:prefix, true)    
+      prefix_text = prefix ? sep : ''
+      
+      init_fact   = prefix_text + config.get(:init_fact, 'hiera_ready')
+      coral_fact  = prefix_text + config.get(:coral_fact, 'coral_exists') 
+      
+      if Puppet::Parser::Functions.function('hiera')
+        if scope.respond_to?('lookupvar')
+          return true if Util::Data.true?(scope.lookupvar(init_fact)) && Util::Data.true?(scope.lookupvar(coral_fact))
+        else
+          return true
+        end
+      end
+    
+    rescue Exception # Prevent abortions.
+    end    
+    return false
+  end
+  
+  #---
+    
+  def self.lookup(name, default = nil, options = {})
+    config = Config.ensure(options)
+    value  = nil
+    
+    context     = config.get(:context, :priority)
+    scope       = config.get(:scope, {})
+    override    = config.get(:override, nil)
+    
+    base_names  = config.get(:search, nil)
+    sep         = config.get(:sep, '::')
+    prefix      = config.get(:prefix, true)    
+    prefix_text = prefix ? sep : ''
+    
+    search_name = config.get(:search_name, true)
+    
+    #dbg(default, "lookup -> #{name}")
+    
+    if Config.initialized?(options)
+      unless scope.respond_to?("[]")
+        scope = Hiera::Scope.new(scope)
+      end
+      value = hiera.lookup(name, default, scope, override, context)
+      #dbg(value, "hiera -> #{name}")
+    end 
+    
+    if Util::Data.undef?(value) && scope.respond_to?('lookupvar')
+      log_level = Puppet::Util::Log.level
+      Puppet::Util::Log.level = :err # Don't want failed parameter lookup warnings here.
+      
+      if base_names
+        if base_names.is_a?(String)
+          base_names = [ base_names ]
+        end
+        base_names.each do |item|
+          value = scope.lookupvar("#{prefix_text}#{item}#{sep}#{name}")
+          #dbg(value, "#{prefix_text}#{item}#{sep}#{name}")
+          break unless Util::Data.undef?(value)  
+        end
+      end
+      if Util::Data.undef?(value) && search_name
+        value = scope.lookupvar("#{prefix_text}#{name}")
+        #dbg(value, "#{prefix_text}#{name}")
+      end
+      Puppet::Util::Log.level = log_level
+    end    
+    value = default if Util::Data.undef?(value)
+    value = Util::Data.value(value)
+    
+    set_property(name, value)
+    
+    #dbg(value, "result -> #{name}")    
+    return value  
+  end
+  
+  #-----------------------------------------------------------------------------
+  # Instance generator
+  
+  def self.ensure(config)
+    case config
+    when Coral::Config
+      return config
+    when Hash
+      return Config.new(config) 
+    end
+    return Config.new
+  end
+  
+  #-----------------------------------------------------------------------------
+  # Configuration instance
+    
+  def initialize(data = {}, defaults = {}, force = true)
+    @force = force
+    
+    if defaults.is_a?(Hash) && ! defaults.empty?
+      symbolized = {}
+      defaults.each do |key, value|
+        symbolized[key.to_sym] = value
+      end
+      defaults = symbolized
+    end
+    
+    case data
+    when Coral::Config
+      @options = Util::Data.merge([ defaults, data.options ], force)
+    when Hash
+      @options = {}
+      if data.is_a?(Hash)
+        symbolized = {}
+        data.each do |key, value|
+          symbolized[key.to_sym] = value
+        end
+        @options = Util::Data.merge([ defaults, symbolized ], force)
+      end  
+    end
+  end
+  
+  #---
+  
+  def import(data, options = {})
+    config = Config.new(options, { :force => @force }).set(:context, :hash)
+    
+    case data
+    when Hash
+      symbolized = {}
+      data.each do |key, value|
+        symbolized[key.to_sym] = value
+      end
+      @options = Util::Data.merge([ @options, symbolized ], config)
+    
+    when String      
+      data = Util::Data.lookup(data, {}, config)
+      Util::Data.merge([ @options, data ], config)
+     
+    when Array
+      data.each do |item|
+        import(item, config)
+      end
+    end
+    
+    return self
+  end
+  
+  #---
+  
+  def set(name, value)
+    @options[name.to_sym] = value
+    return self
+  end
+  
+  def []=(name, value)
+    set(name, value)
+  end
+  
+  #---
+    
+  def get(name, default = nil)
+    name = name.to_sym
+    return @options[name] if @options.has_key?(name)
+    return default
+  end
+  
+  def [](name, default = nil)
+    get(name, default)
+  end
+  
+  #---
+  
+  def options
+    return @options
+  end
+end
+end

data/lib/coral_core/core.rb

@@ -5,13 +5,13 @@ class Core
   #-----------------------------------------------------------------------------
   # Properties
   
-  @@ui = Coral::Interface.new("coral::core")
+  @@ui = Interface.new("coral")
   
   #-----------------------------------------------------------------------------
   # Constructor / Destructor
   
   def initialize(options = {})
-    @ui = Coral::Interface.new(options)
+    @@ui = Interface.new(options)
   end
   
   #-----------------------------------------------------------------------------
@@ -197,8 +197,7 @@ class Core
   #---
     
   def self.test(data)
-    return false if ! data || data.empty?      
-    return false if data.is_a?(String) && data =~ /^(FALSE|false|False|No|no|N|n)$/      
+    return false if Util::Data.empty?(data)
     return true
   end
   

data/lib/coral_core/resource.rb

@@ -0,0 +1,238 @@
+
+module Coral
+module Resource
+  
+  #-----------------------------------------------------------------------------
+  # Resource groups
+  
+  @@resource_groups = {}
+  
+  #---
+  
+  def self.groups
+    return @@resource_groups
+  end
+  
+  #---
+  
+  def self.clear_groups
+    @@resource_groups = {}
+  end
+  
+  #---
+  
+  def self.add_members(group_name, resource_names)
+    @@resource_groups[group_name] = [] unless @@resource_groups[group_name].is_a?(Array)
+    
+    unless resource_names.is_a?(Array)
+      resource_names = [ resource_names ]
+    end
+    
+    resource_names.each do |name|
+      unless @@resource_groups[group_name].include?(name)
+        @@resource_groups[group_name] << name
+      end
+    end
+  end
+  
+  #-----------------------------------------------------------------------------
+  # Resource operations
+  
+  def self.normalize(type_name, resources, options)
+    clear_groups
+    
+    config    = Config.ensure(options)
+    resources = Util::Data.value(resources)
+    
+    #dbg(resources, 'normalize -> init')
+    
+    unless Util::Data.empty?(resources)
+      resources.keys.each do |name|
+        #dbg(name, 'normalize -> name')
+        if ! resources[name] || resources[name].empty? || ! resources[name].is_a?(Hash)        
+          resources.delete(name)
+        else
+          normalize = true
+          
+          namevar = namevar(type_name, name)
+          if resources[name].has_key?(namevar)
+            value = resources[name][namevar]
+            if Util::Data.empty?(value)
+              #dbg(value, "delete #{name}")
+              resources.delete(name)
+              normalize = false
+              
+            elsif value.is_a?(Array)
+              value.each do |item|
+                item_name = "#{name}_#{item}".gsub(/\-/, '_')
+                
+                new_resource = resources[name].clone
+                new_resource[namevar] = item
+                
+                resources[item_name] = render(new_resource, config)
+                add_members(name, item_name)
+              end
+              resources.delete(name)
+              normalize = false
+            end  
+          end
+          
+          #dbg(resources, 'normalize -> resources')
+          
+          if normalize
+            resources[name] = render(resources[name], config)
+          end
+        end
+      end
+    end
+    return resources
+  end
+  
+  #---
+  
+  def self.render(resource, options = {})
+    config = Config.ensure(options)
+    
+    Core.string_map(resource).keys.each do |name|
+      if match = name.match(/^(.+)_template$/)
+        target = match.captures[0]
+        
+        config.set(:noralize_template, config.get("normalize_#{target}", true))
+        config.set(:interpolate_template, config.get("interpolate_#{target}", true))
+        
+        resource[target] = Template.render(resource[name], resource[target], config)
+        resource.delete(name)         
+      end
+    end
+    
+    return resource
+  end
+  
+  #---
+  
+  def self.translate(type_name, resources, options = {})
+    config    = Config.ensure(options)
+    resources = Util::Data.value(resources)
+    results   = {}
+        
+    #dbg(resources, 'resources -> translate')
+    
+    prefix = config.get(:resource_prefix, '')
+    
+    name_map = {}
+    resources.keys.each do |name|
+      name_map[name] = true
+    end
+    config[:resource_names] = name_map
+    
+    resources.each do |name, data|
+      #dbg(name, 'name')
+      #dbg(data, 'data')
+      
+      resource = resources[name]
+      resource['before']    = translate_resource_refs(type_name, data['before'], config) if data.has_key?('before')
+      resource['notify']    = translate_resource_refs(type_name, data['notify'], config) if data.has_key?('notify')
+      resource['require']   = translate_resource_refs(type_name, data['require'], config) if data.has_key?('require')       
+      resource['subscribe'] = translate_resource_refs(type_name, data['subscribe'], config) if data.has_key?('subscribe')
+      
+      unless prefix.empty?
+        name = "#{prefix}_#{name}"
+      end
+      results[name] = resource
+    end
+    return results
+  end
+  
+  #---
+  
+  def self.translate_resource_refs(type_name, resource_refs, options = {})
+    return :undef if Util::Data.undef?(resource_refs)
+    
+    config         = Config.ensure(options)
+    resource_names = config.get(:resource_names, {})
+    title_prefix   = config.get(:title_prefix, '')
+    
+    title_pattern  = config.get(:title_pattern, '^\s*([^\[\]]+)\s*$')
+    title_group    = config.get(:title_var_group, 1)
+    title_flags    = config.get(:title_flags, '')
+    title_regexp   = Regexp.new(title_pattern, title_flags.split(''))
+    
+    allow_single   = config.get(:allow_single_return, true)    
+    
+    type_name      = type_name.sub(/^\@?\@/, '')
+    values         = []
+        
+    case resource_refs
+    when String
+      if resource_refs.empty?
+        return :undef 
+      else
+        resource_refs = resource_refs.split(/\s*,\s*/)
+      end
+        
+    when Puppet::Resource
+      resource_refs = [ resource_refs ]  
+    end
+    
+    resource_refs.collect! do |value|
+      if value.is_a?(Puppet::Resource) || ! value.match(title_regexp)
+        value
+          
+      elsif resource_names.has_key?(value)
+        if ! title_prefix.empty?
+          "#{title_prefix}_#{value}"
+        else
+          value
+        end
+        
+      elsif groups.has_key?(value) && ! groups[value].empty?
+        results = []
+        groups[value].each do |resource_name|
+          unless title_prefix.empty?
+            resource_name = "#{title_prefix}_#{resource_name}"
+          end
+          results << resource_name        
+        end
+        results
+        
+      else
+        nil
+      end           
+    end
+    
+    resource_refs.flatten.each do |ref|
+      #dbg(ref, 'reference -> init')
+      unless ref.nil?        
+        unless ref.is_a?(Puppet::Resource)
+          ref = ref.match(title_regexp) ? Puppet::Resource.new(type_name, ref) : Puppet::Resource.new(ref)
+        end
+        #dbg(ref, 'reference -> final')       
+        values << ref unless ref.nil?
+      end
+    end
+    return values[0] if allow_single && values.length == 1
+    return values
+  end
+  
+  #-----------------------------------------------------------------------------
+  # Utilities
+  
+  def self.type_name(value) # Basically borrowed from Puppet (damn private methods!)
+    return :main if value == :main
+    return "Class" if value == "" or value.nil? or value.to_s.downcase == "component"
+    return value.to_s.split("::").collect { |s| s.capitalize }.join("::")
+  end
+  
+  #---
+  
+  def self.namevar(type_name, resource_name) # Basically borrowed from Puppet (damn private methods!)
+    resource = Puppet::Resource.new(type_name.sub(/^\@?\@/, ''), resource_name)
+    
+    if resource.builtin_type? and type = resource.resource_type and type.key_attributes.length == 1
+      return type.key_attributes.first.to_s
+    else
+      return 'name'
+    end
+  end
+end
+end

data/lib/coral_core/template/environment.rb

@@ -0,0 +1,72 @@
+
+module Coral
+module Template
+class Environment < Base
+  #-----------------------------------------------------------------------------
+  # Renderers  
+   
+  def render(input)
+    output = ''
+    
+    case input
+    when Hash
+      input.each do |name, value|
+        output << render_assignment(name, value)
+      end
+    end              
+    return output      
+  end
+  
+  #-----------------------------------------------------------------------------
+  
+  def render_assignment(name, value)
+    name  = render_name(name)
+    value = render_value(value)
+    
+    export      = get(:export, true)
+    export_text = export ? get(:export_text, 'export ') : ''
+    operator    = get(:operator, '=')
+    
+    return "#{export_text}#{name}#{operator}#{value}\n"  
+  end
+  
+  #---
+  
+  def render_name(name)
+    prefix     = get(:name_prefix, '')
+    prefix_sep = prefix.empty? ? '' : get(:name_prefix_sep, '_')
+    
+    suffix     = get(:name_suffix, '')
+    suffix_sep = suffix.empty? ? '' : get(:name_suffix_sep, '')
+    
+    unless prefix.empty?
+      name = "#{prefix}#{prefix_sep}#{name}#{suffix_sep}#{suffix}"
+    end
+    return name
+  end
+  
+  #---
+  
+  def render_value(value)
+    sep          = get(:value_sep, ' ')
+    quote        = get(:quote, true)
+    
+    array_prefix = get(:array_prefix, '(')
+    array_suffix = get(:array_suffix, ')')
+    
+    case value
+    when Array
+      values = []
+      value.each do |item|
+        values << quote ? "'#{item}'" : "#{item}"  
+      end
+      value = "#{array_prefix}#{values.join(sep)}#{array_suffix}"
+            
+    when String
+      value = quote ? "'#{value}'" : "#{value}" 
+    end
+    return value
+  end
+end
+end
+end

data/lib/coral_core/template/json.rb

@@ -0,0 +1,13 @@
+
+module Coral
+module Template
+class JSON < Base
+  #-----------------------------------------------------------------------------
+  # Renderers  
+   
+  def render(input)
+    return Data.to_json(input)    
+  end
+end
+end
+end

data/lib/coral_core/template/wrapper.rb

@@ -0,0 +1,13 @@
+
+module Coral
+module Template
+class Wrapper < Base
+  #-----------------------------------------------------------------------------
+  # Renderers  
+   
+  def render(input)
+    return get(:template_prefix, '') + input.to_s + get(:template_suffix, '')
+  end
+end
+end
+end

data/lib/coral_core/template/yaml.rb

@@ -0,0 +1,13 @@
+
+module Coral
+module Template
+class JSON < Base
+  #-----------------------------------------------------------------------------
+  # Renderers  
+   
+  def render(input)
+    return Data.to_yaml(input)    
+  end
+end
+end
+end