gemika 0.4.1 → 0.7.0

data/lib/gemika/github_actions_generator.rb

@@ -0,0 +1,150 @@
+module Gemika
+  class GithubActionsGenerator
+    TYPES = {
+      test_sqlite: {
+        gemfile_filter: /\.sqlite/,
+      },
+      test_pg: {
+        gemfile_filter: /\.pg/,
+        database_setup: [
+          'sudo apt-get install -y postgresql-client',
+          "PGPASSWORD=postgres psql -c 'create database test;' -U postgres -p 5432 -h localhost",
+        ],
+        services: {
+          'postgres' => {
+            'image' => 'postgres',
+            'env' => {
+              'POSTGRES_PASSWORD' => 'postgres'
+            },
+            'options' => '--health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5',
+            'ports' => ['5432:5432'],
+          },
+        },
+      },
+      test_mysql: {
+        gemfile_filter: /\.mysql/,
+        database_setup: [
+          'sudo apt-get install -y mysql-client libmariadbclient-dev',
+          "mysql -e 'create database IF NOT EXISTS test;' -u root --password=password -P 3306 -h 127.0.0.1",
+        ],
+        services: {
+          'mysql' => {
+            'image' => 'mysql:5.6',
+            'env' => {
+              'MYSQL_ROOT_PASSWORD' => 'password',
+            },
+            'options' => '--health-cmd "mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 5',
+            'ports' => ['3306:3306'],
+          },
+        },
+      },
+      test: {
+        gemfile_filter: //,
+      }
+    }
+
+    def initialize(bundler_version:)
+      @bundler_version = bundler_version
+    end
+
+    def generate(rows)
+      rows_by_type = split_rows_by_gemfile(rows)
+      jobs = {}
+      rows_by_type.each do |type, type_rows|
+        jobs[type.to_s] = job_by_type(type, type_rows)
+      end
+      full_config(jobs)
+    end
+
+    private
+
+    def split_rows_by_gemfile(rows)
+      rows.group_by do |row|
+        TYPES.detect do |type, type_definition|
+          row.gemfile =~ type_definition[:gemfile_filter]
+        end.first
+      end
+    end
+
+    def job_by_type(type, rows)
+      matrix = full_matrix(rows) || include_matrix(rows)
+      type_definition = TYPES[type]
+
+      steps = [{
+        'uses' => 'actions/checkout@v2',
+      }, {
+        'name' => 'Install ruby',
+        'uses' => 'ruby/setup-ruby@v1',
+        'with' => {'ruby-version' => '${{ matrix.ruby }}'},
+      }]
+
+      if (database_setup = type_definition[:database_setup])
+        steps << {
+          'name' => 'Setup database',
+          'run' => database_setup.join("\n") + "\n",
+        }
+      end
+
+      steps += [{
+        'name' => 'Bundle',
+        'run' => "gem install bundler:#{@bundler_version}\nbundle install --no-deployment\n",
+      }, {
+        'name' => 'Run tests',
+        'run' => 'bundle exec rspec',
+      }]
+
+      job = {}
+      job['runs-on'] = 'ubuntu-20.04'
+      if (services = type_definition[:services])
+        job['services'] = services
+      end
+      job['strategy'] = {
+        'fail-fast' => false,
+        'matrix' => matrix,
+      }
+      job['env'] = {
+        'BUNDLE_GEMFILE' => '${{ matrix.gemfile }}',
+      }
+      job['steps'] = steps
+
+      job
+    end
+
+    def full_matrix(rows)
+      rubies = rows.map(&:ruby)
+      gemfiles = rows.map(&:gemfile)
+      if rubies.size * gemfiles.size == rows.size
+        {
+          'ruby' => rubies,
+          'gemfile' => gemfiles,
+        }
+      end
+    end
+
+    def include_matrix(rows)
+      {
+        'include' => rows.map do |row|
+          {
+            'ruby' => row.ruby,
+            'gemfile' => row.gemfile,
+          }
+        end,
+      }
+    end
+
+    def full_config(jobs)
+      {
+        'name' => 'Tests',
+        'on' => {
+          'push' => {
+            'branches' => ['master'],
+          },
+          'pull_request' => {
+            'branches' => ['master'],
+          },
+        },
+        'jobs' => jobs,
+      }
+    end
+  end
+end

data/lib/gemika/matrix/github_actions_config.rb

@@ -0,0 +1,61 @@
+module Gemika
+  class Matrix
+
+    ##
+    # Load Github Action `.yml` files.
+    #
+    # @!visibility private
+    #
+    class GithubActionsConfig
+      class << self
+
+        def load_rows(options)
+          path = options.fetch(:path, '.github/workflows/test.yml')
+          workflow_yml = YAML.load_file(path)
+
+          matrices = workflow_yml.fetch('jobs', {}).values.map do |job|
+            job.fetch('strategy', {})['matrix']
+          end.reject(&:nil?)
+
+          matrices.map do |matrix|
+            matrix_to_rows(matrix)
+          end.flatten(1)
+        end
+
+        private
+
+        def matrix_to_rows(matrix)
+          if (!matrix['ruby'] || !matrix['gemfile']) && (!matrix['include'])
+            raise InvalidMatrixDefinition, 'matrix must use the keys "ruby" and "gemfile"'
+          end
+
+          rubies = matrix.fetch('ruby', [])
+          gemfiles = matrix.fetch('gemfile', [])
+
+          includes = matrix.fetch('include', [])
+          excludes = matrix.fetch('exclude', [])
+
+          rows = []
+          rubies.each do |ruby|
+            gemfiles.each do |gemfile|
+              row = { 'ruby' => ruby, 'gemfile' => gemfile }
+              rows << row unless excludes.include?(row)
+            end
+          end
+
+          rows = rows + includes
+          rows.map { |row| convert_row(row) }
+        end
+
+        def convert_row(row_hash)
+          if !row_hash['ruby'] || !row_hash['gemfile']
+            raise InvalidMatrixDefinition, 'matrix must use the keys "ruby" and "gemfile"'
+          end
+          Row.new(:ruby => row_hash['ruby'], :gemfile => row_hash['gemfile'])
+        end
+
+      end
+    end
+
+  end
+end

data/lib/gemika/matrix/travis_config.rb

@@ -0,0 +1,42 @@
+module Gemika
+  class Matrix
+
+    ##
+    # Load `.travis.yml` files.
+    #
+    # @!visibility private
+    #
+    class TravisConfig
+      class << self
+
+        def load_rows(options)
+          path = options.fetch(:path, '.travis.yml')
+          travis_yml = YAML.load_file(path)
+          rubies = travis_yml.fetch('rvm', [])
+          gemfiles = travis_yml.fetch('gemfile', [])
+          matrix_options = travis_yml.fetch('matrix', {})
+          includes = matrix_options.fetch('include', [])
+          excludes = matrix_options.fetch('exclude', [])
+
+          rows = []
+          rubies.each do |ruby|
+            gemfiles.each do |gemfile|
+              row = { 'rvm' => ruby, 'gemfile' => gemfile }
+              rows << row unless excludes.include?(row)
+            end
+          end
+
+          rows = rows + includes
+          rows = rows.map { |row| convert_row(row) }
+          rows
+        end
+
+        def convert_row(travis_row)
+          Row.new(:ruby => travis_row['rvm'], :gemfile => travis_row['gemfile'])
+        end
+
+      end
+    end
+
+  end
+end

data/lib/gemika/matrix.rb

@@ -1,47 +1,12 @@
 require 'yaml'
 require 'gemika/errors'
 require 'gemika/env'
+require 'gemika/matrix/travis_config'
+require 'gemika/matrix/github_actions_config'
 
 module Gemika
   class Matrix
 
-    ##
-    # Load `.travis.yml` files.
-    #
-    # @!visibility private
-    #
-    class TravisConfig
-      class << self
-
-        def load_rows(options)
-          path = options.fetch(:path, '.travis.yml')
-          travis_yml = YAML.load_file(path)
-          rubies = travis_yml.fetch('rvm', [])
-          gemfiles = travis_yml.fetch('gemfile', [])
-          matrix_options = travis_yml.fetch('matrix', {})
-          includes = matrix_options.fetch('include', [])
-          excludes = matrix_options.fetch('exclude', [])
-
-          rows = []
-          rubies.each do |ruby|
-            gemfiles.each do |gemfile|
-              row = { 'rvm' => ruby, 'gemfile' => gemfile }
-              rows << row unless excludes.include?(row)
-            end
-          end
-
-          rows = rows + includes
-          rows = rows.map { |row| convert_row(row) }
-          rows
-        end
-
-        def convert_row(travis_row)
-          Row.new(:ruby => travis_row['rvm'], :gemfile => travis_row['gemfile'])
-        end
-
-      end
-    end
-
     ##
     # A row in the test matrix
     #
@@ -57,6 +22,11 @@ module Gemika
       #
       attr_reader :ruby
 
+      ##
+      # The actually used Ruby version for the row.
+      #
+      attr_reader :used_ruby
+
       ##
       # The path to the gemfile for the row.
       #
@@ -66,7 +36,9 @@ module Gemika
       # Returns whether this row can be run with the given Ruby version.
       #
       def compatible_with_ruby?(current_ruby = Env.ruby)
-        ruby == current_ruby
+        @used_ruby = aliased_ruby(ruby)
+
+        @used_ruby == current_ruby
       end
 
       ##
@@ -80,6 +52,53 @@ module Gemika
         contents.include?('gemika') or raise UnusableGemfile, "Gemfile is missing gemika dependency: #{gemfile}"
       end
 
+      private
+
+      ##
+      # Checks if the requested ruby version is aliased by rbenv to use another ruby version.
+      # Returns the runnable ruby version.
+      #
+      def aliased_ruby(requested_version)
+        ruby_aliases = rbenv_aliases
+
+        aliased_versions = {}
+
+        ruby_aliases.split("\n").each do |ruby_alias|
+          split_pattern = /\A(.+) => (.+)\z/
+          alias_name, aliased_version = ruby_alias.match(split_pattern)&.captures
+          aliased_versions[alias_name] = aliased_version
+        end
+
+        find_aliased_ruby(requested_version, aliased_versions)
+      end
+
+      ##
+      # Recursively traverses aliases until the requested Ruby version is found.
+      # Returns the requested version if no alias can be found for that version.
+      #
+      def find_aliased_ruby(requested_version, aliased_versions)
+        found_version = aliased_versions[requested_version]
+
+        if found_version == requested_version
+          found_version
+        elsif found_version
+          find_aliased_ruby(found_version, aliased_versions)
+        else
+          requested_version
+        end
+      end
+
+      ##
+      # Returns the list of rbenv aliases, if rbenv is installed.
+      #
+      def rbenv_aliases
+        if `which rbenv` != ''
+          `rbenv alias --list`
+        else
+          ''
+        end
+      end
+
     end
 
     COLOR_HEAD = "\e[44;97m"
@@ -99,6 +118,7 @@ module Gemika
       @compatible_count = 0
       @all_passed = nil
       @current_ruby = options.fetch(:current_ruby, RUBY_VERSION)
+      @aliased_rubys = {}
     end
 
     ##
@@ -114,6 +134,9 @@ module Gemika
         gemfile = row.gemfile
         if row.compatible_with_ruby?(current_ruby)
           @compatible_count += 1
+
+          @aliased_rubys[current_ruby] = row.ruby
+
           print_title gemfile
           gemfile_passed = Env.with_gemfile(gemfile, row, &block)
           @all_passed &= gemfile_passed
@@ -129,6 +152,25 @@ module Gemika
       print_summary
     end
 
+
+    ##
+    # Builds a {Matrix} from a `.travis.yml` file, or falls back to a Github Action .yml file
+    #
+    # @param [Hash] options
+    # @option options [String] Path to the `.travis.yml` file.
+    #
+    def self.from_ci_config
+      travis_location = '.travis.yml'
+      workflow_location = '.github/workflows/test.yml'
+      if File.exists?(travis_location)
+        from_travis_yml(:path => travis_location)
+      elsif File.exists?(workflow_location)
+        from_github_actions_yml(:path => workflow_location)
+      else
+        raise MissingMatrixDefinition, "expected either a #{travis_location} or a #{workflow_location}"
+      end
+    end
+
     ##
     # Builds a {Matrix} from the given `.travis.yml` file.
     #
@@ -140,8 +182,25 @@ module Gemika
       new(options.merge(:rows => rows))
     end
 
+    ##
+    # Builds a {Matrix} from the given Github Action workflow definition
+    #
+    # @param [Hash] options
+    # @option options [String] Path to the `.yml` file.
+    #
+    def self.from_github_actions_yml(options = {})
+      rows = GithubActionsConfig.load_rows(options)
+      new(options.merge(:rows => rows))
+    end
+
     attr_reader :rows, :current_ruby
 
+    def self.generate_github_actions_workflow(options= {})
+      require 'gemika/github_actions_generator'
+      rows = TravisConfig.load_rows(options)
+      GithubActionsGenerator.new(bundler_version: Bundler::VERSION).generate(rows)
+    end
+
     private
 
     def puts(*args)
@@ -177,19 +236,27 @@ module Gemika
       puts
 
       if @compatible_count == 0
-        message = "No gemfiles were compatible with Ruby #{RUBY_VERSION}"
+        message = "No gemfiles were compatible with Ruby #{@aliased_rubys[RUBY_VERSION]}"
         puts tint(message, COLOR_FAILURE)
-        puts
         raise UnsupportedRuby, message
       elsif @all_passed
-        puts tint("All gemfiles succeeded for Ruby #{RUBY_VERSION}", COLOR_SUCCESS)
-        puts
+        puts tint("All gemfiles succeeded for Ruby #{@aliased_rubys[RUBY_VERSION]}", COLOR_SUCCESS)
       else
         message = 'Some gemfiles failed'
         puts tint(message, COLOR_FAILURE)
         puts
         raise MatrixFailed, message
       end
+
+      print_aliases
+
+      puts
+    end
+
+    def print_aliases
+      @aliased_rubys.select { |used_version, alias_name| used_version != alias_name }.each do |used_version, alias_name|
+        puts tint("Ruby #{alias_name} is an alias for Ruby #{used_version} in this environment.", COLOR_WARNING)
+      end
     end
 
   end

data/lib/gemika/tasks/gemika.rb

@@ -0,0 +1,14 @@
+require 'gemika/env'
+require 'gemika/matrix'
+
+##
+# Rake tasks to run commands for each compatible row in the test matrix.
+#
+namespace :gemika do
+
+  desc "Generate a github action workflow from a .travis.yml"
+  task :generate_github_actions_workflow do
+    puts Gemika::Matrix.generate_github_actions_workflow.to_yaml
+  end
+
+end

data/lib/gemika/tasks/matrix.rb

@@ -9,7 +9,7 @@ namespace :matrix do
 
   desc "Run specs for all Ruby #{RUBY_VERSION} gemfiles"
   task :spec, :files do |t, options|
-    Gemika::Matrix.from_travis_yml.each do |row|
+    Gemika::Matrix.from_ci_config.each do |row|
       options = options.to_hash.merge(
         :gemfile => row.gemfile,
         :fatal => false,
@@ -21,21 +21,21 @@ namespace :matrix do
 
   desc "Install all Ruby #{RUBY_VERSION} gemfiles"
   task :install do
-    Gemika::Matrix.from_travis_yml.each do |row|
+    Gemika::Matrix.from_ci_config.each do |row|
       system('bundle install')
     end
   end
 
   desc "List dependencies for all Ruby #{RUBY_VERSION} gemfiles"
   task :list do
-    Gemika::Matrix.from_travis_yml.each do |row|
+    Gemika::Matrix.from_ci_config.each do |row|
       system('bundle list')
     end
   end
 
   desc "Update all Ruby #{RUBY_VERSION} gemfiles"
   task :update, :gems do |t, options|
-    Gemika::Matrix.from_travis_yml.each do |row|
+    Gemika::Matrix.from_ci_config.each do |row|
       system("bundle update #{options[:gems]}")
     end
   end

data/lib/gemika/tasks.rb

@@ -1,2 +1,3 @@
 require 'gemika/tasks/matrix'
 require 'gemika/tasks/rspec'
+require 'gemika/tasks/gemika'

data/lib/gemika/version.rb

@@ -1,3 +1,3 @@
 module Gemika
-  VERSION = '0.4.1'
+  VERSION = '0.7.0'
 end

data/spec/fixtures/github_actions_yml/Gemfile_without_gemika

@@ -0,0 +1 @@
+gem 'some-gem'

data/spec/fixtures/github_actions_yml/excludes.yml

@@ -0,0 +1,13 @@
+jobs:
+  first_job:
+    strategy:
+      matrix:
+        ruby:
+          - "2.1.8"
+          - "2.3.1"
+        gemfile:
+          - gemfiles/Gemfile1
+          - gemfiles/Gemfile2
+        exclude:
+          - ruby: 2.1.8
+            gemfile: gemfiles/Gemfile1

data/spec/fixtures/github_actions_yml/gemfile_without_gemika.yml

@@ -0,0 +1,8 @@
+jobs:
+  first_job:
+    strategy:
+      matrix:
+        ruby:
+          - 2.1.8
+        gemfile:
+          - spec/fixtures/travis_yml/Gemfile_without_gemika

data/spec/fixtures/github_actions_yml/includes.yml

@@ -0,0 +1,20 @@
+matrix:
+jobs:
+  first_job:
+    strategy:
+      matrix:
+        ruby:
+          - "2.1.8"
+          - "2.3.1"
+        gemfile:
+          - gemfiles/Gemfile1
+          - gemfiles/Gemfile2
+        include:
+          - ruby: 2.6.3
+            gemfile: gemfiles/Gemfile3
+  second_job:
+    strategy:
+      matrix:
+        include:
+          - ruby: 2.7.1
+            gemfile: gemfiles/Gemfile3

data/spec/fixtures/github_actions_yml/invalid.yml

@@ -0,0 +1,8 @@
+jobs:
+  first_job:
+    strategy:
+      matrix:
+        ruby_version:
+          - "2.1.8"
+        gemfile:
+          - gemfiles/Gemfile1

data/spec/fixtures/github_actions_yml/missing_gemfile.yml

@@ -0,0 +1,8 @@
+jobs:
+  first_job:
+    strategy:
+      matrix:
+        ruby:
+          - 2.1.8
+        gemfile:
+          - gemfiles/nonexisting_gemfile

data/spec/fixtures/github_actions_yml/multiple_jobs.yml

@@ -0,0 +1,16 @@
+jobs:
+  first_job:
+    strategy:
+      matrix:
+        ruby:
+          - "2.1.8"
+        gemfile:
+          - gemfiles/Gemfile1
+
+  second_job:
+    strategy:
+      matrix:
+        ruby:
+          - "2.3.1"
+        gemfile:
+          - gemfiles/Gemfile2

data/spec/fixtures/github_actions_yml/two_by_two.yml

@@ -0,0 +1,10 @@
+jobs:
+  first_job:
+    strategy:
+      matrix:
+        ruby:
+          - "2.1.8"
+          - "2.3.1"
+        gemfile:
+          - gemfiles/Gemfile1
+          - gemfiles/Gemfile2