keithsalisbury-subtrac 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 =
+
+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,7 @@
+= the-perfect-gem
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 =. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "subtrac"
+    gem.summary = %Q{TODO}
+    gem.email = "keithsalisbury@gmail.com"
+    gem.homepage = "http://github.com/keithsalisbury/subtrac"
+    gem.authors = ["="]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "subtrac #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 1

data/bin/subtrac

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander'
+require 'subtrac'
+
+program :name, 'subtrac'
+program :version, Subtrac::VERSION
+program :description, 'subtrac will install and manage a collection of subversion respositories and associated trac sites'
+ 
+command :install do |c|
+  c.syntax = 'subtrac install [options]'
+  c.summary = ''
+  c.description = 'Installation of default files required to host multipe development projects.'
+  c.example 'description', 'installs the default trac and svn setup'
+  c.option '-c','--clean', 'Performs a clean install'
+  c.when_called Subtrac::Commands::Install
+end
+
+command :create do |c|
+  c.syntax = 'subtrac create [options]'
+  c.summary = ''
+  c.description = ''
+  c.example 'description', 'creates a new project'
+  c.option '-p','--project PROJECT', 'Name of project to create'
+  c.option '-c','--client CLIENT', 'Name of client to create the project for'
+  c.when_called Subtrac::Commands::Create
+end
+
+=begin
+command :delete do |c|
+  c.syntax = 'subtrac delete [options]'
+  c.summary = ''
+  c.description = ''
+  c.example 'description', 'deletes an existing project'
+  c.option '--project', 'Name of project to delete'
+  c.option '--client', 'Name of client the project was for'
+  c.when_called Devserver::Commands::Create
+end
+=end

data/lib/subtrac.rb

@@ -0,0 +1,245 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2009, Keith Salisbury (www.globalkeith.com)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 
+# Neither the name of the original author nor the names of contributors
+# may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# You may need these...
+#
+# sudo apt-get install ruby rubygems
+# sudo gem sources -a http://gems.github.com
+# sudo gem install visionmedia-commander 
+# sudo gem install yaml erb fileutils
+#
+
+require 'yaml'
+require 'erb'
+require 'fileutils'
+require 'subtrac/version'
+
+module Subtrac
+  DEV_ENV = 'test' # should be a system environment var
+  module Commands
+    class Install
+      def initialize(args, options)
+        Subtrac.load_config()
+        Subtrac.install(args,options)
+      end
+    end
+    class Create
+      def initialize(args, options)
+        project = ask("What is the name of the project you would like to create?") if !options.project
+        client = ask("Which client is this project for?") if !options.client
+        Subtrac.load_config()
+        Subtrac.create_project(options.project,options.client)
+      end
+    end
+  end
+
+  # Install
+  def self.install(args,options)
+    # Ask if the user agrees (yes or no)
+    confirm = agree("Are you sure?") if options.clean
+    if confirm
+      # clear previous data
+      clean()
+      create_environment_directories()
+    else
+      puts "\nAttempt install without overwrites"
+    end
+    install_common_files()
+    create_virtual_host()
+    # create default project and client
+    #create_client(@APP_CONFIG[:default_client])
+    create_project(@APP_CONFIG[:default_project],@APP_CONFIG[:default_client])
+  end
+
+  private
+  
+  # Loads the configuration YML file
+  def self.load_config
+    puts "\n==== Loading configuration file ===="
+    # load configuration file
+    begin
+      file_path = File.join(File.dirname(__FILE__), "subtrac/config/config.yml")
+      yamlFile = YAML.load_file(file_path)
+    rescue Exception => e
+      raise StandardError, "Config #{file_path} could not be loaded."
+    end
+    if yamlFile
+      if yamlFile[DEV_ENV]
+        @APP_CONFIG = yamlFile[DEV_ENV]
+      else
+        raise StandardError, "config/config.yml exists, but doesn't have a configuration for DEV_ENV=#{DEV_ENV}."
+      end
+    else
+      raise StandardError, "config/config.yml does not exist."
+    end
+  end
+
+  # creates a directory if it does not exist
+  def self.create_if_missing *names 
+    puts "\n==== Creating directory #{names} ===="
+    names.each do |name| FileUtils.mkdir_p(name) unless File.directory?(name) end 
+  end
+
+  # publishes an erb template
+  def self.parse_template(infile,outfile,binding)
+    file = File.open(outfile, 'w+')
+    if file
+      template = ERB.new(IO.read(infile))
+      if template
+        file.syswrite(template.result(binding))
+      else
+        raise "Could not read template. file #{infile}"
+      end
+    else
+      raise "Unable to open file for writing. file #{outfile}"
+    end
+  end
+
+  # creates a new virtual host and reloads apache and enables the new virtual host
+  def self.create_virtual_host
+    puts "\n==== Creating new virtual host ===="
+    vhost_template = File.join(File.dirname(__FILE__), @APP_CONFIG[:templates][:virtual_host])
+    new_vhost = "#{@APP_CONFIG[:dirs][:conf]}/#{@APP_CONFIG[:server][:hostname]}"
+    puts new_vhost
+    parse_template(vhost_template,new_vhost,binding)
+    # reload apache configuration
+    `/etc/init.d/apache2 force-reload` if DEV_ENV != 'test'
+    `a2ensite #{@APP_CONFIG[:server][:hostname]}` if DEV_ENV != 'test'
+  end
+  
+  def self.install_common_files
+    puts "\n==== Installing common files ===="
+    # TODO: implement a mash for .svn folders
+    # TODO: refactor /common to the app config
+    common_dir = File.join(File.dirname(__FILE__), "subtrac/common")
+    puts common_dir
+    source = Dir.glob("#{common_dir}/.")
+    puts source
+    dest = @APP_CONFIG[:dirs][:document]
+    FileUtils.cp_r(source,dest)
+  end
+
+  def self.create_environment_directories
+    puts "\n==== Creating new environment directories ===="
+    # create the environment directories
+    @APP_CONFIG[:dirs].each do |key, value|
+      create_if_missing value
+    end
+  end  
+
+  def self.clean
+    puts "\n==== Remove old data if exists ===="
+    @APP_CONFIG[:dirs].each do |key, value|
+      unless [@APP_CONFIG[:dirs][:install]].include? value
+        #TODO: Ask for confirmation - yes,no,All
+        puts "Deleting #{value}"
+        FileUtils.rm_rf value
+      end
+    end
+  end
+  
+  def self.create_client(name)
+    puts "\n==== Create a new client #{name} ===="
+    client_name = name.downcase
+    # create apache configuration
+    # create apache template
+    location_template = File.join(File.dirname(__FILE__), @APP_CONFIG[:templates][:location])
+    location_conf = "#{@APP_CONFIG[:dirs][:conf_locations]}/#{client_name}.conf"
+    parse_template(location_template,location_conf,binding)
+    `/etc/init.d/apache2 force-reload` if DEV_ENV != 'test'
+    
+    # create svn+trac directory
+    create_if_missing "#{@APP_CONFIG[:dirs][:svn]}/#{client_name}"
+    create_if_missing "#{@APP_CONFIG[:dirs][:trac]}/#{client_name}"
+  end
+  
+  def self.create_project(project, client)
+    puts "\n==== Create a new project #{project} for #{client} ===="
+    
+    client_name = client.downcase
+    project_name = project.downcase
+    
+    # create client directory if needed
+    create_client(client_name) if (!File.directory? "#{@APP_CONFIG[:dirs][:svn]}/#{client_name}")
+    
+    svn_dir = "#{@APP_CONFIG[:dirs][:svn]}/#{client_name}/#{project_name}"
+    trac_dir = "#{@APP_CONFIG[:dirs][:trac]}/#{client_name}/#{project_name}"
+    if (File.directory? svn_dir) then
+      raise StandardError, "A project called #{project} already exists in the #{client} repository. Would you like to replace it?"
+    end
+    
+    project_template = File.join(File.dirname(__FILE__), "#{@APP_CONFIG[:templates][:projects]}/#{@APP_CONFIG[:default_project_template]}")
+    
+    # copy template svn project to a temp folder, then svn import it into the repo
+    svn_template_dir = "#{project_template}/svn"
+    temp_dir = "#{@APP_CONFIG[:dirs][:temp]}/#{project_name}"
+    FileUtils.cp_r(svn_template_dir,temp_dir)
+    
+    # create a new subversion repository
+    `svnadmin create #{svn_dir}` if DEV_ENV != 'test'
+    
+    # import into svn and delete the temporary directory
+    `svn import #{temp_dir} file:///#{svn_dir} --message "initial import"` if DEV_ENV != 'test'
+    FileUtils.rm_r(temp_dir, :force => true)
+    
+    # create a new trac site
+    `trac-admin #{trac_dir} initenv #{project_name} sqlite:#{trac_dir}/db/trac.db svn #{svn_dir}` if DEV_ENV != 'test'
+    FileUtils.chown_R('www-data', 'www-data', trac_dir, :verbose => true)  if DEV_ENV != 'test'
+    FileUtils.mkdir_p("#{trac_dir}/conf") if DEV_ENV == 'test' # fake the folder for tests
+    
+    # install shared trac.ini
+    trac_ini_template = File.join(File.dirname(__FILE__), @APP_CONFIG[:templates][:trac])
+    parse_template(trac_ini_template,"#{trac_dir}/conf/trac.ini",binding)
+    
+    # remove custom templates directory so trac uses the shared location (while we wait for trac patch)
+    FileUtils.rm_rf("#{trac_dir}/templates")
+
+    puts "Setting up default trac permission..."
+    # set up trac permissions
+    @APP_CONFIG[:trac][:permissions].each do |key, value|
+      `trac-admin #{trac_dir} permission add #{key} #{value}` if DEV_ENV != 'test'
+    end
+
+    puts "Adding default trac wiki pages..."
+    # this needs to loop through the directory and import all pages
+    Dir.foreach("#{project_template}/trac/wiki/.") do |file|
+      # do something with the file here
+      unless ['.', '..','.svn'].include? file
+        temp_file = "#{@APP_CONFIG[:dirs][:temp]}/#{file}"
+        parse_template("#{project_template}/trac/wiki/#{file}", temp_file, binding)
+        `trac-admin #{trac_dir} wiki import #{file} #{temp_file}` if DEV_ENV != 'test'
+        FileUtils.rm(temp_file)
+      end
+    end
+  end
+  
+end
+
+
+

data/lib/subtrac/common/clients/index.wsgi

@@ -0,0 +1,89 @@
+#!/usr/bin/env python
+"""
+A simple WSGI test application.
+
+Its main purpose is to show that WSGI support works (meaning that the
+web server and the WSGI adaptor / support module are configured correctly).
+
+As a nice plus, it outputs some interesting system / WSGI values as a nice
+HTML table.
+
+The main use of this script will be using the WSGI "application" defined
+below within your production WSGI environment. You will use some code similar
+to what you see at the end of this script to use the application from that
+environment. For the special case of apache2/mod_wsgi, it shoud be possible
+to directly use this file.
+
+If you start this script from the commandline either with python2.5 or with
+and older python + wsgiref module installed, it will serve the content on
+http://localhost:8000/ - this is mainly for debugging THIS script.
+
+@copyright: 2008 by MoinMoin:ThomasWaldmann
+@license: Python License, see LICENSE.Python for details.
+"""
+import os.path
+import os
+import sys
+
+try:
+    __file__
+except NameError:
+    __file__ = '?'
+
+html_template = """\
+<html>
+<head>
+ <title>WSGI Test Script</title>
+</head>
+<body>
+ <h1>WSGI test script is working!</h1>
+ <table border=1>
+  <tr><th colspan=2>1. System Information</th></tr>
+  <tr><td>Python</td><td>%(python_version)s</td></tr>
+  <tr><td>Python Path</td><td>%(python_path)s</td></tr>
+  <tr><td>Platform</td><td>%(platform)s</td></tr>
+  <tr><td>Absolute path of this script</td><td>%(abs_path)s</td></tr>
+  <tr><td>Filename</td><td>%(filename)s</td></tr>
+  <tr><th colspan=2>2. WSGI Environment</th></tr>
+%(wsgi_env)s
+ </table>
+</body>
+</html>
+"""
+
+row_template = "  <tr><td>%s</td><td>%r</td></tr>"
+
+
+def application(environ, start_response):
+    """ The WSGI test application """
+    # emit status / headers
+    status = "200 OK"
+    headers = [('Content-Type', 'text/html'), ]
+    start_response(status, headers)
+
+    # assemble and return content
+    content = html_template % {
+        'python_version': sys.version,
+        'platform': sys.platform,
+        'abs_path': os.path.abspath('.'),
+        'filename': __file__,
+        'python_path': repr(sys.path),
+        'wsgi_env': '\n'.join([row_template % item for item in environ.items()]),
+    }
+    return [content]
+
+
+if __name__ == '__main__':
+    # this runs when script is started directly from commandline
+    try:
+        # create a simple WSGI server and run the application
+        from wsgiref import simple_server
+        print "Running test application - point your browser at http://localhost:8000/ ..."
+        httpd = simple_server.WSGIServer(('', 8000), simple_server.WSGIRequestHandler)
+        httpd.set_app(application)
+        httpd.serve_forever()
+    except ImportError:
+        # wsgiref not installed, just output html to stdout
+        for content in application({}, lambda status, headers: None):
+            print content
+