openstack-router 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff6163ba07f33adc553faed4b8da3a88ef16e4358deaf076e9b43f1d93712eb7
-  data.tar.gz: f486bfd58299931d24248d7d46ee294005cffd5115f5188853ff8a2435c3555f
+  metadata.gz: c625802ba2090efd3f6e782bc28577d48cccdb75d5562d5730e113e00595ea54
+  data.tar.gz: 6799ba121d667839b22bd30153a22752166e7fa7178e02b1ee1ba7ad9b586bd2
 SHA512:
-  metadata.gz: bb7eb683c5131e481342f5146c6ee86e91f9ba3fb22110a3b2f26114ec18a793d559df219a25009e6f1e4ccdae8828742335ddf82661ba2f6400150ced194938
-  data.tar.gz: 84c5203c72ea459d7ae0ceb5475e6444487db240760128ef55e3b1ac65d93d5e3b0ab10d3a9f634e26bb1e34b72efa408b77596025c71ad35cced5b02364d17d
+  metadata.gz: 3a579014ffac9edc697d7694fbe7bc85a7f47fd72b6841e1708001800d198b11ff8100d4e91076f043530afb82ed99a3f91f76ecb6a558eb1c28bf01e25817e3
+  data.tar.gz: 78ae040b3471a1cc43d1cf77370360c728a7f32004e19452097a4d45c03cdbafca29b1ddd205c03ab89375d4a1999f589045bdfc1f684bd633b90758df201ff8

data/README.md

@@ -4,15 +4,20 @@
 [![Gem Version](https://badge.fury.io/rb/openstack-router.svg)](https://badge.fury.io/rb/openstack-router)
 [![coverage report](https://gitlab.com/rol_public/openstack-router/badges/master/coverage.svg)](https://gitlab.com/rol_public/openstack-router/commits/master)
 
-This lib is an overlay/router of OpenStack components and region.
+This lib is an overlay/router of OpenStack services and region.
+It's goal will not be to write a wrapper for the requests themself.
 
 # Current state and goal
 
-Currently we are not far. So no good explaination for now.
-
 ## Currently (what we have)
 
-TBD
+We can manipulate several regions through a single interface.
+We can launch a request on all regions, or through "circuits" of roundrobin
+operations. This means that you can have several ressources you want to be
+created in a roundrobin way, but you don't want instances roundrobin mix with
+volume ones for example, or maybe you need to create several kinds of instances
+with different roundrobin circuits (allowing small servers or big servers to be
+better splattered).
 
 ## v1 goal
 
@@ -20,6 +25,12 @@ TBD
 - Allow to interact simply between regions:
   - create resources where possible (with a round-robin scheme for example)
   - copy images from a region to all the other ...
+- Create some helpers to get all the images available
+- if possible get a mean to detect all the regions of the cluster.
+
+## Outside the scope of this library
+
+- Not a wrapper for the requests them-selfs.
 
 # Install and usage
 

data/lib/openstack-router/parameter/connection.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module OpenStackRouter
+  # Contain all the classes that will treat complexe parameters of other classes.
   module Parameter
     # This class is used to parameter the connection to OpenStack instance and services.
     # Its purpose is to encapsulate the connection parameters.
@@ -45,6 +46,7 @@ module OpenStackRouter
         ALL_OPTIONS.map { |key| [key, send(key)] }.to_h
       end
 
+      # convert to string the options (first convert to Hash, then the Hash to String)
       def to_s
         to_h.to_s
       end

data/lib/openstack-router/region.rb

@@ -7,90 +7,78 @@ module OpenStackRouter
   #
   # @author Roland Laurès
   # @attr_reader [String] name The region name.
-  # @attr_reader [Symbol] state The region's state:
-  #   * operating: connected and fully operational
-  #   * limited: connected but some limits has been reached
-  #   * failed: some connection problems occured
-  # @attr_reader [Hash] connection_parameters The parameters to connect to OpenStack
+  # @attr_reader [Symbol] state The region's state. @see {Region::STATES} descriptions
+  # @attr_reader [Parameter::Connection] connection_parameters The parameters to connect to OpenStack
   #   services.
   class Region
+    # The possible states of a Region
     STATES = [
+      # connected and fully operational
       STATE_OPERATING = :operating,
+      # connected but some limits has been reached
       STATE_LIMITED = :limited,
+      # some connection problems occured
       STATE_FAILED = :failed
     ].freeze
     attr_reader :state
     attr_reader :connection_parameters
+    attr_reader :name
 
-    def initialize(connection_parameters)
-      unless connection_parameters.class == Parameter::Connection
-        raise ArgumentError, 'Invalid connection parameters: Please use OpenStackRouter::Parameter::Connection'
-      end
-      unless connection_parameters.present? :region
-        raise ArgumentError, 'Invalid connection parameters: Please specify region name.'
-      end
+    def initialize(name, connection_parameters)
+      @name = name
+      @connection_parameters = Parameter::Connection.new(connection_parameters.to_h.merge(region: name))
 
-      @compute = @image = nil
-      @connection_parameters = connection_parameters
-      @state = STATE_FAILED
-      connect
-    end
-
-    def name
-      @connection_parameters.region
-    end
-
-    # get the limitation in this region for this project
-    # @see https://developer.openstack.org/api-ref/compute/#show-rate-and-absolute-limits
-    #   The OpenStack API reference for this request.
-    # @return [Hash] if all goes well
-    # @return nil on error
-    def limits
-      request_wrapper(@compute, :get_limits) do |limits_answer|
-        break nil if limits_answer.status != 200
-
-        limits_answer.body['limits']
-      end
+      @services = {}
+      @state = STATE_OPERATING
     end
 
-    # get the list of images available on that region.
-    # @see https://developer.openstack.org/api-ref/image/v2/?expanded=list-images-detail#list-images
-    #   The description of images list request.
-    #   You can use the request options with key/value optional argument.
-    # @param [Hash] opts The options to pass to image#images list request.
+    # This method allow to call a request on a service for this region.
+    # If the service hasn't been already connected it will be connected.
+    #
+    # @param [Symbol] service The service to contact (:compute, :image...)
+    # @param [symbol] request_name The request to do on that service.
+    #   It must exist else an exception will be raised.
+    # @param [Array] args All other arguments will be passed to the requested
+    #   method.
     #
-    # @return [Array] containing
-    # @return nil on error
-    def images(opts = {})
-      request_wrapper(@image, :list_images, opts) do |list_images_answer|
-        # 204 is include because the Fog.mock implementation returns 200 | 204 randomly...
-        break nil unless [200, 204].include?(list_images_answer.status)
+    # @return [NilClass | 'a | Excon::Response]
+    #   * nil if a SocketError occurs and
+    #     the region cannot be reached.
+    #   * +'a+ is the type returned by the block you give
+    #   * Excon::Response is return if no block is given and no error is raised.
+    #
+    # @yield [answer] Block called with the answer for you to filter.
+    #
+    # @yieldparam [Excon::Response] answer The answer of the request
+    # @yieldreturn ['a] You return what you want. It will be then return without
+    #   being touched by the method.
+    #   Since nothing is done after yielding, then you can use the +return+ keyword
+    #   from the block instead of +break+. But for safety, we recommand using +break+.
+    def request(service, request_name, *args, &block)
+      service = service.to_s.capitalize
+      return nil if @state == STATE_FAILED && setup(service) == STATE_FAILED
 
-        list_images_answer.body['images']
-      end
+      do_request(service, request_name, *args, &block)
     end
 
     private
 
-    def connect
-      cp = connection_parameters.to_os_h
-      @compute = Fog::OpenStack::Compute.new cp
-      @image = Fog::OpenStack::Image.new cp
+    def setup(service)
+      @services[service] = Object.const_get(Fog::OpenStack.service_klass(service)).new(@connection_parameters.to_os_h)
       @state = STATE_OPERATING
+    rescue SocketError
+      @state = STATE_FAILED if @services.empty?
+      STATE_FAILED
     end
 
-    def do_request(ctl, request_name, *args)
-      answer = ctl.send(request_name, *args)
+    def do_request(service, request_name, *args)
+      setup(service) unless @services.key?(service)
+      answer = @services[service].send(request_name, *args)
       block_given? ? yield(answer) : answer
     rescue SocketError
-      @state = STATE_FAILED
+      @services.delete(service)
+      @state = STATE_FAILED if @services.empty?
       nil
     end
-
-    def request_wrapper(ctl, request_name, *args, &block)
-      return nil if @state == STATE_FAILED && connect == STATE_FAILED
-
-      do_request(ctl, request_name, *args, &block)
-    end
   end
 end

data/lib/openstack-router/router.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 module OpenStackRouter
   # The main class of the module.
   # It aims to be the uniq entry point to access all the OpenStack services
@@ -8,19 +10,75 @@ module OpenStackRouter
   # @author Roland Laurès
   # @attr_reader [Parameter::Connection] connection_parameters
   #   The connection parameters.
-  # @attr_reader [Regions] regions The regions object used to
+  # @attr_reader [Array<Region>] regions The regions object used to
   #   manage the by region stuffs.
   class Router
     attr_reader :connection_parameters
     attr_reader :regions
 
-    def initialize(connection_parameters, regions_name)
+    def initialize(connection_parameters, region_names)
       unless connection_parameters.class == Parameter::Connection
         raise ArgumentError, 'Invalid connection parameters. Please use OpenStackRouter::Parameter::Connection'
       end
 
       @connection_parameters = connection_parameters
-      @regions = regions_name
+      @regions = region_names.map { |region_name| Region.new(region_name, @connection_parameters) }
+      @rr_circuits = {}
+    end
+
+    # This method do a request on a service for each region in the router.
+    #
+    # @param [String | Symbol] service The service you want to interogate
+    #   Service name should be capitalized, but by precaution, it is converted to string and capitalized
+    #   at each request. :compute will be converted to 'Compute'.
+    # @param [Symbol] request This is the request you want to launch on the regions' service.
+    #   This is a method call, and then must be a Symbol.
+    #   @see https://github.com/fog/fog-openstack For more information on available services and requests name
+    #
+    # @return [Hash] The result of each region, the key being the region_name and the value the
+    #   result of Region#request with the given argument.
+    #   @see Region#request to understand how the block is managed.
+    def request_each(service, request, *request_args, &block)
+      # TODO: make the requests to be parallele to no do them sequentialy...
+      Hash[@regions.map do |region|
+        [region.name, region.request(service, request, *request_args, &block)]
+      end]
+    end
+
+    # Create an UUID for a round robin circuit.
+    # This allow to identify a round robin "group" that you can use for a given request or
+    # group of request.
+    #
+    # @return [String] A randomly generated UUID.
+    def rr_create
+      key = SecureRandom.uuid
+      @rr_circuits[key] = nil
+      key
+    end
+
+    # @return [NilClass | Region] the last used region for that round robin circuit.
+    #   nil is return if the circuit hasn't been used yet.
+    def rr_last_region(rr_uuid)
+      raise ArgumentError, 'Invalid UUID given' unless @rr_circuits.key?(rr_uuid)
+
+      @rr_circuits[rr_uuid]
+    end
+
+    def rr_request(rr_uuid, service, request, *request_args, &block)
+      raise ArgumentError, 'Invalid UUID given' unless @rr_circuits.key?(rr_uuid)
+
+      rr_next_region(rr_uuid).request(service, request, *request_args, &block)
+    end
+
+    private
+
+    def rr_next_region(rr_uuid)
+      last_idx = @rr_circuits[rr_uuid]
+      n_regions = @regions.length
+      @rr_circuits[rr_uuid] = if last_idx.nil? then SecureRandom.rand(n_regions)
+                              else (@rr_circuits[rr_uuid] + 1).modulo(n_regions)
+                              end
+      @regions[@rr_circuits[rr_uuid]]
     end
   end
 end

data/lib/openstack-router/version.rb

@@ -2,5 +2,5 @@
 
 module OpenStackRouter
   # The version number of this library
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstack-router
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Roland Laurès
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-03 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-openstack