performa 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6435a998ab87cdad87f5dceb1ff410c8f081aabe5ef10fc360479d7bd1e97fc
-  data.tar.gz: 2f3a401bae1c21ef9d3bb42d084b19b79dc4e61486028f2a42b9e7dc44d632e9
+  metadata.gz: 610de8109b1e5e60dabaf00a4082876e02aadfeb30ade8c3d1c4029002f65ad8
+  data.tar.gz: f67c8f636156222f878b8a8ba7ab599e4eb3d768cbf8858ec74b461cf2f6263b
 SHA512:
-  metadata.gz: 7792a8296acd422c3d6cd0819f00b509311f57de99b042917e99232d31be9c8c17f76805dd6d501dd28b19ab128b81dd69b4ca7eb0046145bac9be8df21cb405
-  data.tar.gz: fe0205c9b1cf8cfb9bacf9b5b2afaa0a1f077f54e1ba5faa591c1613b67adf29eb82b362782696473c5910e0174b917c3ef41a4557c139adb29a214c2b8aefdd
+  metadata.gz: 3e6b1b838b7b31388acfb7f63cd6f7da63ff93a1640d11fc1069f8bd3184c1ed998dee0a11ee5ba86a4a528ebb3a47dae256f4be61fcacc55b031eea1e92d4a4
+  data.tar.gz: 00fde074f5669f69a4b31c50db8ba6c0183abddfa25b2d53ce447fb1b2f547f9d9f110058c48b3f5b225cfd7d155f291ad6ff78baefee262bd78bbe50af7e82d

data/.ruby-version

@@ -1 +1 @@
-2.6.0-dev
+2.6.0-preview3

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/rubocop-hq/rubocop
-  revision: e74002ce0cf4367b3cebd580523b07ea2a59bf55
+  revision: 52319e485b733e6780a38986e79e7b542b0442aa
   specs:
     rubocop (0.60.0)
       jaro_winkler (~> 1.5.1)
@@ -14,7 +14,7 @@ GIT
 PATH
   remote: .
   specs:
-    performa (0.1.0)
+    performa (0.2.0)
       colorize (~> 0.8)
 
 GEM
@@ -30,7 +30,7 @@ GEM
       ast (~> 2.4.0)
     powerpack (0.1.2)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (12.3.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -59,4 +59,4 @@ DEPENDENCIES
   rubocop!
 
 BUNDLED WITH
-   2.0.0.pre.1
+   1.17.1

data/exe/performa

@@ -4,7 +4,7 @@
 lib = File.expand_path("../lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require "byebug" if ENV["DEBUG"]
+require("byebug") if ENV["DEBUG"] && !Gem::Specification.find_all_by_name("byebug").empty?
 require "performa"
 require "optionparser"
 
@@ -12,7 +12,7 @@ options = Struct.new(:config_file).new
 
 OptionParser.new do |opts|
   opts.banner = [
-    "Usage: performa [-c config-file.yml]",
+    "Usage: performa [-c performa-config-file.yml]",
     "Default config files considered: #{Performa::Configuration::DEFAULT_FILES.join(', ')}\n\n"
   ].join("\n")
 
@@ -25,6 +25,18 @@ OptionParser.new do |opts|
     exit 0
   end
 
+  opts.on("-i", "--init [.performa.yml]", "Generate a new config file") do |file|
+    file ||= ".performa.yml"
+    begin
+      Performa::Configuration.generate_file(file)
+    rescue Errno::EEXIST
+      puts "Error: `#{file}` already exists. Please delete it first."
+      exit 1
+    end
+
+    exit 0
+  end
+
   opts.on("-h", "--help", "Prints this help") do
     puts opts
     exit 0

data/lib/performa/command_result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Performa
+  class CommandResult < String
+    attr_accessor :success
+
+    def success?
+      @success
+    end
+
+    def failure?
+      !@success
+    end
+  end
+end

data/lib/performa/configuration-template.yml

@@ -0,0 +1,30 @@
+---
+
+## [Optional] Config file version (default: latest)
+version: 1
+
+## [Required] Base docker images to run command on
+images:
+  # - ruby:2.4
+  # - ruby:2.5
+
+## [Optional] Commands setting up each image before running command.
+## Environments generated = images * stages
+# stages:
+#   activerecord_4:
+#     - gem install sqlite3
+#     - gem install activerecord -v=4.0.0
+#   activerecord_5:
+#     - gem install sqlite3
+#     - gem install activerecord -v=5.0.0
+
+## [Optional] Cache environments (as performa docker images)
+# cache_environments: true
+
+## [Optional] Volumes to mount
+# volumes:
+#   - .:/app
+
+## [Required] Command to run on all environments
+command: |
+  ruby -e "puts RUBY_VERSION"

data/lib/performa/configuration.rb

@@ -5,8 +5,7 @@ require "yaml"
 module Performa
   class Configuration
     DEFAULT_FILES = %w[
-      performa.yml config/performa.yml
-      spec/performa.yml test/performa.yml
+      .performa.yml performa.yml config/performa.yml
     ].freeze
 
     ERR_READING_CONFIG_FILE = "Could not read config file %s (%s)"
@@ -40,8 +39,7 @@ module Performa
     end
 
     def validate_data
-      raise InvalidDataError if @data["version"].nil? ||
-                                !@data["images"]&.is_a?(Array) ||
+      raise InvalidDataError if !@data["images"]&.is_a?(Array) ||
                                 @data["command"]&.empty?
     rescue InvalidDataError
       raise Error, "Invalid config"
@@ -50,5 +48,16 @@ module Performa
     def [](name)
       @data[name]
     end
+
+    def cachable_envs?
+      !(@data["cache_environments"] == false || @data["stages"].nil?)
+    end
+
+    def self.generate_file(file)
+      raise Errno::EEXIST if File.exist?(file)
+
+      template_file = File.join(__dir__, "configuration-template.yml")
+      FileUtils.cp(template_file, file, verbose: true)
+    end
   end
 end

data/lib/performa/container_registry.rb

@@ -19,7 +19,7 @@ module Performa
     end
 
     def kill(container_id)
-      run_command("docker kill #{container_id}")
+      run_command("docker kill #{container_id}", success_only: false)
       containers.delete(container_id)
     end
 

data/lib/performa/coordinator.rb

@@ -20,15 +20,13 @@ module Performa
     end
 
     def process_env(env, config:)
+      LOG.info_notice("Processing #{env.name}")
       container_id = Images.process(env, config: config)
-      unless container_id.from_cache
-        Stages.process(env, container_id: container_id)
-        Images.cache_container(container_id, tag: env.hash) unless config["cache_environments"] == false
-      end
-
-      result = run_command("docker container exec #{container_id} #{config['command']}")
-      ContainerRegistry.kill(container_id)
-      result
+      run_container_command(container_id, config["command"], success_only: false)
+    rescue CommandFailureError => error
+      error.message
+    ensure
+      ContainerRegistry.kill(container_id) if container_id
     end
   end
 end

data/lib/performa/environment.rb

@@ -5,15 +5,24 @@ require "digest"
 module Performa
   class Environment
     def self.all(config)
-      unless config["stages"]
-        return config["images"].map do |image|
-          new(image: image, volumes: config["volumes"])
-        end
+      config["stages"] ? all_with_active_stages(config) : all_without_stages(config)
+    end
+
+    def self.all_without_stages(config)
+      config["images"].map do |image|
+        new(image: image, volumes: config["volumes"])
       end
+    end
+
+    def self.all_with_active_stages(config)
+      skipped = config["skip"]&.flat_map { |image, stages_names| [image].product(stages_names) }
 
-      config["images"].product(config["stages"].to_a).map do |image, stage|
+      config["images"].product(config["stages"].to_a).map do |image, config_stage|
+        next if skipped&.include?([image, config_stage[0]])
+
+        stage = Stage.from_config(config_stage, image: image)
         new(image: image, stage: stage, volumes: config["volumes"])
-      end
+      end.compact
     end
 
     attr_reader :image, :stage, :volumes, :name, :hash
@@ -23,15 +32,10 @@ module Performa
       @stage = stage
       @volumes = volumes || []
       assign_name
-      assign_hash
     end
 
     def assign_name
-      @name = @image.tr(":", "_") + ("-#{@stage[0]}" if @stage).to_s
-    end
-
-    def assign_hash
-      @hash = Digest::SHA1.hexdigest(@image + @stage.to_s)
+      @name = @image.tr(":", "_") + ("-#{@stage.name}" if @stage).to_s
     end
   end
 end

data/lib/performa/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Performa
+  Error = Class.new(StandardError)
+  CommandFailureError = Class.new(Error)
+end

data/lib/performa/images.rb

@@ -8,22 +8,41 @@ module Performa
     CACHED_IMAGES_NAME = "performa_env"
 
     def process(env, config:)
-      unless config["cache_environments"] == false
+      if config.cachable_envs?
         container_id = container_id_for_cached_image(env)
         return container_id if container_id
       end
 
       pull_if_missing(env.image)
-      id = start_image_container(env.image, volumes: env.volumes)
-      ContainerId.new(id)
+      container_id = start_image_container(env.image, volumes: env.volumes)
+
+      if env.stage&.commands
+        run_and_cache_commands(
+          env.stage.commands,
+          cacheable_envs: config.cachable_envs?,
+          container_id: container_id
+        )
+      end
+
+      container_id
     end
 
     def container_id_for_cached_image(env)
-      cached_image = "#{CACHED_IMAGES_NAME}:#{env.hash}"
-      return unless exists?(cached_image)
+      commands = env.stage.commands
+      last_cached_stage_command = commands.reverse.find(&:cache)
+      return unless last_cached_stage_command
+
+      container_id = start_image_container(last_cached_stage_command.cache, volumes: env.volumes)
+      uncached_commands = commands[commands.index(last_cached_stage_command) + 1..-1]
+      run_and_cache_commands(uncached_commands, container_id: container_id)
+      container_id
+    end
 
-      id = start_image_container(cached_image, volumes: env.volumes)
-      ContainerId.from_cache(id)
+    def run_and_cache_commands(commands, cacheable_envs: true, container_id:)
+      commands.each do |command|
+        run_container_command(container_id, command.value, success_only: false)
+        cache_container(container_id, tag: command.hash) if cacheable_envs
+      end
     end
 
     def pull(image)
@@ -31,11 +50,15 @@ module Performa
     end
 
     def pull_if_missing(image)
-      pull(image) unless exists?(image)
+      pull(image) unless presence(image)
+    end
+
+    def presence(image)
+      image unless run_command("docker images -q #{image}").empty?
     end
 
-    def exists?(image)
-      !run_command("docker images -q #{image}").empty?
+    def cache_presence(hash)
+      presence("#{CACHED_IMAGES_NAME}:#{hash}")
     end
 
     def start_image_container(image, volumes: [])

data/lib/performa/logger.rb

@@ -18,7 +18,21 @@ module Performa
     end
   end
 
-  def LOG.success(message)
-    LOG.info(message.colorize(:green))
+  class << LOG
+    def info_success(message)
+      LOG.info(message.colorize(:green))
+    end
+
+    def info_error(message)
+      LOG.info(message.colorize(:red))
+    end
+
+    def info_warning(message)
+      LOG.info(message.colorize(:yellow))
+    end
+
+    def info_notice(message)
+      LOG.info(message.colorize(:light_blue))
+    end
   end
 end

data/lib/performa/shell_helper.rb

@@ -1,43 +1,50 @@
 # frozen_string_literal: true
 
-require "pty"
 require "English"
+require "open3"
+require "shellwords"
 
 module Performa
   module ShellHelper
     def run_command(command, success_only: true, no_capture: false)
-      LOG.success("Running `#{command}` ...")
+      LOG.info("Running `#{command.colorize(:light_yellow)}` ...")
 
-      if no_capture
-        system(command)
-        result = ""
-      else
-        result = pty_spawn(command)
-      end
-
-      raise "(non-zero exit code)" if success_only && !$CHILD_STATUS.success?
+      exit_status, result_str = no_capture ? run_no_capture_command(command) : run_capture_command(command)
+      raise "(non-zero exit code: #{exit_status.exitstatus})" if success_only && !exit_status.success?
 
-      result
+      CommandResult.new(result_str).tap do |result|
+        result.success = exit_status.success?
+      end
     rescue StandardError => e
       raise Error, <<~MSG
         Error running the command `#{command}`:
         => error: #{e.message}
-        => command output: #{result}
+        => command output: #{result_str}
       MSG
     end
 
-    def pty_spawn(command)
-      result = +""
-      PTY.spawn(command) do |stdout, _stdin, _pid|
-        stdout.each do |line|
-          LOG.info(line.strip)
-          result << line
+    def run_no_capture_command(command)
+      system(command)
+      [$CHILD_STATUS, ""]
+    end
+
+    def run_capture_command(command)
+      exit_status = nil
+      result_str = +""
+
+      Open3.popen2e(command) do |_stdin, stdout_and_stderr, wait_thr|
+        stdout_and_stderr.each do |line|
+          result_str << line
         end
+        exit_status = wait_thr.value
       end
+      exit_status.success? ? LOG.info_success(result_str) : LOG.info_error(result_str)
 
-      Process.wait unless $CHILD_STATUS.exited?
+      [exit_status, result_str]
+    end
 
-      result
+    def run_container_command(container_id, command, **options)
+      run_command("docker container exec #{container_id} sh -c #{Shellwords.escape(command)}", options)
     end
   end
 end

data/lib/performa/stage.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "digest/sha1"
+
+module Performa
+  class Stage
+    def self.from_config(config_stage, image:)
+      hash = Digest::SHA1.hexdigest(image)
+
+      commands = config_stage[1].map do |config_command|
+        hash = Digest::SHA1.hexdigest(hash + config_command)
+        StageCommand.new(config_command, hash: hash)
+      end
+
+      new(name: config_stage[0], commands: commands)
+    end
+
+    attr_reader :name, :commands, :hash
+
+    def initialize(name:, commands:)
+      @name = name
+      @commands = commands
+      @hash = Digest::SHA1.hexdigest(@name + @commands.map(&:hash).join)
+    end
+  end
+
+  class StageCommand
+    attr_reader :value, :hash
+
+    def initialize(value, hash:)
+      @value = value
+      @hash = hash
+    end
+
+    def cache
+      @cache ||= Images.cache_presence(@hash)
+    end
+  end
+end

data/lib/performa/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Performa
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/performa.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 require "performa/version"
+require "performa/errors"
 require "performa/logger"
 require "performa/configuration"
+require "performa/command_result"
 require "performa/shell_helper"
 require "performa/container_registry"
 require "performa/environment"
-require "performa/container_id"
+require "performa/stage"
 require "performa/images"
-require "performa/stages"
 require "performa/coordinator"
 require "performa/results_helper"
 
 module Performa
-  Error = Class.new(StandardError)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: performa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Christophe Maximin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-19 00:00:00.000000000 Z
+date: 2018-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -46,16 +46,18 @@ files:
 - bin/setup
 - exe/performa
 - lib/performa.rb
+- lib/performa/command_result.rb
+- lib/performa/configuration-template.yml
 - lib/performa/configuration.rb
-- lib/performa/container_id.rb
 - lib/performa/container_registry.rb
 - lib/performa/coordinator.rb
 - lib/performa/environment.rb
+- lib/performa/errors.rb
 - lib/performa/images.rb
 - lib/performa/logger.rb
 - lib/performa/results_helper.rb
 - lib/performa/shell_helper.rb
-- lib/performa/stages.rb
+- lib/performa/stage.rb
 - lib/performa/version.rb
 - performa.gemspec
 homepage: https://github.com/christophemaximin/performa

data/lib/performa/container_id.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Performa
-  class ContainerId < String
-    attr_accessor :from_cache
-
-    def initialize(*args)
-      @from_cache = false
-      super
-    end
-
-    def self.from_cache(string)
-      str = new(string)
-      str.from_cache = true
-      str
-    end
-  end
-end

data/lib/performa/stages.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Performa
-  module Stages
-    module_function
-
-    extend ShellHelper
-
-    def process(env, container_id:)
-      return unless env.stage
-
-      env.stage[1].each do |command|
-        run_command("docker container exec #{container_id} #{command}")
-      end
-    end
-  end
-end