misty 1.3.3 → 1.4.0

data/lib/misty/openstack/service.rb

@@ -0,0 +1,88 @@
+module Misty
+  module Openstack
+    module Service
+      attr_reader :headers, :microversion
+
+      # ==== Attributes
+      #
+      # * +arg+ - +Misty::Config+ instance
+      #
+      def initialize(arg)
+        @auth = arg[:auth]
+        @log = arg[:log]
+        @config = arg[:config]
+
+        @content_type = @config[:content_type]
+        @headers = Misty::HTTP::Header.new(@config[:headers].get.clone)
+        @ssl_verify_mode = @config[:ssl_verify_mode]
+
+        @uri = URI.parse(@auth.get_url(service_names, @config[:region_id], @config[:interface]))
+
+        @base_path = @config[:base_path] ? @config[:base_path] : @uri.path
+        @base_path = @base_path.chomp('/')
+        @base_url  = @config[:base_url]  ? @config[:base_url] : nil
+
+        if microversion
+          asked_version = @config[:version] ? @config[:version] : ''
+          @version = set_version(asked_version)
+        end
+      end
+
+      # When a catalog provides a base path and the Service API definition containts the generic equivalent as prefix
+      # then the preifx is redundant and must be removed from the path.
+      #
+      # To use Mixing classes must override
+      #
+      # For exampe, if a Catalog is defined with
+      # 'http://192.0.2.21:8004/v1/48985e6b8da145699d411f12a3459fc'
+      # and Service API resource has '/v1/{tenant_id}/stacks'
+      # then the path prefix is ignored and path is only +/stacks+
+      def prefix_path_to_ignore
+        ''
+      end
+
+      # Generate available requests available for current service
+      def requests
+        requests_api + requests_custom
+      end
+
+      # Each option is recreated to bear new value or the one propagated from defaults, globals or service levels
+      def request_config(arg = {})
+        @request_content_type = arg[:content_type] ? arg[:content_type] : @content_type
+        @request_headers = Misty::HTTP::Header.new(@headers.get.clone)
+        @request_headers.add(arg[:headers]) if arg[:headers]
+        if microversion
+          request_version = if arg[:version]
+                               set_version(arg[:version])
+                             else
+                               @version
+                             end
+          @request_headers.add(microversion_header(request_version)) if request_version
+        end
+      end
+
+      # TODO: remove
+      def baseclass
+        self.class.to_s.split('::')[-1]
+      end
+
+      private
+
+      def requests_api
+        @requests_api_list ||= begin
+          list = []
+          api.each do |_path, verbs|
+            verbs.each do |_verb, requests|
+              list << requests
+            end
+          end
+          list.flatten!
+        end
+      end
+
+      def requests_custom
+        []
+      end
+    end
+  end
+end

data/lib/misty/openstack/swift/v1.rb

@@ -23,8 +23,8 @@ module Misty
 
         def bulk_delete(data)
           param = 'bulk-delete=1'
-          header = Misty::HTTP::Header.new('Content-Type' => 'text/plain')
-          create_update_or_delete_account_metadata(param, data, header)
+          @request_headers.add('Content-Type' => 'text/plain')
+          create_update_or_delete_account_metadata(param, data)
         end
       end
     end

data/lib/misty/service.rb

@@ -16,18 +16,15 @@ module Misty
       str
     end
 
-    def version(api_version = nil)
-      if api_version
-        return api_version if (@versions && @versions.include?(api_version)) || @microversion == api_version
-      end
-      default_version
-    end
-
-    private
-
-    def default_version
-      return @microversion if @microversion
-      return self.versions.sort[-1]
+    def default_version(api_version = nil)
+      res = if api_version && (@versions&.include?(api_version) || api_version == @microversion)
+              api_version
+            elsif @microversion
+              @microversion
+            else
+              self.versions.sort[-1]
+            end
+      res
     end
   end
 end

data/lib/misty/version.rb

@@ -1,3 +1,3 @@
 module Misty
-  VERSION = '1.3.3'
+  VERSION = '1.4.0'
 end

data/test/integration/{network_test.rb → networking_test.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-describe 'Network Service Neutron v2.0 features' do
+describe 'Networking Service Neutron v2.0 features' do
   let(:auth) do
     {
       :url                => 'http://192.0.2.6:5000',
@@ -13,34 +13,34 @@ describe 'Network Service Neutron v2.0 features' do
   end
 
   it 'GET/POST/PUT/DELETE requests' do
-    VCR.use_cassette 'network using neutron v2.0' do
-      cloud = Misty::Cloud.new(:auth => auth, :network => {:api_version => 'v2.0'})
+    VCR.use_cassette 'networking using neutron v2.0' do
+      cloud = Misty::Cloud.new(:auth => auth, :networking => {:api_version => 'v2.0'})
 
       # POST with body data
       data = Misty.to_json('network' => { 'name': 'test_network' })
-      response = cloud.network.create_network(data)
+      response = cloud.networking.create_network(data)
       response.code.must_equal '201'
       id = response.body['network']['id']
       id.wont_be_empty
 
       # GET
-      response = cloud.network.list_networks
+      response = cloud.networking.list_networks
       response.code.must_equal '200'
       response.body['networks'].size.must_equal 2
 
       # GET with URI value
-      response = cloud.network.show_network_details(id)
+      response = cloud.networking.show_network_details(id)
       response.code.must_equal '200'
       response.body['network']['name'].must_equal 'test_network'
 
       # PUT with URI value and body data
       data = Misty.to_json('network' => { 'name': 'test_updated_network' })
-      response = cloud.network.update_network(id, data)
+      response = cloud.networking.update_network(id, data)
       response.code.must_equal '200'
       response.body['network']['name'].must_equal 'test_updated_network'
 
       # DELETE with URI value
-      response = cloud.network.delete_network(id)
+      response = cloud.networking.delete_network(id)
       response.code.must_equal '204'
     end
   end

data/test/integration/test_helper.rb

@@ -4,6 +4,7 @@ require 'misty'
 require 'minitest/autorun'
 require 'vcr'
 require 'webmock/minitest'
+require 'pry-byebug'
 
 VCR.configure do |config|
   config.cassette_library_dir = 'test/integration/vcr'

data/test/unit/auth/name_test.rb

@@ -47,38 +47,42 @@ describe Misty::Auth::User do
   end
 
   describe '#identity' do
-    it 'raises an error when password is missing' do
-      proc do
+    describe 'succesful' do
+      it "with user id and user name" do
         user = Misty::Auth::User.new('user_id', 'User')
-        user.identity
-      end.must_raise Misty::Auth::CredentialsError
-    end
+        user.password = 'secret'
+        user.identity.must_equal ({:user=>{:id=>'user_id', :password=>'secret'}})
+      end
 
-    it "when id is provided it doesn't require domain" do
-      user = Misty::Auth::User.new('user_id', 'User')
-      user.password = 'secret'
-      user.identity.must_equal ({:user=>{:id=>'user_id', :password=>'secret'}})
-    end
+      it 'with user name and user domain name' do
+        user = Misty::Auth::User.new(nil, 'User')
+        user.password = 'secret'
+        user.domain = Misty::Auth::Name.new('default', nil)
+        user.identity.must_equal ({:user=>{:name=>'User', :domain=>{:id=>'default'}, :password=>'secret'}})
+      end
 
-    it 'when id is nul and name is provided it uses domain id' do
-      user = Misty::Auth::User.new(nil, 'User')
-      user.password = 'secret'
-      user.domain = Misty::Auth::Name.new('default', nil)
-      user.identity.must_equal ({:user=>{:name=>'User', :domain=>{:id=>'default'}, :password=>'secret'}})
+      it 'with user name and domain name' do
+        user = Misty::Auth::User.new(nil, 'User')
+        user.password = 'secret'
+        user.domain = Misty::Auth::Name.new(nil, 'Default')
+        user.identity.must_equal ({:user=>{:name=>'User', :domain=>{:name=>'Default'}, :password=>'secret'}})
+      end
     end
 
-    it 'when id is nul and name is provided it uses domain name' do
-      user = Misty::Auth::User.new(nil, 'User')
-      user.password = 'secret'
-      user.domain = Misty::Auth::Name.new(nil, 'Default')
-      user.identity.must_equal ({:user=>{:name=>'User', :domain=>{:name=>'Default'}, :password=>'secret'}})
-    end
+    describe 'raises an error' do
+      it 'raises an error when password is missing' do
+        proc do
+          user = Misty::Auth::User.new('user_id', 'User')
+          user.identity
+        end.must_raise Misty::Config::CredentialsError
+      end
 
-    it 'raises an error with no user id and no domain are provided' do
-      proc do
-        user = Misty::Auth::User.new(nil, 'User')
-        user.identity
-      end.must_raise Misty::Auth::CredentialsError
+      it 'with only user name and no domain' do
+        proc do
+          user = Misty::Auth::User.new(nil, 'User')
+          user.identity
+        end.must_raise Misty::Config::CredentialsError
+      end
     end
   end
 end
@@ -106,7 +110,7 @@ describe Misty::Auth::ProjectScope do
       proc do
         project = Misty::Auth::ProjectScope.new(nil, 'Project')
         project.identity
-      end.must_raise Misty::Auth::CredentialsError
+      end.must_raise Misty::Config::CredentialsError
     end
   end
 end

data/test/unit/auth_helper.rb

@@ -2,7 +2,7 @@ def auth_response_v3(type, name)
   { 'token' =>
     { 'methods' => ['password'],
       'roles' => [{ 'id' => 'id_roles', 'name' => 'admin' }],
-      'expires_at' => '2016-11-29T07:45:29.908554Z',
+      'expires_at' => '2017-11-29T07:45:29.908554Z',
       'project' => { 'domain' => { 'id' => 'default', 'name' => 'Default' }, 'id' => 'project_id', 'name' => 'admin' },
       'catalog' =>
       [{ 'endpoints' =>
@@ -26,14 +26,14 @@ def auth_response_v3(type, name)
          'name'      => name }],
       'user' => { 'domain' => { 'id' => 'default', 'name' => 'Default' }, 'id' => 'id_user', 'name' => 'admin' },
       'audit_ids' => ['id_audits'],
-      'issued_at' => '2016-11-29T06:45:29.908578Z' } }
+      'issued_at' => '2017-11-29T06:45:29.908578Z' } }
 end
 
 def auth_response_v2(type, name)
   { 'access' =>
     { 'token' =>
-      { 'issued_at' => '2016-12-05T10:44:31.454741Z',
-        'expires' => '2016-12-05T11:44:31Z',
+      { 'issued_at' => '2017-12-05T10:44:31.454741Z',
+        'expires' => '2017-12-05T11:44:31Z',
         'id' => '4ae647d3a5294690a3c29bc658e17e26',
         'tenant' => { 'description' => 'admin tenant', 'enabled' => true, 'id' => 'tenant_id', 'name' => 'admin' },
         'audit_ids' => ['Ye0Rq1HzTk2ggUAg8nDGbQ'] },

data/test/unit/auth_test.rb

@@ -2,10 +2,6 @@ require 'test_helper'
 require 'auth_helper'
 
 describe Misty::Auth do
-  let(:config) do
-    Misty::Cloud::Config.new
-  end
-
   describe Misty::AuthV3 do
     describe '#new' do
       it 'fails when missing credentials' do
@@ -13,7 +9,7 @@ describe Misty::Auth do
         to_return(:status => 200, :body => "{\"token\":{\"catalog\":[]}}", :headers => {'x-subject-token'=>'token_data'})
 
         proc do
-          Misty::AuthV3.new({}, config)
+          Misty::AuthV3.new({})
         end.must_raise Misty::Auth::URLError
       end
 
@@ -21,17 +17,18 @@ describe Misty::Auth do
         describe 'with a project scope' do
           it 'authenticates using a project id' do
             auth = {
-              :url        => 'http://localhost:5000',
-              :user_id    => 'user_id',
-              :password   => 'secret',
-              :project_id => 'project_id'
+              :url             => 'http://localhost:5000',
+              :user_id         => 'user_id',
+              :password        => 'secret',
+              :project_id      => 'project_id',
+              :ssl_verify_mode => false
             }
 
             stub_request(:post, 'http://localhost:5000/v3/auth/tokens').
               with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"password\"],\"password\":{\"user\":{\"id\":\"user_id\",\"password\":\"secret\"}}},\"scope\":{\"project\":{\"id\":\"project_id\"}}}}").
               to_return(:status => 200, :body => JSON.dump(auth_response_v3('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
 
-            Misty::AuthV3.new(auth, config)
+            Misty::AuthV3.new(auth)
           end
 
           it 'authenticates using a project name and a project domain id' do
@@ -40,14 +37,31 @@ describe Misty::Auth do
               :user_id           => 'user_id',
               :password          => 'secret',
               :project           => 'project',
-              :project_domain_id => 'domain_id'
+              :project_domain_id => 'project_domain_id'
             }
 
             stub_request(:post, 'http://localhost:5000/v3/auth/tokens').
-              with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"password\"],\"password\":{\"user\":{\"id\":\"user_id\",\"password\":\"secret\"}}},\"scope\":{\"project\":{\"name\":\"project\",\"domain\":{\"id\":\"domain_id\"}}}}}").
+              with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"password\"],\"password\":{\"user\":{\"id\":\"user_id\",\"password\":\"secret\"}}},\"scope\":{\"project\":{\"name\":\"project\",\"domain\":{\"id\":\"project_domain_id\"}}}}}").
+              to_return(:status => 200, :body => JSON.dump(auth_response_v3('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
+
+            Misty::AuthV3.new(auth)
+          end
+
+          it 'authenticates using a project name and a project domain name' do
+            auth = {
+              :url               => 'http://localhost:5000',
+              :user              => 'user',
+              :user_domain       => 'user_domain',
+              :password          => 'secret',
+              :project           => 'project',
+              :project_domain    => 'project_domain'
+            }
+
+            stub_request(:post, "http://localhost:5000/v3/auth/tokens").
+              with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"password\"],\"password\":{\"user\":{\"name\":\"user\",\"domain\":{\"name\":\"user_domain\"},\"password\":\"secret\"}}},\"scope\":{\"project\":{\"name\":\"project\",\"domain\":{\"name\":\"project_domain\"}}}}}").
               to_return(:status => 200, :body => JSON.dump(auth_response_v3('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
 
-            Misty::AuthV3.new(auth, config)
+            Misty::AuthV3.new(auth)
           end
         end
 
@@ -64,7 +78,7 @@ describe Misty::Auth do
               with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"password\"],\"password\":{\"user\":{\"id\":\"user_id\",\"password\":\"secret\"}}},\"scope\":{\"domain\":{\"id\":\"domain_id\"}}}}").
               to_return(:status => 200, :body => JSON.dump(auth_response_v3('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
 
-            Misty::AuthV3.new(auth, config)
+            Misty::AuthV3.new(auth)
           end
 
           it 'authenticates using a domain name' do
@@ -79,7 +93,7 @@ describe Misty::Auth do
               with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"password\"],\"password\":{\"user\":{\"id\":\"user_id\",\"password\":\"secret\"}}},\"scope\":{\"domain\":{\"name\":\"domain\"}}}}").
               to_return(:status => 200, :body => JSON.dump(auth_response_v3('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
 
-            Misty::AuthV3.new(auth, config)
+            Misty::AuthV3.new(auth)
           end
         end
       end
@@ -97,7 +111,7 @@ describe Misty::Auth do
               with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"token\"],\"token\":{\"id\":\"token\"}},\"scope\":{\"project\":{\"id\":\"project_id\"}}}}").
               to_return(:status => 200, :body => JSON.dump(auth_response_v3('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
 
-            Misty::AuthV3.new(auth, config)
+            Misty::AuthV3.new(auth)
           end
 
           it 'authenticates using a project name and a project domain id' do
@@ -112,7 +126,7 @@ describe Misty::Auth do
               with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"token\"],\"token\":{\"id\":\"token\"}},\"scope\":{\"project\":{\"name\":\"project\",\"domain\":{\"id\":\"domain_id\"}}}}}").
               to_return(:status => 200, :body => JSON.dump(auth_response_v3('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
 
-            Misty::AuthV3.new(auth, config)
+            Misty::AuthV3.new(auth)
           end
         end
 
@@ -128,7 +142,7 @@ describe Misty::Auth do
               with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"token\"],\"token\":{\"id\":\"token\"}},\"scope\":{\"domain\":{\"id\":\"domain_id\"}}}}").
               to_return(:status => 200, :body => JSON.dump(auth_response_v3('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
 
-            Misty::AuthV3.new(auth, config)
+            Misty::AuthV3.new(auth)
           end
 
           it 'authenticates using a domain name' do
@@ -142,7 +156,7 @@ describe Misty::Auth do
               with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"token\"],\"token\":{\"id\":\"token\"}},\"scope\":{\"domain\":{\"name\":\"domain\"}}}}").
               to_return(:status => 200, :body => JSON.dump(auth_response_v3('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
 
-            Misty::AuthV3.new(auth, config)
+            Misty::AuthV3.new(auth)
           end
         end
       end
@@ -163,7 +177,7 @@ describe Misty::Auth do
         stub_request(:post, 'http://localhost:5000/v3/auth/tokens').
         to_return(:status => 200, :body => "{\"token\":{\"catalog\":[\"catalog_data\"]}}", :headers => {'x-subject-token'=>'token_data'})
 
-        auth = Misty::AuthV3.new(authv3_creds, config)
+        auth = Misty::AuthV3.new(authv3_creds)
         auth.stub :expired?, false do
           auth.get_token.must_equal 'token_data'
         end
@@ -173,7 +187,7 @@ describe Misty::Auth do
         stub_request(:post, 'http://localhost:5000/v3/auth/tokens').
         to_return(:status => 200, :body => "{\"token\":{\"catalog\":[\"catalog_data\"]}}", :headers => {'x-subject-token'=>'token_data'})
 
-        auth = Misty::AuthV3.new(authv3_creds, config)
+        auth = Misty::AuthV3.new(authv3_creds)
         auth.catalog.must_equal ['catalog_data']
       end
 
@@ -181,7 +195,7 @@ describe Misty::Auth do
         stub_request(:post, 'http://localhost:5000/v3/auth/tokens').
         to_return(:status => 200, :body => JSON.dump(auth_response_v3("identity", "keystone")), :headers => {'x-subject-token'=>'token_data'})
 
-        auth = Misty::AuthV3.new(authv3_creds, config)
+        auth = Misty::AuthV3.new(authv3_creds)
         auth.get_url(%w{identity}, 'regionOne', 'public').must_equal 'http://localhost'
       end
     end
@@ -194,7 +208,7 @@ describe Misty::Auth do
           to_return(:status => 200, :body => "{\"access\":{\"token\":{\"id\":\"token_data\"}}}", :headers => {})
 
         proc do
-          Misty::AuthV2.new({}, config)
+          Misty::AuthV2.new({})
         end.must_raise Misty::Auth::URLError
       end
 
@@ -211,7 +225,7 @@ describe Misty::Auth do
             with(:body => "{\"auth\":{\"passwordCredentials\":{\"username\":\"user\",\"password\":\"secret\"},\"tenantName\":\"tenant\"}}").
             to_return(:status => 200, :body => JSON.dump(auth_response_v2('identity', 'keystone')), :headers => {})
 
-          Misty::AuthV2.new(auth, config)
+          Misty::AuthV2.new(auth)
         end
 
         it 'authenticates using the tenant id' do
@@ -226,7 +240,7 @@ describe Misty::Auth do
             with(:body => "{\"auth\":{\"passwordCredentials\":{\"username\":\"user\",\"password\":\"secret\"},\"tenantId\":\"tenant_id\"}}").
             to_return(:status => 200, :body => JSON.dump(auth_response_v2('identity', 'keystone')), :headers => {})
 
-          Misty::AuthV2.new(auth, config)
+          Misty::AuthV2.new(auth)
         end
       end
 
@@ -242,7 +256,7 @@ describe Misty::Auth do
             with(:body => "{\"auth\":{\"token\":{\"id\":\"token_id\"},\"tenantName\":\"tenant\"}}").
             to_return(:status => 200, :body => JSON.dump(auth_response_v2('identity', 'keystone')), :headers => {})
 
-          Misty::AuthV2.new(auth, config)
+          Misty::AuthV2.new(auth)
         end
 
         it 'authenticates using the tenant id' do
@@ -256,7 +270,7 @@ describe Misty::Auth do
             with(:body => "{\"auth\":{\"token\":{\"id\":\"token_id\"},\"tenantId\":\"tenant_id\"}}").
             to_return(:status => 200, :body => JSON.dump(auth_response_v2('identity', 'keystone')), :headers => {})
 
-          Misty::AuthV2.new(auth, config)
+          Misty::AuthV2.new(auth)
         end
       end
     end
@@ -275,7 +289,7 @@ describe Misty::Auth do
         stub_request(:post, 'http://localhost:5000/v2.0/tokens').
           to_return(:status => 200, :body => "{\"access\":{\"token\":{\"id\":\"token_data\"},\"serviceCatalog\":[\"catalog_data\"]}}", :headers => {})
 
-        auth = Misty::AuthV2.new(authv2_creds, config)
+        auth = Misty::AuthV2.new(authv2_creds)
         auth.stub :expired?, false do
           auth.get_token.must_equal 'token_data'
         end
@@ -285,7 +299,7 @@ describe Misty::Auth do
         stub_request(:post, 'http://localhost:5000/v2.0/tokens').
           to_return(:status => 200, :body => "{\"access\":{\"token\":{\"id\":\"token_data\"},\"serviceCatalog\":[\"catalog_data\"]}}", :headers => {})
 
-        auth = Misty::AuthV2.new(authv2_creds, config)
+        auth = Misty::AuthV2.new(authv2_creds)
         auth.catalog.must_equal ['catalog_data']
       end
 
@@ -293,7 +307,7 @@ describe Misty::Auth do
         stub_request(:post, 'http://localhost:5000/v2.0/tokens').
           to_return(:status => 200, :body => JSON.dump(auth_response_v2('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
 
-        auth = Misty::AuthV2.new(authv2_creds, config)
+        auth = Misty::AuthV2.new(authv2_creds)
         auth.get_url(%w{identity}, 'regionOne', 'public').must_equal 'http://localhost'
       end
     end