tccbuilder 0.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jamie Winsor
+
+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.

data/README.rdoc

@@ -0,0 +1,19 @@
+= TCCBuilder
+
+== Synopsis 
+  Manipulates an existing Tomcat server.xml file to assist in automated
+  deployments and configurations.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jamie Winsor. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tccbuilder"
+    gem.summary = %Q{Utilities to assist in configuring Tomcat via Ruby or the command line}
+    gem.description = %Q{Utilities to assist in configuring Tomcat via Ruby or the command line}
+    gem.email = "resetexistence@gmail.com"
+    gem.homepage = "http://github.com/resetexistence/tccbuilder"
+    gem.authors = ["Jamie Winsor"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tccbuilder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/tc6confbldr

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'tccbuilder'
+
+exit TCCBuilder::Cmdlet.run!(__FILE__, 6, *ARGV)

data/lib/tccbuilder.rb

@@ -0,0 +1,50 @@
+class TCCBuilder
+  require 'ostruct'
+  require 'rexml/document'
+  require 'tccbuilder/errors'
+  require 'tccbuilder/cmdlet'
+  
+  attr_reader :options
+  attr_reader :version
+  attr_reader :server_xml
+  FORMATTER = REXML::Formatters::Pretty.new
+  
+  def initialize(version, options)
+    @options = options
+    @version = version
+    klass = case @version
+    when 6
+      require 'tccbuilder/tomcat6'
+      Tomcat6::ServerXML
+    else
+      raise UnsupportedTomcatVersion, "Unsupported Tomcat version: #{@version}"
+    end
+    @server_xml = klass.new(@options.config_file)
+  end
+  
+  def add_virtual_host
+    raise VirtualHostAlreadyExists if self.server_xml.virtual_host_exists?(self.options.name, self.options.service)
+    self.server_xml.add_virtual_host(self.options.name, self.options.service, self.options)
+    self.save
+  end
+  
+  def rm_virtual_host
+    raise VirtualHostNotFound unless self.server_xml.virtual_host_exists?(self.options.name, self.options.service)
+    self.server_xml.remove_virtual_host(self.options.name, self.options.service)
+    self.save
+  end
+
+  def update_virtual_host
+    # Stub
+    # self.server_xml.update_virtual_host(self.options.name, self.options.service)
+    # self.save
+  end
+  
+  protected
+  
+  def save
+    File.open(self.server_xml.file, "w+") do |f|
+      FORMATTER.write(self.server_xml.xml, f)
+    end
+  end
+end

data/lib/tccbuilder/cmdlet.rb

@@ -0,0 +1,69 @@
+class TCCBuilder
+  class Cmdlet
+    require 'tccbuilder/options'
+    
+    class << self
+      def run!(bin_name, version, *arguments)
+        @options = Options.new(bin_name, arguments)
+        
+        if @options.invalid_command
+          em_puts "Invalid command: #{@options.invalid_command}"
+          @options.show_help = true
+        end
+          
+        if @options.missing_options && !@options.invalid_command
+          em_puts "Missing options: #{@options.missing_options.join(', ')}"
+          @options.show_help = true
+        end
+    
+        if @options.invalid_option
+          em_puts @options.invalid_option
+          @options.show_help = true
+        end
+  
+        if @options.show_help
+          puts @options.opts
+          Kernel.abort
+        end
+
+        tccbuilder = TCCBuilder.new(version, @options)
+        
+        begin
+          case @options.command
+          when "add_vhost"
+            tccbuilder.add_virtual_host
+            em_puts "VirtualHost successfully added! [#{@options.name}]"
+          when "rm_vhost"
+            tccbuilder.rm_virtual_host
+            em_puts "VirtualHost successfully deleted! [#{@options.name}]"
+          end
+          return 0
+        rescue VirtualHostAlreadyExists
+          em_puts "Virtual Host already exists."
+          exit 0
+        rescue VirtualHostNotFound
+          em_puts "Virtual Host not found."
+          exit 0
+        rescue ElementNotFound, Errno::ENOENT => err
+          em_abort err
+        end
+      end
+
+      protected
+
+      def em_abort(str)
+        Kernel.abort console_format(str)
+      end
+
+      def em_puts(str)
+        puts console_format(str)
+      end    
+
+      private
+
+      def console_format(str)
+        "[Tomcat Config Helper] #{str}"
+      end
+    end
+  end
+end

data/lib/tccbuilder/errors.rb

@@ -0,0 +1,8 @@
+class TCCBuilder
+  class TCCBuilderError < StandardError; end
+  class UnsupportedTomcatVersion < TCCBuilderError; end
+  class VirtualHostNotFound < TCCBuilderError; end  
+  class VirtualHostAlreadyExists < TCCBuilderError; end
+  class XMLError < TCCBuilderError; end
+  class ElementNotFound < XMLError; end
+end

data/lib/tccbuilder/options.rb

@@ -0,0 +1,111 @@
+require 'ostruct'
+
+class TCCBuilder
+  class Options < OpenStruct
+    require 'optparse'
+    
+    attr_reader :opts
+    attr_reader :command
+    attr_reader :orig_args
+  
+    HELP_FLAG = "-h"
+    VALID_COMMANDS = ['add_vhost', 'rm_vhost']
+
+    def initialize(bin_name, args)
+      super()
+      
+      # First argument should be a valid command or help_flag
+      self.command = args.slice!(0)
+      
+      # Setup default options
+      self.service = "Catalina"
+      
+      @opts = OptionParser.new do |opt|
+        opt.banner = "Usage: #{bin_name} [command] [options]"
+        opt.separator ""
+        opt.separator "Commands:\n"
+        VALID_COMMANDS.each do |cmd|
+          opt.separator "\t#{cmd}\n"
+        end
+        opt.separator ""
+        opt.separator "Specific options:"
+
+        opt.on("-c", "--config CONFIG", String, "Path to Tomcat server.xml config file.") do |f|
+          self.config_file = f
+        end
+        opt.on("-n", "--hostname HOSTNAME", String, "Hostname of the target Virtual Host.") do |f|
+          self.name = f
+        end
+        opt.on("-s", "--service [SERVICE]", String, "Service to place Virtual Host under. (Default: Catalina)") do |f|
+          self.service = f
+        end
+        opt.on("-a", "--app-base APP_BASE", String, "Application base of Virtual Host.") do |f|
+          self.app_base = f
+        end
+        opt.on("-p", "--path [PATH]", String, "Path of the Virtual Host's context.") do |f|
+          self.path = f
+        end
+        opt.on("-d", "--doc-base [DOC_BASE]", String, "Document base of the Virtual Host's context.") do |f|
+          self.doc_base = f
+        end
+        opt.on("--debug-level [LEVEL]", Integer, "Debug level of Virtual Host's context.") do |f|
+          self.debug = f
+        end
+        opt.on("--aliases ALIAS_1,ALIAS_2", Array, "Optional list of aliases for Virtual Host.") do |list|
+          self.aliases = list
+        end
+        opt.on("-C", "--class-name [CLASS_NAME]", String, "Java class name of the implementation to use.") do |f|
+          self.class_name = f
+        end
+        opt.on("--disable-unpack-wars", "Enable unpack wars.") do
+          self.unpack_wars = false
+        end
+        opt.on("--reloadable", "Enable reloadable flag.") do
+          self.reloadable = true
+        end
+        opt.on("--disable-auto-deploy", "Disables periodic checks for new or updated web applications while running.") do
+          self.auto_deploy = false
+        end
+        opt.on("--background-processor-delay", "Sets the delay in seconds between invocation of backgroundProcess method on host and child containers.") do |f|
+          self.background_processor_delay = f
+        end
+        opt.on("--disable-deploy-on-startup", "Indicates if web applications from this host should be automatically deployed when Tomcat starts.") do
+          self.deploy_on_startup = false
+        end
+        opt.on_tail(HELP_FLAG, "--help", "Show this message.") do
+          self.show_help = true
+        end
+      end
+    
+      begin
+        @opts.parse!(args)
+      rescue OptionParser::InvalidOption => e
+        self.invalid_option = e
+      end
+      
+      if self.command == HELP_FLAG
+        self.show_help = true
+      else
+        mandatory_flags = [:config_file, :name]
+        missing_required_opts = mandatory_flags.select { |param| self.send(param).nil? }
+        unless missing_required_opts.empty?
+          self.missing_options = missing_required_opts
+        end
+      end
+    end
+    
+    private
+    
+    def command=(command)
+      if Options.valid_command?(command)
+        @command = command
+      else
+        self.invalid_command = command
+      end
+    end
+
+    def self.valid_command?(command)
+      VALID_COMMANDS.any? { |cmd| cmd == command } || command == HELP_FLAG
+    end
+  end
+end

data/lib/tccbuilder/tomcat6.rb

@@ -0,0 +1,6 @@
+class TCCBuilder
+  module Tomcat6
+    autoload :VirtualHost, 'tccbuilder/tomcat6/virtual_host'
+    autoload :ServerXML, 'tccbuilder/tomcat6/server_xml'
+  end
+end

data/lib/tccbuilder/tomcat6/server_xml.rb

@@ -0,0 +1,84 @@
+class TCCBuilder
+  module Tomcat6
+    class ServerXML
+      require 'ostruct'
+      require 'rexml/document'
+
+      attr_reader :xml
+      attr_reader :file
+      FORMATTER = REXML::Formatters::Pretty.new
+
+      def initialize(file)
+        raw = File.read(file)
+        @file = file
+        @xml = REXML::Document.new(raw, :raw => :all).root
+      end
+
+      def add_virtual_host(name, service, params)
+        host = VirtualHost.new(name, service)
+    
+        # All implementations of Host support the following attribute: 
+        host.app_base                       = params.app_base if params.respond_to?(:app_base)
+        host.auto_deploy                    = params.auto_deploy if params.respond_to?(:auto_deploy)
+        host.background_processor_delay     = params.background_processor_delay if params.respond_to?(:background_processor_delay)
+        host.class_name                     = params.class_name if params.respond_to?(:class_name)
+        host.deploy_on_startup              = params.deploy_on_startup if params.respond_to?(:deploy_on_startup)
+        # The standard implementation of Host is org.apache.catalina.core.StandardHost. It supports the following additional attributes:
+        host.unpack_wars                    = params.unpack_wars if params.respond_to?(:unpack_wars)
+
+        # All implementations of Context support the following attributes:
+        host.path         = params.path if params.respond_to?(:path)
+        host.doc_base     = params.doc_base if params.respond_to?(:doc_base)
+        host.debug        = params.debug if params.respond_to?(:debug)
+        host.reloadable   = params.reloadable if params.respond_to?(:reloadable)
+
+        if params.aliases
+          params.aliases.each do |al|
+            host.add_alias(al)
+          end
+        end
+      
+        # TODO: Make valves configurable
+        host.add_valve "org.apache.catalina.valves.AccessLogValve", :directory => "logs",
+          :prefix => "#{name}_access_log.",
+          :suffix => ".log",
+          :pattern => "common"
+
+        engine_element = get_engine_element(service)
+        engine_element.add_element(host.to_rexml)
+      end
+
+      def remove_virtual_host(name, service)    
+        @xml.delete_element("Service[@name='#{service}']/Engine/Host[@name='#{name}']")
+      end
+    
+      def update_virtual_host(name, service, params)
+        host = @xml.elements["Server[@name='#{service}']/Engine/Host[@name='#{name}']"]
+      end
+    
+      def virtual_host_exists?(name, service)
+        host = @xml.elements["Service[@name='#{service}']/Engine/Host[@name='#{name}']"]
+        host.nil? ? false : true
+      end
+
+      protected
+    
+      def get_engine_element(service)
+        service_element = get_service_element(service)
+        engine_element = service_element.elements["Engine"]
+        if engine_element.nil?
+          raise ElementNotFound, "Engine element not found for Service: '#{service}'."
+        end
+        return engine_element
+      end
+    
+      def get_service_element(service)
+        service_element = @xml.elements["Service[@name='#{service}']"]
+        if service_element.nil?
+          raise ElementNotFound, "Service element with name '#{service}' was not found."
+        end
+        return service_element
+      end
+    end
+  end
+end

data/lib/tccbuilder/tomcat6/virtual_host.rb

@@ -0,0 +1,111 @@
+class TCCBuilder
+  module Tomcat6
+    class VirtualHost
+      attr_reader :service
+    
+      attr_reader :app_base
+      attr_reader :auto_deploy
+      attr_reader :background_processor_delay
+      attr_reader :class_name
+      attr_reader :deploy_on_startup
+      attr_reader :name
+      attr_reader :unpack_wars
+    
+      attr_reader :path
+      attr_reader :doc_base
+      attr_reader :debug
+      attr_reader :reloadable
+    
+      attr_reader :aliases
+    
+      def initialize(name, service)
+        @host_element = REXML::Element.new("Host")
+        @context_element = nil
+        @service = service
+        self.name = name
+      end
+    
+      def app_base=(value)
+        add_host_attribute("appBase", value)
+      end
+    
+      def auto_deploy=(value)
+        add_host_attribute("autoDeploy", value)
+      end
+    
+      def background_processor_delay=(value)
+        add_host_attribute("backgroundProcessorDelay", value)
+      end
+    
+      def class_name=(value)
+        add_host_attribute("className", value)
+      end
+    
+      def deploy_on_startup=(value)
+        add_host_attribute("deployOnStartup", value)
+      end
+    
+      def name
+        get_host_attribute("name")
+      end
+    
+      def name=(value)
+        add_host_attribute("name", value)
+      end
+    
+      def unpack_wars=(value)
+        add_host_attribute("unpackWars", value)
+      end
+    
+      def path=(value)
+        add_context_attribute("path", value)
+      end
+    
+      def doc_base=(value)
+        add_context_attribute("docBase", value)
+      end
+    
+      def debug=(value)
+        add_context_attribute("debug", value)
+      end
+    
+      def reloadable=(value)
+        add_context_attribute("reloadable", value)
+      end
+    
+      def add_alias(text)
+        al = @host_element.add_element("Alias")
+        al.text = text
+        return al
+      end
+    
+      def add_valve(class_name, options = {})
+        valve = @host_element.add_element("Valve")
+        valve.attributes["className"] = class_name
+        options.each do |key, value|
+          valve.attributes[key.to_s] = value
+        end
+        return valve
+      end
+    
+      def to_rexml
+        @host_element
+      end
+    
+      private
+    
+      def add_host_attribute(name, value)
+        @host_element.attributes[name] = value
+      end
+    
+      def get_host_attribute(name)
+        @host_element.attributes[name]
+      end
+    
+      def add_context_attribute(name, value)
+        @context_element = host.add_element("Context") if @context_element.nil?
+        @context_element.attributes[name] = value
+      end
+    end
+  end
+end

data/tccbuilder.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tccbuilder}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jamie Winsor"]
+  s.date = %q{2010-09-19}
+  s.default_executable = %q{tc6confbldr}
+  s.description = %q{Utilities to assist in configuring Tomcat via Ruby or the command line}
+  s.email = %q{resetexistence@gmail.com}
+  s.executables = ["tc6confbldr"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/tc6confbldr",
+     "lib/tccbuilder.rb",
+     "lib/tccbuilder/cmdlet.rb",
+     "lib/tccbuilder/errors.rb",
+     "lib/tccbuilder/options.rb",
+     "lib/tccbuilder/tomcat6.rb",
+     "lib/tccbuilder/tomcat6/server_xml.rb",
+     "lib/tccbuilder/tomcat6/virtual_host.rb",
+     "tccbuilder.gemspec",
+     "test/helper.rb",
+     "test/test_tccbuilder.rb"
+  ]
+  s.homepage = %q{http://github.com/resetexistence/tccbuilder}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Utilities to assist in configuring Tomcat via Ruby or the command line}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_tccbuilder.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tcchelper'
+
+class Test::Unit::TestCase
+end

data/test/test_tccbuilder.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+class TestTCCBuilder < Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: tccbuilder
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Jamie Winsor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-19 00:00:00 -07:00
+default_executable: tc6confbldr
+dependencies: []
+
+description: Utilities to assist in configuring Tomcat via Ruby or the command line
+email: resetexistence@gmail.com
+executables: 
+- tc6confbldr
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/tc6confbldr
+- lib/tccbuilder.rb
+- lib/tccbuilder/cmdlet.rb
+- lib/tccbuilder/errors.rb
+- lib/tccbuilder/options.rb
+- lib/tccbuilder/tomcat6.rb
+- lib/tccbuilder/tomcat6/server_xml.rb
+- lib/tccbuilder/tomcat6/virtual_host.rb
+- tccbuilder.gemspec
+- test/helper.rb
+- test/test_tccbuilder.rb
+has_rdoc: true
+homepage: http://github.com/resetexistence/tccbuilder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Utilities to assist in configuring Tomcat via Ruby or the command line
+test_files: 
+- test/helper.rb
+- test/test_tccbuilder.rb