fog-openstack 0.1.2 → 0.1.3

data/lib/fog/openstack/docs/planning.md

@@ -17,13 +17,13 @@ If using Ruby 1.8.x execute:
 
 ```ruby
 require 'rubygems'
-require 'fog'
+require 'fog/openstack'
 ```
 
 If using Ruby 1.9.x execute:
 
 ```ruby
-require 'fog'
+require 'fog/openstack'
 ```
 
 ## Create Service

data/lib/fog/openstack/docs/storage.md

@@ -15,13 +15,13 @@ If using Ruby 1.8.x execute:
 
 ```ruby
 require 'rubygems'
-require 'fog'
+require 'fog/openstack'
 ```
 
 If using Ruby 1.9.x execute:
 
 ```ruby
-require 'fog'
+require 'fog/openstack'
 ```
 
 ## Create Service
@@ -29,8 +29,7 @@ require 'fog'
 Next, create a connection to Swift:
 
 ```ruby
-service = Fog::Storage.new({
-  :provider            => 'OpenStack',   # OpenStack Fog provider
+service = Fog::Storage::OpenStack.new({
   :openstack_username  => USERNAME,      # Your OpenStack Username
   :openstack_api_key   => PASSWORD,      # Your OpenStack Password
   :openstack_auth_url  => 'http://YOUR_OPENSTACK_ENDPOINT:PORT/v2.0/tokens'

data/lib/fog/openstack/examples/compute/basics.rb

@@ -1,6 +1,6 @@
 # OpenStack Compute (Nova) Example
 
-require 'fog'
+require 'fog/openstack'
 
 auth_url = "https://example.net/v2.0/tokens"
 username = 'admin@example.net'

data/lib/fog/openstack/examples/compute/block_device_mapping_v2.rb

@@ -1,6 +1,5 @@
 # OpenStack Compute (Nova) Example
 
-require 'fog'
 require 'fog/openstack'
 
 auth_url = "https://example.net/v2.0/tokens"
@@ -8,8 +7,7 @@ username = 'admin@example.net'
 password = 'secret'
 tenant   = 'My Compute Tenant' # String
 
-compute_client ||= ::Fog::Compute.new(
-  :provider           => :openstack,
+compute_client ||= ::Fog::Compute::OpenStack.new(
   :openstack_api_key  => password,
   :openstack_username => username,
   :openstack_auth_url => auth_url,

data/lib/fog/openstack/examples/identity/basics.rb

@@ -1,18 +1,17 @@
 # OpenStack Identity Service (Keystone) Example
 
-require 'fog'
+require 'fog/openstack'
 require 'pp'
 
 auth_url = "https://example.net/v2.0/tokens"
 username = 'admin@example.net'
 password = 'secret'
 
-keystone = Fog::Identity.new :provider           => 'OpenStack',
-                             :openstack_auth_url => auth_url,
-                             :openstack_username => username,
-                             :openstack_api_key  => password
-                             # Optional, self-signed certs
-                             #:connection_options => { :ssl_verify_peer => false }
+keystone = Fog::Identity::OpenStack.new :openstack_auth_url => auth_url,
+                                        :openstack_username => username,
+                                        :openstack_api_key  => password
+                                        # Optional, self-signed certs
+                                        #:connection_options => { :ssl_verify_peer => false }
 
 #
 # Listing keystone tenants

data/lib/fog/openstack/examples/image/upload-test-image.rb

@@ -1,7 +1,7 @@
 require 'securerandom'
 require 'rubygems/package'
 require 'zlib'
-require 'fog'
+require 'fog/openstack'
 
 #
 # Download CirrOS 0.3.0 image from launchpad (~6.5MB) to /tmp
@@ -43,13 +43,10 @@ Gem::Package::TarReader.new(Zlib::GzipReader.open(image_out.path)).each do |entr
   end
 end
 
-image_service = Fog::Image.new({
-  :provider => 'OpenStack',
-  :openstack_api_key => ENV['OS_PASSWORD'],
-  :openstack_username => ENV["OS_USERNAME"],
-  :openstack_auth_url => ENV["OS_AUTH_URL"] + "/tokens",
-  :openstack_tenant => ENV["OS_TENANT_NAME"]
-})
+image_service = Fog::Image::OpenStack.new :openstack_api_key => ENV['OS_PASSWORD'],
+                                          :openstack_username => ENV["OS_USERNAME"],
+                                          :openstack_auth_url => ENV["OS_AUTH_URL"] + "/tokens",
+                                          :openstack_tenant => ENV["OS_TENANT_NAME"]
 
 puts "Uploading AKI..."
 aki = image_service.images.create :name => 'cirros-0.3.0-amd64-aki',

data/lib/fog/openstack/examples/introspection/basics.rb

@@ -0,0 +1,75 @@
+
+require 'rubygems'
+require 'fog/openstack' # version >= 1.37
+
+auth_url = "https://example.net:5000/v3/auth/tokens"
+username = 'admin@example.net'
+password = 'secret'
+project  = 'admin'
+
+@connection_params = {
+  :openstack_auth_url     => auth_url,
+  :openstack_username     => username,
+  :openstack_api_key      => password,
+  :openstack_project_name => project,
+  :openstack_domain_id    => "default"
+}
+
+inspector = Fog::Introspection::OpenStack.new(@connection_params)
+
+# Introspection of an Ironic node
+ironic = Fog::Baremetal::OpenStack.new(@connection_params)
+nodes = ironic.list_nodes
+node1_uuid = nodes.body["nodes"][0]["uuid"]
+
+# Launch introspection
+inspector.create_introspection(node1_uuid)
+
+# Introspection status
+inspector.get_introspection(node1_uuid)
+
+# Abort introspection
+inspector.abort_introspection(node1_uuid)
+
+# Retrieve introspection data
+# Note: introspection must be finished and ended successfully
+inspector.get_introspection_details(node1_uuid)
+
+## Introspection Rules
+# Create a set of rules
+rules = {
+  "description" => "Successful Rule",
+  "actions"     => [
+    {
+      "action" => "set-attribute",
+      "path"   => "/extra/rule_success",
+      "value"  => "yes"
+    }
+  ],
+  "conditions"  => [
+    {
+      "field" => "memory_mb",
+      "op"    => "ge",
+      "value" => 256
+    },
+    {
+      "field" => "local_gb",
+      "op"    => "ge",
+      "value" => 1
+    }
+  ]
+}
+inspector.create_rules(rules)
+
+# List all rules set
+rules1 = inspector.list_rules
+
+# Show a rules set
+rules1_uuid = rules1[:body]["rules"][0]['uuid']
+inspector.get_rules(rules1_uuid)
+
+# Delete a specific rules set
+inspector.delete_rules(rules1_uuid)
+
+# Destroys all rules sets
+inspector.delete_rules_all

data/lib/fog/openstack/examples/planning/basics.rb

@@ -1,6 +1,6 @@
 # OpenStack Planning Service (Tuskar) Example
 
-require 'fog'
+require 'fog/openstack'
 require 'pp'
 
 auth_url = "https://example.net/v2.0/tokens"

data/lib/fog/openstack/examples/storage/set-account-quota.rb

@@ -1,4 +1,4 @@
-require 'fog'
+require 'fog/openstack'
 require 'pp'
 
 #
@@ -28,18 +28,16 @@ Excon.defaults[:ssl_verify_peer] = false
 # to retrieve the list of tenants available and find
 # the tenant we want to set the quotas for.
 #
-id = Fog::Identity.new :provider => 'OpenStack',
-                       :openstack_auth_url => auth_url,
-                       :openstack_username => user,
-                       :openstack_api_key  => password
+id = Fog::Identity::OpenStack.new :openstack_auth_url => auth_url,
+                                  :openstack_username => user,
+                                  :openstack_api_key  => password
 
 #
 # Storage service (Swift)
 #
-st = Fog::Storage.new :provider => 'OpenStack',
-                      :openstack_auth_url => auth_url,
-                      :openstack_username => user,
-                      :openstack_api_key  => password
+st = Fog::Storage::OpenStack.new :openstack_auth_url => auth_url,
+                                 :openstack_username => user,
+                                 :openstack_api_key  => password
 
 id.tenants.each do |t|
   # We want to set the account quota for tenant demo@test.lan

data/lib/fog/openstack/identity.rb

@@ -3,25 +3,119 @@
 module Fog
   module Identity
     class OpenStack < Fog::Service
+      requires :openstack_auth_url
+      recognizes :openstack_auth_token, :openstack_management_url, :persistent,
+                 :openstack_service_type, :openstack_service_name, :openstack_tenant,
+                 :openstack_endpoint_type, :openstack_region, :openstack_domain_id,
+                 :openstack_project_name, :openstack_domain_name,
+                 :openstack_user_domain, :openstack_project_domain,
+                 :openstack_user_domain_id, :openstack_project_domain_id,
+                 :openstack_api_key, :openstack_current_user_id, :openstack_userid, :openstack_username,
+                 :current_user, :current_user_id, :current_tenant,
+                 :provider, :openstack_identity_prefix, :openstack_endpoint_path_matches
 
       # Fog::Identity::OpenStack.new() will return a Fog::Identity::OpenStack::V2 or a Fog::Identity::OpenStack::V3,
       #  depending on whether the auth URL is for an OpenStack Identity V2 or V3 API endpoint
       def self.new(args = {})
-        @openstack_auth_uri = URI.parse(args[:openstack_auth_url]) if args[:openstack_auth_url]
         if self.inspect == 'Fog::Identity::OpenStack'
-          service = (is_v3? args) ? Fog::Identity::OpenStack::V3.new(args) : Fog::Identity::OpenStack::V2.new(args)
+          identity = super
+          config = identity.config
+          service = identity.v3? ? Fog::Identity::OpenStack::V3.new(config) : Fog::Identity::OpenStack::V2.new(config)
         else
           service = Fog::Service.new(args)
         end
         service
       end
 
-      private
+      class Mock
+        attr_reader :config
 
-      def self.is_v3?(args)
-        @openstack_auth_uri && @openstack_auth_uri.path =~ /\/v3/
+        def initialize(options = {})
+          @openstack_auth_uri = URI.parse(options[:openstack_auth_url])
+          @openstack_identity_prefix = options[:openstack_identity_prefix]
+          @config = options
+        end
+
+        def v3?
+          if @openstack_identity_prefix
+            @openstack_identity_prefix =~ /v3/
+          else
+            @openstack_auth_uri && @openstack_auth_uri.path =~ %r{/v3}
+          end
+        end
       end
 
+      class Real
+        DEFAULT_SERVICE_TYPE_V3 = %w(identity_v3 identityv3 identity).collect(&:freeze).freeze
+        DEFAULT_SERVICE_TYPE    = %w(identity).collect(&:freeze).freeze
+
+        def self.not_found_class
+          Fog::Identity::OpenStack::NotFound
+        end
+        include Fog::OpenStack::Common
+
+        def initialize(options = {})
+          if options.respond_to?(:config_service?) && options.config_service?
+            configure(options)
+            return
+          end
+
+          initialize_identity(options)
+
+          @openstack_service_type   = options[:openstack_service_type] || default_service_type(options)
+          @openstack_service_name   = options[:openstack_service_name]
+
+          @connection_options       = options[:connection_options] || {}
+
+          @openstack_endpoint_type  = options[:openstack_endpoint_type] || 'adminURL'
+          initialize_endpoint_path_matches(options)
+
+          authenticate
+
+          if options[:openstack_identity_prefix]
+            @path = "/#{options[:openstack_identity_prefix]}/#{@path}"
+          end
+
+          @persistent = options[:persistent] || false
+          @connection = Fog::Core::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options)
+        end
+
+        def v3?
+          @path && @path =~ %r{/v3}
+        end
+
+        def config_service?
+          true
+        end
+
+        def config
+          self
+        end
+
+        private
+
+        def default_service_type(options)
+          unless options[:openstack_identity_prefix]
+            if @openstack_auth_uri.path =~ %r{/v3} ||
+               (options[:openstack_endpoint_path_matches] && options[:openstack_endpoint_path_matches] =~ '/v3')
+              return DEFAULT_SERVICE_TYPE_V3
+            end
+          end
+          DEFAULT_SERVICE_TYPE
+        end
+
+        def initialize_endpoint_path_matches(options)
+          if options[:openstack_endpoint_path_matches]
+            @openstack_endpoint_path_matches = options[:openstack_endpoint_path_matches]
+          end
+        end
+
+        def configure(source)
+          source.instance_variables.each do |v|
+            instance_variable_set(v, source.instance_variable_get(v))
+          end
+        end
+      end
     end
   end
 end

data/lib/fog/openstack/identity_v2.rb

@@ -171,30 +171,11 @@ module Fog
           end
         end
 
-        class Real
-          def self.not_found_class
-            Fog::Identity::OpenStack::NotFound
-          end
-          include Fog::OpenStack::Common
-
-          def initialize(options={})
-            initialize_identity options
-
-            @openstack_service_type   = options[:openstack_service_type] || ['identity']
-            @openstack_service_name   = options[:openstack_service_name]
-
-            @connection_options       = options[:connection_options] || {}
-
-            @openstack_endpoint_type  = options[:openstack_endpoint_type] || 'adminURL'
-
-            authenticate
-
-            if options[:openstack_identity_prefix]
-              @path = "/#{options[:openstack_identity_prefix]}/#{@path}"
-            end
+        class Real < Fog::Identity::OpenStack::Real
+          private
 
-            @persistent = options[:persistent] || false
-            @connection = Fog::Core::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options)
+          def default_service_type(_)
+            DEFAULT_SERVICE_TYPE
           end
         end
       end

data/lib/fog/openstack/identity_v3.rb

@@ -148,31 +148,19 @@ module Fog
           version
         end
 
-        class Real
-          def self.not_found_class
-            Fog::Identity::OpenStack::NotFound
-          end
-          include Fog::OpenStack::Common
-
-          def initialize(options={})
-            initialize_identity options
-
-            @openstack_service_type   = options[:openstack_service_type] || ['identity_v3','identityv3','identity']
-            @openstack_service_name   = options[:openstack_service_name]
+        class Real < Fog::Identity::OpenStack::Real
+          private
 
-            @connection_options       = options[:connection_options] || {}
-
-            @openstack_endpoint_type  = options[:openstack_endpoint_type] || 'adminURL'
-
-            @openstack_endpoint_path_matches = options[:openstack_endpoint_path_matches] ||= /\/v3/
-            authenticate
+          def default_service_type(_)
+            DEFAULT_SERVICE_TYPE_V3
+          end
 
-            if options[:openstack_identity_prefix]
-              @path = "/#{options[:openstack_identity_prefix]}/#{@path}"
+          def initialize_endpoint_path_matches(options)
+            if options[:openstack_endpoint_path_matches]
+              @openstack_endpoint_path_matches = options[:openstack_endpoint_path_matches]
+            else
+              @openstack_endpoint_path_matches = %r{/v3} unless options[:openstack_identity_prefix]
             end
-
-            @persistent = options[:persistent] || false
-            @connection = Fog::Core::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options)
           end
         end
       end

data/lib/fog/openstack/introspection.rb

@@ -0,0 +1,133 @@
+require 'yaml'
+
+module Fog
+  module Introspection
+    class OpenStack < Fog::Service
+      SUPPORTED_VERSIONS = /v1/
+
+      requires :openstack_auth_url
+      recognizes :openstack_auth_token, :openstack_management_url,
+                 :persistent, :openstack_service_type, :openstack_service_name,
+                 :openstack_tenant, :openstack_tenant_id,
+                 :openstack_api_key, :openstack_username, :openstack_identity_endpoint,
+                 :current_user, :current_tenant, :openstack_region,
+                 :openstack_endpoint_type,
+                 :openstack_project_name, :openstack_project_id,
+                 :openstack_project_domain, :openstack_user_domain, :openstack_domain_name,
+                 :openstack_project_domain_id, :openstack_user_domain_id, :openstack_domain_id
+
+      ## REQUESTS
+      #
+      request_path 'fog/openstack/requests/introspection'
+
+      # Introspection requests
+      request :create_introspection
+      request :get_introspection
+      request :abort_introspection
+      request :get_introspection_details
+
+      # Rules requests
+      request :create_rules
+      request :list_rules
+      request :delete_rules_all
+      request :get_rules
+      request :delete_rules
+
+      ## MODELS
+      #
+      model_path 'fog/openstack/models/introspection'
+      model       :rules
+      collection  :rules_collection
+
+      class Mock
+        def self.data
+          @data ||= Hash.new do |hash, key|
+            # Introspection data is *huge* we load it from a yaml file
+            file = "../../../../tests/fixtures/introspection.yaml"
+            hash[key] = YAML.load(File.read(File.expand_path(file, __FILE__)))
+          end
+        end
+
+        def self.reset
+          @data = nil
+        end
+
+        include Fog::OpenStack::Core
+
+        def initialize(options = {})
+          @auth_token = Fog::Mock.random_base64(64)
+          @auth_token_expiration = (Time.now.utc + 86_400).iso8601
+
+          initialize_identity options
+        end
+
+        def data
+          self.class.data[@openstack_username]
+        end
+
+        def reset_data
+          self.class.data.delete(@openstack_username)
+        end
+      end
+
+      class Real
+        include Fog::OpenStack::Core
+
+        def initialize(options = {})
+          initialize_identity options
+
+          @openstack_service_type  = options[:openstack_service_type] || ['introspection']
+          @openstack_service_name  = options[:openstack_service_name]
+
+          @connection_options = options[:connection_options] || {}
+
+          authenticate
+
+          unless @path.match(SUPPORTED_VERSIONS)
+            @path = "/" + Fog::OpenStack.get_supported_version(
+              SUPPORTED_VERSIONS,
+              @openstack_management_uri,
+              @auth_token,
+              @connection_options
+            )
+          end
+
+          @persistent = options[:persistent] || false
+          @connection = Fog::Core::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options)
+        end
+
+        def request(params)
+          response = @connection.request(
+            params.merge(
+              :headers => {
+                'Content-Type' => 'application/json',
+                'X-Auth-Token' => @auth_token
+              }.merge!(params[:headers] || {}),
+              :path    => "#{@path}/#{params[:path]}"
+            )
+          )
+        rescue Excon::Errors::Unauthorized    => error
+          if error.response.body != "Bad username or password" # token expiration
+            @openstack_must_reauthenticate = true
+            authenticate
+            retry
+          else # bad credentials
+            raise error
+          end
+        rescue Excon::Errors::HTTPStatusError => error
+          raise case error
+                when Excon::Errors::NotFound
+                  Fog::Introspection::OpenStack::NotFound.slurp(error)
+                else
+                  error
+                end
+        else
+          unless response.body.empty?
+            response.body = Fog::JSON.decode(response.body)
+          end
+          response
+        end
+      end
+    end
+  end
+end