performa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6435a998ab87cdad87f5dceb1ff410c8f081aabe5ef10fc360479d7bd1e97fc
+  data.tar.gz: 2f3a401bae1c21ef9d3bb42d084b19b79dc4e61486028f2a42b9e7dc44d632e9
+SHA512:
+  metadata.gz: 7792a8296acd422c3d6cd0819f00b509311f57de99b042917e99232d31be9c8c17f76805dd6d501dd28b19ab128b81dd69b4ca7eb0046145bac9be8df21cb405
+  data.tar.gz: fe0205c9b1cf8cfb9bacf9b5b2afaa0a1f077f54e1ba5faa591c1613b67adf29eb82b362782696473c5910e0174b917c3ef41a4557c139adb29a214c2b8aefdd

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+!/tmp/.keep
+
+# rspec failure tracking
+.rspec_status
+
+/.byebug_history
+/performa-results
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Metrics/LineLength:
+  Max: 130
+  AllowHeredoc: true
+  AllowURI: true
+  IgnoreCopDirectives: true
+  Exclude:
+    - "spec/**/*"
+
+# This cop checks the line count inside blocks.
+# All RSpec code is in the same block for each file.
+# Enabling this for spec/ would require cutting up the spec files in several parts.
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: "double_quotes"
+
+# This cop checks for missing top-level documentation of classes and modules.
+# Classes with no body are exempt from the check and so are namespace modules -
+# modules that have nothing in their bodies except classes, other modules,
+# or constant definitions.
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 30

data/.ruby-version

@@ -0,0 +1 @@
+2.6.0-dev

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# CHANGELOG
+
+WIP

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in performa.gemspec
+gemspec
+
+gem "bundler"
+gem "byebug"
+gem "rake"
+gem "rspec"
+gem "rubocop", github: "rubocop-hq/rubocop"

data/Gemfile.lock

@@ -0,0 +1,62 @@
+GIT
+  remote: https://github.com/rubocop-hq/rubocop
+  revision: e74002ce0cf4367b3cebd580523b07ea2a59bf55
+  specs:
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+
+PATH
+  remote: .
+  specs:
+    performa (0.1.0)
+      colorize (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (10.0.2)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  byebug
+  performa!
+  rake
+  rspec
+  rubocop!
+
+BUNDLED WITH
+   2.0.0.pre.1

data/README.md

@@ -0,0 +1,15 @@
+# Performa
+
+Automate scripts on multiple docker setups.
+
+## Usage
+
+TODO: ...
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/christophemaximin/performa](https://github.com/christophemaximin/performa).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "performa"
+require "byebug"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/performa

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "byebug" if ENV["DEBUG"]
+require "performa"
+require "optionparser"
+
+options = Struct.new(:config_file).new
+
+OptionParser.new do |opts|
+  opts.banner = [
+    "Usage: performa [-c config-file.yml]",
+    "Default config files considered: #{Performa::Configuration::DEFAULT_FILES.join(', ')}\n\n"
+  ].join("\n")
+
+  opts.on("-c", "--config-file [file]", "Performa config file to use") do |file|
+    options.config_file = file
+  end
+
+  opts.on("--clear-cached", "Remove all Performa generated docker images (#{Performa::Images::CACHED_IMAGES_NAME}:*)") do
+    Performa::Images.clear_cached
+    exit 0
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit 0
+  end
+end.parse!
+
+begin
+  config = Performa::Configuration.new(options.config_file)
+  Performa::Coordinator.run(config)
+rescue StandardError => e
+  Performa::LOG.error(e.message)
+  Performa::LOG.error(e.backtrace.join("\n")) if ENV["DEBUG"]
+  exit 1
+end

data/lib/performa.rb

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

data/lib/performa/configuration.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Performa
+  class Configuration
+    DEFAULT_FILES = %w[
+      performa.yml config/performa.yml
+      spec/performa.yml test/performa.yml
+    ].freeze
+
+    ERR_READING_CONFIG_FILE = "Could not read config file %s (%s)"
+    ERR_INVALID_FILE = "Invalid YAML file %s: %s"
+    ERR_NO_FILE = "Could not find a default config file (#{DEFAULT_FILES.join(', ')})"
+
+    InvalidDataError = Class.new(StandardError)
+
+    attr_reader :data
+
+    def initialize(config_file)
+      config_file ||= find_default_config_file
+      raise(Error, ERR_NO_FILE) unless config_file
+
+      @data = load_config_file(config_file)
+      validate_data
+    end
+
+    def load_config_file(config_file)
+      YAML.safe_load(File.read(config_file))
+    rescue Errno::EACCES => error
+      raise Error, format(ERR_READING_CONFIG_FILE, config_file, error.message)
+    rescue Psych::SyntaxError => error
+      raise Error, format(ERR_INVALID_FILE, config_file, error.message)
+    end
+
+    def find_default_config_file
+      DEFAULT_FILES.find do |file|
+        File.exist?(file)
+      end
+    end
+
+    def validate_data
+      raise InvalidDataError if @data["version"].nil? ||
+                                !@data["images"]&.is_a?(Array) ||
+                                @data["command"]&.empty?
+    rescue InvalidDataError
+      raise Error, "Invalid config"
+    end
+
+    def [](name)
+      @data[name]
+    end
+  end
+end

data/lib/performa/container_id.rb

@@ -0,0 +1,18 @@
+# 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/container_registry.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "set"
+
+module Performa
+  module ContainerRegistry
+    module_function
+
+    extend ShellHelper
+
+    def add(container_id)
+      containers << container_id
+    end
+
+    def kill_all
+      containers.each do |container_id|
+        kill(container_id)
+      end
+    end
+
+    def kill(container_id)
+      run_command("docker kill #{container_id}")
+      containers.delete(container_id)
+    end
+
+    def containers
+      Thread.current[:performa_containers] ||= Set.new
+    end
+  end
+end

data/lib/performa/coordinator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Performa
+  module Coordinator
+    module_function
+
+    extend ShellHelper
+
+    def run(config)
+      envs = Environment.all(config)
+      results = {}
+
+      envs.each do |env|
+        results[env.name] = process_env(env, config: config)
+      end
+
+      ResultsHelper.process(results, config: config)
+    ensure
+      ContainerRegistry.kill_all
+    end
+
+    def process_env(env, config:)
+      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
+    end
+  end
+end

data/lib/performa/environment.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+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
+      end
+
+      config["images"].product(config["stages"].to_a).map do |image, stage|
+        new(image: image, stage: stage, volumes: config["volumes"])
+      end
+    end
+
+    attr_reader :image, :stage, :volumes, :name, :hash
+
+    def initialize(image:, stage: nil, volumes: nil)
+      @image = image
+      @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)
+    end
+  end
+end

data/lib/performa/images.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Performa
+  module Images
+    module_function
+
+    extend ShellHelper
+    CACHED_IMAGES_NAME = "performa_env"
+
+    def process(env, config:)
+      unless config["cache_environments"] == false
+        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)
+    end
+
+    def container_id_for_cached_image(env)
+      cached_image = "#{CACHED_IMAGES_NAME}:#{env.hash}"
+      return unless exists?(cached_image)
+
+      id = start_image_container(cached_image, volumes: env.volumes)
+      ContainerId.from_cache(id)
+    end
+
+    def pull(image)
+      run_command("docker pull #{image}", no_capture: true)
+    end
+
+    def pull_if_missing(image)
+      pull(image) unless exists?(image)
+    end
+
+    def exists?(image)
+      !run_command("docker images -q #{image}").empty?
+    end
+
+    def start_image_container(image, volumes: [])
+      volumes_options = volumes.map do |volume|
+        volume[0] = Dir.pwd if volume[0] == "."
+        " -v #{volume}"
+      end.join
+
+      command = "docker run #{volumes_options} -d #{image} tail -f /dev/null"
+
+      run_command(command).strip.tap do |container_id|
+        ContainerRegistry.add(container_id)
+      end
+    end
+
+    def cache_container(container_id, tag:)
+      run_command("docker commit #{container_id} #{CACHED_IMAGES_NAME}:#{tag}")
+    end
+
+    def clear_cached
+      ids = run_command("docker images --filter=reference='#{CACHED_IMAGES_NAME}' --format '{{.ID}}'").split("\n")
+      ids.each do |id|
+        run_command("docker rmi -f #{id.strip}")
+      end
+    end
+  end
+end

data/lib/performa/logger.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "logger"
+require "time"
+require "colorize"
+
+module Performa
+  LOG = Logger.new(STDOUT)
+  LOG.level = Logger::INFO
+  LOG.formatter = proc do |severity, datetime, _progname, message|
+    line = "[#{datetime.strftime('%Y-%m-%d %H:%M:%S')}] #{severity} -- #{message}\n"
+
+    case severity
+    when "ERROR"
+      line.colorize(:red)
+    else
+      line
+    end
+  end
+
+  def LOG.success(message)
+    LOG.info(message.colorize(:green))
+  end
+end

data/lib/performa/results_helper.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "colorize"
+
+module Performa
+  module ResultsHelper
+    module_function
+
+    def process(results, config:)
+      if config["output"].nil? || config["output"] == "STDOUT"
+        output_to_stdout(results)
+      else
+        output_to_directory(results, directory: config["output"])
+      end
+    end
+
+    def output_to_stdout(results)
+      results.each_pair do |env_name, result|
+        puts
+        puts "== Output for #{env_name}".colorize(:green)
+        puts
+        puts result
+      end
+      puts
+    end
+
+    def output_to_directory(results, directory:)
+      FileUtils.mkdir_p(directory)
+      filenames = []
+      results.each_pair do |env_name, result|
+        filename = File.join(directory, env_name + ".txt")
+        filenames << filename
+
+        File.open(filename, "w+") do |file|
+          file.write(result)
+        end
+      end
+
+      message = +"Command outputs are now present in the following files:\n"
+      message << filenames.join("\n")
+
+      puts
+      puts message.colorize(:green)
+      puts
+    end
+  end
+end

data/lib/performa/shell_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "pty"
+require "English"
+
+module Performa
+  module ShellHelper
+    def run_command(command, success_only: true, no_capture: false)
+      LOG.success("Running `#{command}` ...")
+
+      if no_capture
+        system(command)
+        result = ""
+      else
+        result = pty_spawn(command)
+      end
+
+      raise "(non-zero exit code)" if success_only && !$CHILD_STATUS.success?
+
+      result
+    rescue StandardError => e
+      raise Error, <<~MSG
+        Error running the command `#{command}`:
+        => error: #{e.message}
+        => command output: #{result}
+      MSG
+    end
+
+    def pty_spawn(command)
+      result = +""
+      PTY.spawn(command) do |stdout, _stdin, _pid|
+        stdout.each do |line|
+          LOG.info(line.strip)
+          result << line
+        end
+      end
+
+      Process.wait unless $CHILD_STATUS.exited?
+
+      result
+    end
+  end
+end

data/lib/performa/stages.rb

@@ -0,0 +1,17 @@
+# 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

data/lib/performa/version.rb

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

data/performa.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "performa/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "performa"
+  spec.version = Performa::VERSION
+  spec.authors = ["Christophe Maximin"]
+  spec.email = ["christophe.maximin@gmail.com"]
+
+  spec.summary = "PLACEHOLDER"
+  spec.description = "PLACEHOLDER"
+  spec.homepage = "https://github.com/christophemaximin/performa"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/christophemaximin/performa"
+  spec.metadata["changelog_uri"] = "https://github.com/christophemaximin/performa/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "colorize", "~> 0.8"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: performa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christophe Maximin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: PLACEHOLDER
+email:
+- christophe.maximin@gmail.com
+executables:
+- performa
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/performa
+- lib/performa.rb
+- lib/performa/configuration.rb
+- lib/performa/container_id.rb
+- lib/performa/container_registry.rb
+- lib/performa/coordinator.rb
+- lib/performa/environment.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/version.rb
+- performa.gemspec
+homepage: https://github.com/christophemaximin/performa
+licenses: []
+metadata:
+  homepage_uri: https://github.com/christophemaximin/performa
+  source_code_uri: https://github.com/christophemaximin/performa
+  changelog_uri: https://github.com/christophemaximin/performa/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 3.0.0.beta2
+signing_key: 
+specification_version: 4
+summary: PLACEHOLDER
+test_files: []