mattmatt-cijoe 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +2 -0
- data/LICENSE +20 -0
- data/README.markdown +147 -0
- data/Rakefile +25 -0
- data/VERSION +1 -0
- data/bin/cijoe +49 -0
- data/deps.rip +5 -0
- data/examples/cijoe.ru +15 -0
- data/examples/cijoed +53 -0
- data/lib/cijoe.rb +180 -0
- data/lib/cijoe/build.rb +49 -0
- data/lib/cijoe/commit.rb +27 -0
- data/lib/cijoe/config.rb +24 -0
- data/lib/cijoe/email.rb +62 -0
- data/lib/cijoe/public/octocat.png +0 -0
- data/lib/cijoe/public/screen.css +212 -0
- data/lib/cijoe/server.rb +77 -0
- data/lib/cijoe/version.rb +3 -0
- data/lib/cijoe/views/template.erb +64 -0
- data/lib/mmmail.rb +286 -0
- data/spec/email_spec.rb +60 -0
- metadata +105 -0
data/.gitignore
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 Chris Wanstrath
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.markdown
ADDED
@@ -0,0 +1,147 @@
|
|
1
|
+
CI Joe
|
2
|
+
======
|
3
|
+
|
4
|
+
Joe is a [Continuous
|
5
|
+
Integration](http://en.wikipedia.org/wiki/Continuous_integration)
|
6
|
+
server that'll run your tests on demand and report their pass/fail status.
|
7
|
+
|
8
|
+
Because knowing is half the battle.
|
9
|
+
|
10
|
+

|
11
|
+
|
12
|
+
Quickstart
|
13
|
+
----------
|
14
|
+
|
15
|
+
Rip:
|
16
|
+
|
17
|
+
$ rip install git://github.com/defunkt/cijoe.git
|
18
|
+
$ git clone git://github.com/you/yourrepo.git
|
19
|
+
$ cijoe yourrepo
|
20
|
+
|
21
|
+
Gemcutter:
|
22
|
+
|
23
|
+
$ gem install cijoe
|
24
|
+
$ git clone git://github.com/you/yourrepo.git
|
25
|
+
$ cijoe yourrepo
|
26
|
+
|
27
|
+
Boom. Navigate to http://localhost:4567 to see Joe in action.
|
28
|
+
Check `cijoe -h` for other options.
|
29
|
+
|
30
|
+
Basically you need to run `cijoe` and hand it the path to a git
|
31
|
+
repo. Make sure this isn't a shared repo: Joe needs to own it.
|
32
|
+
|
33
|
+
Joe looks for various git config settings in the repo you hand it. For
|
34
|
+
instance, you can tell Joe what command to run by setting
|
35
|
+
`cijoe.runner`:
|
36
|
+
|
37
|
+
$ git config --add cijoe.runner "rake -s test:units"
|
38
|
+
|
39
|
+
Joe doesn't care about Ruby, Python, or whatever. As long as the
|
40
|
+
runner returns a non-zero exit status on fail and a zero on success,
|
41
|
+
everyone is happy.
|
42
|
+
|
43
|
+
Need to do some massaging of your repo before the tests run, like
|
44
|
+
maybe swapping in a new database.yml? No problem - Joe will try to
|
45
|
+
run `.git/hooks/after-reset` if it exists before each build phase.
|
46
|
+
Do it in there. Just make sure it's executable.
|
47
|
+
|
48
|
+
Want to notify IRC or email on test pass or failure? Joe will run
|
49
|
+
`.git/hooks/build-failed` or `.git/hooks/build-worked` if they exist
|
50
|
+
and are executable on build pass / fail. They're just shell scripts -
|
51
|
+
put whatever you want in there.
|
52
|
+
|
53
|
+
Tip: your repo's `HEAD` will point to the commit used to run the
|
54
|
+
build. Pull any metadata you want out of that scro.
|
55
|
+
|
56
|
+
|
57
|
+
Other Branches
|
58
|
+
--------------
|
59
|
+
|
60
|
+
Want joe to run against a branch other than `master`? No problem:
|
61
|
+
|
62
|
+
$ git config --add cijoe.branch deploy
|
63
|
+
|
64
|
+
|
65
|
+
Campfire
|
66
|
+
--------
|
67
|
+
|
68
|
+
Campfire notification is included, because it's what we use. Want Joe
|
69
|
+
notify your Campfire? Put this in your repo's `.git/config`:
|
70
|
+
|
71
|
+
[campfire]
|
72
|
+
user = your@campfire.email
|
73
|
+
pass = passw0rd
|
74
|
+
subdomain = whatever
|
75
|
+
room = Awesomeness
|
76
|
+
ssl = false
|
77
|
+
|
78
|
+
Or do it the old fashion way:
|
79
|
+
|
80
|
+
$ cd yourrepo
|
81
|
+
$ git config --add campfire.user chris@ozmm.org
|
82
|
+
$ git config --add campfire.subdomain github
|
83
|
+
etc.
|
84
|
+
|
85
|
+
|
86
|
+
Multiple Projects
|
87
|
+
-----------------
|
88
|
+
|
89
|
+
Want CI for multiple projects? Just start multiple instances of Joe!
|
90
|
+
He can run on any port - try `cijoe -h` for more options.
|
91
|
+
|
92
|
+
|
93
|
+
HTTP Auth
|
94
|
+
---------
|
95
|
+
|
96
|
+
Worried about people triggering your builds? Setup HTTP auth:
|
97
|
+
|
98
|
+
$ git config --add cijoe.user chris
|
99
|
+
$ git config --add cijoe.pass secret
|
100
|
+
|
101
|
+
|
102
|
+
GitHub Integration
|
103
|
+
------------------
|
104
|
+
|
105
|
+
Any POST to Joe will trigger a build. If you are hiding Joe behind
|
106
|
+
HTTP auth, that's okay - GitHub knows how to authenticate properly.
|
107
|
+
|
108
|
+

|
109
|
+
|
110
|
+
You can find the Post-Receive option under the 'Service Hooks' subtab
|
111
|
+
of your project's "Admin" tab.
|
112
|
+
|
113
|
+
|
114
|
+
Daemonize
|
115
|
+
---------
|
116
|
+
|
117
|
+
Want to run Joe as a daemon? Use `nohup`:
|
118
|
+
|
119
|
+
$ nohup cijoe -p 4444 repo &
|
120
|
+
|
121
|
+
|
122
|
+
Other CI Servers
|
123
|
+
----------------
|
124
|
+
|
125
|
+
Need more features? More notifiers? Check out one of these bad boys:
|
126
|
+
|
127
|
+
* [Cerberus](http://cerberus.rubyforge.org/)
|
128
|
+
* [Integrity](http://integrityapp.com/)
|
129
|
+
* [CruiseControl.rb](http://cruisecontrolrb.thoughtworks.com/)
|
130
|
+
* [BuildBot](http://buildbot.net/trac)
|
131
|
+
|
132
|
+
|
133
|
+
Screenshots
|
134
|
+
-----------
|
135
|
+
|
136
|
+

|
137
|
+
|
138
|
+

|
139
|
+
|
140
|
+
|
141
|
+
Questions? Concerns?
|
142
|
+
--------------------
|
143
|
+
|
144
|
+
[Issues](http://github.com/defunkt/cijoe/issues) or [the mailing list](http://groups.google.com/group/cijoe).
|
145
|
+
|
146
|
+
|
147
|
+
( Chris Wanstrath :: chris@ozmm.org )
|
data/Rakefile
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
desc "Build a gem"
|
2
|
+
task :gem => [ :gemspec, :build ]
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
|
7
|
+
$LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
|
8
|
+
require 'cijoe/version'
|
9
|
+
|
10
|
+
Jeweler::Tasks.new do |gemspec|
|
11
|
+
gemspec.name = "mattmatt-cijoe"
|
12
|
+
gemspec.summary = "CI Joe is a simple Continuous Integration server."
|
13
|
+
gemspec.description = "CI Joe is a simple Continuous Integration server."
|
14
|
+
gemspec.email = "chris@ozmm.org"
|
15
|
+
gemspec.homepage = "http://github.com/defunkt/cijoe"
|
16
|
+
gemspec.authors = ["Chris Wanstrath"]
|
17
|
+
gemspec.add_dependency 'choice'
|
18
|
+
gemspec.add_dependency 'sinatra'
|
19
|
+
gemspec.add_dependency 'open4'
|
20
|
+
gemspec.version = CIJoe::Version.to_s
|
21
|
+
end
|
22
|
+
rescue LoadError
|
23
|
+
puts "Jeweler not available."
|
24
|
+
puts "Install it with: gem install jeweler"
|
25
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.0.1
|
data/bin/cijoe
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
|
3
|
+
|
4
|
+
require 'cijoe'
|
5
|
+
require 'choice'
|
6
|
+
|
7
|
+
Choice.options do
|
8
|
+
banner "Usage: #{File.basename(__FILE__)} [-hpv] path_to_git_repo"
|
9
|
+
header ''
|
10
|
+
header 'Server options:'
|
11
|
+
|
12
|
+
option :host do
|
13
|
+
d = "0.0.0.0"
|
14
|
+
short '-h'
|
15
|
+
long '--host=HOST'
|
16
|
+
desc "The hostname or ip of the host to bind to (default #{d})"
|
17
|
+
default d
|
18
|
+
end
|
19
|
+
|
20
|
+
option :port do
|
21
|
+
d = 4567
|
22
|
+
short '-p'
|
23
|
+
long '--port=PORT'
|
24
|
+
desc "The port to listen on (default #{d})"
|
25
|
+
cast Integer
|
26
|
+
default d
|
27
|
+
end
|
28
|
+
|
29
|
+
separator ''
|
30
|
+
separator 'Common options: '
|
31
|
+
|
32
|
+
option :help do
|
33
|
+
long '--help'
|
34
|
+
desc 'Show this message'
|
35
|
+
end
|
36
|
+
|
37
|
+
option :version do
|
38
|
+
short '-v'
|
39
|
+
long '--version'
|
40
|
+
desc 'Show version'
|
41
|
+
action do
|
42
|
+
puts "#{File.basename(__FILE__)} v#{CIJoe::Version}"
|
43
|
+
exit
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
options = Choice.choices
|
49
|
+
CIJoe::Server.start(options[:host], options[:port], Choice.rest[0])
|
data/deps.rip
ADDED
data/examples/cijoe.ru
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
# Example CI Joe rackup config. Drop a cijoe.ru file
|
2
|
+
# in your projects direct
|
3
|
+
require 'cijoe'
|
4
|
+
|
5
|
+
# setup middleware
|
6
|
+
use Rack::CommonLogger
|
7
|
+
|
8
|
+
# configure joe
|
9
|
+
CIJoe::Server.configure do |config|
|
10
|
+
config.set :project_path, File.dirname(__FILE__)
|
11
|
+
config.set :show_exceptions, true
|
12
|
+
config.set :lock, true
|
13
|
+
end
|
14
|
+
|
15
|
+
run CIJoe::Server
|
data/examples/cijoed
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
### BEGIN INIT INFO
|
3
|
+
# Provides: cijoe
|
4
|
+
# Required-Start: $syslog $local_fs $network
|
5
|
+
# Required-Stop: $syslog $local_fs $network
|
6
|
+
# Default-Start: 2 3 4 5
|
7
|
+
# Default-Stop: 0 1
|
8
|
+
# Description: Run the CIJoe CI server. Yo Joe!!
|
9
|
+
### END INIT INFO
|
10
|
+
|
11
|
+
. /lib/lsb/init-functions
|
12
|
+
|
13
|
+
REPO=/path/to/your/git/repository
|
14
|
+
PORT=4567
|
15
|
+
|
16
|
+
NAME=cijoe
|
17
|
+
INSTALL_DIR=/usr/sbin
|
18
|
+
DAEMON=$INSTALL_DIR/$NAME
|
19
|
+
DAEMON_ARGS="-p $PORT $REPO"
|
20
|
+
PIDFILE=/var/run/$NAME.pid
|
21
|
+
DAEMON_USER=www-data
|
22
|
+
DAEMON_GROUP=$DAEMON_USER
|
23
|
+
|
24
|
+
# test -f $DAEMON || exit 0
|
25
|
+
# test -f $PROJECT_DIR || exit 0
|
26
|
+
|
27
|
+
case "$1" in
|
28
|
+
start)
|
29
|
+
log_daemon_msg "Starting cijoe" "cijoe"
|
30
|
+
start-stop-daemon --background --make-pidfile --exec $DAEMON --start --name $NAME --pidfile $PIDFILE --chuid $DAEMON_USER:$DAEMON_GROUP -- $DAEMON_ARGS
|
31
|
+
log_end_msg $?
|
32
|
+
;;
|
33
|
+
stop)
|
34
|
+
log_daemon_msg "Stopping cijoe" "cijoe"
|
35
|
+
start-stop-daemon --stop --pidfile $PIDFILE --quiet --retry 10
|
36
|
+
log_end_msg $?
|
37
|
+
;;
|
38
|
+
restart)
|
39
|
+
log_daemon_msg "Restarting cijoe" "cijoe"
|
40
|
+
start-stop-daemon --stop --pidfile $PIDFILE --quiet --retry 10
|
41
|
+
start-stop-daemon --background --make-pidfile --exec $DAEMON --start --name $NAME --pidfile $PIDFILE --chuid $DAEMON_USER:$DAEMON_GROUP -- $DAEMON_ARGS
|
42
|
+
log_end_msg $?
|
43
|
+
;;
|
44
|
+
status)
|
45
|
+
status_of_proc $DAEMON $NAME && exit 0 || exit $?
|
46
|
+
;;
|
47
|
+
*)
|
48
|
+
log_action_msg "Usage: /etc/init.d/cijoe (start|stop|restart)"
|
49
|
+
exit 2
|
50
|
+
;;
|
51
|
+
esac
|
52
|
+
|
53
|
+
exit 0
|
data/lib/cijoe.rb
ADDED
@@ -0,0 +1,180 @@
|
|
1
|
+
##
|
2
|
+
# CI Joe.
|
3
|
+
# Because knowing is half the battle.
|
4
|
+
#
|
5
|
+
# This is a stupid simple CI server. It can build one (1)
|
6
|
+
# git-based project only.
|
7
|
+
#
|
8
|
+
# It only remembers the last build.
|
9
|
+
#
|
10
|
+
# It only notifies to Campfire.
|
11
|
+
#
|
12
|
+
# It's a RAH (Real American Hero).
|
13
|
+
#
|
14
|
+
# Seriously, I'm gonna be nuts about keeping this simple.
|
15
|
+
|
16
|
+
begin
|
17
|
+
require 'open4'
|
18
|
+
rescue LoadError
|
19
|
+
abort "** Please install open4"
|
20
|
+
end
|
21
|
+
|
22
|
+
require 'cijoe/version'
|
23
|
+
require 'cijoe/config'
|
24
|
+
require 'cijoe/commit'
|
25
|
+
require 'cijoe/build'
|
26
|
+
require 'cijoe/email'
|
27
|
+
require 'cijoe/server'
|
28
|
+
|
29
|
+
class CIJoe
|
30
|
+
attr_reader :user, :project, :url, :current_build, :last_build
|
31
|
+
|
32
|
+
def initialize(project_path)
|
33
|
+
project_path = File.expand_path(project_path)
|
34
|
+
Dir.chdir(project_path)
|
35
|
+
|
36
|
+
@user, @project = git_user_and_project
|
37
|
+
@url = "http://github.com/#{@user}/#{@project}"
|
38
|
+
|
39
|
+
@last_build = nil
|
40
|
+
@current_build = nil
|
41
|
+
|
42
|
+
trap("INT") { stop }
|
43
|
+
end
|
44
|
+
|
45
|
+
# is a build running?
|
46
|
+
def building?
|
47
|
+
!!@current_build
|
48
|
+
end
|
49
|
+
|
50
|
+
# the pid of the running child process
|
51
|
+
def pid
|
52
|
+
building? and current_build.pid
|
53
|
+
end
|
54
|
+
|
55
|
+
# kill the child and exit
|
56
|
+
def stop
|
57
|
+
Process.kill(9, pid) if pid
|
58
|
+
exit!
|
59
|
+
end
|
60
|
+
|
61
|
+
# build callbacks
|
62
|
+
def build_failed(output, error)
|
63
|
+
finish_build :failed, "#{error}\n\n#{output}"
|
64
|
+
run_hook "build-failed"
|
65
|
+
end
|
66
|
+
|
67
|
+
def build_worked(output)
|
68
|
+
finish_build :worked, output
|
69
|
+
run_hook "build-worked"
|
70
|
+
end
|
71
|
+
|
72
|
+
def finish_build(status, output)
|
73
|
+
@current_build.finished_at = Time.now
|
74
|
+
@current_build.status = status
|
75
|
+
@current_build.output = output
|
76
|
+
@last_build = @current_build
|
77
|
+
@current_build = nil
|
78
|
+
write_build 'current', @current_build
|
79
|
+
write_build 'last', @last_build
|
80
|
+
@last_build.notify if @last_build.respond_to? :notify
|
81
|
+
end
|
82
|
+
|
83
|
+
# run the build but make sure only
|
84
|
+
# one is running at a time
|
85
|
+
def build
|
86
|
+
return if building?
|
87
|
+
@current_build = Build.new(@user, @project)
|
88
|
+
write_build 'current', @current_build
|
89
|
+
Thread.new { build! }
|
90
|
+
end
|
91
|
+
|
92
|
+
# update git then run the build
|
93
|
+
def build!
|
94
|
+
build = @current_build
|
95
|
+
out, err, status = '', '', nil
|
96
|
+
git_update
|
97
|
+
build.sha = git_sha
|
98
|
+
write_build 'current', build
|
99
|
+
|
100
|
+
status = Open4.popen4(runner_command) do |pid, stdin, stdout, stderr|
|
101
|
+
build.pid = pid
|
102
|
+
write_build 'current', build
|
103
|
+
err, out = stderr.read.strip, stdout.read.strip
|
104
|
+
end
|
105
|
+
|
106
|
+
status.exitstatus.to_i == 0 ? build_worked(out) : build_failed(out, err)
|
107
|
+
rescue Object => e
|
108
|
+
build_failed('', e.to_s)
|
109
|
+
end
|
110
|
+
|
111
|
+
# shellin' out
|
112
|
+
def runner_command
|
113
|
+
runner = Config.cijoe.runner.to_s
|
114
|
+
runner == '' ? "rake -s test:units" : runner
|
115
|
+
end
|
116
|
+
|
117
|
+
def git_sha
|
118
|
+
`git rev-parse origin/#{git_branch}`.chomp
|
119
|
+
end
|
120
|
+
|
121
|
+
def git_update
|
122
|
+
`git fetch origin && git reset --hard origin/#{git_branch}`
|
123
|
+
run_hook "after-reset"
|
124
|
+
end
|
125
|
+
|
126
|
+
def git_user_and_project
|
127
|
+
Config.remote.origin.url.to_s.chomp('.git').split(':')[-1].split('/')[-2, 2]
|
128
|
+
end
|
129
|
+
|
130
|
+
def git_branch
|
131
|
+
branch = Config.cijoe.branch.to_s
|
132
|
+
branch == '' ? "master" : branch
|
133
|
+
end
|
134
|
+
|
135
|
+
# massage our repo
|
136
|
+
def run_hook(hook)
|
137
|
+
if File.exists?(file=".git/hooks/#{hook}") && File.executable?(file)
|
138
|
+
data =
|
139
|
+
if @last_build && @last_build.commit
|
140
|
+
{
|
141
|
+
"MESSAGE" => @last_build.commit.message,
|
142
|
+
"AUTHOR" => @last_build.commit.author,
|
143
|
+
"SHA" => @last_build.commit.sha,
|
144
|
+
"OUTPUT" => @last_build.clean_output
|
145
|
+
}
|
146
|
+
else
|
147
|
+
{}
|
148
|
+
end
|
149
|
+
env = data.collect { |k, v| %(#{k}=#{v.inspect}) }.join(" ")
|
150
|
+
`#{env} sh #{file}`
|
151
|
+
end
|
152
|
+
end
|
153
|
+
|
154
|
+
# restore current / last build state from disk.
|
155
|
+
def restore
|
156
|
+
@last_build = read_build('last')
|
157
|
+
@current_build = read_build('current')
|
158
|
+
Process.kill(0, @current_build.pid) if @current_build && @current_build.pid
|
159
|
+
rescue Errno::ESRCH
|
160
|
+
# build pid isn't running anymore. assume previous
|
161
|
+
# server died and reset.
|
162
|
+
@current_build = nil
|
163
|
+
end
|
164
|
+
|
165
|
+
# write build info for build to file.
|
166
|
+
def write_build(name, build)
|
167
|
+
filename = ".git/builds/#{name}"
|
168
|
+
Dir.mkdir '.git/builds' unless File.directory?('.git/builds')
|
169
|
+
if build
|
170
|
+
build.dump filename
|
171
|
+
elsif File.exist?(filename)
|
172
|
+
File.unlink filename
|
173
|
+
end
|
174
|
+
end
|
175
|
+
|
176
|
+
# load build info from file.
|
177
|
+
def read_build(name)
|
178
|
+
Build.load(".git/builds/#{name}")
|
179
|
+
end
|
180
|
+
end
|