aptible-cli 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02557871e371cd47bdc211ea7a52d11587c9c30c
-  data.tar.gz: 3f110a5037e15116cd05b55e591e72decd52b677
+  metadata.gz: a46c716db34062c50939791b35288542ab1dacc4
+  data.tar.gz: 54293b621aba536d05c4ea25740fe61530e9209f
 SHA512:
-  metadata.gz: 235225b2aa1c1935f077efd0f23dd5e1af98d46a1a045ef7d1d4a1da6fb9537de0b347cfb6ce58b90605394c94bcbb78dd8fb4777fb4b36b05050c1615b156a3
-  data.tar.gz: cd51663f95904b23814bfa8d4c1db99357905ca7f4301cb60c5721e70cd8c4568b4a96407cd44e0e805e0e89478412d785949193b97892408f224cc7d4e98403
+  metadata.gz: 35fadaf8062518242be514c26c66f406cb9f3ebf79128986852a4a51ef84365610f5058b90fbdcf426a18e5bfc68d4ec3afd03935b6e08d9955961bc1f24d0bb
+  data.tar.gz: 96a7acb0ac08381a76753035670d6e26f3d72347ce1b5c2f64f7259a960b73ad12de3e35aedd0b30890a7d2701785059f45218a107fc35a6626106875aafe367

data/appveyor.yml

@@ -0,0 +1,31 @@
+version: 1.0.{build}-{branch}
+
+environment:
+  matrix:
+    - RUBY_VERSION: 200
+    - RUBY_VERSION: 21
+    - RUBY_VERSION: 22
+    - RUBY_VERSION: 23
+
+install:
+  # The SSL_CERT_* environment variables are here since otherwise calls to
+  # codecov.io wtill not work. These variables do have to be set in order for
+  # the gem to make calls to the Aptible API, since otherwise Ruby will fail
+  # with a certificate verification error.
+  - set SSL_CERT_DIR=%PROGRAMFILES%\Git\mingw64\ssl\certs
+  - set SSL_CERT_FILE=%PROGRAMFILES%\Git\mingw64\ssl\cert.pem
+  # Override PATHEXT so our ssh bat file has a higher precedence.
+  - set PATHEXT=.BAT;.COM;.EXE;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC
+  - set PATH=C:\Ruby%RUBY_VERSION%-x64\bin;%PATH%
+  - bundle config --local path vendor/bundle
+  - bundle install
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake ci

data/aptible-cli.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'git'
   spec.add_dependency 'term-ansicolor'
   spec.add_dependency 'chronic_duration', '~> 0.10.6'
-
+  spec.add_dependency 'win32-process' if Gem.win_platform?
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'aptible-tasks', '>= 0.2.0'
   spec.add_development_dependency 'rake'

data/lib/aptible/cli/agent.rb

@@ -44,9 +44,19 @@ module Aptible
         true
       end
 
+      def initialize(*)
+        nag_toolbelt unless toolbelt?
+        super
+      end
+
       desc 'version', 'Print Aptible CLI version'
       def version
-        puts "aptible-cli v#{Aptible::CLI::VERSION}"
+        bits = [
+          'aptible-cli',
+          "v#{Aptible::CLI::VERSION}"
+        ]
+        bits << 'toolbelt' if toolbelt?
+        puts bits.join ' '
       end
 
       desc 'login', 'Log in to Aptible'
@@ -104,6 +114,40 @@ module Aptible
         say "DEPRECATION NOTICE: #{msg}"
         say 'Please contact support@aptible.com with any questions.'
       end
+
+      def nag_toolbelt
+        # If you're reading this, it's possible you decided to not use the
+        # toolbelt and are a looking for a way to disable this warning. Look no
+        # further: to do so, edit the file `.aptible/nag_toolbelt` and put a
+        # timestamp far into the future. For example, writing 1577836800 will
+        # disable the warning until 2020.
+        nag_file = File.join ENV['HOME'], '.aptible', 'nag_toolbelt'
+        nag_frequency = 12.hours
+
+        last_nag = begin
+                     Integer(File.read(nag_file))
+                   rescue Errno::ENOENT, ArgumentError
+                     0
+                   end
+
+        now = Time.now.utc.to_i
+
+        if last_nag < now - nag_frequency
+          $stderr.puts yellow([
+            'You have installed the Aptible CLI from source.',
+            'This is not recommended: some functionality may not work!',
+            'Review this support topic for more information:',
+            'https://www.aptible.com/support/topics/cli/how-to-install-cli/'
+          ].join("\n"))
+
+          FileUtils.mkdir_p(File.dirname(nag_file))
+          File.open(nag_file, 'w', 0o600) { |f| f.write(now.to_s) }
+        end
+      end
+
+      def toolbelt?
+        ENV['APTIBLE_TOOLBELT']
+      end
     end
   end
 end

data/lib/aptible/cli/helpers/tunnel.rb

@@ -1,9 +1,27 @@
 require 'socket'
 require 'open3'
+require 'win32-process' if Gem.win_platform?
 
 module Aptible
   module CLI
     module Helpers
+      # The :new_pgroup key specifies the CREATE_NEW_PROCESS_GROUP flag for
+      # CreateProcessW() in the Windows API. This is a Windows only option.
+      # true means the new process is the root process of the new process
+      # group.
+      # This flag is necessary for Process.kill(:SIGINT, pid) on the
+      # subprocess.
+      STOP_SIGNAL = if Gem.win_platform?
+                      :SIGINT
+                    else
+                      :SIGHUP
+                    end
+      SPAWN_OPTS =  if Gem.win_platform?
+                      { new_pgroup: true }
+                    else
+                      {}
+                    end
+
       class Tunnel
         def initialize(env, ssh_cmd)
           @env = env
@@ -37,9 +55,9 @@ module Aptible
 
           out_read, out_write = IO.pipe
           err_read, err_write = IO.pipe
-          @pid = Process.spawn(tunnel_env, *tunnel_cmd, in: :close,
-                                                        out: out_write,
-                                                        err: err_write)
+
+          @pid = Process.spawn(tunnel_env, *tunnel_cmd, SPAWN_OPTS
+            .merge(in: :close, out: out_write, err: err_write))
 
           # Wait for the tunnel to come up before returning. The other end
           # will send a message on stdout to indicate that the tunnel is ready.
@@ -59,7 +77,7 @@ module Aptible
         def stop
           fail 'You must call #start before calling #stop' if @pid.nil?
           begin
-            Process.kill('HUP', @pid)
+            Process.kill(STOP_SIGNAL, @pid)
           rescue Errno::ESRCH
             nil # Dear Rubocop: I know what I'm doing.
           end

data/lib/aptible/cli/subcommands/db.rb

@@ -22,7 +22,7 @@ module Aptible
 
             desc 'db:create HANDLE', 'Create a new database'
             option :type, default: 'postgresql'
-            option :size, default: 10
+            option :size, default: 10, type: :numeric
             option :environment
             define_method 'db:create' do |handle|
               environment = ensure_environment(options)

data/lib/aptible/cli/version.rb

@@ -1,5 +1,5 @@
 module Aptible
   module CLI
-    VERSION = '0.7.4'.freeze
+    VERSION = '0.7.5'.freeze
   end
 end

data/spec/aptible/cli/agent_spec.rb

@@ -7,9 +7,19 @@ describe Aptible::CLI::Agent do
 
   describe '#version' do
     it 'should print the version' do
-      version = Aptible::CLI::VERSION
-      expect(STDOUT).to receive(:puts).with "aptible-cli v#{version}"
-      subject.version
+      ClimateControl.modify(APTIBLE_TOOLBELT: nil) do
+        version = Aptible::CLI::VERSION
+        expect(STDOUT).to receive(:puts).with "aptible-cli v#{version}"
+        subject.version
+      end
+    end
+
+    it 'should print the version (with toolbelt)' do
+      ClimateControl.modify(APTIBLE_TOOLBELT: '1') do
+        version = Aptible::CLI::VERSION
+        expect(STDOUT).to receive(:puts).with "aptible-cli v#{version} toolbelt"
+        subject.version
+      end
     end
   end
 
@@ -158,11 +168,72 @@ describe Aptible::CLI::Agent do
     end
   end
 
+  describe '#nag_toolbelt' do
+    let!(:work_dir) { Dir.mktmpdir }
+    after { FileUtils.remove_entry work_dir }
+    around { |example| ClimateControl.modify(HOME: work_dir) { example.run } }
+
+    let(:nag_dir) { File.join(work_dir, '.aptible') }
+    let(:nag_file) { File.join(nag_dir, 'nag_toolbelt') }
+
+    it 'warns if the nag file is not present' do
+      expect($stderr).to receive(:puts).at_least(:once)
+      subject.send(:nag_toolbelt)
+      expect(Integer(File.read(nag_file))).to be_within(5).of(Time.now.utc.to_i)
+    end
+
+    it 'warns if the nag file contains an old timestamp' do
+      Dir.mkdir(nag_dir)
+      File.open(nag_file, 'w') do |f|
+        f.write((Time.now.utc.to_i - 1.day).to_i.to_s)
+      end
+
+      expect($stderr).to receive(:puts).at_least(:once)
+      subject.send(:nag_toolbelt)
+    end
+
+    it 'does not warn if the nag file contains a recent timestamp' do
+      Dir.mkdir(nag_dir)
+      File.open(nag_file, 'w') do |f|
+        f.write((Time.now.utc.to_i - 3.hours).to_i.to_s)
+      end
+
+      expect($stderr).not_to receive(:puts)
+      subject.send(:nag_toolbelt)
+    end
+
+    it 'does not warn if the nag file contains a recent timestamp (newline)' do
+      # In case a customer writes to the nag file to disable the nag, they're
+      # likely to add a trailing newline. Let's just make sure we support that.
+      Dir.mkdir(nag_dir)
+      File.open(nag_file, 'w') do |f|
+        f.write("#{(Time.now.utc.to_i - 3.hours).to_i}\n")
+      end
+
+      expect($stderr).not_to receive(:puts)
+      subject.send(:nag_toolbelt)
+    end
+
+    it 'warns if the nag file contains an invalid timestamp' do
+      Dir.mkdir(nag_dir)
+      File.open(nag_file, 'w') { |f| f.write('foobar') }
+
+      expect($stderr).to receive(:puts).at_least(:once)
+      subject.send(:nag_toolbelt)
+    end
+
+    it 'is compatible with itself' do
+      expect($stderr).to receive(:puts).once
+      2.times { subject.send(:nag_toolbelt) }
+    end
+  end
+
   context 'load' do
     it 'loads without git' do
       mocks = File.expand_path('../../../mock', __FILE__)
       bins =  File.expand_path('../../../../bin', __FILE__)
-      ClimateControl.modify PATH: [mocks, bins, ENV['PATH']].join(':') do
+      sep = File::PATH_SEPARATOR
+      ClimateControl.modify PATH: [mocks, bins, ENV['PATH']].join(sep) do
         _, _, status = Open3.capture3('aptible version')
         expect(status).to eq(0)
       end

data/spec/aptible/cli/helpers/git_remote_handle_strategy_spec.rb

@@ -1,9 +1,11 @@
 require 'spec_helper'
 
 describe Aptible::CLI::Helpers::App::GitRemoteHandleStrategy do
-  let!(:work_dir) { Dir.mktmpdir }
-  after { FileUtils.remove_entry work_dir }
-  around { |example| Dir.chdir(work_dir) { example.run } }
+  around do |example|
+    Dir.mktmpdir do |work_dir|
+      Dir.chdir(work_dir) { example.run }
+    end
+  end
 
   context 'with git repo' do
     before { `git init` }

data/spec/aptible/cli/helpers/tunnel_spec.rb

@@ -4,7 +4,7 @@ describe Aptible::CLI::Helpers::Tunnel do
   include_context 'mock ssh'
 
   it 'forwards traffic to the remote port given by the server (1234)' do
-    helper = described_class.new({}, ['ssh_mock.rb'])
+    helper = described_class.new({}, ['ssh'])
 
     helper.start(0)
     helper.stop
@@ -23,7 +23,7 @@ describe Aptible::CLI::Helpers::Tunnel do
   end
 
   it 'accepts a desired local port' do
-    helper = described_class.new({}, ['ssh_mock.rb'])
+    helper = described_class.new({}, ['ssh'])
     helper.start(5678)
     helper.stop
 
@@ -35,13 +35,13 @@ describe Aptible::CLI::Helpers::Tunnel do
   end
 
   it 'captures and displays port discovery errors' do
-    helper = described_class.new({ 'FAIL_PORT' => '1' }, ['ssh_mock.rb'])
+    helper = described_class.new({ 'FAIL_PORT' => '1' }, ['ssh'])
     expect { helper.start }
       .to raise_error(/Failed to request.*Something went wrong/m)
   end
 
   it 'captures and displays tunnel errors' do
-    helper = described_class.new({ 'FAIL_TUNNEL' => '1' }, ['ssh_mock.rb'])
+    helper = described_class.new({ 'FAIL_TUNNEL' => '1' }, ['ssh'])
     expect { helper.start(0) }
       .to raise_error(/Tunnel did not come up.*Something went wrong/m)
   end

data/spec/mock/ssh.bat

@@ -0,0 +1,2 @@
+@echo off
+ruby.exe %cd%\spec\mock\ssh_mock.rb %*

data/spec/shared/mock_ssh_context.rb

@@ -9,7 +9,7 @@ shared_context 'mock ssh' do
   around do |example|
     mocks_path = File.expand_path('../../mock', __FILE__)
     env = {
-      PATH: "#{mocks_path}:#{ENV['PATH']}",
+      PATH: "#{mocks_path}#{File::PATH_SEPARATOR}#{ENV['PATH']}",
       SSH_MOCK_OUTFILE: ssh_mock_outfile.path
     }
 

data/spec/spec_helper.rb

@@ -21,4 +21,10 @@ require 'aptible/cli'
 
 RSpec.configure do |config|
   config.before {}
+
+  # We make the CLI believe it's running in a toolbelt context to avoid running
+  # the toolbelt nag every time it initializes.
+  config.around(:each) do |example|
+    ClimateControl.modify(APTIBLE_TOOLBELT: '1') { example.run }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptible-cli
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Frank Macreery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aptible-api
@@ -222,6 +222,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- appveyor.yml
 - aptible-cli.gemspec
 - bin/aptible
 - codecov.yml
@@ -266,6 +267,7 @@ files:
 - spec/fabricators/vhost_fabricator.rb
 - spec/mock/git
 - spec/mock/ssh
+- spec/mock/ssh.bat
 - spec/mock/ssh_mock.rb
 - spec/shared/mock_ssh_context.rb
 - spec/spec_helper.rb
@@ -315,6 +317,7 @@ test_files:
 - spec/fabricators/vhost_fabricator.rb
 - spec/mock/git
 - spec/mock/ssh
+- spec/mock/ssh.bat
 - spec/mock/ssh_mock.rb
 - spec/shared/mock_ssh_context.rb
 - spec/spec_helper.rb