Class: DTK::Shell::Context

Inherits:
Object
  • Object
show all
Includes:
Client::Auxiliary, Client::CommandBase
Defined in:
lib/shell/context.rb

Constant Summary collapse

CLIENT_COMMANDS =

client commands

['cc','exit','clear','pushc','popc','dirs','help']
DEV_COMMANDS =

CLIENT_COMMANDS = [‘cc’,‘exit’,‘clear’,‘help’]

['restart']
DTK_ROOT_PROMPT = 
"dtk:/>"
COMMAND_HISTORY_LIMIT = 
200
HISTORY_LOCATION = 
DTK::Client::OsUtil.dtk_local_folder + "shell_history"
ROOT_TASKS = 
DTK::Client::Dtk.task_names
ALL_COMMANDS = 
ROOT_TASKS + DTK::Client::Dtk.additional_entities
IDENTIFIERS_ONLY = 
['cc','cd','pushc']
[
  { :alias => :workspace, :path => 'workspace/workspace' }
]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Client::CommandBase

#get, #get_connection, handle_argument_error, #post, #post_file, #rest_url, #rotate_args

Methods included from Client::Auxiliary

#cap_form, #snake_form

Constructor Details

#initialize(skip_caching = false) ⇒ Context

Returns a new instance of Context.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/shell/context.rb', line 52

def initialize(skip_caching=false)
  @cached_tasks, @dirs = DTK::Shell::CachedTasks.new, []
  @active_context   = ActiveContext.new
  @previous_context = nil

  # member used to hold current commands loaded for current command
  @context_commands = []
  @conn = DTK::Client::Session.get_connection()

  # if connection parameters are not set up properly, print warning and exit dtk_shell
  exit if validate_connection(@conn)

  unless skip_caching
    @cached_tasks.store('dtk', ROOT_TASKS.sort)

    ALL_COMMANDS.each do |task_name|
      # we exclude help since there is no command class for it
      next if task_name.eql? "help"
      Context.require_command_class(task_name)

      get_latest_tasks(task_name)
    end
  end
end

Instance Attribute Details

#active_context ⇒ Object

Returns the value of attribute active_context.



47
48
49
 
# File 'lib/shell/context.rb', line 47

def active_context
  @active_context
end

#cached_tasks ⇒ Object

Returns the value of attribute cached_tasks.



48
49
50
 
# File 'lib/shell/context.rb', line 48

def cached_tasks
  @cached_tasks
end

#current ⇒ Object

current holds context (list of commands) for active context e.g. dtk:library>



46
47
48
 
# File 'lib/shell/context.rb', line 46

def current
  @current
end

#dirs ⇒ Object

Returns the value of attribute dirs.



49
50
51
 
# File 'lib/shell/context.rb', line 49

def dirs
  @dirs
end

Class Method Details

SYM_LINKS methods is used to calculate aliases that will be used for certain entities one of those approaches will be as such



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/shell/context.rb', line 89

def self.check_for_sym_link(entries)
  # remove empty strings from array
  entries.reject! { |e| e.empty? }

  if (entries.size > 0)
    SYM_LINKS.each do |sym_link|
      if entries.first.downcase.to_sym.eql?(sym_link[:alias])
        entries[0] = sym_link[:path].split('/')
        entries.flatten!
      end
    end
  end

  entries
end

.check_invisible_context(acc, entries, is_root, line_buffer = [], args = [], current_context_clazz = nil) ⇒ Object

TODO: this is hack used this to hide ‘node’ context and use just node_identifier we should rethink the design of shell context if we are about to use different behaviors like this



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/shell/context.rb', line 234

def self.check_invisible_context(acc, entries, is_root, line_buffer=[], args=[], current_context_clazz=nil)
  check = nil
  entries.reject! { |e| e.empty? }
  goes_from_root = args.first.start_with?('/')

  unless (line_buffer.empty? && args.empty?)
    command = line_buffer.empty? ? args.first : line_buffer.split(' ').first
    # command = line_buffer.split(' ').first
    current_c_name = acc.last_command_name
    current_context = acc.last_context
    clazz = DTK::Shell::Context.get_command_class(current_c_name)
    command_from_args = nil

    if args.first.include?('/')
      command_from_args = goes_from_root ? args.first.split('/')[1] : args.first.split('/').first
      clazz_from_args = DTK::Shell::Context.get_command_class(command_from_args) if command_from_args
    end

    check = (command.eql?('cd') || command.eql?('cc') || command.eql?('popc') || command.eql?('pushc') || command.eql?('delete-node'))
    # used when calling node commands from service or workspace context
    # e.g. service/service_name>node1 info will display info about nodes instead of service instance
    unless check
      if current_c_name.eql?('service') || current_c_name.eql?('workspace')
        context_hash_data, error_message, invalid_context = current_context_clazz.validate_value('node', command, acc)
        check = true if context_hash_data && !error_message
      end
    end

    # this delete-node is a hack because we need autocomplete when there is node with name 'node'
    # if (command.eql?('cd') || command.eql?('cc') || command.eql?('popc') || command.eql?('pushc') || command.eql?('delete-node'))
    if check
      if is_root
        if entries.size >= 3
          node = entries[2]
          if (node && clazz_from_args.respond_to?(:valid_child?) && !clazz_from_args.invisible_context_list.empty?)
            unless clazz_from_args.valid_children().first.to_s.include?(node)
              entries[2] = ["node", node]
              entries.flatten!
            end
          end
        end
      else
        double_dots_count = DTK::Shell::ContextAux.count_double_dots(entries)

        unless double_dots_count > 0
          if clazz.respond_to?(:invisible_context)
            if current_context.is_command?
              node = entries[1]
              if (node && clazz.respond_to?(:valid_child?))
                unless clazz.valid_children().first.to_s.include?(node)
                  entries[1] = ["node", node]
                  entries.flatten!
                end
              end
            elsif current_context.is_identifier?
              node = entries[0]
              if (node && clazz.respond_to?(:valid_child?))
                unless clazz.valid_children().first.to_s.include?(node)
                  entries[0] = ["node", node]
                  entries.flatten!
                end
              end
            end
          end
        end

      end
    end

  end

  entries
end

.enchance_path_with_alias(path, context_list) ⇒ Object

take current path and see if it is aliased path



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/shell/context.rb', line 106

def self.enchance_path_with_alias(path, context_list)
  SYM_LINKS.each do |sym_link|
    if path.downcase.include?(sym_link[:path])
      path = path.gsub(sym_link[:path], sym_link[:alias].to_s)
    end
  end

  unless context_list.empty?
    init_context = context_list.first.name
    command_clazz = Context.get_command_class(init_context)
    invisible_context = command_clazz.respond_to?(:invisible_context) ? command_clazz.invisible_context() : {}

    invisible_context.each do |ic|
      path = path.gsub(/\/#{ic}\//,'/')
    end
  end

  path
end

.get_command_class(command_name) ⇒ Object 



77
78
79
 
# File 'lib/shell/context.rb', line 77

def self.get_command_class(command_name)
  ::DTK::Client::OsUtil.get_dtk_class(command_name)
end

.load_session_history ⇒ Object

this file loads sessions history



1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/shell/context.rb', line 1015

def self.load_session_history()
  unless is_there_history_file()
    puts "[INFO] History file is missing, shell history will be disabled. To enable it create file: '#{HISTORY_LOCATION}'"
    return []
  end

  content = File.open(HISTORY_LOCATION,'r').read
  return (content.empty? ? [] : JSON.parse(content))
end

.require_command_class(command_name) ⇒ Object 



81
82
83
84
85
 
# File 'lib/shell/context.rb', line 81

def self.require_command_class(command_name)
  # normalize to file_names
  file_name = command_name.gsub('-','_')
  require File.expand_path("../commands/thor/#{file_name}", File.dirname(__FILE__))
end

.save_session_history(array_of_commands) ⇒ Object 



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
 
# File 'lib/shell/context.rb', line 1025

def self.save_session_history(array_of_commands)
  return [] unless is_there_history_file()
  # we filter the list to remove neighbour duplicates
  filtered_commands = []
  array_of_commands.each_with_index do |a,i|
    filtered_commands << a if (a != array_of_commands[i+1] && is_allowed_command?(a))
  end

  # make sure we only save up to 'COMMAND_HISTORY_LIMIT' commands
  if filtered_commands.size > COMMAND_HISTORY_LIMIT
    filtered_commands = filtered_commands[-COMMAND_HISTORY_LIMIT,COMMAND_HISTORY_LIMIT+1]
  end

  File.open(HISTORY_LOCATION,'w') { |f| f.write(filtered_commands.to_json) }
end

Instance Method Details

#change_context(args, cmd = []) ⇒ Object

Validates and changes context



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/shell/context.rb', line 127

def change_context(args, cmd=[])
  begin
    # check if we are doing switch context
    if args.join("").match(/\A\-\Z/)
      revert_context()
      return
    end

    # remember current context
    @previous_context = @active_context.clone_me()

    # jump to root
    reset if args.join('').match(/^\//)

    # begin
    # hack: used just to avoid entering assembly/id/node or workspace/node context (remove when include this contexts again)
    first_c, warning_message = nil, nil
    first_c = @active_context.context_list().first.name unless @active_context.context_list().empty?
    tmp_active_context = @active_context.clone_me
    restricted = is_restricted_context(first_c, args, tmp_active_context)

    args = restricted[:args]
    warning_message = restricted[:message]
    node_specific = restricted[:node_specific]

    DTK::Client::OsUtil.print_warning(warning_message) if warning_message
    # end

    # Validate and change context
    @active_context, error_message = prepare_context_change(args, @active_context, node_specific, cmd, true)

    load_context(active_context.last_context_name)

    if error_message
      revert_context()
      raise DTK::Client::DtkValidationError, error_message
    end
  rescue DTK::Client::DtkValidationError => e
    DTK::Client::OsUtil.print(e.message, :yellow)
  rescue DTK::Shell::Error, Exception => e
    DtkLogger.instance.error_pp(e.message, e.backtrace)
  ensure
    return shell_prompt()
  end
end

#check_for_id(context, command, tmp_active_context, args) ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/shell/context.rb', line 506

def check_for_id(context, command, tmp_active_context, args)
  command_clazz = Context.get_command_class(context)
  invisible_context = command_clazz.respond_to?(:invisible_context) ? command_clazz.invisible_context.map { |e| e.to_s } : []
  entries = args.first.split(/\//)

  entries = Context.check_for_sym_link(entries) if root?
  unless invisible_context.empty?
    if root?
      tmp_active_context.push_new_context(entries[0], entries[0])
      context_hash_data, error_message, invalid_context = validate_value(entries[0], entries[1], tmp_active_context)

      return if error_message
      tmp_active_context.push_new_context(context_hash_data[:name], entries[0], context_hash_data[:identifier])
      context_hash_data, error_message, invalid_context = validate_value(command, command, tmp_active_context)

      return if error_message
      tmp_active_context.push_new_context(context_hash_data[:name], command, context_hash_data[:identifier])
    end


    node_ids = get_command_identifiers(invisible_context.first.to_s, tmp_active_context)
    node_names = node_ids ? node_ids.collect { |e| e[:name] } : []
  end

  return node_names.include?(command)
end

#current_alt_identifier? ⇒ Boolean

Returns:

  • (Boolean) 


638
639
640
 
# File 'lib/shell/context.rb', line 638

def current_alt_identifier?
  return @active_context.current_alt_identifier?
end

#current_command? ⇒ Boolean

Returns:

  • (Boolean) 


630
631
632
 
# File 'lib/shell/context.rb', line 630

def current_command?
  return @active_context.current_command?
end

#current_context_task_names ⇒ Object

returns list of tasks for given command name



643
644
645
 
# File 'lib/shell/context.rb', line 643

def current_context_task_names()
  @cached_tasks.fetch(@active_context.get_task_cache_id(),[]).dup
end

#current_identifier? ⇒ Boolean

Returns:

  • (Boolean) 


634
635
636
 
# File 'lib/shell/context.rb', line 634

def current_identifier?
  return @active_context.current_identifier?
end

#dynamic_autocomplete_context(readline_input, line_buffer = []) ⇒ Object

this method is used to scan and provide context to be available Readline.complete_proc



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/shell/context.rb', line 174

def dynamic_autocomplete_context(readline_input, line_buffer=[])
  # special case indicator when user starts cc with '/' (go from root)
  goes_from_root = readline_input.start_with?('/')
  # Cloning existing active context, as all changes shouldn't be permanent, but temporary for autocomplete
  active_context_copy = @active_context.clone_me
  # Emptying context copy if it goes from root '/'
  active_context_copy.clear if goes_from_root
  # Invalid context is user leftover to be matched; i.e. 'cc /assembly/te' - 'te' is leftover
  invalid_context = ""

  # Validate and change context; skip step if user's input is empty or it is equal to '/'
  active_context_copy, error_message, invalid_context = prepare_context_change([readline_input], active_context_copy, nil, line_buffer) unless (readline_input.empty? || readline_input == "/")

  # using extended_context when we want to use autocomplete from other context
  # e.g. we are in assembly/apache context and want to create-component we will use extended context to add
  # component-templates to autocomplete
  extended_candidates, new_context, line_buffer_first = {}, nil, nil
  command_clazz = Context.get_command_class(active_context_copy.last_command_name)

  unless (line_buffer.empty? || line_buffer.strip().empty?)
    line_buffer = line_buffer.split(' ')
    line_buffer_last = line_buffer.last
    line_buffer_first = line_buffer.first
    line_buffer_first.gsub!('-','_') unless (line_buffer_first.nil? || line_buffer_first.empty?)
  end

  unless command_clazz.nil?
    extended_context = command_clazz.respond_to?(:extended_context) ? command_clazz.extended_context() : {}

    unless extended_context.empty?
      extended_context = extended_context[:context] || {}
      extended_context.select!{|k,v| line_buffer.include?(k.to_s)} if extended_context.respond_to?(:select!)

      if (extended_context[line_buffer_last] && !line_buffer_first.eql?(line_buffer_last))
        new_context = extended_context[line_buffer_last]
      elsif (extended_context[line_buffer[line_buffer.size-2]] && !line_buffer_first.eql?(extended_context[line_buffer[line_buffer.size-2]]))
        new_context = extended_context[line_buffer[line_buffer.size-2]]
      else
        new_context = extended_context[line_buffer_first.to_sym] unless line_buffer_first.nil? || line_buffer_first.empty?
      end

      unless new_context.nil?
        if new_context.is_a?(String)
          active_context_copy.push_new_context(new_context, new_context)
        elsif new_context.is_a?(Hash)
          context_candidates = load_extended_context_commands(new_context, active_context_copy)
          results_filter = (readline_input.match(/\/$/) && invalid_context.empty?) ? "" : readline_input.split("/").last
          results_filter ||= ""
          context_candidates = context_candidates.grep( /^#{Regexp.escape(results_filter)}/ )
          return context_candidates
        end
      end
    end
  end

  return get_ac_candidates(active_context_copy, readline_input, invalid_context, goes_from_root, line_buffer_first||{})
end

#get_ac_candidates(active_context_copy, readline_input, invalid_context, goes_from_root, line_buffer = []) ⇒ Object 



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/shell/context.rb', line 682

def get_ac_candidates(active_context_copy, readline_input, invalid_context, goes_from_root, line_buffer=[])
  # helper indicator for case when there are more options in current context and cc command is not ended with '/'
  cutoff_forcely = false
  # input string segment used to filter results candidates
  results_filter = (readline_input.match(/\/$/) && invalid_context.empty?) ? "" : readline_input.split("/").last
  results_filter ||= ""

  command_clazz = Context.get_command_class(active_context_copy.last_command_name)
  extended_context_commands = nil

  unless command_clazz.nil?
    extended_context = command_clazz.respond_to?(:extended_context) ? command_clazz.extended_context() : {}

    unless extended_context.empty?
      extended_context = extended_context[:command]
      extended_context.reject!{|k,v| k.to_s!=line_buffer} if extended_context
      extended_context_commands = extended_context[line_buffer.to_sym] unless (line_buffer.empty? || extended_context.nil?)
    end
  end

  if extended_context_commands
    context_candidates = load_extended_context_commands(extended_context_commands, active_context_copy)
  else
    # If command does not end with '/' check if there are more than one result candidate for current context
    if !readline_input.empty? && !readline_input.match(/\/$/) && invalid_context.empty? && !active_context_copy.empty?
      context_list = active_context_copy.context_list
      context_name = context_list.size == 1 ? nil : context_list[context_list.size-2] # if case when on 1st level, return root candidates
      context_candidates = get_ac_candidates_for_context(context_name, active_context_copy)
      cutoff_forcely = true
    else
      # If last context is command, load all identifiers, otherwise, load next possible context command; if no contexts, load root tasks
      context_candidates = get_ac_candidates_for_context(active_context_copy.last_context(), active_context_copy)
    end
  end

  # checking if results will contain context candidates based on input string segment
  context_candidates = context_candidates.grep( /^#{Regexp.escape(results_filter)}/ )

  # Show all context tasks if active context orignal and it's copy are on same context, and are not on root,
  # and if readline has one split result indicating user is not going trough n-level, but possibly executing a task
  task_candidates = []

  #task_candidates = @context_commands if (active_context_copy.last_context_name() == @active_context.last_context_name() && !active_context_copy.empty?)
  task_candidates = @context_commands if (active_context_copy.last_context_name() == @active_context.last_context_name() && !active_context_copy.empty? && readline_input.split("/").size <= 1)

  # create results object filtered by user input segment (results_filter)
  task_candidates = task_candidates.grep( /^#{Regexp.escape(results_filter)}/ )

  # autocomplete candidates are both context and task candidates; remove duplicates in results
  results = context_candidates

  # if command is 'cc/cd/pushc' displat only context candidates
  if line_buffer.empty?
    results += task_candidates
  else
    is_cc = line_buffer.split(' ')
    results += task_candidates unless (IDENTIFIERS_ONLY.include?(is_cc.first) || extended_context_commands)
  end

  # remove duplicate context or task candidates
  results.uniq!

  # Send system beep if there are no candidates
  if results.empty?
    print "\a"
    return []
  end

  # default value of input user string
  input_context_path = readline_input

  # cut off last context if it is leftover (invalid_context),
  # or if last context is not finished with '/' and it can have more than option for current context
  # i.e. dtk> cc assembly - have 2 candidates: 'assembly' and 'assembly-template'
  if !invalid_context.empty? || cutoff_forcely
    start_index = goes_from_root ? 1 : 0 # if it starts with / don't take first element after split
    input_context_path = readline_input.split("/")[start_index.. -2].join("/")
    input_context_path = input_context_path + "/" unless input_context_path.empty?
    input_context_path = "/" + input_context_path if goes_from_root
  end

  # Augment input string with candidates to satisfy thor
  results = results.map { |element| (input_context_path + element) }

  # If there is only one candidate, and candidate is not task operation
  #return (results.size() == 1 && !context_candidates.empty?) ? (results.first + "/") : results
  return results

end

#get_ac_candidates_for_context(context, active_context_copy) ⇒ Object 



772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/shell/context.rb', line 772

def get_ac_candidates_for_context(context, active_context_copy)
  # If last context is command, load all identifiers, otherwise, load next possible context command; if no contexts, load root tasks
  if context
    if context.is_command?
      command_identifiers   = get_command_identifiers(context.name, active_context_copy)
      n_level_ac_candidates = command_identifiers ? command_identifiers.collect { |e| e[:name] } : []
    else
      command_clazz         = Context.get_command_class(active_context_copy.last_command_name)
      root_clazz            = DTK::Shell::Context.get_command_class(active_context_copy.first_command_name)
      valid_all_children    = (root_clazz != command_clazz) ? (root_clazz.all_children() + root_clazz.valid_children()) : []
      n_level_ac_candidates = command_clazz.respond_to?(:valid_children) ? command_clazz.valid_children.map { |e| e.to_s } : []

      n_level_ac_candidates.select {|v| valid_all_children.include?(v.to_sym)} unless valid_all_children.empty?
      invisible_context = command_clazz.respond_to?(:invisible_context) ? command_clazz.invisible_context.map { |e| e.to_s } : []

      unless invisible_context.empty?
        node_ids = get_command_identifiers(invisible_context.first.to_s, active_context_copy)
        node_names = node_ids ? node_ids.collect { |e| e[:name] } : []

        n_level_ac_candidates.concat(node_names)
      end

      # restrict autocomple to utils subcontext in service/service_name/node_group only
      if active_context_copy.last_context_is_shadow_entity? && active_context_copy.last_context().shadow_entity().eql?('node_group')
        n_level_ac_candidates.delete('utils')
      end

      n_level_ac_candidates
    end
  else
    n_level_ac_candidates =  ROOT_TASKS
  end
end

#get_command_identifiers(thor_command_name, active_context_copy = nil) ⇒ Object

get class identifiers for given thor command, returns array of identifiers



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File 'lib/shell/context.rb', line 807

def get_command_identifiers(thor_command_name, active_context_copy=nil)
  begin
    command_clazz = Context.get_command_class(thor_command_name)

    if command_clazz && command_clazz.list_method_supported?
      # take just hashed arguemnts from multi return method
      hashed_args = get_command_parameters(thor_command_name, [], active_context_copy)[2]
      return command_clazz.get_identifiers(@conn, hashed_args)
    end
  rescue DTK::Client::DtkValidationError => e
    # TODO Check if handling needed. Error should happen only when autocomplete ID search illigal
  end

  return []
end

#get_command_parameters(cmd, args, active_context_copy = nil) ⇒ Object

We use enrich data to help when using dynamic_context loading, Readline.completition_proc See bellow for more details



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'lib/shell/context.rb', line 913

def get_command_parameters(cmd,args, active_context_copy=nil)
  # To support autocomplete feature, temp active context may be forwarded into method
  active_context_copy = @active_context unless active_context_copy

  entity_name, method_name, option_types = nil, nil, nil

  context_params = ContextParams.new

  if root? && !args.empty?
    # this means that somebody is calling command with assembly/.. method_name
    entity_name = cmd
    method_name = args.shift
  else
    context_params.current_context = active_context_copy.clone_me
    entity_name = active_context_copy.name_list.first
    entity_name ||= "dtk"
    method_name = cmd
  end

  # extract thor options
  clazz = Context.get_command_class(entity_name)
  current_context_command = active_context_copy.last_command_name

  if ((current_context_command != entity_name) && !current_context_command.eql?("utils"))
    current_context_clazz = Context.get_command_class(current_context_command)
    options = Context.get_thor_options(current_context_clazz, cmd) if current_context_clazz
  else
    options = Context.get_thor_options(clazz, cmd) if clazz
  end

  # set rest of arguments as method options
  args, thor_options, invalid_options = Context.parse_thor_options(args, options)
  context_params.method_arguments = args

  return entity_name, method_name, context_params, thor_options, invalid_options
end

#get_dtk_command_parameters(entity_name, args) ⇒ Object

Raises:



862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'lib/shell/context.rb', line 862

def get_dtk_command_parameters(entity_name, args)
  method_name, entity_name_id = nil, nil
  context_params = ContextParams.new

  if (ROOT_TASKS + ['dtk']).include?(entity_name)
    Context.require_command_class(entity_name)
    available_tasks = Context.get_command_class(entity_name).task_names
    if available_tasks.include?(args.first)
      method_name = args.shift
    else
      entity_name_id = args.shift
      method_name = args.shift
    end
  else
    raise DTK::Client::DtkError, "Could not find context \"#{entity_name}\"."
  end

  # if no method specified use help
  method_name ||= 'help'

  context_params.add_context_to_params(entity_name, entity_name)

  if entity_name_id
    identifier_response = valid_id?(entity_name, entity_name_id, context_params)
    if identifier_response
      context_params.add_context_to_params(identifier_response[:name], entity_name, identifier_response[:identifier])
    else
      raise DTK::Client::DtkError, "Could not validate identifier \"#{entity_name_id}\"."
    end
  end

  # extract thor options
  clazz              = Context.get_command_class(entity_name)
  options            = Context.get_thor_options(clazz, method_name) unless clazz.nil?
  args, thor_options, invalid_options = Context.parse_thor_options(args, options)
  context_params.method_arguments = args


  unless available_tasks.include?(method_name)
    raise DTK::Client::DtkError, "Could not find task \"#{method_name}\"."
  end

  raise DTK::Client::DtkValidationError, "Option '#{invalid_options.first}' is not valid for current command!" unless invalid_options.empty?

  return entity_name, method_name, context_params, thor_options
end

#is_restricted_context(first_c, args = [], tmp_active_context = nil) ⇒ Object

hack: used just to avoid entering assembly/id/node or workspace/node context (remove when include this contexts again)



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/shell/context.rb', line 448

def is_restricted_context(first_c, args = [], tmp_active_context=nil)
  entries = args.first.split(/\//)
  invalid_context = ["workspace/node", "service/node"]
  double_dots_count = DTK::Shell::ContextAux.count_double_dots(entries)
  only_double_dots = entries.select{|e| !e.to_s.include?('..')}||[]
  back_flag = false

  last_from_current, message = nil, nil
  unless (root? || double_dots_count==0 || !only_double_dots.empty?)
    test_c = @previous_context
    test_c.pop_context(double_dots_count)
    last_from_current = test_c.last_context_name
    back_flag = true
  end

  unless args.empty?
    first_c ||= entries.first
    last_c = last_from_current||entries.last

    invalid_context.each do |ac|
      if ac.eql?("#{first_c}/#{last_c}")
        unless last_from_current
          last_1, last_2 = entries.last(2)
          if last_1.eql?(last_2)
            args = entries.join('/')
            return {:args => [args], :node_specific => true}
          end
        end
        message = "'#{last_c}' context is not valid."
        is_valid_id = check_for_id(first_c, last_c, tmp_active_context, args)

        # if ../ to node context, add one more .. to go to previous context (assembly/id or workspace)
        if back_flag
          message = nil
          entries << ".." if is_valid_id==false
        else
          if is_valid_id==false
            entries.pop
          else
            message = nil
          end
        end

        args = (entries.size<=1 ? entries : entries.join('/'))
        args = args.is_a?(Array) ? args : [args]
        if args.empty?
          raise DTK::Client::DtkValidationError, message
        else
          return {:args => args, :message => message, :node_specific => true}
        end

      end
    end
  end

  return {:args => args, :message => message}
end

#load_context(command_name = nil) ⇒ Object

load context will load list of commands available for given command (passed) to method. Context is list of command available at current tier.



553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/shell/context.rb', line 553

def load_context(command_name=nil)
  # when switching to tier 2 we need to use command name from tier one
  # e.g. cc library/public, we are caching context under library_1, library_2
  # so getting context for 'public' will not work and we use than library
  command_name = root? ? 'dtk' : @active_context.last_command_name

  if @active_context.last_context_is_shadow_entity?
    @current = ShadowEntity.resolve_tasks(@active_context.last_context)
  else
    # if there is no new context (current) we use old one
    @current = current_context_task_names() || @current
  end

  client_commands = CLIENT_COMMANDS
  client_commands.concat(DEV_COMMANDS) if DTK::Configuration.get(:development_mode)

  # we add client commands
  @current.concat(client_commands).sort!

  # holder for commands to be used since we do not want to remember all of them
  @context_commands = @current

  # we load thor command class identifiers for autocomplete context list
  command_context = get_command_identifiers(command_name)

  command_name_list = command_context ? command_context.collect { |e| e[:name] } : []
  @context_commands.concat(command_name_list) if current_command?


  # logic behind context loading
  #Readline.completer_word_break_characters=" "
  Readline.completion_proc = proc { |input| dynamic_autocomplete_context(input, Readline.respond_to?("line_buffer") ? Readline.line_buffer : [])}
end

#load_extended_context_commands(extended_context_commands, active_context_copy) ⇒ Object 



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File 'lib/shell/context.rb', line 823

def load_extended_context_commands(extended_context_commands, active_context_copy)
  candidates        = []
  entity_name       = active_context_copy.last_context
  parent_entity     = active_context_copy.context_list[1]
  response_ruby_obj = nil

  field    = extended_context_commands[:field]||'display_name'
  endpoint = extended_context_commands[:endpoint]
  url      = extended_context_commands[:url]
  opts     = extended_context_commands[:opts]||{}

  if entity_name.is_identifier?
    if (parent_entity && parent_entity.is_identifier? && (parent_entity != entity_name))
      parent_id_label = "#{endpoint}_id".to_sym
      parent_id = parent_entity.identifier
      opts[parent_id_label] = parent_id
      id_label = "#{entity_name.entity}_id".to_sym
    end

    id_label ||= "#{endpoint}_id".to_sym
    id = entity_name.identifier
    opts[id_label] = id

    response_ruby_obj = DTK::Client::CommandBaseThor.get_cached_response(endpoint, url, opts)
    # response_ruby_obj = post rest_url(url), opts
  else
    response_ruby_obj = DTK::Client::CommandBaseThor.get_cached_response(endpoint, url, opts)
    # response_ruby_obj = post rest_url(url), opts
  end

  if response_ruby_obj && response_ruby_obj.ok?
    response_ruby_obj.data.each do |d|
      candidates << d[field]
    end
  end

  candidates
end

#method_valid?(method_name) ⇒ Boolean

checks if method name is valid in current context

Returns:

  • (Boolean) 


648
649
650
651
 
# File 'lib/shell/context.rb', line 648

def method_valid?(method_name)
  # validate method, see if we support given method in current tasks
  (current_context_task_names() + ['help']).include?(method_name)
end

#pop_from_active_context ⇒ Object

remove last active command, and returns it



660
661
662
 
# File 'lib/shell/context.rb', line 660

def pop_from_active_context
  return @active_context.pop_context
end

#prepare_context_change(args, active_context_copy, node_specific = nil, line_buffer = [], on_complete = false) ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/shell/context.rb', line 309

def prepare_context_change(args, active_context_copy, node_specific=nil, line_buffer=[], on_complete=false)
  # split original cc command
  entries = args.first.split(/\//)

  # transform alias to full path
  entries = Context.check_for_sym_link(entries) if root?
  entries = Context.check_invisible_context(active_context_copy, entries, root?, line_buffer, args, self)

  # if only '/' or just cc skip validation
  return active_context_copy if entries.empty?

  current_context_clazz, error_message, current_index = nil, nil, 0
  double_dots_count = DTK::Shell::ContextAux.count_double_dots(entries)

  # we remove '..' from our entries
  entries = entries.select { |e| !(e.empty? || DTK::Shell::ContextAux.is_double_dot?(e)) }

  # need this for autocomplete from service/node to service/utils
  is_utils = active_context_copy.last_command_name.eql?('utils')

  # we go back in context based on '..'
  active_context_copy.pop_context(double_dots_count)

  # if cd ../utils from service/node
  if active_context_copy.current_command? && active_context_copy.last_command_name.eql?('node')
    active_context_copy.pop_context(1)
    entries = Context.check_invisible_context(active_context_copy, entries, root?, line_buffer, args, self)
  end

  # need this for autocomplete from service/node to service/utils
  if is_utils
    entries = Context.check_invisible_context(active_context_copy, entries, root?, line_buffer, args, self)
  end

  # if cd .. back to node, skip node context and go to assembly/workspace context
  if (active_context_copy.last_context && entries)
    active_context_copy.pop_context(1) if (node_specific && active_context_copy.last_context.is_command? && active_context_copy.last_command_name.eql?("node") && on_complete)
  end

  # special case when using workspace context
  # if do cd .. from workspace/workspace identifier go directly to root not to workspace
  if active_context_copy.name_list.include?("workspace")
    count_workspaces = active_context_copy.name_list.inject(Hash.new(0)) {|h,i| h[i] += 1; h }
    # don't need this since we can have workspace service instance
    # active_context_copy.pop_context(1) if count_workspaces['workspace']==1
  end

  # we add active commands array to begining, using dup to avoid change by ref.
  context_name_list = active_context_copy.name_list
  entries = context_name_list + entries

  # we check the size of active commands
  ac_size = context_name_list.size

  invalid_context = ""
  # check each par for command / value
  (0..(entries.size-1)).step(2) do |i|
    command       = entries[i]
    value         = entries[i+1]

    clazz = DTK::Shell::Context.get_command_class(command)
    error_message, invalid_context = validate_command(clazz, current_context_clazz, command, active_context_copy)

    # restrict utils subcontext in service/service_name/node_group only
    if active_context_copy.last_context_is_shadow_entity? && active_context_copy.last_context.shadow_entity().eql?('node_group')
      if current_context_clazz.respond_to?(:multi_context_children)
        multi_context_children = current_context_clazz.multi_context_children()
        if command.eql?('utils') && multi_context_children.include?(command.to_sym)
          return active_context_copy, "'#{command}' context is not valid.", invalid_context
        end
      end
    end

    break if error_message
    # if we are dealing with new entries add them to active_context
    active_context_copy.push_new_context(command, command) if (i >= ac_size)
    current_context_clazz = clazz

    if value
      # context_hash_data is hash with :name, :identifier values
      context_hash_data, error_message, invalid_context = validate_value(command, value, active_context_copy)
      if error_message
        # hack: used just to avoid entering assembly/id/node or workspace/node context (remove when include this contexts again)
        if ((@active_context.last_context_name.eql?("node") || node_specific) && !@active_context.first_context_name().eql?("node") )
          active_context_copy.pop_context(1)
        end
        break
      end

      active_context_copy.push_new_context(context_hash_data[:name], command, context_hash_data[:identifier], context_hash_data[:shadow_entity]) if ((i+1) >= ac_size)
    end
  end

  return active_context_copy, error_message, invalid_context
end

#push_context ⇒ Object 



587
588
589
590
591
 
# File 'lib/shell/context.rb', line 587

def push_context()
  raise "DEV WE need to RE-IMPLEMENT this."
  @current_path = @active_context.full_path()
  @dirs.unshift(@current_path) unless @current_path.nil?
end

#push_to_active_context(context_name, entity_name, context_value = nil) ⇒ Object

adds command to current list of active commands



655
656
657
 
# File 'lib/shell/context.rb', line 655

def push_to_active_context(context_name, entity_name, context_value = nil)
  @active_context.push_new_context(context_name, entity_name, context_value)
end

#reload_cached_tasks(command_name) ⇒ Object

when e.g assembly is deleted we want it to be removed from list without exiting dtk-shell



609
610
611
612
613
614
 
# File 'lib/shell/context.rb', line 609

def reload_cached_tasks(command_name)
  # we clear @current since this will be reloaded
  @current = nil

  load_context(command_name)
end

#reset ⇒ Object

resets context



594
595
596
597
 
# File 'lib/shell/context.rb', line 594

def reset
  @active_context.clear
  load_context()
end

#revert_context ⇒ Object 



599
600
601
602
603
604
605
 
# File 'lib/shell/context.rb', line 599

def revert_context()
  if @previous_context
    # swap 2 variables
    @active_context, @previous_context = @previous_context, @active_context
  end
  load_context(active_context.last_context_name)
end

#root? ⇒ Boolean

returns true if context is on root at the moment

Returns:

  • (Boolean) 


626
627
628
 
# File 'lib/shell/context.rb', line 626

def root?
  return @active_context.empty?
end

#root_tasks ⇒ Object 



621
622
623
 
# File 'lib/shell/context.rb', line 621

def root_tasks
  return @cached_tasks['dtk']
end

#shell_prompt ⇒ Object

gets current path for shell



617
618
619
 
# File 'lib/shell/context.rb', line 617

def shell_prompt
  return root? ? DTK_ROOT_PROMPT : "dtk:#{@active_context.full_path}>"
end

#valid_id?(thor_command_name, value, override_context_params = nil, active_context_copy = nil) ⇒ Boolean

calls ‘valid_id?’ method in Thor class to validate ID/NAME

Returns:

  • (Boolean) 


665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/shell/context.rb', line 665

def valid_id?(thor_command_name,value, override_context_params=nil, active_context_copy=nil)

  command_clazz = Context.get_command_class(thor_command_name)
  if command_clazz.list_method_supported?
    if override_context_params
      context_params = override_context_params
    else
      context_params = get_command_parameters(thor_command_name, [], active_context_copy)[2]
    end

    tmp = command_clazz.valid_id?(value, @conn, context_params)
    return tmp
  end

  return nil
end

#validate_command(clazz, current_context_clazz, command, active_context_copy = nil) ⇒ Object 



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/shell/context.rb', line 405

def validate_command(clazz, current_context_clazz, command, active_context_copy=nil)
  error_message = nil
  invalid_context = ""

  # if command class did not found or if command ends with '-'
  if (clazz.nil? || command.match(/-$/))
    error_message = "Context for '#{command}' could not be loaded.";
    invalid_context = command
  end

  # check if previous context support this one as a child
  unless current_context_clazz.nil?
    # valid child method is necessery to define parent-child relet.
    if current_context_clazz.respond_to?(:valid_child?)
      root_clazz = DTK::Shell::Context.get_command_class(active_context_copy.first_command_name)
      all_children = root_clazz.all_children() + root_clazz.valid_children()

      valid_all_children = (root_clazz != current_context_clazz) ? all_children.include?(command.to_sym) : true
      unless (current_context_clazz.valid_child?(command) && valid_all_children)

        error_message = "'#{command}' context is not valid."
        invalid_context = command

        if current_context_clazz.respond_to?(:invisible_context)
          ic = current_context_clazz.invisible_context()
          ic.each do |c|
            if c.to_s.include?(command)
              return nil, ""
            end
          end
        end
      end
    else
      error_message = "'#{command}' context is not valid."
      invalid_context = command
    end
  end

  return error_message, invalid_context
end

#validate_value(command, value, active_context_copy = nil) ⇒ Object 



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/shell/context.rb', line 535

def validate_value(command, value, active_context_copy=nil)
  context_hash_data = nil
  invalid_context = ""
   # check value
  if value
    context_hash_data = valid_id?(command, value, nil, active_context_copy)
    unless context_hash_data
      error_message = "Identifier '#{value}' is not valid."
      # error_message = "Identifier '#{value}' for context '#{command}' is not valid";
      invalid_context = value
    end
  end

  return context_hash_data, error_message, invalid_context
end