rboss 0.6.2 → 0.7.0

data/.gitignore

@@ -1,9 +1,9 @@
 out
 rboss.iws
-rboss.ipr
-rboss.iml
 *.gem
 .bundle
 Gemfile.lock
 pkg/*
 .rakeTasks
+*.sublime-project
+*.sublime-workspace

data/README.md

@@ -10,6 +10,146 @@ Installation
 
     gem install rboss
 
+### Dependencies
+
+    * yummi
+
+Using rboss-cli
+-----------
+
+rboss-cli is a helper tool for jboss-cli, it maps resource paths and helps the operation
+invoke.
+
+### Basics
+
+Invoke the command for a list of mapped resources:
+
+    rboss-cli --help
+
+You can scan resources, detail information and execute operations.
+
+    rboss-cli --datasource
+    rboss-cli --server-memory
+    rboss-cli --server --operation shutdown
+
+### Invoking Operations
+
+To see the operations for a resource, use the option "--list-operations"
+
+    rboss-cli --server --list-operations
+
+To detail an operation, use the option "--detail-operation"
+
+    rboss-cli --server --detail-operation shutdown
+
+This will print a table showing both request and response parameters. To invoke the
+operation, use the "--operation" (or "-o") option
+
+    rboss-cli --server --operation shutdown
+    rboss-cli --server -o shutdown
+
+Since this operation requires a parameter, rboss-cli will ask you to input them. If you
+want to pass the required parameters, use the "--arguments" (or "-a") option
+
+    rboss-cli --server --operation shutdown --arguments restart=true
+    rboss-cli --server -o shutdown -a restart=true
+
+If you want to skip optional arguments, use the "--skip-optional". rboss-cli will not ask
+you to input the arguments, leaving "--arguments" as the only way to set them.
+
+### Known Issues
+
+The datasource mapping (--datasource) retrieves incorrect information if you call either
+detail operation or invoke operation for the operation add. This is caused because the
+command '/subsystem=datasources/data-source=:read-operation-description(name=add)' needs
+to be executed as
+'/subsystem=datasources/data-source=ANY_VALUE:read-operation-description(name=add)',
+leaving the '--datasource any' as a workaround.
+
+    rboss-cli --datasource --detail-operation add
+    rboss-cli --datasource a --detail-operation add
+
+### Configuring mappings
+
+To create and override mappings, just put a yaml file in "~/.rboss/rboss-cli/resources". The filename will
+be used to identify the operation. Example: placing a file named datasource.yaml will override the
+--datasource option and a file named logger.yaml will create a new option (--logger).
+
+The yaml must contain the given definitions:
+
+* description: an explaining text to appear in command usage (--help)
+* path: the path to invoke the operations, may take a ${NAME} if the path contains a resource name
+* scan (optional): a command to scan resources (by using this, the option may take an array of resource names)
+* print (optional): an array of table definitions to print with "read-resource" operation.
+
+To configure a table to print, just use the following parameters:
+
+* id: a name that will be joined to the file name to allow print only this table
+* title: the table title
+* layout (horizontal | vertical): how the table must be printed. Use vertical for large number of properties
+* properties: an array with the properties (returned by "read-resource") to print in this table
+* header: an array that maps a header text to the properties
+* format: a hash that maps formatters to the table columns
+* color: a hash that maps colors to the table columns
+* health: a hash that maps health checkers to the table columns
+
+All mappings (formatter, colorizer and health checker) should be mapped using the following conventions:
+
+* the key should be the property name (replace '-' with '_')
+* the value should be the message to send to RBoss::Formatters, RBoss::HealthCheckers or RBoss::Colorizers
+* if the message takes parameters, they must be specified in a form of a hash after the message
+
+Examples:
+
+    health:
+        active:
+          percentage:
+            max: available
+            using: active
+    color:
+      jndi_name:
+        with: purple
+      enabled: boolean
+      connection_url:
+        with: yellow
+
+    format:
+      system_load: percentage
+    color:
+        name:
+          with: white
+        system_load:
+          threshold:
+            0.8: intense_red
+            0.7: red
+            0.5: yellow
+            0: green
+
+### Adding new components
+
+To add new Colorizers, Formatters or HealthCheckers, just put the code in the "~/.rboss/rboss.rb".
+
+Example:
+
+    module RBoss::Colorizers
+      def self.my_colorizer
+        lambda do |value|
+          value ? :red : :green
+        end
+      end
+    end
+
+From now you can use this colorizer
+
+    color:
+      name: my_colorizer
+
+The components included are defined in the following files:
+
+* /lib/rboss/view/colorizers.rb
+* /lib/rboss/view/formatters.rb
+* /lib/rboss/view/health_checkers.rb
+
 Using twiddle
 -----------
 
@@ -74,7 +214,7 @@ And used with -c or --config
 
 ### Customizing MBeans
 
-Every time you run the twiddle command, this gem will load the ~/.rboss/twiddle.rb file,
+Every time you run the twiddle command, this gem will load the ~/.rboss/rboss.rb file,
 which can be used to customize the mbeans.
 
     defaults = RBoss::Twiddle::Monitor.defaults
@@ -157,8 +297,9 @@ limits by using a :health key:
       end
     }
 
-You can use the indexes of the values (in that case, 2 for :max and 0 for :using) or the
-header values in downcase and underscores.
+Customizing health, formatters and colors are the same as customizing in rboss-cli. You can
+use the indexes of the values (in that case, 2 for :max and 0 for :using) or the header values
+in downcase and underscores.
 
 Using jboss-profile
 -----------

data/bin/rboss-cli

@@ -93,13 +93,22 @@ opts.on('-o', '--operation NAME',
   @operation = name
 end
 
+opts.on('-l', '--list-operations', 'Lists the available operations for a resource') do
+  @operation = 'read-operation-names'
+end
+
+opts.on('--detail-operation NAME', 'Shows the operation details') do |operation_name|
+  @operation = 'read-operation-description'
+  @parameters = {'name' => operation_name}
+end
+
 opts.on('--skip-optional', 'Skips optional parameters while invoking a command ') do
   params[:skip_optional] = true
 end
 
 opts.on('-a', '--args PARAMETERS', Array,
         'Specifies parameters in form of (name=value) for use with operation') do |parameters|
-  @parameters = Hash[(parameters.collect {|p| p.split(/=/,2)})]
+  @parameters = Hash[(parameters.collect { |p| p.split( /=/, 2) })]
 end
 
 RBoss::Cli::Mappings.resource_mappings.each do |name, config|
@@ -127,10 +136,6 @@ opts.parse!(ARGV) rescue abort 'Invalid Option! Use --help or -h for usage help.
 
 @jboss_cli = RBoss::Cli::Invoker::new params
 
-unless $stdout.isatty
-  require 'yummi/no_colors'
-end
-
 if save
   config = load_yaml
   config[save] ||= {}
@@ -160,9 +165,15 @@ def execute_actions
   end
 end
 
-while @loop
+begin
+
+  while @loop
+    execute_actions
+    sleep @interval
+  end
+
   execute_actions
-  sleep @interval
-end
 
-execute_actions
+rescue Interrupt
+  #Do nothing
+end

data/bin/twiddle

@@ -46,10 +46,6 @@ def load_yaml
   YAML::load_file(@servers_file)
 end
 
-unless $stdout.isatty
-  require 'yummi/no_colors'
-end
-
 opts = OptionParser::new
 opts.on('-j', '--jboss-home PATH', 'Defines the JBOSS_HOME variable') do |home|
   params[:jboss_home] = home
@@ -90,7 +86,7 @@ end
 
 (defaults.sort_by { |k, v| k }).each do |mbean_id, mbean|
   next if mbean[:properties] and not mbean[:scan] and mbean[:pattern]['#{resource}']
-  command = mbean_id.to_s.gsub /_/, '-'
+  command = mbean_id.to_s.gsub(/_/, '-')
   if mbean[:scan]
     opts.on("--#{command} [name_a,name_b,...]", Array,
             "Detail \"#{mbean[:description]}\" based on the given names (no names for scan)") do |names|
@@ -176,7 +172,7 @@ end
 
 def extract resource
   mbean, name = resource.split(/:/)
-  mbean.gsub! /-/, '_'
+  mbean.gsub!(/-/, '_')
   [mbean, name]
 end
 
@@ -195,9 +191,14 @@ def execute_actions
   puts buff
 end
 
-while @loop
+begin
+
+  while @loop
+    execute_actions
+    sleep @interval
+  end
+
   execute_actions
-  sleep @interval
+rescue Interrupt
+  #Do nothing
 end
-
-execute_actions

data/lib/rboss.rb

@@ -30,3 +30,7 @@ require_relative "rboss/jboss_profile"
 require_relative "rboss/twiddle"
 require_relative "rboss/cli/invoker"
 require_relative "rboss/bin/command_actions"
+
+file = File.expand_path("~/.rboss/rboss.rb")
+
+eval File.read(file), binding, file if File.exist? file

data/lib/rboss/cli/invoker.rb

@@ -89,28 +89,38 @@ module RBoss
 
       def gets_and_invoke(path, operation, parameters)
         result = result("#{path}:read-operation-description(name=#{operation})")
-        result["request-properties"] ||= {}
-        puts Yummi::colorize("Please input the requested parameters", :yellow)
+        props = result["request-properties"]
+        props ||= {}
         builder = CommandBuilder::new operation
-        result["request-properties"].each do |name, detail|
+        help_printed = false
+        info = Yummi::colorize("Please input the requested parameters", :yellow)
+        props.each do |name, detail|
           next if (@skip_optional and not detail['required'] or detail['default'])
           input = parameters[name]
           unless input
-            puts Yummi::colorize(name, :intense_blue)
-            puts "Enter parameter value (type --help to get the parameter description): "
-            while (input = gets.chomp) == '--help'
-              puts Yummi::colorize(detail['description'], :intense_gray)
-              required = detail['required']
-              default_value = detail['default']
-              puts RBoss::Colorizers.type(detail['type']).colorize(detail['type'])
-              puts Yummi::colorize("Required", :red) if required
-              puts Yummi::colorize("Default: #{default_value}", :brown) if default_value
+            puts info unless help_printed
+            help_printed = true
+            input_message = Yummi::colorize(name, :intense_blue)
+            required = detail['required']
+            default_value = detail['default']
+            input_message << ' | ' << RBoss::Colorizers.type(detail['type']).colorize(detail['type'])
+            input_message << ' | ' << Yummi::colorize("Required", :red) if required
+            input_message << ' | ' << Yummi::colorize("Optional", :cyan) unless required
+            input_message << ' | ' << Yummi::colorize("Default: #{default_value}", :blue) if default_value
+            input_message << "\n" << Yummi::colorize(detail['description'], :intense_gray)
+            puts input_message
+            input = get_input
+            while required and input.empty?
+              puts Yummi::colorize("Required parameter!", :red)
+              input = get_input
             end
           end
           next if input.empty?
           builder << {:name => name, :value => detail['type'].convert(input)}
         end
         result = result("#{path}:#{builder}")
+        puts Yummi::colorize("Result:", :yellow)
+        #TODO print a table using the returned parameters
         puts YAML::dump(result)
       end
 
@@ -124,6 +134,12 @@ module RBoss
         eval_result(execute commands)
       end
 
+      private
+
+      def get_input
+        gets.chomp.strip
+      end
+
     end
 
     class CommandBuilder

data/lib/rboss/cli/mappings/resources/connector.yaml

@@ -40,8 +40,8 @@ print:
       bytes_sent: byte
       max_post_size: byte
       max_save_post_size: byte
-      enabled: yes_or_no
-      secure: yes_or_no
+      enabled: boolean
+      secure: boolean
 
     color:
       scheme:

data/lib/rboss/cli/mappings/resources/datasource.yaml

@@ -7,66 +7,67 @@ print:
   title: Datasource Details
   layout: vertical
   properties:
-  - jndi-name
-  - connection-url
-  - driver-name
-  - user-name
-  - password
-  - jta
-  - min-pool-size
-  - max-pool-size
-  - enabled
+    - jndi-name
+    - connection-url
+    - driver-name
+    - user-name
+    - password
+    - jta
+    - min-pool-size
+    - max-pool-size
+    - enabled
   header:
-  - JNDI Name
-  - Connection URL
-  - Driver Name
-  - User Name
-  - Password
-  - Using JTA
-  - Min Pool Size
-  - Max Pool Size
-  - Enabled
+    - JNDI Name
+    - Connection URL
+    - Driver Name
+    - User Name
+    - Password
+    - Using JTA
+    - Min Pool Size
+    - Max Pool Size
+    - Enabled
   format:
-    enabled: yes_or_no
-    using_jta: yes_or_no
+    enabled: boolean
+    using_jta: boolean
 
   color:
     jndi_name:
       with: purple
     enabled: boolean
+    using_jta: boolean
     connection_url:
-      with: brown
+      with: yellow
 
 - id: pool
   title: Datasource Pool Statistics
   path: ${PATH}/statistics=pool
   layout: vertical
   properties:
-  - ActiveCount
-  - AvailableCount
-  - AverageBlockingTime
-  - AverageCreationTime
-  - CreatedCount
-  - DestroyedCount
-  - MaxCreationTime
-  - MaxUsedCount
-  - MaxWaitTime
-  - TimedOut
-  - TotalBlockingTime
-  - TotalCreationTime
+    - ActiveCount
+    - AvailableCount
+    - AverageBlockingTime
+    - AverageCreationTime
+    - CreatedCount
+    - DestroyedCount
+    - MaxCreationTime
+    - MaxUsedCount
+    - MaxWaitTime
+    - TimedOut
+    - TotalBlockingTime
+    - TotalCreationTime
 
   header:
-  - Active
-  - Available
-  - Average Blocking
-  - Average Creation
-  - Created
-  - Destroyed
-  - Max Creation
-  - Max Wait
-  - Timed Out
-  - Total Blocking
-  - Total Creation
+    - Active
+    - Available
+    - Average Blocking
+    - Average Creation
+    - Created
+    - Destroyed
+    - Max Creation
+    - Max Wait
+    - Timed Out
+    - Total Blocking
+    - Total Creation
 
   health:
     active:
@@ -78,29 +79,16 @@ print:
   title: Datasource JDBC Statistics
   path: ${PATH}/statistics=jdbc
   properties:
-  - PreparedStatementCacheCurrentSize
-  - PreparedStatementCacheAccessCount
-  - PreparedStatementCacheAddCount
-  - PreparedStatementCacheDeleteCount
-  - PreparedStatementCacheHitCount
-  - PreparedStatementCacheMissCount
+    - PreparedStatementCacheCurrentSize
+    - PreparedStatementCacheAccessCount
+    - PreparedStatementCacheAddCount
+    - PreparedStatementCacheDeleteCount
+    - PreparedStatementCacheHitCount
+    - PreparedStatementCacheMissCount
   header:
-  - Current
-
-    Size
-  - Access
-
-    Count
-
-  - Add
-
-    Count
-  - Delete
-
-    Count
-  - Hit
-
-    Count
-  - Miss
-
-    Count
+    - "Current\nSize"
+    - "Access\nCount"
+    - "Add\nCount"
+    - "Delete\nCount"
+    - "Hit\nCount"
+    - "Miss\nCount"