Mercurial > hg > release > thermostat-2.0

changeset 2608:1286dad1ad8f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fill in command-group-metadata Reviewed-by: neugens Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-February/022220.html Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-March/022331.html
author Andrew Azores <aazores@redhat.com>
date Fri, 03 Mar 2017 12:45:11 -0500
parents c0b84b5fdafe
children 3e0b81d9b291
files dependency-tool/distribution/thermostat-plugin.xml dev/schema-info-command/distribution/thermostat-plugin.xml dev/storage-populator/distribution/thermostat-plugin.xml distribution/config/commands/agent-info.properties distribution/config/commands/agent.properties distribution/config/commands/clean-data.properties distribution/config/commands/connect.properties distribution/config/commands/disconnect.properties distribution/config/commands/exit.properties distribution/config/commands/gui.properties distribution/config/commands/list-agents.properties distribution/config/commands/list-vms.properties distribution/config/commands/ping.properties distribution/config/commands/service.properties distribution/config/commands/shell.properties distribution/config/commands/storage.properties distribution/config/commands/vm-info.properties distribution/config/commands/vm-stat.properties integration-tests/itest-run/src/test/java/com/redhat/thermostat/itest/CliTest.java killvm/distribution/thermostat-plugin.xml local/distribution/thermostat-plugin.xml notes/distribution/thermostat-plugin.xml platform/distribution/thermostat-plugin.xml setup/distribution/thermostat-plugin.xml storage-profile/distribution/thermostat-plugin.xml validate-command/distribution/thermostat-plugin.xml vm-byteman/distribution/thermostat-plugin.xml vm-find/distribution/thermostat-plugin.xml vm-gc/distribution/thermostat-plugin.xml vm-heap-analysis/distribution/thermostat-plugin.xml vm-jmx/distribution/thermostat-plugin.xml vm-profiler/distribution/thermostat-plugin.xml web/endpoint-plugin/distribution/thermostat-plugin.xml
diffstat 33 files changed, 167 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/dependency-tool/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/dependency-tool/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -41,6 +41,9 @@
             <name>dependency-analyzer</name>
             <summary>Analyse OSGi dependencies for the selected libray</summary>
             <description>Analyse OSGi dependencies for the selected library</description>
+            <command-groups>
+                <command-group>devtools</command-group>
+            </command-groups>
             <options>
 
                 <option>
@@ -96,4 +99,11 @@
             </bundles>
         </command>
     </commands>
+    <command-group-metadatas>
+        <command-group-metadata>
+            <name>devtools</name>
+            <description>Developer Tools</description>
+            <sort-order>50</sort-order>
+        </command-group-metadata>
+    </command-group-metadatas>
 </plugin>
--- a/dev/schema-info-command/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/dev/schema-info-command/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -44,6 +44,9 @@
       <name>list-categories</name>
       <summary>list all registered categories</summary>
       <description>List all registered categories in the Storage.</description>
+      <command-groups>
+        <command-group>database-util</command-group>
+      </command-groups>
       <environments>
         <environment>cli</environment>
         <environment>shell</environment>
@@ -56,4 +59,11 @@
       </bundles>
     </command>
   </commands>
+  <command-group-metadatas>
+    <command-group-metadata>
+      <name>database-util</name>
+      <description>Database Utilities</description>
+      <sort-order>50</sort-order>
+    </command-group-metadata>
+  </command-group-metadatas>
 </plugin>
--- a/dev/storage-populator/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/dev/storage-populator/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -46,6 +46,9 @@
       <description>
       Populates storage with dummy data.
       </description>
+      <command-groups>
+        <command-group>database-util</command-group>
+      </command-groups>
       <options>
         <option>
           <long>config</long>
--- a/distribution/config/commands/agent-info.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/agent-info.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -18,3 +18,5 @@
 agentId.description = agent ID
 
 environments = cli, shell
+
+command-groups=agent-info
\ No newline at end of file
--- a/distribution/config/commands/agent.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/agent.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -24,3 +24,5 @@
 saveOnExit.hasarg = false
 
 environments = cli
+
+command-groups=thermostat-core
\ No newline at end of file
--- a/distribution/config/commands/clean-data.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/clean-data.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -23,3 +23,5 @@
 alive.description = authorize deletion of live agents
 
 environments = cli, shell
+
+command-groups=database-util
\ No newline at end of file
--- a/distribution/config/commands/connect.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/connect.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -16,3 +16,5 @@
 dbUrl.required = true
 
 environments = shell
+
+command-groups=shell-session
\ No newline at end of file
--- a/distribution/config/commands/disconnect.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/disconnect.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -11,3 +11,5 @@
 options = AUTO_LOG_OPTION
 
 environments = shell
+
+command-groups=shell-session
\ No newline at end of file
--- a/distribution/config/commands/exit.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/exit.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -7,3 +7,5 @@
 usage = exit
 
 environments = shell
+
+command-groups=shell-session
\ No newline at end of file
--- a/distribution/config/commands/gui.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/gui.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -24,3 +24,5 @@
 splashscreen.description = display a splash screen while launching Thermostat gui
 
 environments = cli
+
+command-groups=thermostat-core
\ No newline at end of file
--- a/distribution/config/commands/list-agents.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/list-agents.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -16,3 +16,5 @@
 options = AUTO_DB_OPTIONS, AUTO_LOG_OPTION
 
 environments = cli, shell
+
+command-groups=agent-info
\ No newline at end of file
--- a/distribution/config/commands/list-vms.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/list-vms.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -20,3 +20,5 @@
 agentId.description = Show VMs only for the specified agent ID
 
 environments = cli, shell
+
+command-groups=vm-info
\ No newline at end of file
--- a/distribution/config/commands/ping.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/ping.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -14,3 +14,5 @@
 options = AUTO_DB_OPTIONS, AUTO_LOG_OPTION
 
 environments = cli, shell
+
+command-groups=agent-info
\ No newline at end of file
--- a/distribution/config/commands/service.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/service.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -18,3 +18,5 @@
 options = AUTO_LOG_OPTION
 
 environments = cli
+
+command-groups=thermostat-core
\ No newline at end of file
--- a/distribution/config/commands/shell.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/shell.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -17,3 +17,5 @@
 #options =
 
 environments = cli
+
+command-groups=thermostat-core
\ No newline at end of file
--- a/distribution/config/commands/storage.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/storage.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -42,3 +42,5 @@
 quiet.description = don't produce any output
 
 environments = cli
+
+command-groups=thermostat-core
\ No newline at end of file
--- a/distribution/config/commands/vm-info.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/vm-info.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -24,3 +24,5 @@
 vmId.description = the ID of the VM to monitor
 
 environments= cli, shell
+
+command-groups=vm-info
\ No newline at end of file
--- a/distribution/config/commands/vm-stat.properties	Thu Mar 02 17:24:58 2017 -0500
+++ b/distribution/config/commands/vm-stat.properties	Fri Mar 03 12:45:11 2017 -0500
@@ -33,3 +33,5 @@
   and days, hours, minutes, or seconds
 
 environments = cli, shell
+
+command-groups=vm-info
\ No newline at end of file
--- a/integration-tests/itest-run/src/test/java/com/redhat/thermostat/itest/CliTest.java	Thu Mar 02 17:24:58 2017 -0500
+++ b/integration-tests/itest-run/src/test/java/com/redhat/thermostat/itest/CliTest.java	Fri Mar 03 12:45:11 2017 -0500
@@ -225,7 +225,12 @@
     private void verifyShellHelpOutput(String actual) {
         String expected = SHELL_USAGE_STRING + "\n"
                         + "thermostat shell\n"
-                        + "     --help    show usage of command\n";
+                        + "     --help    show usage of command\n"
+                        + "\n"
+                        + "See also:\n"
+                        + "  agent, gui, local, platform, service, setup, storage, web-storage,\n"
+                        + "  web-storage-service\n";
+                ;
         assertEquals(expected, actual);
     }
 
@@ -237,7 +242,11 @@
         String expectedOut = "Could not parse options: Unrecognized option: --foo\n"
                            + SHELL_USAGE_STRING + "\n"
                            + "thermostat shell\n"
-                           + "     --help    show usage of command\n";
+                           + "     --help    show usage of command\n"
+                           + "\n"
+                           + "See also:\n"
+                           + "  agent, gui, local, platform, service, setup, storage, web-storage,\n"
+                           + "  web-storage-service\n";
         assertEquals(expectedOut, stdOut);
     }
 
--- a/killvm/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/killvm/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -44,6 +44,9 @@
       <name>kill-vm</name>
       <summary>kill the specified vm</summary>
       <description>Kill the specified vm.</description>
+      <command-groups>
+        <command-group>vm-instrumentation</command-group>
+      </command-groups>
       <options>
         <option>
           <long>vmId</long>
--- a/local/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/local/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -50,6 +50,9 @@
         is installed and then start the GUI client as a separate process. On exit,
         shut them all down.
       </description>
+      <command-groups>
+        <command-group>thermostat-core</command-group>
+      </command-groups>
       <options>
         <option>
           <long>show-splash</long>
--- a/notes/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/notes/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -44,6 +44,10 @@
       <name>notes</name>
       <summary>manipulate notes on Hosts or VMs</summary>
       <description>Add, remove, update, and list notes for Hosts and VMs</description>
+      <command-groups>
+        <command-group>vm-info</command-group>
+        <command-group>agent-info</command-group>
+      </command-groups>
 
       <subcommands>
         <subcommand>
--- a/platform/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/platform/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -41,6 +41,9 @@
             <name>platform</name>
             <summary>launches a bare bone Platform Client</summary>            
             <description>launches a bare bone Platform Client</description>
+            <command-groups>
+                <command-group>thermostat-core</command-group>
+            </command-groups>
             <options>
                 <option>
                     <long>launch</long>
--- a/setup/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/setup/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -44,6 +44,9 @@
       <name>setup</name>
       <summary>setup thermostat for first run</summary>
       <description>setup an initial mongodb user and webapp settings. Optionally create a client admin and agent user.</description>
+      <command-groups>
+        <command-group>thermostat-core</command-group>
+      </command-groups>
       <options>
         <option>
           <long>origArgs</long>
@@ -73,4 +76,26 @@
       </bundles>
     </command>
   </commands>
+  <command-group-metadatas>
+    <command-group-metadata>
+      <name>thermostat-core</name>
+      <description>Thermostat Core Commands</description>
+      <sort-order>0</sort-order>
+    </command-group-metadata>
+    <command-group-metadata>
+      <name>shell-session</name>
+      <description>Shell Session</description>
+      <sort-order>1</sort-order>
+    </command-group-metadata>
+    <command-group-metadata>
+      <name>vm-info</name>
+      <description>Virtual Machine Information</description>
+      <sort-order>3</sort-order>
+    </command-group-metadata>
+    <command-group-metadata>
+      <name>agent-info</name>
+      <description>Thermostat Agent Information</description>
+      <sort-order>2</sort-order>
+    </command-group-metadata>
+  </command-group-metadatas>
 </plugin>
--- a/storage-profile/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/storage-profile/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -48,6 +48,9 @@
       exercies various aspects of storage to see how well it performs for that
       given workload.
       </description>
+      <command-groups>
+        <command-group>database-util</command-group>
+      </command-groups>
       <options>
         <option common="true">
           <long>dbUrl</long>
--- a/validate-command/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/validate-command/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -44,6 +44,9 @@
       <name>validate</name>
       <summary>validate a thermostat plug-in XML file</summary>
       <description>Validate a thermostat plug-in XML file against the standard schema and report any issues.</description>
+      <command-groups>
+        <command-group>devtools</command-group>
+      </command-groups>
       <environments>
         <environment>cli</environment>
         <environment>shell</environment>
--- a/vm-byteman/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/vm-byteman/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -44,6 +44,9 @@
             <description>
             Instrument a target VM with Byteman rules.
             </description>
+            <command-groups>
+                <command-group>vm-instrumentation</command-group>
+            </command-groups>
             <subcommands>
                 <subcommand>
                     <name>load</name>
--- a/vm-find/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/vm-find/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -53,6 +53,9 @@
         At least one filtering criteria option must be specified. These are any of the options switches listed
         which do not begin with "--show" and which take an argument.
       </description>
+      <command-groups>
+        <command-group>vm-info</command-group>
+      </command-groups>
       <options>
         <option>
           <long>agentId</long>
--- a/vm-gc/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/vm-gc/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -44,6 +44,9 @@
       <name>gc</name>
       <summary>perform Garbage Collection on the given vm</summary>
       <description>Perform Garbage Collection on the given vm.</description>
+      <command-groups>
+        <command-group>vm-instrumentation</command-group>
+      </command-groups>
       <options>
         <option>
           <long>vmId</long>
@@ -73,6 +76,9 @@
       <description>Show the configured garbage collector name of a given VM.
       The displayed name of the garbage collector is its commonly referred to
       name.</description>
+      <command-groups>
+        <command-group>vm-info</command-group>
+      </command-groups>
       <options>
         <option common="true">
           <long>dbUrl</long>
--- a/vm-heap-analysis/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/vm-heap-analysis/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -44,6 +44,9 @@
       <name>dump-heap</name>
       <summary>trigger a heap dump on the VM</summary>
       <description>Trigger a heap dump on the VM.</description>
+      <command-groups>
+        <command-group>vm-heap</command-group>
+      </command-groups>
       <options>
         <option>
           <long>vmId</long>
@@ -76,6 +79,9 @@
       <name>find-objects</name>
       <summary>find objects in a heapdump</summary>
       <description>Find objects in a heapdump.</description>
+      <command-groups>
+        <command-group>vm-heap</command-group>
+      </command-groups>
       <arguments>
         <argument>pattern</argument>
       </arguments>
@@ -118,6 +124,9 @@
       <name>find-root</name>
       <summary>find the shortest path from an object to a GC root</summary>
       <description>Find the shortest path, or all paths, from an object to a GC root.</description>
+      <command-groups>
+        <command-group>vm-heap</command-group>
+      </command-groups>
       <options>
         <option>
           <long>heapId</long>
@@ -163,6 +172,9 @@
       <name>list-heap-dumps</name>
       <summary>list all heap dumps</summary>
       <description>List all heap dumps, or all dumps from a particular agent or VM.</description>
+      <command-groups>
+        <command-group>vm-heap</command-group>
+      </command-groups>
       <options>
         <option>
           <long>agentId</long>
@@ -202,6 +214,9 @@
       <name>object-info</name>
       <summary>show information about an object in a heap dump</summary>
       <description>Show information about an object in a heap dump.</description>
+      <command-groups>
+        <command-group>vm-heap</command-group>
+      </command-groups>
       <options>
         <option>
           <long>heapId</long>
@@ -241,6 +256,9 @@
       <name>save-heap-dump-to-file</name>
       <summary>save a heap dump to a local file</summary>
       <description>Save a heap dump to a local file.</description>
+      <command-groups>
+        <command-group>vm-heap</command-group>
+      </command-groups>
       <options>
         <option>
           <long>heapId</long>
@@ -280,6 +298,9 @@
       <name>show-heap-histogram</name>
       <summary>show the heap histogram</summary>
       <description>Show the heap histogram for a given heapId.</description>
+      <command-groups>
+        <command-group>vm-heap</command-group>
+      </command-groups>
       <options>
         <option>
           <long>heapId</long>
@@ -309,6 +330,13 @@
       </bundles>
     </command>
   </commands>
+  <command-group-metadatas>
+    <command-group-metadata>
+      <name>vm-heap</name>
+      <description>JVM Heap Analysis</description>
+      <sort-order>5</sort-order>
+    </command-group-metadata>
+  </command-group-metadatas>
   <extensions>
     <extension>
       <name>gui</name>
--- a/vm-jmx/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/vm-jmx/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -44,6 +44,9 @@
       <name>notifications</name>
       <summary>manage JMX notifications on the given VM</summary>
       <description>Manage JMX notification monitoring on the given JVM.</description>
+      <command-groups>
+        <command-group>vm-info</command-group>
+      </command-groups>
       <subcommands>
         <subcommand>
           <name>status</name>
--- a/vm-profiler/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/vm-profiler/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -49,6 +49,9 @@
             'start' and 'stop') can take a while for programs with lots of
             classes.
             </description>
+            <command-groups>
+                <command-group>vm-instrumentation</command-group>
+            </command-groups>
             <subcommands>
                 <subcommand>
                     <name>start</name>
@@ -90,6 +93,13 @@
             </bundles>
         </command>
     </commands>
+    <command-group-metadatas>
+        <command-group-metadata>
+            <name>vm-instrumentation</name>
+            <description>Virtual Machine Instrumentation</description>
+            <sort-order>3</sort-order>
+        </command-group-metadata>
+    </command-group-metadatas>
     <extensions>
         <extension>
             <name>gui</name>
--- a/web/endpoint-plugin/distribution/thermostat-plugin.xml	Thu Mar 02 17:24:58 2017 -0500
+++ b/web/endpoint-plugin/distribution/thermostat-plugin.xml	Fri Mar 03 12:45:11 2017 -0500
@@ -48,6 +48,9 @@
         archive deployed and then connect an agent to this web endpoint. Do all
         this as a foreground process. On exit, shut them all down.
       </description>
+      <command-groups>
+        <command-group>thermostat-core</command-group>
+      </command-groups>
       <environments>
         <environment>cli</environment>
       </environments>
@@ -68,6 +71,9 @@
         Start mongodb storage, an embedded servlet container with the web
         archive deployed as a foreground process. On exit, shut them down.
       </description>
+      <command-groups>
+        <command-group>thermostat-core</command-group>
+      </command-groups>
       <environments>
         <environment>cli</environment>
       </environments>