Stable gemset for integration testing (#1470)

Author: marcotc

.circleci/config.yml

@@ -25,6 +25,10 @@ test_containers:
         description: Resource class to use
         type: string
         default: medium
+      edge:
+        description: Use latest version of dependencies during testing
+        type: boolean
+        default: false
   - &container_base_environment
     BUNDLE_GEMFILE: /app/Gemfile
     JRUBY_OPTS: --dev # Faster JVM startup: https://github.com/jruby/jruby/wiki/Improving-startup-time#use-the---dev-flag
@@ -97,8 +101,27 @@ step_appraisal_install: &step_appraisal_install
   run:
     name: Install Appraisal gems
     command: |
-      bundle exec appraisal clean # Ensure we fetch the latest version of dependencies
       bundle exec appraisal install
+step_appraisal_update: &step_appraisal_update
+  run:
+    name: Update Appraisal gems
+    command: | # Remove all generated gemfiles and lockfiles, resolve, and install dependencies again
+      bundle exec appraisal update
+ensure_lockfile_committed: &ensure_lockfile_committed
+  run:
+    name: Ensure Gem lock files are commited
+    command: |
+      CHANGED_FILES=$(git status gemfiles/ --porcelain)
+      if [[ $CHANGED_FILES ]]
+      then
+        >&2 echo "Gem lock files were modified or new lock files were created during"
+        >&2 echo "'bundle install' and 'bundle appraisal install' installation in CI."
+        >&2 echo "You need to check in those changes in your branch."
+        >&2 echo "Affected files:"
+        >&2 echo $CHANGED_FILES
+        >&2 GIT_PAGER=cat git diff HEAD
+        exit 1
+      fi
 step_compute_bundle_checksum: &step_compute_bundle_checksum
   run:
     name: Compute bundle checksum
@@ -154,7 +177,18 @@ orbs:
               keys:
                 - '{{ .Environment.CIRCLE_CACHE_VERSION }}-bundle-<<parameters.ruby_version>>-{{ checksum ".circleci/bundle_checksum" }}'
           - *step_bundle_install
-          - *step_appraisal_install
+          - when:
+              condition:
+                equal: [ << parameters.edge >>, true ]
+              steps:
+                - *step_appraisal_update # Run on latest version of all gems we integrate with
+          - when:
+              condition:
+                not:
+                  equal: [ << parameters.edge >>, true ]
+              steps:
+                - *step_appraisal_install # Run on a stable set of gems we integrate with
+                - *ensure_lockfile_committed
           - *step_compute_bundle_checksum
           - save_cache:
               key: '{{ .Environment.CIRCLE_CACHE_VERSION }}-bundled-repo-<<parameters.ruby_version>>-{{ .Environment.CIRCLE_SHA1 }}'
@@ -685,3 +719,176 @@ workflows:
             - test-jruby-9.2.0.0
             - test-jruby-9.2-latest
             # soon™️ - test-truffleruby-21.0.0
+  # This workflow runs the same `build` and `test` jobs as above on a schedule.
+  # Tasks related to housekeeping (e.g. prerelease) are not relevant
+  # to this daily check, as they are not expected to be impacted here.
+  edge:
+    triggers:
+      - schedule:
+          cron: "0 0 * * 1-5" # Every weekday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      # Integration
+      - orb/build_and_test_integration:
+          name: build_and_test_integration-2.0
+          integration_apps: 'ruby rack'
+          ruby_version: '2.0'
+          <<: *filters_all_branches_and_tags
+      - orb/build_and_test_integration:
+          name: build_and_test_integration-2.1
+          integration_apps: 'ruby rack'
+          ruby_version: '2.1'
+          <<: *filters_all_branches_and_tags
+      - orb/build_and_test_integration:
+          name: build_and_test_integration-2.2
+          integration_apps: 'ruby rack'
+          ruby_version: '2.2'
+          <<: *filters_all_branches_and_tags
+      - orb/build_and_test_integration:
+          name: build_and_test_integration-2.3
+          integration_apps: 'ruby rack rails-five'
+          ruby_version: '2.3'
+          <<: *filters_all_branches_and_tags
+      - orb/build_and_test_integration:
+          name: build_and_test_integration-2.4
+          integration_apps: 'ruby rack rails-five'
+          ruby_version: '2.4'
+          <<: *filters_all_branches_and_tags
+      - orb/build_and_test_integration:
+          name: build_and_test_integration-2.5
+          integration_apps: 'ruby rack rails-five'
+          ruby_version: '2.5'
+          <<: *filters_all_branches_and_tags
+      - orb/build_and_test_integration:
+          name: build_and_test_integration-2.6
+          integration_apps: 'ruby rack rails-five'
+          ruby_version: '2.6'
+          <<: *filters_all_branches_and_tags
+      - orb/build_and_test_integration:
+          name: build_and_test_integration-2.7
+          integration_apps: 'ruby rack rails-five'
+          ruby_version: '2.7'
+          <<: *filters_all_branches_and_tags
+      - orb/build_and_test_integration:
+          name: build_and_test_integration-3.0
+          # TODO: Get Rack & Rails apps working with Ruby 3.0
+          integration_apps: 'ruby'
+          ruby_version: '3.0'
+          <<: *filters_all_branches_and_tags
+      # MRI
+      - orb/build:
+          <<: *config-2_0
+          name: build-2.0
+          edge: true
+      - orb/test:
+          <<: *config-2_0
+          name: test-2.0
+          requires:
+            - build-2.0
+      - orb/build:
+          <<: *config-2_1
+          name: build-2.1
+      - orb/test:
+          <<: *config-2_1
+          name: test-2.1
+          requires:
+            - build-2.1
+      - orb/build:
+          <<: *config-2_2
+          name: build-2.2
+      - orb/test:
+          <<: *config-2_2
+          name: test-2.2
+          requires:
+            - build-2.2
+      - orb/build:
+          <<: *config-2_3
+          name: build-2.3
+      - orb/test:
+          <<: *config-2_3
+          name: test-2.3
+          requires:
+            - build-2.3
+      - orb/benchmark:
+          <<: *config-2_3
+          name: benchmark-2.3
+          requires:
+            - build-2.3
+      - orb/build:
+          <<: *config-2_4
+          name: build-2.4
+      - orb/test:
+          <<: *config-2_4
+          name: test-2.4
+          requires:
+            - build-2.4
+      - orb/build:
+          <<: *config-2_5
+          name: build-2.5
+      - orb/test:
+          <<: *config-2_5
+          name: test-2.5
+          requires:
+            - build-2.5
+      - orb/build:
+          <<: *config-2_6
+          name: build-2.6
+      - orb/test:
+          <<: *config-2_6
+          name: test-2.6
+          requires:
+            - build-2.6
+      - orb/build:
+          <<: *config-2_7
+          name: build-2.7
+      - orb/test:
+          <<: *config-2_7
+          name: test-2.7
+          requires:
+            - build-2.7
+      - orb/build:
+          <<: *config-3_0
+          name: build-3.0
+      - orb/test:
+          <<: *config-3_0
+          name: test-3.0
+          requires:
+            - build-3.0
+      - orb/build:
+          <<: *config-3_0-jit
+          name: build-3.0-jit
+      - orb/test:
+          <<: *config-3_0-jit
+          name: test-3.0-jit
+          requires:
+            - build-3.0-jit
+      # JRuby
+      - orb/build:
+          <<: *config-jruby-9_2_0_0
+          name: build-jruby-9.2.0.0
+      - orb/test:
+          <<: *config-jruby-9_2_0_0
+          name: test-jruby-9.2.0.0
+          requires:
+            - build-jruby-9.2.0.0
+      - orb/build:
+          <<: *config-jruby-9_2-latest
+          name: build-jruby-9.2-latest
+      - orb/test:
+          <<: *config-jruby-9_2-latest
+          name: test-jruby-9.2-latest
+          requires:
+            - build-jruby-9.2-latest
+      # TruffleRuby
+      # soon™️
+      # - orb/build:
+      #     <<: *config-truffleruby-21_0_0
+      #     name: build-truffleruby-21.0.0
+      # - orb/test:
+      #     <<: *config-truffleruby-21_0_0
+      #     name: test-truffleruby-21.0.0
+      #     requires:
+      #       - build-truffleruby-21.0.0

.dockerignore

@@ -1 +0,0 @@
-gemfiles/*

.gitignore

@@ -55,7 +55,6 @@ build-iPhoneSimulator/
 
 # lock files
 Gemfile.lock
-gemfiles/*
 
 # bundle config
 gemfiles/.bundle

Appraisals

@@ -1417,3 +1417,13 @@ elsif Gem::Version.new('3.0.0') <= Gem::Version.new(RUBY_VERSION)
     gem 'dogstatsd-ruby', '~> 4'
   end
 end
+
+ruby_runtime = if defined?(RUBY_ENGINE_VERSION)
+                 "#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}"
+               else
+                 "#{RUBY_ENGINE}-#{RUBY_VERSION}" # For Ruby < 2.3
+               end
+
+appraisals.each do |appraisal|
+  appraisal.name.prepend("#{ruby_runtime}-")
+end

Rakefile

@@ -193,6 +193,14 @@ def declare(*args)
   total_executors = ENV.key?('CIRCLE_NODE_TOTAL') ? ENV['CIRCLE_NODE_TOTAL'].to_i : nil
   current_executor = ENV.key?('CIRCLE_NODE_INDEX') ? ENV['CIRCLE_NODE_INDEX'].to_i : nil
 
+  ruby_runtime = if defined?(RUBY_ENGINE_VERSION)
+                   "#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}"
+                 else
+                   "#{RUBY_ENGINE}-#{RUBY_VERSION}" # For Ruby < 2.3
+                 end
+
+  args[0].sub!(/^bundle exec appraisal /, "bundle exec appraisal #{ruby_runtime}-")
+
   if total_executors && current_executor && total_executors > 1
     @execution_count ||= 0
     @execution_count += 1

docker-compose.yml

@@ -30,7 +30,6 @@ services:
     volumes:
       - .:/app
       - bundle-2.0:/usr/local/bundle
-      - gemfiles-2.0:/app/gemfiles
   tracer-2.1:
     image: palazzem/docker-library:ddtrace_rb_2_1_10
     command: /bin/bash
@@ -61,7 +60,6 @@ services:
     volumes:
       - .:/app
       - bundle-2.1:/usr/local/bundle
-      - gemfiles-2.1:/app/gemfiles
   tracer-2.2:
     image: palazzem/docker-library:ddtrace_rb_2_2_10
     command: /bin/bash
@@ -92,7 +90,6 @@ services:
     volumes:
       - .:/app
       - bundle-2.2:/usr/local/bundle
-      - gemfiles-2.2:/app/gemfiles
   tracer-2.3:
     image: palazzem/docker-library:ddtrace_rb_2_3_8
     command: /bin/bash
@@ -123,7 +120,6 @@ services:
     volumes:
       - .:/app
       - bundle-2.3:/usr/local/bundle
-      - gemfiles-2.3:/app/gemfiles
   tracer-2.4:
     image: palazzem/docker-library:ddtrace_rb_2_4_6
     command: /bin/bash
@@ -154,7 +150,6 @@ services:
     volumes:
       - .:/app
       - bundle-2.4:/usr/local/bundle
-      - gemfiles-2.4:/app/gemfiles
   tracer-2.5:
     image: marcotc/docker-library:ddtrace_rb_2_5_6
     command: /bin/bash
@@ -185,7 +180,6 @@ services:
     volumes:
       - .:/app
       - bundle-2.5:/usr/local/bundle
-      - gemfiles-2.5:/app/gemfiles
   tracer-2.6:
     image: marcotc/docker-library:ddtrace_rb_2_6_4
     command: /bin/bash
@@ -216,7 +210,6 @@ services:
     volumes:
       - .:/app
       - bundle-2.6:/usr/local/bundle
-      - gemfiles-2.6:/app/gemfiles
   tracer-2.7:
     image: marcotc/docker-library:ddtrace_rb_2_7_0
     command: /bin/bash
@@ -247,7 +240,6 @@ services:
     volumes:
       - .:/app
       - bundle-2.7:/usr/local/bundle
-      - gemfiles-2.7:/app/gemfiles
   tracer-3.0:
     image: marcotc/docker-library:ddtrace_rb_3.0.0
     command: /bin/bash
@@ -275,7 +267,6 @@ services:
     volumes:
       - .:/app
       - bundle-3.0:/usr/local/bundle
-      - gemfiles-3.0:/app/gemfiles
   # JRuby
   tracer-jruby-9.2.0.0:
     image: marcotc/docker-library:ddtrace_rb_jruby_9_2_0_0
@@ -307,7 +298,6 @@ services:
     volumes:
       - .:/app
       - bundle-jruby-9.2.0.0:/usr/local/bundle
-      - gemfiles-jruby-9.2.0.0:/app/gemfiles
   tracer-jruby-9.2-latest:
     image: marcotc/docker-library:ddtrace_rb_jruby_9_2_11_1
     command: /bin/bash
@@ -338,7 +328,6 @@ services:
     volumes:
       - .:/app
       - bundle-jruby-9.2-latest:/usr/local/bundle
-      - gemfiles-jruby-9.2-latest:/app/gemfiles
   # TruffleRuby
   tracer-truffleruby-21.0.0:
     image: ivoanjo/docker-library:ddtrace_rb_truffleruby_21_0_0
@@ -370,7 +359,6 @@ services:
     volumes:
       - .:/app
       - bundle-truffleruby-21.0.0:/usr/local/bundle
-      - gemfiles-truffleruby-21.0.0:/app/gemfiles
   ddagent:
     image: datadog/agent
     environment:
@@ -454,15 +442,3 @@ volumes:
   bundle-jruby-9.2.0.0:
   bundle-jruby-9.2-latest:
   bundle-truffleruby-21.0.0:
-  gemfiles-2.0:
-  gemfiles-2.1:
-  gemfiles-2.2:
-  gemfiles-2.3:
-  gemfiles-2.4:
-  gemfiles-2.5:
-  gemfiles-2.6:
-  gemfiles-2.7:
-  gemfiles-3.0:
-  gemfiles-jruby-9.2.0.0:
-  gemfiles-jruby-9.2-latest:
-  gemfiles-truffleruby-21.0.0: