rboss 0.1.0

data/lib/rboss.rb

@@ -0,0 +1,25 @@
+#                         The MIT License
+#
+# Copyright (c) 2011 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.
+
+require_relative "rboss/version"
+require_relative "rboss/jboss_profile"
+require_relative "rboss/twiddle"

data/lib/rboss/component_processor.rb

@@ -0,0 +1,177 @@
+#                         The MIT License
+#
+# Copyright (c) 2011 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.
+
+# A main class to process components based on a highly customizable set of parameters.
+#
+# 1. Creating a ComponentProcessor
+#   A ComponentProcessor needs a block that defines how to process a component. The block
+#   will receive the component type and the configuration.
+#
+#   Example: ComponentProcessor::new do |component_type, configuration|
+#              component_type.new(configuration).process
+#            end
+#
+# 2. Registering a component
+#   Components need to be registered in the processor. The registration uses an id and a hash
+#   of parameters described bellow:
+#
+#   :type => the type of the component. Only components with a defined type will be passed to the processor block
+#
+#   :multiple_instances => a flag to indicate if this component can be added more than once
+#   :priority => a number defining a priority for this component to be processed
+#
+#   :enabled => a flag to indicate if this component is enabled for processing by default
+#
+#   :defaults => a hash containing the default config parameters for this component (only if the configuration is a Hash)
+#
+#   :send_config => a hash for sending the configurations at process time to another component (only if the configuration
+#   is a Hash).
+#
+#     The configuration keys are sending using the pattern :to_$COMPONENT_ID and supports key overriding
+#     Example:
+#     :send_config => {
+#       :to_bar_service => {
+#         :foo => :bar
+#       }
+#       :to_foo_service => [:foo]
+#     }
+#     The :foo config will be moved to the component :bar_service using :bar as the configuration key and to the component
+#     :foo_service using the same name as the key.
+#
+#   :move_config => the same as for :send_config, but the configurations moved will not be passed to the block for this
+#   component.
+#
+# 3. Adding a component
+#
+# A component should be added by add method. You only need to specify the component id and the configuration (if needed).
+# When a component is added, it will be processed for sending or moving configurations and, if the component has a type,
+# it will be passed to the block for processing.
+#
+# author: Marcelo Guimarães <ataxexe@gmail.com>
+class ComponentProcessor
+
+  def initialize &block
+    @process = block
+    @process ||= lambda { |type, config| type.new(config).process }
+  end
+
+  # Register a component using the given id (which must be used for adding it to process) and parameters
+  def register component_id, params
+    params = {
+      :type => nil,
+      :multiple_instances => false,
+      :priority => 0,
+      :enabled => false,
+      :defaults => {}
+    }.merge! params
+    @components ||= {}
+    params[:configs] ||= [] if params[:multiple_instances]
+    @components[component_id] = params unless @components.has_key? component_id
+  end
+
+  def add component_id, config = {}
+    registered_component = @components[component_id]
+    return unless registered_component
+    defaults = registered_component[:defaults]
+    registered_component[:enabled] = true
+    config = defaults.merge config if config.is_a? Hash
+    if registered_component[:multiple_instances]
+      registered_component[:configs] << config
+    else
+      registered_component[:config] = config
+    end
+    propagate_configs registered_component
+  end
+
+  def defaults component_id, defaults
+    registered_component = @components[component_id]
+    registered_component[:defaults] = defaults if registered_component
+  end
+
+  def process_components
+    enabled_components = @components.find_all {|component_id, params| params[:enabled]}
+    (enabled_components.sort_by { |key, value| value[:priority] }).each do |key, component|
+      process_component component
+    end
+  end
+
+  private
+
+  def process_component component
+    return unless component[:type]
+    if component[:multiple_instances]
+      component[:configs].each do |config|
+        @process.call component[:type], config
+      end
+    else
+      config = component[:config]
+      config ||= component[:defaults]
+      @process.call component[:type], config
+    end
+  end
+
+  def propagate_configs component
+    #TODO refactor this -----------------------------------
+    if component[:send_config] and component[:config].is_a? Hash
+      component[:send_config].each do |to, keys|
+        destination = to.to_s.gsub(/^to_/, '').to_sym
+        config = {}
+        if keys.is_a? Array
+          keys.each do |key|
+            config[key] = component[:config][key] if component[:config].has_key? key
+          end
+        elsif keys.is_a? Hash
+          keys.each do |k, v|
+            config[v] = component[:config][k] if component[:config].has_key? k
+          end
+        end
+        send_config destination, config
+      end
+    end
+    if component[:move_config] and component[:config].is_a? Hash
+      component[:move_config].each do |to, keys|
+        destination = to.to_s.gsub(/^to_/, '').to_sym
+        config = {}
+        if keys.is_a? Array
+          keys.each do |key|
+            config[key] = component[:config].delete key if component[:config].has_key? key
+          end
+        elsif keys.is_a? Hash
+          keys.each do |k, v|
+            config[v] = component[:config].delete k if component[:config].has_key? k
+          end
+        end
+        send_config destination, config, :enable_component => true
+      end
+    end
+    #------------------------------------------------------
+  end
+
+  def send_config component_id, config, opts = {}
+    component = @components[component_id]
+    component[:defaults] ||= {}
+    component_config = @components[component_id][:defaults]
+    component_config.merge! config
+    component[:enabled] = true if opts[:enable_component]
+  end
+
+end

data/lib/rboss/components/component.rb

@@ -0,0 +1,52 @@
+#                         The MIT License
+#
+# Copyright (c) 2011 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.
+
+require_relative "../file_processor"
+require_relative "../jboss_path"
+require_relative "../utils"
+
+module JBoss
+
+  # A base helper module for JBoss Components
+  #
+  # author: Marcelo Guimarães <ataxexe@gmail.com>
+  module Component
+
+    def initialize jboss, logger, config
+      @jboss = jboss
+      @logger = logger
+      config = defaults.merge! config if self.respond_to? :defaults
+      configure(config)
+    end
+
+    def configure config
+      @config = config
+    end
+
+    # Creates a FileProcessor using the same logger and
+    # jboss path as the variable
+    def new_file_processor
+      FileProcessor::new :logger => @logger, :var => @jboss
+    end
+
+  end
+end

data/lib/rboss/components/datasource.rb

@@ -0,0 +1,198 @@
+#                         The MIT License
+#
+# Copyright (c) 2011 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.
+
+require_relative "component"
+
+require "logger"
+require "rexml/document"
+
+include REXML
+
+module JBoss
+
+  # A class to configure a JBoss Datasource.
+  #
+  # For converting the property (if it is a Symbol), the above rules are used taking by example a
+  # value ":database_url":
+  #   a. The value "database_url"
+  #   b. The value "database-url"
+  #   c. The value "DatabaseUrl"
+  #   d. The value "DATABASE_URL"
+  #
+  # The key for finding the correct datasource is the configuration attribute :type, which is used
+  # to search in $JBOSS_HOME/docs/examples/jca for the file.
+  #
+  # Any key that is not found in the datasource template will be added. If it is a Symbol, the underlines will be
+  # converted to hyphens.
+  #
+  # For saving the file, the configuration :name will be used in the form "${name}-ds.xml".
+  #
+  # Configuration:
+  #
+  # :folder => a folder where this datasource will be saved (default: $JBOSS_HOME/server/$CONFIG/deploy)
+  #            if a relative path is given, it will be appended to default value
+  # :encrypt => a flag to indicate if the password should be encrypted (default: false)
+  # :type => the type of the datasource
+  # :name => a name for saving the file (default: :type)
+  # :attributes => a Hash with the attributes that will be changed in template (the only required is :jndi_name)
+  #   Any attribute that is not present in datasource xml will be created using this template: <key>value</key>.
+  #
+  # author: Marcelo Guimarães <ataxexe@gmail.com>
+  class Datasource
+    include Component
+
+    attr_accessor :jndi_name, :attributes, :type, :name
+
+    def defaults
+      {
+        :folder => "#{@jboss.profile}/deploy",
+        :encrypt => false,
+        :attributes => {}
+      }
+    end
+
+    def configure config
+      config[:type] = :mssql if config[:type].to_s == "sqlserver"
+      @type = config[:type].to_s.gsub /_/, '-'
+      @name = config[:name]
+      @name ||= @type.to_s
+      @folder = config[:folder].to_s
+      @folder = "#{@jboss.profile}/#{@folder}" unless @folder.start_with? '/'
+      @attributes = config[:attributes]
+      @encrypt = config[:encrypt]
+      @jndi_name = @attributes.delete :jndi_name
+    end
+
+    def process
+      if @encrypt
+        @user = @attributes.delete :user
+        @user = @attributes.delete :user_name unless @user
+        @password = encrypt @attributes.delete :password
+      end
+      processor = new_file_processor
+      processor.with "#{@jboss.home}/docs/examples/jca/#{@type}-ds.xml", :xml do |action|
+        action.to_process do |xml, jboss|
+          element = XPath.first xml, "//jndi-name"
+          element.text = @jndi_name
+          configure_datasource xml
+
+          if @encrypt
+            security_domain = Element::new "security-domain"
+            security_domain.text = @name
+
+            xml.root.elements[1] << security_domain
+          end
+          action.copy_to "#{@folder}/#{@name}-ds.xml"
+          xml
+        end
+      end
+      @logger.info "Creating datasource #{@name}"
+      processor.process
+      if @encrypt
+        create_login_module
+        create_login_config
+      end
+    end
+
+    def find xml, key
+      if key.is_a? Symbol
+        key = key.to_s
+        [key, key.gsub(/_/, '-'), key.camelize, key.upcase].each do |k|
+          element = XPath.first xml, yield(k)
+          return element if element
+        end
+      else
+        XPath.first xml, yield(key)
+      end
+      nil
+    end
+
+    def configure_datasource xml
+      if @encrypt
+        xml.root.delete_element "//user-name"
+        xml.root.delete_element "//password"
+        @service = "LocalTxCM"
+      end
+      @attributes.each do |key, value|
+        element = find(xml, key) { |k| "//#{k}" }
+
+        if element
+          element.text = value
+        else
+          insert_attribute xml, key, value
+        end
+      end
+    end
+
+    def insert_attribute xml, key, value
+      if key.is_a? Symbol
+        element = Element::new key.to_s.gsub /_/, '-'
+      else
+        element = Element::new key
+      end
+      element.text = value
+      xml.root.elements[1] << element
+    end
+
+    def create_login_config
+      File.open("#{@folder}/#{@name}.login-module.xml", 'w+') { |f| f.write @login_module }
+    end
+
+    def create_login_module
+      @login_module = Document::new <<XML
+<policy>
+  <application-policy name='#{@name}'>
+    <authentication>
+      <login-module code='org.jboss.resource.security.SecureIdentityLoginModule' flag='required'>
+        <module-option name='username'>#{@user}</module-option>
+        <module-option name='password'>#{@password}</module-option>
+        <module-option name='managedConnectionFactoryName'>jboss.jca:name=#{@jndi_name},service=#{@service}</module-option>
+      </login-module>
+    </authentication>
+  </application-policy>
+</policy>
+XML
+    end
+
+    def jboss_logging_lib_path
+      %W{#{@jboss.home}/client/jboss-logging-spi.jar #{@jboss.home}/client/jboss-logging.jar}.each do |path|
+        return path if File.exist? path
+      end
+    end
+
+    def jbosssx_lib_path
+      %W{#{@jboss.home}/lib/jbosssx.jar #{@jboss.home}/common/lib/jbosssx.jar}.each do |path|
+        return path if File.exist? path
+      end
+    end
+
+    # Encrypts the given password using the SecureIdentityLoginModule
+    def encrypt password
+      cmd = "java -cp #{jboss_logging_lib_path}:#{jbosssx_lib_path} org.jboss.resource.security.SecureIdentityLoginModule #{password}"
+      @logger.debug cmd
+      encrypted = `#{cmd}`
+      encrypted.chomp.split(/:/)[1].strip
+    end
+
+  end
+
+end