kontena-cli 0.15.5 → 0.16.0.pre1

data/lib/kontena/command.rb

@@ -1,4 +1,176 @@
 require 'clamp'
 
 class Kontena::Command < Clamp::Command
+
+  attr_accessor :arguments
+  attr_reader :result
+  attr_reader :exit_code
+
+
+  def self.inherited(where)
+    return if where.has_subcommands?
+    return if where.callback_matcher
+
+    name_parts = where.name.split('::')[-2, 2]
+
+    unless name_parts.compact.empty?
+      # 1: Remove trailing 'Command' from for example AuthCommand
+      # 2: Convert the string from CamelCase to under_score
+      # 3: Convert the string into a symbol
+      #
+      # In comes: ['ExternalRegistry', 'UseCommand']
+      # Out goes: [:external_registry, :use]
+      name_parts = name_parts.map { |np|
+        np.gsub(/Command$/, '').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase.
+        to_sym
+      }
+      where.callback_matcher(*name_parts)
+    end
+
+    # Run all #after_load callbacks for this command.
+    [name_parts.last, :all].compact.uniq.each do |cmd_type|
+      [name_parts.first, :all].compact.uniq.each do |cmd_class|
+        if Kontena::Callback.callbacks.fetch(cmd_class, {}).fetch(cmd_type, nil)
+          Kontena::Callback.callbacks[cmd_class][cmd_type].each do |cb|
+            if cb.instance_methods.include?(:after_load)
+              cb.new(where).after_load
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def self.callback_matcher(cmd_class = nil, cmd_type = nil)
+    unless cmd_class
+      if @command_class.nil?
+        return nil
+      else
+        return [@command_class, @command_type]
+      end
+    end
+    @command_class = cmd_class.to_sym
+    @command_type = cmd_type.to_sym
+    [@command_class, @command_type]
+  end
+
+  def run_callbacks(state)
+    if self.class.respond_to?(:callback_matcher) && !self.class.callback_matcher.compact.empty?
+      Kontena::Callback.run_callbacks(self.class.callback_matcher, state, self)
+    end
+  end
+
+  # Overwrite Clamp's banner command. Calling banner multiple times 
+  # will now add lines to the banner message instead of overwriting
+  # the whole message. This is useful if callbacks add banner messages.
+  #
+  # @param [String] message
+  def self.banner(msg, extra_feed = true)
+    self.description = [self.description, extra_feed ? "\n#{msg}" : msg].compact.join("\n")
+  end
+
+  def self.requires_current_master
+    banner "#{Kontena.pastel.green("Requires current master")}: This command requires that you have selected a current master using 'kontena master auth' or 'kontena master use'. You can also use the environment variable KONTENA_URL to specify the master address or KONTENA_MASTER=master_name to override the current_master setting."
+    @requires_current_master = true
+  end
+
+  def self.requires_current_grid
+    banner "#{Kontena.pastel.green("Requires current grid")}: This command requires that you have selected a grid as the current grid using 'kontena grid use' or by setting KONTENA_GRID environment variable."
+    @requires_current_grid = true
+  end
+
+  def self.requires_current_account_token
+    banner "#{Kontena.pastel.green("Requires account authentication")}: This command requires that you have authenticated to Kontena Cloud using 'kontena cloud auth'"
+    @requires_current_account_token = true
+  end
+
+
+  def self.requires_current_master?
+    @requires_current_master ||= false
+  end
+
+  def verify_current_master
+    Kontena::Cli::Config.instance.require_current_master if self.class.requires_current_master?
+  end
+
+  def self.requires_current_grid?
+    @requires_current_grid ||= false
+  end
+
+  def verify_current_grid
+    Kontena::Cli::Config.instance.require_current_grid if self.class.requires_current_grid?
+  end
+
+  def self.requires_current_account_token?
+    @requires_current_account_token ||= false
+  end
+
+  def verify_current_account_token
+    retried ||= false
+    Kontena::Cli::Config.instance.require_current_account_token if self.class.requires_current_account_token?
+  end
+
+  def self.requires_current_master_token
+    @requires_current_master_token = true
+  end
+
+  def self.requires_current_master_token?
+    @requires_current_master_token ||= false
+  end
+
+  def verify_current_master_token
+    return nil unless self.class.requires_current_master_token?
+    retried ||= false
+    Kontena::Cli::Config.instance.require_current_master_token
+  rescue Kontena::Cli::Config::TokenExpiredError
+    success = Kontena::Client.new(
+      Kontena::Cli::Config.instance.current_master,
+      Kontena::Cli::Config.instance.current_master.token
+    ).refresh_token
+    if success && !retried
+      retried = true
+      retry
+    else
+      raise Kontena::Cli::Config::TokenExpiredError, "The access token has expired and refresh failed. Try authenticating again, use: kontena master auth"
+    end
+  end
+
+  def help_requested?
+    return true if @arguments.include?('--help')
+    return true if @arguments.include?('-h')
+    false
+  end
+
+  def run(arguments)
+    ENV["DEBUG"] && puts("Running #{self} -- callback matcher = '#{self.class.callback_matcher.map(&:to_s).join(' ')}'")
+    @arguments = arguments
+
+    run_callbacks :before_parse unless help_requested?
+
+    parse @arguments
+
+    unless help_requested?
+      verify_current_master
+      verify_current_master_token
+      verify_current_grid
+      run_callbacks :before
+    end
+
+    begin
+      @result = execute
+      @exit_code = @result.kind_of?(FalseClass) ? 1 : 0
+    rescue SystemExit => exc
+      @result = exc.status == 0
+      @exit_code = exc.status
+    end
+    run_callbacks :after unless help_requested?
+    exit(@exit_code) if @exit_code.to_i > 0
+    @result
+  end
 end
+
+require_relative 'callback'

data/lib/kontena/main_command.rb

@@ -1,11 +1,11 @@
 require 'clamp'
-require_relative 'command'
-require_relative 'util'
 require_relative 'cli/common'
+require_relative 'util'
+require_relative 'command'
+require_relative 'callback'
 require_relative 'cli/bytes_helper'
 require_relative 'cli/grid_options'
 require_relative 'cli/app_command'
-require_relative 'cli/register_command'
 require_relative 'cli/login_command'
 require_relative 'cli/logout_command'
 require_relative 'cli/whoami_command'
@@ -20,15 +20,17 @@ require_relative 'cli/external_registry_command'
 require_relative 'cli/app_command'
 require_relative 'cli/etcd_command'
 require_relative 'cli/vault_command'
-require_relative 'cli/user_command'
 require_relative 'cli/plugin_command'
 require_relative 'cli/version_command'
 require_relative 'cli/stack_command'
 require_relative 'cli/certificate_command'
+require_relative 'cli/cloud_command'
 
 class Kontena::MainCommand < Kontena::Command
   include Kontena::Util
 
+  subcommand "cloud", "Kontena Cloud specific commands", Kontena::Cli::CloudCommand
+  subcommand "logout", "Logout from Kontena Masters or Kontena Cloud accounts", Kontena::Cli::LogoutCommand
   subcommand "grid", "Grid specific commands", Kontena::Cli::GridCommand
   subcommand "app", "App specific commands", Kontena::Cli::AppCommand
   subcommand "stack", "Stack specific commands", Kontena::Cli::StackCommand if experimental?
@@ -42,13 +44,10 @@ class Kontena::MainCommand < Kontena::Command
   subcommand "container", "Container specific commands", Kontena::Cli::ContainerCommand
   subcommand "etcd", "Etcd specific commands", Kontena::Cli::EtcdCommand
   subcommand "external-registry", "External registry specific commands", Kontena::Cli::ExternalRegistryCommand
-  subcommand "register", "Register Kontena Account", Kontena::Cli::RegisterCommand
-  subcommand "login", "Login to Kontena Master", Kontena::Cli::LoginCommand
-  subcommand "logout", "Logout from Kontena Master", Kontena::Cli::LogoutCommand
   subcommand "whoami", "Shows current logged in user", Kontena::Cli::WhoamiCommand
-  subcommand "user", "User related commands", Kontena::Cli::UserCommand
   subcommand "plugin", "Plugin related commands", Kontena::Cli::PluginCommand
   subcommand "version", "Show version", Kontena::Cli::VersionCommand
+  subcommand "login", "Login to Kontena Master (removed, use kontena master auth)", Kontena::Cli::LoginCommand
 
   def execute
   end

data/lib/kontena/presets/github_auth_provider.yml

@@ -0,0 +1,11 @@
+---
+oauth2.authorize_endpoint: https://github.com/login/oauth/authorize
+oauth2.code_requires_basic_auth: false
+oauth2.token_endpoint: https://github.com/login/oauth/access_token
+oauth2.token_method: post
+oauth2.token_post_content_type: application/json
+oauth2.userinfo_scope: user:email
+oauth2.userinfo_endpoint: https://api.github.com/user
+oauth2.userinfo_username_jsonpath: "$..login"
+oauth2.userinfo_email_jsonpath: "$..email"
+oauth2.userinfo_user_id_jsonpath: "$..id"

data/lib/kontena/presets/kontena_auth_provider.yml

@@ -0,0 +1,11 @@
+---
+oauth2.authorize_endpoint: https://cloud-beta.kontena.io/login/oauth/authorize
+oauth2.code_requires_basic_auth: false
+oauth2.token_endpoint: https://auth2.kontena.io/v1/oauth2/token
+oauth2.token_method: post
+oauth2.token_post_content_type: application/x-www-form-urlencoded
+oauth2.userinfo_endpoint: https://auth2.kontena.io/v1/user
+oauth2.userinfo_username_jsonpath: "$..username"
+oauth2.userinfo_email_jsonpath: "$..email"
+oauth2.userinfo_user_id_jsonpath: "$..id"
+oauth2.userinfo_scope: user

data/lib/kontena_cli.rb

@@ -1,6 +1,56 @@
-module Kontena; end
+module Kontena
+  # Run a kontena command like it was launched from the command line.
+  # 
+  # @example
+  #   Kontena.run("grid list --help")
+  #
+  # @param [String] command_line 
+  # @return [Fixnum] exit_code
+  def self.run(cmdline = "", returning: :status)
+    require 'shellwords'
+    result = Kontena::MainCommand.new(File.basename(__FILE__)).run(cmdline.shellsplit)
+    return 0 if returning == :status
+    return result if returning == :result
+  rescue SystemExit
+    returning == :status ? $!.status : nil
+  end
+
+  def self.version
+    "kontena-cli/#{Kontena::Cli::VERSION}"
+  end
+
+  def self.pastel
+    @pastel ||= Pastel.new(enabled: $stdout.tty?)
+  end
+
+  def self.prompt
+    @prompt ||= TTY::Prompt.new(
+      active_color: :cyan,
+      help_color: :white,
+      error_color: :red,
+      interrupt: :exit,
+      prefix: pastel.green('> ')
+    )
+  end
+
+  def self.root
+    File.dirname(__dir__)
+  end
+end
+
+# Monkeypatching string to mimick 'colorize' gem
+class String
+  def colorize(color_sym)
+    ::Kontena.pastel.send(color_sym, self)
+  end
+end
 
 require 'ruby_dig'
+require_relative 'kontena/cli/version'
+require_relative 'kontena/cli/common'
+require_relative 'kontena/command'
 require_relative 'kontena/client'
 require_relative 'kontena/plugin_manager'
 require_relative 'kontena/main_command'
+require_relative 'kontena/cli/spinner'
+

data/spec/kontena/cli/app/deploy_command_spec.rb

@@ -4,40 +4,12 @@ require "kontena/cli/apps/deploy_command"
 
 describe Kontena::Cli::Apps::DeployCommand do
   include FixturesHelpers
+  include ClientHelpers
 
   let(:subject) do
     described_class.new(File.basename($0))
   end
 
-  let(:settings) do
-    {'current_server' => 'alias',
-     'servers' => [
-         {'name' => 'some_master', 'url' => 'some_master'},
-         {'name' => 'alias', 'url' => 'someurl', 'token' => token}
-     ]
-    }
-  end
-
-  let(:settings_without_api_url) do
-    {'current_server' => 'alias',
-     'servers' => [
-         {'name' => 'alias', 'token' => token}
-     ]
-    }
-  end
-
-  let(:settings_without_token) do
-    {'current_server' => 'alias',
-     'servers' => [
-         {'name' => 'alias', 'url' => 'url'}
-     ]
-    }
-  end
-
-  let(:token) do
-    '1234567'
-  end
-
   let(:docker_compose_yml) do
     fixture('docker-compose.yml')
   end
@@ -64,10 +36,6 @@ describe Kontena::Cli::Apps::DeployCommand do
     }
   end
 
-  let(:client) do
-    double
-  end
-
   let(:options) do
     double({prefix: false, file: false, service: nil})
   end
@@ -88,21 +56,24 @@ describe Kontena::Cli::Apps::DeployCommand do
 
     context 'when api_url is nil' do
       it 'raises error' do
-        allow(subject).to receive(:settings).and_return(settings_without_api_url)
+        allow(subject.config).to receive(:current_master).and_return(
+          Kontena::Cli::Config::Server.new
+        )
         expect{subject.run([])}.to raise_error(ArgumentError)
       end
     end
 
     context 'when token is nil' do
       it 'raises error' do
-        allow(subject).to receive(:settings).and_return(settings_without_token)
+        allow(subject.config).to receive(:current_master).and_return(
+          Kontena::Cli::Config::Server.new(url: 'http://foo.com')
+        )
         expect{subject.run([])}.to raise_error(ArgumentError)
       end
     end
 
     context 'when api url and token are valid' do
       before(:each) do
-        allow(subject).to receive(:settings).and_return(settings)
         allow(File).to receive(:exists?).and_return(true)
         allow(File).to receive(:read).with("#{Dir.getwd}/kontena.yml").and_return(kontena_yml)
         allow(File).to receive(:read).with("#{Dir.getwd}/docker-compose.yml").and_return(docker_compose_yml)
@@ -113,7 +84,6 @@ describe Kontena::Cli::Apps::DeployCommand do
       end
 
       it 'reads ./kontena.yml file by default' do
-        allow(subject).to receive(:settings).and_return(settings)
         expect(File).to receive(:read).with("#{Dir.getwd}/kontena.yml").and_return(kontena_yml)
         subject.run([])
       end
@@ -147,7 +117,7 @@ describe Kontena::Cli::Apps::DeployCommand do
               'env' => ['MYSQL_ADMIN_PASSWORD=password', 'TEST_ENV_VAR=test', 'TEST_ENV_VAR2=test3'],
           }
 
-          expect(subject).to receive(:create_service).with('1234567', '1', hash_including(data))
+          expect(subject).to receive(:create_service).with(duck_type(:access_token), '1', hash_including(data))
           subject.run([])
         end
       end
@@ -167,7 +137,7 @@ describe Kontena::Cli::Apps::DeployCommand do
               'env' => ['MYSQL_ADMIN_PASSWORD=password', 'TEST_ENV_VAR=test']
           }
 
-          expect(subject).to receive(:create_service).with('1234567', '1', hash_including(data))
+          expect(subject).to receive(:create_service).with(duck_type(:access_token), '1', hash_including(data))
           subject.run([])
         end
       end
@@ -191,7 +161,7 @@ describe Kontena::Cli::Apps::DeployCommand do
           ]
         }
 
-        expect(subject).to receive(:create_service).with('1234567', '1', hash_including(data))
+        expect(subject).to receive(:create_service).with(duck_type(:access_token), '1', hash_including(data))
         subject.run([])
       end
 
@@ -204,7 +174,7 @@ describe Kontena::Cli::Apps::DeployCommand do
             'container_count' => nil,
             'stateful' => true,
         }
-        expect(subject).to receive(:create_service).with('1234567', '1', hash_including(data))
+        expect(subject).to receive(:create_service).with(duck_type(:access_token), '1', hash_including(data))
 
         subject.run([])
       end
@@ -222,15 +192,15 @@ describe Kontena::Cli::Apps::DeployCommand do
           'links' => [{ 'name' => 'kontena-test-mysql', 'alias' => 'mysql' }],
           'ports' => [{ 'ip' => '0.0.0.0','container_port' => '80', 'node_port' => '80', 'protocol' => 'tcp' }]
         }
-        expect(subject).to receive(:create_service).with('1234567', '1', hash_including(data))
+        expect(subject).to receive(:create_service).with(duck_type(:access_token), '1', hash_including(data))
 
         subject.run([])
       end
 
       it 'deploys services' do
         allow(subject).to receive(:current_dir).and_return('kontena-test')
-        expect(subject).to receive(:deploy_service).with('1234567', 'kontena-test-mysql', {})
-        expect(subject).to receive(:deploy_service).with('1234567', 'kontena-test-wordpress', {})
+        expect(subject).to receive(:deploy_service).with(duck_type(:access_token), 'kontena-test-mysql', {})
+        expect(subject).to receive(:deploy_service).with(duck_type(:access_token), 'kontena-test-wordpress', {})
         subject.run([])
       end
 

data/spec/kontena/cli/app/scale_spec.rb

@@ -42,7 +42,7 @@ describe Kontena::Cli::Apps::ScaleCommand do
 
     it 'scales given service' do
       allow(File).to receive(:read).with("#{Dir.getwd}/kontena.yml").and_return(kontena_yml_no_instances)
-      expect(subject).to receive(:scale_service).with('1234567','kontena-test-wordpress',3)
+      expect(subject).to receive(:scale_service).with(duck_type(:access_token),'kontena-test-wordpress',3)
       subject.run(['wordpress', 3])
     end