dtk-shell 0.10.0

data/lib/commands/thor/utils.rb

@@ -0,0 +1,21 @@
+#
+# 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 Utils < CommandBaseThor
+  end
+end

data/lib/commands/thor/workspace.rb

@@ -0,0 +1,685 @@
+#
+# 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 'rest_client'
+require 'json'
+require 'colorize'
+dtk_require_from_base('dtk_logger')
+dtk_require_from_base('util/os_util')
+dtk_require_from_base('command_helper')
+dtk_require_from_base('task_status')
+dtk_require_common_commands('thor/edit')
+dtk_require_common_commands('thor/purge_clone')
+dtk_require_common_commands('thor/assembly_workspace')
+dtk_require_common_commands('thor/action_result_handler')
+# LOG_SLEEP_TIME_W   = DTK::Configuration.get(:tail_log_frequency)
+
+module DTK::Client
+  class Workspace < CommandBaseThor
+    no_tasks do
+      include TaskStatusMixin
+      include SetRequiredParamsMixin
+      include EditMixin
+      include PurgeCloneMixin
+      include AssemblyWorkspaceMixin
+      include ActionResultHandler
+
+      def get_workspace_name(workspace_id)
+        get_name_from_id_helper(workspace_id)
+      end
+    end
+
+    def self.whoami()
+      return :workspace, "assembly/list", {:subtype  => 'instance'}
+    end
+
+    def self.pretty_print_cols()
+      PPColumns.get(:assembly)
+    end
+
+    def self.valid_children()
+      [:utils]
+    end
+
+    def self.invisible_context()
+      [:node]
+    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
+    # component-templates to autocomplete
+    def self.extended_context()
+      {
+        :context => {
+          :add_component => "component_template",
+          :create_node => "node_template",
+          :create_node_group => "node_template",
+          :add_component_dependency => "component_template",
+          :set_target => 'target'
+        },
+        :command => {
+          :edit_component_module => {
+            :endpoint => "assembly",
+            :url => "assembly/info_about",
+            :opts => {:subtype=>"instance", :about=>"modules"}
+          },
+          :push_component_module_updates => {
+            :endpoint => "assembly",
+            :url => "assembly/info_about",
+            :opts => {:subtype=>"instance", :about=>"modules"}
+          },
+          :delete_node => {
+            :endpoint => "assembly",
+            :url => "assembly/get_nodes_without_node_groups"
+          },
+          :delete_node_group => {
+            :endpoint => "assembly",
+            :url => "assembly/get_node_groups"
+          },
+          :pull_base_component_module => {
+            :endpoint => "assembly",
+            :url => "assembly/info_about",
+            :opts => {:subtype=>"instance", :about=>"modules"}
+          },
+          :action_info => {
+            :endpoint => "assembly",
+            :url => "assembly/task_action_list"
+          },
+          :exec => {
+            :endpoint => "assembly",
+            :url => "assembly/list_actions"
+          },
+          :exec_sync => {
+            :endpoint => "assembly",
+            :url => "assembly/list_actions"
+          }
+          # TODO: DEPRECATE execute_workflow
+          # :execute_workflow => {
+          #   :endpoint => "assembly",
+          #   :url => "assembly/task_action_list"
+          # }
+        }
+      }
+    end
+
+    # this includes children of children
+    def self.all_children()
+      # [:node, :component, :attribute]
+      [:node]
+    end
+
+    def self.multi_context_children()
+      [[:utils],[:node, :utils]]
+    end
+
+    def self.valid_child?(name_of_sub_context)
+      return Workspace.valid_children().include?(name_of_sub_context.to_sym)
+    end
+
+    def self.validation_list(context_params)
+      get_cached_response(:workspace, "assembly/list_with_workspace", {})
+    end
+
+    # TODO: Hack which is necessery for the specific problem (DTK-541), something to reconsider down the line
+    # at this point not sure what would be clenear solution
+
+    # :all             => include both for commands with command and identifier
+    # :command_only    => only on command level
+    # :identifier_only => only on identifier level for given entity (command)
+    #
+    def self.override_allowed_methods()
+      return DTK::Shell::OverrideTasks.new({
+        :all => {
+          :node      => [
+            # ['delete-component',"delete-component COMPONENT-ID [-y]","# Delete component from assembly's node"],
+            # ['list-attributes',"list-attributes","# List attributes associated with workspace's node."],
+            # ['list-components',"list-components","# List components associated with workspace's node."]
+          ],
+          :component => [
+            ['list-attributes',"list-attributes","# List attributes associated with given component."]
+          ]
+        },
+        :command_only => {
+          :attribute => [
+            ['list-attributes',"list-attributes","# List attributes."]
+          ],
+          :node => [
+            # ['delete',"delete NAME/ID [-y] ","# Delete component from workspace."],
+            ['delete',"delete NODE-NAME/ID [-y] ","# Delete node, terminating it if the node has been spun up."],
+            ['list',"list","# List nodes."]
+          ],
+          :component => [
+            ['delete',"delete COMPONENT-NAME/ID [-y] ","# Delete component from workspace."],
+            ['list-components',"list-components","# List components."]
+          ],
+          :utils => [
+# TODO: DTK-2027 might subsume by the dtk actions; currently server changes does not support this command
+#            ['execute-tests',"execute-tests [--component COMPONENT-NAME] [--timeout TIMEOUT]","# Execute tests. --component filters execution per component, --timeout changes default execution timeout."],
+            ['get-netstats',"get-netstats","# Get netstats."],
+            ['get-ps',"get-ps [--filter PATTERN]","# Get ps."],
+            ['grep',"grep LOG-PATH NODE-ID-PATTERN GREP-PATTERN [--first]","# Grep log from multiple nodes. --first option returns first match (latest log entry)."],
+            ['tail',"tail LOG-PATH NODE-NAME  [REGEX-PATTERN] [--more]","# Tail specified number of lines from log. CTRL+C to quit."]
+          ]
+        },
+        :identifier_only => {
+          :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."],
+            # ['link-attributes', "link-attributes TARGET-ATTR-TERM SOURCE-ATTR-TERM", "# Set TARGET-ATTR-TERM to SOURCE-ATTR-TERM."],
+            ['list-attributes',"list-attributes","# List attributes associated with workspace's node."],
+            ['list-components',"list-components","# List components associated with workspace's node."],
+            ['set-attribute',"set-attribute ATTRIBUTE-NAME [VALUE] [-u]","# (Un)Set attribute value. The option -u will unset the attribute's value."],
+            ['start', "start", "# Start node instance."],
+            ['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."],
+            # ['edit-dsl',"edit-dsl","# Edit component module dsl file related to given component."],
+            ['link-components',"link-components ANTECEDENT-CMP-NAME [DEPENDENCY-NAME]","#Link components to satisfy component dependency relationship."],
+            ['list-component-links',"list-component-links","# List component's links to other components."]
+            #['unlink-components',"unlink-components SERVICE-TYPE","# Delete service link on component."]
+            # ['create-attribute',"create-attribute SERVICE-TYPE DEP-ATTR ARROW BASE-ATTR","# Create an attribute to service link."],
+          ],
+          :attribute => [
+            ['info',"info","# Return info about attribute instance belonging to given component."]
+          ]
+        }
+      }, [:utils])
+    end
+
+    desc "WORKSPACE-NAME/ID cancel-task [TASK-ID]", "Cancel an executing task. If task id is omitted, the most recent executing task is canceled."
+    def cancel_task(context_params)
+      cancel_task_aux(context_params)
+    end
+
+    #desc "WORKSPACE-NAME/ID clear-tasks", "Clears the tasks that have been run already."
+    #def clear_tasks(context_params)
+    #  clear_tasks_aux(context_params)
+    #end
+
+    desc "WORKSPACE-NAME/ID exec [NODE/NODE-GROUP/]ACTION [ACTION-PARAMS]", "Execute action asynchronously"
+    def exec(context_params)
+      exec_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID exec-sync [NODE/NODE-GROUP/]ACTION [ACTION-PARAMS]", "Execute action synchronously"
+    def exec_sync(context_params)
+      exec_sync_aux(context_params)
+    end
+
+    # desc "WORKSPACE-NAME/ID exec SERVICE-LEVEL-ACTION [PARAMS] [--stream-results]", "Execute a service level action"
+    # method_option 'stream-results', :aliases => '-s', :type => :boolean, :default => false, :desc => "Stream results"
+    # def exec(context_params)
+    #   opts = {}
+    #   opts.merge!(:mode => :stream) if context_params.pure_cli_mode or options['stream-results']
+    #   converge_aux(context_params, opts)
+    # end
+
+    # TODO: DEPRECATE: keeping around for backward compatibiity but will be deprecating execute-workflow
+    # desc "WORKSPACE-NAME/ID execute-workflow WORKFLOW-ACTION [WORKFLOW-PARAMS] [-m COMMIT-MSG]", "Execute workflow.", :hide => true
+    # method_option "commit_msg",:aliases => "-m",
+    #   :type => :string,
+    #   :banner => "COMMIT-MSG",
+    #   :desc => "Commit message"
+    # def execute_workflow(context_params)
+    #   OsUtil.print_deprecate_message("Command 'execute-workflow' will be deprecated; use 'exec' instead")
+    #   converge_aux(context_params)
+    # end
+
+
+    desc "WORKSPACE-NAME/ID converge [-m COMMIT-MSG] [--stream-results]", "Converge workspace instance."
+    method_option "commit_msg",:aliases => "-m" ,
+      :type => :string,
+      :banner => "COMMIT-MSG",
+      :desc => "Commit message"
+    method_option 'stream-results', :aliases => '-s', :type => :boolean, :default => false, :desc => "Stream results"
+    def converge(context_params)
+      opts = {}
+      opts.merge!(:mode => :stream) if context_params.pure_cli_mode or options['stream-results']
+      converge_aux(context_params, opts)
+    end
+
+    desc "WORKSPACE-NAME/ID push-component-module-updates COMPONENT-MODULE-NAME [--force]", "Push changes made to a component module in the workspace to its base component module."
+    method_option :force, :type => :boolean, :default => false, :aliases => '-f'
+    def push_component_module_updates(context_params)
+      push_module_updates_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID pull-base-component-module COMPONENT-MODULE-NAME [--force] [--revert]", "Pull base component module changes to component module in workspace"
+    method_option :force, :type => :boolean, :default => false, :aliases => '-f'
+    method_option :revert, :type => :boolean, :default => false, :aliases => '-r'
+    def pull_base_component_module(context_params)
+      pull_base_component_module_aux(context_params)
+    end
+
+    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)
+      if qualified_assembly_name =~ /(^[^\/]*)\/([^\/]*$)/
+        service_module_name, assembly_template_name = [$1,$2]
+      else
+        raise DtkError,"The term (#{qualified_assembly_name}) must have form SERVICE-MODULE-NAME/ASSEMBLY-NAME"
+      end
+      response = promote_assembly_aux(:update,workspace_id, service_module_name, assembly_template_name)
+      return response unless response.ok?
+      @@invalidate_map << :assembly
+      Response::Ok.new()
+    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."
+    method_option :purge, :aliases => '-p', :type => :boolean, :default => false
+    method_option "description",:aliases => "-m" ,
+      :type => :string,
+      :banner => "DESCRIPTION"
+    def create_assembly(context_params)
+      workspace_id, service_module_full_name, assembly_template_name = context_params.retrieve_arguments([:workspace_id!,:option_1!,:option_2!],method_argument_names)
+
+      # need default_namespace for create-assembly because need to check if local service-module directory existst in promote_assembly_aux
+      resp = post rest_url("namespace/default_namespace_name")
+      return resp unless resp.ok?
+      default_namespace = resp.data
+
+      opts = {:default_namespace => default_namespace}
+      opts.merge!(:description => options.description) if options.description
+      response = promote_assembly_aux(:create,workspace_id,service_module_full_name,assembly_template_name,opts)
+      return response unless response.ok?
+
+      if options.purge?
+        response = purge_aux(context_params)
+        return response unless response.ok?
+      end
+
+      @@invalidate_map << :assembly
+      @@invalidate_map << :service
+
+      Response::Ok.new()
+    end
+
+    desc "WORKSPACE-NAME/ID create-attribute ATTRIBUTE-NAME [VALUE] [--type DATATYPE] [--required] [--dynamic]", "Create a new attribute and optionally assign it a value."
+    method_option :required, :type => :boolean, :default => false
+    method_option :dynamic, :type => :boolean, :default => false
+    method_option :type, :aliases => "-t"
+    def create_attribute(context_params)
+      create_attribute_aux(context_params)
+    end
+
+    #only supported at node-level
+    # using HIDE_FROM_BASE to hide this command from base context (dtk:/workspace>)
+    desc "WORKSPACE-NAME/ID add-component COMPONENT [--auto-complete]", "Add a component to a workspace. Use --auto-complete to link components automatically"
+    method_option :auto_complete, :type => :boolean, :default => true
+    def add_component(context_params)
+      response = create_component_aux(context_params)
+      return response unless response.ok?
+
+      @@invalidate_map << :service
+      @@invalidate_map << :service_node
+
+      response
+    end
+
+    # using ^^ before NODE-NAME to remove this command from workspace/node/node_id but show in workspace
+    desc "WORKSPACE-NAME/ID create-node ^^NODE-NAME NODE-TEMPLATE", "Add (stage) a new node in the workspace."
+    def create_node(context_params)
+      response = create_node_aux(context_params)
+      return response unless response.ok?
+
+      @@invalidate_map << :assembly
+      @@invalidate_map << :assembly_node
+      @@invalidate_map << :service
+      @@invalidate_map << :service_node
+      @@invalidate_map << :workspace
+      @@invalidate_map << :workspace_node
+
+      message = "Created node '#{response.data["display_name"]}'."
+      DTK::Client::OsUtil.print(message, :yellow)
+    end
+
+    desc "WORKSPACE-NAME/ID create-node-group ^^NODE-GROUP-NAME NODE-TEMPLATE [-n CARDINALITY]", "Add (stage) a new node group in the workspace."
+    method_option :cardinality, :aliases => '-n', :type => :string, :default => 1
+    def create_node_group(context_params)
+      response = create_node_group_aux(context_params)
+      return response unless response.ok?
+
+      @@invalidate_map << :assembly
+      @@invalidate_map << :assembly_node
+      @@invalidate_map << :service
+      @@invalidate_map << :service_node
+      @@invalidate_map << :workspace
+      @@invalidate_map << :workspace_node
+
+      message = "Created node group '#{response.data["display_name"]}'."
+      DTK::Client::OsUtil.print(message, :yellow)
+    end
+
+    desc "WORKSPACE-NAME/ID link-components TARGET-CMP-NAME SOURCE-CMP-NAME [DEPENDENCY-NAME]","Link the target component to the source component."
+    def link_components(context_params)
+      link_components_aux(context_params)
+    end
+
+    desc "delete NAME/ID [-y]", ""
+    method_option :force, :aliases => '-y', :type => :boolean, :default => false
+    def delete(context_params)
+      if context_params.is_last_command_eql_to?(:node)
+        response = delete_node_aux(context_params)
+        @@invalidate_map << :service_node
+
+        response
+      elsif context_params.is_last_command_eql_to?(:component)
+        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 "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
+
+      return response
+    end
+
+    # using ^^ before NODE-NAME to remove this command from workspace/node/node_id but show in workspace
+    desc "WORKSPACE-NAME/ID delete-node ^^NODE-NAME [-y]","Delete node, terminating it if the node has been spun up."
+    method_option :force, :aliases => '-y', :type => :boolean, :default => false
+    def delete_node(context_params)
+      response = delete_node_aux(context_params)
+
+      @@invalidate_map << :assembly
+      @@invalidate_map << :assembly_node
+      @@invalidate_map << :service
+      @@invalidate_map << :service_node
+      @@invalidate_map << :workspace
+      @@invalidate_map << :workspace_node
+
+      return response
+    end
+
+    desc "WORKSPACE-NAME/ID delete-node-group ^^NODE-NAME [-y]","Delete node group and all nodes that are part of that group."
+    method_option :force, :aliases => '-y', :type => :boolean, :default => false
+    def delete_node_group(context_params)
+      response = delete_node_group_aux(context_params)
+
+      @@invalidate_map << :assembly
+      @@invalidate_map << :assembly_node
+      @@invalidate_map << :service
+      @@invalidate_map << :service_node
+      @@invalidate_map << :workspace
+      @@invalidate_map << :workspace_node
+
+      return response
+    end
+
+    desc "WORKSPACE-NAME/ID unlink-components TARGET-CMP-NAME SOURCE-CMP-NAME [DEPENDENCY-NAME]", "Remove a component link."
+    def unlink_components(context_params)
+      unlink_components_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID edit-component-module COMPONENT-MODULE-NAME", "Edit a component module used in the workspace."
+    def edit_component_module(context_params)
+      edit_module_aux(context_params)
+    end
+
+    # 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-action [WORKSPACE-LEVEL-ACTION]", "Edit a workflow in the workspace."
+    def edit_action(context_params)
+      edit_or_create_workflow_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID edit-attributes [-n NODE] [-c COMPONENT] [-a ATTRIBUTE]", "Edit workspace's attributes."
+    method_option :node, :aliases => '-n'
+    method_option :component, :aliases => '-c'
+    method_option :attribute, :aliases => '-a'
+    def edit_attributes(context_params)
+      response = edit_attributes_aux(context_params)
+
+      @@invalidate_map << :assembly
+      @@invalidate_map << :assembly_node
+      @@invalidate_map << :service
+      @@invalidate_map << :service_node
+      @@invalidate_map << :workspace
+      @@invalidate_map << :workspace_node
+
+      response
+    end
+
+    # using HIDE_FROM_BASE to hide this command from base context (dtk:/workspace>)
+    desc "HIDE_FROM_BASE get-netstats", "Get netstats"
+    def get_netstats(context_params)
+      get_netstats_aux(context_params)
+    end
+
+=begin
+# 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 :timeout, :type => :string, :desc => "Timeout"
+    def execute_tests(context_params)
+      execute_tests_aux(context_params)
+    end
+=end
+
+    # using HIDE_FROM_BASE to hide this command from base context (dtk:/workspace>)
+    desc "HIDE_FROM_BASE get-ps [--filter PATTERN]", "Get ps"
+    method_option :filter, :type => :boolean, :default => false, :aliases => '-f'
+    def get_ps(context_params)
+      get_ps_aux(context_params)
+    end
+
+    # using HIDE_FROM_BASE to hide this command from base context (dtk:/workspace>)
+    desc "HIDE_FROM_BASE grep LOG-PATH NODES-ID-PATTERN GREP-PATTERN [--first]","Grep log from multiple nodes. --first option returns first match (latest log entry)."
+    method_option :first, :type => :boolean, :default => false
+    def grep(context_params)
+      grep_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID grant-access USER-ACCOUNT PUB-KEY-NAME [PATH-TO-PUB-KEY] [--nodes NODE-NAMES]", "Grants ssh access to user account USER-ACCOUNT for nodes in workspace"
+    method_option :nodes, :type => :string, :default => nil
+    def grant_access(context_params)
+      grant_access_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID revoke-access USER-ACCOUNT PUB-KEY-NAME [PATH-TO-PUB-KEY] [--nodes NODE-NAMES]", "Revokes ssh access to user account USER-ACCOUNT for nodes in workspace"
+    method_option :nodes, :type => :string, :default => nil
+    def revoke_access(context_params)
+      revoke_access_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID list-ssh-access", "List SSH access for each of the nodes"
+    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)
+    end
+
+    desc "WORKSPACE-NAME/ID link-attributes TARGET-ATTR SOURCE-ATTR", "Link the value of the target attribute to the source attribute."
+    def link_attributes(context_params)
+      link_attributes_aux(context_params)
+    end
+
+    desc "list", ""
+    def list(context_params)
+      if context_params.is_last_command_eql_to?(:node)
+        list_nodes_aux(context_params)
+      end
+    end
+
+    desc "WORKSPACE-NAME/ID list-attributes [-f FORMAT] [-t TAG,..] [--links] [-n NODE] [-c COMPONENT] [-a ATTRIBUTE]","List attributes associated with workspace."
+    method_option :format, :aliases => '-f'
+    method_option :tags, :aliases => '-t'
+    method_option :links, :type => :boolean, :default => false, :aliases => '-l'
+    method_option :node, :aliases => '-n'
+    method_option :component, :aliases => '-c'
+    method_option :attribute, :aliases => '-a'
+    def list_attributes(context_params)
+      list_attributes_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID list-components [--deps]","List components associated with workspace."
+    method_option :deps, :type => :boolean, :default => false, :aliases => '-l'
+    def list_components(context_params)
+      list_components_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID list-nodes","List nodes associated with workspace."
+    def list_nodes(context_params)
+      list_nodes_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID list-component-links","List component links."
+    def list_component_links(context_params)
+      list_component_links_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID list-component-modules","List component modules associated with workspace."
+    def list_component_modules(context_params)
+      list_modules_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID list-tasks","List tasks associated with workspace."
+    def list_tasks(context_params)
+      list_tasks_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID action-info [WORKSPACE-LEVEL-ACTION]", "Get the contents of action associated with the workspace."
+    def action_info(context_params)
+      action_info_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID list-actions [--type TYPE]", "List the actions defined on components in the workspace."
+    method_option :type, :aliases => '-t'
+    def list_actions(context_params)
+      list_actions_aux(context_params)
+    end
+
+    # desc "WORKSPACE-NAME/ID list-workflows", "List the workflows associated with the workspace.", :hide => true
+    # def list_workflows(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)
+    end
+
+    desc "WORKSPACE-NAME/ID print-includes", "Finds includes in the workspace."
+    def print_includes(context_params)
+      print_includes_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID purge [-y]", "Purge the workspace, deleting and terminating any nodes that have been spun up."
+    method_option :force, :aliases => '-y', :type => :boolean, :default => false
+    def purge(context_params)
+      purge_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID destroy-and-reset-nodes [-y]", "Terminates all nodes, but keeps config state so they can be spun up from scratch."
+    method_option :force, :aliases => '-y', :type => :boolean, :default => false
+    def destroy_and_reset_nodes(context_params)
+      destroy_and_reset_nodes_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID set-target TARGET-NAME/ID", "Set target associated with workspace."
+    def set_target(context_params)
+      set_target_aux(context_params)
+    end
+
+    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)
+      response = set_attribute_aux(context_params)
+      return response unless response.ok?
+
+      @@invalidate_map << :assembly
+      @@invalidate_map << :assembly_node
+      @@invalidate_map << :service
+      @@invalidate_map << :service_node
+      @@invalidate_map << :workspace
+      @@invalidate_map << :workspace_node
+
+      response
+    end
+
+    desc "WORKSPACE-NAME/ID set-required-attributes", "Interactive dialog to set required attributes that are not currently set"
+    def set_required_attributes(context_params)
+      workspace_id = context_params.retrieve_arguments([:workspace_id!],method_argument_names)
+      set_required_attributes_aux(workspace_id,:assembly,:instance)
+    end
+
+#    desc "WORKSPACE-NAME/ID start [NODE-ID-PATTERN]", "Starts all workspace's nodes,  specific nodes can be selected via node id regex."
+    desc "WORKSPACE-NAME/ID start [NODE-NAME]", "Starts all the workspace nodes. A single node can be selected."
+    def start(context_params)
+      start_aux(context_params)
+    end
+
+#    desc "WORKSPACE-NAME/ID stop [NODE-ID-PATTERN]", "Stops all workspace's nodes, specific nodes can be selected via node id regex."
+    desc "WORKSPACE-NAME/ID stop [NODE-NAME]", "Stops all the workspace nodes. A single node can be selected."
+    def stop(context_params)
+      stop_aux(context_params)
+    end
+
+    # using HIDE_FROM_BASE to hide this command from base context (dtk:/workspace>)
+    desc "HIDE_FROM_BASE tail LOG-PATH NODE-NAME [REGEX-PATTERN] [--more]","Tail specified number of lines from log. CTRL+C to quit."
+    method_option :more, :type => :boolean, :default => false
+    def tail(context_params)
+      tail_aux(context_params)
+    end
+
+    #desc "WORKSPACE-NAME/ID task-status [--wait] [--summarize]", "Get the task status of the running or last running workspace task."
+    desc "WORKSPACE-NAME/ID task-status [--mode MODE] [--summarize]", "Get the task status of the running or last running workspace task."
+    method_option "mode",:aliases => "-m" ,
+      :type => :string,
+      :banner => "MODE",
+      :desc => "Mode in which task status display; one of [stream,snapshot,refresh]; default is 'snapshot'"
+    method_option :summarize, :type => :boolean, :default => false, :aliases => '-s'
+    # TODO: leaving --wait in for backwards compatability  
+    method_option :wait, :type => :boolean, :default => false
+
+    def task_status(context_params)
+      task_status_aw_aux(context_params)
+    end
+
+    desc "WORKSPACE-NAME/ID task-action-detail", "Get the task info of the running or last running workspace task."
+    def task_action_detail(context_params)
+      task_action_detail_aw_aux(context_params)
+    end
+  end
+end