lorj 1.0.1 → 1.0.2

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

@@ -44,8 +44,9 @@ class CloudProcess
         :more => "Found several %s. Searching for '%s'.",
         :items => :public_ip
       }
-      list = controller_query(sCloudObj, sQuery)
-      query_single(sCloudObj, list, sQuery, server_name, info)
+      #  list = controller_query(sCloudObj, sQuery)
+      #  query_single(sCloudObj, list, sQuery, server_name, info)
+      query_single(sCloudObj, sQuery, server_name, info)
     rescue => e
       retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
     end

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

@@ -30,18 +30,19 @@ class CloudProcess
 
   # Process Query handler
   def forj_query_rule(sCloudObj, sQuery, hParams)
-    rule = '%s %s:%s - %s to %s', hParams[:dir], hParams[:rule_proto],
-           hParams[:port_min], hParams[:port_max],
-           hParams[:addr_map]
+    rule = format('%s %s:%s - %s to %s', hParams[:dir], hParams[:rule_proto],
+                  hParams[:port_min], hParams[:port_max],
+                  hParams[:addr_map])
     PrcLib.state("Searching for rule '%s'", rule)
     ssl_error_obj = SSLErrorMgt.new
     begin
       info = {
-        :items => [:dir, :rule_proto, :port_min, :port_max, :addr_map],
+        :items => [:dir, :proto, :port_min, :port_max, :addr_map],
         :items_form => '%s %s:%s - %s to %s'
       }
-      list = controller_query(sCloudObj, sQuery)
-      query_single(sCloudObj, list, sQuery, rule, info)
+      #  list = controller_query(sCloudObj, sQuery)
+      #  query_single(sCloudObj, list, sQuery, rule, info)
+      query_single(sCloudObj, sQuery, rule, info)
     rescue => e
       retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
     end

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

@@ -49,7 +49,7 @@ class CloudProcess
         config[:addr_map]   = '0.0.0.0/0'
 
         # object.Create(:rule)
-        Create(:rule)
+        process_create(:rule)
       end
     end
     security_group

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

@@ -63,7 +63,7 @@ class CloudProcess
 end
 
 # Define framework object on BaseDefinition
-class Lorj
+module Lorj
   # ************************************ SERVER Object
   # Identify the server to use/build on the network/...
   class BaseDefinition

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

@@ -17,7 +17,7 @@
 # It requires Core objects to be defined + default ForjProcess functions.
 
 # Define framework object on BaseDefinition
-class Lorj
+module Lorj
   # ************************************ SERVER Console Object
   # Object representing the console log attached to a server
   class BaseDefinition

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

@@ -20,7 +20,10 @@
 class CloudProcess
   def forj_get_or_create_subnetwork(sCloudObj, hParams)
     subnet = query_subnet_one(sCloudObj, hParams)
-    return nil if subnet.nil?
+    unless subnet.empty?
+      register(subnet)
+      return subnet
+    end
 
     # Create the subnet
     subnet = create_subnet(sCloudObj, hParams)

data/lib/core_process/cloud_process.rb

@@ -25,6 +25,6 @@ lorj_objects = %w(common connection network subnetwork router
                   keypairs images flavor internet_network server public_ip
                   server_log internet_server)
 
-lorj_objects.each do | name |
+lorj_objects.each do |name|
   require File.join(cloud_path, 'cloud', 'process', name + '.rb')
 end

data/lib/logging.rb

@@ -23,51 +23,6 @@ require 'ansi'
 require 'ansi/logger'
 
 #
-# PrcLib module
-#
-# PrcLib Implements a Logging class based on logger.
-#
-# For details about this class capabilities, see PrcLib::Logging
-#
-#    # To use the Prc::Logging system, do the following:
-#    require 'PrcLib'
-#
-#    # To configure logging system:
-#    PrcLib.app_name = 'config/app' # Define application data path as
-#                                   # ~/.<app_name>.
-#                                   #  Ex: 'config/app' will use ~/.config/app
-#    PrcLib.log_file = 'app.log'    # Relative path to the log file name
-#                                   # stored in the Application data path.
-#                                   # Here, ~/.config/app/app.log
-#    PrcLib.level = Logger::FATAL   # Define printout debug level. Can be any
-#                                   # Logger predefined value.
-#
-#    # To log some information:
-#    PrcLib.debug('My debug message')
-#    PrcLib.info('My info message')
-#    PrcLib.warning('my warning')
-#    PrcLib.error('my error')
-#    PrcLib.fatal(2, "Fatal error, with return code = 2)
-#    PrcLib.message('Only printout message')
-#
-#    # You can printout some instant message to the terminal, not logged.
-#    # This is useful before any action that will take time to be executed.
-#    # It is inform the end user that something is still running, which means
-#    # the application is not frozen
-#    PrcLib.state("Running a long task")
-#    # The next message will replace the previous state message.
-#    sleep(10)
-#    PrcLib.info("The long task has been executed successfully.")
-#
-#    # You can change the logger level with PrcLib.level
-#    PrcLib.level = Logger::DEBUG
-#
-#    # You can just print high level message (print without \n) if PrcLib.level
-# is not DEBUG or INFO.
-#    PrcLib.high_level_msg("Print a message, not logged, if level is not DEBUG
-# or INFO")
-#
-# Enjoy!
 module PrcLib
   # Class used to create 2 logger object, in order to keep track of error in a
   # log file and change log output to OUTPUT on needs (option flags).
@@ -86,7 +41,45 @@ module PrcLib
   # set.
   # In several cases, messages are printed out, but not stored in the log file.
   #
-  # See Logging functions for details.
+  # To use the Prc::Logging system, do the following:
+  #    require 'PrcLib'
+  #
+  #    # To configure logging system:
+  #    PrcLib.app_name = 'config/app' # Define application data path as
+  #                                   # ~/.<app_name>.
+  #                                   #  Ex: 'config/app' will use ~/.config/app
+  #    PrcLib.log_file = 'app.log'    # Relative path to the log file name
+  #                                   # stored in the Application data path.
+  #                                   # Here, ~/.config/app/app.log
+  #    PrcLib.level = Logger::FATAL   # Define printout debug level. Can be any
+  #                                   # Logger predefined value.
+  #
+  #    # To log some information:
+  #    PrcLib.debug('My %s debug message', 'test')
+  #    PrcLib.info('My info message')
+  #    PrcLib.warning('my warning')
+  #    PrcLib.error('my error')
+  #    PrcLib.fatal(2, "Fatal error, with return code = 2)
+  #    PrcLib.message('Only printout message')
+  #
+  #    # You can printout some instant message to the terminal, not logged.
+  #    # This is useful before any action that will take time to be executed.
+  #    # It is inform the end user that something is still running, which means
+  #    # the application is not frozen
+  #    PrcLib.state("Running a long task")
+  #    # The next message will replace the previous state message.
+  #    sleep(10)
+  #    PrcLib.info("The long task has been executed successfully.")
+  #
+  #    # You can change the logger level with PrcLib.level
+  #    PrcLib.level = Logger::DEBUG
+  #
+  #    # You can just print high level message (print without \n)
+  #    # if PrcLib.level is not DEBUG or INFO.
+  #    PrcLib.high_level_msg("Print a message, not logged, if level is not DEBUG
+  #    # or INFO")
+  #
+  # For details, see Logging functions
   #
   class Logging
     attr_reader :level
@@ -155,7 +148,7 @@ module PrcLib
     # Log to STDOUT and Log file and ERROR class message
     def error(message)
       @out_logger.error(message + ANSI.clear_eol)
-      @file_logger.error(message)
+      @file_logger.error(message + "\n" + caller.join("\n"))
     end
 
     # Log to STDOUT and Log file and FATAL class message
@@ -250,7 +243,7 @@ module PrcLib
 
   # Internal heap management to help controller developper to identify issue.
   def dcl_fail(msg, *p)
-    msg = "Declaration error:\n%s"
+    msg = "Declaration error:\n" + msg
     msg += format("\nSee at %s",
                   PrcLib.model.heap[0]) if PrcLib.model.heap.is_a?(Array)
     runtime_fail(msg, *p)

data/lib/lorj/version.rb

@@ -16,5 +16,5 @@
 
 # Lorj version
 module Lorj
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/lorj.rb

@@ -35,9 +35,16 @@ require 'lorj_account.rb'          # Lorj::Account class  - account config
 
 require 'core/core_internal'       # Lorj Core class private init. functions
 require 'core/core'                # Lorj Core class
+require 'core/core_object_params'  # Lorj Internal core class
 require 'core/core_model'          # Lorj Model class
 require 'core/core_process'        # Lorj core process functions
+require 'core/core_process_setup'  # Lorj core process setup
+require 'core/core_setup_ask'      # Lorj core setup ask functions
+require 'core/core_setup_encrypt'  # Lorj core setup encrypt functions
+require 'core/core_setup_init'     # Lorj core setup init functions
+require 'core/core_setup_list'     # Lorj core setup list functions
 require 'core/core_controller'     # Lorj core controller functions
+
 require 'core/core_object_data'    # Lorj ObjectData class
 require 'core/lorj_data'           # Lorj Lorj::Data object
 require 'core/lorj_basedefinition' # Lorj Lorj::BaseDefinition object

data/lib/lorj_account.rb

@@ -502,9 +502,9 @@ module Lorj
       index = layer_index(options[:name]) if options.key?(:name)
 
       indexes = exclusive_indexes(account_exclusive)
-      options[:indexes] = indexes
-
       indexes = [index] if !index.nil? && indexes.include?(index)
+
+      options[:indexes] = indexes
       indexes
     end
 
@@ -553,7 +553,7 @@ module Lorj
 
     def index_to_update(layer_name, key, section)
       indexes = [0] # choose runtime by default.
-      indexes = _layer_indexes([layer_name]) unless layer_name.nil?
+      indexes = layer_indexes([layer_name]) unless layer_name.nil?
 
       if layer_name.nil?
         # Return runtime layer, if layer requested is not updatable.

data/lib/lorj_config.rb

@@ -88,7 +88,7 @@ module Lorj
       if names.length == 1
         res = config_layers[0][:config].data
       else
-        config_layers.each do | layer |
+        config_layers.each do |layer|
           res[layer[:name]] = layer[:config].data
         end
       end

data/lib/lorj_defaults.rb

@@ -23,29 +23,107 @@ require 'yaml'
 module Lorj
   # This class is the Application configuration class used by Lorj::Config
   #
-  # It load a defaults.yaml file (path defined by PrcLib::app_defaults)
+  # It loads a defaults.yaml file (path defined by PrcLib::app_defaults)
+  #
+  # The defaults.yaml data is accessible through Lorj.defaults.data
+  # Use this capability with caution, as it contents is R/W.
+  #
+  # For getting Application defaults, use Lorj::Config[]
+  # or Lorj::Account[], Lorj::Account.get(key, nil, :names => ['default'])
+  # For setup meta data, use Lorj.defaults.get_meta,
+  # Lorj.defaults.get_meta_auto or Lorj.defaults.get_meta_section
   #
   # defaults.yaml is divided in 3 sections:
   #
-  # * :default: Contains a list of key = value
+  # * :default: Contains a list of key = value representing the application
+  #   default configuration.
+  #
+  #   Data stored in this section are accessible through Lorj::Config[]
+  #   or Lorj::Account[], Lorj::Account.get(key, nil, :names => ['default'])
+  #
+  #   Ex:
+  #    # Use Lorj.defaults.data exceptionnaly
+  #    Lorj.defaults.data.merge(:default => { data: 'test'}})
+  #
+  #    config = Lorj::Account.new
+  #    puts config.get(:data, nil, :names => ['default'])
+  #    # => test
+  #    puts Lorj.defaults[:data]
+  #    # => test
+  #
   # * :setup:   Contains :ask_step array
-  #   - :ask_step: Array of group of keys/values to setup. Each group will be
-  #                internally identified by a index starting at 0. parameters
-  #                are as follow:
+  #   - :ask_step:
+  #
+  #     Array of group of keys/values to setup. Each group will be
+  #     internally identified by a index starting at 0. parameters are as
+  #     follow:
   #     - :desc:        string to print out before group setup
+  #
+  #       ERB template enable: To get config data in ERB context, use
+  #       config[...]
+  #
   #     - :explanation: longer string to display after :desc:
-  #     - :add:         array of keys to add manually in the group.
+  #
+  #       It is printed out in brown color.
+  #
+  #       It supports ERB template. To get config data, type
+  #       <%= config[...] %>
+  #
+  #       In your defaults.yaml file, write multiline with |- after the key.
+  #
+  #       Ex: if config['text'] returns 'text', defaults.yaml can have the
+  #       following explanation.
+  #
+  #    [...]
+  #    :explanation: |-
+  #      My complete explanation is in
+  #      multiline <%= config['text'] %>
+  #    [...]
+  #
+  #
+  #     - :add: array of keys to add manually in the group. The Array can be
+  #       written with [] or list of dash elements
+  #
+  #       Example of a defaults.yaml content:
+  #
+  #    [...]
+  #    :ports: [22, 25]
+  #
+  #    :ports:
+  #      - 22
+  #      - 25
+  #    [...]
   #
   #       By default, thanks to data model dependency, the group is
-  #       automatically populated.
+  #       automatically populated. So, you need update this part only for
+  #       data that are not found from the dependency.
+  # * :section: Contains a list of sections with several keys and attributes
+  #   and eventually :default:
   #
-  # * :section: Contains a list of sections contains several key and attributes
-  #             and eventually :default:
   #   This list of sections and keys will be used to build the account files
-  #   with the lorj Lorj::Core::Setup function.
+  #   with the lorj Lorj::Core.setup function.
+  #   Those data is accessible through the Lorj.defaults.get_meta,
+  #   Lorj.defaults.get_meta_auto or Lorj.defaults.get_meta_section
+  #
+  #   Ex:
+  #    # Use Lorj.defaults.data exceptionnaly
+  #    Lorj.defaults.data.merge({sections: {:mysection: {key: {
+  #                                                            data1: 'test1',
+  #                                                            data2: 'test2'
+  #                                                           }}}})
+  #
+  #    puts Lorj.defaults.get_meta(:mysection, :key)
+  #    # => { data1: 'test1', data2: 'test2' }
+  #    puts Lorj.defaults.get_meta(:mysection)
+  #    # => {:key => { data1: 'test1', data2: 'test2' }}
+  #    puts Lorj.defaults.get_meta_section(:key)
+  #    # => :mysection
+  #    puts Lorj.defaults.get_meta_auto(:key)
+  #    # => { data1: 'test1', data2: 'test2' }
   #
   #   - :default: This section define updatable data available from config.yaml.
-  #               But will never be added in an account file.
+  #     But will never be added in an account file.
+  #
   #     It contains a list of key and options.
   #
   #     - :<aKey>: Possible options
@@ -53,20 +131,31 @@ module Lorj
   #
   #   - :<aSectionName>: Name of the section which should contains a list
   #     - :<aKeyName>: Name of the key to setup.
-  #       - :desc:              Description of that key, printed out at setup
-  #                             time.
+  #       - :desc:
+  #
+  #         Description of that key, printed out at setup time.
+  #
   #       - :readonly:          true if this key is not modifiable by a simple
-  #                             Lorj::Account::set function. false otherwise.
+  #
+  #         Lorj::Account::set function. false otherwise.
+  #
   #       - :account_exclusive: true if the key cannot be set as default from
-  #                             config.yaml or defaults.yaml.
+  #         config.yaml or defaults.yaml.
+  #
   #       - :account:           true to ask setup to ask this key to the user.
+  #
   #       - :validate:          Ruby Regex to validate the end user input.
-  #                             Ex: !ruby/regexp /^\w?\w*$/
+  #
+  #         Ex: !ruby/regexp /^\w?\w*$/
+  #
   #       - :default_value:     default value proposed to the user.
+  #
   #       - :ask_step:          Define the group number to attach the key to be
-  #                             asked. ex: 2
+  #         asked. ex: 2
+  #
   #       - :list_values:       Provide capabililities to get a list and choose
-  #                             from.
+  #         from.
+  #
   #         - :query_type:      Can be:
   #
   #           ':query_call' to execute a query on flavor, query_params is empty
@@ -99,10 +188,112 @@ module Lorj
   #           Used with :query_type=:process_call. hParams data passed to the
   #           process function.
   #
-  #         - :value:           fields to extract for the list of objects
-  #                             displayed.
-  #         - :validate:        if :list_strict, the value is limited to the
-  #                             possible values from the list
+  #         - :value:
+  #
+  #           fields to extract for the list of objects displayed.
+  #
+  #         - :validate:
+  #
+  #           if :list_strict, the value is limited to the possible values from
+  #           the list
+
+  # meta data are defined in defaults.yaml and loaded in Lorj::Default class
+  # definition.
+  # Cloud provider can redefine ForjData defaults and add some extra
+  # parameters.
+  # To get Application defaults, read defaults.yaml, under :sections:
+  # Those values can be updated by the controller with define_data
+  # <Section>:
+  #   <Data>:               Required. Symbol/String. default: nil
+  #                         => Data name. This symbol must be unique, across
+  #                            sections.
+  #     :desc:              Required. String. default: nil
+  #                         => Description
+  #     :explanation:  |-   Print a multiline explanation before ask the key
+  #                         value.
+  #                         ERB template enable. To get config data,
+  #                         type <%= config[...] %>
+  #     :readonly:          Optional. true/false. Default: false
+  #                         => oForjConfig.set() will fail if readonly is
+  #                            true. It can be set, only thanks to:
+  #                            - oForjConfig.setup()
+  #                              or using private
+  #                            - oForjConfig._set()
+  #     :account_exclusive: Optional. true/false. Default: false
+  #                         => Only oConfig.account_get/set() can handle the
+  #                            value
+  #                            oConfig.set/get cannot.
+  #     :account:           Optional. default: False
+  #                         => setup will configure the account with this
+  #                           <Data>
+  #     :ask_sort:          Number which represents the ask order in the
+  #                         step group. (See /:setup/:ask_step for details)
+  #     :after:  <Data>     Name of the previous <Data> to ask before the
+  #                         current one.
+  #     :depends_on:
+  #                         => Identify :data type required to be set before
+  #                            the current one.
+  #     :default_value:     Default value at setup time. This is not
+  #                         necessarily the Application default value
+  #                         (See /:default)
+  #     :validate:          Regular expression to validate end user input
+  #                         during setup.
+  #     :value_mapping:     list of values to map as defined by the
+  #                         controller
+  #       :controller:      mapping for get controller value from process
+  #                         values
+  #         <value> : <map> value map equivalence. See data_value_mapping
+  #                         function
+  #       :process:         mapping for get process value from controller
+  #                         values
+  #         <value> : <map> value map equivalence. See data_value_mapping
+  #                         function
+  #     :default:           Default value. Replace /:default/<data>
+  #     :list_values:       Defines a list of valid values for the current
+  #                         data.
+  #       :query_type       :controller_call to execute a function defined
+  #                         in the controller object.
+  #                         :process_call to execute a function defined in
+  #                         the process object.
+  #                         :values to get list of values from :values.
+  #       :object           Object to load before calling the function.
+  #                           Only :query_type = :*_call
+  #       :query_call       Symbol. function name to call.
+  #                           Only :query_type = :*_call
+  #                         function must return an Array.
+  #       :query_params     Hash. Controler function parameters.
+  #                           Only :query_type = :*_call
+  #       :validate         :list_strict. valid only if value is one of
+  #                          thoselisted.
+  #       :values:          to retrieve from.
+  #                         otherwise define simply a list of possible
+  #                         values.
+  #       :ask_step:        Step number. By default, setup will determine
+  #                         the step, thanks to meta lorj object
+  #                         dependencies tree.
+  #                         This number start at 0. Each step can be defined
+  #                         by /:setup/:ask_step/<steps> list.
+  #     :pre_step_function: Process called before asking the data.
+  #                         if it returns true, user interaction is
+  #                         cancelled.
+  #     :post_step_function:Process called after asking the data.
+  #                         if it returns false, the user is requested to
+  #                         re-enter a new value.
+  #
+  # :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
     # Remove inherited method []=
     def []=(*_keys, _value)
@@ -123,8 +314,8 @@ module Lorj
     def meta_each
       return nil if @data.rh_get(:sections).nil?
 
-      @data.rh_get(:sections).each do | section, hValue |
-        hValue.each do | key, value |
+      @data.rh_get(:sections).each do |section, hValue|
+        hValue.each do |key, value|
           yield section, key, value
         end
       end
@@ -168,6 +359,11 @@ module Lorj
       @data.rh_get(:sections, section, keys)
     end
 
+    # def get_meta_section(*keys)
+    #   return nil unless keys.length > 0
+    #   @account_section_mapping.rh_get(keys[0])
+    # end
+
     # Get model section/data options.
     #
     # * *Args*    :
@@ -204,9 +400,9 @@ module Lorj
 
       # TODO: Support multiple identical key name on distinct sections
       # The primary data key should change from key to section & key.
-      @data.rh_get(:sections).each do | section, hValue |
+      @data.rh_get(:sections).each do |section, hValue|
         next if section == :default
-        hValue.each_key do | map_key |
+        hValue.each_key do |map_key|
           if @account_section_mapping.rh_exist?(map_key)
             PrcLib.fatal(1, 'defaults.yaml: Duplicate entry between sections. '\
                             "'%s' defined in section '%s' already exists in"\