dtk-client 0.7.4.1 → 0.7.5

data/lib/commands/thor/workspace.rb

@@ -20,7 +20,7 @@ module DTK::Client
       include PurgeCloneMixin
       include AssemblyWorkspaceMixin
       include ActionResultHandler
-      
+
       def get_workspace_name(workspace_id)
         get_name_from_id_helper(workspace_id)
       end
@@ -43,7 +43,7 @@ module DTK::Client
     end
 
     # 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 
+    # e.g. we are in assembly/apache context and want to create-component we will use extended context to add
     # component-templates to autocomplete
     def self.extended_context()
       {
@@ -56,13 +56,13 @@ module DTK::Client
         },
         :command => {
           :edit_component_module => {
-            :endpoint => "assembly", 
-            :url => "assembly/info_about", 
+            :endpoint => "assembly",
+            :url => "assembly/info_about",
             :opts => {:subtype=>"instance", :about=>"modules"}
           },
           :push_component_module_updates => {
-            :endpoint => "assembly", 
-            :url => "assembly/info_about", 
+            :endpoint => "assembly",
+            :url => "assembly/info_about",
             :opts => {:subtype=>"instance", :about=>"modules"}
           },
           :delete_node => {
@@ -142,7 +142,7 @@ module DTK::Client
           ]
         },
         :identifier_only => {
-          :node      => [
+          :node => [
             ['add-component',"add-component COMPONENT","# Add a component to the node."],
             ['delete-component',"delete-component COMPONENT-NAME [-y]","# Delete component from workspace's node"],
             ['info',"info","# Return info about node instance belonging to given workspace."],
@@ -154,7 +154,7 @@ module DTK::Client
             ['stop', "stop", "# Stop node instance."],
             ['ssh', "ssh REMOTE-USER [-i PATH-TO-PEM]","# SSH into node, optional parameters are path to identity file."]
           ],
-          
+
           :component => [
             ['info',"info","# Return info about component instance belonging to given node."],
             ['edit',"edit","# Edit component module related to given component."],
@@ -181,11 +181,20 @@ module DTK::Client
     #  clear_tasks_aux(context_params)
     #end
 
+    desc "WORKSPACE-NAME/ID execute-workflow WORKFLOW-ACTION [WORKFLOW-PARAMS] [-m COMMIT-MSG]", "Execute workflow."
+    method_option "commit_msg",:aliases => "-m",
+      :type => :string,
+      :banner => "COMMIT-MSG",
+      :desc => "Commit message"
+    def execute_workflow(context_params)
+      converge_aux(context_params)
+    end
+
     desc "WORKSPACE-NAME/ID converge [-m COMMIT-MSG]", "Converge workspace instance."
     method_option "commit_msg",:aliases => "-m" ,
       :type => :string,
       :banner => "COMMIT-MSG",
-      :desc => "Commit message" 
+      :desc => "Commit message"
     def converge(context_params)
       converge_aux(context_params)
     end
@@ -205,7 +214,7 @@ module DTK::Client
 
     desc "WORKSPACE-NAME/ID push-assembly-updates [NAMESPACE:]SERVICE-MODULE-NAME/ASSEMBLY-NAME", "Push changes made to this workspace to the designated assembly."
     def push_assembly_updates(context_params)
-      workspace_id, qualified_assembly_name = context_params.retrieve_arguments([:workspace_id!,:option_1!],method_argument_names) 
+      workspace_id, qualified_assembly_name = context_params.retrieve_arguments([:workspace_id!,:option_1!],method_argument_names)
       if qualified_assembly_name =~ /(^[^\/]*)\/([^\/]*$)/
         service_module_name, assembly_template_name = [$1,$2]
       else
@@ -218,7 +227,7 @@ module DTK::Client
     end
 
     desc "WORKSPACE-NAME/ID create-assembly [NAMESPACE:]SERVICE-MODULE-NAME ASSEMBLY-NAME [-p] [-m DESCRIPTION]", "Create a new assembly from the workspace instance in the designated service module."
-   # The option -p will purge the workspace after assembly creation." 
+   # The option -p will purge the workspace after assembly creation."
     method_option :purge, :aliases => '-p', :type => :boolean, :default => false
     method_option "description",:aliases => "-m" ,
       :type => :string,
@@ -257,7 +266,7 @@ module DTK::Client
 
     #only supported at node-level
     # using HIDE_FROM_BASE to hide this command from base context (dtk:/workspace>)
-    desc "HIDE_FROM_BASE add-component NODE-NAME COMPONENT", "Add a component to a workspace."
+    desc "WORKSPACE-NAME/ID add-component COMPONENT", "Add a component to a workspace."
     def add_component(context_params)
       response = create_component_aux(context_params)
       return response unless response.ok?
@@ -319,18 +328,18 @@ module DTK::Client
         response = delete_component_aux(context_params)
         return response unless response.ok?
         @@invalidate_map << :service_node_component
-        
+
         response
       end
       # delete_aux(context_params)
     end
 
     # using HIDE_FROM_BASE to hide this command from base context (dtk:/workspace>)
-    desc "HIDE_FROM_BASE delete-component COMPONENT-NAME [-y]","Delete component from the workspace."
+    desc "WORKSPACE-NAME/ID delete-component COMPONENT-NAME [-y]","Delete component from the workspace."
     method_option :force, :aliases => '-y', :type => :boolean, :default => false
     def delete_component(context_params)
       response = delete_component_aux(context_params)
-      
+
       @@invalidate_map << :service
       @@invalidate_map << :service_node
       @@invalidate_map << :service_node_component
@@ -379,9 +388,15 @@ module DTK::Client
       edit_module_aux(context_params)
     end
 
-    desc "WORKSPACE-NAME/ID edit-workflow", "Edit workflow"
+    desc "WORKSPACE-NAME/ID create-workflow WORKFLOW-NAME [--from BASE-WORKFLOW-NAME]", "Create a new workflow in the workspace."
+    method_option :from, :type => :string
+    def create_workflow(context_params)
+      edit_or_create_workflow_aux(context_params,:create => true,:create_from => options.from)
+    end
+
+    desc "WORKSPACE-NAME/ID edit-workflow [WORKFLOW-NAME]", "Edit a workflow in the workspace."
     def edit_workflow(context_params)
-      edit_workflow_aux(context_params)
+      edit_or_create_workflow_aux(context_params)
     end
 
     desc "WORKSPACE-NAME/ID edit-attributes", "Edit workspace's attributes."
@@ -399,7 +414,7 @@ module DTK::Client
 # TODO: DTK-2027 might subsume by the dtk actions; currently server changes does not support this command
     # using HIDE_FROM_BASE to hide this command from base context (dtk:/workspace>)
     desc "HIDE_FROM_BASE execute-tests [--component COMPONENT-NAME] [--timeout TIMEOUT]", "Execute tests. --component filters execution per component, --timeout changes default execution timeout"
-    method_option :component, :type => :string, :desc => "Component name" 
+    method_option :component, :type => :string, :desc => "Component name"
     method_option :timeout, :type => :string, :desc => "Timeout"
     def execute_tests(context_params)
       execute_tests_aux(context_params)
@@ -436,7 +451,7 @@ module DTK::Client
     def list_ssh_access(context_params)
       list_ssh_access_aux(context_params)
     end
-    
+
     desc "WORKSPACE-NAME/ID info", "Get info about content of the workspace."
     def info(context_params)
       info_aux(context_params)
@@ -447,11 +462,6 @@ module DTK::Client
       link_attributes_aux(context_params)
     end
 
-    #desc "WORKSPACE-NAME/ID list-attribute-mappings SERVICE-LINK-NAME/ID", "List attribute mappings associated with service link"
-    #def list_attribute_mappings(context_params)
-    #  list_attribute_mappings_aux(context_params)
-    #end
-
     desc "list", ""
     def list(context_params)
       if context_params.is_last_command_eql_to?(:node)
@@ -460,7 +470,7 @@ module DTK::Client
     end
 
     desc "WORKSPACE-NAME/ID list-attributes [-f FORMAT] [-t TAG,..] [--links]","List attributes associated with workspace."
-    method_option :format, :aliases => '-f' 
+    method_option :format, :aliases => '-f'
     method_option :tags, :aliases => '-t'
     method_option :links, :type => :boolean, :default => false, :aliases => '-l'
     def list_attributes(context_params)
@@ -493,11 +503,16 @@ module DTK::Client
       list_tasks_aux(context_params)
     end
 
-    desc "WORKSPACE-NAME/ID workflow-info", "Get the structure of the workflow associated with workspace."
+    desc "WORKSPACE-NAME/ID workflow-info [WORKFLOW-NAME]", "Get the contents of a workflow associated with the workspace."
     def workflow_info(context_params)
       workflow_info_aux(context_params)
     end
 
+    desc "WORKSPACE-NAME/ID workflow-list", "List the workflows associated with the workspace."
+    def workflow_list(context_params)
+      workflow_list_aux(context_params)
+    end
+
     desc "WORKSPACE-NAME/ID list-violations", "Finds violations in the workspace that will prevent a converge operation."
     def list_violations(context_params)
       list_violations_aux(context_params)
@@ -525,8 +540,10 @@ module DTK::Client
       set_target_aux(context_params)
     end
 
-    desc "WORKSPACE-NAME/ID set-attribute ATTRIBUTE-NAME [VALUE] [-u]", "(Un)Set attribute value. The option -u will unset the attribute's value."
+    desc "WORKSPACE-NAME/ID set-attribute ATTRIBUTE-NAME [VALUE] [-u] [-c] [-n]", "(Un)Set attribute value. The option -u will unset the attribute's value, -c to set component-attribute, -n to set node-attribute."
     method_option :unset, :aliases => '-u', :type => :boolean, :default => false
+    method_option :component_attribute, :aliases => '-c', :type => :boolean, :default => false
+    method_option :node_attribute, :aliases => '-n', :type => :boolean, :default => false
     def set_attribute(context_params)
       set_attribute_aux(context_params)
     end

data/lib/context_router.rb

@@ -6,8 +6,12 @@ module DTK
     #
     class ContextRouter
 
+      extend DTK::Client::Auxiliary
+
       # This method invokes target context task
       def self.routeTask(target_context, target_method, target_context_params, conn)
+        target_context = target_context.to_s
+        target_method  = target_method.to_s
 
         # Initing required params and invoking target_context.target_method
         load_command(target_context)

data/lib/core.rb

@@ -33,7 +33,7 @@ def top_level_execute(entity_name, method_name, context_params=nil, options_args
   rescue DTK::Client::DtkLoginRequiredError
     # re-logging user and repeating request
     DTK::Client::OsUtil.print("Session expired: re-establishing session & repeating given task", :yellow)
-    DTK::Client::Session.re_initialize()
+    DTK::Client::Session.re_initialize
     top_level_execute_core(entity_name, method_name, context_params, options_args, shell_execute)
   end
 end
@@ -48,7 +48,7 @@ def top_level_execute_core(entity_name, method_name, context_params=nil, options
 
     entity_name = entity_name.gsub("-","_")
     load_command(entity_name)
-    conn = DTK::Client::Session.get_connection()
+    conn = DTK::Client::Session.get_connection
 
     # if connection parameters are not set up properly then don't execute any command
     return if validate_connection(conn)
@@ -63,23 +63,11 @@ def top_level_execute_core(entity_name, method_name, context_params=nil, options
 
     response_ruby_obj = entity_class.execute_from_cli(conn,method_name,context_params,options_args,shell_execute)
 
-    # this will raise error if found
-    DTK::Client::ResponseErrorHandler.check(response_ruby_obj)
-
-    # this will find appropriate render adapter and give output, returns boolean
-    if print = response_ruby_obj.render_data()
-      print = [print] unless print.kind_of?(Array)
-      print.each do |el|
-        if el.kind_of?(String)
-          el.each_line{|l| STDOUT << l}
-        else
-          PP.pp(el,STDOUT)
-        end
-      end
-    end
+    # it will raise DTK::Client::Error in case of error response
+    print_method_response!(response_ruby_obj)
 
     # process/print queued message from server
-    DTK::Shell::MessageQueue.print_messages()
+    DTK::Shell::MessageQueue.print_messages
 
   rescue DTK::Client::DtkLoginRequiredError => e
     # this error is handled in method above
@@ -107,7 +95,25 @@ def top_level_execute_core(entity_name, method_name, context_params=nil, options
     # this are expected application errors
     DtkLogger.instance.error_pp(e.message, e.backtrace)
   rescue Exception => e
-    DtkLogger.instance.fatal_pp("[INTERNAL ERROR] DTK has encountered an error #{e.class}: #{e.message}", e.backtrace)
+    client_internal_error = DTK::Client::DtkError::Client.label()
+    DtkLogger.instance.fatal_pp("[#{client_internal_error}] DTK has encountered an error #{e.class}: #{e.message}", e.backtrace)
+  end
+end
+
+def print_method_response!(response_ruby_obj)
+  # this will raise error if found
+  DTK::Client::ResponseErrorHandler.check(response_ruby_obj)
+
+  # this will find appropriate render adapter and give output, returns boolean
+  if print = response_ruby_obj.render_data
+    print = [print] unless print.kind_of?(Array)
+    print.each do |el|
+      if el.kind_of?(String)
+        el.each_line{|l| STDOUT << l}
+      else
+        PP.pp(el,STDOUT)
+      end
+    end
   end
 end
 
@@ -125,6 +131,8 @@ def validate_connection(connection)
     puts "\nDTK will now exit. Please set up your connection properly and try again."
     return true
   end
+
+  false
 end
 
 # check if .add_direct_access file exists, if not then add direct access and create .add_direct_access file
@@ -133,13 +141,13 @@ def resolve_direct_access(params, config_exists=nil)
 
   puts "Processing ..." if config_exists
   # check to see if catalog credentials are set
-  conn = DTK::Client::Session.get_connection()
+  conn = DTK::Client::Session.get_connection
   response = conn.post DTK::Client::CommandBase.class, conn.rest_url("account/check_catalog_credentials"), {}
 
   # set catalog credentails
   if response.ok? && !response.data['catalog_credentials_set']
     # setting up catalog credentials
-    catalog_creds = DTK::Client::Configurator.ask_catalog_credentials()
+    catalog_creds = DTK::Client::Configurator.ask_catalog_credentials
     unless catalog_creds.empty?
       response = conn.post DTK::Client::CommandBase.class, conn.rest_url("account/set_catalog_credentials"), { :username => catalog_creds[:username], :password => catalog_creds[:password], :validate => true}
       if errors = response['errors']
@@ -149,20 +157,20 @@ def resolve_direct_access(params, config_exists=nil)
   end
 
   # response = DTK::Client::Account.add_access(params[:ssh_key_path])
-  response, matched_pub_key, matched_username = DTK::Client::Account.add_key(params[:ssh_key_path])
+  response, matched_pub_key, matched_username = DTK::Client::Account.add_key(params[:ssh_key_path], true, "#{DTK::Client::Session.connection_username}-client")
 
   if !response.ok?
     DTK::Client::OsUtil.print("We were not able to add access for current user. #{response.error_message}. In order to properly use dtk-shell you will have to add access manually ('dtk account add-ssh-key').\n", :yellow)
   elsif matched_pub_key
     # message will be displayed by add key # TODO: Refactor this flow
     DTK::Client::OsUtil.print("Provided SSH PUB key has already been added.", :yellow)
-    DTK::Client::Configurator.add_current_user_to_direct_access()
+    DTK::Client::Configurator.add_current_user_to_direct_access
   elsif matched_username
     DTK::Client::OsUtil.print("User with provided name already exists.", :yellow)
   else
     # commented out because 'add_key' method called above will also print the same message
     # DTK::Client::OsUtil.print("Your SSH PUB key has been successfully added.", :yellow)
-    DTK::Client::Configurator.add_current_user_to_direct_access()
+    DTK::Client::Configurator.add_current_user_to_direct_access
   end
 
   response
@@ -173,10 +181,10 @@ module DTK
     class ResponseErrorHandler
       class << self
 
-        def check_for_session_expiried(response_ruby_obj)
+        def check_for_session_expiried(response)
           error_code = nil
-          if response_ruby_obj && response_ruby_obj['errors']
-            response_ruby_obj['errors'].each do |err|
+          if response && response['errors']
+            response['errors'].each do |err|
               error_code      = err["code"]||(err["errors"] && err["errors"].first["code"])
             end
           end
@@ -184,60 +192,12 @@ module DTK
           return (error_code == "forbidden")
         end
 
-        def check(response_ruby_obj)
-          # check for errors in response
-
-          unless response_ruby_obj["errors"].nil?
-            error_msg       = ""
-            error_internal  = nil
-            error_backtrace = nil
-            error_code      = nil
-            error_on_server = nil
-
-            #TODO:  below just 'captures' first error
-            response_ruby_obj['errors'].each do |err|
-              error_msg       +=  err["message"] unless err["message"].nil?
-              error_msg       +=  err["error"]   unless err["error"].nil?
-              error_on_server = true unless err["on_client"]
-              error_code      = err["code"]||(err["errors"] && err["errors"].first["code"])
-              error_internal  ||= (err["internal"] or error_code == "not_found") #"not_found" code is at Ramaze level; so error_internal not set
-              error_backtrace ||= err["backtrace"]
-            end
-
-            # normalize it for display
-            error_msg = error_msg.empty? ? 'Internal DTK Client error, please try again' : "#{error_msg}"
-
-            # if error_internal.first == true
-            if error_code == "unauthorized"
-              raise DTK::Client::DtkError, "[UNAUTHORIZED] Your session has been suspended, please log in again."
-            elsif error_code == "session_timeout"
-              raise DTK::Client::DtkError, "[SESSION TIMEOUT] Your session has been suspended, please log in again."
-            elsif error_code == "broken"
-              raise DTK::Client::DtkError, "[BROKEN] Unable to connect to the DTK server at host: #{Config[:server_host]}"
-            elsif error_code == "forbidden"
-              raise DTK::Client::DtkLoginRequiredError, "[FORBIDDEN] Access not granted, please log in again."
-            elsif error_code == "timeout"
-              raise DTK::Client::DtkError, "[TIMEOUT ERROR] Server is taking too long to respond."
-            elsif error_code == "connection_refused"
-              raise DTK::Client::DtkError, "[CONNECTION REFUSED] Connection refused by server."
-            elsif error_code == "resource_not_found"
-              raise DTK::Client::DtkError, "[RESOURCE NOT FOUND] #{error_msg}"
-            elsif error_code == "pg_error"
-              raise DTK::Client::DtkError, "[PG_ERROR] #{error_msg}"
-            elsif error_internal
-              where = (error_on_server ? "SERVER" : "CLIENT")
-              #opts = (error_backtrace ? {:backtrace => error_backtrace} : {})
-              raise DTK::Client::DtkError.new("[#{where} INTERNAL ERROR] #{error_msg}", :backtrace => error_backtrace)
-            else
-              # if usage error occurred, display message to console and display that same message to log
-              raise DTK::Client::DtkError, "[ERROR] #{error_msg}"
-            end
-          end
+        def check(response)
+          DtkError.raise_if_error?(response)
         end
       end
     end
 
-
     class Log
       #TODO Stubs
       def self.info(msg)
@@ -269,26 +229,26 @@ module DTK
         Config.instance[k]
       end
      private
-      def initialize()
-        set_defaults()
-        load_config_file()
-        validate()
+      def initialize
+        set_defaults
+        load_config_file
+        validate
       end
-      def set_defaults()
+      def set_defaults
         self[:server_port] = 80
         self[:assembly_module_base_location] = 'assemblies'
         self[:secure_connection] = true
         self[:secure_connection_server_port] = 443
       end
 
-      def load_config_file()
+      def load_config_file
         parse_key_value_file(CONFIG_FILE).each{|k,v|self[k]=v}
       end
 
       def validate
         #TODO: need to check for legal values
         missing_keys = REQUIRED_KEYS - keys
-        raise DTK::Client::DtkError,"Missing config keys (#{missing_keys.join(",")}). Please check your configuration file #{CONFIG_FILE} for required keys!" unless missing_keys.empty?
+        raise DTK::Client::DtkError, "Missing config keys (#{missing_keys.join(",")}). Please check your configuration file #{CONFIG_FILE} for required keys!" unless missing_keys.empty?
       end
 
     end
@@ -303,31 +263,35 @@ module DTK
 
       attr_accessor :conn
 
-      def initialize()
-        @conn = DTK::Client::Conn.new()
+      def initialize
+        @conn = DTK::Client::Conn.new
       end
 
-      def self.get_connection()
+      def self.get_connection
         Session.instance.conn
       end
 
-      def self.re_initialize()
+      def self.connection_username
+        Session.instance.conn.get_username
+      end
+
+      def self.re_initialize
         Session.instance.conn = nil
-        Session.instance.conn = DTK::Client::Conn.new()
+        Session.instance.conn = DTK::Client::Conn.new
         Session.instance.conn.cookies
       end
 
-      def self.logout()
+      def self.logout
         # from this point @conn is not valid, since there are no cookies set
-        Session.instance.conn.logout()
+        Session.instance.conn.logout
       end
     end
 
     class Conn
-      def initialize()
+      def initialize
         @cookies = Hash.new
         @connection_error = nil
-        login()
+        login
       end
 
       VERBOSE_MODE_ON = ::DTK::Configuration.get(:verbose_rest_calls)
@@ -338,7 +302,7 @@ module DTK
         require 'ap'
       end
 
-      def self.get_timeout()
+      def self.get_timeout
         DefaultRestOpts[:timeout]
       end
 
@@ -346,6 +310,9 @@ module DTK
         DefaultRestOpts[:timeout] = timeout_sec
       end
 
+      def get_username
+        get_credentials[:username]
+      end
 
       def rest_url(route=nil)
         protocol, port = "http", Config[:server_port].to_s
@@ -387,7 +354,7 @@ module DTK
         if ResponseErrorHandler.check_for_session_expiried(response)
           # re-logging user and repeating request
           DTK::Client::OsUtil.print("Session expired: re-establishing session & re-trying request ...", :yellow)
-          @cookies = DTK::Client::Session.re_initialize()
+          @cookies = DTK::Client::Session.re_initialize
           response = rest_method_func.call
         end
 
@@ -405,7 +372,7 @@ module DTK
         return !@connection_error.nil?
       end
 
-      def logout()
+      def logout
         response = get_raw rest_url("user/process_logout")
 
         # save cookies - no need to persist them
@@ -439,8 +406,8 @@ module DTK
 
       include ParseFile
 
-      def login()
-        creds = get_credentials()
+      def login
+        creds = get_credentials
         response = post_raw rest_url("user/process_login"),creds
         errors = response['errors']
 
@@ -455,14 +422,19 @@ module DTK
         end
       end
 
-      def get_credentials()
+      def set_credentials(username, password)
+        @parsed_credentials = { :username => username, :password => password}
+      end
+
+      def get_credentials
         unless @parsed_credentials
           cred_file = Config::CRED_FILE
           raise DTK::Client::DtkError,"Authorization configuration file (#{cred_file}) does not exist" unless File.exists?(cred_file)
           ret = parse_key_value_file(cred_file)
-          [:username,:password].each{ |k| raise DTK::Client::DtkError,"cannot find #{k}" unless ret[k] }
+          [:username,:password].each{ |k| raise DTK::Client::DtkError, "cannot find #{k}" unless ret[k] }
           @parsed_credentials = ret
         end
+
         @parsed_credentials
       end