testability-driver-runner 0.9.2
Sign up to get free protection for your applications and to get access to all the features.
- data/bin/sierra +19 -0
- data/bin/tdrunner +17 -0
- data/lib/tdrunner.rb +208 -0
- data/lib/tdrunner.yml +1 -0
- data/lib/tdrunner_cucumber.rb +222 -0
- data/lib/tdrunner_cucumber_runners.rb +35 -0
- data/lib/tdrunner_file_finder.rb +45 -0
- data/lib/tdrunner_monitor.rb +473 -0
- data/lib/tdrunner_profile.rb +416 -0
- data/lib/tdrunner_test_unit.rb +433 -0
- data/rakefile +135 -0
- data/readme +186 -0
- data/websi/README +243 -0
- data/websi/Rakefile +10 -0
- data/websi/app/controllers/application_controller.rb +29 -0
- data/websi/app/controllers/report_editor/test_run/cases_controller.rb +307 -0
- data/websi/app/controllers/report_editor_controller.rb +25 -0
- data/websi/app/controllers/websi_controller.rb +478 -0
- data/websi/app/controllers/websi_script.rb +26 -0
- data/websi/app/controllers/websi_support.rb +142 -0
- data/websi/app/helpers/application_helper.rb +22 -0
- data/websi/app/helpers/report_editor/report_editor_helper.rb +26 -0
- data/websi/app/helpers/report_editor/test_run/cases_helper.rb +26 -0
- data/websi/app/helpers/websi_helper.rb +21 -0
- data/websi/app/views/layouts/application.rhtml +17 -0
- data/websi/app/views/websi/execution.html.erb +28 -0
- data/websi/app/views/websi/index.html.erb +23 -0
- data/websi/app/views/websi/profile.html.erb +30 -0
- data/websi/app/views/websi/results.html.erb +30 -0
- data/websi/app/views/websi/tests.html.erb +23 -0
- data/websi/app/views/websi/weights.html.erb +16 -0
- data/websi/config/boot.rb +129 -0
- data/websi/config/database.yml +22 -0
- data/websi/config/environment.rb +60 -0
- data/websi/config/environments/development.rb +36 -0
- data/websi/config/environments/production.rb +47 -0
- data/websi/config/environments/test.rb +47 -0
- data/websi/config/initializers/backtrace_silencers.rb +26 -0
- data/websi/config/initializers/inflections.rb +29 -0
- data/websi/config/initializers/mime_types.rb +24 -0
- data/websi/config/initializers/new_rails_defaults.rb +40 -0
- data/websi/config/initializers/session_store.rb +34 -0
- data/websi/config/locales/en.yml +5 -0
- data/websi/config/routes.rb +62 -0
- data/websi/db/development.sqlite3 +0 -0
- data/websi/db/seeds.rb +26 -0
- data/websi/doc/README_FOR_APP +2 -0
- data/websi/log/development.log +0 -0
- data/websi/log/production.log +0 -0
- data/websi/log/server.log +0 -0
- data/websi/log/test.log +0 -0
- data/websi/public/report_editor/test_run/_index.html +12 -0
- data/websi/public/robots.txt +5 -0
- data/websi/public/stylesheets/tdriver_report_style.css +220 -0
- data/websi/public/tests/config/web_profile.sip +0 -0
- data/websi/public/tests/example_profile.sip +8 -0
- data/websi/public/tests/tdrunner.yml +3 -0
- data/websi/public/tests/web_profile.sip +8 -0
- data/websi/public/tests/websi_parameters.xml +4 -0
- data/websi/script/about +4 -0
- data/websi/script/console +3 -0
- data/websi/script/dbconsole +3 -0
- data/websi/script/destroy +3 -0
- data/websi/script/generate +3 -0
- data/websi/script/performance/benchmarker +3 -0
- data/websi/script/performance/profiler +3 -0
- data/websi/script/plugin +3 -0
- data/websi/script/runner +3 -0
- data/websi/script/server +3 -0
- data/websi/test/functional/websi_controller_test.rb +27 -0
- data/websi/test/performance/browsing_test.rb +28 -0
- data/websi/test/test_helper.rb +57 -0
- data/websi/test/unit/helpers/websi_helper_test.rb +23 -0
- metadata +199 -0
data/rakefile
ADDED
@@ -0,0 +1,135 @@
|
|
1
|
+
#
|
2
|
+
# rakefile for building and releasing tdrunner
|
3
|
+
|
4
|
+
@__release_mode = ENV['rel_mode']
|
5
|
+
@__release_mode = 'minor' if @__release_mode == nil
|
6
|
+
GEM_NAME='testability-driver-runner'
|
7
|
+
|
8
|
+
require 'rubygems'
|
9
|
+
require 'rake'
|
10
|
+
require 'rake/clean'
|
11
|
+
require 'rake/gempackagetask'
|
12
|
+
require 'rake/rdoctask'
|
13
|
+
require 'rake/testtask'
|
14
|
+
require 'spec/rake/spectask'
|
15
|
+
|
16
|
+
# version information
|
17
|
+
def read_version
|
18
|
+
version = "0"
|
19
|
+
File.open(Dir.getwd << '/debian/changelog') do |file|
|
20
|
+
|
21
|
+
line = file.gets
|
22
|
+
arr = line.split(')')
|
23
|
+
arr = arr[0].split('(')
|
24
|
+
arr = arr[1].split('-')
|
25
|
+
version = arr[0]
|
26
|
+
end
|
27
|
+
|
28
|
+
if(@__release_mode == 'release')
|
29
|
+
return version
|
30
|
+
elsif( @__release_mode == 'cruise' )
|
31
|
+
return version + "." + Time.now.strftime("pre%Y%m%d")
|
32
|
+
else
|
33
|
+
return version + "." + Time.now.strftime("%Y%m%d%H%M%S")
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
@__revision = read_version
|
38
|
+
puts "version " << @__revision
|
39
|
+
|
40
|
+
|
41
|
+
@__gem_version = @__revision
|
42
|
+
def make_spec
|
43
|
+
gem_version = @__gem_version
|
44
|
+
return Gem::Specification.new do |s|
|
45
|
+
s.name = GEM_NAME
|
46
|
+
s.version = "#{gem_version}"
|
47
|
+
s.has_rdoc = true
|
48
|
+
s.extra_rdoc_files = ['readme']
|
49
|
+
s.summary = 'Testability Driver test runner'
|
50
|
+
s.description = s.summary
|
51
|
+
s.author = "Testability Driver team"
|
52
|
+
s.email = "no@mail.com"
|
53
|
+
s.executables = ["tdrunner","sierra"]
|
54
|
+
s.files = %w(readme rakefile) + Dir.glob("{bin,lib,spec,websi}/**/*")
|
55
|
+
s.require_path = "lib"
|
56
|
+
s.bindir = "bin"
|
57
|
+
s.add_dependency("testability-driver")
|
58
|
+
s.add_dependency("rails", "=2.3.5")
|
59
|
+
s.add_dependency("zippy")
|
60
|
+
s.add_dependency("sqlite3-ruby", "1.2.5")
|
61
|
+
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
Rake::GemPackageTask.new(make_spec) do |p|
|
66
|
+
p.gem_spec = make_spec
|
67
|
+
p.need_tar = true
|
68
|
+
p.need_zip = true
|
69
|
+
end
|
70
|
+
|
71
|
+
Rake::RDocTask.new do |rdoc|
|
72
|
+
files =['readme', 'lib/**/*.rb']
|
73
|
+
rdoc.rdoc_files.add(files)
|
74
|
+
rdoc.main = "README" # page to start on
|
75
|
+
rdoc.title = "tdrunner Docs"
|
76
|
+
rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
|
77
|
+
rdoc.options << '--line-numbers'
|
78
|
+
end
|
79
|
+
|
80
|
+
Rake::TestTask.new do |t|
|
81
|
+
t.test_files = FileList['test/**/*.rb']
|
82
|
+
end
|
83
|
+
|
84
|
+
Spec::Rake::SpecTask.new do |t|
|
85
|
+
t.spec_files = FileList['spec/**/*.rb']
|
86
|
+
end
|
87
|
+
|
88
|
+
|
89
|
+
desc "Task for installing the generated gem"
|
90
|
+
task :gem_install do
|
91
|
+
|
92
|
+
puts "#########################################################"
|
93
|
+
puts "### Installing GEM #{GEM_NAME} ###"
|
94
|
+
puts "#########################################################"
|
95
|
+
tdrunner_gem = "tdrunner-#{@__gem_version}.gem"
|
96
|
+
if /win/ =~ RUBY_PLATFORM
|
97
|
+
cmd = "gem install pkg\\*.gem --LOCAL"
|
98
|
+
else
|
99
|
+
cmd = "gem install pkg/*.gem --LOCAL"
|
100
|
+
end
|
101
|
+
failure = system(cmd)
|
102
|
+
raise "installing #{GEM_NAME} failed" if (failure != true) or ($? != 0)
|
103
|
+
|
104
|
+
end
|
105
|
+
|
106
|
+
|
107
|
+
desc "Task for uninstalling the generated gem"
|
108
|
+
task :gem_uninstall do
|
109
|
+
|
110
|
+
puts "#########################################################"
|
111
|
+
puts "### Uninstalling GEM #{GEM_NAME} ###"
|
112
|
+
puts "#########################################################"
|
113
|
+
tdrunner_gem = "tdrunner-#{@__gem_version}.gem"
|
114
|
+
if /win/ =~ RUBY_PLATFORM
|
115
|
+
cmd = "del /F /Q pkg\\"
|
116
|
+
failure = system(cmd)
|
117
|
+
#raise "deleting #{GEM_NAME} in pkg folder failed" if (failure != true) or ($? != 0)
|
118
|
+
|
119
|
+
cmd = "gem uninstall --executables #{GEM_NAME}"
|
120
|
+
failure = system(cmd)
|
121
|
+
#raise "uninstalling #{GEM_NAME} failed" if (failure != true) or ($? != 0)
|
122
|
+
else
|
123
|
+
`gem uninstall pkg/#{tdrunner_gem}`
|
124
|
+
end
|
125
|
+
|
126
|
+
end
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
desc "Task for cruise control on Windows"
|
131
|
+
#task :cruise => ['unit_test', 'build_help', 'gem', 'gem_install', 'gem_copy_to_share'] do
|
132
|
+
task :cruise => ['gem_uninstall', 'gem', 'gem_install'] do
|
133
|
+
|
134
|
+
end
|
135
|
+
|
data/readme
ADDED
@@ -0,0 +1,186 @@
|
|
1
|
+
== tdrunner
|
2
|
+
|
3
|
+
TDRunner
|
4
|
+
|
5
|
+
Table of contents:
|
6
|
+
|
7
|
+
* Introduction
|
8
|
+
* Supported frameworks
|
9
|
+
* Installation
|
10
|
+
* TDRunner long period testing modes
|
11
|
+
* TDRunner parameters
|
12
|
+
* TDRunner Profiles
|
13
|
+
o Preprocessing with ERb
|
14
|
+
o Execution profiles
|
15
|
+
* Howto use TDRunner with Cucumber
|
16
|
+
* Howto use TDRunner with Test::Unit
|
17
|
+
|
18
|
+
Introduction
|
19
|
+
|
20
|
+
TDRunner is a tool for runnig long period testing for different opensource test frameworks. With TDRunner you can execute long period testing using different parameters and execution profiles.
|
21
|
+
Supported frameworks
|
22
|
+
|
23
|
+
* Cucumber
|
24
|
+
* Test::Unit
|
25
|
+
|
26
|
+
Installation
|
27
|
+
|
28
|
+
TDRunner is distributed in a regular rubygems application and you can install it using command.
|
29
|
+
|
30
|
+
gem install tdrunner
|
31
|
+
|
32
|
+
TDRunner long period testing modes
|
33
|
+
|
34
|
+
TDRunner supports the following LPT execution modes:
|
35
|
+
|
36
|
+
* LPT duration in hours
|
37
|
+
* LPT duration in iterations
|
38
|
+
* LPT duration in end date and time stamp
|
39
|
+
* LPT with execution profiles
|
40
|
+
|
41
|
+
TDRunner parameters
|
42
|
+
|
43
|
+
TDRunner command has two sections:
|
44
|
+
|
45
|
+
tdrunner [options] [framework command]
|
46
|
+
|
47
|
+
* [options]
|
48
|
+
o This is the section where TDRunner parameters are defined
|
49
|
+
* [framework command]
|
50
|
+
o This is the section where the test framework specific command is defined
|
51
|
+
o For cucumber the framework command shoud start with cucumber
|
52
|
+
o For Test::Unit the framework command shoud start with test_suite
|
53
|
+
|
54
|
+
* [options]
|
55
|
+
o -H i Defines how many hours tdrunner will run i as number of hours.
|
56
|
+
+ Executes tests for 1.5 hours:
|
57
|
+
|
58
|
+
tdrunner -H 1.5 cucumber features
|
59
|
+
|
60
|
+
o -i i Defines how many iterations tdrunner will run the tests i as number of iterations.
|
61
|
+
+ Repeats tests for ten iterations:
|
62
|
+
|
63
|
+
tdrunner -i 10 test_suite ts_my_test_unit_suite.rb
|
64
|
+
|
65
|
+
o -d "date time" Defines end date and time when tdrunner will stop testing.
|
66
|
+
+ Runs tests until defined date and time is reached:
|
67
|
+
|
68
|
+
tdrunner -d "12.12.2100 12:00" cucumber features
|
69
|
+
|
70
|
+
o -e execution_profile Defines tdrunner to use execution profile for running tests.
|
71
|
+
+ Runs tests using execution profile:
|
72
|
+
|
73
|
+
tdrunner -e my_execution_profile -d "12.12.2100 12:00" test_suite ts_my_test_unit_suite.rb
|
74
|
+
|
75
|
+
o --teardown Defines test unit teardown only when the testcase is failed.
|
76
|
+
+ Run test unit teardown only when the testcase is failed:
|
77
|
+
|
78
|
+
tdrunner --teardown -i 10 test_suite ts_my_test_unit_suite.rb
|
79
|
+
|
80
|
+
o -p profile_name Pull commandline arguments from tdrunner.yml which can be defined as strings or arrays.
|
81
|
+
+ Run tests using a tdrunner profile:
|
82
|
+
|
83
|
+
tdrunner -p my_profile_name
|
84
|
+
|
85
|
+
|
86
|
+
TDRunner Profiles
|
87
|
+
|
88
|
+
TDRunner lets you store and reuse commonly used tdrunner command line arguments for a project in a tdrunner.yml or tdrunner.yaml file.
|
89
|
+
|
90
|
+
NOTE: This file must be in your project�s root directory, config or .config.
|
91
|
+
|
92
|
+
For example, by having this in your config/tdrunner.yml:
|
93
|
+
|
94
|
+
default: -i 100 cucumber features
|
95
|
+
html_report: -H 1 cucumber features -f TDriverReport::CucumberListener
|
96
|
+
|
97
|
+
You can reuse the arguments listed above:
|
98
|
+
|
99
|
+
tdrunner -p html_report
|
100
|
+
|
101
|
+
Preprocessing with ERb
|
102
|
+
|
103
|
+
The tdrunner.yml file is preprocessed by ERb; this allows you to use ruby code to generate values in the tdrunner.yml file. So if you have several profiles with similar values you could do something like:
|
104
|
+
|
105
|
+
<% common = "-i 100" %>
|
106
|
+
default: <%= common %> cucumber features
|
107
|
+
html_report: <%= common %> cucumber features -f TDriverReport::CucumberListener
|
108
|
+
|
109
|
+
Execution profiles
|
110
|
+
|
111
|
+
You can define execution profiles with emphasis for test cases using parameter -e profile_file_name. When profile file is defined and it does not exist tdrunner will create the sip file for you and add the tests in to the file with default emphasis value 1.
|
112
|
+
|
113
|
+
NOTE: This file must be in your project�s root directory, config or .config.
|
114
|
+
|
115
|
+
For example, by having this in your config/calculator.sip for Test::Unit tests:
|
116
|
+
|
117
|
+
test_simple_addition(TC_Calculator)=3
|
118
|
+
test_memory_recall(TC_Calculator)=1
|
119
|
+
test_memory_store(TC_Calculator)=1
|
120
|
+
test_simple_addition(TC_Calculator)=1
|
121
|
+
|
122
|
+
Will execute test_simple_addition test three times more than the other tests. The default emphasis for tests is 1.
|
123
|
+
|
124
|
+
For example, by having this in your config/calculator.sip for cucumber tests:
|
125
|
+
|
126
|
+
features/move.feature=1
|
127
|
+
features/move_mouse.feature=3
|
128
|
+
features/press_key.feature=1
|
129
|
+
|
130
|
+
Will execute move_mouse.feature test three times more than the other tests. The default emphasis for tests is 1.
|
131
|
+
|
132
|
+
NOTE: The tests which do not have a emphasis value are added automatically in to the execution profile with default value 1.
|
133
|
+
|
134
|
+
To run tdrunner with execution profile use -e rofile_file_name parameter in your tdrunner command:
|
135
|
+
|
136
|
+
tdrunner -H 2 -e calculator test_suite my_test_unit_suite.rb
|
137
|
+
|
138
|
+
|
139
|
+
Howto use TDRunner with Cucumber
|
140
|
+
|
141
|
+
TDRunner command has two sections:
|
142
|
+
|
143
|
+
tdrunner [options] [framework command]
|
144
|
+
|
145
|
+
* [options]
|
146
|
+
o This is the section where TDRunner parameters are defined
|
147
|
+
* [framework command]
|
148
|
+
o This is the section where the test framework specific command is defined
|
149
|
+
o For cucumber the framework command shoud start with cucumber
|
150
|
+
|
151
|
+
1. Install tdrunner
|
152
|
+
2. Go to your test folder where cucumber features folder is located
|
153
|
+
3. Run command:
|
154
|
+
|
155
|
+
tdrunner -h
|
156
|
+
|
157
|
+
this displays the tdrunner help.
|
158
|
+
4. Test tdrunner by running a command:
|
159
|
+
|
160
|
+
tdrunner -i 2 cucumber your_feature_folder_name
|
161
|
+
|
162
|
+
Howto use TDRunner with Test::Unit
|
163
|
+
|
164
|
+
TDRunner command has two sections:
|
165
|
+
|
166
|
+
tdrunner [options] [framework command]
|
167
|
+
|
168
|
+
* [options]
|
169
|
+
o This is the section where TDRunner parameters are defined
|
170
|
+
* [framework command]
|
171
|
+
o This is the section where the test framework specific command is defined
|
172
|
+
o For Test::Unit the framework command shoud start with test_suite
|
173
|
+
|
174
|
+
1. Install TDriver
|
175
|
+
2. Install tdrunner
|
176
|
+
3. Go to your test folder where cucumber features folder is located
|
177
|
+
4. Run command:
|
178
|
+
|
179
|
+
tdrunner -h
|
180
|
+
|
181
|
+
this displays the tdrunner help.
|
182
|
+
5. Test tdrunner by running a command:
|
183
|
+
|
184
|
+
tdrunner -i 2 test_suite your_test_suite_file_name
|
185
|
+
|
186
|
+
|
data/websi/README
ADDED
@@ -0,0 +1,243 @@
|
|
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" templates
|
7
|
+
that are primarily responsible for inserting pre-built data in between HTML tags.
|
8
|
+
The model contains the "smart" domain objects (such as Account, Product, Person,
|
9
|
+
Post) that holds all the business logic and knows how to persist themselves to
|
10
|
+
a database. The controller handles the incoming requests (such as Save New Account,
|
11
|
+
Update Product, Show Post) by manipulating the model and directing data to the view.
|
12
|
+
|
13
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
14
|
+
layer entitled Active Record. This layer allows you to present the data from
|
15
|
+
database rows as objects and embellish these data objects with business logic
|
16
|
+
methods. You can read more about Active Record in
|
17
|
+
link:files/vendor/rails/activerecord/README.html.
|
18
|
+
|
19
|
+
The controller and view are handled by the Action Pack, which handles both
|
20
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
21
|
+
are bundled in a single package due to their heavy interdependence. This is
|
22
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
23
|
+
more separate. Each of these packages can be used independently outside of
|
24
|
+
Rails. You can read more about Action Pack in
|
25
|
+
link:files/vendor/rails/actionpack/README.html.
|
26
|
+
|
27
|
+
|
28
|
+
== Getting Started
|
29
|
+
|
30
|
+
1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
|
31
|
+
and your application name. Ex: rails myapp
|
32
|
+
2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
|
33
|
+
3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
|
34
|
+
4. Follow the guidelines to start developing your application
|
35
|
+
|
36
|
+
|
37
|
+
== Web Servers
|
38
|
+
|
39
|
+
By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
|
40
|
+
with a variety of other web servers.
|
41
|
+
|
42
|
+
Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
|
43
|
+
suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
|
44
|
+
getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
|
45
|
+
More info at: http://mongrel.rubyforge.org
|
46
|
+
|
47
|
+
Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
|
48
|
+
Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
|
49
|
+
FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
|
50
|
+
|
51
|
+
== Apache .htaccess example for FCGI/CGI
|
52
|
+
|
53
|
+
# General Apache options
|
54
|
+
AddHandler fastcgi-script .fcgi
|
55
|
+
AddHandler cgi-script .cgi
|
56
|
+
Options +FollowSymLinks +ExecCGI
|
57
|
+
|
58
|
+
# If you don't want Rails to look in certain directories,
|
59
|
+
# use the following rewrite rules so that Apache won't rewrite certain requests
|
60
|
+
#
|
61
|
+
# Example:
|
62
|
+
# RewriteCond %{REQUEST_URI} ^/notrails.*
|
63
|
+
# RewriteRule .* - [L]
|
64
|
+
|
65
|
+
# Redirect all requests not available on the filesystem to Rails
|
66
|
+
# By default the cgi dispatcher is used which is very slow
|
67
|
+
#
|
68
|
+
# For better performance replace the dispatcher with the fastcgi one
|
69
|
+
#
|
70
|
+
# Example:
|
71
|
+
# RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
|
72
|
+
RewriteEngine On
|
73
|
+
|
74
|
+
# If your Rails application is accessed via an Alias directive,
|
75
|
+
# then you MUST also set the RewriteBase in this htaccess file.
|
76
|
+
#
|
77
|
+
# Example:
|
78
|
+
# Alias /myrailsapp /path/to/myrailsapp/public
|
79
|
+
# RewriteBase /myrailsapp
|
80
|
+
|
81
|
+
RewriteRule ^$ index.html [QSA]
|
82
|
+
RewriteRule ^([^.]+)$ $1.html [QSA]
|
83
|
+
RewriteCond %{REQUEST_FILENAME} !-f
|
84
|
+
RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
|
85
|
+
|
86
|
+
# In case Rails experiences terminal errors
|
87
|
+
# Instead of displaying this message you can supply a file here which will be rendered instead
|
88
|
+
#
|
89
|
+
# Example:
|
90
|
+
# ErrorDocument 500 /500.html
|
91
|
+
|
92
|
+
ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
|
93
|
+
|
94
|
+
|
95
|
+
== Debugging Rails
|
96
|
+
|
97
|
+
Sometimes your application goes wrong. Fortunately there are a lot of tools that
|
98
|
+
will help you debug it and get it back on the rails.
|
99
|
+
|
100
|
+
First area to check is the application log files. Have "tail -f" commands running
|
101
|
+
on the server.log and development.log. Rails will automatically display debugging
|
102
|
+
and runtime information to these files. Debugging info will also be shown in the
|
103
|
+
browser on requests from 127.0.0.1.
|
104
|
+
|
105
|
+
You can also log your own messages directly into the log file from your code using
|
106
|
+
the Ruby logger class from inside your controllers. Example:
|
107
|
+
|
108
|
+
class WeblogController < ActionController::Base
|
109
|
+
def destroy
|
110
|
+
@weblog = Weblog.find(params[:id])
|
111
|
+
@weblog.destroy
|
112
|
+
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
|
113
|
+
end
|
114
|
+
end
|
115
|
+
|
116
|
+
The result will be a message in your log file along the lines of:
|
117
|
+
|
118
|
+
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
|
119
|
+
|
120
|
+
More information on how to use the logger is at http://www.ruby-doc.org/core/
|
121
|
+
|
122
|
+
Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
|
123
|
+
|
124
|
+
* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
|
125
|
+
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
|
126
|
+
|
127
|
+
These two online (and free) books will bring you up to speed on the Ruby language
|
128
|
+
and also on programming in general.
|
129
|
+
|
130
|
+
|
131
|
+
== Debugger
|
132
|
+
|
133
|
+
Debugger support is available through the debugger command when you start your Mongrel or
|
134
|
+
Webrick server with --debugger. This means that you can break out of execution at any point
|
135
|
+
in the code, investigate and change the model, AND then resume execution!
|
136
|
+
You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
|
137
|
+
Example:
|
138
|
+
|
139
|
+
class WeblogController < ActionController::Base
|
140
|
+
def index
|
141
|
+
@posts = Post.find(:all)
|
142
|
+
debugger
|
143
|
+
end
|
144
|
+
end
|
145
|
+
|
146
|
+
So the controller will accept the action, run the first line, then present you
|
147
|
+
with a IRB prompt in the server window. Here you can do things like:
|
148
|
+
|
149
|
+
>> @posts.inspect
|
150
|
+
=> "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
|
151
|
+
#<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
|
152
|
+
>> @posts.first.title = "hello from a debugger"
|
153
|
+
=> "hello from a debugger"
|
154
|
+
|
155
|
+
...and even better is that you can examine how your runtime objects actually work:
|
156
|
+
|
157
|
+
>> f = @posts.first
|
158
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
159
|
+
>> f.
|
160
|
+
Display all 152 possibilities? (y or n)
|
161
|
+
|
162
|
+
Finally, when you're ready to resume execution, you enter "cont"
|
163
|
+
|
164
|
+
|
165
|
+
== Console
|
166
|
+
|
167
|
+
You can interact with the domain model by starting the console through <tt>script/console</tt>.
|
168
|
+
Here you'll have all parts of the application configured, just like it is when the
|
169
|
+
application is running. You can inspect domain models, change values, and save to the
|
170
|
+
database. Starting the script without arguments will launch it in the development environment.
|
171
|
+
Passing an argument will specify a different environment, like <tt>script/console production</tt>.
|
172
|
+
|
173
|
+
To reload your controllers and models after launching the console run <tt>reload!</tt>
|
174
|
+
|
175
|
+
== dbconsole
|
176
|
+
|
177
|
+
You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
|
178
|
+
You would be connected to the database with the credentials defined in database.yml.
|
179
|
+
Starting the script without arguments will connect you to the development database. Passing an
|
180
|
+
argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
|
181
|
+
Currently works for mysql, postgresql and sqlite.
|
182
|
+
|
183
|
+
== Description of Contents
|
184
|
+
|
185
|
+
app
|
186
|
+
Holds all the code that's specific to this particular application.
|
187
|
+
|
188
|
+
app/controllers
|
189
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
190
|
+
automated URL mapping. All controllers should descend from ApplicationController
|
191
|
+
which itself descends from ActionController::Base.
|
192
|
+
|
193
|
+
app/models
|
194
|
+
Holds models that should be named like post.rb.
|
195
|
+
Most models will descend from ActiveRecord::Base.
|
196
|
+
|
197
|
+
app/views
|
198
|
+
Holds the template files for the view that should be named like
|
199
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
|
200
|
+
syntax.
|
201
|
+
|
202
|
+
app/views/layouts
|
203
|
+
Holds the template files for layouts to be used with views. This models the common
|
204
|
+
header/footer method of wrapping views. In your views, define a layout using the
|
205
|
+
<tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
|
206
|
+
call <% yield %> to render the view using this layout.
|
207
|
+
|
208
|
+
app/helpers
|
209
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are generated
|
210
|
+
for you automatically when using script/generate for controllers. Helpers can be used to
|
211
|
+
wrap functionality for your views into methods.
|
212
|
+
|
213
|
+
config
|
214
|
+
Configuration files for the Rails environment, the routing map, the database, and other dependencies.
|
215
|
+
|
216
|
+
db
|
217
|
+
Contains the database schema in schema.rb. db/migrate contains all
|
218
|
+
the sequence of Migrations for your schema.
|
219
|
+
|
220
|
+
doc
|
221
|
+
This directory is where your application documentation will be stored when generated
|
222
|
+
using <tt>rake doc:app</tt>
|
223
|
+
|
224
|
+
lib
|
225
|
+
Application specific libraries. Basically, any kind of custom code that doesn't
|
226
|
+
belong under controllers, models, or helpers. This directory is in the load path.
|
227
|
+
|
228
|
+
public
|
229
|
+
The directory available for the web server. Contains subdirectories for images, stylesheets,
|
230
|
+
and javascripts. Also contains the dispatchers and the default HTML files. This should be
|
231
|
+
set as the DOCUMENT_ROOT of your web server.
|
232
|
+
|
233
|
+
script
|
234
|
+
Helper scripts for automation and generation.
|
235
|
+
|
236
|
+
test
|
237
|
+
Unit and functional tests along with fixtures. When using the script/generate scripts, template
|
238
|
+
test files will be generated for you and placed in this directory.
|
239
|
+
|
240
|
+
vendor
|
241
|
+
External libraries that the application depends on. Also includes the plugins subdirectory.
|
242
|
+
If the app has frozen rails, those gems also go here, under vendor/rails/.
|
243
|
+
This directory is in the load path.
|