Merge pull request #183 from AaronC81/seed-failures

Run examples on GitHub Actions

Author: AaronC81

.github/workflows/examples.yml

@@ -0,0 +1,22 @@
+name: Run Sord on examples
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4 # Use latest for best chance of dependencies resolving
+    - name: Install dependencies
+      run: bundle install
+    - name: Install example dependencies
+      run: sudo apt-get install libldap2-dev libidn11-dev # Dependencies for `addressable`
+    - name: Run examples (RBI)
+      run: bundle exec rake examples:seed[rbi]
+    - name: Run examples (RBS)
+      run: bundle exec rake examples:seed[rbs]

.github/workflows/ruby.yml

@@ -6,7 +6,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [3.0, 3.1]
+        ruby: [3.0, 3.1, 3.2, 3.3, 3.4]
     continue-on-error: false
 
     runs-on: ubuntu-latest

Rakefile

@@ -19,85 +19,138 @@ REPOS = {
   zeitwerk: 'https://github.com/fxn/zeitwerk'
 }
 
-namespace :examples do
-  require 'fileutils'
-  require 'rainbow'
+# Thrown by tasks to present a "friendly" error message and abort the task.
+class TaskError < StandardError
+end
 
-  desc "Clone git repositories and run Sord on them as examples"
-  task :seed, [:mode, :clean] do |t, args|
-    if File.directory?('sord_examples')
-      puts Rainbow('sord_examples directory already exists, please delete the directory or run a reseed!').red
-      exit
-    end
+# Handles Sord examples, including checkout and running Sord to generate types.
+class ExampleRunner
+  attr_reader :mode, :mode_arg, :clean
+  alias clean? clean
+
+  # @return [<Symbol>] Names of gems where Sord failed.
+  attr_accessor :failed_examples
 
-    if args[:mode] == 'rbi'
-      mode_arg = '--rbi'
-    elsif args[:mode] == 'rbs'
-      mode_arg = '--rbs'
+  # @param [String] mode "rbi" or "rbs".
+  # @param [Boolean] clean Run Sord with additional options to generate minimal type output.
+  def initialize(mode:, clean: false)
+    @mode = mode
+    @clean = clean
+
+    if mode == 'rbi'
+      @mode_arg = '--rbi'
+    elsif mode == 'rbs'
+      @mode_arg = '--rbs'
     else
-      puts Rainbow('please specify \'rbi\' or \'rbs\'!').red
-      exit
+      raise TaskError, 'please specify \'rbi\' or \'rbs\'!'
+    end
+
+    @failed_examples = []
+  end
+
+  # Create the `sord_examples` directory, ready for checkouts.
+  # @raise [TaskError] If it already exists.
+  def create_examples_dir
+    if File.directory?(File.join(__dir__, 'sord_examples'))
+      raise TaskError, 'sord_examples directory already exists, please delete the directory or run a reseed!'
     end
 
     FileUtils.mkdir 'sord_examples'
-    FileUtils.cd 'sord_examples'
-    
-    Bundler.with_clean_env do
-      # Shallow clone each of the repositories, then bundle install and run sord.
-      REPOS.each do |name, url|
-        puts "Cloning #{name}..."
-        system("git clone #{url} --depth=1")
-        FileUtils.cd name.to_s
+  end
+
+  # Check that the `sord_examples` directory exists.
+  # @raise [TaskError] If it doesn't.
+  def validate_examples_dir
+    unless File.directory?(File.join(__dir__, 'sord_examples'))
+      raise TaskError, 'The sord_examples directory does not exist. Have you run the seed task?'
+    end
+  end
+
+  # Check out a repository, add Sord to its Gemfile, and install its dependencies.
+  # @param [Symbol] name Name of the checkout.
+  # @param [String] url Git URL.
+  def prepare_checkout(name, url)
+    Dir.chdir(File.join(__dir__, 'sord_examples')) do
+      puts "Cloning #{name}..."
+      system("git clone #{url} --depth=1")
+
+      Dir.chdir(name.to_s) do
         # Add sord to gemfile.
         `echo "gem 'sord', path: '../../'" >> Gemfile`
+
         # Run bundle install.
         system('bundle install')
-        # Generate sri
-        puts "Generating rbi for #{name}..."
-        if args[:clean]
-          system("bundle exec sord ../#{name}.#{args[:mode]} #{mode_arg} --no-sord-comments --replace-errors-with-untyped --replace-unresolved-with-untyped")
-        else
-          system("bundle exec sord ../#{name}.#{args[:mode]} #{mode_arg}")
-        end
-        puts "#{name}.#{args[:mode]} generated!"
-        FileUtils.cd '..'
       end
     end
+  end
 
-    puts Rainbow("Seeding complete!").green
+  # Run Sord on a checked-out repository.
+  # @param [Symbol] name Name of the checkout.
+  def generate_types(name)
+    puts "Generating rbi for #{name}..."
+
+    Dir.chdir(File.join(__dir__, 'sord_examples', name.to_s)) do
+      if clean?
+        system("bundle exec sord ../#{name}.#{mode} #{mode_arg} --no-sord-comments --replace-errors-with-untyped --replace-unresolved-with-untyped")
+      else
+        system("bundle exec sord ../#{name}.#{mode} #{mode_arg}")
+      end
+
+      if $?.success?
+        puts "#{name}.#{mode} generated!"
+      else
+        puts "Sord exited with error"
+        failed_examples << name
+      end
+    end
   end
 
-  desc 'Regenerate the rbi files in sord_examples.'
-  task :reseed, [:mode, :clean] do |t, args|
-    if Dir.exist?('sord_examples')
-      FileUtils.cd 'sord_examples'
-    else
-      raise Rainbow("The sord_examples directory does not exist. Have you run the seed task?").red.bold
+  # Check that all Sord executions were successful.
+  # @raise [TaskError] If any failed.
+  def validate_sord_success
+    if failed_examples.any?
+      raise TaskError, "Not all Sord runs were successful: #{failed_examples.map(&:to_s).join(', ')}"
     end
+  end
+end
 
-    if args[:mode] == 'rbi'
-      mode_arg = '--rbi'
-    elsif args[:mode] == 'rbs'
-      mode_arg = '--rbs'
-    else
-      puts Rainbow('please specify \'rbi\' or \'rbs\'!').red
-      exit
+namespace :examples do
+  require 'fileutils'
+  require 'rainbow'
+
+  desc "Clone git repositories and run Sord on them as examples"
+  task :seed, [:mode, :clean] do |t, args|
+    examples = ExampleRunner.new(**args)
+    examples.create_examples_dir
+
+    Bundler.with_clean_env do
+      REPOS.each do |name, url|
+        examples.prepare_checkout(name, url)
+        examples.generate_types(name)
+      end
     end
+    examples.validate_sord_success
+
+    puts Rainbow("Seeding complete!").green
+
+  rescue TaskError => e
+    abort Rainbow(e.to_s).red
+  end
+
+  desc 'Regenerate the rbi files in sord_examples.'
+  task :reseed, [:mode, :clean] do |t, args|
+    examples = ExampleRunner.new(**args)
+    examples.validate_examples_dir
 
     REPOS.keys.each do |name|
-      FileUtils.cd name.to_s
-      puts "Regenerating rbi file for #{name}..."
-      Bundler.with_clean_env do
-        if args[:clean]
-          system("bundle exec sord ../#{name}.#{args[:mode]} #{mode_arg} --no-regenerate --no-sord-comments --replace-errors-with-untyped --replace-unresolved-with-untyped")
-        else
-          system("bundle exec sord ../#{name}.#{args[:mode]} #{mode_arg} --no-regenerate")
-        end
-      end
-      FileUtils.cd '..'
+      examples.generate_types(name)
     end
+    examples.validate_sord_success
 
     puts Rainbow("Re-seeding complete!").green
+
+  rescue TaskError => e
+    abort Rainbow(e.to_s).red
   end
 
   desc 'Delete the sord_examples directory to allow the seeder to run again.'

lib/sord/generator.rb

@@ -681,10 +681,8 @@ def run
         end
       end
     rescue
-      Logging.error($!)
-      $@.each do |line|
-        puts "         #{line}"
-      end
+      Logging.error("An internal error occurred while running Sord: #{$!}")
+      raise
     end
 
     # Given two pairs of arrays representing method parameters, in the form