v1.19.1

This reverts commit 01ca86de8b.

CHANGELOG.md

@@ -1,5 +1,21 @@
 ## ChangeLog
 
+### v1.19.1
+
+#### Fixes
+
+- #123 - Install builder: remove target file before copying to avoid errors due to overwriting read-only files
+
+### v1.19.0
+
+#### New Features
+
+- #117 - ruby 2.7 compatibility
+
+#### Fixes
+
+- #115 - Check that user dependencies exist before running builders.
+
 ### v1.18.0
 
 #### Performance Improvements

Gemfile.lock

@@ -1,36 +1,36 @@
 PATH
   remote: .
   specs:
-    rscons (1.18.0)
+    rscons (1.19.1)
       json (>= 1.8, < 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    docile (1.3.2)
+    docile (1.1.5)
-    json (2.2.0)
+    json (2.3.0)
-    rake (13.0.0)
+    rake (13.0.1)
-    rdoc (6.2.0)
+    rdoc (6.2.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
+    rspec-core (3.9.1)
-      rspec-support (~> 3.9.0)
+      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+    rspec-support (3.9.2)
-    simplecov (0.17.1)
+    simplecov (0.15.1)
-      docile (~> 1.1)
+      docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    yard (0.9.20)
+    yard (0.9.24)
 
 PLATFORMS
   ruby
@@ -41,8 +41,8 @@ DEPENDENCIES
   rdoc
   rscons!
   rspec
-  simplecov
+  simplecov (~> 0.15.0)
   yard
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

build_tests/build_dir/install_read_only.rb

@@ -0,0 +1,3 @@
+Rscons::Environment.new do |env|
+  env.Install("dest", "install.rb")
+end

build_tests/simple/new_dep

@@ -0,0 +1 @@
+# This file is referenced by cache_debugging.rb

lib/rscons.rb

@@ -5,6 +5,7 @@ require_relative "rscons/cache"
 require_relative "rscons/environment"
 require_relative "rscons/job_set"
 require_relative "rscons/threaded_command"
+require_relative "rscons/util"
 require_relative "rscons/varset"
 require_relative "rscons/version"
 

lib/rscons/builders/install.rb

@@ -47,6 +47,7 @@ module Rscons
               printed_message = true
             end
             cache.mkdir_p(File.dirname(dest))
+            FileUtils.rm_f(dest)
             FileUtils.cp(src, dest, :preserve => true)
           end
           cache.register_build(dest, :Copy, [src], env)

lib/rscons/cache.rb

@@ -282,6 +282,16 @@ module Rscons
       @cache["directories"].keys
     end
 
+    # Return a file's checksum, or the previously calculated checksum for
+    # the same file.
+    #
+    # @param file [String] The file name.
+    #
+    # @return [String] The file's checksum.
+    def lookup_checksum(file)
+      @lookup_checksums[file] || calculate_checksum(file)
+    end
+
     private
 
     # Return a String key based on the target name to use in the on-disk cache.
@@ -312,16 +322,6 @@ module Rscons
       @lookup_checksums = {}
     end
 
-    # Return a file's checksum, or the previously calculated checksum for
-    # the same file.
-    #
-    # @param file [String] The file name.
-    #
-    # @return [String] The file's checksum.
-    def lookup_checksum(file)
-      @lookup_checksums[file] || calculate_checksum(file)
-    end
-
     # Calculate and return a file's checksum.
     #
     # @param file [String] The file name.

lib/rscons/environment.rb

@@ -1,7 +1,6 @@
 require "fileutils"
 require "set"
 require "shellwords"
-require "thwait"
 
 module Rscons
   # The Environment class is the main programmatic interface to Rscons. It
@@ -341,6 +340,7 @@ module Rscons
           cache.clear_checksum_cache!
 
           if job
+            validate_user_deps(job[:target], @user_deps[job[:target]], cache)
             result = run_builder(job[:builder],
                                  job[:target],
                                  job[:sources],
@@ -1011,10 +1011,7 @@ module Rscons
           !thread.alive?
         end
       else
-        if threads.empty?
+        Util.wait_for_thread(*threads)
-          raise "No threads to wait for"
-        end
-        ThreadsWait.new(*threads).next_wait
       end
     end
 
@@ -1107,5 +1104,25 @@ module Rscons
       end
       deps
     end
+
+    # Ensures that user dependencies exist with valid checksums in the
+    # cache.  Raises an exception if any dependency is invalid.
+    #
+    # @param target [String]
+    #   Target to be built
+    # @param user_deps [Array<String>, nil]
+    #   User dependencies of the target
+    # @param cache [Cache]
+    #   Rscons cache instance
+    #
+    # @return [void]
+    def validate_user_deps(target, user_deps, cache)
+      return if user_deps.nil?
+      user_deps.each do |dep|
+        if cache.lookup_checksum(dep) == ""
+          raise "User dependency #{dep} of target #{target} is invalid"
+        end
+      end
+    end
   end
 end

lib/rscons/util.rb

@@ -0,0 +1,34 @@
+module Rscons
+  # A collection of stand-alone utility methods.
+  module Util
+    class << self
+
+      # Wait for any of a number of threads to complete.
+      #
+      # @param threads [Array<Thread>]
+      #   Threads to wait for.
+      #
+      # @return [Thread]
+      #   The Thread that completed.
+      def wait_for_thread(*threads)
+        if threads.empty?
+          raise "No threads to wait for"
+        end
+        queue = Queue.new
+        threads.each do |thread|
+          # Create a wait thread for each thread we're waiting for.
+          Thread.new do
+            begin
+              thread.join
+            ensure
+              queue.push(thread)
+            end
+          end
+        end
+        # Wait for any thread to complete.
+        queue.pop
+      end
+
+    end
+  end
+end

lib/rscons/version.rb

@@ -1,4 +1,4 @@
 module Rscons
   # gem version
-  VERSION = "1.18.0"
+  VERSION = "1.19.1"
 end

rscons.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "simplecov", "~> 0.15.0"
   gem.add_development_dependency "yard"
   gem.add_development_dependency "rdoc"
 end

spec/build_tests_spec.rb

@@ -97,7 +97,7 @@ ENV["TERM"] = nil
 EOF
     end
     stdout, stderr, status = nil, nil, nil
-    Bundler.with_clean_env do
+    Bundler.with_unbundled_env do
       stdout, stderr, status = Open3.capture3(*command)
     end
     # Remove output lines generated as a result of the test environment
@@ -417,14 +417,14 @@ EOF
     expect(result.stderr).to eq ""
     expect(lines(result.stdout)).to eq(["LD simple.exe"])
 
-    File.unlink("program.ld")
-    result = run_test(rsconsfile: "user_dependencies.rb")
-    expect(result.stderr).to eq ""
-    expect(lines(result.stdout)).to eq ["LD simple.exe"]
-
     result = run_test(rsconsfile: "user_dependencies.rb")
     expect(result.stderr).to eq ""
     expect(result.stdout).to eq ""
+
+    File.unlink("program.ld")
+    result = run_test(rsconsfile: "user_dependencies.rb")
+    expect(result.stderr).to match /User dependency program\.ld of target simple\.exe is invalid/
+    expect(result.status).to_not eq 0
   end
 
   unless ENV["omit_gdc_tests"]
@@ -1002,6 +1002,22 @@ EOF
       expect(lines(result.stdout)).to eq ["Install inst.exe"]
     end
 
+    it "overwrites a read-only file" do
+      test_dir("build_dir")
+
+      FileUtils.chmod("a=r", "install.rb")
+      result = run_test(rsconsfile: "install_read_only.rb")
+      expect(result.stderr).to eq ""
+      expect(lines(result.stdout)).to eq ["Install dest"]
+
+      FileUtils.rm_f("install.rb")
+      File.binwrite("install.rb", "hi")
+      FileUtils.chmod("a=r", "install.rb")
+      result = run_test(rsconsfile: "install_read_only.rb")
+      expect(result.stderr).to eq ""
+      expect(lines(result.stdout)).to eq ["Install dest"]
+    end
+
     it "operates the same as a Copy builder" do
       test_dir("build_dir")