tomo 0.1.0

data/lib/tomo/testing/docker_plugin_tester.rb

@@ -0,0 +1,39 @@
+require "fileutils"
+require "securerandom"
+require "tmpdir"
+
+module Tomo
+  module Testing
+    class DockerPluginTester < PluginTester
+      def initialize(*plugin_names, settings: {}, setup_script: nil)
+        @docker_image = DockerImage.new
+        @docker_image.setup_script = setup_script if setup_script
+        @docker_image.build_and_run
+        host = @docker_image.host
+        super(
+          *plugin_names,
+          settings: @docker_image.ssh_settings.merge(settings),
+          host: host
+        )
+      end
+
+      def run(shell_script, **kwargs)
+        call_helper(:run, shell_script, **kwargs)
+      end
+
+      def run_task(task, *args)
+        Testing.enabling_ssh do
+          super
+        end
+      end
+
+      def teardown
+        docker_image.stop
+      end
+
+      private
+
+      attr_reader :docker_image
+    end
+  end
+end

data/lib/tomo/testing/host_extensions.rb

@@ -0,0 +1,27 @@
+module Tomo
+  module Testing
+    module HostExtensions
+      attr_reader :helper_values, :mocks, :scripts, :release
+
+      def initialize(**kwargs)
+        @mocks = []
+        @scripts = []
+        @helper_values = []
+        @release = {}
+        super
+      end
+
+      def mock(script, stdout: "", stderr: "", exit_status: 0)
+        mocks << [
+          script.is_a?(Regexp) ? script : /\A#{Regexp.quote(script)}\z/,
+          Result.new(stdout: stdout, stderr: stderr, exit_status: exit_status)
+        ]
+      end
+
+      def result_for(script)
+        match = mocks.find { |regexp, _| regexp.match?(script.to_s) }
+        match&.last || Result.empty_success
+      end
+    end
+  end
+end

data/lib/tomo/testing/local.rb

@@ -0,0 +1,75 @@
+require "bundler"
+require "open3"
+require "shellwords"
+
+module Tomo
+  module Testing
+    module Local
+      class << self
+        def bundle_exec(command)
+          gemfile = File.expand_path("../../../Gemfile", __dir__)
+          full_cmd = "bundle exec --gemfile=#{gemfile.shellescape} #{command}"
+          Bundler.with_original_env do
+            puts ">>> #{full_cmd}"
+            system(full_cmd) || raise("Command failed")
+          end
+        end
+
+        def capture(command, raise_on_error: true)
+          progress(command) do
+            output, status = Open3.capture2e(command)
+
+            if raise_on_error && !status.success?
+              raise "Command failed: #{command}\n#{output}"
+            end
+
+            output
+          end
+        end
+
+        private
+
+        def progress(message, &block)
+          return with_progress(message, &block) if interactive?
+
+          thread = Thread.new(&block)
+          return thread.value if wait_for_exit(thread, 4)
+
+          puts "#{message} ..."
+          wait_for_exit(thread)
+          puts "#{message} ✔"
+
+          thread.value
+        end
+
+        def with_progress(message, &block)
+          spinner = %w[⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏].cycle
+          thread = Thread.new(&block)
+          return thread.value if wait_for_exit(thread, 4)
+
+          print "#{spinner.next} #{message}..."
+          loop do
+            break if wait_for_exit(thread, 0.2)
+
+            print "\r#{spinner.next} #{message}..."
+          end
+          puts "\r✔ #{message}..."
+          thread.value
+        end
+
+        def interactive?
+          Tomo::Console.interactive? && !ENV["_TOMO_CONTAINER"]
+        end
+
+        def wait_for_exit(thread, seconds=nil)
+          thread.join(seconds)
+        rescue StandardError
+          # Sanity check. If we get an exception, the thread should be dead.
+          raise if thread.alive?
+
+          thread
+        end
+      end
+    end
+  end
+end

data/lib/tomo/testing/mock_plugin_tester.rb

@@ -0,0 +1,26 @@
+module Tomo
+  module Testing
+    class MockPluginTester < PluginTester
+      def initialize(*plugin_names, settings: {}, release: {})
+        host = Host.parse("testing@host")
+        host.release.merge!(release)
+        super(*plugin_names, settings: settings, host: host)
+      end
+
+      def executed_script
+        return executed_scripts.first unless executed_scripts.length > 1
+
+        raise "Expected one executed script, got multiple: #{executed_scripts}"
+      end
+
+      def executed_scripts
+        host.scripts.map(&:to_s)
+      end
+
+      def mock_script_result(script=/.*/, **kwargs)
+        host.mock(script, **kwargs)
+        self
+      end
+    end
+  end
+end

data/lib/tomo/testing/mocked_exec_error.rb

@@ -0,0 +1,6 @@
+module Tomo
+  module Testing
+    class MockedExecError < Exception # rubocop:disable Lint/InheritException
+    end
+  end
+end

data/lib/tomo/testing/plugin_tester.rb

@@ -0,0 +1,49 @@
+module Tomo
+  module Testing
+    class PluginTester
+      def initialize(*plugin_names, settings: {}, host:)
+        @host = host
+        config = Configuration.new
+        config.hosts << @host
+        config.plugins.push(*plugin_names, "testing")
+        config.settings[:application] = "testing"
+        config.settings.merge!(settings)
+        @runtime = config.build_runtime
+      end
+
+      def call_helper(helper, *args, **kwargs)
+        run_task("testing:call_helper", helper, args, kwargs)
+        host.helper_values.pop
+      end
+
+      def run_task(task, *args)
+        capturing_logger_output do
+          runtime.run!(task, *args, privileged: false)
+          nil
+        end
+      end
+
+      def stdout
+        @stdout_io&.string
+      end
+
+      def stderr
+        @stderr_io&.string
+      end
+
+      private
+
+      attr_reader :host, :runtime
+
+      def capturing_logger_output
+        orig_logger = Tomo.logger
+        @stdout_io = StringIO.new
+        @stderr_io = StringIO.new
+        Tomo.logger = Tomo::Logger.new(stdout: @stdout_io, stderr: @stderr_io)
+        yield
+      ensure
+        Tomo.logger = orig_logger
+      end
+    end
+  end
+end

data/lib/tomo/testing/remote_extensions.rb

@@ -0,0 +1,10 @@
+module Tomo
+  module Testing
+    module RemoteExtensions
+      def initialize(*args)
+        super
+        release.merge!(ssh.host.release)
+      end
+    end
+  end
+end

data/lib/tomo/testing/ssh_extensions.rb

@@ -0,0 +1,13 @@
+module Tomo
+  module Testing
+    module SSHExtensions
+      private
+
+      def build_connection(host, options)
+        return super if Testing.ssh_enabled
+
+        Testing::Connection.new(host, options)
+      end
+    end
+  end
+end

data/lib/tomo/testing/tomo_test_ed25519

@@ -0,0 +1,7 @@
+-----BEGIN OPENSSH PRIVATE KEY-----
+b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW
+QyNTUxOQAAACDU7UqhQJMIlzZgNVZf7oGtDF054nePB/NY0X0dJlL3VgAAAJh/FNNRfxTT
+UQAAAAtzc2gtZWQyNTUxOQAAACDU7UqhQJMIlzZgNVZf7oGtDF054nePB/NY0X0dJlL3Vg
+AAAEDHWenvyWnYId1S/v4idksTmU28IntayxXkJUSbcGwETNTtSqFAkwiXNmA1Vl/uga0M
+XTnid48H81jRfR0mUvdWAAAAEHRvbW9AZXhhbXBsZS5jb20BAgMEBQ==
+-----END OPENSSH PRIVATE KEY-----

data/lib/tomo/testing/tomo_test_ed25519.pub

@@ -0,0 +1 @@
+ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINTtSqFAkwiXNmA1Vl/uga0MXTnid48H81jRfR0mUvdW tomo@example.com

data/lib/tomo/testing/ubuntu_setup.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+set -e
+
+export DEBIAN_FRONTEND=noninteractive
+
+# Create `deployer` user
+adduser --disabled-password deployer < /dev/null
+mkdir -p /home/deployer/.ssh
+cp /root/.ssh/authorized_keys /home/deployer/.ssh
+chown -R deployer:deployer /home/deployer/.ssh
+chmod 600 /home/deployer/.ssh/authorized_keys
+mkdir -p /var/www
+chown deployer:deployer /var/www
+
+# Packages needed for ruby, etc.
+apt-get -y update
+apt-get -y install build-essential zlib1g-dev libssl-dev libreadline-dev \
+                   git-core curl locales libsqlite3-dev
+
+apt-get -y install tzdata \
+        -o DPkg::options::="--force-confdef" \
+        -o DPkg::options::="--force-confold"
+
+locale-gen en_US.UTF-8
+
+# Install and configure sshd
+apt-get -y install openssh-server
+echo "Port 22" >> /etc/ssh/sshd_config
+echo "PasswordAuthentication no" >> /etc/ssh/sshd_config
+echo "ChallengeResponseAuthentication no" >> /etc/ssh/sshd_config
+mkdir /var/run/sshd
+chmod 0755 /var/run/sshd

data/lib/tomo/testing.rb

@@ -0,0 +1,39 @@
+require "tomo"
+
+module Tomo
+  module Testing
+    autoload :Connection, "tomo/testing/connection"
+    autoload :DockerImage, "tomo/testing/docker_image"
+    autoload :DockerPluginTester, "tomo/testing/docker_plugin_tester"
+    autoload :HostExtensions, "tomo/testing/host_extensions"
+    autoload :Local, "tomo/testing/local"
+    autoload :MockedExecError, "tomo/testing/mocked_exec_error"
+    autoload :MockPluginTester, "tomo/testing/mock_plugin_tester"
+    autoload :PluginTester, "tomo/testing/plugin_tester"
+    autoload :RemoteExtensions, "tomo/testing/remote_extensions"
+    autoload :SSHExtensions, "tomo/testing/ssh_extensions"
+
+    class << self
+      attr_reader :ssh_enabled
+
+      def enabling_ssh
+        orig_ssh = ssh_enabled
+        @ssh_enabled = true
+        yield
+      ensure
+        @ssh_enabled = orig_ssh
+      end
+    end
+    @ssh_enabled = false
+  end
+end
+
+Tomo.logger = Tomo::Logger.new(
+  stdout: File.open(File::NULL, "w"), stderr: File.open(File::NULL, "w")
+)
+Tomo::Colors.enabled = false
+Tomo::Host.prepend Tomo::Testing::HostExtensions
+Tomo::Remote.prepend Tomo::Testing::RemoteExtensions
+class << Tomo::SSH
+  prepend Tomo::Testing::SSHExtensions
+end

data/lib/tomo/version.rb

@@ -0,0 +1,3 @@
+module Tomo
+  VERSION = "0.1.0".freeze
+end

data/lib/tomo.rb

@@ -0,0 +1,45 @@
+module Tomo
+  autoload :CLI, "tomo/cli"
+  autoload :Colors, "tomo/colors"
+  autoload :Commands, "tomo/commands"
+  autoload :Configuration, "tomo/configuration"
+  autoload :Console, "tomo/console"
+  autoload :Error, "tomo/error"
+  autoload :Host, "tomo/host"
+  autoload :Logger, "tomo/logger"
+  autoload :Path, "tomo/path"
+  autoload :Paths, "tomo/paths"
+  autoload :Plugin, "tomo/plugin"
+  autoload :PluginDSL, "tomo/plugin_dsl"
+  autoload :Remote, "tomo/remote"
+  autoload :Result, "tomo/result"
+  autoload :Runtime, "tomo/runtime"
+  autoload :Script, "tomo/script"
+  autoload :ShellBuilder, "tomo/shell_builder"
+  autoload :SSH, "tomo/ssh"
+  autoload :TaskLibrary, "tomo/task_library"
+  autoload :VERSION, "tomo/version"
+
+  DEFAULT_CONFIG_PATH = ".tomo/config.rb".freeze
+
+  class << self
+    attr_accessor :logger
+    attr_writer :debug, :dry_run
+
+    def debug?
+      !!@debug
+    end
+
+    def dry_run?
+      !!@dry_run
+    end
+
+    def bundled?
+      !!(defined?(Bundler) && ENV["BUNDLE_GEMFILE"])
+    end
+  end
+
+  self.debug = false
+  self.dry_run = false
+  self.logger = Logger.new
+end

metadata

@@ -0,0 +1,308 @@
+--- !ruby/object:Gem::Specification
+name: tomo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Brictson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-ci
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: 
+email:
+- opensource@mattbrictson.com
+executables:
+- tomo
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/tomo
+- lib/tomo.rb
+- lib/tomo/cli.rb
+- lib/tomo/cli/command.rb
+- lib/tomo/cli/common_options.rb
+- lib/tomo/cli/completions.rb
+- lib/tomo/cli/deploy_options.rb
+- lib/tomo/cli/error.rb
+- lib/tomo/cli/interrupted_error.rb
+- lib/tomo/cli/options.rb
+- lib/tomo/cli/parser.rb
+- lib/tomo/cli/project_options.rb
+- lib/tomo/cli/rules.rb
+- lib/tomo/cli/rules/argument.rb
+- lib/tomo/cli/rules/switch.rb
+- lib/tomo/cli/rules/value_switch.rb
+- lib/tomo/cli/rules_evaluator.rb
+- lib/tomo/cli/state.rb
+- lib/tomo/cli/usage.rb
+- lib/tomo/colors.rb
+- lib/tomo/commands.rb
+- lib/tomo/commands/completion_script.rb
+- lib/tomo/commands/default.rb
+- lib/tomo/commands/deploy.rb
+- lib/tomo/commands/help.rb
+- lib/tomo/commands/init.rb
+- lib/tomo/commands/run.rb
+- lib/tomo/commands/setup.rb
+- lib/tomo/commands/tasks.rb
+- lib/tomo/commands/version.rb
+- lib/tomo/configuration.rb
+- lib/tomo/configuration/dsl.rb
+- lib/tomo/configuration/dsl/batch_block.rb
+- lib/tomo/configuration/dsl/config_file.rb
+- lib/tomo/configuration/dsl/environment_block.rb
+- lib/tomo/configuration/dsl/error_formatter.rb
+- lib/tomo/configuration/dsl/hosts_and_settings.rb
+- lib/tomo/configuration/dsl/tasks_block.rb
+- lib/tomo/configuration/environment.rb
+- lib/tomo/configuration/glob.rb
+- lib/tomo/configuration/plugin_file_not_found_error.rb
+- lib/tomo/configuration/plugin_resolver.rb
+- lib/tomo/configuration/plugins_registry.rb
+- lib/tomo/configuration/plugins_registry/file_resolver.rb
+- lib/tomo/configuration/plugins_registry/gem_resolver.rb
+- lib/tomo/configuration/project_not_found_error.rb
+- lib/tomo/configuration/role_based_task_filter.rb
+- lib/tomo/configuration/unknown_environment_error.rb
+- lib/tomo/configuration/unknown_plugin_error.rb
+- lib/tomo/configuration/unspecified_environment_error.rb
+- lib/tomo/console.rb
+- lib/tomo/console/key_reader.rb
+- lib/tomo/console/menu.rb
+- lib/tomo/error.rb
+- lib/tomo/error/suggestions.rb
+- lib/tomo/host.rb
+- lib/tomo/logger.rb
+- lib/tomo/logger/tagged_io.rb
+- lib/tomo/path.rb
+- lib/tomo/paths.rb
+- lib/tomo/plugin.rb
+- lib/tomo/plugin/bundler.rb
+- lib/tomo/plugin/bundler/helpers.rb
+- lib/tomo/plugin/bundler/tasks.rb
+- lib/tomo/plugin/core.rb
+- lib/tomo/plugin/core/helpers.rb
+- lib/tomo/plugin/core/tasks.rb
+- lib/tomo/plugin/env.rb
+- lib/tomo/plugin/env/tasks.rb
+- lib/tomo/plugin/git.rb
+- lib/tomo/plugin/git/helpers.rb
+- lib/tomo/plugin/git/tasks.rb
+- lib/tomo/plugin/nvm.rb
+- lib/tomo/plugin/nvm/tasks.rb
+- lib/tomo/plugin/puma.rb
+- lib/tomo/plugin/puma/tasks.rb
+- lib/tomo/plugin/rails.rb
+- lib/tomo/plugin/rails/helpers.rb
+- lib/tomo/plugin/rails/tasks.rb
+- lib/tomo/plugin/rbenv.rb
+- lib/tomo/plugin/rbenv/tasks.rb
+- lib/tomo/plugin/testing.rb
+- lib/tomo/plugin_dsl.rb
+- lib/tomo/remote.rb
+- lib/tomo/result.rb
+- lib/tomo/runtime.rb
+- lib/tomo/runtime/concurrent_ruby_load_error.rb
+- lib/tomo/runtime/concurrent_ruby_thread_pool.rb
+- lib/tomo/runtime/context.rb
+- lib/tomo/runtime/current.rb
+- lib/tomo/runtime/execution_plan.rb
+- lib/tomo/runtime/host_execution_step.rb
+- lib/tomo/runtime/inline_thread_pool.rb
+- lib/tomo/runtime/privileged_task.rb
+- lib/tomo/runtime/settings_interpolation.rb
+- lib/tomo/runtime/settings_required_error.rb
+- lib/tomo/runtime/task_aborted_error.rb
+- lib/tomo/runtime/task_runner.rb
+- lib/tomo/runtime/unknown_task_error.rb
+- lib/tomo/script.rb
+- lib/tomo/shell_builder.rb
+- lib/tomo/ssh.rb
+- lib/tomo/ssh/child_process.rb
+- lib/tomo/ssh/connection.rb
+- lib/tomo/ssh/connection_error.rb
+- lib/tomo/ssh/connection_validator.rb
+- lib/tomo/ssh/error.rb
+- lib/tomo/ssh/executable_error.rb
+- lib/tomo/ssh/options.rb
+- lib/tomo/ssh/permission_error.rb
+- lib/tomo/ssh/script_error.rb
+- lib/tomo/ssh/unknown_error.rb
+- lib/tomo/ssh/unsupported_version_error.rb
+- lib/tomo/task_library.rb
+- lib/tomo/templates/config.rb.erb
+- lib/tomo/testing.rb
+- lib/tomo/testing/Dockerfile
+- lib/tomo/testing/connection.rb
+- lib/tomo/testing/docker_image.rb
+- lib/tomo/testing/docker_plugin_tester.rb
+- lib/tomo/testing/host_extensions.rb
+- lib/tomo/testing/local.rb
+- lib/tomo/testing/mock_plugin_tester.rb
+- lib/tomo/testing/mocked_exec_error.rb
+- lib/tomo/testing/plugin_tester.rb
+- lib/tomo/testing/remote_extensions.rb
+- lib/tomo/testing/ssh_extensions.rb
+- lib/tomo/testing/tomo_test_ed25519
+- lib/tomo/testing/tomo_test_ed25519.pub
+- lib/tomo/testing/ubuntu_setup.sh
+- lib/tomo/version.rb
+homepage: https://github.com/mattbrictson/tomo
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/mattbrictson/tomo/issues
+  changelog_uri: https://github.com/mattbrictson/tomo/releases
+  source_code_uri: https://github.com/mattbrictson/tomo
+  homepage_uri: https://tomo-deploy.com/
+  documentation_uri: https://tomo-deploy.com/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple SSH-based deployment tool, built for Rails
+test_files: []