kontena-cli 1.5.0.pre1 → 1.5.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d3147d4def0570ae7d592b83163f2a55bebcf939901adba261c18a78e3189e7
-  data.tar.gz: c6a3f61cfc69c56a62b1ae5e75ca45c5880937d8861a5e65c2f3074981070a44
+  metadata.gz: 74f6386b28ddbc26a54ac61391df25e03f771574faddad0d8ea24731bd8bd561
+  data.tar.gz: 7c2563acbae96b3e5658715395990677c8ccb06ca326df05badae5359a9803d3
 SHA512:
-  metadata.gz: 7c1b25a00c0c46e046d62d530a316d77949b766c6272b8bf56685fdb6ce902c1a7ed29b527b5ab18f985fa7adac46f95e42b1c6e74b04bea7916d362490290cb
-  data.tar.gz: dc54b0386062eea65878e11b0339658091afbfafa5beb45241ce46507c9dd3c4889897b653557cabc520593151faa4e213fd16138d15c3a548a9b67fb31bfd85
+  metadata.gz: acc350ae3e7ee4c98925a6777fba1ed1f668b6b0107ed7ed3309a57bedd46f3aa9b650c757429697e6ce361e3553fc1dd25b1e313b93791ef5b76b6a8a1fbee5
+  data.tar.gz: 96aa693a16692716d4510ab1c3c265a696c8f087cb1f6f5f2fcf712507b4e1cf5b12b47040b80ded854ef500fe88248a221400b58108e7b1ec5b94f088cd0276

data/.gitignore

@@ -15,3 +15,5 @@ mkmf.log
 .idea
 *.gem
 /vendor/
+.ruby-version
+.ruby-gemset

data/VERSION

@@ -1 +1 @@
-1.5.0.pre1
+1.5.0.pre2

data/bin/kontena

@@ -13,8 +13,10 @@ if ARGV[0] == 'complete'
   $VERSION_WARNING_ADDED=true
   require 'kontena/scripts/completer'
 else
-  ENV['DEBUG'] = "true" if ARGV.any? { |arg| arg == '-D' || arg == '--debug'}
-  ENV['DEBUG'] = "false" if ARGV.any? { |arg| arg == '--no-debug' }
+
+  arg_end_idx = ARGV.index('--') || ARGV.size
+  ENV['DEBUG'] = "true" if ARGV[0..arg_end_idx].any? { |arg| arg == '-D' || arg == '--debug'}
+  ENV['DEBUG'] = "false" if ARGV[0..arg_end_idx].any? { |arg| arg == '--no-debug' }
   require 'kontena_cli'
   Kontena::PluginManager.init unless ENV['NO_PLUGINS']
   Kontena::MainCommand.run

data/lib/kontena/callback.rb

@@ -22,14 +22,17 @@ class Kontena::Callback
       else
         cmd_type = cmd_type.to_sym
       end
-      cmd_types[cmd_class.to_sym] = cmd_type
+      cmd_types[cmd_class.to_sym] ||= []
+      cmd_types[cmd_class.to_sym] << cmd_type
     end
 
     # Finally it should be normalized into a hash that looks like :cmd_class => :cmd_type, :app => :init, :grid => :all
-    cmd_types.each do |cmd_class, cmd_type|
-      Kontena::Callback.callbacks[cmd_class] ||= {}
-      Kontena::Callback.callbacks[cmd_class][cmd_type] ||= []
-      Kontena::Callback.callbacks[cmd_class][cmd_type] << self
+    cmd_types.each do |cmd_class, cmd_types|
+      cmd_types.each do |cmd_type|
+        Kontena::Callback.callbacks[cmd_class] ||= {}
+        Kontena::Callback.callbacks[cmd_class][cmd_type] ||= []
+        Kontena::Callback.callbacks[cmd_class][cmd_type] << self
+      end
     end
   end
 

data/lib/kontena/cli/containers/exec_command.rb

@@ -6,6 +6,8 @@ module Kontena::Cli::Containers
     include Kontena::Cli::GridOptions
     include Kontena::Cli::Helpers::ExecHelper
 
+    usage "[OPTIONS] [CONTAINER_ID] -- [CMD] ..."
+
     parameter "CONTAINER_ID", "Container id"
     parameter "CMD ...", "Command"
 

data/lib/kontena/cli/grids/remove_command.rb

@@ -5,13 +5,13 @@ module Kontena::Cli::Grids
     include Kontena::Cli::Common
     include Common
 
-    parameter "NAME ...", "Grid name", attribute_name: :grids
+    parameter "NAME ...", "Grid name"
     option "--force", :flag, "Force remove", default: false, attribute_name: :forced
 
     def execute
       require_api_url
       token = require_token
-      grids.each do |name|
+      name_list.each do |name|
         confirm_command(name) unless forced?
         grid = find_grid_by_name(name)
 

data/lib/kontena/cli/master/ssh_command.rb

@@ -2,9 +2,10 @@ require 'kontena/plugin_manager'
 
 module Kontena::Cli::Master
   class SshCommand < Kontena::Command
-
     include Kontena::Cli::Common
 
+    usage "[OPTIONS] -- [COMMANDS] ..."
+
     parameter "[COMMANDS] ...", "Run command on host"
 
     option ["-i", "--identity-file"], "IDENTITY_FILE", "Path to ssh private key"
@@ -56,7 +57,12 @@ module Kontena::Cli::Master
     end
 
     def run_vagrant_ssh
-      Kontena.run!(['vagrant', 'master', 'ssh'] + commands_list)
+      cmd = %w(vagrant master ssh)
+      unless commands_list.empty?
+        cmd << '--'
+        cmd.concat commands_list
+      end
+      Kontena.run!(cmd)
     end
 
     def execute

data/lib/kontena/cli/nodes/ssh_command.rb

@@ -5,6 +5,8 @@ module Kontena::Cli::Nodes
     include Kontena::Cli::Common
     include Kontena::Cli::GridOptions
 
+    usage "[OPTIONS] [NODE] -- [COMMANDS] ..."
+
     parameter "[NODE]", "SSH to Grid node. Use --any to connect to the first available node"
     parameter "[COMMANDS] ...", "Run command on host"
     option ["-a", "--any"], :flag, "Connect to first available node"
@@ -35,7 +37,11 @@ module Kontena::Cli::Nodes
         unless Kontena::PluginManager::Common.installed?('vagrant')
           exit_with_error 'You need to install vagrant plugin to ssh into this node. Use kontena plugin install vagrant'
         end
-        cmd = ['vagrant', 'node', 'ssh', node['name']] + commands_list
+        cmd = ['vagrant', 'node', 'ssh', node['name']]
+        unless commands_list.empty?
+          cmd << '--'
+          cmd.concat(commands_list)
+        end
         Kontena.run!(cmd)
       else
         cmd = ['ssh']
@@ -49,6 +55,7 @@ module Kontena::Cli::Nodes
         end
         cmd << "#{user}@#{ip}"
         cmd += commands_list
+        logger.debug { "Running ssh command: #{cmd.inspect}" }
         exec(*cmd)
       end
     end

data/lib/kontena/cli/services/exec_command.rb

@@ -19,6 +19,8 @@ module Kontena::Cli::Services
       end
     end
 
+    usage "[OPTIONS] [NAME] -- [CMD] ..."
+
     parameter "NAME", "Service name"
     parameter "CMD ...", "Command"
 

data/lib/kontena/cli/stacks/yaml/validator_v3.rb

@@ -66,9 +66,18 @@ module Kontena::Cli::Stacks
           end
         end
 
+        if yaml.key?('stack')
+          unless yaml['stack'] =~ /\A(?:.+?\/)?(?!-)[a-z0-9\-]+\z/
+            result[:notifications] << { 'stack' => 'A stack name should only include a-z, 0-9 and - characters and not start with the - character' }
+          end
+        end
+
         if yaml.key?('services')
           if yaml['services'].kind_of?(Hash)
             yaml['services'].each do |service, options|
+              unless service =~ /\A(?!-)[a-z0-9\-]+\z/
+                result[:notifications] << { 'services' => { service => { 'name' => 'A service name should only include a-z, 0-9 and - characters and not start with the - character' } } }
+              end
               unless options.kind_of?(Hash)
                 result[:errors] << { 'services' => { service => { 'options' => "must be a mapping not a #{options.class}"}  } }
                 next

data/lib/kontena/command.rb

@@ -5,8 +5,9 @@ require 'kontena/cli/bytes_helper'
 require 'kontena/cli/grid_options'
 require 'excon/error'
 
-class Kontena::Command < Clamp::Command
+Clamp.allow_options_after_parameters = true
 
+class Kontena::Command < Clamp::Command
   option ['-D', '--[no-]debug'], :flag, "Enable debug", environment_variable: 'DEBUG', attribute_name: :debug_option do |debug|
     unless debug.kind_of?(String)
       ENV['DEBUG'] = debug.to_s

data/omnibus/config/software/kontena-cli.rb

@@ -13,7 +13,7 @@ build do
   gem "install rb-readline -v 0.5.4 -N", env: env
   gem "install nokogiri -v 1.8.2 -N", env: env
   gem "build kontena-cli.gemspec", env: env, cwd: File.expand_path('..', Omnibus::Config.project_root)
-  gem "install -N #{Dir[File.expand_path('../kontena-cli-%s.gem' % default_version, Omnibus::Config.project_root)].first}", env: env
+  gem "install -N kontena-cli-%s.gem" % default_version, env: env, cwd: File.expand_path('..', Omnibus::Config.project_root)
   gem "install kontena-plugin-cloud -N", env: env
   copy "sh/kontena", "#{install_dir}/bin/kontena"
 end

data/spec/kontena/cli/grids/remove_command_spec.rb

@@ -0,0 +1,28 @@
+require 'kontena/cli/grids/remove_command'
+
+describe Kontena::Cli::Grids::RemoveCommand do
+  include ClientHelpers
+
+  before do
+    # Kontena::Cli::Grids::Common#grids
+    allow(client).to receive(:get).with('grids').and_return('grids' => grids)
+  end
+
+  context 'without any grids' do
+    let(:grids) { [] }
+
+    it 'errors out' do
+      expect{subject.run ['--force', 'test-grid']}.to exit_with_error.and output(/Could not resolve grid by name/).to_stderr
+    end
+  end
+
+  context 'with a grid' do
+    let(:grids) { [{'id' => 'test-grid', 'name' => 'test-grid'}] }
+
+    it 'deletes the grid' do
+      expect(client).to receive(:delete).with('grids/test-grid')
+
+      subject.run ['--force', 'test-grid']
+    end
+  end
+end

data/spec/kontena/cli/nodes/ssh_command_spec.rb

@@ -20,7 +20,7 @@ describe Kontena::Cli::Nodes::SshCommand do
     context 'used together with a node name' do
       it "fails and outputs an error message" do
         expect(subject).to_not receive(:exec)
-        expect{subject.run(['--any', 'ls', '-l'])}.to exit_with_error.and output(/Cannot combine --any with a node name/).to_stderr
+        expect{subject.run(['--any', '--', 'ls', '-l'])}.to exit_with_error.and output(/Cannot combine --any with a node name/).to_stderr
       end
     end
 
@@ -53,11 +53,11 @@ describe Kontena::Cli::Nodes::SshCommand do
 
   it "passes through the command to SSH" do
     expect(subject).to receive(:exec).with('ssh', 'core@192.0.2.10', 'ls', '-l')
-    subject.run ['test-node', 'ls', '-l']
+    subject.run ['test-node', '--', 'ls', '-l']
   end
 
   it "passes through arguments to SSH" do
     expect(subject).to receive(:exec).with('ssh', 'core@192.0.2.10', '-F', 'ssh/config' 'ls', '-l')
-    subject.run ['test-node', '-F', 'ssh/config' 'ls', '-l']
+    subject.run ['test-node', '--', '-F', 'ssh/config' 'ls', '-l']
   end
 end

data/spec/kontena/cli/stacks/yaml/validator_v3_spec.rb

@@ -374,6 +374,55 @@ describe Kontena::Cli::Stacks::YAML::ValidatorV3 do
   end
 
   describe '#validate' do
+    context 'stack' do
+      context 'stack name' do
+        let(:stack) do
+          {
+            'stack' => 'user/a_stack',
+            'services' => {
+              'app' => {
+                'image' => 'redis:latest'
+              }
+            }
+          }
+        end
+
+        it 'should warn about invalid stack names' do
+          result = subject.validate(stack)
+          expect(result[:notifications]).to match array_including(
+            hash_including('stack' => /stack name should/)
+          )
+        end
+      end
+    end
+
+    context 'services' do
+      context 'service name' do
+        let(:stack) do
+          {
+            'stack' => 'user/a-stack',
+            'services' => {
+              'invalid_service_name' => {
+                'image' => 'redis:latest'
+              }
+            }
+          }
+        end
+
+        it 'should warn about invalid service names' do
+          result = subject.validate(stack)
+          expect(result[:notifications]).to match array_including(
+            hash_including(
+              'services' => hash_including(
+                'invalid_service_name' => hash_including(
+                  'name' => /service name should/
+                )
+              )
+            )
+          )
+        end
+      end
+    end
 
     context 'volumes' do
       let(:stack) do

data/spec/kontena/command_spec.rb

@@ -51,4 +51,71 @@ describe Kontena::Command do
       end
     end
   end
+
+  context 'option placement handling' do
+    subject do
+      Class.new(Kontena::Command) do
+        parameter 'TESTPARAM', 'Test parameter'
+        option '--long-only', 'LONGONLY', 'Option with long only'
+        option ['--long-and-short', '-l'], :flag, 'Flag with short and long', default: false
+
+        def execute
+          { param: testparam, longopt: long_only, shortflag: long_and_short? }
+        end
+      end
+
+    end
+
+    it 'allows using options before parameters' do
+      expect(subject.new('kontena').run(%w(-l --long-only longopt test))).to match hash_including(
+        param: 'test', longopt: 'longopt', shortflag: true
+      )
+      expect(subject.new('kontena').run(%w(--long-only longopt test))).to match hash_including(
+        param: 'test', longopt: 'longopt', shortflag: false
+      )
+      expect(subject.new('kontena').run(%w(--long-and-short test))).to match hash_including(
+        param: 'test', longopt: nil, shortflag: true
+      )
+    end
+
+    it 'allows using options after parameters' do
+      expect(subject.new('kontena').run(%w(test -l --long-only longopt))).to match hash_including(
+        param: 'test', longopt: 'longopt', shortflag: true
+      )
+      expect(subject.new('kontena').run(%w(test --long-only longopt))).to match hash_including(
+        param: 'test', longopt: 'longopt', shortflag: false
+      )
+      expect(subject.new('kontena').run(%w(test --long-and-short))).to match hash_including(
+        param: 'test', longopt: nil, shortflag: true
+      )
+    end
+
+    it 'allows using options mixed with parameters' do
+      expect(subject.new('kontena').run(%w(-l test --long-only longopt))).to match hash_including(
+        param: 'test', longopt: 'longopt', shortflag: true
+      )
+      expect(subject.new('kontena').run(%w(--long-and-short test --long-only longopt))).to match hash_including(
+        param: 'test', longopt: 'longopt', shortflag: true
+      )
+    end
+
+    context 'with double dash' do
+      subject do
+        Class.new(Kontena::Command) do
+          parameter 'TESTPARAM ...', 'Test parameter'
+          option '--opt', 'OPT', 'Option'
+
+          def execute
+            { param_list: testparam_list, opt: opt }
+          end
+        end
+      end
+
+      it 'does not parse options after -- double dash' do
+        expect(subject.new('kontena').run(%w(--opt hello foo -- --bar hello))).to match hash_including(
+          param_list: %w(foo --bar hello), opt: 'hello'
+        )
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kontena-cli
 version: !ruby/object:Gem::Version
-  version: 1.5.0.pre1
+  version: 1.5.0.pre2
 platform: ruby
 authors:
 - Kontena, Inc
@@ -570,6 +570,7 @@ files:
 - spec/kontena/cli/etcd/health_command_spec.rb
 - spec/kontena/cli/grids/events_command_spec.rb
 - spec/kontena/cli/grids/health_command_spec.rb
+- spec/kontena/cli/grids/remove_command_spec.rb
 - spec/kontena/cli/grids/trusted_subnets/add_command_spec.rb
 - spec/kontena/cli/grids/trusted_subnets/list_command_spec.rb
 - spec/kontena/cli/grids/trusted_subnets/remove_command_spec.rb
@@ -752,6 +753,7 @@ test_files:
 - spec/kontena/cli/etcd/health_command_spec.rb
 - spec/kontena/cli/grids/events_command_spec.rb
 - spec/kontena/cli/grids/health_command_spec.rb
+- spec/kontena/cli/grids/remove_command_spec.rb
 - spec/kontena/cli/grids/trusted_subnets/add_command_spec.rb
 - spec/kontena/cli/grids/trusted_subnets/list_command_spec.rb
 - spec/kontena/cli/grids/trusted_subnets/remove_command_spec.rb