chore: Migrate more rake tasks to toys (#980)

Author: dazuma

.github/workflows/ci-common.yml

@@ -17,18 +17,24 @@ jobs:
     strategy:
       matrix:
         include:
-          - os: ubuntu-latest
-            ruby: "2.6"
           - os: ubuntu-latest
             ruby: "2.7"
+            task: test
           - os: ubuntu-latest
             ruby: "3.0"
+            task: test
           - os: ubuntu-latest
             ruby: "3.1"
+            task: test
+          - os: ubuntu-latest
+            ruby: "3.2"
+            task: ci
           - os: macos-latest
-            ruby: "3.0"
+            ruby: "3.2"
+            task: test
           - os: windows-latest
-            ruby: "3.0"
+            ruby: "3.2"
+            task: test
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -38,11 +44,12 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: "${{ matrix.ruby }}"
-    - name: Install tools
+    - name: Install dependencies
       shell: bash
       run: |
-        cd gapic-common && gem install --no-document toys bundler && bundle install
-    - name: Test ${{ matrix.task }}
+        gem install --no-document toys bundler
+        cd gapic-common && bundle install
+    - name: Run ${{ matrix.task }}
       shell: bash
       run: |
-        cd gapic-common && bundle exec rake ci
+        cd gapic-common && toys ${{ matrix.task }}

.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "2.6"
+          ruby-version: "3.1"
       - name: Checkout repo
         uses: actions/checkout@v3
       - name: Checkout submodules
@@ -35,9 +35,8 @@ jobs:
           git submodule update --init --recursive
       - name: Install dependencies
         run: |
-          gem install bundler
-          bundle install --retry=3
-          bundle exec rake bundle_install
+          gem install --no-document toys bundler
+          toys bundle install
       - name: Run CI
         run: |
-          bundle exec rake ci
+          toys ci --generator-only

.toys/.toys.rb

@@ -21,10 +21,12 @@
   # with the current directory set to that directory, and also passing the
   # directory name to the block.
   #
-  def in_directories_with_bundles
+  def in_directories_with_bundles generator_only: false
+    non_generator_directories = ["gapic", "gapic-common"]
     Dir.chdir context_directory do
       Dir.glob "*/Gemfile" do |gemfile|
         dir = File.dirname gemfile
+        next if generator_only && non_generator_directories.include?(dir)
         Dir.chdir dir do
           yield dir
         end
@@ -89,13 +91,15 @@ def run
 tool "ci" do
   desc "Runs CI in all directories"
 
+  flag :generator_only
+
   include :exec
   include :terminal
   include "repo_info"
 
   def run
     failures = []
-    in_directories_with_bundles do |dirname|
+    in_directories_with_bundles generator_only: generator_only do |dirname|
       ["test", "rubocop"].each do |task_name|
         if tool_defined? task_name
           puts "Running #{task_name} in #{dirname}", :cyan, :bold
@@ -117,59 +121,34 @@ def run
 end
 
 tool "gen" do
-  desc "Runs the generator for all goldens"
+  desc "Regenerates output for goldens"
+
+  remaining_args :services
+  flag :generator, "--generator=GENERATOR"
 
   include :exec, e: true
   include :terminal
-  include "repo_info"
 
   def run
-    in_directories_with_bundles do |dirname|
-      next if dirname == "shared"
-      puts "Generating in #{dirname}", :cyan, :bold
-      exec ["bundle", "exec", "rake", "gen"]
-    end
-  end
-
-  ["garbage", "showcase"].each do |name|
-    tool name do
-      desc "Runs the generator for #{name}"
-
-      include :exec, e: true
-      static :name, name
-  
-      def run
-        Dir.chdir "#{context_directory}/gapic-generator" do
-          exec ["bundle", "exec", "rake", "gen:#{name}"]
-        end
-      end
+    Dir.chdir "#{context_directory}/shared" do
+      cmd = ["gen"] + services + verbosity_flags
+      cmd += ["--generator", generator] if generator
+      exec_separate_tool cmd
     end
   end
 end
 
 tool "bin" do
-  desc "Generates binary input for all goldens"
+  desc "Regenerates binary input for goldens"
+
+  remaining_args :services
 
   include :exec, e: true
+  include :terminal
 
   def run
     Dir.chdir "#{context_directory}/shared" do
-      exec ["bundle", "exec", "rake", "gen"]
-    end
-  end
-
-  ["garbage", "showcase"].each do |name|
-    tool name do
-      desc "Generates binary input for #{name}"
-
-      include :exec, e: true
-      static :name, name
-  
-      def run
-        Dir.chdir "#{context_directory}/shared" do
-          exec ["bundle", "exec", "rake", "gen:#{name}"]
-        end
-      end
+      exec_separate_tool ["bin"] + services + verbosity_flags
     end
   end
 end

gapic-common/.toys.rb

@@ -21,3 +21,24 @@
   t.files = ["test/**/*_test.rb"]
   t.bundler = true
 end
+
+expand :yardoc do |t|
+  t.generate_output_flag = true
+  t.fail_on_warning = true
+  t.fail_on_undocumented_objects = false # TODO: Fix so this can be enabled
+  t.bundler = true
+end
+
+tool "ci" do
+  include :exec, e: true
+  include :terminal
+
+  def run
+    puts "Running rubocop...", :bold
+    exec_tool ["rubocop"] + verbosity_flags
+    puts "Running tests...", :bold
+    exec_tool ["test"] + verbosity_flags
+    puts "Running yard...", :bold
+    exec_tool ["yardoc"] + verbosity_flags
+  end
+end

gapic-generator-ads/.toys.rb

@@ -21,3 +21,38 @@
   t.files = ["test/**/*_test.rb"]
   t.bundler = true
 end
+
+tool "gen" do
+  desc "Regenerates output for goldens"
+
+  remaining_args :services
+
+  include :exec, e: true
+  include :terminal
+  load File.join __dir__, "gem_defaults.rb"
+
+  def run
+    set :services, all_service_names(generator: :ads) if services.empty?
+    Dir.chdir "#{context_directory}/shared" do
+      cmd = ["gen"] + services + verbosity_flags
+      cmd += ["--generator", generator] if generator
+      exec_separate_tool cmd
+    end
+  end
+end
+
+tool "bin" do
+  desc "Regenerates binary input for goldens"
+
+  remaining_args :services
+
+  include :exec, e: true
+  include :terminal
+
+  def run
+    set :services, all_service_names(generator: :ads) if services.empty?
+    Dir.chdir "#{context_directory}/shared" do
+      exec_separate_tool ["bin"] + services + verbosity_flags
+    end
+  end
+end

gapic-generator-ads/Gemfile.lock

@@ -35,6 +35,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.2)
+    base64 (0.1.1)
     builder (3.2.4)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
@@ -50,11 +51,11 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     middleware (0.1.0)
-    mini_portile2 (2.8.2)
-    minitest (5.18.1)
-    minitest-focus (1.3.1)
+    mini_portile2 (2.8.4)
+    minitest (5.19.0)
+    minitest-focus (1.4.0)
       minitest (>= 4, < 6)
-    nokogiri (1.15.3)
+    nokogiri (1.15.4)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.23.0)
@@ -67,10 +68,10 @@ GEM
       thor
       thread_safe
     racc (1.7.1)
-    rack (2.2.7)
+    rack (2.2.8)
     rack-test (2.1.0)
       rack (>= 1.3)
-    rails-dom-testing (2.1.1)
+    rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
@@ -80,16 +81,17 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.1)
-    rexml (3.2.5)
-    rubocop (1.54.1)
+    rexml (3.2.6)
+    rubocop (1.56.2)
+      base64 (~> 0.1.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)

gapic-generator-cloud/.toys.rb

@@ -21,3 +21,38 @@
   t.files = ["test/**/*_test.rb"]
   t.bundler = true
 end
+
+tool "gen" do
+  desc "Regenerates output for goldens"
+
+  remaining_args :services
+
+  include :exec, e: true
+  include :terminal
+  load File.join __dir__, "gem_defaults.rb"
+
+  def run
+    set :services, all_service_names(generator: :cloud) if services.empty?
+    Dir.chdir "#{context_directory}/shared" do
+      cmd = ["gen"] + services + verbosity_flags
+      cmd += ["--generator", generator] if generator
+      exec_separate_tool cmd
+    end
+  end
+end
+
+tool "bin" do
+  desc "Regenerates binary input for goldens"
+
+  remaining_args :services
+
+  include :exec, e: true
+  include :terminal
+
+  def run
+    set :services, all_service_names(generator: :cloud) if services.empty?
+    Dir.chdir "#{context_directory}/shared" do
+      exec_separate_tool ["bin"] + services + verbosity_flags
+    end
+  end
+end

gapic-generator-cloud/Gemfile.lock

@@ -36,6 +36,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.2)
+    base64 (0.1.1)
     builder (3.2.4)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
@@ -53,16 +54,16 @@ GEM
       nokogiri (>= 1.12.0)
     method_source (1.0.0)
     middleware (0.1.0)
-    mini_portile2 (2.8.2)
-    minitest (5.18.1)
+    mini_portile2 (2.8.4)
+    minitest (5.19.0)
     minitest-autotest (1.1.1)
       minitest-server (~> 1.0)
       path_expander (~> 1.0)
-    minitest-focus (1.3.1)
+    minitest-focus (1.4.0)
       minitest (>= 4, < 6)
     minitest-server (1.0.7)
       minitest (~> 5.16)
-    nokogiri (1.15.3)
+    nokogiri (1.15.4)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.23.0)
@@ -79,10 +80,10 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     racc (1.7.1)
-    rack (2.2.7)
+    rack (2.2.8)
     rack-test (2.1.0)
       rack (>= 1.3)
-    rails-dom-testing (2.1.1)
+    rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
@@ -92,16 +93,17 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.1)
-    rexml (3.2.5)
-    rubocop (1.54.1)
+    rexml (3.2.6)
+    rubocop (1.56.2)
+      base64 (~> 0.1.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)