cheese 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2007 Jamie van Dyke
+
+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/Manifest.txt

@@ -0,0 +1,30 @@
+CHANGELOG.txt
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+setup.rb
+TODO.txt
+
+bin/cheese
+
+data/templates/footer.inc
+data/templates/header.inc
+data/templates/mongrel.inc
+data/templates/proxy.inc
+data/templates/vhost.inc
+
+lib/cheese-setup.rb
+lib/controller.rb
+lib/process.rb
+lib/verbose.rb
+lib/cheese/version.rb
+lib/database/mysql.rb
+lib/database/postgresql.rb
+lib/scm/subversion.rb
+lib/web/domain.rb
+lib/web/mongrel.rb
+lib/web/nginx.rb
+lib/web/proxy.rb
+lib/web/virtual_host.rb

data/README.txt

@@ -0,0 +1,132 @@
+== Cheese
+  
+Cheese is a set of ruby scripts supplied with all Candid Mush 
+Virtual Cheesey Servers but available to all under the MIT license.  
+They reduce the steps needed to administrate a web server.
+
+Currently this script is executed server side, but we're looking 
+into using Capistrano to manage it instead.
+
+Cheese Tools can:
+  
+    * Add nginx virtual hosts
+    * Replace nginx virtual hosts
+    * Remove nginx virtual hosts
+    * Create subversion repositories
+    * Remove subversion repositories
+    * Set access rights on subversion repositories
+    * Create mysql/pgsql databases
+    * Delete mysql/pgsql databases
+
+Cheese Tools will be able to:
+
+    * Configure monit to watch your sites and svnserve
+    * Configure a scheduled backup of your sites and source to s3
+
+
+== Requirements
+
+Gems:
+    * Rubygems
+    * OptionParser
+    * Highline
+
+Nginx Config
+  If you are using this on an existing nginx.conf file, you must wrap your vhosts like so:
+  
+#### VHOST something.com BEGIN ####
+server {
+  ...
+}
+#### VHOST something.com END ####
+
+#### PROXY something.com BEGIN ####
+upstream something_com_mongrel {
+  ...
+}
+#### PROXY something.com END ####
+
+and the proxies that each use like so:
+
+
+This is temporary until I improve my regex skills somewhat, or someone
+changes it for me.
+
+== Setup
+
+Before you can use Cheese you need to run cheese --setup, you will be 
+notified of this if you forget, however, this can be re-run if you 
+wish to change any options you have previously set.
+
+The Cheese setup utility:
+    
+		* Asks what type of setup you have (out of the supported sets)
+    * Saves a default source code management username and password
+    
+
+
+== Switches
+
+  -L or --list-vhosts
+      List the vhosts contained in the /etc/nginx/nginx.conf file
+
+	--setup
+			Run the setup utility which saves preferences to /etc/cheese/cheese.conf
+
+  --domain domain-name.com
+      Set the domain name to use
+  --mongrel-threads
+      Let Cheese Tools know how many threads you want to run
+  
+  --remove
+      Remove this vhost and the subversion repository
+  
+  --svn-read-all
+      Set svnserve to allow anonymous read on the subversion repository
+  
+  --pgsql
+      Use PostgreSQL instead of MySQL which is the default
+  
+  --skip-nginx
+      Don't add a vhost or restart nginx
+  --skip-svn
+      Don't create a subversion repository or attempt to add files to one
+  --skip-mongrel-config
+      Don't create a mongrel_cluster.yml config file
+  --skip-database
+      Don't create the database
+  --only-nginx
+      Only add/replace a vhost and restart nginx
+  --only-svn
+      Only create a subversion repository and standard file structure
+  --only-mongrel-config
+      Only create a mongrel_cluster.yml config file
+  --only-database
+      Only create the database
+    
+== Usage
+
+To create a new web application with a subversion repository which stores 
+the source  and a mongrel_cluster config:
+
+    ./cheese --domain candidmush.com --mongrel-threads 2
+
+The steps cheese will take are:
+
+    * Add a vhost to /etc/nginx/nginx.conf
+    * Add a mongrel proxy declaration to /etc/nginx/nginx.conf
+    * Create a subversion repository in /var/src/candidmush.com
+        * The standard structure of branches/tags/trunk will be added
+    * Add a Cap config file to trunk/config/deploy.rb
+    * Add a mongrel_cluster config to trunk/config/mongrel_cluster.yml
+    * Start mongrel_cluster for this server
+    * Restart nginx
+    
+
+== Details
+
+The port range to use for mongrel_cluster will be determined by finding 
+the highest port range used by other vhosts and incrementing it by 10.
+
+If the vhost in nginx for the domain you are adding already exists, 
+Cheese Tools will replace it rather than add another.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'cheese', 'version')
+
+AUTHOR = "Jamie van Dyke"
+EMAIL = "jamie@writtenpath.com"
+DESCRIPTION = "Automate the creation of web applications and accompanying pieces e.g. Nginx, Subversion, Mongrel, Monit, S3."
+GEM_NAME = "cheese"
+RUBYFORGE_PROJECT = "cheese"
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+
+
+NAME = "cheese"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (Cheese::VERSION::STRING + (REV ? ".#{REV}" : ""))
+                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "cheese documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  p.extra_deps = ['highline', ">= 1.2.0"]
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+end

data/TODO.txt

@@ -0,0 +1,11 @@
+Things to implement in order of priority:
+
+* TESTS TESTS TESTS!
+* Monit services
+* S3 backup
+* Allow mongrel to use a set port
+* Remove the parsing of the entire nginx file and use includes
+
+Things to look into:
+
+* Using Capistrano to manage this remotely

data/bin/cheese

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+#
+
+require 'rubygems'
+require 'optparse'
+require 'fileutils'
+
+class Arguments < Hash
+  def initialize(args)
+    super
+  
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #$0 [options]"
+      
+      self[:setup]            = false
+      self[:actions]          = [:scm, :web_server, :app_server, :database]
+      self[:thread_count]     = 1
+      self[:database_type]    = :postgresql
+      self[:remove]           = false
+      self[:svn_anon_read]    = false
+      self[:verbose]          = false
+      self[:dry_run]          = false
+      
+      opts.on('-n STRING', '--name STRING', String, '[REQUIRED] set the name to use') do |name|
+        self[:name] = name
+      end
+
+      opts.on('--setup', 'setup your preferences') do
+        self[:setup] = true
+      end
+      
+      opts.on('--remove', 'remove instead of create') do
+        self[:remove] = true
+      end
+      
+      opts.on('-t NUMBER', '--threads NUMBER', Integer, 
+                '[DEFAULT=1] how many app server threads to listen on') do |thread_count|
+        self[:thread_count] = thread_count
+      end
+      
+      opts.on('--scm-anon-read', 'set the scm to allow anonymous read on the source repository') do |anon|
+        self[:scm_anon_read] = anon
+      end
+      
+      opts.on('-D', '--database-type STRING', [:mysql, :postgresql], 
+                'pass in the database type, currently { mysql || postgresql (default) }') do |dtype|
+        self[:database_type] = dtype
+      end
+      
+      opts.on('--only-web-server', 'only add/replace a vhost and restart the web server (e.g. nginx)') do
+        self[:actions] = [:web_server]
+      end
+      
+      opts.on('--only-scm', 'only create a scm repository and standard file structure') do
+        self[:actions] = [:scm]
+      end
+      
+      opts.on('--only-app-config', 'only create an app server config file') do
+        self[:actions] = [:app_server]
+      end
+      
+      opts.on('--only-database', 'only create the database') do
+        self[:actions] = [:database]
+      end
+      
+      opts.on('--skip-web-server', 'skip adding/replacing a vhost and restarting the web server (e.g. nginx)') do
+        self[:actions] -= [:web_server]
+      end
+      
+      opts.on('--skip-scm', 
+          'skip creating a source repository and standard file structure') do
+        self[:actions] -= [:scm]
+      end
+            
+      opts.on('--skip-app-config', 'skip creating an app server config file') do
+        self[:actions] -= [:app_server]
+      end
+      
+      opts.on('--skip-database', 'skip creating the database') do
+        self[:actions] -= [:database]
+      end
+      
+      opts.on('-L', '--list-vhosts', 'list the vhosts contained in our web server') do
+        self[:actions] = [:list_vhosts]
+      end
+      
+      opts.on_tail('-v', '--verbose', 'be verbose about what action is being taken') do
+        self[:verbose] = true
+      end
+      
+      opts.on_tail('--dry-run', 'fake all of the actions') do
+        self[:dry_run] = true
+      end
+      
+      opts.on_tail('-h', '--help', 'display this help and exit') do
+        puts opts
+        exit
+      end
+    end
+    
+    opts.parse!(args)
+    if self[:name].empty? and !self[:list_vhosts]
+      puts "You must specify a name with the --name switch e.g. your-domain.com"
+      exit
+    end
+  end
+end
+
+# Default arguments to help if no arguments given
+argv = ARGV.empty? ? ["-h"] : ARGV
+options = Arguments.new(argv)
+
+if options[:setup]
+  require 'cheese-setup'
+else
+  require 'controller'
+  controller = Cheese::Controller.new(options)
+end

data/data/templates/footer.inc

@@ -0,0 +1 @@
+}

data/data/templates/header.inc

@@ -0,0 +1,46 @@
+user www-data;
+worker_processes  3;
+
+error_log  /var/log/nginx/error.log;
+pid        /var/run/nginx.pid;
+
+events {
+    worker_connections  1024;
+}
+
+
+# start the http module where we config http access.
+http {
+  # pull in mime-types. You can break out your config 
+  # into as many include's as you want to make it cleaner
+  include /etc/nginx/mime.types;
+  
+  # set a default type for the rare situation that
+  # nothing matches from the mimie-type include
+  default_type  application/octet-stream;
+
+  # configure log format
+  log_format main '$remote_addr - $remote_user [$time_local] $status '
+                  '"$request" $body_bytes_sent "$http_referer" '
+                  '"$http_user_agent" "$http_x_forwarded_for"';
+
+  # main access log
+  access_log  /var/log/nginx_access.log  main;
+
+  # main error log
+  error_log  /var/log/nginx_error.log debug;
+
+  sendfile on;
+
+  # increase the url length limit
+  server_names_hash_bucket_size  128;
+
+  # These are good default values.
+  tcp_nopush        on;
+  tcp_nodelay       off;
+  # output compression saves bandwidth 
+  gzip            on;
+  gzip_http_version 1.0;
+  gzip_comp_level 2;
+  gzip_proxied any;
+  gzip_types      text/plain text/html text/css application/x-javascript text/xml application/xml application/xml+rss text/javascript;

data/data/templates/mongrel.inc

@@ -0,0 +1,7 @@
+--- 
+log_file: /var/www/||DOMAIN||/shared/log/production.log
+port: "||PORT||"
+environment: production
+address: 127.0.0.1
+pid_file: /var/www/||DOMAIN||/shared/tmp/pids/mongrel.pid
+servers: ||THREADS||

data/data/templates/proxy.inc

@@ -0,0 +1,3 @@
+upstream ||DOMAIN||_mongrel {
+||THREADS||
+}

data/data/templates/vhost.inc

@@ -0,0 +1,84 @@
+server {
+  # port to listen on. Can also be set to an IP:PORT
+  listen 80;
+
+  # Set the max size for file uploads to 50Mb
+  client_max_body_size 50M;
+
+  # sets the domain[s] that this vhost server requests for
+  server_name ||DOMAIN|| www.||DOMAIN||;
+
+  # redirect blank to www
+  if ($host != 'www.||DOMAIN||' ) {
+    rewrite  ^/(.*)$  http://www.||DOMAIN||/$1  permanent;
+  }
+
+  # doc root
+  root /var/www/||DOMAIN||/current/public;
+
+  # vhost specific access log
+  access_log  /var/log/nginx_||DOMAIN||.access.log  main;
+  
+
+  # this rewrites all the requests to the maintenance.html
+  # page if it exists in the doc root. This is for capistrano's
+  # disable web task
+  if (-f $document_root/system/maintenance.html) {
+    rewrite  ^(.*)$  /system/maintenance.html last;
+    break;
+  }
+
+  location ~* ^.+\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|doc|xls|exe|pdf|ppt|txt|tar|mid|midi|wav|bmp|rtf|js|mov).*?$ {
+    root /var/www/||SHORT_DOMAIN||/current/public;
+    if (!-f $request_filename) {
+      proxy_pass  http://||PROXY||_mongrel;
+      break;
+    }
+  }
+
+  location / {
+    # needed to forward user's IP address to rails
+    proxy_set_header  X-Real-IP  $remote_addr;
+
+    # needed for HTTPS
+    proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_redirect false;
+    proxy_max_temp_file_size 0;
+
+    # If the file exists as a static file serve it directly without
+    # running all the other rewite tests on it
+    if (-f $request_filename) { 
+      break; 
+    }
+
+    # check for index.html for directory index
+    # if its there on the filesystem then rewite 
+    # the url to add /index.html to the end of it
+    # and then break to send it to the next config rules.
+    if (-f $request_filename/index.html) {
+      rewrite (.*) $1/index.html break;
+    }
+
+    # this is the meat of the rails page caching config
+    # it adds .html to the end of the url and then checks
+    # the filesystem for that file. If it exists, then we
+    # rewite the url to have explicit .html on the end 
+    # and then send it on its way to the next config rule.
+    # if there is no file on the fs then it sets all the 
+    # necessary headers and proxies to our upstream mongrels
+    if (-f $request_filename.html) {
+      rewrite (.*) $1.html break;
+    }
+
+    if (!-f $request_filename) {
+      proxy_pass http://||PROXY||_mongrel;
+      break;
+    }
+  }
+
+  error_page   500 502 503 504  /500.html;
+  location = /500.html {
+    root /var/www/||DOMAIN||/current/public;
+  }
+}