WIP - parallel tests

Fix up some macOS test cases

.github/workflows/run-tests.yml

@@ -0,0 +1,38 @@
+name: Run RScons Tests
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby-version: ['2.7', '3.0', '3.4']
+    
+    steps:
+    - name: Install dependencies (Linux)
+      if: runner.os == 'Linux'
+      run: sudo apt-get update && sudo apt-get install -y gcc gdc ldc clang flex bison
+
+    - name: Install dependencies (macOS)
+      if: runner.os == 'macOS'
+      run: brew install gcc ldc flex bison
+
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Run tests
+      run: rake all

.gitignore

@@ -7,5 +7,5 @@
 /gen/
 /large_project/
 /pkg/
-/test/
+/test_run/
 /yard/

CHANGELOG.md

@@ -1,3 +1,12 @@
+## v3.3.0
+
+### New Features
+
+- Add support for Ruby 3.4.
+- Fix up some macOS test cases.
+- #177 - Remove dependency on base64
+- #175 - Add support for building object files from LLVM assembly sources
+
 ## v3.2.0
 
 ### New Features

Gemfile

@@ -4,6 +4,7 @@ gem "base64"
 gem "rspec"
 gem "rake"
 gem "simplecov", "~> 0.15.0"
+gem "openssl"
 if RbConfig::CONFIG["host"]["msys"]
   gem "json", "2.1.0"
 else

Gemfile.lock

@@ -1,39 +1,44 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    base64 (0.2.0)
-    date (3.4.1)
-    diff-lcs (1.6.0)
+    base64 (0.3.0)
+    date (3.5.1)
+    diff-lcs (1.6.2)
     docile (1.1.5)
-    json (2.10.2)
-    psych (5.2.3)
+    erb (6.0.1)
+    json (2.18.0)
+    openssl (4.0.0)
+    psych (5.3.1)
       date
       stringio
-    rake (13.2.1)
-    rdoc (6.13.0)
+    rake (13.3.1)
+    rdoc (7.1.0)
+      erb
       psych (>= 4.0.0)
+      tsort
     redcarpet (3.6.1)
-    rspec (3.13.0)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
+    rspec-support (3.13.6)
     simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    stringio (3.1.5)
+    stringio (3.2.0)
     syntax (1.2.2)
-    yard (0.9.37)
+    tsort (0.2.0)
+    yard (0.9.38)
 
 PLATFORMS
   ruby
@@ -42,6 +47,7 @@ PLATFORMS
 DEPENDENCIES
   base64
   json
+  openssl
   rake
   rdoc
   redcarpet
@@ -51,4 +57,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.4.17
+   2.6.2

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2022 Josh Holtrop
+Copyright (c) 2013-2025 Josh Holtrop
 
 MIT License
 

Rakefile.rb

@@ -9,7 +9,7 @@ require "rspec/core/rake_task"
 require "rake/clean"
 require "fileutils"
 
-CLEAN.include %w[build_test_run .yardoc yard coverage test]
+CLEAN.include %w[build_test_run .yardoc yard coverage test_run]
 CLOBBER.include %w[dist gen large_project pkg]
 
 task :build_dist do
@@ -32,11 +32,12 @@ end
 # useful for coverage information.
 desc "Dist Specs"
 task :dspec, [:example_string] => :build_dist do |task, args|
-  FileUtils.mkdir_p("test")
-  FileUtils.cp("dist/rscons", "test/rscons.rb")
-  ENV["dist_specs"] = "1"
+  FileUtils.rm_rf("test_run")
+  FileUtils.mkdir_p("test_run")
+  FileUtils.cp("dist/rscons", "test_run/rscons.rb")
+  ENV["rscons_dist_specs"] = "1"
   Rake::Task["spec"].execute(args)
-  ENV.delete("dist_specs")
+  ENV.delete("rscons_dist_specs")
   FileUtils.rm_f(Dir.glob(".rscons-*"))
 end
 

build_tests/two_sources/assuffix.rb

@@ -3,5 +3,5 @@ env do |env|
   env["CFLAGS"] += %w[-S]
   env.Object("one.ssss", "one.c", "CPPFLAGS" => ["-DONE"])
   env.Object("two.sss", "two.c")
-  env.Program("two_sources.exe", %w[one.ssss two.sss], "ASFLAGS" => env["ASFLAGS"] + %w[-x assembler])
+  env.Program("two_sources.exe", %w[one.ssss two.sss], "ASFLAGS" => env["ASFLAGS"] + %w[-x assembler-with-cpp])
 end

build_tests/typical/phonies.rb

@@ -0,0 +1,15 @@
+class Custom < Rscons::Builder
+  def run(options)
+    print_run_message("#{name} #{target}", nil)
+    true
+  end
+end
+
+env do |env|
+  env.add_builder(Custom)
+  env.Custom("t3", :phony1)
+  env.Custom(:phony1, "t2")
+  env.Custom("t2", :phony2)
+  env.Custom(:phony2, "t1")
+  env.Custom("t1", [])
+end

lib/rscons.rb

@@ -23,6 +23,7 @@ module Rscons
   # Names of the default builders which will be added to all newly created
   # {Environment} objects.
   DEFAULT_BUILDERS = [
+    :Barrier,
     :Command,
     :Copy,
     :Directory,
@@ -66,6 +67,13 @@ module Rscons
       target.is_a?(Symbol)
     end
 
+    # Generate a random phony target name.
+    #
+    # @return [Symbol] Phony target name.
+    def gen_phony_target
+      ("t" + sprintf("%08x", rand(1_000_000..4_000_000_000))).to_sym
+    end
+
     # Return the system shell and arguments for executing a shell command.
     #
     # @return [Array<String>] The shell and flag.
@@ -136,6 +144,7 @@ require_relative "rscons/builders/mixins/object_deps"
 require_relative "rscons/builders/mixins/program"
 
 # default builders
+require_relative "rscons/builders/barrier"
 require_relative "rscons/builders/command"
 require_relative "rscons/builders/copy"
 require_relative "rscons/builders/directory"

lib/rscons/builder_set.rb

@@ -37,7 +37,7 @@ module Rscons
     #   The number of remaining build steps.
     def build_steps_remaining
       self.reduce(0) do |result, (target, builders)|
-        result + builders.size
+        result + builders.count {|b| !b.is_a?(Rscons::Builders::Barrier)}
       end
     end
 

lib/rscons/builders/barrier.rb

@@ -0,0 +1,15 @@
+module Rscons
+  module Builders
+    # The Barrier builder does not perform any action. It exists as a builder
+    # on which to place dependencies to ensure that each of its sources are
+    # built before any build targets which depend on the barrier build target.
+    class Barrier < Builder
+
+      # Run the builder.
+      def run(options)
+        true
+      end
+
+    end
+  end
+end

lib/rscons/environment.rb

@@ -397,7 +397,11 @@ module Rscons
         expand(ud)
       end
       @user_deps[target] ||= []
-      @user_deps[target] = (@user_deps[target] + user_deps).uniq
+      (@user_deps[target] + user_deps).each do |ud|
+        unless Rscons.phony_target?(ud) || @user_deps[target].include?(ud)
+          @user_deps[target] << ud
+        end
+      end
       build_after(target, user_deps)
     end
 
@@ -623,7 +627,9 @@ module Rscons
     #
     # @return [void]
     def run_builder(builder)
-      builder.build_step ||= get_next_build_step
+      unless builder.is_a?(Rscons::Builders::Barrier)
+        builder.build_step ||= get_next_build_step
+      end
       case result = builder.run({})
       when Array
         result.each do |waititem|
@@ -649,8 +655,10 @@ module Rscons
           Cache.instance.register_build(side_effect, nil, [], self, side_effect: true)
           @side_effects.delete(side_effect)
         end
-        @build_hooks[:post].each do |build_hook_block|
-          build_hook_block.call(builder)
+        unless builder.is_a?(Rscons::Builders::Barrier)
+          @build_hooks[:post].each do |build_hook_block|
+            build_hook_block.call(builder)
+          end
         end
         process_remove_wait(builder)
       else
@@ -727,8 +735,10 @@ module Rscons
       if @builder_sets.size > 0
         if builder = @builder_sets[0].get_next_builder_to_run(targets_still_building)
           builder.vars = @varset.merge(builder.vars)
-          @build_hooks[:pre].each do |build_hook_block|
-            build_hook_block.call(builder)
+          unless builder.is_a?(Rscons::Builders::Barrier)
+            @build_hooks[:pre].each do |build_hook_block|
+              build_hook_block.call(builder)
+            end
           end
           return run_builder(builder)
         end

lib/rscons/version.rb

@@ -1,4 +1,4 @@
 module Rscons
   # Project version.
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

rb/build_dist.rb

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
 
-require "fileutils"
+require "base64"
 require "digest/md5"
+require "fileutils"
+require "stringio"
+require "zlib"
 
 if File.read("lib/rscons/version.rb") =~ /VERSION = "(.+)"/
   VERSION = $1
@@ -68,11 +71,15 @@ license = File.read("LICENSE.txt").gsub(/^(.*?)$/) do |line|
   end
 end
 
-require "zlib"
-require "base64"
 compressed_script = Zlib::Deflate.deflate(stripped.join)
+hash = Digest::MD5.hexdigest(compressed_script)
 encoded_compressed_script = Base64.encode64(compressed_script).gsub("\n", "")
-hash = Digest::MD5.hexdigest(encoded_compressed_script)
+encoded_compressed_script_io = StringIO.new(encoded_compressed_script)
+commented_encoded_compressed_script = ""
+until encoded_compressed_script_io.eof?
+  line = encoded_compressed_script_io.read(64)
+  commented_encoded_compressed_script += "##{line}\n"
+end
 
 FileUtils.rm_rf(DIST)
 FileUtils.mkdir_p(DIST)
@@ -82,25 +89,53 @@ File.open("#{DIST}/#{PROG_NAME}", "wb", 0755) do |fh|
 
 #{license}
 
+BASE64CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
+
+def base64_decode(s)
+  out = ""
+  v = 0
+  bits = 0
+  s.each_char do |c|
+    if cv = BASE64CHARS.index(c)
+      v = (v << 6) | cv
+      bits += 6
+    elsif c == "="
+      break
+    end
+    if bits >= 8
+      out += (v >> (bits - 8)).chr
+      v &= 0xFFFFFFFF >> (32 - (bits - 8))
+      bits -= 8
+    end
+  end
+  out
+end
+
 script = File.join(File.dirname(__FILE__), ".rscons-#{VERSION}-#{hash}.rb")
 unless File.exist?(script)
-  if File.read(__FILE__, mode: "rb") =~ /^#==>(.*)/
+  if File.read(__FILE__, mode: "rb") =~ /^#==>(.*)/m
     require "zlib"
-    require "base64"
     encoded_compressed = $1
-    unescaped_compressed = Base64.decode64(encoded_compressed)
-    inflated = Zlib::Inflate.inflate(unescaped_compressed)
+    compressed = base64_decode(encoded_compressed)
+    if ENV["rscons_dist_specs"]
+      require "digest/md5"
+      if Digest::MD5.hexdigest(compressed) != "#{hash}"
+        raise "Hash mismatch when decompressing rscons executable"
+      end
+    end
+    inflated = Zlib::Inflate.inflate(compressed)
     File.open(script, "wb") do |fh|
       fh.write(inflated)
     end
   else
-    raise "Could not decompress."
+    raise "Error expanding rscons executable"
   end
 end
 load script
 if __FILE__ == $0
   Rscons::Cli.new.run(ARGV)
 end
-#==>#{encoded_compressed_script}
+#==>
+#{commented_encoded_compressed_script}
 EOF
 end

spec/spec_helper.rb

@@ -1,4 +1,4 @@
-if ENV["dist_specs"]
+if ENV["rscons_dist_specs"]
   require_relative "../test/rscons"
 else
   require "simplecov"
@@ -11,12 +11,7 @@ else
     else
       command_name "RSpec"
     end
-    if ENV["dist_specs"]
-      add_filter "/bin/"
-      add_filter "/lib/"
-    else
-      add_filter "test/rscons.rb"
-    end
+    add_filter "test/rscons.rb"
     project_name "Rscons"
     merge_timeout 3600
   end