lorj 1.0.3 → 1.0.4

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

@@ -15,6 +15,9 @@
 #    limitations under the License.
 
 # It requires Core objects to be defined + default ForjProcess functions.
+
+# rubocop: disable Style/ClassAndModuleChildren
+
 # ---------------------------------------------------------------------------
 # Router management
 # ---------------------------------------------------------------------------
@@ -23,75 +26,72 @@ class CloudProcess
   def forj_get_or_create_router(_sCloudObj, hParams)
     sub_net_obj = hParams[:subnetwork]
 
-    unless hParams[:router_name]
-      config[:router_name] = 'router-%s', hParams[:network, :name]
-      hParams[:router_name] = config[:router_name]
+    if hParams[:router_name].nil?
+      router_name = format('router-%s', hParams[:network, :name])
+    else
+      router_name = hParams[:router_name]
     end
 
-    router_name = hParams[:router_name]
     router_port = get_router_interface_attached(:port, hParams)
 
-    if !router_port
+    if router_port.length == 0
       # Trying to get router
       router = get_router(router_name)
-      router = create_router(router_name) unless router
+      router = create_router(router_name) if router.empty?
       create_router_interface(sub_net_obj, router) if router
     else
-      router = query_router_from_port(router_port, hParams)
+      router = query_router_from_port(router_port[0], hParams)
     end
     router
   end
 end
 
-# Define framework object on BaseDefinition
-module Lorj
-  # ************************************ Router Object
-  # Identify the router of a network.
-  class BaseDefinition
-    define_obj(:router,
-
-               :create_e => :forj_get_or_create_router,
-               #         :query_e    => :forj_query_router,
-               #         :get_e      => :forj_get_router,
-               :update_e => :controller_update
-               #         :delete_e   => :forj_delete_router
-               )
-    obj_needs :CloudObject,  :network_connection
-    obj_needs :CloudObject,  :network,             :for => [:create_e]
-    obj_needs :CloudObject,  :subnetwork,          :for => [:create_e]
-    obj_needs_optional
-    obj_needs :data,         :router_name,         :for => [:create_e]
-
-    def_attribute :gateway_network_id
-  end
+# Router Object
+# Identify the router of a network.
+class Lorj::BaseDefinition
+  define_obj(:router,
+
+             :create_e => :forj_get_or_create_router,
+             #         :query_e    => :forj_query_router,
+             #         :get_e      => :forj_get_router,
+             :update_e => :controller_update
+             #         :delete_e   => :forj_delete_router
+             )
+  obj_needs :CloudObject,  :network_connection
+  obj_needs :CloudObject,  :network,             :for => [:create_e]
+  obj_needs :CloudObject,  :subnetwork,          :for => [:create_e]
+  obj_needs_optional
+  obj_needs :data,         :router_name,         :for => [:create_e]
+
+  def_attribute :gateway_network_id
+end
 
-  # ************************************ Port Object
-  # Identify port attached to network
-  class BaseDefinition
-    define_obj :port,   :nohandler => true
+# Port Object
+# Identify port attached to network
+class Lorj::BaseDefinition
+  define_obj :port,   :nohandler => true
 
-    obj_needs :CloudObject,  :network_connection
-    def_attribute :device_id
+  obj_needs :CloudObject,  :network_connection
+  def_attribute :device_id
 
-    def_query_attribute :network_id
-    def_query_attribute :device_owner
-  end
+  def_attribute :network_id
+  def_attribute :device_owner
+end
 
-  # ************************************ Router interface Object
-  # Identify interface attached to a router
-  # This object will probably be moved to controller task
-  # To keep the network model more generic.
-  class BaseDefinition
-    # No process handler defined. Just Controller object
-    define_obj :router_interface,   :nohandler => true
+# Router interface Object
+# Identify interface attached to a router
+# This object will probably be moved to controller task
+# To keep the network model more generic.
+class Lorj::BaseDefinition
+  # No process handler defined. Just Controller object
+  define_obj :router_interface,   :nohandler => true
 
-    obj_needs :CloudObject,  :network_connection
-    obj_needs :CloudObject,  :router,              :for => [:create_e]
-    obj_needs :CloudObject,  :subnetwork,          :for => [:create_e]
+  obj_needs :CloudObject,  :network_connection
+  obj_needs :CloudObject,  :router,              :for => [:create_e]
+  obj_needs :CloudObject,  :subnetwork,          :for => [:create_e]
 
-    undefine_attribute :name
-    undefine_attribute :id
-  end
+  undefine_attribute :name
+  undefine_attribute :id
 end
 
 # Router Process internal functions
@@ -99,16 +99,12 @@ class CloudProcess
   def get_router(name)
     PrcLib.state("Searching for router '%s'", name)
     begin
-      routers = controller_query(:router, :name => name)
-      case routers.length
-      when 1
-        routers[0]
-      else
-        PrcLib.info("Router '%s' not found.", name)
-        nil
-      end
-   rescue => e
-     PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
+      query = { :name => name }
+      routers = query_single(:router, query, name)
+      return Lorj::Data.new if routers.length == 0
+      register(routers[0])
+    rescue => e
+      PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
     end
   end
 
@@ -124,7 +120,7 @@ class CloudProcess
                      router_name)
       end
 
-      router = controller_create(:router)
+      router = controller_create(:router, :router_name => router_name)
       if oExternalNetwork
         PrcLib.info("Router '%s' created and attached to the external "\
                     "Network '%s'.", router_name, ext_net)
@@ -133,8 +129,8 @@ class CloudProcess
                     router_name)
       end
    rescue => e
-     raise ForjError.new, "Unable to create '%s' router\n%s",
-           router_name, e.message
+     PrcLib.error "Unable to create '%s' router\n%s\n%s", router_name,
+                  e.message, e.backtrace.join("\n")
     end
     router
   end
@@ -150,20 +146,20 @@ class CloudProcess
     end
   end
 
-  def query_router_from_port(router_port, hParams)
+  def query_router_from_port(router_port, _hParams)
     query = { :id => router_port[:device_id] }
-    routers = controller_query(:router, query)
-    case routers.length
-    when 1
-      PrcLib.info("Found router '%s' attached to the network '%s'.",
-                  routers[0, :name], hParams[:network, :name])
-      routers[0]
-    else
-      PrcLib.warning('Unable to find the router '\
-                     "id '%s'", router_port[:device_id])
-      ForjLib::Data.new
-    end
+    info = {
+      :notfound => 'No %s for port ID %s found',
+      :checkmatch => 'Found 1 %s. Checking exact match for port ID %s.',
+      :nomatch => 'No %s for port ID %s match',
+      :found => "Found %s '%s' from port ID #{router_port[:device_id]}.",
+      :more => 'Found several %s. Searching for port ID %s.'
+    }
+    routers = query_single(:router, query, router_port[:device_id], info)
+    return Lorj::Data.new if routers.length == 0
+    register(routers[0])
   end
+
   # TODO: Move router interface management to hpcloud controller.
   # Router interface to connect to the network
   def create_router_interface(oSubnet, router_obj)
@@ -193,28 +189,26 @@ class CloudProcess
   end
 
   def get_router_interface_attached(sCloudObj, hParams)
-    PrcLib.state("Searching for router port attached to the network '%s'",
-                 hParams[:network, :name])
+    name = hParams[:network, :name]
+    PrcLib.state("Searching for router port attached to the network '%s'", name)
     begin
       # Searching for router port attached
       #################
       query = { :network_id => hParams[
                                :network, :id],
                 :device_owner => 'network:router_interface' }
-
-      ports = controller_query(sCloudObj, query)
-      case ports.length
-      when 0
-        PrcLib.info("No router port attached to the network '%s'",
-                    hParams[:network, :name])
-        nil
-      else
-        PrcLib.info("Found a router port attached to the network '%s' ",
-                    hParams[:network, :name])
-        ports[0]
-      end
-   rescue => e
-     PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
+      info = {
+        :notfound => "No router %s for network '%s' found",
+        :checkmatch => 'Found 1 router %s. '\
+                             "Checking exact match for network '%s'.",
+        :nomatch => "No router %s for network '%s' match",
+        :found => "Found router %s ID %s attached to network '#{name}'.",
+        :more => "Found several router %s. Searching for network '%s'.",
+        :items => [:id]
+      }
+      query_single(sCloudObj, query, name, info)
+    rescue => e
+      PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
     end
   end
 
@@ -244,7 +238,7 @@ class CloudProcess
       case networks.length
       when 0
         PrcLib.info('No external network')
-        ForjLib::Data.new
+        Lorj::Data.new
       when 1
         PrcLib.info("Found external network '%s'.", networks[0, :name])
         networks[0]

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

@@ -16,6 +16,8 @@
 
 # It requires Core objects to be defined + default ForjProcess functions.
 
+# rubocop: disable Style/ClassAndModuleChildren
+
 # SecurityGroups rules management
 class CloudProcess
   # Process Delete handler
@@ -58,7 +60,6 @@ class CloudProcess
       :addr_map => hParams[:addr_map],
       :sg_id => hParams[:sg_id]
     }
-
     rules = forj_query_rule(sCloudObj, query, hParams)
     if rules.length == 0
       create_rule(sCloudObj, hParams)
@@ -68,35 +69,32 @@ class CloudProcess
   end
 end
 
-# Define framework object on BaseDefinition
-module Lorj
-  # ************************************ Security group rules Object
-  # Identify Rules attached to the security group
-  class BaseDefinition
-    define_obj(:rule,
+# Security group rules Object
+# Identify Rules attached to the security group
+class Lorj::BaseDefinition
+  define_obj(:rule,
 
-               :create_e => :forj_get_or_create_rule,
-               :query_e => :forj_query_rule
-               #         :delete_e   => :forj_delete_rule
-               )
+             :create_e => :forj_get_or_create_rule,
+             :query_e => :forj_query_rule
+             #         :delete_e   => :forj_delete_rule
+             )
 
-    undefine_attribute :name  # Do not return any predefined name attribute
+  undefine_attribute :name  # Do not return any predefined name attribute
 
-    obj_needs :CloudObject, :network_connection
-    obj_needs :CloudObject, :security_groups, :for => [:create_e]
-    obj_needs :data,        :sg_id, :for => [:create_e],
-                                    :extract_from => [:security_groups,
-                                                      :attrs, :id]
+  obj_needs :CloudObject, :network_connection
+  obj_needs :CloudObject, :security_groups, :for => [:create_e]
+  obj_needs :data,        :sg_id, :for => [:create_e],
+                                  :extract_from => [:security_groups,
+                                                    :attrs, :id]
 
-    obj_needs :data,        :dir,                 :for => [:create_e]
-    predefine_data_value :IN,   :desc => 'Input NAT/firewall rule map type'
-    predefine_data_value :OUT,  :desc => 'Output NAT/firewall rule map type'
+  obj_needs :data,        :dir,                 :for => [:create_e]
+  predefine_data_value :IN,   :desc => 'Input NAT/firewall rule map type'
+  predefine_data_value :OUT,  :desc => 'Output NAT/firewall rule map type'
 
-    obj_needs :data,        :proto,               :for => [:create_e]
-    obj_needs :data,        :port_min,            :for => [:create_e]
-    obj_needs :data,        :port_max,            :for => [:create_e]
-    obj_needs :data,        :addr_map,            :for => [:create_e]
-  end
+  obj_needs :data,        :proto,               :for => [:create_e]
+  obj_needs :data,        :port_min,            :for => [:create_e]
+  obj_needs :data,        :port_max,            :for => [:create_e]
+  obj_needs :data,        :addr_map,            :for => [:create_e]
 end
 
 # SecurityGroups rules management
@@ -104,17 +102,18 @@ class CloudProcess
   # Rules internal #
   #----------------#
   def create_rule(sCloudObj, hParams)
-    rule = '%s %s:%s - %s to %s', hParams[:dir], hParams[:rule_proto],
-           hParams[:port_min], hParams[:port_max],
-           hParams[:addr_map]
-    PrcLib.state("Creating rule '%s'", rule)
+    rule_msg = format('%s %s:%s - %s to %s',
+                      hParams[:dir], hParams[:rule_proto],
+                      hParams[:port_min], hParams[:port_max],
+                      hParams[:addr_map])
+    PrcLib.state("Creating rule '%s'", rule_msg)
     ssl_error_obj = SSLErrorMgt.new
     begin
       rule = controller_create(sCloudObj)
-      PrcLib.info("Rule '%s' created.", rule)
+      PrcLib.info("Rule '%s' created.", rule_msg)
     rescue StandardError => e
       retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
-      PrcLib.error 'error creating the rule for port %s', rule
+      PrcLib.error 'error creating the rule "%s"', rule_msg
     end
     rule
   end

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

@@ -16,6 +16,8 @@
 
 # It requires Core objects to be defined + default ForjProcess functions.
 
+# rubocop: disable Style/ClassAndModuleChildren
+
 # SecurityGroups management
 class CloudProcess
   # Process Create handler
@@ -42,14 +44,15 @@ class CloudProcess
         portmax = (port_found_match[3]) ? (port_found_match[3]) : (portmin)
         # Need to set runtime data to get or if missing
         # create the required rule.
-        config[:dir]        = :IN
-        config[:proto] = 'tcp'
-        config[:port_min]   = portmin.to_i
-        config[:port_max]   = portmax.to_i
-        config[:addr_map]   = '0.0.0.0/0'
+        params = {}
+        params[:dir]        = :IN
+        params[:proto] = 'tcp'
+        params[:port_min]   = portmin.to_i
+        params[:port_max]   = portmax.to_i
+        params[:addr_map]   = '0.0.0.0/0'
 
         # object.Create(:rule)
-        process_create(:rule)
+        process_create(:rule, params)
       end
     end
     security_group
@@ -87,23 +90,19 @@ class CloudProcess
   end
 end
 
-# Define framework object on BaseDefinition
-module Lorj
-  # ************************************ Security groups Object
-  # Identify security_groups
-  class BaseDefinition
-    define_obj(:security_groups,
-
-               :create_e => :forj_get_or_create_sg,
-               :query_e => :forj_query_sg,
-               :delete_e => :forj_delete_sg
-               )
+# ************************************ Security groups Object
+# Identify security_groups
+class Lorj::BaseDefinition
+  define_obj(:security_groups,
+             :create_e => :forj_get_or_create_sg,
+             :query_e => :forj_query_sg,
+             :delete_e => :forj_delete_sg
+             )
 
-    obj_needs :CloudObject,  :network_connection
-    obj_needs :data,         :security_group,      :for => [:create_e]
-    obj_needs_optional
-    obj_needs :data,         :sg_desc,             :for => [:create_e]
-  end
+  obj_needs :CloudObject,  :network_connection
+  obj_needs :data,         :security_group,      :for => [:create_e]
+  obj_needs_optional
+  obj_needs :data,         :sg_desc,             :for => [:create_e]
 end
 
 # SecurityGroups Process internal functions #

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

@@ -16,6 +16,8 @@
 
 # It requires Core objects to be defined + default ForjProcess functions.
 
+# rubocop: disable Style/ClassAndModuleChildren
+
 # ---------------------------------------------------------------------------
 # Server management
 # ---------------------------------------------------------------------------
@@ -62,42 +64,39 @@ class CloudProcess
   end
 end
 
-# Define framework object on BaseDefinition
-module Lorj
-  # ************************************ SERVER Object
-  # Identify the server to use/build on the network/...
-  class BaseDefinition
-    define_obj(:server,
+# SERVER Object
+# Identify the server to use/build on the network/...
+class Lorj::BaseDefinition
+  define_obj(:server,
 
-               :create_e => :forj_get_or_create_server,
-               :query_e => :forj_query_server,
-               :get_e => :forj_get_server,
-               #         :update_e   => :forj_update_server,
-               :delete_e => :forj_delete_server
-               )
+             :create_e => :forj_get_or_create_server,
+             :query_e => :forj_query_server,
+             :get_e => :forj_get_server,
+             #         :update_e   => :forj_update_server,
+             :delete_e => :forj_delete_server
+             )
 
-    obj_needs :CloudObject,  :compute_connection
-    obj_needs :CloudObject,  :flavor,              :for => [:create_e]
-    obj_needs :CloudObject,  :network,             :for => [:create_e]
-    obj_needs :CloudObject,  :security_groups,     :for => [:create_e]
-    obj_needs :CloudObject,  :keypairs,            :for => [:create_e]
-    obj_needs :CloudObject,  :image,               :for => [:create_e]
-    obj_needs :data,         :server_name,         :for => [:create_e]
+  obj_needs :CloudObject,  :compute_connection
+  obj_needs :CloudObject,  :flavor,              :for => [:create_e]
+  obj_needs :CloudObject,  :network,             :for => [:create_e]
+  obj_needs :CloudObject,  :security_groups,     :for => [:create_e]
+  obj_needs :CloudObject,  :keypairs,            :for => [:create_e]
+  obj_needs :CloudObject,  :image,               :for => [:create_e]
+  obj_needs :data,         :server_name,         :for => [:create_e]
 
-    obj_needs_optional
-    obj_needs :data,         :user_data,           :for => [:create_e]
-    obj_needs :data,         :meta_data,           :for => [:create_e]
+  obj_needs_optional
+  obj_needs :data,         :user_data,           :for => [:create_e]
+  obj_needs :data,         :meta_data,           :for => [:create_e]
 
-    def_attribute :status
-    predefine_data_value :create,   :desc => 'Server is creating.'
-    predefine_data_value :boot,     :desc => 'Server is booting.'
-    predefine_data_value :active,   :desc => 'Server is started.'
-    def_attribute :private_ip_address
-    def_attribute :public_ip_address
+  def_attribute :status
+  predefine_data_value :create,   :desc => 'Server is creating.'
+  predefine_data_value :boot,     :desc => 'Server is booting.'
+  predefine_data_value :active,   :desc => 'Server is started.'
+  def_attribute :private_ip_address
+  def_attribute :public_ip_address
 
-    def_attribute :image_id
-    def_attribute :key_name
-  end
+  def_attribute :image_id
+  def_attribute :key_name
 end
 
 # Internal Process function

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

@@ -16,20 +16,19 @@
 
 # It requires Core objects to be defined + default ForjProcess functions.
 
-# Define framework object on BaseDefinition
-module Lorj
-  # ************************************ SERVER Console Object
-  # Object representing the console log attached to a server
-  class BaseDefinition
-    define_obj(:server_log,
+# rubocop: disable Style/ClassAndModuleChildren
 
-               :get_e => :forj_get_server_log
-               )
+# SERVER Console Object
+# Object representing the console log attached to a server
+class Lorj::BaseDefinition
+  define_obj(:server_log,
 
-    obj_needs :CloudObject,  :server
-    obj_needs :data,         :log_lines
-    undefine_attribute :name
-    undefine_attribute :id
-    def_attribute :output
-  end
+             :get_e => :forj_get_server_log
+             )
+
+  obj_needs :CloudObject,  :server
+  obj_needs :data,         :log_lines
+  undefine_attribute :name
+  undefine_attribute :id
+  def_attribute :output
 end

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

@@ -16,13 +16,15 @@
 
 # It requires Core objects to be defined + default ForjProcess functions.
 
+# rubocop: disable Style/ClassAndModuleChildren
+
 # Subnetwork Management
 class CloudProcess
   def forj_get_or_create_subnetwork(sCloudObj, hParams)
-    subnet = query_subnet_one(sCloudObj, hParams)
-    unless subnet.empty?
-      register(subnet)
-      return subnet
+    subnets = query_subnet(sCloudObj, hParams)
+    unless subnets.length == 0
+      register(subnets[0])
+      return subnets[0]
     end
 
     # Create the subnet
@@ -34,21 +36,18 @@ class CloudProcess
   end
 end
 
-# ************************************ SubNetwork Object model
 # Define framework object on BaseDefinition
-module Lorj
-  # Identify subnetwork as part of network.
-  class BaseDefinition
-    define_obj(:subnetwork,
-               :create_e => :forj_get_or_create_subnetwork
-              )
+# Identify subnetwork as part of network.
+class Lorj::BaseDefinition
+  define_obj(:subnetwork,
+             :create_e => :forj_get_or_create_subnetwork
+            )
 
-    obj_needs :CloudObject,  :network_connection
-    obj_needs :CloudObject,  :network
-    obj_needs :data,         :subnetwork_name
+  obj_needs :CloudObject,  :network_connection
+  obj_needs :CloudObject,  :network
+  obj_needs :data,         :subnetwork_name
 
-    def_query_attribute :network_id
-  end
+  def_attribute :network_id
 end
 
 # Subnetwork Management - internal functions
@@ -57,7 +56,7 @@ class CloudProcess
     name = hParams[:subnetwork_name]
     PrcLib.state("Creating subnet '%s'", name)
     begin
-      subnet = controller_create(sCloudObj)
+      subnet = controller_create(sCloudObj, hParams)
       PrcLib.info("Subnet '%s' created.", subnet[:name])
    rescue => e
      PrcLib.fatal(1, "Unable to create '%s' subnet.", name, e)
@@ -78,34 +77,20 @@ class CloudProcess
     end
   end
 
-  def query_subnet_one(_sCloudObj, hParams)
+  def query_subnet(sCloudObj, hParams)
     PrcLib.state('Searching for sub-network attached to '\
                  "network '%s'", hParams[:network, :name])
     #######################
     begin
       query = { :network_id => hParams[:network, :id] }
-      subnets = controller_query(:subnetwork, query)
-   rescue => e
-     PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
-    end
-    return nil if subnets.nil?
-
-    case subnets.length
-    when 0
-      PrcLib.info('No subnet found from '\
-                  "'%s' network", hParams[:network, :name])
-      ForjLib::Data.new
-    when 1
-      PrcLib.info("Found '%s' subnet from "\
-                  "'%s' network", subnets[0, :name],
-                  hParams[:network, :name])
-      subnets[0]
-    else
-      PrcLib.warning('Several subnet was found on '\
-                     "'%s'. Choosing the first one "\
-                     "= '%s'", hParams[:network, :name],
-                     subnets[0, :name])
-      subnets[0]
+      info = {
+        :notfound => "No %s found from '%s' network",
+        :checkmatch => "Found 1 %s. checking exact match for network '%s'.",
+        :nomatch => "No %s for network '%s' match"
+      }
+      query_single(sCloudObj, query, hParams[:network, :name], info)
+    rescue => e
+      PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
     end
   end
 end