matrixeval 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2f92ab631d36382a3fe2796928681d6c0a7eddaeea0d74b7165647fa3166c81
-  data.tar.gz: c45c4f0d82a430846049f07ac2a659ded7cc3cb054512823beea37af09175e1b
+  metadata.gz: f340adc04181b907e790e3028bb80f1de0d4ea91f1ec4477087d7b2631bde065
+  data.tar.gz: e6845d5bcf308d0974b9241420ef3a1dbc8a3fa544bbad43543cae7f6079203e
 SHA512:
-  metadata.gz: c696eaf66bb2daba16dc82221f47a3f0fab5362dc6883c9d72656e690690810491fce0ed2d63b4e30cb4152c0dad940156d9c4754cc2c86d88c4e66acc68f6c9
-  data.tar.gz: 9476247c48c5028eaac4a2e983e6e11c55d7233a23a01e5618ecd874b3dba5e1da7c1f08f4576af9f7c2f1532e370e271df8366c615582051b7339df73a07d02
+  metadata.gz: 9b733e83ca820507963da27358d419154d1023ae60e821121935dc116cc3880123e1c1fb8af5b0355d5f6d854b8e1e0f42c4823408b5308008a3ea2e74fd0e21
+  data.tar.gz: af5163f1de81ea41d3882f1930f741a9434dd88c181743820d63d837ed19eacf76651644d85310d276c5ca82ff89094fb88327675a24567caadf7fbcd5ccece0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-02-03
+# [0.4.0] - 2022-02-26
+
+- Test your code against different versions of dependencies
+- Support 3rd plugin
+# [0.1.0] - 2022-02-09
 
 - Initial release

data/Gemfile

@@ -8,3 +8,7 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+
+gem "minitest-focus"
+gem "byebug"
+gem "mocha"

data/README.md

@@ -1,9 +1,17 @@
-# Matrixeval
+# MatrixEval
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/matrixeval`. To experiment with that code, run `bin/console` for an interactive prompt.
+Test your code against multiple versions of dependencies like:
+- Programming language version
+- Framework version
+- Package version
+- Environment variables
 
-TODO: Delete this and the text above, and describe your gem
+## Features
 
+- Parallel test your code against multiple versions of dependencies combinations.
+- Test your 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:
@@ -20,9 +28,86 @@ Or install it yourself as:
 
     $ gem install matrixeval
 
+### Plugins
+
+If you plan to test ruby code, you can use [matrixeval-ruby](https://github.com/MatrixEval/matrixeval-ruby) directly.
+
 ## Usage
 
-TODO: Write usage instructions here
+Initialize
+
+```bash
+matrixeval init
+```
+
+Customize `matrixeval.yml` file and run commands like:
+
+```bash
+matrixeval --all COMMAND
+matrixeval --PROGRAMMING_LANGUAGE LANGUAGE_VERSION --PACKAGE_NAME PACKAGE_VERSION COMMAND OPTIONS
+matrixeval bash
+```
+Run `matrixeval --help` for more details
+
+### Configuration Example
+
+Here is the configuration file `matrixeval.yml` which will auto created by `matrixeval init`
+
+```yaml
+version: 0.4
+project_name: REPLACE_ME
+parallel_workers: number_of_processors
+# commands:
+#   - ps
+#   - top
+#   - an_additional_command
+# mounts:
+#   - /a/path/need/to/mount:/a/path/mount/to
+matrix:
+  # YOUR_PROGRAMMING_LANGUAGE_NAME:
+  #   main: true
+  #   variants:
+  #     - key: LANGUAGE_VERSION_1
+  #       default: true
+  #       container:
+  #         image: LANGUAGE_DOCKER_NAME_1
+  #     - key: LANGUAGE_VERSION_2
+  #       container:
+  #         image: LANGUAGE_DOCKER_NAME_2
+  #       env:
+  #           AN_ENV_KEY: ENV_VALUE
+  #       mounts:
+  #         - /a/path/need/to/mount:/a/path/mount/to
+
+  # another:
+  #   variants:
+  #     - key: key1
+  #       default: true
+  #       env:
+  #         ENV_KEY: 1
+  #     - key: key2
+  #       env:
+  #         ENV_KEY: 2
+
+exclude:
+  # - YOUR_PROGRAMMING_LANGUAGE_NAME: LANGUAGE_VERSION_1
+  #   another: key1
+
+docker-compose-extend:
+  # services:
+  #   postgres:
+  #     image: postgres:12.8
+  #     volumes:
+  #       - postgres12:/var/lib/postgresql/data
+  #     environment:
+  #       POSTGRES_HOST_AUTH_METHOD: trust
+
+  #   redis:
+  #     image: redis:6.2-alpine
+
+  # volumes:
+  #   postgres12:
+```
 
 ## Development
 
@@ -32,7 +117,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/matrixeval. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/matrixeval/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/matrixeval/matrixeval. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/matrixeval/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +125,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Matrixeval project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/matrixeval/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Matrixeval::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/matrixeval/matrixeval/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -6,7 +6,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["test/matrixeval/**/*_test.rb"]
 end
 
 task default: :test

data/bin/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+system("ruby -Ilib:test #{ARGV.join(" ")}")

data/exe/matrixeval

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'matrixeval'
+
+Matrixeval.start(ARGV)

data/exe/meval

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'matrixeval'
+
+Matrixeval.start(ARGV)

data/lib/matrixeval/command_line/parse_context_arguments.rb

@@ -0,0 +1,80 @@
+module Matrixeval
+  class CommandLine
+    class ParseContextArguments
+      class << self
+        def call(context_arguments)
+          new(context_arguments).call
+        end
+      end
+
+      attr_reader :context_arguments, :options
+
+      def initialize(context_arguments)
+        @context_arguments = context_arguments 
+        @options = {}
+      end
+
+      def call
+        parse!
+        options
+      end
+
+      private
+
+      def parse!
+        OptionParser.new do |opts|
+          opts.version = Config.target.version
+          opts.program_name = ""
+          opts.banner = <<~USAGE
+            Usage:
+                matrixeval(meval) [OPTIONS] COMMAND
+            USAGE
+
+          opts.separator ""
+          opts.separator "Options:"
+
+          opts.on "-a", "--all", "# Run the COMMAND against all matrix combinations"
+
+          Config.vectors.each do |vector|
+            # short = "-#{vector.short_key}"
+            long = "--#{vector.key} [VERSION]"
+            desc = [
+              "# Run the COMMAND against a specific #{vector.key} version",
+              "# Options: #{vector.variants.map(&:key).join("/")}",
+              "# Default: #{vector.default_variant.key}",
+              "# Customizable"
+            ]
+            opts.separator ""
+            opts.on(long, *desc)
+          end
+
+          opts.separator ""
+          opts.separator "Commands: #{Config.commands.join("/")} (Customizable)"
+
+          opts.separator ""
+          opts.separator "MatrixEval Options:"
+
+          opts.on("-h", "--help", "# Show help") do
+            puts opts.help
+            exit
+          end
+
+          opts.on("-v", "--version", "# Show version") do
+            puts opts.version
+            exit
+          end
+
+          opts.separator ""
+          opts.separator "Customizations:"
+          opts.separator "    You can customize all options in matrixeval.yml"
+
+          Config.target.cli_example_lines.each do |line|
+            opts.separator line
+          end
+
+        end.parse!(context_arguments, into: options)
+      end
+
+    end
+  end
+end

data/lib/matrixeval/command_line/parse_init_arguments.rb

@@ -0,0 +1,50 @@
+module Matrixeval
+  class CommandLine
+    class ParseInitArguments
+      class << self
+        def call(arguments)
+          new(arguments).call
+        end
+      end
+
+      attr_reader :init_arguments, :options
+
+      def initialize(init_arguments)
+        @init_arguments = init_arguments
+        @options = {}
+      end
+
+      def call
+        parse!
+        options
+      end
+
+      private
+
+      def parse!
+        OptionParser.new do |opts|
+          opts.version = Matrixeval::VERSION
+          opts.program_name = ""
+          opts.banner = <<~USAGE
+            Usage:
+                matrixeval(meval) init [Options]
+            USAGE
+
+          opts.separator ""
+          opts.separator "Options:"
+          opts.on("-t", "--target [TARGET]", *[
+            "# Initialize with a specific target",
+            "# Options: #{Matrixeval.targets.keys}",
+            "# Default: none"
+          ])
+
+          opts.on("-h", "--help", "# Show help") do
+            puts opts.help
+            exit
+          end
+        end.parse!(init_arguments, into: options)
+      end
+
+    end
+  end
+end

data/lib/matrixeval/command_line.rb

@@ -0,0 +1,57 @@
+require_relative "./command_line/parse_context_arguments"
+require_relative "./command_line/parse_init_arguments"
+
+module Matrixeval
+
+  COMMANDS = ['bash', 'dash', 'sh', 'zsh']
+
+  class CommandLine
+
+    attr_reader :argv
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def valid?
+      init? ||
+        !context_options.empty? ||
+        !seperator_index.nil?
+    end
+
+    def init?
+      @argv[0] == 'init'
+    end
+
+    def init_options
+      @init_options ||= ParseInitArguments.call(@argv[1..-1])
+    end
+
+    def all?
+      context_options[:all]
+    end
+
+    def context_options
+      @context_options ||= ParseContextArguments.call(context_arguments)
+    end
+
+    def context_arguments
+      arguments = @argv[0...seperator_index]
+      arguments << "-h" if @argv.empty?
+      arguments
+    end
+
+    def rest_arguments
+      @argv[seperator_index..-1]
+    end
+
+    private
+
+    def seperator_index
+      @argv.index do |argument|
+        Config.commands.include?(argument)
+      end
+    end
+
+  end
+end

data/lib/matrixeval/config/yaml.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+module Matrixeval
+  class Config
+    class YAML
+
+      class MissingError < StandardError; end
+
+      class << self
+
+        def create_for(target_name)
+          return if File.exist?(path)
+
+          FileUtils.cp(
+            target(target_name).matrixeval_yml_template_path,
+            path
+          )
+        end
+
+        def path
+          Matrixeval.working_dir.join("matrixeval.yml")
+        end
+
+        def [](key)
+          yaml[key]
+        end
+
+        def yaml
+          raise MissingError unless File.exist?(path)
+
+          ::YAML.load File.read(path)
+        end
+
+        private
+
+        def target(target_name)
+          target_klass(target_name).new
+        end
+
+        def target_klass(target_name)
+          Matrixeval.targets[target_name] || Target
+        end
+
+      end
+    end
+  end
+end

data/lib/matrixeval/config.rb

@@ -0,0 +1,101 @@
+require 'yaml'
+require_relative "./config/yaml"
+
+module Matrixeval
+  class Config
+    class << self
+
+      def version
+        YAML["version"]
+      end
+
+      def target_name
+        YAML["target"]
+      end
+
+      def target
+        @target ||= target_klass.new
+      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)
+        end
+      end
+
+      def main_vector
+        vectors.find(&:main?)
+      end
+
+      def rest_vectors
+        vectors.reject(&:main?)
+      end
+
+      def variant_combinations
+        main_vector_variants.product(*rest_vector_variants_matrix)
+      end
+
+      def main_vector_variants
+        main_vector.variants
+      end
+
+      def rest_vector_variants_matrix
+        rest_vectors.map(&:variants)
+      end
+
+      def exclusions
+        YAML["exclude"] || []
+      end
+
+      def parallel_workers
+        YAML["parallel_workers"] || "number_of_processors"
+      end
+
+      def commands
+        cmds = YAML["commands"] || []
+        COMMANDS + target.support_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
+
+      def target_klass
+        Matrixeval.targets[target_name&.to_sym] || Target
+      end
+
+    end
+  end
+end

data/lib/matrixeval/container.rb

@@ -0,0 +1,13 @@
+module Matrixeval
+  class Container
+
+    attr_reader :image, :env
+
+    def initialize(options)
+      options ||= {}
+      @image = options["image"]
+      @env = options["env"] || {}
+    end
+
+  end
+end

data/lib/matrixeval/context/build_docker_compose_extend.rb

@@ -0,0 +1,41 @@
+require 'erb'
+require 'json'
+
+module Matrixeval
+  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

data/lib/matrixeval/context/find_by_command_options.rb

@@ -0,0 +1,65 @@
+module Matrixeval
+  class Context
+    class FindByCommandOptions
+      class << self
+        def call(options)
+          new(options).call
+        end
+      end
+
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def call
+        context = Context.all.find do |context|
+          context.main_variant == main_variant &&
+            context.rest_variants == rest_variants
+        end
+
+        raise Error.new("Can't find a corresponding matrix") if context.nil?
+
+        context
+      end
+
+      private
+
+      def main_variant
+        dig_variant Config.main_vector
+      end
+
+      def rest_variants
+        Config.rest_vectors.map do |vector|
+          dig_variant vector
+        end.sort do |v1, v2|
+          v1.id <=> v2.id
+        end
+      end
+
+      def dig_variant(vector)
+        if option_key?(vector.key)
+          find_variant(vector)
+        else
+          vector.default_variant
+        end
+      end
+
+      def find_variant(vector)
+        vector.variants.find do |variant|
+          option(vector.key) == variant.key
+        end
+      end
+
+      def option(key)
+        options[key.to_sym] || options[key.to_s]
+      end
+
+      def option_key?(key)
+        options.key?(key.to_sym) || options.key?(key.to_s)
+      end
+
+    end
+  end
+end