mongo 2.13.0.rc1 → 2.13.0

data/spec/mongo/auth/aws/request_spec.rb

@@ -1,15 +1,15 @@
 require 'spec_helper'
 
-describe Mongo::Auth::Aws::Request do 
+describe Mongo::Auth::Aws::Request do
 
-  describe "#formatted_time" do 
-    context "when time is provided and frozen" do 
+  describe "#formatted_time" do
+    context "when time is provided and frozen" do
       let(:original_time) { Time.at(1592399523).freeze }
-      let(:request) do 
-        described_class.new(access_key_id: 'access_key_id', 
-          secret_access_key: 'secret_access_key', 
-          session_token: 'session_token', 
-          host: 'host', 
+      let(:request) do
+        described_class.new(access_key_id: 'access_key_id',
+          secret_access_key: 'secret_access_key',
+          session_token: 'session_token',
+          host: 'host',
           server_nonce: 'server_nonce',
           time: original_time
         )
@@ -24,12 +24,12 @@ describe Mongo::Auth::Aws::Request do
       end
     end
 
-    context "when time is not provided" do 
-      let(:request) do 
-        described_class.new(access_key_id: 'access_key_id', 
-          secret_access_key: 'secret_access_key', 
-          session_token: 'session_token', 
-          host: 'host', 
+    context "when time is not provided" do
+      let(:request) do
+        described_class.new(access_key_id: 'access_key_id',
+          secret_access_key: 'secret_access_key',
+          session_token: 'session_token',
+          host: 'host',
           server_nonce: 'server_nonce'
         )
       end
@@ -40,37 +40,37 @@ describe Mongo::Auth::Aws::Request do
     end
   end
 
-  describe "#signature" do 
-    context "when time is provided and frozen" do 
+  describe "#signature" do
+    context "when time is provided and frozen" do
       let(:original_time) { Time.at(1592399523).freeze }
-      let(:request) do 
-        described_class.new(access_key_id: 'access_key_id', 
-          secret_access_key: 'secret_access_key', 
-          session_token: 'session_token', 
-          host: 'host', 
+      let(:request) do
+        described_class.new(access_key_id: 'access_key_id',
+          secret_access_key: 'secret_access_key',
+          session_token: 'session_token',
+          host: 'host',
           server_nonce: 'server_nonce',
           time: original_time
         )
       end
-  
-      it 'doesn\'t raise error on signature' do 
+
+      it 'doesn\'t raise error on signature' do
         expect { request.signature }.to_not raise_error
       end
     end
 
-    context "when time is not provided" do 
-      let(:request) do 
-        described_class.new(access_key_id: 'access_key_id', 
-          secret_access_key: 'secret_access_key', 
-          session_token: 'session_token', 
-          host: 'host', 
+    context "when time is not provided" do
+      let(:request) do
+        described_class.new(access_key_id: 'access_key_id',
+          secret_access_key: 'secret_access_key',
+          session_token: 'session_token',
+          host: 'host',
           server_nonce: 'server_nonce'
         )
       end
-  
-      it 'doesn\'t raise error on signature' do 
+
+      it 'doesn\'t raise error on signature' do
         expect { request.signature }.to_not raise_error
       end
-    end    
+    end
   end
 end

data/spec/mongo/client_construction_spec.rb

@@ -1382,6 +1382,118 @@ describe Mongo::Client do
         end
       end
 =end
+
+      context ':wrapping_libraries option' do
+        let(:options) do
+          {wrapping_libraries: wrapping_libraries}
+        end
+
+        context 'valid input' do
+          context 'symbol keys' do
+            let(:wrapping_libraries) do
+              [name: 'Mongoid', version: '7.1.2'].freeze
+            end
+
+            it 'works' do
+              client.options[:wrapping_libraries].should == ['name' => 'Mongoid', 'version' => '7.1.2']
+            end
+          end
+
+          context 'string keys' do
+            let(:wrapping_libraries) do
+              ['name' => 'Mongoid', 'version' => '7.1.2'].freeze
+            end
+
+            it 'works' do
+              client.options[:wrapping_libraries].should == ['name' => 'Mongoid', 'version' => '7.1.2']
+            end
+          end
+
+          context 'Redacted keys' do
+            let(:wrapping_libraries) do
+              [Mongo::Options::Redacted.new(name: 'Mongoid', version: '7.1.2')].freeze
+            end
+
+            it 'works' do
+              client.options[:wrapping_libraries].should == ['name' => 'Mongoid', 'version' => '7.1.2']
+            end
+          end
+
+          context 'two libraries' do
+            let(:wrapping_libraries) do
+              [
+                {name: 'Mongoid', version: '7.1.2'},
+                {name: 'Rails', version: '4.0', platform: 'Foobar'},
+              ].freeze
+            end
+
+            it 'works' do
+              client.options[:wrapping_libraries].should == [
+                {'name' => 'Mongoid', 'version' => '7.1.2'},
+                {'name' => 'Rails', 'version' => '4.0', 'platform' => 'Foobar'},
+              ]
+            end
+          end
+
+          context 'empty array' do
+            let(:wrapping_libraries) do
+              []
+            end
+
+            it 'works' do
+              client.options[:wrapping_libraries].should == []
+            end
+          end
+
+          context 'empty array' do
+            let(:wrapping_libraries) do
+              nil
+            end
+
+            it 'works' do
+              client.options[:wrapping_libraries].should be nil
+            end
+          end
+        end
+
+        context 'valid input' do
+          context 'hash given instead of an array' do
+            let(:wrapping_libraries) do
+              {name: 'Mongoid', version: '7.1.2'}.freeze
+            end
+
+            it 'is rejected' do
+              lambda do
+                client
+              end.should raise_error(ArgumentError, /:wrapping_libraries must be an array of hashes/)
+            end
+          end
+
+          context 'invalid keys' do
+            let(:wrapping_libraries) do
+              [name: 'Mongoid', invalid: '7.1.2'].freeze
+            end
+
+            it 'is rejected' do
+              lambda do
+                client
+              end.should raise_error(ArgumentError, /:wrapping_libraries element has invalid keys/)
+            end
+          end
+
+          context 'value includes |' do
+            let(:wrapping_libraries) do
+              [name: 'Mongoid|on|Rails', version: '7.1.2'].freeze
+            end
+
+            it 'is rejected' do
+              lambda do
+                client
+              end.should raise_error(ArgumentError, /:wrapping_libraries element value cannot include '|'/)
+            end
+          end
+        end
+      end
     end
 
     context 'when making a block client' do

data/spec/mongo/index/view_spec.rb

@@ -325,6 +325,81 @@ describe Mongo::Index::View do
           end
         end
 
+        context 'when hidden is specified' do
+          let(:index) { view.get('with_hidden_1') }
+
+          context 'on server versions <= 3.2' do
+            # DRIVERS-1220 Server versions 3.2 and older do not perform any option
+            # checking on index creation. The server will allow the user to create
+            # the index with the hidden option, but the server does not support this
+            # option and will not use it.
+            max_server_fcv '3.2'
+
+            let!(:result) do
+              view.create_many({ key: { with_hidden: 1 }, hidden: true })
+            end
+
+            it 'returns ok' do
+              expect(result).to be_successful
+            end
+
+            it 'creates an index' do
+              expect(index).to_not be_nil
+            end
+          end
+
+          context 'on server versions between 3.4 and 4.2' do
+            max_server_fcv '4.2'
+            min_server_fcv '3.4'
+
+            it 'raises an exception' do
+              expect do
+                view.create_many({ key: { with_hidden: 1 }, hidden: true })
+              end.to raise_error(/The field 'hidden' is not valid for an index specification/)
+            end
+          end
+
+          context 'on server versions >= 4.4' do
+            min_server_fcv '4.4'
+
+            context 'when hidden is true' do
+              let!(:result) do
+                view.create_many({ key: { with_hidden: 1 }, hidden: true })
+              end
+
+              it 'returns ok' do
+                expect(result).to be_successful
+              end
+
+              it 'creates an index' do
+                expect(index).to_not be_nil
+              end
+
+              it 'applies the hidden option to the index' do
+                expect(index['hidden']).to be true
+              end
+            end
+
+            context 'when hidden is false' do
+              let!(:result) do
+                view.create_many({ key: { with_hidden: 1 }, hidden: false })
+              end
+
+              it 'returns ok' do
+                expect(result).to be_successful
+              end
+
+              it 'creates an index' do
+                expect(index).to_not be_nil
+              end
+
+              it 'does not apply the hidden option to the index' do
+                expect(index['hidden']).to be_nil
+              end
+            end
+          end
+        end
+
         context 'when collation is specified' do
           min_server_fcv '3.4'
 
@@ -773,6 +848,77 @@ describe Mongo::Index::View do
       end
     end
 
+    context 'when providing hidden option' do
+      let(:index) { view.get('with_hidden_1') }
+
+      context 'on server versions <= 3.2' do
+        # DRIVERS-1220 Server versions 3.2 and older do not perform any option
+        # checking on index creation. The server will allow the user to create
+        # the index with the hidden option, but the server does not support this
+        # option and will not use it.
+        max_server_fcv '3.2'
+
+        let!(:result) do
+          view.create_one({ 'with_hidden' => 1 }, { hidden: true })
+        end
+
+        it 'returns ok' do
+          expect(result).to be_successful
+        end
+
+        it 'creates an index' do
+          expect(index).to_not be_nil
+        end
+      end
+
+      context 'on server versions between 3.4 and 4.2' do
+        max_server_fcv '4.2'
+        min_server_fcv '3.4'
+
+        it 'raises an exception' do
+          expect do
+            view.create_one({ 'with_hidden' => 1 }, { hidden: true })
+          end.to raise_error(/The field 'hidden' is not valid for an index specification/)
+        end
+      end
+
+      context 'on server versions >= 4.4' do
+        min_server_fcv '4.4'
+
+        context 'when hidden is true' do
+          let!(:result) { view.create_one({ 'with_hidden' => 1 }, { hidden: true }) }
+
+          it 'returns ok' do
+            expect(result).to be_successful
+          end
+
+          it 'creates an index' do
+            expect(index).to_not be_nil
+          end
+
+          it 'applies the hidden option to the index' do
+            expect(index['hidden']).to be true
+          end
+        end
+
+        context 'when hidden is false' do
+          let!(:result) { view.create_one({ 'with_hidden' => 1 }, { hidden: false }) }
+
+          it 'returns ok' do
+            expect(result).to be_successful
+          end
+
+          it 'creates an index' do
+            expect(index).to_not be_nil
+          end
+
+          it 'does not apply the hidden option to the index' do
+            expect(index['hidden']).to be_nil
+          end
+        end
+      end
+    end
+
     context 'when providing commit_quorum option' do
       require_topology :replica_set, :sharded
       context 'on server versions >= 4.4' do

data/spec/mongo/server/app_metadata_shared.rb

@@ -53,4 +53,84 @@ shared_examples 'app metadata document' do
       end
     end
   end
+
+  context 'when wrapping libraries are specified' do
+    let(:app_metadata) do
+      described_class.new(wrapping_libraries: wrapping_libraries)
+    end
+
+    context 'one' do
+      let(:wrapping_libraries) { [wrapping_library] }
+
+      context 'no fields' do
+        let(:wrapping_library) do
+          {}
+        end
+
+        it 'adds empty strings' do
+          document[:client][:driver][:name].should == 'mongo-ruby-driver|'
+          document[:client][:driver][:version].should == "#{Mongo::VERSION}|"
+          document[:client][:platform].should =~ /\AJ?Ruby[^|]+\|\z/
+        end
+      end
+
+      context 'some fields' do
+        let(:wrapping_library) do
+          {name: 'Mongoid'}
+        end
+
+        it 'adds the fields' do
+          document[:client][:driver][:name].should == 'mongo-ruby-driver|Mongoid'
+          document[:client][:driver][:version].should == "#{Mongo::VERSION}|"
+          document[:client][:platform].should =~ /\AJ?Ruby[^|]+\|\z/
+        end
+      end
+
+      context 'all fields' do
+        let(:wrapping_library) do
+          {name: 'Mongoid', version: '7.1.2', platform: 'OS9000'}
+        end
+
+        it 'adds the fields' do
+          document[:client][:driver][:name].should == 'mongo-ruby-driver|Mongoid'
+          document[:client][:driver][:version].should == "#{Mongo::VERSION}|7.1.2"
+          document[:client][:platform].should =~ /\AJ?Ruby[^|]+\|OS9000\z/
+        end
+      end
+    end
+
+    context 'two' do
+      context 'some fields' do
+        let(:wrapping_libraries) do
+          [
+            {name: 'Mongoid', version: '42'},
+            # All libraries should be specifying their versions, in theory,
+            # but test not specifying a version.
+            {version: '4.0', platform: 'OS9000'},
+          ]
+        end
+
+        it 'adds the fields' do
+          document[:client][:driver][:name].should == 'mongo-ruby-driver|Mongoid|'
+          document[:client][:driver][:version].should == "#{Mongo::VERSION}|42|4.0"
+          document[:client][:platform].should =~ /\AJ?Ruby[^|]+\|\|OS9000\z/
+        end
+      end
+
+      context 'a realistic Mongoid & Rails wrapping' do
+        let(:wrapping_libraries) do
+          [
+            {name: 'Mongoid', version: '7.1.2'},
+            {name: 'Rails', version: '6.0.3'},
+          ]
+        end
+
+        it 'adds the fields' do
+          document[:client][:driver][:name].should == 'mongo-ruby-driver|Mongoid|Rails'
+          document[:client][:driver][:version].should == "#{Mongo::VERSION}|7.1.2|6.0.3"
+          document[:client][:platform].should =~ /\AJ?Ruby[^|]+\|\|\z/
+        end
+      end
+    end
+  end
 end