Merge pull request #7891 from rubygems/deivid-rodriguez/better-current-platform-debug

Print better log message when current platform is not present in the lockfile

(cherry picked from commit 894b724)

Author: deivid-rodriguez

bundler/lib/bundler/definition.rb

@@ -137,7 +137,7 @@ def initialize(lockfile, dependencies, sources, unlock, ruby_version = nil, opti
       end
       @unlocking ||= @unlock[:ruby] ||= (!@locked_ruby_version ^ !@ruby_version)
 
-      add_current_platform unless Bundler.frozen_bundle?
+      @current_platform_missing = add_current_platform unless Bundler.frozen_bundle?
 
       converge_path_sources_to_gemspec_sources
       @path_changes = converge_paths
@@ -484,6 +484,7 @@ def nothing_changed?
 
       !@source_changes &&
         !@dependency_changes &&
+        !@current_platform_missing &&
         @new_platforms.empty? &&
         !@path_changes &&
         !@local_changes &&
@@ -671,19 +672,19 @@ def current_platform_locked?
     end
 
     def add_current_platform
-      @most_specific_non_local_locked_ruby_platform = find_most_specific_non_local_locked_ruby_platform
+      return if @platforms.include?(local_platform)
+
+      @most_specific_non_local_locked_ruby_platform = find_most_specific_locked_ruby_platform
       return if @most_specific_non_local_locked_ruby_platform
 
-      add_platform(local_platform)
+      @platforms << local_platform
+      true
     end
 
-    def find_most_specific_non_local_locked_ruby_platform
+    def find_most_specific_locked_ruby_platform
       return unless generic_local_platform_is_ruby? && current_platform_locked?
 
-      most_specific_locked_ruby_platform = most_specific_locked_platform
-      return unless most_specific_locked_ruby_platform != local_platform
-
-      most_specific_locked_ruby_platform
+      most_specific_locked_platform
     end
 
     def change_reason
@@ -705,6 +706,7 @@ def change_reason
       [
         [@source_changes, "the list of sources changed"],
         [@dependency_changes, "the dependencies in your gemfile changed"],
+        [@current_platform_missing, "your lockfile does not include the current platform"],
         [@new_platforms.any?, "you added a new platform to your gemfile"],
         [@path_changes, "the gemspecs for path gems changed"],
         [@local_changes, "the gemspecs for git local gems changed"],

bundler/spec/commands/install_spec.rb

@@ -1136,12 +1136,16 @@ def run
     end
   end
 
-  context "in a frozen bundle" do
-    before do
+  context "when current platform not included in the lockfile" do
+    around do |example|
       build_repo4 do
         build_gem "libv8", "8.4.255.0" do |s|
           s.platform = "x86_64-darwin-19"
         end
+
+        build_gem "libv8", "8.4.255.0" do |s|
+          s.platform = "x86_64-linux"
+        end
       end
 
       gemfile <<-G
@@ -1166,11 +1170,36 @@ def run
            #{Bundler::VERSION}
       L
 
-      bundle "config set --local deployment true"
+      simulate_platform("x86_64-linux", &example)
     end
 
-    it "should fail loudly if the lockfile platforms don't include the current platform" do
-      simulate_platform(Gem::Platform.new("x86_64-linux")) { bundle "install", raise_on_error: false }
+    it "adds the current platform to the lockfile" do
+      bundle "install --verbose"
+
+      expect(out).to include("re-resolving dependencies because your lockfile does not include the current platform")
+
+      expect(lockfile).to eq <<~L
+        GEM
+          remote: https://gem.repo4/
+          specs:
+            libv8 (8.4.255.0-x86_64-darwin-19)
+            libv8 (8.4.255.0-x86_64-linux)
+
+        PLATFORMS
+          x86_64-darwin-19
+          x86_64-linux
+
+        DEPENDENCIES
+          libv8
+
+        BUNDLED WITH
+           #{Bundler::VERSION}
+      L
+    end
+
+    it "fails loudly if frozen mode set" do
+      bundle "config set --local deployment true"
+      bundle "install", raise_on_error: false
 
       expect(err).to eq(
         "Your bundle only supports platforms [\"x86_64-darwin-19\"] but your local platform is x86_64-linux. " \

bundler/spec/commands/lock_spec.rb

@@ -1061,7 +1061,7 @@
          #{Bundler::VERSION}
     G
 
-    simulate_platform(Gem::Platform.new("x86_64-darwin-19")) { bundle "lock --update" }
+    simulate_platform("x86_64-darwin-19") { bundle "lock --update" }
 
     expect(out).to match(/Writing lockfile to.+Gemfile\.lock/)
   end
@@ -1083,7 +1083,7 @@
       gem "libv8"
     G
 
-    simulate_platform(Gem::Platform.new("x86_64-darwin-19")) { bundle "lock" }
+    simulate_platform("x86_64-darwin-19") { bundle "lock" }
 
     checksums = checksums_section_when_enabled do |c|
       c.checksum gem_repo4, "libv8", "8.4.255.0", "x86_64-darwin-19"
@@ -1151,7 +1151,7 @@
     previous_lockfile = lockfile
 
     %w[x86_64-darwin-19 x86_64-darwin-20].each do |platform|
-      simulate_platform(Gem::Platform.new(platform)) do
+      simulate_platform(platform) do
         bundle "lock"
         expect(lockfile).to eq(previous_lockfile)