lorj 0.2.0 → 1.0.0

data/lib/providers/hpcloud/security_groups.rb

@@ -14,54 +14,55 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
+# HPCloud security groups
 module HPSecurityGroups
-   def HPSecurityGroups.query_sg(oNetworkConnect, sQuery)
-      oNetworkConnect.security_groups.all(sQuery)
-   end
+  def self.query_sg(oNetworkConnect, sQuery)
+    oNetworkConnect.security_groups.all(sQuery)
+  end
 
-   def HPSecurityGroups.create_sg(oNetwork, name, description)
-      params = {:name => name}
-      params[:description] = description if description
-      oNetwork.security_groups.create( params )
-   end
+  def self.create_sg(oNetwork, name, description)
+    params = { :name => name }
+    params[:description] = description if description
+    oNetwork.security_groups.create(params)
+  end
 
-   def HPSecurityGroups.create_rule(oNetwork, hData)
-      oNetwork.security_group_rules.create( hData )
-   end
+  def self.create_rule(oNetwork, hData)
+    oNetwork.security_group_rules.create(hData)
+  end
 
-   def HPSecurityGroups.query_rule(oNetwork, sQuery)
-      oNetwork.security_group_rules.all(sQuery)
-   end
+  def self.query_rule(oNetwork, sQuery)
+    oNetwork.security_group_rules.all(sQuery)
+  end
 
-   def HPSecurityGroups.delete_rule(oNetwork, rule_id)
-      oNetwork.security_group_rules.get(rule_id).destroy
-   end
+  def self.delete_rule(oNetwork, rule_id)
+    oNetwork.security_group_rules.get(rule_id).destroy
+  end
 end
 
+# HPCloud keypairs
 module HPKeyPairs
-   def HPKeyPairs.query_keypair(oComputeConnect, sQuery)
-      cKeyPairs = oComputeConnect.key_pairs.all()
-      aResults = []
-      cKeyPairs.each { |sElem|
-         bSelect = true
-         attributes = sElem.instance_variable_get(:@attributes)
-         sQuery.each { | key, value |
-            if attributes[key] != value
-               bSelect = false
-               break
-            end
-         }
-         aResults.push sElem if bSelect
-      }
-      aResults
-   end
+  def self.query_keypair(oComputeConnect, sQuery)
+    keypairs = oComputeConnect.key_pairs.all
+    results = []
+    keypairs.each do |sElem|
+      is_selected = true
+      attributes = sElem.instance_variable_get(:@attributes)
+      sQuery.each do | key, value |
+        if attributes[key] != value
+          is_selected = false
+          break
+        end
+      end
+      results.push sElem if is_selected
+    end
+    results
+  end
 
-   def HPKeyPairs.get_keypair(oComputeConnect, sId)
-      #byebug
-      oComputeConnect.key_pairs.get(sId)
-   end
+  def self.get_keypair(oComputeConnect, sId)
+    oComputeConnect.key_pairs.get(sId)
+  end
 
-   def HPKeyPairs.create_keypair(oComputeConnect, name, pubkey)
-      oComputeConnect.key_pairs.create( :name => name, :public_key => pubkey)
-   end
+  def self.create_keypair(oComputeConnect, name, pubkey)
+    oComputeConnect.key_pairs.create(:name => name, :public_key => pubkey)
+  end
 end

data/lib/providers/mock/mock.rb

@@ -0,0 +1,144 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# This class describes how to process some actions, and will do everything prior
+# this task to make it to work.
+
+# This Mock controller keep the data in memory in hash/Array data.
+class Mock
+  # mock do not need to use any mapping. It adapts itself to what the process
+  # has defined.
+end
+
+# This Mock controller keep the data in memory in hash/Array data.
+class MockController
+  @@data = {} # rubocop: disable ClassVars
+
+  def create(sObjectType, hParams)
+    PrcLib.debug("Mock: create object '%s' with parameters (hdata) '%s'",
+                 sObjectType, hParams[:hdata])
+
+    result = {}
+    hParams[].keys.each do |key|
+      next if key == :hdata
+      result[key] = hParams[key]
+    end
+    result.merge!(hParams[:hdata])
+
+    @@data[sObjectType] = [] unless @@data.key?(sObjectType)
+
+    array = @@data[sObjectType]
+
+    array.each do | value |
+      fail if value.key?(result[:name])
+    end
+    array << result
+
+    result[:id] = array.length - 1
+
+    # Typical code:
+    # ~ case sObjectType
+    # ~ when :public_ip
+    # Following function can be executed to ensure the object :connection exists
+    # ~ required?(hParams, :connection)
+    # ~ required?(hParams, :server)
+    # ~ ... CODE to create
+    # ~ else
+    # ~ controller_error "'%s' is not a valid object for 'create'", sObjectType
+    # ~ end
+    # The code should return some data
+    # This data will be encapsulated in Lorj::Data object.
+    # data will be extracted by the framework with the controller get_attr
+    # function and mapped.
+    PrcLib.debug("Mock: object '%s' = '%s' is created.", sObjectType, result)
+    result
+  end
+
+  # This function return a collection which have to provide:
+  # functions: [], length, each
+  # Used by network process.
+  def query(sObjectType, sQuery, hParams)
+    PrcLib.debug("Mock: query object '%s' with hdata '%s' using query '%s'",
+                 sObjectType, hParams[:hdata], sQuery)
+
+    return [] unless @@data.key?(sObjectType)
+
+    result = []
+
+    @@data[sObjectType].each do | value |
+      elem = value
+      sQuery.each do | query_key, query_value |
+        elem = nil if !value.key?(query_key) || value[query_key] != query_value
+      end
+      result << elem if elem
+    end
+    result
+  end
+
+  def delete(sObjectType, hParams)
+    PrcLib.debug("Mock: delete object '%s' with hdata '%s'",
+                 sObjectType, hParams[:hdata])
+    return nil unless @@data.key?(sObjectType)
+
+    return false if !hParams.exist?(sObjectType) || hParams[sObjectType].nil?
+    @@data[sObjectType].delete(hParams[sObjectType])
+    PrcLib.debug("Mock: object '%s' = '%s' is deleted.",
+                 sObjectType, hParams[sObjectType])
+    true
+  end
+
+  def get(sObjectType, sUniqId, hParams)
+    PrcLib.debug("Mock: Get object '%s' = '%s' with hdata '%s'",
+                 sObjectType, sUniqId, hParams[:hdata])
+    return nil unless @@data.key?(sObjectType)
+    @@data[sObjectType][sUniqId]
+  end
+
+  def get_attr(oControlerObject, key)
+    # This controller function read the data and
+    # extract the information requested by the framework.
+    # Those data will be mapped to the process data model.
+    # The key is an array, to get data from a level tree.
+    # [data_l1, data_l2, data_l3] => should retrieve data from structure like
+    # data[ data_l2[ data_l3 ] ]
+    attributes = oControlerObject
+
+    attributes.rh_get(key)
+ rescue => e
+   controller_error "Unable to map '%s'.\n%s", key, e.message
+  end
+
+  def set_attr(oControlerObject, key, value)
+    attributes = oControlerObject
+
+    attributes.rh_set(value, key)
+ rescue => e
+   controller_error "Unable to map '%s' on '%s'.\n%s",
+                    key, sObjectType, e.message
+  end
+
+  def update(sObjectType, oObject, hParams)
+    PrcLib.debug("Mock: Update object '%s' = '%s' with hdata '%s'",
+                 sObjectType, sUniqId, hParams[:hdata])
+    return false unless @@data.key?(sObjectType)
+
+    return false unless @@data[sObjectType][oObject[:id]].nil?
+    # Considered hash object is already updated.
+    # This action emule the object save which doesn't make sense in this empty
+    # Mock controller.
+    true
+  end
+end

data/lib/providers/openstack/openstack.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# This class describes how to process some actions, and will do everything prior
+# this task to make it to work.
+class Openstack < BaseDefinition
+  def initialize
+    superclass.provides([:compute, :network])
+  end
+
+  def compute
+    Fog::Compute.new(
+       :provider => :openstack,
+       :openstack_api_key => superclass.oForjAccount.get(:account_id),
+       :openstack_username => superclass.oForjAccount.get(:account_key),
+       :openstack_auth_url => superclass.oForjAccount.get(:auth_uri),
+       :openstack_tenant => superclass.oForjAccount.get(:tenant_id),
+       :openstack_region => superclass.oForjAccount.get(:compute)
+       )
+  end
+
+  def network
+    Fog::Network.new(
+       :provider => :openstack,
+       :openstack_api_key => superclass.oForjAccount.get(:account_id),
+       :openstack_username => superclass.oForjAccount.get(:account_key),
+       :openstack_auth_url => superclass.oForjAccount.get(:auth_uri),
+       :openstack_tenant => superclass.oForjAccount.get(:tenant_id),
+       :openstack_region => superclass.oForjAccount.get(:network)
+       )
+  end
+end

data/lib/providers/templates/compute.rb

@@ -15,28 +15,26 @@
 #    limitations under the License.
 
 # This file is given as an example.
+# This class is automatically derived from ForjCloudBase and ForjProcess
+class Mycloud
+  def provider_compute_new
+    # My fog connection
+    # hget_cloudObjMapping() is a ForjCloudBase function which will build a
+    # hash from data required with needed mapped keys(see core.rb)
+    Fog::Compute.new({ :provider => :mycloud }.merge(hget_cloudObjMapping))
 
-class Mycloud # This class is automatically derived from ForjCloudBase and ForjProcess
-
-   def provider_compute_new
-      # My fog connection
-      # hget_cloudObjMapping() is a ForjCloudBase function which will build a
-      # hash from data required with needed mapped keys(see core.rb)
-      Fog::Compute.new({:provider  => :mycloud}.merge(hget_cloudObjMapping()))
-
-      # If you do not want to get data mapped automatically, you can use
-      # @oForjAccount.get()
-      # This means in following declaration in your core.rb:
-      # obj_needs(:data, :<CloudDataKey},{:mapping => :<MyCloudKeyMapped>})
-      # can be updated by removing the mapping => <Value>
-      Fog::Compute.new({
-         :provider         => :mycloud,
-         :user             => @oForjAccount.get(:account_id),
-         :pwd              => @oForjAccount.get(:account_key),
-         :auth_uri         => @oForjAccount.get(:auth_uri),
-         :project          => @oForjAccount.get(:tenant),
-         :compute_service  => @oForjAccount.get(:compute),
-         })
-
-   end
+    # If you do not want to get data mapped automatically, you can use
+    # @oForjAccount.get()
+    # This means in following declaration in your core.rb:
+    # obj_needs(:data, :<CloudDataKey},{:mapping => :<MyCloudKeyMapped>})
+    # can be updated by removing the mapping => <Value>
+    Fog::Compute.new(
+       :provider => :mycloud,
+       :user => @oForjAccount.get(:account_id),
+       :pwd => @oForjAccount.get(:account_key),
+       :auth_uri => @oForjAccount.get(:auth_uri),
+       :project => @oForjAccount.get(:tenant),
+       :compute_service => @oForjAccount.get(:compute)
+       )
+  end
 end

data/lib/providers/templates/mycloud.rb

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# This file is given as an example.
+
+# require 'fog' # We can use fog to access a cloud
+
+cloud_path = File.expand_path(File.dirname(__FILE__))
+
+require File.join(cloud_path, 'compute.rb')
+require File.join(cloud_path, 'network.rb')
+
+# Defines Meta MyCloud object
+class Mycloud
+  # Defines Object structure and function stored on the Hpcloud class object.
+
+  # ForjCloud has a list of predefined object, like compute_connection, network
+  # , ...
+  # See lib/providers/core/cloud_data_pref.rb
+
+  # Compute Object
+  define_obj :compute_connection
+  # Defines Data used by compute.
+  obj_needs(:data, :account_id,   :mapping => :user)
+  obj_needs(:data, :account_key,  :mapping => :pwd)
+  obj_needs(:data, :auth_uri,     :mapping => :auth_uri)
+  obj_needs(:data, :tenant,       :mapping => :project)
+  obj_needs(:data, :compute,      :mapping => :compute_service)
+
+  define_obj :network_connection
+  obj_needs(:data, :account_id,   :mapping => :user)
+  obj_needs(:data, :account_key,  :mapping => :pwd)
+  obj_needs(:data, :auth_uri,     :mapping => :auth_uri)
+  obj_needs(:data, :tenant,       :mapping => :project)
+  obj_needs(:data, :network,      :mapping => :network_service)
+
+  define_obj :network
+  obj_needs(:CloudObject, :network_connection)
+  obj_needs(:data,        :network_name)
+
+  # defines setup Cloud data
+  # This definition is required only if you need to change the predefined data.
+  # To get details on what kind of parameters can be applied to a CloudData, see
+  # lib/defaults.yaml
+  define_data(:account_id,  :provisioned_by => :setup,
+                            :desc => 'MyCloud username')
+  define_data(:account_key, :provisioned_by => :setup,
+                            :desc => 'HPCloud secret Key')
+  define_data(:auth_uri,    :provisioned_by => :setup,
+                            :desc => 'HPCloud Authentication service URL')
+  define_data(:tenant,      :provisioned_by => :setup,
+                            :desc => 'HPCloud Tenant ID')
+  define_data(:compute,     :provisioned_by => :setup,
+                            :desc => 'HPCloud Compute service zone (Ex: '\
+                                     'region-a.geo-1)')
+  define_data(:network,     :provisioned_by => :setup,
+                            :desc => 'HPCloud Network service zone (Ex: '\
+                                     'region-a.geo-1)')
+end

data/lib/providers/templates/network.rb

@@ -16,18 +16,17 @@
 
 # This file is given as an example.
 
-class Mycloud # This class is automatically derived from ForjCloudBase and ForjProcess
+# This class is automatically derived from ForjCloudBase and ForjProcess
+class Mycloud
+  def provider_network_new
+    Fog::Network.new({ :provider => :mycloud }.merge(hget_cloudObjMapping))
+  end
 
-   def provider_network_new
-      Fog::Network.new({:provider  => :mycloud}.merge(hget_cloudObjMapping()))
-   end
-
-   def provider_query_network(oNetwork, name)
-      oNetwork.networks.all(:name => name)
-   end
-
-   def provider_create_network(oNetwork, name)
-      oNetwork.networks.create(:name => name)
-   end
+  def provider_query_network(oNetwork, name)
+    oNetwork.networks.all(:name => name)
+  end
 
+  def provider_create_network(oNetwork, name)
+    oNetwork.networks.create(:name => name)
+  end
 end