dtk-shell 0.10.0

data/lib/task_status/stream_mode/element/stage.rb

@@ -0,0 +1,84 @@
+#
+# 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 TaskStatus::StreamMode
+  class Element
+    class Stage < self
+      require File.expand_path('stage/render', File.dirname(__FILE__))
+      include Render::Mixin
+
+      def initialize(response_element, opts = {})
+        super
+        @just_render = opts[:just_render]
+      end
+      
+      # opts has
+      #   :wait - amount to wait if get no results (required)
+      def self.get_and_render_stages(task_status_handle, opts = {})
+        unless wait = opts[:wait]
+          raise DtkError::Client, "opts[:wait] must be set"
+        end
+        
+        cursor = Cursor.new
+        until cursor.task_end? do
+          elements = get_single_stage(task_status_handle, cursor.stage, {:wait_for => cursor.wait_for}.merge(opts))
+          if no_results_yet?(elements)
+            sleep wait
+            next
+          end
+          render_elements(elements)
+          cursor.advance!(task_end?(elements))
+        end
+      end
+    
+      class Cursor
+        def initialize
+          @stage    = 1
+          @wait_for = :start
+          @task_end = false
+        end
+        attr_reader :stage, :wait_for
+        def task_end?
+          @task_end
+        end
+        def advance!(task_end)
+          unless @task_end = task_end
+            if @wait_for == :start
+              @wait_for = :end
+            else
+              @stage += 1
+              @wait_for = :start
+            end
+          end
+        end
+      end
+      
+      def self.get_single_stage(task_status_handle, stage_num, opts = {})
+        get_stages(task_status_handle, stage_num, stage_num, opts)
+      end
+      
+      def self.get_stages(task_status_handle, start_stage_num, end_stage_num, opts = {})
+        opts_get = {
+          :start_index => start_stage_num, 
+          :end_index   => end_stage_num
+        }.merge(opts)
+        get_task_status_elements(task_status_handle, :stage, opts_get)
+      end
+      
+    end
+  end
+end; end

data/lib/task_status/stream_mode/element/stage/render.rb

@@ -0,0 +1,76 @@
+#
+# 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::TaskStatus::StreamMode::Element::Stage
+  module Render
+    module Mixin
+      def render
+        render_start unless @just_render and @just_render != :start
+        render_end unless @just_render and @just_render != :end
+      end
+      
+      private
+      
+      def render_start
+        if @ignore_stage_level_info
+          render_stage_steps field?(:subtasks)
+          render_start_time field?(:started_at)
+        else
+          render_border
+          render_line line__stage_heading?
+          render_start_time field?(:started_at)
+          render_stage_steps field?(:subtasks)
+        end
+      end
+      
+      def render_end
+        render_line line__status
+        render_duration_line
+        render_stage_results field?(:subtasks)
+        unless @ignore_stage_level_info
+          render_border
+          render_empty_line
+        end
+      end
+      
+      def line__stage_heading?
+        stage_num  = field?(:position)
+        stage_name = stage_name?
+        
+        unless stage_num.nil? and stage_name.nil?
+          msg = 'STAGE'
+          if stage_num  = field?(:position)
+            msg << " #{stage_num.to_s}"
+          end
+          
+          if stage_name = stage_name?
+            msg << ": #{stage_name}"
+          end
+          msg
+        end
+      end
+      
+      def line__status
+        "STATUS: #{field?(:status) || 'UNKNOWN'}"
+      end
+      
+      def stage_name?
+        field?(:display_name)
+      end
+    end
+  end
+end

data/lib/task_status/stream_mode/element/task_end.rb

@@ -0,0 +1,35 @@
+#
+# 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 TaskStatus::StreamMode
+  class Element
+    class TaskEnd < self
+      def task_end?()
+        true
+      end
+
+      def render
+        return if @ignore_stage_level_info
+        msg = "end: '#{field?(:display_name) || 'Workflow'}'"
+        if duration = formatted_duration?
+          msg << " (total duration: #{duration})"
+        end
+        render_line msg, :bracket => true
+      end
+    end
+  end
+end; end

data/lib/task_status/stream_mode/element/task_start.rb

@@ -0,0 +1,37 @@
+#
+# 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 TaskStatus::StreamMode
+  class Element
+    class TaskStart < self
+      def self.get(task_status_handle, opts = {})
+        opts_get = {
+          :start_index => 0,
+          :end_index   => 0
+        }.merge(opts)
+        get_task_status_elements(task_status_handle, :task_start, opts_get)
+      end
+
+      def render
+        return if @ignore_stage_level_info
+        msg = "start '#{field?(:display_name) || 'Workflow'}'"
+        render_line msg, :bracket => true, :started_at => field?(:started_at)
+        render_empty_lines 2
+      end
+    end
+  end
+end; end

data/lib/util/common_util.rb

@@ -0,0 +1,37 @@
+#
+# 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
+  module Client
+    module CommonUtil
+      class << self
+        def substract_array_once(array1, array2, substract_from_back = false)
+          # we substract from reverse if flag set
+          array1 = array1.reverse if substract_from_back
+
+          array2.each do |element|
+            if index = array1.index(element)
+              array1.delete_at(index)
+            end
+          end
+
+          substract_from_back ? array1.reverse : array1
+        end
+      end
+    end
+  end
+end

data/lib/util/console.rb

@@ -0,0 +1,235 @@
+#
+# 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 'readline'
+require 'shellwords'
+
+dtk_require("os_util")
+dtk_require_common_commands('../common/thor/push_clone_changes')
+dtk_require_common_commands('../common/thor/reparse')
+dtk_require_from_base("command_helper")
+
+module DTK::Client
+  module Console
+    class << self
+      include PushCloneChangesMixin
+      include ReparseMixin
+      include CommandBase
+      include CommandHelperMixin
+
+      #
+      # Display confirmation prompt and repeat message until expected answer is given
+      #
+      def confirmation_prompt(message, add_options=true)
+        # used to disable skip with ctrl+c
+        trap("INT", "SIG_IGN")
+        message += " (yes|no)" if add_options
+
+        while line = Readline.readline("#{message}: ", true)
+          if (line.eql?("yes") || line.eql?("y"))
+            trap("INT",false)
+            return true
+          elsif (line.eql?("no") || line.eql?("n"))
+            trap("INT",false)
+            return false
+          end
+        end
+      end
+
+      #
+      # Display confirmation prompt and repeat message until expected answer is given
+      #
+      def confirmation_prompt_simple(message, add_options=true)
+        # used to disable skip with ctrl+c
+        trap("INT", "SIG_IGN")
+        message += " (Y/n)" if add_options
+
+        while line = Readline.readline("#{message}: ", true)
+          if (line.downcase.eql?("yes") || line.downcase.eql?("y") || line.empty?)
+            trap("INT",false)
+            return true
+          elsif (line.downcase.eql?("no") || line.downcase.eql?("n"))
+            trap("INT",false)
+            return false
+          end
+        end
+      end
+
+      #
+      # Display confirmation prompt and repeat message until expected answer is given
+      # options should be sent as array ['all', 'none']
+      def confirmation_prompt_additional_options(message, options = [])
+        raise DTK::Client::DtkValidationError, "Options should be sent as array: ['all', 'none']" unless options.is_a?(Array)
+
+        # used to disable skip with ctrl+c
+        trap("INT", "SIG_IGN")
+        message += " (yes/no#{options.empty? ? '' : ('/' + options.join('/'))})"
+
+        while line = Readline.readline("#{message}: ", true)
+          if line.eql?("yes") || line.eql?("y")
+            trap("INT",false)
+            return true
+          elsif line.eql?("no") || line.eql?("n")
+            trap("INT",false)
+            return false
+          elsif options.include?(line)
+            trap("INT",false)
+            return line
+          end
+        end
+      end
+
+      # multiple choice
+      # e.g.
+      # Select version to delete:
+      # 1. base
+      # 2. 0.0.1
+      # 3. 0.0.2
+      # 4. all
+      # > 2
+      def confirmation_prompt_multiple_choice(message, opts_array)
+        indexes = opts_array.map{ |opt| "#{opts_array.index(opt)+1}" }
+
+        trap("INT", "SIG_IGN")
+
+        message << "\n"
+        opts_array.each {|opt| message << "#{opts_array.index(opt)+1}. #{opt}\n" }
+        message << "> "
+
+        while line = Readline.readline("#{message}", true)
+          if indexes.include?(line)
+            trap("INT",false)
+            return opts_array[line.to_i-1]
+          elsif line.eql?('exit')
+            return nil
+          end
+        end
+      end
+
+      # Loading output used to display waiting status
+      def wait_animation(message, time_seconds)
+        print message
+        print " [     ]"
+        STDOUT.flush
+        time_seconds.downto(1) do
+          1.upto(4) do |i|
+            next_output = "\b\b\b\b\b\b\b"
+            case
+             when i % 4 == 0
+              next_output  += "[ =   ]"
+             when i % 3 == 0
+               next_output += "[  =  ]"
+             when i % 2 == 0
+              next_output  += "[   = ]"
+             else
+              next_output  += "[  =  ]"
+            end
+
+            print next_output
+            STDOUT.flush
+            sleep(0.25)
+          end
+        end
+        # remove loading animation
+        print "\b\b\b\b\b\b\bRefreshing..."
+        STDOUT.flush
+        puts
+      end
+
+
+      ##
+      # Method that will execute until interupted as unix like shell. As input takes
+      # path to desire directory from where unix shell can execute normaly.
+      #
+      def unix_shell(path,module_id,module_type,version=nil)
+
+        dtk_shell_ac_proc = Readline.completion_proc
+        dtk_shell_ac_append_char = Readline.completion_append_character
+
+        if OsUtil.is_windows?
+          puts "[NOTICE] Shell interaction is currenly not supported on Windows."
+          return
+        end
+
+        begin
+          # we need to change path like this since system call 'cd' is not supported
+          initial_dir = Dir.pwd
+          Dir.chdir(path)
+          puts "[NOTICE] You are switching to unix-shell, to path #{path}"
+
+          # prompt = DTK::Client::OsUtil.colorize("$dtk:unix-shell ", :yellow)
+          prompt = DTK::Client::OsUtil.colorize("$:", :yellow)
+
+          Readline.completion_append_character = ""
+          Readline.completion_proc = Proc.new do |str|
+            Dir[str+'*'].grep(/^#{Regexp.escape(str)}/)
+          end
+          while line = Readline.readline("#{prompt}#{OsUtil.current_dir}>", true)
+            begin
+              line = line.chomp()
+              break if line.eql?('exit')
+              # since we are not able to support cd command due to ruby specific restrictions
+              # we will be using chdir to this.
+              if (line.match(/^cd /))
+                 # remove cd part of command
+                line = line.gsub(/^cd /,'')
+                # Get path
+                path = line.match(/^\//) ? line : "#{Dir.getwd()}/#{line}"
+                # If filepat* with '*' at the end, match first directory and go in it, else try to change original input
+                if path.match(/\*$/)
+                  dirs = Dir[path].select{|file| File.directory?(file)}
+                  unless dirs.empty?
+                    Dir.chdir(dirs.first)
+                    next
+                  end
+                end
+                # Change directory
+                Dir.chdir(path)
+              elsif line.match(/^dtk-push-changes/)
+                args       = Shellwords.split(line)
+                commit_msg = nil
+
+                unless args.size==1
+                  raise DTK::Client::DtkValidationError, "To push changes to server use 'dtk-push-changes [-m COMMIT-MSG]'" unless (args[1]=="-m" && args.size==3)
+                  commit_msg = args.last
+                end
+
+                reparse_aux(path)
+                push_clone_changes_aux(module_type, module_id, version, commit_msg)
+              else
+                # we are sending stderr to stdout
+                system("#{line} 2>&1")
+              end
+            rescue Exception => e
+              DtkLogger.instance.error_pp(e.message, e.backtrace)
+            end
+          end
+         rescue Interrupt
+          puts ""
+          # do nothing else
+         ensure
+          Dir.chdir(initial_dir)
+        end
+
+        Readline.completion_append_character = dtk_shell_ac_append_char unless dtk_shell_ac_append_char.nil?
+        Readline.completion_proc = dtk_shell_ac_proc unless dtk_shell_ac_proc.nil?
+        puts "[NOTICE] You are leaving unix-shell."
+      end
+
+    end
+  end
+end