bantic-integrity 0.1.4

data/README.markdown

@@ -0,0 +1,153 @@
+Integrity
+=========
+
+Integrity is your friendly automated Continuous Integration server.
+
+It's fully usable from within its web interface (backed by [Sinatra][]),
+allowing you to add a project, set preferences for it (where's the code
+repository, is it completely private or public, etc), and run the build command
+from there.
+
+It has been designed with ruby projects in mind, but any project that can be
+tested in an unix-y fashion (with a command line tool that returns 0 on success
+and non-zero on failure) works with it.
+
+Getting Started
+===============
+
+Install the `integrity` gem from GitHub:
+
+    gem sources --add http://gems.github.com
+    sudo gem install foca-integrity
+
+In order to setup Integrity, run the following command:
+
+    integrity install /path/to/my/app
+
+Then browse to /path/to/my/app and edit the config files at your convenience.
+The default configuration should be "good enough" in most cases, so you should
+be pretty much ready to rock.
+
+For deployment, we recommend [Thin][]. Provided with Integrity comes a thin.yml
+file, so all you need to do after running `integrity install` should be
+
+    thin -C /path/to/my/app/thin.yml -R /path/to/my/app/config.ru start
+
+And you should be up and running.
+
+If you want automatic commit processing, you currently need to be using
+[GitHub][]. Click the edit link on your GitHub project, and add an integrity
+link that looks like the following to the `Post-Receive URL` field:
+
+    http://integrity.domain.tld/projectname/push
+
+Receiving Notifications
+=======================
+
+If you want to be notified after each build, you need to install our notifiers.
+For example, in order to receive an email after each build, install:
+
+    sudo gem install foca-integrity-email
+
+And then edit `/path/to/my/app/config.ru` and add:
+
+    require "notifier/email"
+
+After all the `require` lines.
+
+Available notifiers
+-------------------
+
+* [Mail](http://github.com/foca/integrity-email)
+* [Jabber](http://github.com/ph/integrity-jabber)
+* [Campfire](http://github.com/defunkt/integrity-campfire)
+
+Resources
+========
+
+We have a [Lighthouse account][lighthouse] where you can submit patches or
+feature requests. Also, someone is usually around [#integrity][irc-channel] on
+Freenode, so don't hesitate to stop by for ideas, help, patches or something.
+
+Future plans
+============
+
+* [Twitter][]/[IRC][]/etc bots
+* A sample generic post-receive-hook so you can run this from any git repo
+* Better integration with GitHub
+
+Development
+===========
+
+The code is stored in [GitHub][repo]. Feel free to fork, play with it, and send
+a pull request afterwards. 
+
+In order to run the test suite you'll need a few more gems: [rspec][], [rcov][]
+and [hpricot][]. With that installed running `rake` will run the specs and
+ensure the code coverage stays high.
+
+Thanks
+======
+
+Thanks to the fellowing people for their feedbacks, ideas and patches :
+
+* [James Adam][james]
+* [Elliott Cable][ec]
+* [Corey Donohoe][atmos]
+* [Kyle Hargraves][kyle]
+* [Pier-Hugues Pellerin][ph]
+* [Simon Rozet][sr]
+* [Scott Taylor][scott]
+
+[james]: http://github.com/lazyatom
+[ec]: http://github.com/elliotcabble
+[atmos]: http://github.com/atmos
+[kyle]: http://github.com/pd
+[ph]: http://github.com/ph
+[sr]: http://purl.org/net/sr/
+[scott]: http://github.com/smtlaissezfaire
+
+License
+=======
+
+(The MIT License)
+
+Copyright (c) 2008 [Nicolás Sanguinetti][foca], [entp][]
+
+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.
+
+[Sinatra]: http://sinatrarb.com
+[git]: http://git.or.cz
+[svn]: http://subversion.tigris.org
+[Twitter]: http://twitter.com
+[IRC]: http://wikipedia.org/wiki/IRC
+[entp]: http://entp.com
+[GitHub]: http://github.com
+[Thin]: http://code.macournoyer.com/thin/
+
+[rspec]: http://rspec.info
+[rcov]: http://eigenclass.org/hiki.rb?rcov
+[hpricot]: http://code.whytheluckystiff.net/hpricot
+
+[repo]: http://github.com/foca/integrity
+[lighthouse]: http://integrity.lighthouseapp.com/projects/14308-integrity
+[irc-channel]: irc://irc.freenode.net/integrity
+
+[foca]: http://nicolassanguinetti.info/

data/Rakefile

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + "/lib/integrity"
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+
+task :default => ["spec:coverage", "spec:coverage:verify"]
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ["--color", "--format", "progress"]
+  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+  t.libs = ['lib']
+  t.rcov = false
+end
+
+namespace :spec do
+  Spec::Rake::SpecTask.new(:coverage) do |t|
+    t.spec_opts = ["--color", "--format", "progress"]
+    t.spec_files = Dir['spec/**/*_spec.rb'].sort
+    t.libs = ['lib']
+    t.rcov = true
+    t.rcov_opts = ['--exclude-only', '".*"', '--include-file', '^lib']
+  end
+
+  namespace :coverage do
+    RCov::VerifyTask.new(:verify) do |t|
+      t.threshold = 100
+      t.index_html = "coverage" / 'index.html'
+    end
+  end
+end
+
+namespace :db do
+  desc "Setup connection."
+  task :connect do
+    config = File.expand_path(ENV['CONFIG']) if ENV['CONFIG']
+    config = Integrity.root / 'config.yml' if File.exists?(Integrity.root / 'config.yml')
+    Integrity.new(config)
+  end
+
+  desc "Automigrate the database"
+  task :migrate => :connect do
+    require "project"
+    require "build"
+    require "notifier"
+    DataMapper.auto_migrate!
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    files  = `git ls-files`.split("\n").reject {|f| f =~ %r(^spec) || f =~ %r(^vendor/rspec) || f =~ /^\.git/ } 
+    files += %w(spec/spec_helper.rb spec/form_field_matchers.rb)
+
+    s.name                 = 'integrity'
+    s.summary              = 'The easy and fun Continuous Integration server'
+    s.description          = 'Your Friendly Continuous Integration server. Easy, fun and painless!'
+    s.homepage             = 'http://integrityapp.com'
+    s.rubyforge_project    = 'integrity'
+    s.email                = 'contacto@nicolassanguinetti.info'
+    s.authors              = ['Nicolás Sanguinetti', 'Simon Rozet']
+    s.files                = files
+    s.executables          = ['integrity']
+    s.post_install_message = 'Run `integrity help` for information on how to setup Integrity.'
+
+    s.add_dependency 'sinatra', ['>= 0.3.2']
+    s.add_dependency 'haml' # ah, you evil monkey you
+    s.add_dependency 'dm-core', ['>= 0.9.5']
+    s.add_dependency 'dm-validations', ['>= 0.9.5']
+    s.add_dependency 'dm-types', ['>= 0.9.5']
+    s.add_dependency 'dm-timestamps', ['>= 0.9.5']
+    s.add_dependency 'dm-aggregates', ['>= 0.9.5']
+    s.add_dependency 'data_objects', ['>= 0.9.5']
+    s.add_dependency 'do_sqlite3', ['>= 0.9.5']        
+    s.add_dependency 'json'
+    s.add_dependency 'foca-sinatra-diddies', ['>= 0.0.2']
+    s.add_dependency 'rspec_hpricot_matchers'
+    s.add_dependency 'thor'
+    s.add_dependency 'bcrypt-ruby'
+  end
+rescue LoadError
+end
+

data/VERSION.yml

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

data/app.rb

@@ -0,0 +1,278 @@
+require File.dirname(__FILE__) + '/lib/integrity'
+require 'sinatra'
+require 'diddies'
+require 'hacks'
+
+set :root,   Integrity.root
+set :public, Integrity.root / "public"
+set :views,  Integrity.root / "views"
+
+enable :sessions
+
+include Integrity
+
+configure :development do
+  config = Integrity.root / "config" / "config.yml"
+  Integrity.config = config if File.exists? config
+end
+
+configure do
+  Integrity.new
+end
+
+not_found do
+  status 404
+  show :not_found, :title => "lost, are we?"
+end
+
+error do
+  @error = request.env['sinatra.error']
+  status 500
+  show :error, :title => "something has gone terribly wrong"
+end
+
+before do
+  # The browser only sends http auth data for requests that are explicitly
+  # required to do so. This way we get the real values of +#logged_in?+ and
+  # +#current_user+
+  login_required if session[:user]
+end
+
+get "/" do
+  @projects = Project.all(authorized? ? {} : { :public => true })
+  show :home, :title => "projects"
+end
+
+get "/login" do
+  login_required
+  session[:user] = current_user
+  redirect "/"
+end
+
+get "/new" do
+  login_required
+
+  @project = Project.new
+  show :new, :title => ["projects", "new project"]
+end
+
+post "/" do
+  login_required
+  
+  @project = Project.new(params[:project_data])
+  if @project.save
+    @project.enable_notifiers(params["enabled_notifiers[]"], params["notifiers"])
+    redirect project_url(@project)
+  else
+    show :new, :title => ["projects", "new project"]
+  end
+end
+
+get "/:project" do
+  login_required unless current_project.public?
+  show :project, :title => ["projects", current_project.permalink]
+end
+
+put "/:project" do
+  login_required
+  
+  if current_project.update_attributes(params[:project_data])
+    current_project.enable_notifiers(params["enabled_notifiers[]"], params["notifiers"])
+    redirect project_url(current_project)
+  else
+    show :new, :title => ["projects", current_project.permalink, "edit"]
+  end
+end
+
+delete "/:project" do
+  login_required
+
+  current_project.destroy
+  redirect "/"
+end
+
+get "/:project/edit" do
+  login_required
+
+  show :new, :title => ["projects", current_project.permalink, "edit"]
+end
+
+post "/:project/push" do
+  login_required
+  
+  content_type 'text/plain'
+
+  begin
+    payload = JSON.parse(params[:payload] || "")
+
+    if Integrity.config[:build_all_commits]
+      payload['commits'].sort_by { |commit| Time.parse(commit['timestamp']) }.each do |commit|
+        current_project.build(commit['id']) if payload['ref'] =~ /#{current_project.branch}/
+      end
+    else
+      current_project.build(payload['after']) if payload['ref'] =~ /#{current_project.branch}/
+    end
+
+    'Thanks, build started.'
+  rescue JSON::ParserError => exception
+    invalid_payload!(exception.to_s)
+  end
+end
+
+post "/:project/builds" do
+  login_required
+
+  current_project.build
+  redirect project_url(@project)
+end
+
+get '/:project/builds/:build' do
+  login_required unless current_project.public?
+  show :build, :title => ["projects", current_project.permalink, current_build.short_commit_identifier]
+end
+
+get "/integrity.css" do
+  header "Content-Type" => "text/css; charset=utf-8"
+  sass :integrity
+end
+
+helpers do
+  include Rack::Utils
+  include Sinatra::Authorization
+  alias_method :h, :escape_html
+
+  def authorization_realm
+    "Integrity"
+  end
+
+  def authorized?
+    return true unless Integrity.config[:use_basic_auth]
+    !!request.env['REMOTE_USER']
+  end
+
+  def authorize(user, password)
+    if Integrity.config[:hash_admin_password]
+      password = Digest::SHA1.hexdigest(password)
+    end
+
+    !Integrity.config[:use_basic_auth] ||
+    (Integrity.config[:admin_username] == user &&
+      Integrity.config[:admin_password] == password)
+  end
+
+  def unauthorized!(realm=authorization_realm)
+    header 'WWW-Authenticate' => %(Basic realm="#{realm}")
+    throw :halt, [401, show(:unauthorized, :title => "incorrect credentials")]
+  end
+
+  def invalid_payload!(msg=nil)
+    throw :halt, [422, msg || 'No payload given']
+  end
+
+  def current_project
+    @project ||= Project.first(:permalink => params[:project]) or raise Sinatra::NotFound
+  end
+
+  def current_build
+    @build ||= current_project.builds.first(:commit_identifier => params[:build]) or raise Sinatra::NotFound
+  end
+
+  def show(view, options={})
+    @title = breadcrumbs(*options[:title])
+    haml view
+  end
+
+  def pages
+    @pages ||= [["projects", "/"], ["new project", "/new"]]
+  end
+
+  def breadcrumbs(*crumbs)
+    crumbs[0..-2].map do |crumb|
+      if page_data = pages.detect {|c| c.first == crumb }
+        %Q(<a href="#{page_data.last}">#{page_data.first}</a>)
+      elsif @project && @project.permalink == crumb
+        %Q(<a href="#{project_url(@project)}">#{@project.permalink}</a>)
+      end
+    end + [crumbs.last]
+  end
+
+  def cycle(*values)
+    @cycles ||= {}
+    @cycles[values] ||= -1 # first value returned is 0
+    next_value = @cycles[values] = (@cycles[values] + 1) % values.size
+    values[next_value]
+  end
+
+  def project_url(project, *path)
+    "/" << [project.permalink, *path].join("/")
+  end
+
+  def push_url_for(project)
+    Addressable::URI.parse(Integrity.config[:base_uri]).join("#{project_url(project)}/push").to_s
+  end
+
+  def build_url(build)
+    "/#{build.project.permalink}/builds/#{build.commit_identifier}"
+  end
+
+  def filter_attributes_of(model)
+    valid = model.properties.collect {|p| p.name.to_s }
+    Hash[*params.dup.select {|k,_| valid.include?(k) }.flatten]
+  end
+
+  def errors_on(object, field)
+    return "" unless errors = object.errors.on(field)
+    errors.map {|e| e.gsub(/#{field} /i, "") }.join(", ")
+  end
+
+  def error_class(object, field)
+    object.errors.on(field).nil? ? "" : "with_errors"
+  end
+  
+  def checkbox(name, condition, extras={})
+    attrs = { :name => name, :type => "checkbox" }.merge(condition ? { :checked => "checked" } : {})
+    attrs.merge(extras)
+  end
+
+  def bash_color_codes(string)
+    string.gsub("\e[0m", '</span>').
+      gsub("\e[31m", '<span class="color31">').
+      gsub("\e[32m", '<span class="color32">').
+      gsub("\e[33m", '<span class="color33">').
+      gsub("\e[34m", '<span class="color34">').
+      gsub("\e[35m", '<span class="color35">').
+      gsub("\e[36m", '<span class="color36">').
+      gsub("\e[37m", '<span class="color37">')
+  end
+
+  def pretty_date(date_time)
+    today = Date.today
+    if date_time.day == today.day && date_time.month == today.month && date_time.year == today.year
+      "today"
+    elsif date_time.day == today.day - 1 && date_time.month == today.month && date_time.year == today.year
+      "yesterday"
+    else
+      date_time.strftime("on %b %d%o")
+    end
+  end
+  
+  def pretty_time_since(date_time)
+    seconds = Time.now - Time.parse(date_time.to_s)
+    seconds = seconds.round
+    if seconds < 60
+      "#{seconds}s"
+    else
+      minutes = seconds / 60
+      remainder_seconds = seconds % 60
+      "#{minutes}m#{remainder_seconds}s"
+    end
+  end
+  
+  def notifier_form(notifier)
+    haml(notifier.to_haml, :layout => :notifier, :locals => { 
+      :config => current_project.config_for(notifier), 
+      :notifier => "#{notifier.to_s.split(/::/).last}", 
+      :enabled => current_project.notifies?(notifier) 
+    })
+  end
+end

data/bin/integrity

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "thor"
+
+require File.dirname(__FILE__) + "/../lib/integrity"
+
+class WithIntegrity < Thor
+  include FileUtils
+
+  desc "install [PATH]",
+       "Copy template files to PATH. Next, go there and edit them."
+  def install(path)
+    @root = File.expand_path(path)
+
+    create_dir_structure
+    copy_template_files
+    edit_template_files
+    create_db(root / "config.yml")
+    after_setup_message
+  end
+
+  desc "create_db [CONFIG]",
+       "Checks the `database_uri` in CONFIG and creates and bootstraps a database for integrity"
+  def create_db(config)
+    Integrity.new(config)
+    DataMapper.auto_migrate!
+  end
+
+  private
+    attr_reader :root
+
+    def create_dir_structure
+      mkdir_p root
+      mkdir_p root / "builds"
+      mkdir_p root / "log"
+    end
+
+    def copy_template_files
+      cp Integrity.root / "config" / "config.sample.ru",  root / "config.ru"
+      cp Integrity.root / "config" / "config.sample.yml", root / "config.yml"
+      cp Integrity.root / "config" / "thin.sample.yml",   root / "thin.yml"
+    end
+
+    def edit_template_files
+      edit_integrity_configuration
+      edit_thin_configuration
+    end
+
+    def edit_integrity_configuration
+      config = File.read(root / "config.yml")
+      config.gsub! %r(sqlite3:///var/integrity.db), "sqlite3://#{root}/integrity.db"
+      config.gsub! %r(/path/to/scm/exports),        "#{root}/builds"
+      config.gsub! %r(/var/log),                    "#{root}/log"
+      File.open(root / "config.yml", "w") { |f| f.puts config }
+    end
+
+    def edit_thin_configuration
+      config = File.read(root / "thin.yml")
+      config.gsub! %r(/apps/integrity), root
+      File.open(root / "thin.yml", 'w') { |f| f.puts config }
+    end
+
+    def after_setup_message
+      puts
+      puts %Q(Awesome! Integrity was installed successfully!)
+      puts
+      puts %Q(If you want to enable notifiers, install the gems and then require them)
+      puts %Q(in #{root}/config.ru)
+      puts
+      puts %Q(For example:)
+      puts
+      puts %Q(  sudo gem install -s http://gems.github.com foca-integrity-email)
+      puts
+      puts %Q(And then in #{root}/config.ru add:)
+      puts
+      puts %Q(  require "notifier/email")
+      puts
+      puts %Q(Don't forget to tweak #{root / "config.yml"} to your needs.)
+    end
+end
+
+WithIntegrity.start

data/config/config.sample.ru

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'integrity'
+
+# If you want to add any notifiers, install the gems and then require them here
+# For example, to enable the Email notifier: install the gem (from github: 
+#
+#   sudo gem install -s http://gems.github.com foca-integrity-email
+# 
+# And then uncomment the following line:
+# 
+# require "notifier/email"
+
+# Load integrity's configuration.
+Integrity.config = File.expand_path('./config.yml')
+
+#######################################################################
+##                                                                   ##
+## == DON'T EDIT ANYTHING BELOW UNLESS YOU KNOW WHAT YOU'RE DOING == ##
+##                                                                   ##
+#######################################################################
+require Integrity.root / 'app'
+
+set     :public,  Integrity.root / 'public'
+set     :views,   Integrity.root / 'views'
+set     :port,    8910
+set     :env,     :production
+disable :run,     :reload
+
+run Sinatra.application

data/config/config.sample.yml

@@ -0,0 +1,34 @@
+# Domain where integrity will be running from. This is used to have
+# nice URLs in your notifications.
+# For example:
+#   http://builder.integrityapp.com
+:base_uri: http://integrity.domain.tld
+
+# This should be a complete connection string to your database. For example 
+# `mysql://user@localhost/integrity` (you need an `integrity` db created in 
+# localhost, of course).
+:database_uri: sqlite3:///var/integrity.db
+
+# This is where your project's code will be checked out to. Make sure it's 
+# writable by the user that runs Integrity.
+:export_directory: /path/to/scm/exports
+
+# Path to the integrity log file
+:log: /var/log/integrity.log
+
+# Enable or disable HTTP authentication for the app. BE AWARE that if you 
+# disable this anyone can delete and alter projects, so do it only if your 
+# app is running in a controlled environment (ie, behind your company's
+# firewall.)
+:use_basic_auth: false
+
+# When `use_basic_auth` is true, the admin's username for HTTP authentication.
+:admin_username: username
+
+# When `use_basic_auth` is true, the admin's password. Usually saved as a 
+# SHA1 hash. See the next option.
+:admin_password: a94a8fe5ccb19ba61c4c0873d391e987982fbbd3
+
+# If this is true, then whenever we authenticate the admin user, will hash 
+# it using SHA1. If not, we'll assume the provided password is in plain text.
+:hash_admin_password: true

data/config/thin.sample.yml

@@ -0,0 +1,13 @@
+---
+environment: production
+chdir: /apps/integrity
+address: 127.0.0.1
+port: 8910
+pid: /apps/integrity/thin.pid
+rackup: /apps/integrity/config.ru
+log: /apps/integrity/log/thin.log
+max_conns: 1024
+timeout: 30
+max_persistent_conns: 512
+daemonize: true
+servers: 2