mina 1.2.4 → 1.2.5

data/lib/mina/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mina
   class Configuration
     include Singleton
@@ -6,7 +8,7 @@ module Mina
     module DSL
       def self.included(base)
         [:set, :fetch, :remove, :set?, :ensure!, :reset!].each do |method|
-          base.send :define_method, method do |*args,  &block|
+          base.send :define_method, method do |*args, &block|
             Configuration.instance.send(method, *args, &block)
           end
         end
@@ -16,7 +18,7 @@ module Mina
     attr_reader :variables
 
     def initialize
-      @variables ||= {}
+      @variables = {}
     end
 
     def set(key, value = nil, &block)
@@ -33,11 +35,12 @@ module Mina
     end
 
     def set?(key)
-      ENV.has_key?(key.to_s) || !variables.fetch(key, nil).nil?
+      ENV.key?(key.to_s) || !variables.fetch(key, nil).nil?
     end
 
     def ensure!(key, message: nil)
       return if set?(key)
+
       message ||= "#{key} must be defined!"
       error! message
     end

data/lib/mina/dsl.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 module Mina
   module DSL
-    attr_reader :commands
-
     extend Forwardable
     def_delegators :configuration, :fetch, :set, :set?, :ensure!
     def_delegators :commands, :command, :comment

data/lib/mina/helpers/internal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mina
   module Helpers
     module Internal
@@ -8,7 +10,7 @@ module Mina
         erb fetch(:deploy_script)
       end
 
-      def erb(file, b = binding)
+      def erb(file, b = binding) # rubocop:disable Naming/MethodParameterName
         require 'erb'
         erb = ERB.new(File.read(file))
         erb.result b
@@ -16,7 +18,7 @@ module Mina
 
       def echo_cmd(code, ignore_verbose = false)
         if fetch(:verbose) && !ignore_verbose
-          "echo #{Shellwords.escape('$ ' + code)} &&\n#{code}"
+          "echo #{Shellwords.escape("$ #{code}")} &&\n#{code}"
         else
           code
         end
@@ -27,9 +29,7 @@ module Mina
       end
 
       def unindent(code)
-        if code =~ /^\n([ \t]+)/
-          code = code.gsub(/^#{$1}/, '')
-        end
+        code = code.gsub(/^#{Regexp.last_match(1)}/, '') if code =~ /^\n([ \t]+)/
 
         code.strip
       end
@@ -37,18 +37,18 @@ module Mina
       def report_time
         time_start = Time.now
         output = yield
-        print_info "Elapsed time: %.2f seconds" % [Time.now - time_start] unless fetch(:skip_report_time)
+        print_info format('Elapsed time: %.2f seconds', Time.now - time_start) unless fetch(:skip_report_time)
         output
       end
 
       def next_version
         case fetch(:version_scheme)
         when :datetime
-          Time.now.utc.strftime("%Y%m%d%H%M%S")
+          Time.now.utc.strftime('%Y%m%d%H%M%S')
         when :sequence
           "$((`ls -1 #{fetch(:releases_path)} | sort -n | tail -n 1`+1))"
         else
-          error! 'Unrecognizes version scheme. Use :datetime or :sequence'
+          error! 'Unrecognized version scheme. Use :datetime or :sequence'
         end
       end
 

data/lib/mina/helpers/output.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Mina
   module Helpers
     module Output
       def print_line(line)
         case line
-        when /^\-+> (.*?)$/
+        when /^-+> (.*?)$/
           print_status Regexp.last_match[1]
         when /^! (.*?)$/
           print_error Regexp.last_match[1]
@@ -42,8 +44,8 @@ module Mina
         puts "       #{msg}"
       end
 
-      def color(str, c)
-        ENV['NO_COLOR'] ? str : "\033[#{c}m#{str}\033[0m"
+      def color(str, color)
+        ENV['NO_COLOR'] ? str : "\033[#{color}m#{str}\033[0m"
       end
     end
   end

data/lib/mina/runner/exec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mina
   class Runner
     class Exec

data/lib/mina/runner/pretty.rb

@@ -1,45 +1,51 @@
+# frozen_string_literal: true
+
 module Mina
   class Runner
     class Pretty
       include Mina::Helpers::Output
 
-      attr_reader :script, :coathooks
+      attr_reader :script
 
       def initialize(script)
         @script = Shellwords.shellsplit(script)
         @coathooks = 0
       end
 
-      def run
-        status =
-          Open4.popen4(*script) do |pid, _stdin, stdout, stderr|
-            # Handle `^C`.
-            trap('INT') { handle_sigint(pid) }
+      def run # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        exit_status = nil
 
-            stdout_thread = Thread.new do
-              while (line = stdout.gets)
-                print_line(line)
-              end
-            end
+        Open3.popen3(*script) do |_stdin, stdout, stderr, wait_thr|
+          pid = wait_thr.pid
 
-            stderr_thread = Thread.new do
-              while (line = stderr.gets)
-                print_stderr(line)
-              end
+          trap('INT') { handle_sigint(pid) }
+
+          stdout_thread = Thread.new do
+            while (line = stdout.gets)
+              print_line(line)
             end
+          end
 
-            stdout_thread.join
-            stderr_thread.join
+          stderr_thread = Thread.new do
+            while (line = stderr.gets)
+              print_stderr(line)
+            end
           end
 
-        status.exitstatus == 0
+          stdout_thread.join
+          stderr_thread.join
+
+          exit_status = wait_thr.value
+        end
+
+        exit_status.success?
       end
 
       private
 
       def handle_sigint(pid)
         puts ''
-        if coathooks > 1
+        if @coathooks > 1
           print_status 'Mina: SIGINT received again. Force quitting...'
           Process.kill 'KILL', pid
         else

data/lib/mina/runner/printer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mina
   class Runner
     class Printer

data/lib/mina/runner/system.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mina
   class Runner
     class System

data/lib/mina/runner.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 module Mina
   class Runner
     attr_reader :commands, :backend
+
     include Configuration::DSL
 
     def initialize(commands, backend)
       fail 'You must specify execution mode' if execution_mode.nil?
-      fail 'Unsuported execution mode (pretty on windows)' if unsuported_execution_mode?
+
       @backend = backend
       @commands = commands
     end
@@ -16,11 +19,11 @@ module Mina
 
     def execution_mode
       @execution_mode ||=
-      if fetch(:simulate)
-        :printer
-      else
-        fetch(:execution_mode)
-      end
+        if fetch(:simulate)
+          :printer
+        else
+          fetch(:execution_mode)
+        end
     end
 
     private
@@ -29,10 +32,6 @@ module Mina
       Mina::Backend.const_get(class_name_for(backend)).new(commands).prepare
     end
 
-    def unsuported_execution_mode?
-      execution_mode == :pretty && Gem::Platform.local.os == :windows
-    end
-
     def class_name_for(symbol)
       symbol.to_s.split('_').map(&:capitalize).join
     end

data/lib/mina/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mina
-  VERSION = '1.2.4'.freeze
+  VERSION = '1.2.5'
 end

data/lib/mina/windows_patches.rb

@@ -1,10 +1,12 @@
-#if windows os
+# frozen_string_literal: true
+
+# if windows os
 require 'rbconfig'
 is_windows = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
 if is_windows
   module Shellwords
     def shellescape(str)
-      '"' + str.gsub(/\\(?=\\*\")/, "\\\\\\").gsub(/\"/, "\\\"").gsub(/\\$/, "\\\\\\").gsub("%", "%%") + '"'
+      "\"#{str.gsub(/\\(?=\\*")/, '\\\\\\').gsub(/"/, '\\"').gsub(/\\$/, '\\\\\\').gsub('%', '%%')}\""
     end
 
     module_function :shellescape

data/lib/mina.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 require 'rake'
 Rake.application.options.trace = true
 
 # require 'pry'
-# require 'awesome_print'
 
 require 'forwardable'
 require 'shellwords'
 require 'singleton'
-require 'open4'
+require 'open3'
 
 require 'mina/version'
 require 'mina/helpers/output'
@@ -27,6 +28,6 @@ require 'mina/application'
 
 module Mina
   def self.root_path(*args)
-    File.join File.expand_path('../../', __FILE__), *args
+    File.join File.expand_path('..', __dir__), *args
   end
 end

data/mina.gemspec

@@ -1,7 +1,9 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-tasks = File.expand_path('../tasks', __FILE__)
+tasks = File.expand_path('tasks', __dir__)
 $LOAD_PATH.unshift(tasks) unless $LOAD_PATH.include?(tasks)
 
 require 'mina/version'
@@ -20,10 +22,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib', 'tasks']
 
   spec.add_dependency 'rake'
-  spec.add_dependency 'open4', '~> 1.3.4'
-  spec.add_development_dependency 'rspec', '~> 3.5.0'
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/spec/configs/default.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+set :simulate, true
+set :domain, 'localhost'
+set :deploy_to, "#{Dir.pwd}/deploy"
+set :repository, Mina.root_path.to_s
+set :shared_paths, ['config/database.yml', 'log']
+set :keep_releases, 2

data/spec/configs/dsl.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+task :reset_task do
+  command 'echo Hello there'
+  reset!
+  command 'echo New command'
+end
+
+task :one_run_inside_another do
+  run :local do
+    run :remote do
+      puts "I shouldn't execute"
+    end
+  end
+end
+
+task :local_run do
+  run :local do
+    comment 'I am a comment'
+    command 'echo Hello there'
+  end
+end
+
+task :remote_run do
+  run :remote do
+    comment 'I am a comment'
+    command 'echo Hello there'
+  end
+end
+
+task :nonexistent_run do
+  run :nonexistent do
+    comment "I shouldn't run"
+  end
+end
+
+task :on_stage_task do
+  deploy do
+    on :launch do
+      command 'echo Hello there'
+    end
+  end
+end
+
+task :in_path_task do
+  in_path '/path' do
+    command 'echo Hello there'
+  end
+end
+
+task :deploy_block_task do
+  deploy do
+    command 'echo Hello there'
+  end
+end

data/spec/configs/e2e.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'mina/git'
+
+set :simulate, false
+set :user, 'mina-ssh'
+set :domain, '0.0.0.0'
+set :port, 2222
+set :deploy_to, '/app'
+
+set :repository, 'https://github.com/mina-deploy/mina.git'
+set :branch, 'master'
+
+set :identity_file, 'spec/e2e/ssh'
+
+set :ssh_options, '-o StrictHostKeyChecking=no'
+
+desc 'Deploys to the server'
+task :e2e_deploy do
+  deploy do
+    invoke :'git:clone'
+    invoke :'deploy:link_shared_paths'
+    invoke :'deploy:cleanup'
+  end
+end

data/spec/e2e/docker-compose.yml

@@ -0,0 +1,21 @@
+version: '3.8'
+services:
+  mina-ssh:
+    image: ghcr.io/linuxserver/openssh-server
+    container_name: mina-ssh
+    hostname: mina-ssh
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - TZ=UTC
+      - PUBLIC_KEY
+      - SUDO_ACCESS=true
+      - USER_NAME=mina-ssh
+    ports:
+      - 2222:2222
+    command: >
+      sh -c "
+        apk update && apk add git ruby && gem install bundler &&
+        touch /tmp/ready.txt &&
+        tail -f /dev/null
+      "

data/spec/e2e/e2e_run.sh

@@ -0,0 +1,11 @@
+cd spec/e2e/
+chmod 600 ssh
+PUBLIC_KEY="$(cat ssh.pub)" docker-compose up -d mina-ssh \
+  && docker exec mina-ssh sh -c "while [ ! -f /tmp/ready.txt ]; do sleep 2; done"
+cd -
+[[ -z "${CI}" ]] && ssh-keygen -R \[0.0.0.0\]:2222
+bundle exec rspec --tag e2e --order defined
+status=$?
+cd spec/e2e
+docker-compose down
+exit $status

data/spec/e2e/e2e_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# IMPORTANT: run only through e2e_run.sh script
+describe 'E2E tests', :e2e, type: :rake do
+  before do
+    load_config 'e2e'
+  end
+
+  describe 'deploy without setup' do
+    it 'exits with an error message' do
+      expect do
+        rake.run(['e2e_deploy'])
+      end.to raise_error(SystemExit)
+         .and output(output_file('e2e_deploy_without_setup')).to_stdout
+    end
+  end
+
+  describe 'setup' do
+    it 'sets up directories' do
+      expect do
+        rake.run(['setup'])
+      end.to output(output_file('e2e_setup')).to_stdout
+    end
+  end
+
+  describe 'deploy after setup' do
+    it 'deploys the app' do
+      expect do
+        rake.run(['e2e_deploy'])
+      end.to output(output_file('e2e_deploy_after_setup')).to_stdout
+    end
+  end
+end

data/spec/e2e/ssh

@@ -0,0 +1,27 @@
+-----BEGIN OPENSSH PRIVATE KEY-----
+b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABFwAAAAdzc2gtcn
+NhAAAAAwEAAQAAAQEAskzzKcHPV/0n84dIXUKO3q/s4MX8+R+ogsbbEr/XRo0e2BtEmD52
+VLEJczYaxICqTOmlOvyx0oWOSPbim6Cpq6YskbxVaUqYSdzafdRXmc3+6BSXgGZH3dHWYc
+2vQFx01PVRXdb4EwQBwmCLX7v7+/OxXVq5MHxxXNHblut2c//Udp53F5fVm3WgE3iTIpxL
+0h/0H25kaE0HyZrFhFdPItAu/owkOhra6yX1PE8vcyQRs7d9uWwd3n+odCjwhTJ3431PFJ
+SyCSTCKbDGMIB44E85e6Vr4EK9Xjrxb6Zrc8ayg4GEX9jqpltjup9vWKhdM7q4vrkEK2uC
+lYGurnfEAwAAA8ilS5nwpUuZ8AAAAAdzc2gtcnNhAAABAQCyTPMpwc9X/Sfzh0hdQo7er+
+zgxfz5H6iCxtsSv9dGjR7YG0SYPnZUsQlzNhrEgKpM6aU6/LHShY5I9uKboKmrpiyRvFVp
+SphJ3Np91FeZzf7oFJeAZkfd0dZhza9AXHTU9VFd1vgTBAHCYItfu/v787FdWrkwfHFc0d
+uW63Zz/9R2nncXl9WbdaATeJMinEvSH/QfbmRoTQfJmsWEV08i0C7+jCQ6GtrrJfU8Ty9z
+JBGzt325bB3ef6h0KPCFMnfjfU8UlLIJJMIpsMYwgHjgTzl7pWvgQr1eOvFvpmtzxrKDgY
+Rf2OqmW2O6n29YqF0zuri+uQQra4KVga6ud8QDAAAAAwEAAQAAAQA7oVyZlIXhqXrZCV98
+QSxC8ZdJPS3zq1DSG+tcg+hdYgj0wXnZaNpuTJ8advfQzC8odeOarLRT8fK6GEeFQOA91d
++GBfSSuC3iVgiEmKWLfMdJmsloWcyjNPB72SxJXCJ+rmS9+40P3wEvntY9+EK36rJgxFy3
+CIdpQY4tFSaSeGgEWvyhoUjad5OOZhW6zy1D5bOQX9mxCjTIJ+LqIKgUK50gv2zBt8lOTu
++g4aw4gQoFPoX7tOqD0GAt0Q2NdogugFyWfIumBv6RCeHvxpbwYhIrhucsACbCgjydnLNa
+chcZfR+DNQeezq0l6vpIuCCqWxVXHYQLMizvW9MuIcQhAAAAgAxkO1gv7AiRjL0UJcIxQ9
+Ec9okq+MXgyRJxLL1x1r/sVqkCUXzf95O9fB/uJEQx6V/Uok4NN2m9lhRhSbu2dfrwq3dI
+Xxe0/l7pS0p67nIrvROPBcnQOGGcPVNxwvjD+fC3dBwiFjh08qXA47v8ddu4MujgIWkFaX
+oGxXMr2ijcAAAAgQDbNTsd/YsldmSpRTlPd/tyu+VyZ8afRNpRqTZki3J+LcJ8CoET7DLA
+EHPXqaNWyEuLRjrZx6CdlbVrZvoU4k4TftrRMq177DNP7WBCvha3eZhZg2EA4MVG2j2iP2
+VtXtEjdWHNYwHUBMj6IXDxQuAQvXsQPTQ4h2kt7GG5/Wdw2QAAAIEA0DoKl7jfsQMSn1LR
+csvP3tIfmj6KqboetjFABLloKnxVa/tlJRTJHiuWgUZQ9sCyI4rYAnSfZS2uppDBHvn/9f
+uOV8XPu7N3Vm/jP5E97JUGaJUjnNZWiWHxUAf9VM2r7x2V4VvEn98xDKSObciSz9rosXlJ
+POFxW7iCkxhNkjsAAAANbWluYS1lMmUtdGVzdAECAwQFBg==
+-----END OPENSSH PRIVATE KEY-----

data/spec/e2e/ssh.pub

@@ -0,0 +1 @@
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyTPMpwc9X/Sfzh0hdQo7er+zgxfz5H6iCxtsSv9dGjR7YG0SYPnZUsQlzNhrEgKpM6aU6/LHShY5I9uKboKmrpiyRvFVpSphJ3Np91FeZzf7oFJeAZkfd0dZhza9AXHTU9VFd1vgTBAHCYItfu/v787FdWrkwfHFc0duW63Zz/9R2nncXl9WbdaATeJMinEvSH/QfbmRoTQfJmsWEV08i0C7+jCQ6GtrrJfU8Ty9zJBGzt325bB3ef6h0KPCFMnfjfU8UlLIJJMIpsMYwgHjgTzl7pWvgQr1eOvFvpmtzxrKDgYRf2OqmW2O6n29YqF0zuri+uQQra4KVga6ud8QD mina-e2e-test

data/spec/lib/mina/application_spec.rb

@@ -1,39 +1,98 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Mina::Application do
-  # let(:app) { Rake.application }
-  #
-  # %w(quiet silent dry-run).each do |switch|
-  #   it "doesn't include --#{switch} in help" do
-  #     binding.pry
-  #     expect(out).not_to match(/--#{switch}/)
-  #   end
-  # end
-  #
-  # it 'runs adds two default tasks to the task list' do
-  #   expect(subject.top_level_tasks).to include(:debug_configuration_variables)
-  #   expect(subject.top_level_tasks).to include(:run_commands)
-  # end
-  #
-  # it 'overrides the rake method, but still prints the rake version' do
-  #   out = capture_io do
-  #     flags '--version', '-V'
-  #   end
-  #   expect(out).to match(/\bMina, version\b/)
-  #   expect(out).to match(/\bv#{Mina::VERSION}\b/)
-  # end
-  #
-  # it 'enables simulation mode, and sets the backend Mina::Runner::Printer' do
-  #   capture_io do
-  #     flags '--simulate', '-s'
-  #   end
-  #   expect(Mina::Configuration.instance.fetch(:simulate)).to be true
-  # end
-  #
-  # it 'enables printing all config variables on command line parameter' do
-  #   capture_io do
-  #     flags '--debug-configuration-variables', '-d'
-  #   end
-  #   expect(Mina::Configuration.instance.fetch(:debug_configuration_variables)).to be true
-  # end
+  subject(:application) { described_class.new }
+
+  describe '#top_level_tasks' do
+    let(:default_tasks) { ['debug_configuration_variables', 'run_commands'] }
+
+    context 'when `init` task is added' do
+      it 'removes default tasks' do
+        expect do
+          application.collect_command_line_tasks(['init'])
+        end.to change(application, :top_level_tasks).from(default_tasks).to(['init'])
+      end
+    end
+
+    context "when `init` task isn't added" do
+      it 'keeps default tasks' do
+        expect do
+          application.collect_command_line_tasks(['a_task'])
+        end.to change(application, :top_level_tasks).from(default_tasks).to(['a_task', *default_tasks])
+      end
+    end
+  end
+
+  describe 'command-line options' do
+    ['--version', '-V'].each do |option|
+      describe option do
+        it 'prints Mina version and exits' do
+          expect do
+            application.handle_options([option])
+          end.to raise_error(SystemExit)
+             .and output("Mina, version v#{Mina::VERSION}\n").to_stdout
+        end
+      end
+    end
+
+    ['--verbose', '-v'].each do |option|
+      describe option do
+        it 'sets verbose flag to true' do
+          expect do
+            application.handle_options([option])
+          end.to change { application.fetch(:verbose) }.from(nil).to(true)
+        end
+      end
+    end
+
+    ['--simulate', '-s'].each do |option|
+      describe option do
+        it 'sets simulate flag to true' do
+          expect do
+            application.handle_options([option])
+          end.to change { application.fetch(:simulate) }.from(nil).to(true)
+        end
+      end
+    end
+
+    ['--debug-configuration-variables', '-d'].each do |option|
+      describe option do
+        it 'sets debug_configuration_variables flag to true' do
+          expect do
+            application.handle_options([option])
+          end.to change { application.fetch(:debug_configuration_variables) }.from(nil).to(true)
+        end
+      end
+    end
+
+    describe '--no-report-time' do
+      it 'sets skip_report_time flag to true' do
+        expect do
+          application.handle_options(['--no-report-time'])
+        end.to change { application.fetch(:skip_report_time) }.from(nil).to(true)
+      end
+    end
+  end
+
+  describe 'Rake options' do
+    let(:options) { application.standard_rake_options }
+
+    it 'shows --verbose' do
+      expect(options.any? { |(switch, *)| switch == '--verbose' }).to eq(true)
+    end
+
+    it "doesn't show --dry-run" do
+      expect(options.any? { |(switch, *)| switch == '--dry-run' }).to eq(false)
+    end
+
+    it "doesn't show --quiet" do
+      expect(options.any? { |(switch, *)| switch == '--quiet' }).to eq(false)
+    end
+
+    it "doesn't show --silent" do
+      expect(options.any? { |(switch, *)| switch == '--silent' }).to eq(false)
+    end
+  end
 end