Merge pull request #4535 from DataDog/add-meta-version-into-build-matrix

[NO-TICKET] Adjust build coverage matrix method to allow min/<version>/last

Author: Strech

appraisal/generate.rb

@@ -13,13 +13,13 @@
 # Usage: `bundle exec ruby appraisal/generate.rb`
 
 require 'bundler'
-require "appraisal/appraisal"
+require 'appraisal/appraisal'
 
-require_relative "../tasks/appraisal_conversion"
+require_relative '../tasks/appraisal_conversion'
 
 gemfile = Appraisal::Gemfile.new.tap do |g|
   # Support `eval_gemfile` for `Bundler::DSL`
-  g.define_singleton_method(:eval_gemfile) {|file| load(file) }
+  g.define_singleton_method(:eval_gemfile) { |file| load(file) }
   g.load(Bundler.default_gemfile)
 end
 
@@ -53,20 +53,56 @@
 # `gem`  : optional, gem name to test (gem name can be different from the integration name)
 # `min`  : optional, minimum version to test
 # `meta` : optional, additional metadata (development dependencies, etc.) for the group
+#
+# Examples:
+#
+# 1. Generating coverage starting minimal version
+#
+#    build_coverage_matrix('devise', min: '3.1.4')
+#     ├─ appraise 'devise-min'
+#     │   └─ gem 'devise', '= 3.1.4'
+#     └─ appraise 'devise-latest'
+#         └─ gem 'devise'
+#
+# 2. Generating coverage starting minimal version with some additional gems with
+#    specific version tied to only minimal version
+#
+#    build_coverage_matrix('devise', min: '3.1.4', meta: { min: { 'bigdecimal' => '1.3.4' } })
+#     ├─ appraise 'devise-min'
+#     │   ├─ gem 'devise', '= 3.1.4'
+#     │   └─ gem 'bigdecimal', '1.3.4'
+#     └─ appraise 'devise-latest'
+#         └─ gem 'devise'
+#
+# 3. Generating coverage starting minimal version with some additional gems with
+#    specific version for all possible combinations
+#
+#    build_coverage_matrix('devise', min: '3.1.4', meta: { 'bigdecimal' => '3.0.0' })
+#     ├─ appraise 'devise-min'
+#     │   ├─ gem 'devise', '= 3.1.4'
+#     │   └─ gem 'bigdecimal', '3.0.0'
+#     └─ appraise 'devise-latest'
+#         ├─ gem 'devise'
+#         └─ gem 'bigdecimal', '3.0.0'
 def build_coverage_matrix(integration, range = [], gem: nil, min: nil, meta: {})
   gem ||= integration
 
+  meta_versions = meta.each_with_object({}) do |(key, value), memo|
+    memo[key] = meta.delete(key) if value.is_a?(Hash)
+  end
+
   if min
     appraise "#{integration}-min" do
       gem gem, "= #{min}"
-      meta.each { |k, v| v ? gem(k, v) : gem(k) }
+
+      meta_versions[:min].to_h.merge(meta).each { |k, v| v ? gem(k, v) : gem(k) }
     end
   end
 
   range.each do |n|
     appraise "#{integration}-#{n}" do
       gem gem, "~> #{n}"
-      meta.each { |k, v| v ? gem(k, v) : gem(k) }
+      meta_versions[n].to_h.merge(meta).each { |k, v| v ? gem(k, v) : gem(k) }
     end
   end
 
@@ -75,7 +111,7 @@ def build_coverage_matrix(integration, range = [], gem: nil, min: nil, meta: {})
     # still requires being updated to pick up the next major version and
     # committing the changes to lockfiles.
     gem gem
-    meta.each { |k, v| v ? gem(k, v) : gem(k) }
+    meta_versions[:latest].to_h.merge(meta).each { |k, v| v ? gem(k, v) : gem(k) }
   end
 end
 

appraisal/ruby-2.5.rb

@@ -223,7 +223,7 @@
 build_coverage_matrix('rest-client')
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli')
-build_coverage_matrix('devise', min: '3.2.1')
+build_coverage_matrix('devise', min: '3.2.1', meta: { min: { 'bigdecimal' => '1.3.4' } })
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 5'

appraisal/ruby-2.6.rb

@@ -176,7 +176,7 @@
 build_coverage_matrix('rest-client')
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli', [2])
-build_coverage_matrix('devise', min: '3.2.1')
+build_coverage_matrix('devise', min: '3.2.1', meta: { min: { 'bigdecimal' => '1.4.1' } })
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 6.0.0'