lorj 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b230339c53324a35d70056924d04caf83361556
-  data.tar.gz: 7e40d7041f4999a803f625a850067199ed1296ab
+  metadata.gz: 39a783a3bdefa0193225dbdeeffa904220c3e212
+  data.tar.gz: b5d15179e5989d20e02dec91bcb5f6fd6cafb530
 SHA512:
-  metadata.gz: 3c4117298308f75daf06230285ec3971e555315c876007f548a3a3207a201655f030f61c52e87ffcb18a9ac10308b9048ee3d1128faff26551da995b573454c5
-  data.tar.gz: b945fafa30d2f087c51a008ec3750d5f70fdb7e3bf05e5bbd161a4c073ff69fd466745c0324822d5be03be99094455ba9cf36942fc4d9ca399842a213bce1d70
+  metadata.gz: ed18aa7febd8d02e4e5d31bfa9b99407a40f5bc80a97d237bd0696281be2e330756e08d276fb4b77c7e6d90db239e569eb3fea4f661cffd0880ab04a89cb3bc1
+  data.tar.gz: 3c553c66bd2b48a15e0652c8b18c28ce2bafb4a7c37a47b3fef1712f71dccd761fed8ff992aedf41c8f9e89e9db3a8b230191bd38a6947cf137f9b4575f08ae0

data/lib/core/core_setup_init.rb

@@ -217,14 +217,20 @@ module Lorj
             options = _get_meta_data(data)
             options = {} if options.nil?
 
+            Lorj.data.layer_add(:name => :setup)
+
             if options[:pre_step_function]
               proc = options[:pre_step_function]
               next unless @process.method(proc).call(data)
+              # Get any update from pre_step_function
+              options = _get_meta_data(data)
             end
 
             data_desc = _setup_display_data(data, options)
 
             _setup_ask_data(data_desc, data, options)
+
+            Lorj.data.layer_remove(:name => :setup)
           end
         end
       end

data/lib/core/lorj_basedefinition.rb

@@ -18,20 +18,6 @@
 # Lorj::BaseDefinition
 #
 module Lorj
-  # This class limits ERC template to access only to config object data.
-  class ERBConfig
-    attr_reader :config
-
-    def initialize(config)
-      @config = config
-    end
-
-    # Bind this limited class with ERB templates
-    def get_binding # rubocop: disable AccessorMethodName
-      binding
-    end
-  end
-
   # Following class defines class levels function to
   # declare framework objects.
   # As each process needs to define new object to deal with

data/lib/core/lorj_keypath.rb

@@ -38,6 +38,7 @@ module Lorj
   # puts oKey.key[1]   # => nil
   # puts oKey.fpath    # => ':test'
   # puts oKey.tree     # => [:test]
+  # puts oKey.key_tree # => :test
   #
   # oKey = KeyPath([:test,:test2,:test3])
   # puts oKey.to_s      # => 'test/test2/test3'
@@ -46,6 +47,7 @@ module Lorj
   # puts oKey.key[1]    # => :test2
   # puts oKey.fpath     # => ':test/:test2/:test3'
   # puts oKey.tree      # => [:test,:test2,:test3]
+  # puts oKey.key_tree  # => ':test/:test2/:test3'
   #
   class KeyPath
     def initialize(sKeyPath = nil, max_level = -1)
@@ -74,6 +76,11 @@ module Lorj
       @keypath
     end
 
+    def key_tree
+      return @keypath[0] if @keypath.length == 1
+      fpath
+    end
+
     def fpath
       return nil if @keypath.length == 0
       key_access = @keypath.clone

data/lib/core_process/cloud/process/keypairs.rb

@@ -129,6 +129,21 @@ class CloudProcess
                 private_key_file) if keypair[:private_key_exist?]
     PrcLib.info("Found openssh public key file '%s'.",
                 public_key_file) if keypair[:public_key_exist?]
+
+    unless keypair[:public_key_exist?]
+      name = keypair[:name]
+      PrcLib.warning("The local public key file '%s' is missing.\n"\
+                     "As the keypair name '%s' already exists in your cloud, "\
+                     'you will need to get the original SSH keypair files '\
+                     "used to create the keypair name '%s'. Otherwise, you "\
+                     "won't be able to use it to connect to a box configured"\
+                     " with '%s'."\
+                     "\nPublic key found in the cloud:\n%s",
+                     public_key_file, name, name, name,
+                     keypair[:public_key])
+      return
+    end
+
     if keypair[:coherent]
       PrcLib.info("keypair '%s' local files are coherent with keypair in "\
                   'your cloud service. You will be able to use your local '\
@@ -142,7 +157,10 @@ class CloudProcess
                      public_key_file, keypair[:name], keypair[:public_key])
     end
   end
+end
 
+# Keypair management: Internal process functions
+class CloudProcess
   # Function to update a keypair object with ssh files found in :keypair_path
   #
   def keypair_files_detected(keypair, loc_kpair)
@@ -293,6 +311,7 @@ class CloudProcess
 
     # Check the public key with the one found here, locally.
     if !pub_keypair.nil? && pub_keypair != ''
+      return false unless loc_kpair[:public_key_exist?]
       begin
         loc_pubkey = File.read(File.join(loc_kpair[:keypair_path],
                                          loc_kpair[:public_key_name]))

data/lib/core_process/cloud_process.rb

@@ -26,5 +26,5 @@ lorj_objects = %w(common connection network subnetwork router
                   server_log internet_server)
 
 lorj_objects.each do |name|
-  require File.join(cloud_path, 'cloud', 'process', name + '.rb')
+  load File.join(cloud_path, 'cloud', 'process', name + '.rb')
 end

data/lib/lorj/version.rb

@@ -16,5 +16,5 @@
 
 # Lorj version
 module Lorj
-  VERSION = '1.0.8'
+  VERSION = '1.0.9'
 end

data/lib/lorj_account.rb

@@ -17,6 +17,8 @@
 
 require 'rubygems'
 
+require 'erb'
+
 # Lorj implements Lorj::Accounts
 module Lorj
   # Simple List of accounts class.
@@ -27,6 +29,8 @@ module Lorj
     end
 
     def dump
+      return [] unless File.directory?(@account_path)
+
       accounts = []
       Dir.foreach(@account_path) do |x|
         accounts << x unless x.match(/^\..?$/)
@@ -55,6 +59,22 @@ module Lorj
   end
 end
 
+module Lorj
+  # This class limits ERB template to access only to config object data.
+  class ERBConfig
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    # Bind this limited class with ERB templates
+    def get_binding # rubocop: disable AccessorMethodName
+      binding
+    end
+  end
+end
+
 # Lorj implements Lorj::Account
 module Lorj
   # Lorj::Account manage a list of key/value grouped by section.
@@ -154,6 +174,8 @@ module Lorj
     # :account_exclusive => true, get will limit to runtime then account.
     # otherwise, search in all layers.
     #
+    # The data found is parse through ERB with self as context.
+    #
     # * *Args*    :
     #   - +key+     : key name. It do not support it to be a key tree (Arrays of
     #     keys).
@@ -183,10 +205,13 @@ module Lorj
       names = []
       indexes.each { |index| names << @config_layers[index][:name] }
 
-      options[:data_options] = _set_data_options_per_names(names)
-
-      return p_get(options) if p_exist?(options)
+      options[:data_options] = _set_data_options_per_names(names, section)
 
+      if p_exist?(options)
+        value = p_get(options)
+        return value unless value.is_a?(String)
+        return ERB.new(value).result ERBConfig.new(self).get_binding
+      end
       default
     end
 
@@ -232,7 +257,7 @@ module Lorj
         :keys => [key],
         :section => section,
         :indexes => indexes,
-        :data_options => _set_data_options_per_names(names)
+        :data_options => _set_data_options_per_names(names, section)
       }
 
       p_where?(where_options)
@@ -275,7 +300,7 @@ module Lorj
       names = []
       indexes.each { |index| names << @config_layers[index][:name] }
 
-      options[:data_options] = _set_data_options_per_names(names)
+      options[:data_options] = _set_data_options_per_names(names, section)
 
       p_exist?(options)
     end
@@ -563,30 +588,37 @@ module Lorj
       indexes
     end
 
-    def _set_data_options_per_names(names)
+    def _set_data_options_per_names(names, section)
       data_options = []
 
-      names.each { |name| data_options <<  _data_options_per_layer(name) }
+      names.each do |name|
+        data_options << _data_options_per_layer(name, section)
+      end
 
       data_options
     end
 
-    # TODO: Change local and default way to get default values, not in /:default
-
     # This internal function defines default section name per config index.
-    def _data_options_per_layer(layer_name)
+    def _data_options_per_layer(layer_name, section)
       # runtime and local and default uses :default section
       case layer_name
-      when 'local', 'default'
+      when 'default'
+        return { :section => :default, :metadata_section => section }
+      when 'local'
         # local & default are SectionConfig and is forced to use :default as
         # section name for each data.
-        { :section => :default }
+        return { :section => :default }
       end
       # nil: layer_index = 0 => runtime. runtime is not a SectionConfig.
 
       # nil: layer_index = 1 => account
+      # If no section is provided, 'account' layer will use the first section
+      # name
+      # otherwise, it will used the section provided.
+      return { :section => section } unless section.nil?
       # account is a SectionConfig and use section value defined by the
       # lorj data model. So the section name is not forced.
+      nil
     end
 
     def _do_load(config, account_file)

data/lib/lorj_defaults.rb

@@ -60,21 +60,70 @@ module Lorj
   #   and eventually :default:
   #   For details, see Lorj::MetaAppConfig
   #
-  # :setup:                  This section describes group of fields to ask,
-  #                          step by step.
-  #     :ask_step:           Define an Array of setup steps to ask to the
-  #                          end user. The step order is respected, and
-  #                          start at 0
-  #     -  :desc:            Define the step description. ERB template
-  #                          enable. To get config data, type config[...]
-  #        :explanation:  |- Define a multiline explanation. This is printed
-  #                          out in brown color.
-  #                          ERB template enable. To get config data, type
-  #                          <%= config[...] %>
-  #        :add:             Define a list of additionnal fields to ask.
-  #        - <Data>          Data to ask.
-  #
   class Defaults < PRC::SectionConfig
+    # Get function
+    # It implements the following:
+    # 1. Search in data_options[:section] section or :default section if missing
+    # 2. otherwise, provide the metadata default value, erb like.
+    #   It uses data_options[:metadata_section]
+    #
+    # * *Args*
+    #   - +keys+ : Array of key path to found
+    #
+    # * *Returns*
+    #   - value
+    #
+    def [](*keys)
+      return nil if keys.length == 0
+
+      if @data_options[:section].nil?
+        section = :default
+      else
+        section = @data_options[:section]
+      end
+
+      return p_get(section, *keys) if p_exist?(section, *keys)
+
+      metadata_section = @data_options[:metadata_section]
+
+      return nil if metadata_section.nil?
+      default = Lorj.data.section_data(metadata_section, keys[0],
+                                       :default_value)
+      return nil if default.nil?
+      default
+    end
+
+    # Check if data found in this default layer has a value.
+    #
+    # It implements the following:
+    # 1. Search in data_options[:section] section or :default section if missing
+    # 2. otherwise, provide the metadata default value, erb like.
+    #   It uses data_options[:metadata_section]
+    #
+    # * *Args*
+    #   - +keys+ : Array of key path to found
+    #
+    # * *Returns*
+    #   - boolean : true if the key path was found
+    #
+    def exist?(*keys)
+      return nil if keys.length == 0
+
+      if @data_options[:section].nil?
+        section = :default
+      else
+        section = @data_options[:section]
+      end
+
+      return true if p_exist?(section, *keys)
+
+      metadata_section = @data_options[:metadata_section]
+
+      return false if metadata_section.nil?
+
+      Lorj.data.exist?(:sections, metadata_section, keys[0], :default_value)
+    end
+
     # Remove inherited method []=
     def []=(*_keys, _value)
     end

data/lib/prc_base_config.rb

@@ -42,6 +42,9 @@ module PRC
     # * *get*: get the config file name used by #load and #save.
     attr_accessor :filename
 
+    # config layer version
+    attr_accessor :version
+
     # initialize BaseConfig
     #
     # * *Args*
@@ -114,14 +117,13 @@ module PRC
       p_exist?(*keys)
     end
 
-    # Erase function
-    #
-    # * *Args*
+    # Erase the data in the object. internal version is cleared as well.
     #
     # * *Returns*
-    #   -
+    #   - Hash : {}.
     #
     def erase
+      @version = nil
       @data = {}
     end
 
@@ -275,6 +277,10 @@ module PRC
       fail 'Config filename not set.' if @filename.nil?
 
       @data = YAML.load_file(File.expand_path(@filename))
+      if @data.key?(:file_version)
+        @version = @data[:file_version]
+        @data.delete(:file_version)
+      end
       true
     end
 
@@ -284,6 +290,9 @@ module PRC
 
       fail 'Config filename not set.' if @filename.nil?
 
+      @data.delete(:file_version)
+      @data[:file_version] = @version unless @version.nil?
+
       File.open(@filename, 'w+') { |out| YAML.dump(@data, out) }
       true
     end

data/lib/prc_core_config.rb

@@ -1186,6 +1186,32 @@ module PRC
                          be_exclusive)
     end
 
+    # Function to get the version of a config layer name.
+    # * *Args*
+    #   - +:name+      : layer to get data.
+    #
+    def version(name)
+      return nil unless name.is_a?(String)
+
+      index = layer_index(name)
+      return nil if index.nil?
+
+      @config_layers[index][:config].version
+    end
+
+    # Function to set the version of a config layer name.
+    # * *Args*
+    #   - +:name+      : layer to set data version.
+    #
+    def version_set(name, version)
+      return nil unless name.is_a?(String) && version.is_a?(String)
+
+      index = layer_index(name)
+      return nil if index.nil?
+
+      @config_layers[index][:config].version = version
+    end
+
     # List all config layers defined in this instance.
     def layers
       result = []

data/lib/providers/hpcloud/hpcloud.rb

@@ -21,9 +21,9 @@ require 'fog' # We use fog to access HPCloud
 
 hpcloud_path = File.expand_path(File.dirname(__FILE__))
 
-require File.join(hpcloud_path, 'compute.rb')
-require File.join(hpcloud_path, 'network.rb')
-require File.join(hpcloud_path, 'security_groups.rb')
+load File.join(hpcloud_path, 'compute.rb')
+load File.join(hpcloud_path, 'network.rb')
+load File.join(hpcloud_path, 'security_groups.rb')
 
 # Defines Meta HPCloud object
 class Hpcloud

data/lorj-spec/defaults.yaml

@@ -17,6 +17,7 @@
   :maestro_url: http://example.org
   :keypair_name: default_key
   :data: None
+  :default_case2: 'success'
 :description:
   :FORJ_HPC: Testing extra application default value.
 :setup:
@@ -34,3 +35,8 @@
       :account_exclusive: true
   :maestro:
     :maestro_url:
+  :lorj_default:
+    :default_case:
+      :default_value: 'success'
+    :default_case2:
+      :default_value: 'incorrect - meta-default value'

data/spec/02_prc_base_config_spec.rb

@@ -50,6 +50,12 @@ describe 'class: PRC::BaseConfig,' do
       @config[:test1, :test2] = 'value'
       expect(@config.data).to eq(:test1 => { :test2 => 'value' })
     end
+
+    it 'version = "0.1" can be set and get' do
+      expect(@config.version).to equal(nil)
+      @config.version = '0.1'
+      expect(@config.version).to eq('0.1')
+    end
   end
 
   context 'config.del(*keys)' do
@@ -120,8 +126,11 @@ describe 'class: PRC::BaseConfig,' do
   context "config.erase on :test1 => { :test2 => 'value' }" do
     it 'with no parameter should return {} and cleanup internal data.' do
       config = PRC::BaseConfig.new(:test1 => { :test2 => 'value' })
+      config.version = '0.1'
+
       expect(config.erase).to eq({})
       expect(config.data).to eq({})
+      expect(config.version).to eq(nil)
     end
   end
 
@@ -150,6 +159,7 @@ describe 'class: PRC::BaseConfig,' do
       old_file = @config.filename
       filename = File.expand_path(file)
 
+      @config.version = '1'
       expect(@config.save(file)).to equal(true)
       expect(@config.filename).not_to eq(old_file)
       expect(@config.filename).to eq(filename)
@@ -160,6 +170,7 @@ describe 'class: PRC::BaseConfig,' do
 
       expect(@config.load).to equal(true)
       expect(@config.data).to eq(:test1 => { :test2 => 'value' })
+      expect(@config.version).to eq('1')
 
       File.delete(@config.filename)
     end

data/spec/04_prc_core_config_spec.rb

@@ -77,6 +77,28 @@ describe 'class: PRC::CoreConfig,' do
       expect(@config.layers).to eq(%w(runtime local))
     end
 
+    it 'config.version("local") return nil' do
+      expect(@config.version('local')).to equal(nil)
+    end
+
+    it 'config.version("runtime") return nil' do
+      expect(@config.version('runtime')).to equal(nil)
+    end
+
+    it 'config.version["inexistent"] return nil' do
+      expect(@config.version('inexistent')).to equal(nil)
+    end
+
+    it 'only config.version_set("local") = "1"' do
+      expect(@config.version_set('local', '1')).to eq('1')
+    end
+
+    it 'only config.version("local") return "1"' do
+      expect(@config.version('local')).to eq('1')
+      expect(@config.version('runtime')).to equal(nil)
+      expect(@config.version('inexistent')).to equal(nil)
+    end
+
     it 'config.exist?(:test) returns true' do
       expect(@config.exist?(:test)).to equal(true)
     end

data/spec/{21_lorj_defaults_spec.rb → 11_lorj_defaults_spec.rb}

@@ -16,7 +16,7 @@
 #    limitations under the License.
 
 # require 'rubygems'
-#  require 'byebug'
+# require 'byebug'
 # require 'bundler/setup'
 
 app_path = File.dirname(__FILE__)
@@ -80,6 +80,37 @@ describe 'class: Lorj::Default loaded lorj_spec/defaults.yaml, '\
       it 'get_meta_section(:data) return :credentials' do
         expect(@defaults.get_meta_section(:data)).to eq(:credentials)
       end
+
+      it 'with :metadata_section => :lorj_default_missing, '\
+         'exist?[:default_case] return false' do
+        @defaults.data_options(:metadata_section => :lorj_default_missing)
+        expect(@defaults.exist?(:default_case)).to equal(false)
+      end
+    end
+    context 'defaults.yaml loaded, with :metadata_section => :lorj_default,' do
+      before(:all) do
+        @defaults.data_options(:metadata_section => :lorj_default)
+      end
+
+      it 'exist?[:default_case] return true' do
+        expect(@defaults.exist?(:default_case)).to equal(true)
+      end
+
+      it 'exist?[:default_case2] return true' do
+        expect(@defaults.exist?(:default_case2)).to equal(true)
+      end
+
+      it 'exist?[:default_case3] return false' do
+        expect(@defaults.exist?(:default_case3)).to equal(false)
+      end
+
+      it 'get[:default_case] return "success"' do
+        expect(@defaults[:default_case]).to eq('success')
+      end
+
+      it 'get[:default_case2] return "success"' do
+        expect(@defaults[:default_case2]).to eq('success')
+      end
     end
   end
 end

data/spec/{11_lorj_config_spec.rb → 12_lorj_config_spec.rb}

@@ -206,9 +206,14 @@ describe 'class: Lorj::Config,' do
       expect(@config.where?(:test1)).to equal(false)
     end
 
-    it 'default_dump return all in a Hash' do
+    it 'default_dump return all in a Hash, without :setup and :sections' do
       default_file = @config.config_filename('default')
+      # Following will split defaults.yaml to 2 differents config
+      # values config layers and metadata config layers.
+      Lorj.defaults
       default = YAML.load_file(default_file)
+      default.delete(:setup)
+      default.delete(:sections)
 
       res = { 'local' => { :default => {} },
               'default' => default

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorj
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - forj team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -244,10 +244,10 @@ files:
 - spec/04_prc_core_config_spec.rb
 - spec/09_prc_spec.rb
 - spec/10_lorj_log_spec.rb
-- spec/11_lorj_config_spec.rb
-- spec/12_lorj_account_spec.rb
+- spec/11_lorj_defaults_spec.rb
+- spec/12_lorj_config_spec.rb
+- spec/13_lorj_account_spec.rb
 - spec/20_lorj_meta_spec.rb
-- spec/21_lorj_defaults_spec.rb
 homepage: https://github.com/forj-oss/lorj
 licenses:
 - Apache License, Version 2.0.
@@ -281,8 +281,8 @@ test_files:
 - spec/04_prc_core_config_spec.rb
 - spec/09_prc_spec.rb
 - spec/10_lorj_log_spec.rb
-- spec/11_lorj_config_spec.rb
-- spec/12_lorj_account_spec.rb
+- spec/11_lorj_defaults_spec.rb
+- spec/12_lorj_config_spec.rb
+- spec/13_lorj_account_spec.rb
 - spec/20_lorj_meta_spec.rb
-- spec/21_lorj_defaults_spec.rb
 has_rdoc: