dtk-shell 0.10.0

data/lib/dtk_logger.rb

@@ -0,0 +1,126 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+##
+# DtkLogger singleton to be used for logging.
+#
+require 'singleton'
+require 'logger'
+require 'colorize'
+require 'pp'
+
+require File.expand_path('./util/os_util', File.dirname(__FILE__))
+
+class DtkLogger
+
+  #
+  LOG_FILE_NAME           = 'client.log'
+  LOG_MB_SIZE             = 2
+  LOG_NUMBER_OF_OLD_FILES = 10
+  DEVELOPMENT_MODE        = DTK::Configuration.get(:development_mode)
+
+  include Singleton
+
+  def initialize
+    log_location_dir = DTK::Client::OsUtil.get_log_location()
+    begin
+      if File.directory?(log_location_dir)
+        file = File.open(file_path(), "a")
+        file.sync = true
+        @logger = Logger.new(file, LOG_NUMBER_OF_OLD_FILES, LOG_MB_SIZE * 1024000)
+
+        @logger.formatter = proc do |severity, datetime, progname, msg|
+          "[#{datetime}] #{severity} -- : #{msg}\n"
+        end
+      else
+        no_log_dir(log_location_dir)
+      end
+     rescue Errno::EACCES
+      no_log_permissions(log_location_dir)
+    end
+  end
+
+  def file_path()
+    "#{DTK::Client::OsUtil.get_log_location()}/#{LOG_FILE_NAME}"
+  end
+
+  LoggerMethods = [:debug, :info, :warn, :error, :fatal, :error_pp, :fatal_pp]
+  def self.method_missing(method, *args)
+    if LoggerMethods.include?(method)
+      instance.send(method, *args)
+    else
+      super(method, *args)
+    end
+  end
+
+  def self.respond_to?(method)
+    LoggerMethods.include?(method) or super(method)
+  end
+
+  def debug(log_text, sttdout_out=false)
+    puts log_text if sttdout_out || DEVELOPMENT_MODE
+    @logger.debug(log_text) if log_created?
+  end
+
+  def info(log_text, sttdout_out=false)
+    puts log_text if sttdout_out || DEVELOPMENT_MODE
+    @logger.info(log_text) if log_created?
+  end
+
+  def warn(log_text, sttdout_out=false)
+    DTK::Client::OsUtil.print(log_text, :yellow) if sttdout_out || DEVELOPMENT_MODE
+    @logger.warn(log_text) if log_created?
+  end
+
+  def error(log_text, sttdout_out=false)
+    DTK::Client::OsUtil.print(log_text, :red) if sttdout_out || DEVELOPMENT_MODE
+    @logger.error(log_text) if log_created?
+  end
+
+  def error_pp(message, backtrace, sttdout_out = true)
+    error(message, sttdout_out)
+    # we do not print this to STDOUT (will be overriden with DEVELOPMENT_MODE)s
+    error("#{message}\n" + PP.pp(backtrace, ""), false) if backtrace
+  end
+
+  def fatal_pp(message, backtrace, sttdout_out = true)
+    fatal(message, sttdout_out)
+    # we do not print this to STDOUT (will be overriden with DEVELOPMENT_MODE)
+    fatal("#{message}\n" + PP.pp(backtrace, ""), false) if backtrace
+  end
+
+
+  def fatal(log_text, sttdout_out=false)
+    puts log_text if sttdout_out || DEVELOPMENT_MODE
+    @logger.fatal(log_text) if log_created?
+  end
+
+  private
+
+  def log_created?
+    #no log found if @logger.nil?
+    return !@logger.nil?
+  end
+
+  def no_log_dir(dir)
+    puts "[WARNING] Log directory (#{dir}) does not exist; please add it manually or re-install DTK client."
+  end
+
+  def no_log_permissions(dir)
+    puts "[WARNING] User (#{DTK::Common::Aux.running_process_user()}) does not have permissions to create a log file in log directory (#{dir})"
+  end
+end

data/lib/dtk_shell.rb

@@ -0,0 +1,31 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require File.expand_path('../client', __FILE__)
+require File.expand_path('../configurator', __FILE__)
+require File.expand_path('../parser/adapters/thor',    __FILE__)
+require File.expand_path('../shell/context', __FILE__)
+require File.expand_path('../shell/domain/context_entity', __FILE__)
+require File.expand_path('../shell/domain/active_context', __FILE__)
+require File.expand_path('../shell/domain/context_params', __FILE__)
+require File.expand_path('../shell/domain/override_tasks', __FILE__)
+require File.expand_path('../shell/domain/shadow_entity', __FILE__)
+require File.expand_path('../commands/thor/account', __FILE__)
+require File.expand_path('../shell/parse_monkey_patch', __FILE__)
+require File.expand_path('../shell/help_monkey_patch', __FILE__)
+require File.expand_path('../execute/cli_pure/cli_rerouter', __FILE__)
+require File.expand_path('../context_router', __FILE__)

data/lib/error.rb

@@ -0,0 +1,85 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+##
+# Application expected errors will be handled trough DtkError. All else will be treaded 
+# as Internal Server error. Logs will be added to ~/dtk.log for developers to investigate
+# issues more closely.
+
+module DTK
+  module Client
+    class Error < NameError
+    end
+
+   # DtkError is child of Error; so order matters
+    require File.expand_path('dtk_error', File.dirname(__FILE__))
+
+    class DSLParsing < Error
+      def initialize(base_json_error,file_path=nil)
+        super(err_msg(base_json_error,file_path))
+      end
+      private
+      def err_msg(base_json_error,file_path=nil)
+        "#{base_json_error}: #{file_path}"
+      end
+
+      class JSONParsing < self
+      end
+
+      class YAMLParsing < self
+      end
+    end
+
+    # class DtkValidationError < Error
+
+    #   attr_accessor :skip_usage_info
+
+    #   def initialize(msg, skip_usage_info = false)
+    #     @skip_usage_info = skip_usage_info
+    #     super(msg)
+    #   end
+    # end
+
+    class DtkValidationError < Error
+
+      attr_accessor :display_usage_info
+
+      def initialize(msg, display_usage_info = false)
+        @display_usage_info = display_usage_info
+        super(msg)
+      end
+    end
+
+    # raise by developers to signal wrong usage of components
+    class DtkImplementationError < Error
+    end
+
+    class DtkLoginRequiredError < Error
+    end
+
+  end
+end
+
+module DTK
+  module Shell
+    class Error < DTK::Client::Error
+    end
+
+    class ExitSignal < DTK::Client::Error
+    end
+  end
+end

data/lib/execute.rb

@@ -0,0 +1,29 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module DTK::Client
+  class Execute
+    # The order matters
+    dtk_require('execute/error_usage')
+    dtk_require('execute/command')
+    dtk_require('execute/command_processor')
+    dtk_require('execute/execute_context')
+    dtk_require('execute/script')
+
+    extend ExecuteContext::ClassMixin
+  end
+end

data/lib/execute/cli_pure/cli_rerouter.rb

@@ -0,0 +1,102 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module DTK
+  class CLIRerouter
+
+    ROUTER_DATA = {
+      :service_module => [
+          { :regex => /service-module (?<service_module_id>[\w:\-]+) (?<method_name>stage) (?<assembly_id>[\w:\-]+) (?<instance_name>[\w:\-\.\:]+)/, :entity => 'assembly' },
+          { :regex => /service-module (?<service_module_id>[\w:\-]+) (?<method_name>deploy) (?<assembly_id>[\w:\-]+) (?<instance_name>[\w:\-\.\:]+)/ }
+        ],
+      :component_module => [
+          { :regex => /component-module (?<component_module_id>[\w:\-]+) (?<method_name>clone)/ }
+        ],
+      :service        => [
+          { :regex => /service (?<service_id>[\w:\-]+) (?<method_name>set-attribute) (?<name>[\w:\-\.\:]+) (?<value>[\w:\-\.\:]+)/ },
+          { :regex => /service (?<service_id>[\w:\-]+) (?<method_name>converge)/ },
+          { :regex => /service (?<method_name>delete-and-destroy) (?<instance_name>[\w:\-]+)/ }
+        ]
+    }
+
+    def initialize(entity_name, args)
+      @cli_string  = CLIRerouter.formulate_command_string(entity_name, args)
+      @entity_name = CLIRerouter.norm(entity_name)
+
+      ROUTER_DATA[@entity_name].each do |defintion|
+        if match = @cli_string.match(defintion[:regex])
+          @method_name = CLIRerouter.norm(match[:method_name])
+
+          # sometimes we need to override entity
+          @entity_name = defintion[:entity] if defintion[:entity]
+
+          # we need to filter out IDs
+          @entity_ids  = match.names.collect { |k| k.to_s.end_with?('_id') ? { k => match[k] } : nil }.compact
+
+          if @entity_ids.empty?
+            # match 1 is method name, there is no id
+            @args = match[2, match.size]
+          else
+            # match 1, 2 are id and method name rest are args
+            @args = match[@entity_ids.size + 2, match.size]
+          end
+
+          break
+        end
+      end
+
+      @conn = ::DTK::Client::Session.get_connection()
+      exit if validate_connection(@conn)
+    end
+
+    def run
+      new_context_params = DTK::Shell::ContextParams.new
+
+      @entity_ids.each do |value_hash|
+        key    = value_hash.keys.first
+        value  = value_hash.values.first
+        entity_name_of_param = key.gsub('_id', '')
+        new_context_params.add_context_name_to_params(entity_name_of_param, entity_name_of_param, value)
+      end
+
+      new_context_params.method_arguments = @args
+      new_context_params.pure_cli_mode    = true
+      DTK::Client::ContextRouter.routeTask(@entity_name, @method_name, new_context_params, @conn)
+    end
+
+    def self.is_candidate?(entity_name, args)
+      cli = formulate_command_string(entity_name, args)
+      if definitions = ROUTER_DATA[norm(entity_name)]
+        is_match = definitions.find { |d| cli.match(d[:regex]) }
+
+        return true if is_match
+      end
+
+      return false
+    end
+
+  private
+
+    def self.norm(string_value)
+      return string_value ? string_value.gsub('-','_').to_sym : nil
+    end
+
+    def self.formulate_command_string(entity_name, args)
+      "#{entity_name} #{args.join(' ')}".strip()
+    end
+  end
+end

data/lib/execute/command.rb

@@ -0,0 +1,40 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+class DTK::Client::Execute
+  class Command
+    dtk_require('command/rest_call')
+    dtk_require('command/api_call')
+
+    attr_reader :result_var,:input_hash
+    def initialize(input_hash)
+      @input_hash = input_hash
+      @result_var = optional?(:result_var)
+    end
+
+   private
+    def required(key)
+      unless @input_hash.has_key?(key)
+        raise ErrorUsage.new("Missing required key '#{key}' in: #{@input_hash.inspect}")
+      end
+      @input_hash[key]
+    end
+    def optional?(key)
+      @input_hash[key]
+    end
+  end
+end

data/lib/execute/command/api_call.rb

@@ -0,0 +1,60 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+class DTK::Client::Execute
+  class Command
+    class APICall < self
+
+      # order matters; having these defs before requires; plus order of these requires
+      def self.Required(key)
+        Required.new(key)
+      end
+      def self.PreviousResponse(response_key)
+        PreviousResponse.new(response_key)
+      end
+      dtk_require('api_call/translation_term')
+      dtk_require('api_call/map')
+      dtk_require('api_call/service')
+
+
+       # calss block where on one or more commands that achieve the api
+      def raw_executable_commands(&block)
+        method = required(:method).to_sym
+        case required(:object_type).to_sym
+         when :service
+           Service.raw_executable_commands(method,&block)
+         else
+          raise ErrorUsage.new("The object_type '#{object_type}' is not supported")
+        end
+      end
+
+     private
+      def self.raw_executable_commands(method,&block)
+        if command_map = self::CommandMap[method]
+          array_form(command_map).each{|raw_command|block.call(raw_command)}
+        else
+          raise ErrorUsage.new("The method on '#{method}' on object type '#{object_type()}' is not supported")
+        end
+      end
+
+      def self.array_form(obj)
+        obj.kind_of?(Array) ? obj : [obj]
+      end
+
+    end
+  end
+end