akqa-jenkins 0.6.4.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +8 -0
- data/Changelog.md +54 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +56 -0
- data/README.md +159 -0
- data/Rakefile +82 -0
- data/bin/jenkins +11 -0
- data/cucumber.yml +8 -0
- data/features/build_details.feature +42 -0
- data/features/configure.feature +36 -0
- data/features/default_host.feature +26 -0
- data/features/development.feature +14 -0
- data/features/launch_server.feature +16 -0
- data/features/listing_jobs.feature +34 -0
- data/features/manage_jobs.feature +214 -0
- data/features/manage_slave_nodes.feature +82 -0
- data/features/step_definitions/common_steps.rb +192 -0
- data/features/step_definitions/fixture_project_steps.rb +8 -0
- data/features/step_definitions/jenkins_steps.rb +116 -0
- data/features/step_definitions/scm_steps.rb +12 -0
- data/features/support/common.rb +37 -0
- data/features/support/env.rb +19 -0
- data/features/support/hooks.rb +16 -0
- data/features/support/jenkins_helpers.rb +6 -0
- data/features/support/matchers.rb +10 -0
- data/fixtures/jenkins/envfile.hpi +0 -0
- data/fixtures/jenkins/git.hpi +0 -0
- data/fixtures/jenkins/github.hpi +0 -0
- data/fixtures/jenkins/greenballs.hpi +0 -0
- data/fixtures/jenkins/rake.hpi +0 -0
- data/fixtures/jenkins/ruby.hpi +0 -0
- data/fixtures/projects/erlang/rebar.config +1 -0
- data/fixtures/projects/non-bundler/Rakefile +4 -0
- data/fixtures/projects/rails-3/.gitignore +4 -0
- data/fixtures/projects/rails-3/Gemfile +30 -0
- data/fixtures/projects/rails-3/Gemfile.lock +74 -0
- data/fixtures/projects/rails-3/README +256 -0
- data/fixtures/projects/rails-3/Rakefile +7 -0
- data/fixtures/projects/rails-3/app/controllers/application_controller.rb +3 -0
- data/fixtures/projects/rails-3/app/helpers/application_helper.rb +2 -0
- data/fixtures/projects/rails-3/app/views/layouts/application.html.erb +14 -0
- data/fixtures/projects/rails-3/config.ru +4 -0
- data/fixtures/projects/rails-3/config/application.rb +42 -0
- data/fixtures/projects/rails-3/config/boot.rb +13 -0
- data/fixtures/projects/rails-3/config/database.yml +22 -0
- data/fixtures/projects/rails-3/config/environment.rb +5 -0
- data/fixtures/projects/rails-3/config/environments/development.rb +26 -0
- data/fixtures/projects/rails-3/config/environments/production.rb +49 -0
- data/fixtures/projects/rails-3/config/environments/test.rb +35 -0
- data/fixtures/projects/rails-3/config/initializers/backtrace_silencers.rb +7 -0
- data/fixtures/projects/rails-3/config/initializers/inflections.rb +10 -0
- data/fixtures/projects/rails-3/config/initializers/mime_types.rb +5 -0
- data/fixtures/projects/rails-3/config/initializers/secret_token.rb +7 -0
- data/fixtures/projects/rails-3/config/initializers/session_store.rb +8 -0
- data/fixtures/projects/rails-3/config/locales/en.yml +5 -0
- data/fixtures/projects/rails-3/config/routes.rb +58 -0
- data/fixtures/projects/rails-3/db/seeds.rb +7 -0
- data/fixtures/projects/rails-3/doc/README_FOR_APP +2 -0
- data/fixtures/projects/rails-3/lib/tasks/.gitkeep +0 -0
- data/fixtures/projects/rails-3/public/404.html +26 -0
- data/fixtures/projects/rails-3/public/422.html +26 -0
- data/fixtures/projects/rails-3/public/500.html +26 -0
- data/fixtures/projects/rails-3/public/favicon.ico +0 -0
- data/fixtures/projects/rails-3/public/images/rails.png +0 -0
- data/fixtures/projects/rails-3/public/index.html +239 -0
- data/fixtures/projects/rails-3/public/javascripts/application.js +2 -0
- data/fixtures/projects/rails-3/public/javascripts/controls.js +965 -0
- data/fixtures/projects/rails-3/public/javascripts/dragdrop.js +974 -0
- data/fixtures/projects/rails-3/public/javascripts/effects.js +1123 -0
- data/fixtures/projects/rails-3/public/javascripts/prototype.js +6001 -0
- data/fixtures/projects/rails-3/public/javascripts/rails.js +175 -0
- data/fixtures/projects/rails-3/public/robots.txt +5 -0
- data/fixtures/projects/rails-3/public/stylesheets/.gitkeep +0 -0
- data/fixtures/projects/rails-3/script/rails +6 -0
- data/fixtures/projects/rails-3/test/performance/browsing_test.rb +9 -0
- data/fixtures/projects/rails-3/test/test_helper.rb +13 -0
- data/fixtures/projects/rails-3/vendor/plugins/.gitkeep +0 -0
- data/fixtures/projects/ruby/Gemfile +3 -0
- data/fixtures/projects/ruby/Gemfile.lock +10 -0
- data/fixtures/projects/ruby/Rakefile +4 -0
- data/jenkins.gemspec +33 -0
- data/lib/jenkins.rb +6 -0
- data/lib/jenkins/api.rb +250 -0
- data/lib/jenkins/cli.rb +291 -0
- data/lib/jenkins/cli/formatting.rb +53 -0
- data/lib/jenkins/config.rb +27 -0
- data/lib/jenkins/core_ext/hash.rb +9 -0
- data/lib/jenkins/core_ext/object/blank.rb +77 -0
- data/lib/jenkins/hudson-cli.jar +0 -0
- data/lib/jenkins/job_config_builder.rb +292 -0
- data/lib/jenkins/project_scm.rb +22 -0
- data/lib/jenkins/remote.rb +11 -0
- data/lib/jenkins/version.rb +3 -0
- data/spec/fixtures/ec2_global.config.xml +103 -0
- data/spec/fixtures/erlang.single.config.xml +59 -0
- data/spec/fixtures/rails.multi.config.xml +82 -0
- data/spec/fixtures/rails.single.config.triggers.xml +84 -0
- data/spec/fixtures/rails.single.config.xml +80 -0
- data/spec/fixtures/ruby.multi-ruby-multi-labels.config.xml +84 -0
- data/spec/fixtures/ruby.multi.config.xml +77 -0
- data/spec/fixtures/ruby.single.config.xml +58 -0
- data/spec/fixtures/therubyracer.config.xml +77 -0
- data/spec/hash_key_cleaner_spec.rb +25 -0
- data/spec/job_config_builder_spec.rb +150 -0
- data/spec/spec_helper.rb +15 -0
- metadata +283 -0
@@ -0,0 +1,8 @@
|
|
1
|
+
Given /^I am in the "([^\"]*)" project folder$/ do |project|
|
2
|
+
project_folder = File.expand_path(File.dirname(__FILE__) + "/../../fixtures/projects/#{project}")
|
3
|
+
in_tmp_folder do
|
4
|
+
FileUtils.cp_r(project_folder, project)
|
5
|
+
setup_active_project_folder(project)
|
6
|
+
end
|
7
|
+
end
|
8
|
+
|
@@ -0,0 +1,116 @@
|
|
1
|
+
Given /^I have a Jenkins server running$/ do
|
2
|
+
unless @jenkins_port
|
3
|
+
port = 3010
|
4
|
+
begin
|
5
|
+
res = Net::HTTP.start("localhost", port) { |http| http.get('/api/json') }
|
6
|
+
Jenkins::Api.base_uri "http://localhost:#{port}"
|
7
|
+
rescue Errno::ECONNREFUSED => e
|
8
|
+
raise Exception, "To run tests, launch jenkins in test mode: 'rake jenkins:server:test'"
|
9
|
+
end
|
10
|
+
@jenkins_port = port.to_s
|
11
|
+
@jenkins_host = 'localhost'
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
Given /^the Jenkins server has no current jobs$/ do
|
16
|
+
if port = @jenkins_port
|
17
|
+
Jenkins::Api.summary['jobs'].each do |job|
|
18
|
+
Jenkins::Api.delete_job(job['name'])
|
19
|
+
end
|
20
|
+
Jenkins::Api.summary['jobs'].should == []
|
21
|
+
else
|
22
|
+
puts "WARNING: Run 'I have a Jenkins server running' step first."
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
Given /^the Jenkins server has no slaves$/ do
|
27
|
+
if port = @jenkins_port
|
28
|
+
Jenkins::Api.summary['jobs'].each do |job|
|
29
|
+
Jenkins::Api.delete_job(job['name'])
|
30
|
+
end
|
31
|
+
Jenkins::Api.summary['jobs'].should == []
|
32
|
+
|
33
|
+
Jenkins::Api.nodes['computer'].each do |node|
|
34
|
+
name = node['displayName']
|
35
|
+
Jenkins::Api.delete_node(name) unless name == "master"
|
36
|
+
end
|
37
|
+
Jenkins::Api.nodes['computer'].size.should == 1
|
38
|
+
else
|
39
|
+
puts "WARNING: Run 'I have a Jenkins server running' step first."
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
Given /^there is nothing listening on port (\d+)$/ do |port|
|
44
|
+
lambda {
|
45
|
+
TCPSocket.open("localhost", port) {}
|
46
|
+
}.should raise_error
|
47
|
+
end
|
48
|
+
|
49
|
+
Given /^I cleanup any jenkins processes with control port (\d+)$/ do |port|
|
50
|
+
@jenkins_cleanup << port
|
51
|
+
end
|
52
|
+
|
53
|
+
def try(times, interval = 1)
|
54
|
+
begin
|
55
|
+
times -= 1
|
56
|
+
return yield
|
57
|
+
rescue Exception => e
|
58
|
+
if times >= 0
|
59
|
+
sleep(interval)
|
60
|
+
retry
|
61
|
+
end
|
62
|
+
raise e
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
When /^I run jenkins server with arguments "(.*)"/ do |arguments|
|
67
|
+
@stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
|
68
|
+
executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin","jenkins"))
|
69
|
+
in_project_folder do
|
70
|
+
system "ruby #{executable.inspect} server #{arguments} > #{@stdout.inspect} 2> #{@stdout.inspect}"
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
|
75
|
+
Then /^I should see a jenkins server on port (\d+)$/ do |port|
|
76
|
+
require 'json'
|
77
|
+
try(15, 2) do
|
78
|
+
Jenkins::Api.base_uri "http://localhost:#{port}"
|
79
|
+
Jenkins::Api.summary['nodeDescription'].should == "the master Jenkins node"
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
When /^I (re|)create a job$/ do |override|
|
84
|
+
override = override.blank? ? "" : " --override"
|
85
|
+
steps <<-CUCUMBER
|
86
|
+
When the project uses "git" scm
|
87
|
+
When I run local executable "jenkins" with arguments "create . --host localhost --port 3010#{override}"
|
88
|
+
CUCUMBER
|
89
|
+
end
|
90
|
+
|
91
|
+
When /^I wait for ([\S]+) build (\d+) to start$/ do |project_name, build_number|
|
92
|
+
begin
|
93
|
+
Timeout.timeout(10) do
|
94
|
+
while !Jenkins::Api.build_details(project_name, build_number)
|
95
|
+
sleep 1
|
96
|
+
end
|
97
|
+
end
|
98
|
+
rescue TimeoutError
|
99
|
+
raise "Couldn't find build #{build_number} for project #{project_name}"
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
Then /^the job "([^"]*)" config "([^"]*)" should be:$/ do |job_name, xpath, string|
|
104
|
+
raise "Cannot yet fetch XML config from non-localhost Jenkins" unless Jenkins::Api.base_uri =~ /localhost/
|
105
|
+
require "hpricot"
|
106
|
+
config = Hpricot.XML(File.read("#{test_jenkins_path}/jobs/#{job_name}/config.xml"))
|
107
|
+
config.search(xpath).to_s.should == string
|
108
|
+
end
|
109
|
+
|
110
|
+
Then /^the Jenkins config "([^"]*)" should be:$/ do |xpath, string|
|
111
|
+
raise "Cannot yet fetch XML config from non-localhost Jenkins" unless Jenkins::Api.base_uri =~ /localhost/
|
112
|
+
require "hpricot"
|
113
|
+
config = Hpricot.XML(File.read("#{test_jenkins_path}/config.xml"))
|
114
|
+
config.search(xpath).to_s.should == string
|
115
|
+
end
|
116
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
Given /^the project uses "git" scm$/ do
|
2
|
+
repo = "git://some.host/drnic/ruby.git"
|
3
|
+
in_project_folder do
|
4
|
+
unless File.exist?(".git")
|
5
|
+
%x[ git init ]
|
6
|
+
%x[ git add . ]
|
7
|
+
%x[ git commit -m "initial commit" ]
|
8
|
+
%x[ git remote add origin #{repo} ]
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
@@ -0,0 +1,37 @@
|
|
1
|
+
module CommonHelpers
|
2
|
+
def get_command_output
|
3
|
+
strip_color_codes(File.read(@stdout)).chomp
|
4
|
+
end
|
5
|
+
|
6
|
+
def strip_color_codes(text)
|
7
|
+
text.gsub(/\e\[\d+m/, '')
|
8
|
+
end
|
9
|
+
|
10
|
+
def in_tmp_folder(&block)
|
11
|
+
FileUtils.chdir(@tmp_root, &block)
|
12
|
+
end
|
13
|
+
|
14
|
+
def in_project_folder(&block)
|
15
|
+
project_folder = @active_project_folder || @tmp_root
|
16
|
+
FileUtils.chdir(project_folder, &block)
|
17
|
+
end
|
18
|
+
|
19
|
+
def in_home_folder(&block)
|
20
|
+
FileUtils.chdir(@home_path, &block)
|
21
|
+
end
|
22
|
+
|
23
|
+
def force_local_lib_override(project_name = @project_name)
|
24
|
+
rakefile = File.read(File.join(project_name, 'Rakefile'))
|
25
|
+
File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
|
26
|
+
f << "$:.unshift('#{@lib_path}')\n"
|
27
|
+
f << rakefile
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
def setup_active_project_folder project_name
|
32
|
+
@active_project_folder = File.join(@tmp_root, project_name)
|
33
|
+
@project_name = project_name
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
World(CommonHelpers)
|
@@ -0,0 +1,19 @@
|
|
1
|
+
$:.unshift(File.expand_path(File.dirname(__FILE__) + "/../../lib"))
|
2
|
+
require 'jenkins.rb'
|
3
|
+
require 'bundler/setup'
|
4
|
+
require 'ap'
|
5
|
+
|
6
|
+
Before do
|
7
|
+
@tmp_root = File.dirname(__FILE__) + "/../../tmp"
|
8
|
+
@home_path = File.expand_path(File.join(@tmp_root, "home"))
|
9
|
+
@lib_path = File.expand_path(File.dirname(__FILE__) + "/../../lib")
|
10
|
+
FileUtils.rm_rf @tmp_root
|
11
|
+
FileUtils.mkdir_p @home_path
|
12
|
+
ENV['HOME'] = @home_path
|
13
|
+
ENV['CUCUMBER_RUNNING'] = 'oooh yes'
|
14
|
+
end
|
15
|
+
|
16
|
+
After do
|
17
|
+
ENV.delete('JENKINS_HOST')
|
18
|
+
ENV.delete('JENKINS_PORT')
|
19
|
+
end
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
@@ -0,0 +1 @@
|
|
1
|
+
% important erlang business here
|
@@ -0,0 +1,30 @@
|
|
1
|
+
source 'http://rubygems.org'
|
2
|
+
|
3
|
+
gem 'rails', '3.0.1'
|
4
|
+
|
5
|
+
# Bundle edge Rails instead:
|
6
|
+
# gem 'rails', :git => 'git://github.com/rails/rails.git'
|
7
|
+
|
8
|
+
gem 'sqlite3-ruby', :require => 'sqlite3'
|
9
|
+
|
10
|
+
# Use unicorn as the web server
|
11
|
+
# gem 'unicorn'
|
12
|
+
|
13
|
+
# Deploy with Capistrano
|
14
|
+
# gem 'capistrano'
|
15
|
+
|
16
|
+
# To use debugger
|
17
|
+
# gem 'ruby-debug'
|
18
|
+
|
19
|
+
# Bundle the extra gems:
|
20
|
+
# gem 'bj'
|
21
|
+
# gem 'nokogiri'
|
22
|
+
# gem 'sqlite3-ruby', :require => 'sqlite3'
|
23
|
+
# gem 'aws-s3', :require => 'aws/s3'
|
24
|
+
|
25
|
+
# Bundle gems for the local environment. Make sure to
|
26
|
+
# put test-only gems in this group so their generators
|
27
|
+
# and rake tasks are available in development mode:
|
28
|
+
# group :development, :test do
|
29
|
+
# gem 'webrat'
|
30
|
+
# end
|
@@ -0,0 +1,74 @@
|
|
1
|
+
GEM
|
2
|
+
remote: http://rubygems.org/
|
3
|
+
specs:
|
4
|
+
abstract (1.0.0)
|
5
|
+
actionmailer (3.0.1)
|
6
|
+
actionpack (= 3.0.1)
|
7
|
+
mail (~> 2.2.5)
|
8
|
+
actionpack (3.0.1)
|
9
|
+
activemodel (= 3.0.1)
|
10
|
+
activesupport (= 3.0.1)
|
11
|
+
builder (~> 2.1.2)
|
12
|
+
erubis (~> 2.6.6)
|
13
|
+
i18n (~> 0.4.1)
|
14
|
+
rack (~> 1.2.1)
|
15
|
+
rack-mount (~> 0.6.12)
|
16
|
+
rack-test (~> 0.5.4)
|
17
|
+
tzinfo (~> 0.3.23)
|
18
|
+
activemodel (3.0.1)
|
19
|
+
activesupport (= 3.0.1)
|
20
|
+
builder (~> 2.1.2)
|
21
|
+
i18n (~> 0.4.1)
|
22
|
+
activerecord (3.0.1)
|
23
|
+
activemodel (= 3.0.1)
|
24
|
+
activesupport (= 3.0.1)
|
25
|
+
arel (~> 1.0.0)
|
26
|
+
tzinfo (~> 0.3.23)
|
27
|
+
activeresource (3.0.1)
|
28
|
+
activemodel (= 3.0.1)
|
29
|
+
activesupport (= 3.0.1)
|
30
|
+
activesupport (3.0.1)
|
31
|
+
arel (1.0.1)
|
32
|
+
activesupport (~> 3.0.0)
|
33
|
+
builder (2.1.2)
|
34
|
+
erubis (2.6.6)
|
35
|
+
abstract (>= 1.0.0)
|
36
|
+
i18n (0.4.2)
|
37
|
+
mail (2.2.9)
|
38
|
+
activesupport (>= 2.3.6)
|
39
|
+
i18n (~> 0.4.1)
|
40
|
+
mime-types (~> 1.16)
|
41
|
+
treetop (~> 1.4.8)
|
42
|
+
mime-types (1.16)
|
43
|
+
polyglot (0.3.1)
|
44
|
+
rack (1.2.1)
|
45
|
+
rack-mount (0.6.13)
|
46
|
+
rack (>= 1.0.0)
|
47
|
+
rack-test (0.5.6)
|
48
|
+
rack (>= 1.0)
|
49
|
+
rails (3.0.1)
|
50
|
+
actionmailer (= 3.0.1)
|
51
|
+
actionpack (= 3.0.1)
|
52
|
+
activerecord (= 3.0.1)
|
53
|
+
activeresource (= 3.0.1)
|
54
|
+
activesupport (= 3.0.1)
|
55
|
+
bundler (~> 1.0.0)
|
56
|
+
railties (= 3.0.1)
|
57
|
+
railties (3.0.1)
|
58
|
+
actionpack (= 3.0.1)
|
59
|
+
activesupport (= 3.0.1)
|
60
|
+
rake (>= 0.8.4)
|
61
|
+
thor (~> 0.14.0)
|
62
|
+
rake (0.8.7)
|
63
|
+
sqlite3-ruby (1.3.1)
|
64
|
+
thor (0.14.3)
|
65
|
+
treetop (1.4.8)
|
66
|
+
polyglot (>= 0.3.1)
|
67
|
+
tzinfo (0.3.23)
|
68
|
+
|
69
|
+
PLATFORMS
|
70
|
+
ruby
|
71
|
+
|
72
|
+
DEPENDENCIES
|
73
|
+
rails (= 3.0.1)
|
74
|
+
sqlite3-ruby
|
@@ -0,0 +1,256 @@
|
|
1
|
+
== Welcome to Rails
|
2
|
+
|
3
|
+
Rails is a web-application framework that includes everything needed to create
|
4
|
+
database-backed web applications according to the Model-View-Control pattern.
|
5
|
+
|
6
|
+
This pattern splits the view (also called the presentation) into "dumb"
|
7
|
+
templates that are primarily responsible for inserting pre-built data in between
|
8
|
+
HTML tags. The model contains the "smart" domain objects (such as Account,
|
9
|
+
Product, Person, Post) that holds all the business logic and knows how to
|
10
|
+
persist themselves to a database. The controller handles the incoming requests
|
11
|
+
(such as Save New Account, Update Product, Show Post) by manipulating the model
|
12
|
+
and directing data to the view.
|
13
|
+
|
14
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
15
|
+
layer entitled Active Record. This layer allows you to present the data from
|
16
|
+
database rows as objects and embellish these data objects with business logic
|
17
|
+
methods. You can read more about Active Record in
|
18
|
+
link:files/vendor/rails/activerecord/README.html.
|
19
|
+
|
20
|
+
The controller and view are handled by the Action Pack, which handles both
|
21
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
22
|
+
are bundled in a single package due to their heavy interdependence. This is
|
23
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
24
|
+
more separate. Each of these packages can be used independently outside of
|
25
|
+
Rails. You can read more about Action Pack in
|
26
|
+
link:files/vendor/rails/actionpack/README.html.
|
27
|
+
|
28
|
+
|
29
|
+
== Getting Started
|
30
|
+
|
31
|
+
1. At the command prompt, create a new Rails application:
|
32
|
+
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
|
33
|
+
|
34
|
+
2. Change directory to <tt>myapp</tt> and start the web server:
|
35
|
+
<tt>cd myapp; rails server</tt> (run with --help for options)
|
36
|
+
|
37
|
+
3. Go to http://localhost:3000/ and you'll see:
|
38
|
+
"Welcome aboard: You're riding Ruby on Rails!"
|
39
|
+
|
40
|
+
4. Follow the guidelines to start developing your application. You can find
|
41
|
+
the following resources handy:
|
42
|
+
|
43
|
+
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
|
44
|
+
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
|
45
|
+
|
46
|
+
|
47
|
+
== Debugging Rails
|
48
|
+
|
49
|
+
Sometimes your application goes wrong. Fortunately there are a lot of tools that
|
50
|
+
will help you debug it and get it back on the rails.
|
51
|
+
|
52
|
+
First area to check is the application log files. Have "tail -f" commands
|
53
|
+
running on the server.log and development.log. Rails will automatically display
|
54
|
+
debugging and runtime information to these files. Debugging info will also be
|
55
|
+
shown in the browser on requests from 127.0.0.1.
|
56
|
+
|
57
|
+
You can also log your own messages directly into the log file from your code
|
58
|
+
using the Ruby logger class from inside your controllers. Example:
|
59
|
+
|
60
|
+
class WeblogController < ActionController::Base
|
61
|
+
def destroy
|
62
|
+
@weblog = Weblog.find(params[:id])
|
63
|
+
@weblog.destroy
|
64
|
+
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
The result will be a message in your log file along the lines of:
|
69
|
+
|
70
|
+
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
|
71
|
+
|
72
|
+
More information on how to use the logger is at http://www.ruby-doc.org/core/
|
73
|
+
|
74
|
+
Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
|
75
|
+
several books available online as well:
|
76
|
+
|
77
|
+
* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
|
78
|
+
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
|
79
|
+
|
80
|
+
These two books will bring you up to speed on the Ruby language and also on
|
81
|
+
programming in general.
|
82
|
+
|
83
|
+
|
84
|
+
== Debugger
|
85
|
+
|
86
|
+
Debugger support is available through the debugger command when you start your
|
87
|
+
Mongrel or WEBrick server with --debugger. This means that you can break out of
|
88
|
+
execution at any point in the code, investigate and change the model, and then,
|
89
|
+
resume execution! You need to install ruby-debug to run the server in debugging
|
90
|
+
mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
|
91
|
+
|
92
|
+
class WeblogController < ActionController::Base
|
93
|
+
def index
|
94
|
+
@posts = Post.find(:all)
|
95
|
+
debugger
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
So the controller will accept the action, run the first line, then present you
|
100
|
+
with a IRB prompt in the server window. Here you can do things like:
|
101
|
+
|
102
|
+
>> @posts.inspect
|
103
|
+
=> "[#<Post:0x14a6be8
|
104
|
+
@attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
|
105
|
+
#<Post:0x14a6620
|
106
|
+
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
|
107
|
+
>> @posts.first.title = "hello from a debugger"
|
108
|
+
=> "hello from a debugger"
|
109
|
+
|
110
|
+
...and even better, you can examine how your runtime objects actually work:
|
111
|
+
|
112
|
+
>> f = @posts.first
|
113
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
114
|
+
>> f.
|
115
|
+
Display all 152 possibilities? (y or n)
|
116
|
+
|
117
|
+
Finally, when you're ready to resume execution, you can enter "cont".
|
118
|
+
|
119
|
+
|
120
|
+
== Console
|
121
|
+
|
122
|
+
The console is a Ruby shell, which allows you to interact with your
|
123
|
+
application's domain model. Here you'll have all parts of the application
|
124
|
+
configured, just like it is when the application is running. You can inspect
|
125
|
+
domain models, change values, and save to the database. Starting the script
|
126
|
+
without arguments will launch it in the development environment.
|
127
|
+
|
128
|
+
To start the console, run <tt>rails console</tt> from the application
|
129
|
+
directory.
|
130
|
+
|
131
|
+
Options:
|
132
|
+
|
133
|
+
* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
|
134
|
+
made to the database.
|
135
|
+
* Passing an environment name as an argument will load the corresponding
|
136
|
+
environment. Example: <tt>rails console production</tt>.
|
137
|
+
|
138
|
+
To reload your controllers and models after launching the console run
|
139
|
+
<tt>reload!</tt>
|
140
|
+
|
141
|
+
More information about irb can be found at:
|
142
|
+
link:http://www.rubycentral.com/pickaxe/irb.html
|
143
|
+
|
144
|
+
|
145
|
+
== dbconsole
|
146
|
+
|
147
|
+
You can go to the command line of your database directly through <tt>rails
|
148
|
+
dbconsole</tt>. You would be connected to the database with the credentials
|
149
|
+
defined in database.yml. Starting the script without arguments will connect you
|
150
|
+
to the development database. Passing an argument will connect you to a different
|
151
|
+
database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
|
152
|
+
PostgreSQL and SQLite 3.
|
153
|
+
|
154
|
+
== Description of Contents
|
155
|
+
|
156
|
+
The default directory structure of a generated Ruby on Rails application:
|
157
|
+
|
158
|
+
|-- app
|
159
|
+
| |-- controllers
|
160
|
+
| |-- helpers
|
161
|
+
| |-- models
|
162
|
+
| `-- views
|
163
|
+
| `-- layouts
|
164
|
+
|-- config
|
165
|
+
| |-- environments
|
166
|
+
| |-- initializers
|
167
|
+
| `-- locales
|
168
|
+
|-- db
|
169
|
+
|-- doc
|
170
|
+
|-- lib
|
171
|
+
| `-- tasks
|
172
|
+
|-- log
|
173
|
+
|-- public
|
174
|
+
| |-- images
|
175
|
+
| |-- javascripts
|
176
|
+
| `-- stylesheets
|
177
|
+
|-- script
|
178
|
+
| `-- performance
|
179
|
+
|-- test
|
180
|
+
| |-- fixtures
|
181
|
+
| |-- functional
|
182
|
+
| |-- integration
|
183
|
+
| |-- performance
|
184
|
+
| `-- unit
|
185
|
+
|-- tmp
|
186
|
+
| |-- cache
|
187
|
+
| |-- pids
|
188
|
+
| |-- sessions
|
189
|
+
| `-- sockets
|
190
|
+
`-- vendor
|
191
|
+
`-- plugins
|
192
|
+
|
193
|
+
app
|
194
|
+
Holds all the code that's specific to this particular application.
|
195
|
+
|
196
|
+
app/controllers
|
197
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
198
|
+
automated URL mapping. All controllers should descend from
|
199
|
+
ApplicationController which itself descends from ActionController::Base.
|
200
|
+
|
201
|
+
app/models
|
202
|
+
Holds models that should be named like post.rb. Models descend from
|
203
|
+
ActiveRecord::Base by default.
|
204
|
+
|
205
|
+
app/views
|
206
|
+
Holds the template files for the view that should be named like
|
207
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
208
|
+
eRuby syntax by default.
|
209
|
+
|
210
|
+
app/views/layouts
|
211
|
+
Holds the template files for layouts to be used with views. This models the
|
212
|
+
common header/footer method of wrapping views. In your views, define a layout
|
213
|
+
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
214
|
+
Inside default.html.erb, call <% yield %> to render the view using this
|
215
|
+
layout.
|
216
|
+
|
217
|
+
app/helpers
|
218
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are
|
219
|
+
generated for you automatically when using generators for controllers.
|
220
|
+
Helpers can be used to wrap functionality for your views into methods.
|
221
|
+
|
222
|
+
config
|
223
|
+
Configuration files for the Rails environment, the routing map, the database,
|
224
|
+
and other dependencies.
|
225
|
+
|
226
|
+
db
|
227
|
+
Contains the database schema in schema.rb. db/migrate contains all the
|
228
|
+
sequence of Migrations for your schema.
|
229
|
+
|
230
|
+
doc
|
231
|
+
This directory is where your application documentation will be stored when
|
232
|
+
generated using <tt>rake doc:app</tt>
|
233
|
+
|
234
|
+
lib
|
235
|
+
Application specific libraries. Basically, any kind of custom code that
|
236
|
+
doesn't belong under controllers, models, or helpers. This directory is in
|
237
|
+
the load path.
|
238
|
+
|
239
|
+
public
|
240
|
+
The directory available for the web server. Contains subdirectories for
|
241
|
+
images, stylesheets, and javascripts. Also contains the dispatchers and the
|
242
|
+
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
243
|
+
server.
|
244
|
+
|
245
|
+
script
|
246
|
+
Helper scripts for automation and generation.
|
247
|
+
|
248
|
+
test
|
249
|
+
Unit and functional tests along with fixtures. When using the rails generate
|
250
|
+
command, template test files will be generated for you and placed in this
|
251
|
+
directory.
|
252
|
+
|
253
|
+
vendor
|
254
|
+
External libraries that the application depends on. Also includes the plugins
|
255
|
+
subdirectory. If the app has frozen rails, those gems also go here, under
|
256
|
+
vendor/rails/. This directory is in the load path.
|