MONGOID-5656 Rails specs ought to enable FLE (#5718)

jamis · web-flow · commit 8f74b689c229 · 2023-09-14T08:05:34.000-06:00
* make sure and test the rails specs with fle enabled

* only run FLE with Rails 7 (due to OS constraints with cmake/libmongocrypt-helper)

* see about making GH actions build and use libmongocrypt-helper

* make sure command-line parsing doesn't pick up arguments that weren't intended for it

* a bit more information for deciphering what's wrong under GH actions

* *grumble* use a real exception class

* run `rake ci` instead, to better isolate the specs

* disambiguate test names

* use logger to report error in collection creation

also, use log-levels to minimize log spam in tests, instead of stubbing the logger
diff --git a/.evergreen/config.yml b/.evergreen/config.yml
@@ -680,7 +680,8 @@ buildvariants:
     mongodb-version: "6.0"
     topology: "standalone"
     rails: ['7.0']
-    os: debian11
+    os: ubuntu-22.04
+    fle: helper
   display_name: "${rails}, ${driver}, ${mongodb-version}"
   tasks:
     - name: "test"
diff --git a/.evergreen/config/variants.yml.erb b/.evergreen/config/variants.yml.erb
@@ -116,8 +116,9 @@ buildvariants:
     mongodb-version: "6.0"
     topology: "standalone"
     rails: ['7.0']
-    os: debian11
-  display_name: "${rails}, ${driver}, ${mongodb-version}"
+    os: ubuntu-22.04
+    fle: helper
+  display_name: "${rails}, ${driver}, ${mongodb-version} (FLE ${fle})"
   tasks:
     - name: "test"
 
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -7,8 +7,8 @@ name: Run Mongoid Tests
 - pull_request
 jobs:
   build:
-    name: "${{matrix.ruby}} driver-${{matrix.driver}} mongodb-${{matrix.mongodb}}
-      ${{matrix.topology}}"
+    name: "${{matrix.ruby}} drv:${{matrix.driver}} db:${{matrix.mongodb}}
+      rails:${{matrix.rails}} fle:${{matrix.fle}} ${{matrix.topology}}"
     env:
       CI: true
       TESTOPTS: "-v"
@@ -24,8 +24,6 @@ jobs:
           os: ubuntu-20.04
           task: test
           driver: current
-          rails:
-          i18n:
           gemfile: Gemfile
           experimental: false
         - mongodb: '6.0'
@@ -34,8 +32,6 @@ jobs:
           os: ubuntu-20.04
           task: test
           driver: current
-          rails:
-          i18n:
           gemfile: Gemfile
           experimental: false
         - mongodb: '6.0'
@@ -44,8 +40,6 @@ jobs:
           os: ubuntu-20.04
           task: test
           driver: current
-          rails:
-          i18n:
           gemfile: Gemfile
           experimental: false
         - mongodb: '6.0'
@@ -54,8 +48,6 @@ jobs:
           os: ubuntu-20.04
           task: test
           driver: master
-          rails:
-          i18n:
           gemfile: gemfiles/driver_master.gemfile
           experimental: true
         - mongodb: '6.0'
@@ -64,8 +56,6 @@ jobs:
           os: ubuntu-20.04
           task: test
           driver: stable
-          rails:
-          i18n:
           gemfile: gemfiles/driver_stable.gemfile
           experimental: false
         - mongodb: '6.0'
@@ -75,7 +65,7 @@ jobs:
           task: test
           driver: current
           rails: '7.0'
-          i18n:
+          fle: helper
           gemfile: gemfiles/rails-7.0.gemfile
           experimental: false
         - mongodb: '6.0'
@@ -85,7 +75,7 @@ jobs:
           task: test
           driver: current
           rails: '6.1'
-          i18n:
+          fle: helper
           gemfile: gemfiles/rails-6.1.gemfile
           experimental: false
         - mongodb: '6.0'
@@ -95,7 +85,7 @@ jobs:
           task: test
           driver: current
           rails: '7.0'
-          i18n:
+          fle: helper
           gemfile: gemfiles/rails-7.0.gemfile
           experimental: false
         - mongodb: '6.0'
@@ -105,7 +95,7 @@ jobs:
           task: test
           driver: current
           rails: '6.1'
-          i18n:
+          fle: helper
           gemfile: gemfiles/rails-6.1.gemfile
           experimental: false
         - mongodb: '6.0'
@@ -115,7 +105,7 @@ jobs:
           task: test
           driver: current
           rails: '6.0'
-          i18n:
+          fle: helper
           gemfile: gemfiles/rails-6.0.gemfile
           experimental: false
         - mongodb: '6.0'
@@ -125,7 +115,7 @@ jobs:
           task: test
           driver: current
           rails: '5.2'
-          i18n:
+          fle: helper
           gemfile: gemfiles/rails-5.2.gemfile
           experimental: false
         - mongodb: '6.0'
@@ -135,7 +125,7 @@ jobs:
           task: test
           driver: current
           rails: '6.0'
-          i18n:
+          fle: helper
           gemfile: gemfiles/rails-6.0.gemfile
           experimental: false
         - mongodb: '5.0'
@@ -144,8 +134,6 @@ jobs:
           os: ubuntu-20.04
           task: test
           driver: current
-          rails:
-          i18n:
           gemfile: Gemfile
           experimental: false
         - mongodb: '4.4'
@@ -154,8 +142,6 @@ jobs:
           os: ubuntu-20.04
           task: test
           driver: current
-          rails:
-          i18n:
           gemfile: Gemfile
           experimental: false
         - mongodb: '4.0'
@@ -164,8 +150,6 @@ jobs:
           os: ubuntu-20.04
           task: test
           driver: current
-          rails:
-          i18n:
           gemfile: Gemfile
           experimental: false
         - mongodb: '3.6'
@@ -174,8 +158,6 @@ jobs:
           os: ubuntu-20.04
           task: test
           driver: current
-          rails:
-          i18n:
           gemfile: Gemfile
           experimental: false
 
@@ -193,18 +175,21 @@ jobs:
     - name: load ruby
       uses: ruby/setup-ruby@v1
       env:
+        FLE: "${{matrix.fle}}"
         BUNDLE_GEMFILE: "${{matrix.gemfile}}"
       with:
         ruby-version: "${{matrix.ruby}}"
         bundler: 2
     - name: bundle
       run: bundle install --jobs 4 --retry 3
       env:
+        FLE: "${{matrix.fle}}"
         BUNDLE_GEMFILE: "${{matrix.gemfile}}"
     - name: test
       timeout-minutes: 60
       continue-on-error: "${{matrix.experimental}}"
-      run: bundle exec rake spec
+      run: bundle exec rake ci
       env:
         BUNDLE_GEMFILE: "${{matrix.gemfile}}"
+        FLE: "${{matrix.fle}}"
         MONGODB_URI: "${{ steps.start-mongodb.outputs.cluster-uri }}"
diff --git a/lib/mongoid/tasks/database.rb b/lib/mongoid/tasks/database.rb
@@ -26,6 +26,9 @@ def create_collections(models = ::Mongoid.models, force: false)
           else
             logger.info("MONGOID: collection options ignored on: #{model}, please define in the root model.")
           end
+        rescue Exception
+          logger.error "error while creating collection for #{model}"
+          raise
         end
       end
 
diff --git a/lib/mongoid/tasks/encryption.rake b/lib/mongoid/tasks/encryption.rake
@@ -2,27 +2,45 @@
 
 require 'optparse'
 
-# rubocop:disable Metrics/BlockLength
+def parse_data_key_options(argv = ARGV)
+  # The only way to use OptionParser to parse custom options in rake is
+  # to pass an empty argument ("--") before specifying them, e.g.:
+  #
+  #    rake db:mongoid:encryption:create_data_key -- --client default
+  #
+  # Otherwise, rake complains about an unknown option. Thus, we can tell
+  # if the argument list is valid for us to parse by detecting this empty
+  # argument.
+  #
+  # (This works around an issue in the tests, where the specs are loading
+  # the tasks directly to test them, but the option parser is then picking
+  # up rspec command-line arguments and raising an exception).
+  return {} unless argv.include?('--')
+
+  {}.tap do |options|
+    parser = OptionParser.new do |opts|
+      opts.on('-c', '--client CLIENT', 'Name of the client to use') do |v|
+        options[:client_name] = v
+      end
+      opts.on('-p', '--provider PROVIDER', 'KMS provider to use') do |v|
+        options[:kms_provider_name] = v
+      end
+      opts.on('-n', '--key-alt-name KEY_ALT_NAME', 'Alternate name for the key') do |v|
+        options[:key_alt_name] = v
+      end
+    end
+    # rubocop:disable Lint/EmptyBlock
+    parser.parse!(parser.order!(argv) {})
+    # rubocop:enable Lint/EmptyBlock
+  end
+end
+
 namespace :db do
   namespace :mongoid do
     namespace :encryption do
       desc 'Create encryption key'
       task create_data_key: [ :environment ] do
-        options = {}
-        parser = OptionParser.new do |opts|
-          opts.on('-c', '--client CLIENT', 'Name of the client to use') do |v|
-            options[:client_name] = v
-          end
-          opts.on('-p', '--provider PROVIDER', 'KMS provider to use') do |v|
-            options[:kms_provider_name] = v
-          end
-          opts.on('-n', '--key-alt-name KEY_ALT_NAME', 'Alternate name for the key') do |v|
-            options[:key_alt_name] = v
-          end
-        end
-        # rubocop:disable Lint/EmptyBlock
-        parser.parse!(parser.order!(ARGV) {})
-        # rubocop:enable Lint/EmptyBlock
+        options = parse_data_key_options
         result = Mongoid::Tasks::Encryption.create_data_key(
           client_name: options[:client_name],
           kms_provider_name: options[:kms_provider_name],
@@ -39,4 +57,3 @@ namespace :db do
     end
   end
 end
-# rubocop:enable Metrics/BlockLength
diff --git a/spec/mongoid/tasks/database_rake_spec.rb b/spec/mongoid/tasks/database_rake_spec.rb
@@ -11,9 +11,7 @@
   let(:task_file) { "mongoid/tasks/database" }
 
   let(:logger) do
-    double("logger").tap do |log|
-      allow(log).to receive(:info)
-    end
+    Logger.new(STDOUT, level: :error, formatter: ->(_sev, _dt, _prog, msg) { msg })
   end
 
   before do
