lorj 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36d83ea9cfd8bf5813827bf81787e5d4be58571c
-  data.tar.gz: f78ae355e208f298649ea3cd523fb163553948a7
+  metadata.gz: 913a046318c32edd50058f113100fed25d93075d
+  data.tar.gz: 58fb06cb60adfc5b01682f9c966d23dc82b29ae6
 SHA512:
-  metadata.gz: e84cd61cdb98437b233c724c56df7dd6bf1b388e6e9e521defc20c6295346c221d75388eeaf3af1963a830736aea13e762bcca313094a860472248f897eddd7c
-  data.tar.gz: 5a4f65aab04941d2107f20ba7f7f0152104f4977ef3203c8418c5ef45e1448d0c1bf4038ca4de7a74bdab3556323176b2349f9f5c10a42d4163e4dc64bb21d38
+  metadata.gz: c5839c30daa322cf69478379d1dc5282eded2fdb34e6d1f0de7a37d8674e25bddc5e850a386467e0573eed6fc56b11a83868d9289441897c763a518d44ec9901
+  data.tar.gz: 8128e5644c561b4fd66456e917cfe5cc3a3c51da5c52b581b352adaa3da8f0714a69a745ec37e982c58bbebccaf849c9399526b4c0a30afbe8764143a77f7020

data/README.md

@@ -33,6 +33,19 @@ clouds providers.
 Currently, forj cli has implemented *hpcloud* and *openstack* providers, using
 *fog*. Docker controller is under development.
 
+### embedded process/controllers
+
+Currently, lorj embed a Cloud process and 3 providers (controllers: hpcloud/openstack/mock)
+
+The cloud process is used by [forj cli|http://www.rubydoc.info/gems/forj] - the DevOps forge builder,
+to execute cloud task transparently against hpcloud or openstack.
+
+To support a new cloud provider, you need to write your own cloud controller.
+Look in [lib/providers] to clone an existing one and update to use your own cloud.
+
+TODO: Move process and controller to new gem libraries.
+TODO: write up cloud controller documentation for contributors.
+
 ## Getting started
 
 As playing by example is better than a long discussion, let's start playing with a simple example.

data/lib/core/core_setup_ask.rb

@@ -117,14 +117,31 @@ module Lorj
       result
     end
 
+    # rubocop: disable Metrics/CyclomaticComplexity
+    # rubocop: disable Metrics/PerceivedComplexity
+
     # Internal setup function to ask to the end user from a list.
     #
     # * *Args* :
     #  - +data+        : Data to ask.
     #  - +list_options+: list and validation options
+    #    - +:validate+ : Can be :list_strict to restrict possible value to only
+    #      those listed.
     #  - +desc+        : Data description
     #  - +options+     : Used when user have to enter a string instead of
     #                    selecting from a list.
+    #   - +:default_value+ : predfined default value.
+    #
+    #     if data model defines :default_value. => choose it
+    #     In this last case, the :default_value is interpreted by ERB.
+    #     ERB context contains:
+    #       - config : data config layer.
+    #
+    #       Ex: So you can set :default_value like:
+    #
+    #            :default_value: "~/.ssh/<%= config[:keypair_name] %>-id_rsa"
+    #       This may assume that keypair_name is setup before abd would need:
+    #       - :after: <datas>
     #
     # * *Returns*:
     #   - value : value entered by the end user.
@@ -138,6 +155,18 @@ module Lorj
                                           options[:default_value])
 
       list = result[:list]
+      default = options[:default_value]
+      default = result[:default_value] unless result[:default_value].nil?
+
+      begin
+        default = erb(default)
+      rescue => e
+        PrcLib.warning("ERB error with :%s/:default_value '%s'.\n%s",
+                       data, result[:default_value], e.message)
+      else
+        default = nil if default == ''
+        options[:default_value] = default
+      end
 
       is_strict_list = (list_options[:validate] == :list_strict)
 
@@ -155,11 +184,12 @@ module Lorj
       value = _setup_choose_data_from_list(data, desc, list, options)
 
       if !is_strict_list && value == 'Not in this list'
-        value = _setup_ask_data_from_keyboard(desc, data, options,
-                                              result[:default_value])
+        value = _setup_ask_data_from_keyboard(desc, data, options)
       end
       value
     end
+    # rubocop: enable Metrics/CyclomaticComplexity
+    # rubocop: enable Metrics/PerceivedComplexity
 
     # Internal setup function to present the list to the user and ask to choose.
     #
@@ -194,8 +224,9 @@ module Lorj
     #   - +desc+   : Data description
     #   - +data+   : Data to ask.
     #   - +options+: list and validation options
-    #     - :ask_function: Replace the _ask default call by a process function
+    #     - :ask_function : Replace the _ask default call by a process function
     #       This function should return a string or nil, if no value.
+    #     - :default_value: Predefined default value.
     #   - +default+: Default value.
     #
     #     setup will present a default value. This value can come from several

data/lib/core/core_setup_encrypt.rb

@@ -84,9 +84,9 @@ module Lorj
       value_hidden = ''
       begin
         value_hidden = '*' * _get_encrypted_value(enc_value, entr).length
-      rescue
-        PrcLib.error('Unable to decrypt your %s. You will need to re-enter it.',
-                     sDesc)
+      rescue => e
+        PrcLib.error('Unable to decrypt your %s. You will need to re-enter it.'\
+                     '\n%s', sDesc, e.message)
       else
         PrcLib.message("'%s' is already set. If you want to keep it,"\
                        ' just press Enter', sDesc)
@@ -137,7 +137,7 @@ module Lorj
     def _ask_encrypted(sDesc, default)
       entr = _get_encrypt_key
 
-      enc_value = default
+      enc_value = default unless default == ''
 
       value_hidden = _get_encrypted_value_hidden(sDesc, default, entr)
 

data/lib/lorj/version.rb

@@ -16,5 +16,5 @@
 
 # Lorj version
 module Lorj
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/lib/providers/openstack/openstack.rb

@@ -35,7 +35,8 @@ class Openstack
   # Define Data used by service
 
   obj_needs :data, :account_id,  :mapping => :openstack_username
-  obj_needs :data, :account_key, :mapping => :openstack_api_key
+  obj_needs :data, :account_key, :mapping => :openstack_api_key,
+                                 :decrypt => true
   obj_needs :data, :auth_uri,    :mapping => :openstack_auth_uri
   obj_needs :data, :tenant,      :mapping => :openstack_tenant
   obj_needs :data, ':excon_opts/:connect_timeout', :default_value => 30
@@ -139,7 +140,15 @@ class Openstack
                 'API, then download the Openstack RC file. The Region name is '\
                 'set as OS_REGION_NAME.'\
                 "\nIf there is no region shown, you can ignore it.",
-              :desc => 'Openstack Compute Region (Ex: RegionOne)'
+              :desc => 'Openstack Compute Region (Ex: RegionOne)',
+              :depends_on => [:account_id, :account_key, :auth_uri, :tenant],
+              :list_values => {
+                :query_type => :controller_call,
+                :object => :services,
+                :query_call => :get_services,
+                :query_params => { :list_services => [:Compute, :compute] },
+                :validate => :list_strict
+              }
   )
 
   define_data(:network,
@@ -152,7 +161,15 @@ class Openstack
                 "\nYou can also get it from Project-Compute-Access & Security-"\
                 'API, then download the Openstack RC file. The Region name is '\
                 'set as OS_REGION_NAME.'\
-                "\nIf there is no region shown, you can ignore it."
+                "\nIf there is no region shown, you can ignore it.",
+              :depends_on => [:account_id, :account_key, :auth_uri, :tenant],
+              :list_values => {
+                :query_type => :controller_call,
+                :object => :services,
+                :query_call => :get_services,
+                :query_params => { :list_services => [:Networking, :network] },
+                :validate => :list_strict
+              }
   )
 
   define_obj :server
@@ -308,3 +325,82 @@ class OpenstackController
     controller_error "==>Unable to map '%s'. %s", key, e.message
   end
 end
+
+# Following class describe how FORJ should handle Openstack Cloud objects.
+class OpenstackController
+  # This function requires to return an Array of values or nil.
+  def get_services(sObjectType, oParams)
+    case sObjectType
+    when :services
+      # oParams[sObjectType] will provide the controller object.
+      # This one can be interpreted only by controller code,
+      # except if controller declares how to map with this object.
+      # Processes can deal only process mapped data.
+      # Currently there is no services process function. No need to map.
+      services = oParams[:services]
+      if !oParams[:list_services].is_a?(Array)
+        service_to_find = [oParams[:list_services]]
+      else
+        service_to_find = oParams[:list_services]
+      end
+      # Search for service. Ex: Can be :Networking or network. I currently do
+      # not know why...
+      search_services = services.rh_get(:service_catalog)
+      service = nil
+      service_to_find.each do |sServiceElem|
+        if search_services.key?(sServiceElem)
+          service = sServiceElem
+          break
+        end
+      end
+
+      controller_error 'Unable to find services %s',
+                       service_to_find if service.nil?
+      result = services.rh_get(:service_catalog, service).keys
+      result.delete('name')
+      result.each_index do |iIndex|
+        result[iIndex] = result[iIndex].to_s if result[iIndex].is_a?(Symbol)
+      end
+      return result
+    else
+      controller_error "'%s' is not a valid object for 'get_services'",
+                       sObjectType
+    end
+  end
+
+  def format_retrieve_result(retrieve_result)
+    {
+      :auth_token => retrieve_result['access']['token']['id'],
+      :expires => retrieve_result['access']['token']['expires'],
+      :service_catalog =>
+          get_service_catalog(retrieve_result['access']['serviceCatalog']),
+      :endpoint_url => nil,
+      :cdn_endpoint_url => nil
+    }
+  end
+
+  def get_service_catalog(body)
+    fail 'Unable to parse service catalog.' unless body
+    service_catalog = {}
+    body.each do |s|
+      type = s['type']
+      next if type.nil?
+      type = type.to_sym
+      next if s['endpoints'].nil?
+      service_catalog[type] = {}
+      service_catalog[type]['name'] = s['name']
+      service_catalog = parse_service_catalog_endpoint(s, type, service_catalog)
+    end
+    service_catalog
+  end
+
+  def parse_service_catalog_endpoint(s, type, service_catalog)
+    s['endpoints'].each do |ep|
+      next if ep['region'].nil?
+      next if ep['publicURL'].nil?
+      next if ep['publicURL'].empty?
+      service_catalog[type][ep['region'].to_sym] = ep['publicURL']
+    end
+    service_catalog
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorj
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - forj team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler