matrixeval-ruby 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c1fa003fd849f1a5baf6c9393c5210e030e52a14c044308f6732b602c196027
-  data.tar.gz: 652ab5ecd63138e426a002aae768c7bd61214785ef8a8eaa698cffa2eddda1ae
+  metadata.gz: 526b698efa76d623a97a48ec4f9ed2d365ed9c05f2d6ea8230d7778997173dd9
+  data.tar.gz: fcb6eb6971632aaf115e00390c7b0230e903e4ef57421e9e0d3a192535b645b8
 SHA512:
-  metadata.gz: fc85db98392512e7683fbfa96c54e4f34ff2f5c248ab07ceac57bd18a6781cdfac45325b874c1580c068b5a1f56a8653bc0d943baea6fcd391e3baf521038dd4
-  data.tar.gz: af503dd911a0522975061dfb37696470adedafc4a6868019480e89cfd51c686bb5aa4f5d848683dfe9b52ba94be0d34cb7fbb7478a262c6fe62f8964f0c5c6a1
+  metadata.gz: fc21ef4da660bddffb12d523559c7609b6d8b232c2b38409184c9e67260b37d5acf23a0d2456afe977076f09ccf436b0b138502caf3b3db90b4d330a0050d2dd
+  data.tar.gz: 35085fc143ce553458ebbab452aec1a062f1faed2915098c6d9753115ca906cd19d2f335bbf5def2310f18bddd380bf43351ad23f00191d3401035892580ba0f

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.3.0] - 2022-02-21
+
+- Support add extra docker compose services and volumes
+- Isolate each job with docker compose project name and network
+
 ## [0.2.2] - 2022-02-11
 
 - Auto remove containers

data/README.md

@@ -1,6 +1,15 @@
 # matrixeval-ruby
 
 Test your ruby code against multiple versions of dependencies like Ruby, Rails, Env ...
+
+![](https://raw.githubusercontent.com/MatrixEval/assets/main/screenshots/summary.png)
+
+## Features
+
+- Parallel test your ruby code against multiple versions of dependencies combinations.
+- Test your ruby code against a specific dependencies combination.
+- Choose any docker image you like for each job.
+- Easy to use CLI to speed up your development efficiency
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -36,6 +45,82 @@ matrixeval bash
 ```
 Run `matrixeval --help` for more details
 
+![](https://raw.githubusercontent.com/MatrixEval/assets/main/screenshots/help.png)
+
+### Configuration Example
+
+Here is the configuration file `matrixeval.yml` which will auto created by `matrixeval init`
+
+```yaml
+version: 0.3
+project_name: REPLACE_ME
+target: ruby
+parallel_workers: number_of_processors
+# commands:
+#   - ps
+#   - top
+#   - an_additional_command
+# mounts:
+#   - /a/path/need/to/mount:/a/path/mount/to
+matrix:
+  ruby:
+    variants:
+      - key: 2.7
+        container:
+          image: ruby:2.7.1
+      - key: 3.0
+        default: true
+        container:
+          image: ruby:3.0.0
+      - key: 3.1
+        container:
+          image: ruby:3.1.0
+      # - key: jruby-9.3
+      #   container:
+      #     image: jruby:9.3
+      #   env:
+      #       PATH: "/opt/jruby/bin:/app/bin:/bundle/bin:$PATH"
+      #   mounts:
+      #     - /a/path/need/to/mount:/a/path/mount/to
+
+  # rails:
+  #   variants:
+  #     - key: 6.1
+  #       default: true
+  #       env:
+  #         RAILS_VERSION: "~> 6.1.0"
+  #     - key: 7.0
+  #       env:
+  #         RAILS_VERSION: "~> 7.0.0"
+  # another:
+  #   variants:
+  #     - key: key1
+  #       default: true
+  #       env:
+  #         ENV_KEY: 1
+  #     - key: key2
+  #       env:
+  #         ENV_KEY: 2
+
+exclude:
+  # - ruby: 3.0
+  #   rails: 4.2
+  # - ruby: jruby-9.3
+  #   rails: 7.0
+```
+
+### Gemfile configuration example
+
+Here is an example from [ruby-trello](https://github.com/jeremytregunna/ruby-trello)
+
+```ruby
+if active_model_version = ENV['ACTIVE_MODEL_VERSION']
+  gem 'activemodel', active_model_version
+end
+```
+
+You can also check its corresponding [`matrixeval.yml`](https://github.com/jeremytregunna/ruby-trello/blob/master/matrixeval.yml)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/matrixeval/ruby/command_line.rb

@@ -2,7 +2,11 @@ require_relative "./command_line/parse_context_arguments"
 
 module Matrixeval
   module Ruby
-    COMMANDS = ['rake', 'rspec', 'bundle', 'bash']
+    COMMANDS = [
+      'ruby', 'rake', 'rails', 'rspec', 'bundle',
+      'bin/rake', 'bin/rails', 'bin/rspec', 'bin/test',
+      'bash', 'dash', 'sh', 'zsh'
+    ]
 
     class CommandLine
 

data/lib/matrixeval/ruby/config.rb

@@ -1,6 +1,8 @@
 require 'yaml'
 require_relative "./vector"
 require_relative "./config/yaml"
+require_relative "./docker_compose/extend_raw"
+require_relative "./docker_compose/extend"
 
 module Matrixeval
   module Ruby
@@ -15,6 +17,16 @@ module Matrixeval
           YAML["target"]
         end
 
+        def project_name
+          name = YAML["project_name"]
+
+          if name.nil? || name.strip.empty?
+            raise Error.new('missing project_name')
+          end
+
+          name
+        end
+
         def vectors
           @vectors = YAML["matrix"].map do |key, vector_config|
             Vector.new(key, vector_config)
@@ -54,6 +66,32 @@ module Matrixeval
           COMMANDS + cmds
         end
 
+        def docker_compose_extend_raw
+          DockerCompose::ExtendRaw.new(
+            YAML["docker-compose-extend"] || {}
+          )
+        end
+
+        def env
+          YAML["env"] || {}
+        end
+
+        def mounts
+          YAML["mounts"] || []
+        end
+
+        def all_mounts
+          mounts + all_variant_mounts
+        end
+
+        private
+
+        def all_variant_mounts
+          Config.vectors
+                .map(&:variants).flatten
+                .map(&:mounts).flatten
+        end
+
       end
     end
   end

data/lib/matrixeval/ruby/context/build_docker_compose_extend.rb

@@ -0,0 +1,43 @@
+require 'erb'
+require 'json'
+
+module Matrixeval
+  module Ruby
+    class Context
+      class BuildDockerComposeExtend
+        class << self
+          def call(context)
+            new(context).call
+          end
+        end
+
+        attr_reader :context
+
+        def initialize(context)
+          @context = context
+        end
+
+        def matrix_combination_id
+          context.id
+        end
+
+        def call
+          DockerCompose::Extend.new(docker_compose_extend)
+        end
+
+        private
+
+        def docker_compose_extend
+          JSON.parse(render_erb)
+        end
+
+        def render_erb
+          ERB.new(
+            Config.docker_compose_extend_raw.content
+          ).result(binding)
+        end
+
+      end
+    end
+  end
+end

data/lib/matrixeval/ruby/context.rb

@@ -1,4 +1,5 @@
 require_relative "./context/find_by_command_options"
+require_relative "./context/build_docker_compose_extend"
 
 module Matrixeval
   module Ruby
@@ -52,7 +53,11 @@ module Matrixeval
       end
 
       def gemfile_lock_path
-        Matrixeval.working_dir.join(".matrixeval/Gemfile.lock.#{id}")
+        Matrixeval.working_dir.join(".matrixeval/gemfile_locks/#{id}")
+      end
+
+      def docker_compose_file_path
+        Matrixeval.working_dir.join(".matrixeval/docker-compose/#{id}.yml")
       end
 
       def variants
@@ -72,6 +77,10 @@ module Matrixeval
         end
       end
 
+      def docker_compose_extend
+        BuildDockerComposeExtend.call(self)
+      end
+
     end
   end
 end

data/lib/matrixeval/ruby/docker_compose/extend.rb

@@ -0,0 +1,21 @@
+module Matrixeval
+  module Ruby
+    class DockerCompose
+      class Extend
+
+        def initialize(config)
+          @config = config || {}
+        end
+
+        def volumes
+          @config["volumes"] || {}
+        end
+
+        def services
+          @config["services"] || {}
+        end
+
+      end
+    end
+  end
+end

data/lib/matrixeval/ruby/docker_compose/extend_raw.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module Matrixeval
+  module Ruby
+    class DockerCompose
+      class ExtendRaw
+
+        def initialize(config)
+          @config = config || {}
+        end
+
+        def content
+          @config.to_json
+        end
+
+      end
+    end
+  end
+end

data/lib/matrixeval/ruby/docker_compose/file.rb

@@ -0,0 +1,135 @@
+require "erb"
+
+module Matrixeval
+  module Ruby
+    class DockerCompose
+      class File
+        class << self
+
+          def create_all
+            FileUtils.mkdir_p folder
+
+            Context.all.each do |context|
+              new(context).create
+            end
+          end
+
+          private
+
+          def folder
+            Matrixeval.working_dir.join(".matrixeval/docker-compose")
+          end
+        end
+
+        attr_reader :context
+
+        def initialize(context)
+          @context = context
+        end
+
+        def create
+          ::File.open(docker_compose_file_path, 'w+') do |file|
+            file.puts build_content
+          end
+        end
+
+        private
+
+        def docker_compose_file_path
+          context.docker_compose_file_path
+        end
+
+        def build_content
+          {
+            "version" => "3",
+            "services" => services_json,
+            "volumes" => volumes_json
+          }.to_yaml.sub(/---\n/, "")
+        end
+
+        def services_json
+          services = {}
+
+          services[main_variant.docker_compose_service_name] = {
+            "image" => main_variant.container.image,
+            "volumes" => mounts(main_variant),
+            "environment" => {
+              "BUNDLE_PATH" => "/bundle",
+              "GEM_HOME" => "/bundle",
+              "BUNDLE_APP_CONFIG" => "/bundle",
+              "BUNDLE_BIN" => "/bundle/bin",
+              "PATH" => "/app/bin:/bundle/bin:$PATH"
+            }.merge(extra_env),
+            "working_dir" => "/app"
+          }.merge(depends_on)
+
+          services.merge(docker_compose_extend.services)
+        end
+
+        def volumes_json
+          {
+            bundle_volume => {
+              "name" => bundle_volume
+            }
+          }.merge(docker_compose_extend.volumes)
+        end
+
+        def depends_on
+          if docker_compose_extend.services.keys.empty?
+            {}
+          else
+            { "depends_on" => docker_compose_extend.services.keys }
+          end
+        end
+
+        def extra_env
+          Config.env.merge(context.env)
+                    .merge(main_variant.container.env)
+        end
+
+        def main_variant
+          context.main_variant
+        end
+
+        def bundle_volume
+          main_variant.bundle_volume_name
+        end
+
+        def mounts(variant)
+          [
+            "../..:/app:cached",
+            "#{variant.bundle_volume_name}:/bundle",
+            "../gemfile_locks/#{context.id}:/app/Gemfile.lock"
+          ] + extra_mounts
+        end
+
+        def extra_mounts
+          mounts = Config.mounts + context.variants.map(&:mounts).flatten
+          mounts.map do |mount|
+            local_path, in_docker_path = mount.split(':')
+            next mount if Pathname.new(local_path).absolute?
+
+            local_path = Matrixeval.working_dir.join(local_path)
+            docker_compose_folder_path = Matrixeval.working_dir.join(".matrixeval/docker-compose")
+            local_path = local_path.relative_path_from docker_compose_folder_path
+
+            "#{local_path}:#{in_docker_path}"
+          end
+        end
+
+        def docker_compose_extend
+          @docker_compose_extend ||= context.docker_compose_extend
+        end
+
+        def working_dir_name
+          Matrixeval.working_dir.basename
+        end
+
+        def project_name
+          Config.project_name.gsub(/[^A-Za-z0-9-]/,'_').downcase
+        end
+
+      end
+    end
+  end
+end

data/lib/matrixeval/ruby/docker_compose.rb

@@ -1,16 +1,10 @@
 
-require_relative "./docker_compose/yaml"
+require_relative "./docker_compose/file"
 
 module Matrixeval
   module Ruby
     class DockerCompose
 
-      class << self
-        def clean_containers
-          system("docker compose -f .matrixeval/docker-compose.yml rm --all -f >> /dev/null 2>&1")
-        end
-      end
-
       attr_reader :context
 
       def initialize(context)
@@ -18,34 +12,55 @@ module Matrixeval
       end
 
       def run(arguments)
-        forward_arguments = arguments.join(" ")
+        forward_arguments = arguments.map do |arg|
+          arg.match(/\s/) ? "\"#{arg}\"" : arg
+        end.join(" ")
+
+        no_tty = %w[bash sh zsh dash].include?(arguments[0]) ? '' : '--no-TTY' 
 
         system(
           <<~DOCKER_COMPOSE_COMMAND
-          docker compose -f .matrixeval/docker-compose.yml \
+          #{docker_compose} \
           run --rm \
-          #{env} \
-          #{gemfile_mount} \
-          #{docker_compose_service_name} \
+          #{no_tty} \
+          #{context.docker_compose_service_name} \
           #{forward_arguments}
           DOCKER_COMPOSE_COMMAND
         )
+      ensure
+        stop_containers
+        clean_containers_and_anonymous_volumes
+        turn_on_stty_opost
       end
 
       private
 
-      def env
-        context.env.map do |k, v|
-          "-e #{k}='#{v}'"
-        end.join(" ")
+      def stop_containers
+        system("#{docker_compose} stop >> /dev/null 2>&1")
+      end
+
+      def clean_containers_and_anonymous_volumes
+        system("#{docker_compose} rm -v -f >> /dev/null 2>&1")
+      end
+
+      def docker_compose
+        <<~DOCKER_COMPOSE_COMMAND.strip
+        docker --log-level error compose \
+        -f #{yaml_file} \
+        -p matrixeval-#{project_name}-#{context.id}
+        DOCKER_COMPOSE_COMMAND
+      end
+
+      def yaml_file
+        ".matrixeval/docker-compose/#{context.id}.yml"
       end
 
-      def gemfile_mount
-        "-v ./.matrixeval/Gemfile.lock.#{context.id}:/app/Gemfile.lock"
+      def turn_on_stty_opost
+        system("stty opost")
       end
 
-      def docker_compose_service_name
-        context.docker_compose_service_name
+      def project_name
+        Config.project_name.gsub(/[^A-Za-z0-9-]/,'_').downcase
       end
 
     end

data/lib/matrixeval/ruby/extra_mount_files.rb

@@ -0,0 +1,23 @@
+module Matrixeval
+  module Ruby
+    class ExtraMountFiles
+      class << self
+
+        def create
+          Config.all_mounts.each do |mount|
+            local_path, _ = mount.split(':')
+            next mount if Pathname.new(local_path).absolute?
+
+            local_path = Matrixeval.working_dir.join(local_path)
+            next if local_path.extname.empty?
+            next if local_path.ascend.none? { |path| path == Matrixeval.working_dir }
+
+            FileUtils.mkdir_p local_path.dirname
+            FileUtils.touch local_path
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/matrixeval/ruby/gemfile_locks.rb

@@ -4,7 +4,7 @@ module Matrixeval
       class << self
 
         def create
-          FileUtils.mkdir_p dot_matrixeval_folder
+          FileUtils.mkdir_p gemfile_lock_folder
 
           Context.all.each do |context|
             FileUtils.touch context.gemfile_lock_path
@@ -13,8 +13,8 @@ module Matrixeval
 
         private
 
-        def dot_matrixeval_folder
-          Matrixeval.working_dir.join(".matrixeval")
+        def gemfile_lock_folder
+          Matrixeval.working_dir.join(".matrixeval/gemfile_locks")
         end
 
       end

data/lib/matrixeval/ruby/gitignore.rb

@@ -41,7 +41,7 @@ module Matrixeval
         end
 
         def gemfile_locks
-          ".matrixeval/Gemfile.lock.*"
+          ".matrixeval/gemfile_locks"
         end
 
         def gitignore_path

data/lib/matrixeval/ruby/runner.rb

@@ -45,7 +45,6 @@ module Matrixeval
         exit
       ensure
         turn_on_stty_opost
-        DockerCompose.clean_containers
       end
 
       private
@@ -67,9 +66,10 @@ module Matrixeval
 
       def run_all_contexts
         Config::YAML.create
-        DockerCompose::YAML.create
+        DockerCompose::File.create_all
         GemfileLocks.create
         Gitignore.update
+        ExtraMountFiles.create
 
         pull_all_images
 
@@ -111,9 +111,10 @@ module Matrixeval
 
       def run_a_specific_context
         Config::YAML.create
-        DockerCompose::YAML.create
+        DockerCompose::File.create_all
         GemfileLocks.create
         Gitignore.update
+        ExtraMountFiles.create
 
         context = Context.find_by_command_options!(command.context_options)
 

data/lib/matrixeval/ruby/templates/matrixeval.yml

@@ -1,14 +1,15 @@
-version: 0.2
+version: 0.3
+project_name: REPLACE_ME
 target: ruby
 parallel_workers: number_of_processors
 # commands:
 #   - ps
 #   - top
 #   - an_additional_command
+# mounts:
+#   - /a/path/need/to/mount:/a/path/mount/to
 matrix:
   ruby:
-    # mounts:
-    #   - /a/path/need/to/mount:/a/path/mount/to
     variants:
       - key: 2.7
         container:
@@ -23,8 +24,10 @@ matrix:
       # - key: jruby-9.3
       #   container:
       #     image: jruby:9.3
-      #     env:
+      #   env:
       #       PATH: "/opt/jruby/bin:/app/bin:/bundle/bin:$PATH"
+      #   mounts:
+      #     - /a/path/need/to/mount:/a/path/mount/to
 
   # rails:
   #   variants:

data/lib/matrixeval/ruby/variant.rb

@@ -9,7 +9,7 @@ module Matrixeval
         end
       end
 
-      attr_reader :key, :env, :vector, :default, :container
+      attr_reader :key, :env, :vector, :default, :container, :mounts
 
       def initialize(config = {}, vector)
         raise Error.new("Variant#key is missing") if config["key"].nil?
@@ -19,6 +19,7 @@ module Matrixeval
         @container = Container.new(config["container"])
         @env = config["env"] || {}
         @default = config["default"] || false
+        @mounts = config["mounts"] || []
       end
 
       def name

data/lib/matrixeval/ruby/vector.rb

@@ -3,11 +3,10 @@ require_relative "./variant"
 module Matrixeval
   module Ruby
     class Vector
-      attr_reader :key, :variants, :mounts
+      attr_reader :key, :variants
 
       def initialize(key, config)
         @key = key.to_s
-        @mounts = config["mounts"] || []
         @variants = (config["variants"] || []).map do |variant_config|
           config = if variant_config.is_a?(Hash)
             variant_config

data/lib/matrixeval/ruby/version.rb

@@ -2,6 +2,6 @@
 
 module Matrixeval
   module Ruby
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

data/lib/matrixeval/ruby.rb

@@ -5,6 +5,7 @@ require 'rainbow'
 require 'matrixeval/ruby/docker_compose'
 require 'matrixeval/ruby/context'
 require 'matrixeval/ruby/gemfile_locks'
+require 'matrixeval/ruby/extra_mount_files'
 require 'matrixeval/ruby/runner'
 require 'matrixeval/ruby/gitignore'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrixeval-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Hopper Gee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-11 00:00:00.000000000 Z
+date: 2022-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -79,9 +79,13 @@ files:
 - lib/matrixeval/ruby/config/yaml.rb
 - lib/matrixeval/ruby/container.rb
 - lib/matrixeval/ruby/context.rb
+- lib/matrixeval/ruby/context/build_docker_compose_extend.rb
 - lib/matrixeval/ruby/context/find_by_command_options.rb
 - lib/matrixeval/ruby/docker_compose.rb
-- lib/matrixeval/ruby/docker_compose/yaml.rb
+- lib/matrixeval/ruby/docker_compose/extend.rb
+- lib/matrixeval/ruby/docker_compose/extend_raw.rb
+- lib/matrixeval/ruby/docker_compose/file.rb
+- lib/matrixeval/ruby/extra_mount_files.rb
 - lib/matrixeval/ruby/gemfile_locks.rb
 - lib/matrixeval/ruby/gitignore.rb
 - lib/matrixeval/ruby/runner.rb

data/lib/matrixeval/ruby/docker_compose/yaml.rb

@@ -1,77 +0,0 @@
-require "erb"
-
-module Matrixeval
-  module Ruby
-    class DockerCompose
-      class YAML
-        class << self
-
-          def create
-            FileUtils.mkdir_p dot_matrixeval_folder
-
-            File.open(path, 'w+') do |file|
-              file.puts build_content
-            end
-          end
-
-          private
-
-          def build_content
-            {
-              "version" => "3",
-              "services" => services_json,
-              "volumes" => volumes_json
-            }.to_yaml.sub(/---\n/, "")
-          end
-
-          def services_json
-            services = {}
-
-            Config.main_vector_variants.map do |variant|
-              services[variant.docker_compose_service_name] = {
-                "image" => variant.container.image,
-                "volumes" => mounts(variant),
-                "environment" => {
-                  "BUNDLE_PATH" => "/bundle",
-                  "GEM_HOME" => "/bundle",
-                  "BUNDLE_APP_CONFIG" => "/bundle",
-                  "BUNDLE_BIN" => "/bundle/bin",
-                  "PATH" => "/app/bin:/bundle/bin:$PATH"
-                }.merge(variant.container.env),
-                "working_dir" => "/app"
-              }
-            end
-
-            services
-          end
-
-          def volumes_json
-            bundle_volumes.map do |volume|
-              [volume, {"name" => volume}]
-            end.to_h
-          end
-
-          def bundle_volumes
-            Config.main_vector_variants.map(&:bundle_volume_name)
-          end
-
-          def mounts(variant)
-            [
-              "..:/app:cached",
-              "#{variant.bundle_volume_name}:/bundle",
-            ] + Config.main_vector.mounts
-          end
-
-          def path
-            dot_matrixeval_folder.join("docker-compose.yml")
-          end
-
-          def dot_matrixeval_folder
-            Matrixeval.working_dir.join(".matrixeval")
-          end
-
-        end
-      end
-    end
-  end
-end