Replace mongo shell with mongosh

Johan De Wit · stevenpost · commit 7630480e13f8 · 2024-03-19T18:02:05.000+01:00
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -87,6 +87,7 @@ The following parameters are available in the `mongodb::globals` class:
 
 * [`server_package_name`](#-mongodb--globals--server_package_name)
 * [`client_package_name`](#-mongodb--globals--client_package_name)
+* [`client_version`](#-mongodb--globals--client_version)
 * [`mongod_service_manage`](#-mongodb--globals--mongod_service_manage)
 * [`service_enable`](#-mongodb--globals--service_enable)
 * [`service_ensure`](#-mongodb--globals--service_ensure)
@@ -124,6 +125,14 @@ Data type: `Any`
 
 
 
+Default value: `undef`
+
+##### <a name="-mongodb--globals--client_version"></a>`client_version`
+
+Data type: `Any`
+
+Version of the client package to install.
+
 Default value: `undef`
 
 ##### <a name="-mongodb--globals--mongod_service_manage"></a>`mongod_service_manage`
diff --git a/lib/facter/is_master.rb b/lib/facter/is_master.rb
@@ -39,17 +39,17 @@ def get_options_from_config(file)
 
 Facter.add('mongodb_is_master') do
   setcode do
-    if %w[mongo mongod].all? { |m| Facter::Util::Resolution.which m }
+    if %w[mongosh mongod].all? { |m| Facter::Util::Resolution.which m }
       file = mongod_conf_file
       if file
         options = get_options_from_config(file)
-        e = File.exist?('/root/.mongorc.js') ? 'load(\'/root/.mongorc.js\'); ' : ''
+        e = File.exist?('/root/.mongoshrc.js') ? 'load(\'/root/.mongoshrc.js\'); ' : ''
 
         # Check if the mongodb server is responding:
-        Facter::Core::Execution.exec("mongo --quiet #{options} --eval \"#{e}printjson(db.adminCommand({ ping: 1 }))\"")
+        Facter::Core::Execution.exec("mongosh --quiet #{options} --eval \"#{e}EJSON.stringify(db.adminCommand({ ping: 1 }))\"")
 
         if $CHILD_STATUS.success?
-          Facter::Core::Execution.exec("mongo --quiet #{options} --eval \"#{e}db.isMaster().ismaster\"")
+          Facter::Core::Execution.exec("mongosh --quiet #{options} --eval \"#{e}db.isMaster().ismaster\"")
         else
           'not_responding'
         end
diff --git a/lib/puppet/provider/mongodb.rb b/lib/puppet/provider/mongodb.rb
@@ -8,15 +8,15 @@
 class Puppet::Provider::Mongodb < Puppet::Provider
   # Without initvars commands won't work.
   initvars
-  commands mongo: 'mongo'
+  commands mongosh: 'mongosh'
 
   # Optional defaults file
-  def self.mongorc_file
-    "load('#{Facter.value(:root_home)}/.mongorc.js'); " if File.file?("#{Facter.value(:root_home)}/.mongorc.js")
+  def self.mongoshrc_file
+    "load('#{Facter.value(:root_home)}/.mongoshrc.js'); " if File.file?("#{Facter.value(:root_home)}/.mongoshrc.js")
   end
 
-  def mongorc_file
-    self.class.mongorc_file
+  def mongoshrc_file
+    self.class.mongoshrc_file
   end
 
   def self.mongod_conf_file
@@ -74,7 +74,7 @@ def self.tls_invalid_hostnames(config = nil)
     config['tlsallowInvalidHostnames']
   end
 
-  def self.mongo_cmd(db, host, cmd)
+  def self.mongosh_cmd(db, host, cmd)
     config = mongo_conf
 
     args = [db, '--quiet', '--host', host]
@@ -101,7 +101,7 @@ def self.mongo_cmd(db, host, cmd)
     end
 
     args += ['--eval', cmd]
-    mongo(args)
+    mongosh(args)
   end
 
   def self.conn_string
@@ -137,9 +137,9 @@ def self.conn_string
 
   def self.db_ismaster
     cmd_ismaster = 'db.isMaster().ismaster'
-    cmd_ismaster = mongorc_file + cmd_ismaster if mongorc_file
+    cmd_ismaster = mongoshrc_file + cmd_ismaster if mongoshrc_file
     db = 'admin'
-    res = mongo_cmd(db, conn_string, cmd_ismaster).to_s.split(%r{\n}).last.chomp
+    res = mongosh_cmd(db, conn_string, cmd_ismaster).to_s.split(%r{\n}).last.chomp
     res.eql?('true')
   end
 
@@ -156,14 +156,14 @@ def self.auth_enabled(config = nil)
   def self.mongo_eval(cmd, db = 'admin', retries = 10, host = nil)
     retry_count = retries
     retry_sleep = 3
-    cmd = mongorc_file + cmd if mongorc_file
+    cmd = mongoshrc_file + cmd if mongoshrc_file
 
     out = nil
     begin
       out = if host
-              mongo_cmd(db, host, cmd)
+              mongosh_cmd(db, host, cmd)
             else
-              mongo_cmd(db, conn_string, cmd)
+              mongosh_cmd(db, conn_string, cmd)
             end
     rescue StandardError => e
       retry_count -= 1
diff --git a/lib/puppet/provider/mongodb_database/mongodb.rb b/lib/puppet/provider/mongodb_database/mongodb.rb
@@ -9,8 +9,8 @@
   def self.instances
     require 'json'
 
-    pre_cmd = 'try { rs.secondaryOk() } catch (err) { rs.slaveOk() }'
-    dbs = JSON.parse mongo_eval("#{pre_cmd};printjson(db.getMongo().getDBs())")
+    pre_cmd = 'db.getMongo().setReadPref("primaryPreferred")'
+    dbs = JSON.parse mongo_eval("#{pre_cmd};EJSON.stringify(db.getMongo().getDBs())")
 
     dbs['databases'].map do |db|
       new(name: db['name'],
diff --git a/lib/puppet/provider/mongodb_shard/mongo.rb b/lib/puppet/provider/mongodb_shard/mongo.rb
@@ -13,7 +13,7 @@
 
   mk_resource_methods
 
-  commands mongo: 'mongo'
+  commands mongosh: 'mongosh'
 
   def initialize(value = {})
     super(value)
@@ -152,8 +152,8 @@ def self.mongo_command(command, host = nil, _retries = 4)
       args = []
       args << '--quiet'
       args << ['--host', host] if host
-      args << ['--eval', "printjson(#{command})"]
-      output = mongo(args.flatten)
+      args << ['--eval', "EJSON.stringify(#{command})"]
+      output = mongosh(args.flatten)
     rescue Puppet::ExecutionFailure => e
       raise unless e =~ %r{Error: couldn't connect to server} && wait <= (2**max_wait)
 
diff --git a/lib/puppet/provider/mongodb_user/mongodb.rb b/lib/puppet/provider/mongodb_user/mongodb.rb
@@ -10,13 +10,12 @@ def self.instances
     require 'json'
 
     if db_ismaster
-      script = 'printjson(db.system.users.find().toArray())'
+      script = 'EJSON.stringify(db.system.users.find().toArray())'
       # A hack to prevent prefetching failures until admin user is created
-      script = "try {#{script}} catch (e) { if (e.message.match(/not authorized on admin/)) { 'not authorized on admin' } else {throw e}}" if auth_enabled
+      script = "try {#{script}} catch (e) { if (e.message.match(/requires authentication/) || e.message.match(/not authorized on admin/)) { 'not authorized on admin' } else {throw e}}" if auth_enabled
 
       out = mongo_eval(script)
-
-      return [] if auth_enabled && out.include?('not authorized on admin')
+      return [] if auth_enabled && (out.include?('requires authentication') || out.include?('not authorized on admin'))
 
       users = JSON.parse out
 
diff --git a/manifests/client/params.pp b/manifests/client/params.pp
@@ -3,16 +3,10 @@
 # @api private
 #
 class mongodb::client::params inherits mongodb::globals {
-  $package_ensure = pick($mongodb::globals::version, 'present')
+  $package_ensure = pick($mongodb::globals::client_version, 'present')
   $manage_package = pick($mongodb::globals::manage_package, $mongodb::globals::manage_package_repo, false)
 
-  if $manage_package {
-    $package_name = "mongodb-${mongodb::globals::edition}-shell"
-  } else {
-    $package_name = $facts['os']['family'] ? {
-      'Debian' => 'mongodb-clients',
-      'Redhat' => "mongodb-${mongodb::globals::edition}-shell",
-      default  => 'mongodb',
-    }
-  }
+  # the new mongosh package is the same for all distros.
+  # and it follows its own versioning
+  $package_name = 'mongodb-mongosh'
 }
diff --git a/manifests/globals.pp b/manifests/globals.pp
@@ -2,6 +2,8 @@
 #
 # @param server_package_name
 # @param client_package_name
+# @param client_version
+#   Version of the client package to install.
 # @param mongod_service_manage
 # @param service_enable
 # @param service_ensure
@@ -28,6 +30,7 @@
 class mongodb::globals (
   $server_package_name         = undef,
   $client_package_name         = undef,
+  $client_version              = undef,
 
   $mongod_service_manage       = undef,
   $service_enable              = undef,
diff --git a/manifests/params.pp b/manifests/params.pp
@@ -22,7 +22,7 @@
   ]
   $handle_creds          = true
   $store_creds           = false
-  $rcfile                = "${facts['root_home']}/.mongorc.js"
+  $rcfile                = "${facts['root_home']}/.mongoshrc.js"
   $dbpath_fix            = false
 
   $manage_package        = pick($mongodb::globals::manage_package, $mongodb::globals::manage_package_repo, false)
diff --git a/manifests/server/config.pp b/manifests/server/config.pp
@@ -179,7 +179,7 @@
   if $handle_creds {
     file { $rcfile:
       ensure  => file,
-      content => template('mongodb/mongorc.js.erb'),
+      content => template('mongodb/mongoshrc.js.erb'),
       owner   => 'root',
       group   => 'root',
       mode    => '0600',
diff --git a/spec/acceptance/database_spec.rb b/spec/acceptance/database_spec.rb
@@ -23,8 +23,8 @@ class { 'mongodb::server': }
       end
 
       it 'creates the databases' do
-        shell("mongo testdb1 --eval 'printjson(db.getMongo().getDBs())'")
-        shell("mongo testdb2 --eval 'printjson(db.getMongo().getDBs())'")
+        shell("mongosh testdb1 --eval 'EJSON.stringify(db.getMongo().getDBs())'")
+        shell("mongosh testdb2 --eval 'EJSON.stringify(db.getMongo().getDBs())'")
       end
     end
 
@@ -50,8 +50,8 @@ class { 'mongodb::server':
       end
 
       it 'creates the database' do
-        shell("mongo testdb1 --port 27018 --eval 'printjson(db.getMongo().getDBs())'")
-        shell("mongo testdb2 --port 27018 --eval 'printjson(db.getMongo().getDBs())'")
+        shell("mongosh testdb1 --port 27018 --eval 'EJSON.stringify(db.getMongo().getDBs())'")
+        shell("mongosh testdb2 --port 27018 --eval 'EJSON.stringify(db.getMongo().getDBs())'")
       end
     end
   end
diff --git a/spec/acceptance/mongos_spec.rb b/spec/acceptance/mongos_spec.rb
@@ -46,7 +46,7 @@ class { 'mongodb::server':
       it { is_expected.to be_listening }
     end
 
-    describe command('mongo --version') do
+    describe command('mongod --version') do
       its(:exit_status) { is_expected.to eq 0 }
     end
   end
diff --git a/spec/acceptance/replset_spec.rb b/spec/acceptance/replset_spec.rb
@@ -6,7 +6,7 @@
   describe 'mongodb_replset resource' do
     after :all do
       # Have to drop the DB to disable replsets for further testing
-      on hosts, %{mongo local --verbose --eval 'db.dropDatabase()'}
+      on hosts, %{mongosh local --verbose --eval 'db.dropDatabase()'}
 
       pp = <<-EOS
         class { 'mongodb::globals': }
@@ -48,26 +48,26 @@ class { 'mongodb::client': }
         }
       EOS
       apply_manifest_on(hosts_as('master'), pp, catch_failures: true)
-      on(hosts_as('master'), 'mongo --quiet --eval "printjson(rs.conf())"') do |r|
+      on(hosts_as('master'), 'mongosh --quiet --eval "EJSON.stringify(rs.conf())"') do |r|
         expect(r.stdout).to match %r{#{hosts[0]}:27017}
         expect(r.stdout).to match %r{#{hosts[1]}:27017}
       end
     end
 
     it 'inserts data on the master' do
       sleep(30)
-      on hosts_as('master'), %{mongo --verbose --eval 'db.test.save({name:"test1",value:"some value"})'}
+      on hosts_as('master'), %{mongosh --verbose --eval 'db.test.save({name:"test1",value:"some value"})'}
     end
 
     it 'checks the data on the master' do
-      on hosts_as('master'), %{mongo --verbose --eval 'printjson(db.test.findOne({name:"test1"}))'} do |r|
+      on hosts_as('master'), %{mongosh --verbose --eval 'EJSON.stringify(db.test.findOne({name:"test1"}))'} do |r|
         expect(r.stdout).to match %r{some value}
       end
     end
 
     it 'checks the data on the slave' do
       sleep(10)
-      on hosts_as('slave'), %{mongo --verbose --eval 'try { rs.secondaryOk() } catch (err) { rs.slaveOk() }; printjson(db.test.findOne({name:"test1"}))'} do |r|
+      on hosts_as('slave'), %{mongosh --verbose --eval 'db.getMongo().setReadPref("primaryPreferred"); EJSON.stringify(db.test.findOne({name:"test1"}))'} do |r|
         expect(r.stdout).to match %r{some value}
       end
     end
@@ -76,7 +76,7 @@ class { 'mongodb::client': }
   describe 'mongodb_replset resource with auth => true' do
     after :all do
       # Have to drop the DB to disable replsets for further testing
-      on hosts, %{mongo local --verbose --eval 'db.dropDatabase()'}
+      on hosts, %{mongosh local --verbose --eval 'db.dropDatabase()'}
 
       pp = <<-EOS
         class { 'mongodb::globals': }
@@ -177,26 +177,26 @@ class { 'mongodb::server':
       EOS
       apply_manifest_on(hosts_as('master'), pp, catch_failures: true)
       apply_manifest_on(hosts_as('master'), pp, catch_changes: true)
-      on(hosts_as('master'), 'mongo --quiet --eval "load(\'/root/.mongorc.js\');printjson(rs.conf())"') do |r|
+      on(hosts_as('master'), 'mongosh --quiet --eval "load(\'/root/.mongoshrc.js\');EJSON.stringify(rs.conf())"') do |r|
         expect(r.stdout).to match %r{#{hosts[0]}:27017}
         expect(r.stdout).to match %r{#{hosts[1]}:27017}
       end
     end
 
     it 'inserts data on the master' do
       sleep(30)
-      on hosts_as('master'), %{mongo test --verbose --eval 'load("/root/.mongorc.js");db.dummyData.insert({"created_by_puppet": 1})'}
+      on hosts_as('master'), %{mongosh test --verbose --eval 'load("/root/.mongoshrc.js");db.dummyData.insert({"created_by_puppet": 1})'}
     end
 
     it 'checks the data on the master' do
-      on hosts_as('master'), %{mongo test --verbose --eval 'load("/root/.mongorc.js");printjson(db.dummyData.findOne())'} do |r|
+      on hosts_as('master'), %{mongosh test --verbose --eval 'load("/root/.mongoshrc.js");EJSON.stringify(db.dummyData.findOne())'} do |r|
         expect(r.stdout).to match %r{created_by_puppet}
       end
     end
 
     it 'checks the data on the slave' do
       sleep(10)
-      on hosts_as('slave'), %{mongo test --verbose --eval 'load("/root/.mongorc.js");try { rs.secondaryOk() } catch (err) { rs.slaveOk() };printjson(db.dummyData.findOne())'} do |r|
+      on hosts_as('slave'), %{mongosh test --verbose --eval 'load("/root/.mongoshrc.js");db.getMongo().setReadPref("primaryPreferred");EJSON.stringify(db.dummyData.findOne())'} do |r|
         expect(r.stdout).to match %r{created_by_puppet}
       end
     end
diff --git a/spec/acceptance/server_spec.rb b/spec/acceptance/server_spec.rb
@@ -35,7 +35,7 @@ class { 'mongodb::server': }
       it { is_expected.to be_listening }
     end
 
-    describe command('mongo --version') do
+    describe command('mongod --version') do
       its(:exit_status) { is_expected.to eq 0 }
     end
   end
@@ -120,24 +120,24 @@ class { 'mongodb::client': }
       it { is_expected.to be_listening }
     end
 
-    describe command('mongo --quiet --eval "db.serverCmdLineOpts().code"') do
+    describe command('mongosh --quiet --eval "db.serverCmdLineOpts().code"') do
       its(:stdout) { is_expected.to match '13' }
     end
 
-    describe file('/root/.mongorc.js') do
+    describe file('/root/.mongoshrc.js') do
       it { is_expected.to be_file }
       it { is_expected.to be_owned_by 'root' }
       it { is_expected.to be_grouped_into 'root' }
       it { is_expected.to be_mode 600 }
       it { is_expected.to contain 'db.auth(\'admin\', \'password\')' }
     end
 
-    describe command("mongo admin --quiet --eval \"load('/root/.mongorc.js');printjson(db.getUser('admin')['customData'])\"") do
+    describe command("mongosh admin --quiet --eval \"load('/root/.mongoshrc.js');EJSON.stringify(db.getUser('admin')['customData'])\"") do
       its(:exit_status) { is_expected.to eq 0 }
       its(:stdout) { is_expected.to match "{ \"createdBy\" : \"Puppet Mongodb_user['User admin on db admin']\" }\n" }
     end
 
-    describe command('mongo --version') do
+    describe command('mongod --version') do
       its(:exit_status) { is_expected.to eq 0 }
     end
   end
diff --git a/spec/acceptance/sharding_spec.rb b/spec/acceptance/sharding_spec.rb
@@ -46,7 +46,7 @@ class { 'mongodb::client': }
       EOS
 
       apply_manifest_on(hosts_as('router'), pp, catch_failures: true)
-      on(hosts_as('router'), 'mongo --quiet --eval "printjson(sh.status())"') do |r|
+      on(hosts_as('router'), 'mongosh --quiet --eval "EJSON.stringify(sh.status())"') do |r|
         expect(r.stdout).to match %r{foo/shard:27018}
         expect(r.stdout).to match %r{foo\.toto}
       end
diff --git a/spec/acceptance/user_spec.rb b/spec/acceptance/user_spec.rb
diff --git a/spec/classes/client_spec.rb b/spec/classes/client_spec.rb
diff --git a/spec/classes/server_spec.rb b/spec/classes/server_spec.rb
diff --git a/spec/unit/puppet/provider/mongodb_database/mongodb_spec.rb b/spec/unit/puppet/provider/mongodb_database/mongodb_spec.rb
diff --git a/spec/unit/puppet/provider/mongodb_user/mongodb_spec.rb b/spec/unit/puppet/provider/mongodb_user/mongodb_spec.rb
diff --git a/templates/mongoshrc.js.erb b/templates/mongoshrc.js.erb

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`]`
`23`	`23`	`$handle_creds = true`
`24`	`24`	`$store_creds = false`
`25`		`- $rcfile = "${facts['root_home']}/.mongorc.js"`
	`25`	`+ $rcfile = "${facts['root_home']}/.mongoshrc.js"`
`26`	`26`	`$dbpath_fix = false`
`27`	`27`
`28`	`28`	`$manage_package = pick($mongodb::globals::manage_package, $mongodb::globals::manage_package_repo, false)`