rboss 0.6.1 → 0.6.2

data/README.md

@@ -142,8 +142,12 @@ limits by using a :health key:
       :properties => %W(activeCount currentFree maxAvailable),
       :header => ['Active Count', 'Current Free', 'Max Available'],
       :health => {
-        :max => :max_available,
-        :using => :active_count #or use :free if you have the number of free resources
+        :active_count => {
+          :percentage => { # uses a percentage based check
+            :max => :max_available,
+            :using => :active_count #or use :free if you have the number of free resources
+          }
+        }
       },
       :scan => proc do
         # queries and pass each result do the block

data/bin/rboss-cli

@@ -32,8 +32,10 @@ require 'yummi'
 params = {}
 @conf_dir = File.expand_path "~/.rboss"
 servers_file = "#@conf_dir/jboss-cli-servers.yaml"
-@components = {}
+@resources = {}
+@parameters = {}
 @servers_file = File.expand_path(servers_file)
+@operation = :read_resource
 save = false
 params[:jboss_home] = (ENV["JBOSS_HOME"] or ENV["RBOSS_CLI_JBOSS_HOME"] or Dir.pwd)
 params[:host] = '127.0.0.1'
@@ -68,7 +70,7 @@ end
 opts.on('--save SERVER_NAME', "Saves the server configuration in #{servers_file}") do |server|
   save = server
 end
-opts.on('--loop INTERVAL', Float, 'Runs the mbean inside a loop') do |interval|
+opts.on('--loop INTERVAL', Float, 'Run inside a loop') do |interval|
   @loop = true
   @interval = interval
 end
@@ -86,21 +88,35 @@ opts.on('-v', '--verbose', 'Displays jboss-cli commands before execution') do
   params[:log_level] = Logger::DEBUG
 end
 
+opts.on('-o', '--operation NAME',
+        'Sets the operation to invoke (Defaults to "read-resource")') do |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)})]
+end
+
 RBoss::Cli::Mappings.resource_mappings.each do |name, config|
   if config[:scan]
     opts.on("--#{name} [NAMES]", Array, config[:description]) do |resources|
-      @components[name] = resources || :all
+      @resources[name] = resources
     end
   else
     opts.on("--#{name}", config[:description]) do
-      @components[name] = true
+      @resources[name] = true
     end
   end
 end
 
 opts.on('--all', 'Display all available info') do
   RBoss::Cli::Mappings.resource_mappings.each do |name, config|
-    @components[name] = :all unless config[:derived]
+    @resources[name] = nil unless config[:derived]
   end
 end
 
@@ -131,13 +147,17 @@ if save
   puts "Configuration saved!"
 end
 
-puts opts if @components.empty?
+puts opts if @resources.empty?
 
 def execute_actions
-  content = @jboss_cli.content(@components)
-  system "clear" if @loop
-  puts Yummi.colorize(Time.now.strftime("At %H:%M:%S%n"), :white) if @loop
-  puts content
+  begin
+    content = @jboss_cli.invoke(@operation, @resources, @parameters)
+    system "clear" if @loop
+    puts Yummi.colorize(Time.now.strftime("At %H:%M:%S%n"), :white) if @loop
+    puts content.chomp
+  rescue RBoss::Cli::InvocationFailed => e
+    puts Yummi::colorize e.message, :intense_red
+  end
 end
 
 while @loop

data/lib/rboss/cli/{jboss_cli.rb → invoker.rb}

@@ -20,17 +20,21 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'result_parser'
 require_relative 'resource'
 require_relative 'mappings'
 
 require 'logger'
 
+require 'yummi'
+require 'yaml'
+
 module RBoss
 
   module Cli
 
     class Invoker
-      include RBoss::Cli::Mappings, RBoss::Platform
+      include RBoss::Cli::Mappings, RBoss::Platform, RBoss::Cli::ResultParser
 
       attr_reader :server, :host, :port, :user, :password
 
@@ -58,6 +62,8 @@ module RBoss
           end
           @logger.formatter = formatter
         end
+
+        @skip_optional = params[:skip_optional]
       end
 
       def command
@@ -68,24 +74,74 @@ module RBoss
         command
       end
 
-      def content(components)
+      def invoke(operation, resources, parameters)
         buff = ""
-        components.each do |key, resources|
+        resources.each do |key, resource_names|
           if resource_mappings.has_key? key
             mapping = resource_mappings[key]
-            component = RBoss::Cli::Resource::new(self, mapping)
-            buff << component.content(resources)
+            resource = RBoss::Cli::Resource::new(self, mapping)
+            result = resource.invoke(operation, resource_names, parameters)
+            buff << result.to_s if result
           end
         end
         buff
       end
 
+      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)
+        builder = CommandBuilder::new operation
+        result["request-properties"].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
+            end
+          end
+          next if input.empty?
+          builder << {:name => name, :value => detail['type'].convert(input)}
+        end
+        result = result("#{path}:#{builder}")
+        puts YAML::dump(result)
+      end
+
       def execute(*commands)
-        exec = "#{command} --commands=\"#{commands.join ','}\""
+        exec = "#{command} --command#{commands.size > 1 ? 's' : ''}=\"#{commands.join ','}\""
         @logger.debug exec
         `#{exec}`.chomp
       end
 
+      def result(*commands)
+        eval_result(execute commands)
+      end
+
+    end
+
+    class CommandBuilder
+
+      def initialize (operation)
+        @operation = operation
+        @params = {}
+      end
+
+      def << (param)
+        @params[param[:name]] = param[:value]
+      end
+
+      def to_s
+        params = (@params.collect() { |k, v| "#{k}=#{v}" }).join ','
+        "#@operation(#{params})"
+      end
+
     end
 
   end

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

@@ -1,7 +1,7 @@
 ---
 description: Details Connectors
 path: /subsystem=web/connector=${NAME}
-scan: ls ${PATH}
+scan: ls /subsystem=web/connector
 print:
   - title: Connectors
     layout: vertical

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

@@ -1,7 +1,7 @@
 ---
-description: Detail Datasource Information
+description: Datasource Information
 path: /subsystem=datasources/data-source=${NAME}
-scan: ls ${PATH}
+scan: ls /subsystem=datasources/data-source
 print:
 - id: config
   title: Datasource Details
@@ -39,7 +39,7 @@ print:
 
 - id: pool
   title: Datasource Pool Statistics
-  command: ${PATH}/statistics=pool:${READ_RESOURCE}
+  path: ${PATH}/statistics=pool
   layout: vertical
   properties:
   - ActiveCount
@@ -76,7 +76,7 @@ print:
 
 - id: jdbc
   title: Datasource JDBC Statistics
-  command: ${PATH}/statistics=jdbc:${READ_RESOURCE}
+  path: ${PATH}/statistics=jdbc
   properties:
   - PreparedStatementCacheCurrentSize
   - PreparedStatementCacheAccessCount

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

@@ -1,7 +1,7 @@
 ---
 description: Detail JDBC Drivers
 path: /subsystem=datasources/jdbc-driver=${NAME}
-scan: ls ${PATH}
+scan: ls /subsystem=datasources/jdbc-driver
 print:
 - title: JDBC Drivers
   properties:

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

@@ -4,7 +4,7 @@ path: /core-service=
 print:
 - id: platform
   title: Operating System Information
-  command: ${PATH}platform-mbean/type=operating-system:${READ_RESOURCE}
+  path: ${PATH}platform-mbean/type=operating-system
   properties:
   - name
   - arch
@@ -19,10 +19,19 @@ print:
   - System Load
   format:
     system_load: percentage
+  color:
+      name:
+        with: white
+      system_load:
+        threshold:
+          0.8: intense_red
+          0.7: red
+          0.5: brown
+          0: green
 
 - id: env
   title: Server Environment Information
-  command: ${PATH}server-environment:${READ_RESOURCE}
+  path: ${PATH}server-environment
   properties:
   - server-name
   - node-name
@@ -54,7 +63,7 @@ print:
 - id: memory
   title: Server Memory Usage
   layout: vertical
-  command: ${PATH}platform-mbean/type=memory:${READ_RESOURCE}
+  path: ${PATH}platform-mbean/type=memory
   properties:
   - heap-memory-usage -> init
   - heap-memory-usage -> used
@@ -111,7 +120,7 @@ print:
 
 - id: thread
   title: Server Thread Info
-  command: ${PATH}platform-mbean/type=threading:${READ_RESOURCE}
+  path: ${PATH}platform-mbean/type=threading
   layout: vertical
   properties:
   - thread-contention-monitoring-supported
@@ -162,7 +171,7 @@ print:
 
 - id: config
   title: Server Configuration Resources
-  command: ${PATH}server-environment:${READ_RESOURCE}
+  path: ${PATH}server-environment
   layout: vertical
   properties:
   - server-name

data/lib/rboss/cli/mappings.rb

@@ -42,6 +42,10 @@ module RBoss
             new_mapping[:print] = [table]
             new_mapping[:description] = table[:title]
             new_mapping[:derived] = true
+            if table[:path]
+              new_mapping[:path] = table[:path].gsub '${PATH}', mapping[:path]
+              table[:path] = new_mapping[:path]
+            end
             new_key = "#{name}-#{table[:id]}"
             @resource_mappings[new_key] = new_mapping
           end

data/lib/rboss/cli/resource.rb

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+
 module RBoss
   module Cli
     class Resource
@@ -36,22 +37,27 @@ module RBoss
         @count = 0
       end
 
-      def content(resources)
-        if :all == resources and scannable?
-          resources = scan
+      def invoke(operation, resource_names, arguments)
+        if respond_to? operation.to_key
+          send operation.to_key, resource_names, arguments
+        else
+          interact_to_invoke operation, resource_names, arguments
+          Yummi.colorize('Operation Executed!', :green)
         end
-        resources = [resources] unless resources.is_a? Array
+      end
+
+      def read_resource(resources, arguments)
+        resources ||= scan
         params = @config[:print]
         params.each do |p|
           table_builder = RBoss::TableBuilder::new p
           table_builder.add_name_column if scannable?
           @tables << table_builder.build_table
         end
-        resources.each do |resource|
-          @context[:name] = resource
-          @context[:path] = parse(@config[:path])
-
+        with resources do
           params.each do |p|
+            @context[:path] = parse(@config[:path])
+            @context[:path] = parse(p[:path]) if p[:path]
             add_row(p)
           end
         end
@@ -63,6 +69,112 @@ module RBoss
         result
       end
 
+      def read_operation_names(resource_name, arguments)
+        operations = Yummi::colorize('Operations:', :yellow)
+        operations << $/
+        with resource_name do
+          result = @invoker.result("#{@context[:path]}:read-operation-names")
+          result.each do |operation|
+            operations << Yummi::colorize('- ', :intense_purple)
+            operations << Yummi::colorize(operation, :intense_blue) << $/
+          end
+        end
+        operations
+      end
+
+      def read_operation_description (resource_name, arguments)
+        buff = ''
+        with resource_name do
+          operation_name = arguments['name']
+          table = Yummi::Table::new
+          buff << Yummi::colorize(operation_name, :intense_green) << $/
+          result = @invoker.result(
+            "#{@context[:path]}:read-operation-description(name=#{operation_name})"
+          )
+          buff << Yummi::colorize(result['description'], :intense_gray) << $/ * 2
+          table.title = 'Request'
+          table.header = %w(Parameter Type Required Default)
+          table.aliases = %w(name type required default)
+          table.colorize('name', :with => :white)
+
+          table.using_row do
+            table.colorize %w(type default) do |value|
+              RBoss::Colorizers.type(value['type']).color_for(value)
+            end
+          end
+
+          table.format 'required', :using => RBoss::Formatters.yes_or_no
+          table.colorize 'required', :using => RBoss::Colorizers.boolean
+          result["request-properties"] ||= {}
+          unless result["request-properties"].empty?
+            result["request-properties"].each do |name, detail|
+              detail['name'] = name
+              table << detail
+            end
+            buff << table.to_s << $/
+          end
+
+          table = Yummi::Table::new
+          table.title = 'Response'
+          table.header = %w(Parameter Type Nilable Unit)
+          table.aliases = %w(name type nilable unit)
+
+          table.colorize 'name', :with => :white
+
+          table.using_row do
+            table.colorize 'type' do |value|
+              RBoss::Colorizers.type(value['type']).color_for(value)
+            end
+          end
+
+          table.format 'nilable', :using => RBoss::Formatters.yes_or_no
+          table.colorize 'nilable', :using => RBoss::Colorizers.boolean
+          result["reply-properties"] ||= {}
+          unless result["reply-properties"].empty?
+            result = result["reply-properties"]
+            table.description = result['description']
+            table << result
+            build_nested(result).each do |nested|
+              table << nested
+            end
+            buff << table.to_s << $/
+          end
+        end
+        buff
+      end
+
+      alias_method :list_operations, :read_operation_names
+      alias_method :detail_operation, :read_operation_description
+
+      private
+
+      def build_nested(detail, parent_name = '', result = [])
+        if detail['value-type']
+          detail['value-type'].each do |name, _detail|
+            name = "#{parent_name}#{name}"
+            _detail['name'] = name
+            result << _detail
+            build_nested(_detail, "#{name} => ", result)
+          end
+        end
+        result
+      end
+
+      def interact_to_invoke(operation, resource_name, arguments)
+        with resource_name do
+          @invoker.gets_and_invoke(@context[:path], operation, arguments)
+        end
+      end
+
+      def with(resources)
+        resources ||= ''
+        [*resources].each do |resource|
+          @context[:name] = resource
+          @context[:path] = parse(@config[:path])
+          yield
+        end
+      end
+
       def add_row(params)
         data = get_data(params)
         return unless data
@@ -76,12 +188,13 @@ module RBoss
         result = value.scan /\$\{\w+\}/
         result.each do |matched|
           key = matched[2...-1].downcase.to_sym
-          value = value.gsub(matched, @context[key])
+          value = value.gsub(matched, @context[key].to_s)
         end
         value
       end
 
       def scan
+        return '' unless scannable?
         result = @invoker.execute(parse @config[:scan])
         result.split "\n"
       end
@@ -91,30 +204,27 @@ module RBoss
       end
 
       def get_data(config)
-        command = (config[:command] or '${PATH}:${READ_RESOURCE}')
-        result = @invoker.execute(parse command)
-        result = eval_result(result)
-        data = []
-        config[:properties].each do |prop|
-          data << get_property(prop, result)
+        command = parse((config[:command] or '${PATH}:read-resource(include-runtime=true)'))
+        begin
+          result = @invoker.result(command)
+          data = []
+          config[:properties].each do |prop|
+            data << get_property(prop, result)
+          end
+          data
+        rescue
+          nil
         end
-        data
       end
 
       def get_property(prop, result)
-        value = result["result"]
+        value = result
         prop.split(/\s*->\s*/).each do |p|
           value = value[p]
         end
         value
       end
 
-      def eval_result(result)
-        undefined = nil #prevents error because undefined means nil in result object
-        result = result.gsub /(\d+)L/, '\1' #removes the long type mark
-        eval(result)
-      end
-
     end
   end
 end

data/lib/rboss/cli/result_parser.rb

@@ -0,0 +1,80 @@
+#                         The MIT License
+#
+# Copyright (c) 2011-2012 Marcelo Guimarães <ataxexe@gmail.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module RBoss
+  module Cli
+
+    class InvocationFailed < Exception
+
+      def initialize(message)
+        super(message)
+      end
+
+    end
+
+    module ResultParser
+
+      class Type
+
+        attr_reader :name
+
+        def initialize (name, &block)
+          @name = name
+          @converter_block = block
+        end
+
+        def convert (value)
+          @converter_block.call value
+        end
+
+        def to_s
+          @name
+        end
+
+      end
+
+      STRING = Type::new 'STRING' do |string|
+        "\"#{string}\""
+      end
+      BOOLEAN = Type::new 'BOOLEAN' do |string|
+        'true' == string.downcase
+      end
+      INT = Type::new 'INT' do |string|
+        string.to_i
+      end
+      LONG = Type::new 'LONG' do |string|
+        string.to_i
+      end
+      LIST = Type::new 'LIST'
+      OBJECT = Type::new 'OBJECT'
+
+      def eval_result(result)
+        undefined = nil #prevents error because undefined means nil in result object
+        result = result.gsub /(\d+)L/, '\1' #removes the long type mark
+        result = eval(result)
+        raise InvocationFailed::new(result["failure-description"]) if result["outcome"] == "failed"
+        result["result"]
+      end
+
+    end
+  end
+end

data/lib/rboss/components/resource.rb

@@ -40,8 +40,7 @@ module RBoss
     def process
       @logger.info "Including resources..."
       @config.each do |to_path, resources|
-        resources = [resources] unless resources.is_a? Array
-        resources.each do |resource|
+        [*resources].each do |resource|
           to_path = "#{@jboss.profile}/#{to_path}" unless to_path.to_s.start_with? '/'
           cp_r File.expand_path(resource), to_path
         end

data/lib/rboss/components/slimming.rb

@@ -63,7 +63,7 @@ module RBoss
     include Component, FileUtils
 
     def configure services_to_remove
-      @services_to_remove = services_to_remove.is_a?(Array) ? services_to_remove : [services_to_remove]
+      @services_to_remove = [*services_to_remove]
       @mapping = {}
       load_yaml('slimming').each do |key, values|
         @mapping[key.to_sym] = values

data/lib/rboss/twiddle/mbean.rb

@@ -91,7 +91,7 @@ module RBoss
 
     def name
       if pattern['#{resource}'] and not @resource
-        domain,name = pattern.split ':'
+        domain, name = pattern.split ':'
         name.gsub! /[^,]+\{resource\}/, ''
         name << "," if name.empty?
         name << "*"
@@ -107,7 +107,7 @@ module RBoss
       result = @twiddle.execute(:get, query, property)
 
       def result.value
-        self.split(/=/)[1..-1].join "="
+        self.split(/=/, 2)[1]
       end
 
       result

data/lib/rboss/utils.rb

@@ -30,6 +30,18 @@ class String
     self[0, 1].downcase + self[1..-1]
   end
 
+  def to_key
+    self.gsub('-', '_').to_sym
+  end
+
+end
+
+class Symbol
+
+  def to_key
+    self
+  end
+
 end
 
 class Hash
@@ -43,7 +55,8 @@ class Hash
           end
         end
       end
-      h[k.to_sym] = v
+      k = k.to_sym if k.respond_to? :to_sym
+      h[k] = v
       h
     end)
   end

data/lib/rboss/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module RBoss
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/lib/rboss/view/colorizers.rb

@@ -4,14 +4,38 @@ module RBoss
   module Colorizers
 
     def self.boolean params = {}
-      lambda do |value|
-        return (params[:if_true] or :green) if value
-        params[:if_false] or :brown
+      Yummi::to_colorize do |value|
+        value ? (params[:if_true] or :green) : (params[:if_false] or :brown)
+      end
+    end
+
+    def self.threshold params
+      colorize = lambda do |value|
+        params.sort.reverse_each do |limit, color|
+          return color if value > limit
+        end
+      end
+      Yummi::to_colorize &colorize
+    end
+
+    def self.type type
+      Yummi::to_colorize do |value|
+        case type
+          when RBoss::Cli::ResultParser::STRING then
+            :green
+          when RBoss::Cli::ResultParser::INT,
+            RBoss::Cli::ResultParser::LONG then
+            :blue
+          when RBoss::Cli::ResultParser::BOOLEAN then
+            :purple
+          else
+            :cyan
+        end
       end
     end
 
     def self.with color
-      lambda do |value|
+      Yummi::to_colorize do |value|
         color
       end
     end

data/lib/rboss.rb

@@ -22,11 +22,11 @@
 
 require_relative "rboss/version"
 require_relative "rboss/plaftorm"
-require_relative "rboss/jboss_profile"
-require_relative "rboss/twiddle"
-require_relative "rboss/cli/jboss_cli"
-require_relative "rboss/bin/command_actions"
 require_relative "rboss/view/colorizers"
 require_relative "rboss/view/formatters"
 require_relative "rboss/view/health_checkers"
 require_relative "rboss/view/table_builder"
+require_relative "rboss/jboss_profile"
+require_relative "rboss/twiddle"
+require_relative "rboss/cli/invoker"
+require_relative "rboss/bin/command_actions"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rboss
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-15 00:00:00.000000000 Z
+date: 2012-07-19 00:00:00.000000000 Z
 dependencies: []
 description: ! "A tool to create profiles for JBoss Application Server and use\n twiddle
   to manage a running JBoss AS."
@@ -31,13 +31,14 @@ files:
 - bin/twiddle
 - lib/rboss.rb
 - lib/rboss/bin/command_actions.rb
-- lib/rboss/cli/jboss_cli.rb
+- lib/rboss/cli/invoker.rb
 - lib/rboss/cli/mappings.rb
 - lib/rboss/cli/mappings/resources/connector.yaml
 - lib/rboss/cli/mappings/resources/datasource.yaml
 - lib/rboss/cli/mappings/resources/jdbc_driver.yaml
 - lib/rboss/cli/mappings/resources/server.yaml
 - lib/rboss/cli/resource.rb
+- lib/rboss/cli/result_parser.rb
 - lib/rboss/component_processor.rb
 - lib/rboss/components/component.rb
 - lib/rboss/components/datasource.rb