gemika 0.3.4 → 0.6.1

data/gemika.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.description = s.summary
   s.license = 'MIT'
 
-  s.files         = `git ls-files`.split("\n").reject { |path| File.lstat(path).symlink? }
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").reject { |path| File.lstat(path).symlink? }
+  s.files         = `git ls-files`.split("\n").reject { |path| !File.exists?(path) || File.lstat(path).symlink? }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").reject { |path| !File.exists?(path) || File.lstat(path).symlink? }
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/lib/gemika/database.rb

@@ -14,7 +14,13 @@ module Gemika
 
     def initialize(options = {})
       yaml_config_folder = options.fetch(:config_folder, 'spec/support')
-      yaml_config_filename = Env.travis? ? 'database.travis.yml' : 'database.yml'
+      yaml_config_filename = if Env.travis?
+        'database.travis.yml'
+      elsif Env.github?
+        'database.github.yml'
+      else
+        'database.yml'
+      end
       yaml_config_path = File.join(yaml_config_folder, yaml_config_filename)
       if File.exists?(yaml_config_path)
         @yaml_config = YAML.load_file(yaml_config_path)
@@ -30,7 +36,7 @@ module Gemika
     #
     def connect
       unless @connected
-        ActiveRecord::Base.establish_connection(adapter_config)
+        ActiveRecord::Base.establish_connection(**adapter_config)
         @connected = true
       end
     end
@@ -102,7 +108,7 @@ module Gemika
       else
         raise UnknownAdapter, "Unknown database type. Either 'pg', 'mysql2', or 'sqlite3' gem should be in your current bundle."
       end
-      default_config.merge(user_config)
+      default_config.merge(user_config).symbolize_keys
     end
 
     private

data/lib/gemika/env.rb

@@ -35,7 +35,15 @@ module Gemika
       # process, regardless of what's in ENV temporarily
       @gemfile_changed = true
       @process_gemfile = ENV['BUNDLE_GEMFILE']
-      Bundler.with_clean_env do
+
+      # .with_clean_env is deprecated since Bundler ~> 2.
+      bundler_method = if Gemika::Env.gem?('bundler', '< 2')
+        :with_clean_env
+      else
+        :with_unbundled_env
+      end
+
+      Bundler.send(bundler_method) do
         ENV['BUNDLE_GEMFILE'] = path
         block.call(*args)
       end
@@ -87,6 +95,12 @@ module Gemika
       !!ENV['TRAVIS']
     end
 
+    ##
+    # Return whether this process is running within a Github Actions build.
+    def github?
+      ENV.key?('GITHUB_WORKFLOW')
+    end
+
     ##
     # Creates an hash that enumerates entries in order of insertion.
     #

data/lib/gemika/errors.rb

@@ -6,4 +6,6 @@ module Gemika
   class UnsupportedRuby < Error; end
   class MatrixFailed < Error; end
   class RSpecFailed < Error; end
+  class MissingMatrixDefinition < Error; end
+  class InvalidMatrixDefinition < Error; end
 end

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.rb

@@ -1,43 +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', {})
-          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.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
     #
@@ -125,6 +94,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.
     #
@@ -136,8 +124,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)

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/tasks.rb

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

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