tork 19.2.2 → 19.3.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -34,33 +34,33 @@ Tork runs your tests as they change, in parallel:
34
34
 
35
35
  * You can override the modular `tork*` programs with your own in $PATH.
36
36
 
37
- * You can remotely control other `tork*` programs using `tork-remote`.
37
+ * You can remotely control other `tork*` programs using tork-remote(1).
38
38
 
39
39
  ### Architecture
40
40
 
41
- Following UNIX philosophy, tork is composed of simple text-based programs that
42
- *do one thing well*. As a result, you could even create your own tork user
43
- interface by wrapping `tork-driver` appropriately!
41
+ Following UNIX philosophy, Tork is composed of simple text-based programs that
42
+ *do one thing well*. As a result, you can even create your own user interface
43
+ for Tork by wrapping the tork-driver(1) program appropriately!
44
44
 
45
- * `tork` is an interactive command-line user interface for `tork-driver`
46
- * `tork-herald` monitors current directory tree and reports changed files
47
- * `tork-driver` drives the engine according to the herald's observations
48
- * `tork-engine` tells master to run tests and keeps track of test results
49
- * `tork-master` absorbs test execution overhead and forks to run your tests
50
- * `tork-remote` remotely controls any tork program running in the same `pwd`
51
- * `tork-notify` shows how to receive and process messages from tork programs
45
+ * tork(1) is an interactive command-line user interface for tork-driver(1)
46
+ * tork-herald(1) monitors current directory tree and reports changed files
47
+ * tork-driver(1) drives the engine according to the herald's observations
48
+ * tork-engine(1) tells master to run tests and keeps track of test results
49
+ * tork-master(1) absorbs test execution overhead and forks to run your tests
50
+ * tork-remote(1) remotely controls any Tork program running in the same `pwd`
51
+ * tork-notify(1) shows how to receive and process messages from Tork programs
52
52
 
53
53
  When the herald observes that files in or beneath the current directory have
54
54
  been written to, it tells the driver, which then commands the master to fork a
55
55
  worker process to run the tests affected by those changed files. This is all
56
56
  performed *automatically*. However, to run a test file *manually*, you can:
57
57
 
58
- 1. Simply save the file! When you do, tork tries to figure out which tests
58
+ 1. Simply save the file! When you do, Tork tries to figure out which tests
59
59
  inside your newly saved test file have changed (using diff and regexps)
60
60
  and then attempts to run just those. To make it run *all* tests in your
61
61
  saved file, simply save the file *again* without changing it.
62
62
 
63
- 2. Type `t` followed by a space and the file you want to run into `tork`:
63
+ 2. Type `t` followed by a space and the file you want to run into tork(1):
64
64
 
65
65
  # run all of test/some_test.rb
66
66
  t test/some_test.rb
@@ -68,7 +68,7 @@ performed *automatically*. However, to run a test file *manually*, you can:
68
68
  # run lines 4, 33, and 21 of test/some_test.rb
69
69
  t test/some_test.rb 4 33 21
70
70
 
71
- 3. Send a `["run_test_file"]` message to `tork-engine` using `tork-remote`:
71
+ 3. Send a `["run_test_file"]` message to tork-engine(1) using tork-remote(1):
72
72
 
73
73
  # run all of test/some_test.rb
74
74
  echo run_test_file test/some_test.rb | tork-remote tork-engine
@@ -85,13 +85,13 @@ performed *automatically*. However, to run a test file *manually*, you can:
85
85
  * Ruby 1.8.7 or 1.9.3 or newer.
86
86
 
87
87
  * Operating system that supports POSIX signals and the `fork()` system call.
88
- To check if your system qualifies, launch `irb` and enter the following:
88
+ To check if your system qualifies, launch irb(1) and enter the following:
89
89
 
90
90
  Process.respond_to? :fork # must be true
91
91
  Signal.list.key? 'TERM' # must be true
92
92
  Signal.list.key? 'KILL' # must be true
93
93
 
94
- * To make the `tork-herald` program's filesystem monitoring more efficient:
94
+ * To make the tork-herald(1) program's filesystem monitoring more efficient:
95
95
 
96
96
  gem install rb-inotify # linux
97
97
  gem install rb-fsevent # macosx
@@ -1,3 +1,19 @@
1
+ ## Version 19.3.0 (2013-05-05)
2
+
3
+ Minor:
4
+
5
+ * tork-engine(1) now emits `["idle"]` messages whenever all tests
6
+ have finished running and no more tests are queued for running.
7
+
8
+ Thanks to Jonathan Cairns for requesting this feature in GH-50:
9
+ https://github.com/sunaku/tork/issues/50
10
+
11
+ Other:
12
+
13
+ * add man/man0 subdir containing README and VERSION
14
+
15
+ * README: use manpage xrefs for linking in HTML mans
16
+
1
17
  ## Version 19.2.2 (2013-05-04)
2
18
 
3
19
  This release makes Tork resilient to `Errno::EADDRINUSE` errors that may occur
data/bin/tork CHANGED
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # TORK 1 2013-05-04 19.2.2
4
+ # TORK 1 2013-05-05 19.3.0
5
5
 
6
6
  ## NAME
7
7
 
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # TORK-DRIVER 1 2013-05-04 19.2.2
4
+ # TORK-DRIVER 1 2013-05-05 19.3.0
5
5
 
6
6
  ## NAME
7
7
 
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # TORK-ENGINE 1 2013-05-04 19.2.2
4
+ # TORK-ENGINE 1 2013-05-05 19.3.0
5
5
 
6
6
  ## NAME
7
7
 
@@ -53,6 +53,9 @@ from stdin and performs the actions described respectively.
53
53
  This program prints the following messages, which are single-line JSON arrays,
54
54
  to stdout.
55
55
 
56
+ `["idle"]`
57
+ All tests have finished running and no tests are queued for running either.
58
+
56
59
  `["pass_now_fail",` *test_file*`,` *message*`]`
57
60
  A previously passing *test_file* has now failed. See *message* for details.
58
61
 
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # TORK-HERALD 1 2013-05-04 19.2.2
4
+ # TORK-HERALD 1 2013-05-05 19.3.0
5
5
 
6
6
  ## NAME
7
7
 
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # TORK-MASTER 1 2013-05-04 19.2.2
4
+ # TORK-MASTER 1 2013-05-05 19.3.0
5
5
 
6
6
  ## NAME
7
7
 
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # TORK-NOTIFY 1 2013-05-04 19.2.2
4
+ # TORK-NOTIFY 1 2013-05-05 19.3.0
5
5
 
6
6
  ## NAME
7
7
 
@@ -87,6 +87,7 @@ protected
87
87
  @queued_test_files.delete file
88
88
 
89
89
  when :pass
90
+ finished = true
90
91
  # only whole test file runs should qualify as pass
91
92
  if line_numbers.empty?
92
93
  was_fail = @failed_test_files.delete? file
@@ -95,11 +96,13 @@ protected
95
96
  end
96
97
 
97
98
  when :fail
99
+ finished = true
98
100
  was_pass = @passed_test_files.delete? file
99
101
  now_fail = @failed_test_files.add? file
100
102
  send @clients, [:pass_now_fail, file, message] if was_pass and now_fail
101
103
  end
102
104
 
105
+ send @clients, [:idle] if finished and @queued_test_files.empty?
103
106
  else
104
107
  super
105
108
  end
@@ -1,3 +1,3 @@
1
1
  module Tork
2
- VERSION = "19.2.2"
2
+ VERSION = "19.3.0"
3
3
  end
@@ -0,0 +1,189 @@
1
+ _______ _______
2
+ ___ /___________ /__
3
+ _ __/ __ \ __/ /_/
4
+ / /_/ /_/ / / / ,\
5
+ \__/\____/_/ /_/|_\
6
+ >>>------>
7
+
8
+ # _Test with fork_
9
+
10
+ Tork runs your tests as they change, in parallel:
11
+
12
+ 1. Absorbs test execution overhead into a master process.
13
+
14
+ 2. Forks to inherit overhead and run test files in parallel.
15
+
16
+ 3. Avoids running unchanged tests inside changed test files.
17
+
18
+ ## Features
19
+
20
+ * No configuration necessary: simply run `tork` to start testing *now!*
21
+
22
+ * Runs test files in parallel using fork for multi-core/CPU utilization.
23
+
24
+ * Tests *changes* your Ruby application for rapid TDD: avoids running (1)
25
+ unchanged test files and (2) unchanged tests inside changed test files.
26
+
27
+ * Supports MiniTest, Test::Unit, RSpec, and *any testing framework* that (1)
28
+ exits with a nonzero status to indicate test failures and (2) is loaded by
29
+ your application's `test/test_helper.rb` or `spec/spec_helper.rb` file.
30
+
31
+ * Logs the output from your tests into separate files: one log per test.
32
+
33
+ * Configurable through Ruby scripts in your current working directory.
34
+
35
+ * You can override the modular `tork*` programs with your own in $PATH.
36
+
37
+ * You can remotely control other `tork*` programs using tork-remote(1).
38
+
39
+ ### Architecture
40
+
41
+ Following UNIX philosophy, Tork is composed of simple text-based programs that
42
+ *do one thing well*. As a result, you can even create your own user interface
43
+ for Tork by wrapping the tork-driver(1) program appropriately!
44
+
45
+ * tork(1) is an interactive command-line user interface for tork-driver(1)
46
+ * tork-herald(1) monitors current directory tree and reports changed files
47
+ * tork-driver(1) drives the engine according to the herald's observations
48
+ * tork-engine(1) tells master to run tests and keeps track of test results
49
+ * tork-master(1) absorbs test execution overhead and forks to run your tests
50
+ * tork-remote(1) remotely controls any Tork program running in the same `pwd`
51
+ * tork-notify(1) shows how to receive and process messages from Tork programs
52
+
53
+ When the herald observes that files in or beneath the current directory have
54
+ been written to, it tells the driver, which then commands the master to fork a
55
+ worker process to run the tests affected by those changed files. This is all
56
+ performed *automatically*. However, to run a test file *manually*, you can:
57
+
58
+ 1. Simply save the file! When you do, Tork tries to figure out which tests
59
+ inside your newly saved test file have changed (using diff and regexps)
60
+ and then attempts to run just those. To make it run *all* tests in your
61
+ saved file, simply save the file *again* without changing it.
62
+
63
+ 2. Type `t` followed by a space and the file you want to run into tork(1):
64
+
65
+ # run all of test/some_test.rb
66
+ t test/some_test.rb
67
+
68
+ # run lines 4, 33, and 21 of test/some_test.rb
69
+ t test/some_test.rb 4 33 21
70
+
71
+ 3. Send a `["run_test_file"]` message to tork-engine(1) using tork-remote(1):
72
+
73
+ # run all of test/some_test.rb
74
+ echo run_test_file test/some_test.rb | tork-remote tork-engine
75
+
76
+ # run lines 4, 33, and 21 of test/some_test.rb
77
+ echo run_test_file test/some_test.rb 4 33 21 | tork-remote tork-engine
78
+
79
+ ## Installation
80
+
81
+ gem install tork
82
+
83
+ ### Prerequisites
84
+
85
+ * Ruby 1.8.7 or 1.9.3 or newer.
86
+
87
+ * Operating system that supports POSIX signals and the `fork()` system call.
88
+ To check if your system qualifies, launch irb(1) and enter the following:
89
+
90
+ Process.respond_to? :fork # must be true
91
+ Signal.list.key? 'TERM' # must be true
92
+ Signal.list.key? 'KILL' # must be true
93
+
94
+ * To make the tork-herald(1) program's filesystem monitoring more efficient:
95
+
96
+ gem install rb-inotify # linux
97
+ gem install rb-fsevent # macosx
98
+
99
+ ### Development
100
+
101
+ git clone git://github.com/sunaku/tork
102
+ cd tork
103
+ bundle install
104
+ bundle exec tork --help # run it directly
105
+ bundle exec rake --tasks # packaging tasks
106
+
107
+ ## Usage
108
+
109
+ ### At the command line
110
+
111
+ tork --help
112
+
113
+ You can add line editing, history, and filename completion:
114
+
115
+ rlwrap -c tork
116
+
117
+ You can control tork(1) interactively from another terminal:
118
+
119
+ tork-remote tork-engine
120
+ # type your commands here, one per line.
121
+ # press Control-D to exit tork-remote(1)
122
+
123
+ You can also do the same non-interactively using a pipeline:
124
+
125
+ # run lines 4, 33, and 21 of test/some_test.rb
126
+ echo run_test_file test/some_test.rb 4 33 21 | tork-remote tork-engine
127
+
128
+ You can monitor your test processes from another terminal:
129
+
130
+ watch 'pgrep -f ^tork | xargs -r ps u'
131
+
132
+ ### With MiniTest
133
+
134
+ MiniTest 1.3.2 and newer contain a bug where `minitest/autorun` won't run any
135
+ tests if someone calls `Kernel#exit` explicitly or simply loads a library
136
+ (such as RSpec) which makes the call implicitly. Use Tork 19.0.2+ to avoid
137
+ this problem or [apply this patch to the minitest library](
138
+ https://github.com/seattlerb/minitest/pull/183/files ) to fix the problem.
139
+
140
+ ### With RSpec
141
+
142
+ RSpec 2.9.0 and newer contain a bug where RSpec's autorun helper won't run any
143
+ specs if someone calls `Kernel#exit` explicitly or simply loads a library
144
+ (such as Test::Unit) which makes the call implicitly. Use Tork 19.0.2+ to
145
+ avoid this problem or [apply this patch to the rspec-core library](
146
+ https://github.com/rspec/rspec-core/pull/720/files ) to fix the problem.
147
+
148
+ RSpec 2.8.0 and older contain [a bug](
149
+ https://github.com/sunaku/tork/issues/31 ) where a nonzero exit status (caused
150
+ by an uncaught exception) is overridden by RSpec's `Kernel#at_exit` handler to
151
+ be zero, thereby falsely indicating that a spec had passed. [This patch](
152
+ https://github.com/rspec/rspec-core/pull/569/files ) fixes the problem.
153
+
154
+ ### With [Ruby on Rails]
155
+
156
+ For Rails 3 or newer, use the `rails` configuration helper *before* the `test`
157
+ or `spec` helpers. Otherwise your test helper will load Rails *before* the
158
+ specified `rails` configuration helper has a chance to disable class caching!
159
+
160
+ For older Rails, make sure your `config/environments/test.rb` file contains:
161
+
162
+ config.cache_classes = false
163
+
164
+ To use SQLite3 as your test database, install its [in-memory database
165
+ adapter][memory_test_fix]. Otherwise, you *might* face these errors:
166
+
167
+ > SQLite3::BusyException: database is locked
168
+
169
+ > cannot start a transaction within a transaction
170
+
171
+ ## Configuration
172
+
173
+ Tork looks for a configuration directory named `.tork/` inside its working
174
+ directory. The configuration directory contains specially-named Ruby scripts,
175
+ within which you can query and modify the settings for various tork programs.
176
+ See the "FILES" sections in the manual pages of tork programs for details.
177
+
178
+ Note that tork *does not* automatically reload changes from your configuration
179
+ directory. Consequently, you must restart tork if your configuration changes.
180
+
181
+ ## License
182
+
183
+ Released under the ISC license. See the LICENSE file for details.
184
+
185
+ [factory_girl]: https://github.com/thoughtbot/factory_girl
186
+ [memory_test_fix]: https://github.com/stepahn/memory_test_fix
187
+ [parallel_tests]: https://github.com/grosser/parallel_tests
188
+ [Ruby on Rails]: http://rubyonrails.org
189
+ [Cucumber]: https://cukes.info
@@ -0,0 +1,1312 @@
1
+ ## Version 19.3.0 (2013-05-05)
2
+
3
+ Minor:
4
+
5
+ * tork-engine(1) now emits `["idle"]` messages whenever all tests
6
+ have finished running and no more tests are queued for running.
7
+
8
+ Thanks to Jonathan Cairns for requesting this feature in GH-50:
9
+ https://github.com/sunaku/tork/issues/50
10
+
11
+ Other:
12
+
13
+ * add man/man0 subdir containing README and VERSION
14
+
15
+ * README: use manpage xrefs for linking in HTML mans
16
+
17
+ ## Version 19.2.2 (2013-05-04)
18
+
19
+ This release makes Tork resilient to `Errno::EADDRINUSE` errors that may occur
20
+ sometimes, intermittently, when test execution overhead is being reabsorbed.
21
+
22
+ Patch:
23
+
24
+ * server: retry until the socket opens successfully
25
+
26
+ Other:
27
+
28
+ * include md2man rake tasks in developer's rakefile
29
+
30
+ ## Version 19.2.1 (2013-02-08)
31
+
32
+ Patch:
33
+
34
+ * GH-46: allow reassigning `$tork_*` variable values. Thanks to Joe
35
+ Escalante for reminding me to fix this issue.
36
+
37
+ * GH-48: disable class caching at the ActiveSupport level for Devise.
38
+ Thanks to Ryan Ahearn for fixing this issue and to Jonathan Cairns for
39
+ reporting it.
40
+
41
+ ## Version 19.2.0 (2012-12-30)
42
+
43
+ Minor:
44
+
45
+ * Add "devise" configuration helper that adds support for testing Rails
46
+ applications that use the Devise authentication framework. Thanks to Ryan
47
+ Ahearn for this contribution.
48
+
49
+ Patch:
50
+
51
+ * gemspec: upgrade to *listen* 0.7.0 to fix issue #43. Thanks to Ryan
52
+ Ahearn for reporting this issue and helping debug it, and to Thibaud
53
+ Guillaume-Gentil for fixing this issue upstream in the *listen* library.
54
+
55
+ * Fix `undefined method 'path' for nil` error on socket file removal.
56
+
57
+ ## Version 19.1.0 (2012-12-12)
58
+
59
+ Minor:
60
+
61
+ * tork-driver: don't run overhead files as test files
62
+
63
+ Patch:
64
+
65
+ * rails: run dependent tests when `app/views/*` change
66
+
67
+ * Clear FactoryGirl sequences and traits on fork in the `factory_girl`
68
+ configuration helper. Thanks to Ryan Ahearn for this contribution.
69
+
70
+ * server: fix clean up of socket files upon exit
71
+
72
+ ## Version 19.0.2 (2012-11-07)
73
+
74
+ Patch:
75
+
76
+ * Monkeypatch `at_exit()` to fix RSpec and MiniTest:
77
+
78
+ https://github.com/rspec/rspec-core/pull/720
79
+
80
+ https://github.com/seattlerb/minitest/pull/183
81
+
82
+ Other:
83
+
84
+ * README: document RSpec 2.9.0+ autorun skipping bug
85
+
86
+ * README: MiniTest 1.3.2+ also has autorun skip bug
87
+
88
+ ## Version 19.0.1 (2012-10-26)
89
+
90
+ Patch:
91
+
92
+ * Support testing projects that have both test/ and spec/ directories.
93
+
94
+ I assumed that users would only have either test/ or spec/ but not both.
95
+ Do you know what happens when a test/ is run by RSpec or vice versa? :-)
96
+
97
+ Thanks to Kyle Peyton for reporting this issue.
98
+
99
+ * Automatically load the "autorun" helpers for RSpec and MiniTest.
100
+
101
+ RSpec users are accustomed to not having `require "rspec/autorun"` in
102
+ their spec/spec_helper.rb file because they use the rspec(1) executable
103
+ to run their tests. This commit makes things Just Work for them again.
104
+
105
+ Other:
106
+
107
+ * test whether input is JSON by actually parsing it
108
+
109
+ * server: use Set instead of Array for faster lookup
110
+
111
+ ## Version 19.0.0 (2012-10-17)
112
+
113
+ Major:
114
+
115
+ * The `.tork.rb` configuration file has been replaced by the `.tork/`
116
+ directory, which contains specially-named Ruby scripts. Refer to the
117
+ `TORK_CONFIGS` environment variable in tork(1) for more information.
118
+
119
+ * The `Tork::Config` object has been replaced by various data structures in
120
+ the `Tork::` namespace. See the "FILES" sections in the manual pages of
121
+ tork programs for information on the data structures that replaced it.
122
+
123
+ * `Tork::Config.test_event_hooks` has been removed. Instead, you must now
124
+ monitor the STDOUT of tork-master(1) or tork-engine(1) either directly
125
+ or indirectly, via tork-remote(1), and react to their status messages.
126
+ See the tork-notify(1) program for an example of how to implement this.
127
+
128
+ * tork(1): 't' now runs a specified test, whereas 'a' runs all tests.
129
+
130
+ * tork-engine(1): the `run_test_file` command now takes line numbers as a
131
+ variable-length list of arguments (varargs) rather than as an array.
132
+
133
+ * tork-engine(1): the `run_test_file` command now runs an entire test file
134
+ when zero is given as one of the line numbers to be run.
135
+
136
+ * tork-master(1): the `load` command is no longer accepted. Instead, you
137
+ must specify load paths and overhead files in the `.tork/master.rb` file.
138
+
139
+ * The `TORK_CONFIGS` env-var is now a colon delimited list of directories.
140
+
141
+ * The `tork/client` library has been removed. The threaded IO and popen()
142
+ wrappers that it provided have been replaced by the powerful IO.select().
143
+
144
+ Minor:
145
+
146
+ * tork(1): allow user to specify arguments after command key
147
+
148
+ * tork(1): add 'k' to stop all currently running tests with SIGKILL
149
+
150
+ * add tork-remote(1) to remotely control any tork program. This feature is
151
+ made possible by the awesome power of IO.select() and UNIX domain sockets.
152
+
153
+ * add tork-notify(1) as example of using tork-remote(1) and tork-engine(1)
154
+
155
+ * tork-engine(1): add `["run_test_files"]` command to run multiple files
156
+
157
+ * tork-engine(1): emit edge-triggered `pass_now_fail` and `fail_now_pass`
158
+ events to notify you about changes in a test file's pass/fail status.
159
+
160
+ * typing Control-D now breaks tork programs out of `Tork::Server#loop()`
161
+
162
+ Patch:
163
+
164
+ * tork-master(1): stop workers with SIGKILL when quitting
165
+
166
+ Other:
167
+
168
+ * tork(1): document parameters for `t` and `s` commands
169
+
170
+ * README: add tip about rlwrap for better interactive
171
+
172
+ * README: simplify watch command using pgrep & xargs
173
+
174
+ * README: use standard bundle exec; no `--binstubs`
175
+
176
+ ## Version 18.2.4 (2012-10-10)
177
+
178
+ Other:
179
+
180
+ * GH-39: upgrade listen gem version to fix a bug in OSX.
181
+ Thanks to Adam Grant for reporting this issue.
182
+
183
+ ## Version 18.2.3 (2012-09-26)
184
+
185
+ Patch:
186
+
187
+ * Restored support for building Tork from its gemspec under Ruby 1.8.
188
+ Thanks to Ohno Shin'ichi for reporting this issue and contributing a
189
+ preliminary fix.
190
+
191
+ * Add resilience against failed command dispatch in `Tork::Server#loop()`.
192
+
193
+ Other:
194
+
195
+ * It's not worth rescuing Interrupt only to exit silently.
196
+ Let the user see stack traces when they press Control-C.
197
+
198
+ * Update old comments about SIGCHLD handler, which was
199
+ replaced by reaping threads quite a few releases ago.
200
+
201
+ * Use $0 instead of hard-coding the program name.
202
+
203
+ ## Version 18.2.2 (2012-07-11)
204
+
205
+ Patch:
206
+
207
+ * GH-35: resume dispatched but not yet started tests.
208
+
209
+ After reabsorbing overhead, we need to resume previously dispatched test
210
+ files that have not yet finished running. This includes the waiting set
211
+ (dispatched but not yet running) as well as the running set (dispatched
212
+ and already started running). Otherwise, we encounter a bug where test
213
+ files in the waiting set can NEVER be run again!
214
+
215
+ ## Version 18.2.1 (2012-07-05)
216
+
217
+ Patch:
218
+
219
+ * GH-37: switch from Guard::Listener to Listen gem.
220
+ Thanks to Jesse Cooke for reporting this issue.
221
+
222
+ Other:
223
+
224
+ * gemspec: need to provide .0 suffix for ~> operator.
225
+
226
+ * gemspec: LICENSE file contains UTF-8 author names.
227
+
228
+ ## Version 18.2.0 (2012-03-27)
229
+
230
+ Minor:
231
+
232
+ * Emit warnings when commands cannot be performed. This improves the user
233
+ experience by giving them immediate feedback. For example, if you issue
234
+ the "rerun_failed_tests" command and no tests have failed yet, you will
235
+ now see a warning message that explains the situation. Thanks to
236
+ NagaChaitanya Vellanki (@chaitanyav) for suggesting this change.
237
+
238
+ Patch:
239
+
240
+ * GH-32: Restore support for Selenium and Capybara by replacing the global
241
+ SIGCHLD handler in tork-master(1) with individual threads, one per forked
242
+ worker process. Thanks to Bjørn Trondsen (@Sharagoz) for reporting this
243
+ issue and verifying the fix.
244
+
245
+ * README: Recommend a newer fork of the "memory_test_fix" Rails plugin.
246
+
247
+ ## Version 18.1.0 (2012-02-26)
248
+
249
+ Minor:
250
+
251
+ * Add `tork/config/coverage` configuration helper for Ruby 1.9, which prints
252
+ a coverage report at the end of your log file in YAML format. The report
253
+ is a hash containing the following information per each loaded Ruby file
254
+ that exist in or beneath the current working directory:
255
+
256
+ * :grade - percentage of C0 code coverage for source lines of code
257
+ * :nsloc - total number of source lines of code in the file
258
+ * :holes - line numbers of source lines that were not covered
259
+
260
+ ## Version 18.0.1 (2012-02-13)
261
+
262
+ Alert:
263
+
264
+ * If you're on Ruby 1.9, please use 1.9.3 or newer because 1.9.2 is
265
+ known to segfault under RSpec and Rails. See GH-30 and GH-32.
266
+
267
+ Patch:
268
+
269
+ * GH-27: Cucumber features now run correctly under RSpec. Thanks to Scott
270
+ Radcliff for reporting this issue and to David Burrows for solving it!
271
+
272
+ * tork(1): fix undefined method `strip' for nil:NilClass error.
273
+
274
+ * tork/config: ignore directories given as configuration files.
275
+
276
+ ## Version 18.0.0 (2012-02-06)
277
+
278
+ Alert:
279
+
280
+ * RSpec 2.8.0 and older contain [a bug](
281
+ https://github.com/sunaku/tork/issues/31 ) where a nonzero
282
+ exit status (caused by an uncaught exception) is overridden
283
+ by RSpec's `Kernel#at_exit` handler to be zero, thereby
284
+ falsely indicating that a spec had passed. [This patch](
285
+ https://github.com/rspec/rspec-core/pull/569/files) fixes the
286
+ problem. Thanks to Gumaro Melendez for reporting this issue.
287
+
288
+ Major:
289
+
290
+ * Dropped first parameter to `Tork::Config::test_file_globbers`.
291
+
292
+ * GH-31: tork-master now emits separate exit code and info.
293
+ Update your `Tork::Config::test_event_hooks` accordingly.
294
+
295
+ * tork/server: switch from modules to class inheritance.
296
+
297
+ * tork/config: switch to Struct to prevent misspellings.
298
+
299
+ Minor:
300
+
301
+ * tork-driver now recursively expands dependent test files while globbing.
302
+
303
+ * Extracted bookkeeping stuff from tork-driver into tork-engine component.
304
+
305
+ Other:
306
+
307
+ * tork/config: do not reabsorb when .tork.rb
308
+ changes. Since the configuration is loaded in
309
+ multiple processes, it is difficult to reload
310
+ the configuration on the fly without adding
311
+ significant complexity to Tork. Instead, it's
312
+ easier to accept the limitation that you must
313
+ restart Tork if you change your configuration.
314
+
315
+ * GH-29: bump guard version requirement to v1 series.
316
+
317
+ * Improve documentation; revise markdown; clean up.
318
+
319
+ ## Version 17.1.0 (2012-01-30)
320
+
321
+ Minor:
322
+
323
+ * Added `Tork::Config.test_event_hooks` configuration option.
324
+
325
+ * Added `tork/config/notify` configuration helper for receiving
326
+ edge-triggered notifications (via libnotify, growl, or
327
+ xmessage) about changes in test files' pass/fail status.
328
+
329
+ * Added `tork/config/factory_girl` configuration helper for properly
330
+ clearing factory definitions before forking and then finding them after
331
+ forking to avoid `FactoryGirl::DuplicateDefinitionError`. (Mark Hayes)
332
+
333
+ * Lambda functions in `Tork::Config.test_file_globbers` can now return
334
+ multiple globs in an array, in addition to just a single glob or `nil`.
335
+
336
+ * Added support for the MiniTest convention of naming test files as
337
+ `test/**/test_*.rb` and `spec/**/spec_*.rb`. (Jose Pablo Barrantes)
338
+
339
+ ## Version 17.0.1 (2012-01-29)
340
+
341
+ Patch:
342
+
343
+ * tork-herald(1) *sometimes* reported changed test files twice.
344
+
345
+ * tork/driver: only whole test file runs should qualify as pass.
346
+
347
+ * tork/config/cucumber: only set ARGV for `*.feature` test files.
348
+
349
+ * Tork::Client::Transceiver needs to stop both TX & RX loops.
350
+
351
+ Other:
352
+
353
+ * tork/driver: store test file lists in Set, not Array.
354
+
355
+ * HISTORY: use single-word change-set descriptions.
356
+
357
+ ## Version 17.0.0 (2012-01-27)
358
+
359
+ Major:
360
+
361
+ * tork-herald(1) now emits batches of single-line JSON arrays instead of
362
+ printing one (raw) path per line. This makes IPC uniform across Tork.
363
+
364
+ * tork-master(1) now emits log_file and worker_number in status messages.
365
+
366
+ * The order of parameters for before/after fork hooks has been changed to
367
+ better reflect the order of items in tork-master(1)'s status messages.
368
+
369
+ * The old order was: worker_number, log_file, test_file, line_numbers.
370
+
371
+ * The new order is: test_file, line_numbers, log_file, worker_number.
372
+
373
+ Minor:
374
+
375
+ * GH-24: add `tork/config/dotlog` configuration helper to "hide" log files.
376
+ (Nicolas Fouché)
377
+
378
+ * GH-25: add `tork/config/logdir` configuration helper to isolate log files.
379
+ (Jose Pablo Barrantes)
380
+
381
+ * tork(1) now strips all whitespace from your input, in case you pressed
382
+ spacebar or tab a few times, by accident, before entering your command.
383
+
384
+ Other:
385
+
386
+ * tork/client: Replace write lock with queue to support SIGCHLD handler.
387
+
388
+ The SIGCHLD handler in tork-master(1) can be triggered at any time, even
389
+ in the middle of writing to the standard output stream! Locking access
390
+ to the output stream in normal code (outside the signal handler) would
391
+ freeze the program because the signal handler, waiting for the lock to
392
+ be released, would never return!
393
+
394
+ One solution is to maintain a thread-safe queue of outgoing items that
395
+ need to be written to the output stream. Both normal code and the
396
+ signal handler can quickly push an outgoing item onto the queue and
397
+ proceed with their business. A separate thread can then have the sole
398
+ responsibility of (and access to) continually writing those outgoing
399
+ items to the output stream.
400
+
401
+ * README: revise instructions, reorganize document, and other improvements.
402
+
403
+ ## Version 16.0.0 (2012-01-25)
404
+
405
+ Major:
406
+
407
+ * Drop the `Tork::Config.test_name_extractor` configuration option.
408
+
409
+ * Pass line numbers instead of test names to before/after fork hooks.
410
+
411
+ * Pass $~ (MatchData) to `Tork::Config::test_file_globbers` functions.
412
+
413
+ Minor:
414
+
415
+ * tork/config/cucumber: only run changed scenarios in changed features.
416
+
417
+ Other:
418
+
419
+ * README: update instructions on running Tork directly from Git clone.
420
+
421
+ ## Version 15.1.0 (2012-01-25)
422
+
423
+ Minor:
424
+
425
+ * GH-19: add `tork cucumber` for running cucumber features.
426
+
427
+ Patch:
428
+
429
+ * tork/config/rails: support Rails 2 and don't assume AR is used. (Benjamin
430
+ Quorning)
431
+
432
+ * tork/config: settings from configuration helpers specified in
433
+ $TORK_CONFIGS should override settings from the `.tork.rb` file.
434
+
435
+ * README: need to set $PATH to run this project from a git clone.
436
+
437
+ * LICENSE: give copyright to major contributors only.
438
+ See <http://stackoverflow.com/questions/1497756>.
439
+ Also added forgotten Luke Wendling to the list.
440
+
441
+ ## Version 15.0.1 (2012-01-24)
442
+
443
+ Patch:
444
+
445
+ * GH-21: Ruby 1.9 class_eval() is smarter than 1.8.
446
+
447
+ * GH-20: forgot `require 'thread'` for Mutex class. (Jesse Cooke)
448
+
449
+ Other:
450
+
451
+ * tork(1): fix shadowed variable names. (Jose Pablo Barrantes)
452
+
453
+ * GH-22: fix command to build & install gem from source.
454
+
455
+ * GH-22: add m2dman as development dependency in gemspec.
456
+
457
+ * GH-18: windows not supported; lacks fork & SIGCHLD.
458
+
459
+ * README: spruce up introduction and features list.
460
+
461
+ * README: missed a testr => tork rename in watch cmd.
462
+
463
+ * README: add tip about Guard's FS watching backends.
464
+
465
+ ## Version 15.0.0 (2012-01-23)
466
+
467
+ Major:
468
+
469
+ * This project has been renamed from TestR to Tork (test with fork) in order
470
+ to better compete with rival projects, namely Spork! >:-) Credit goes to
471
+ Brian D. Burns for thinking of this most succinct & awesome project name!
472
+ He also created the snazzy ASCII-art logo featured in the project README.
473
+
474
+ * tork(1): rename `r` command, which runs all tests, to `t`, for *t*ork.
475
+
476
+ ## Version 14.3.0 (2012-01-20)
477
+
478
+ Minor:
479
+
480
+ * testr(1): notify user while dispatching their commands. This is especially
481
+ useful when the "rerun_passed_test_files" command has been dispatched but
482
+ there are no passed test files, so nothing happens and from the user's
483
+ perspective: TestR sucks because it's unresponsive.
484
+
485
+ * config/testr/rails: Reopen connections in forked workers to fix errors:
486
+
487
+ Mysql2::Error: MySQL server has gone away
488
+ PGError: connection not open
489
+
490
+ Thanks to Spencer Steffen for [contributing this solution](
491
+ https://github.com/sunaku/tork/issues/14#issuecomment-3539470).
492
+
493
+ * testr-driver(1): document the "over" status message in manual page.
494
+
495
+ Other:
496
+
497
+ * testr-driver(1): keep same herald; only replace master.
498
+
499
+ * testr(1): shorten code for loop break on quit command.
500
+
501
+ * server: rename `@upstream` to `@client` for coherence.
502
+
503
+ * Can pass lambda and proc with block to `<<` method.
504
+
505
+ * Explain `$0` override at the start of bin/ scripts.
506
+
507
+ * LICENSE: credit our most recent contributors.
508
+
509
+ ## Version 14.2.0 (2012-01-16)
510
+
511
+ Minor:
512
+
513
+ * Add ability to run `testr rails` without needing a `.testr.rb` file.
514
+
515
+ * testr(1) no longer shows command menu at startup. Press ENTER to see it.
516
+
517
+ * testr(1) now notifies you before absorbing overhead at startup.
518
+
519
+ Patch:
520
+
521
+ * testr(1) now accepts death silently when Control-C is pressed.
522
+
523
+ ## Version 14.1.3 (2012-01-13)
524
+
525
+ Patch:
526
+
527
+ * Add support Guard v0.9.0 and newer in `testr-herald`. (Jose Pablo
528
+ Barrantes)
529
+
530
+ Other:
531
+
532
+ * Tighten version constraints for gem dependencies to avoid future
533
+ breakages.
534
+
535
+ ## Version 14.1.2 (2012-01-09)
536
+
537
+ Minor:
538
+
539
+ * Don't consider partial test file pass as full pass.
540
+
541
+ Other:
542
+
543
+ * Upgrade to binman 3 for better bundler support.
544
+
545
+ ## Version 14.1.1 (2011-12-07)
546
+
547
+ Patch:
548
+
549
+ * Do not fail when given test file no longer exists.
550
+
551
+ * Make xUnit `--name` option regexp case-insensitive.
552
+
553
+ * RSpec does not accept regexp for `--example` option;
554
+ see https://github.com/rspec/rspec-core/issues/445
555
+ and https://github.com/dchelimsky/rspec/issues/44
556
+
557
+ * Ruby 187 does not have Symbol#upcase() method.
558
+
559
+ Other:
560
+
561
+ * README: add another SQLite3 error to known issues.
562
+ Thanks to Luke Wendling for contributing this patch.
563
+
564
+ * README: add a section explaining usage and theory.
565
+
566
+ * README: show example earlier in factory_girl tip.
567
+
568
+ * README: update lines of code statistic: 372 SLOC.
569
+
570
+ * Better variable naming for self-documentation.
571
+
572
+ * Upgrade to binman 2.0.0 for UNIX man pages.
573
+
574
+ ## Version 14.1.0 (2011-11-03)
575
+
576
+ Minor:
577
+
578
+ * Make servers responsive to quit request (SIGTERM) from upstream.
579
+
580
+ This change lets the user quit testr-master(1) while it is loading
581
+ test execution overhead (which can be a lengthy, blocking operation).
582
+
583
+ By sending a signal to the server, we don't have to wait for it to
584
+ finish processing its current command before seeing our :quit command.
585
+
586
+ * Add embedded BinMan manual pages to bin scripts. All TestR scripts now
587
+ have a `--help` option which displays their UNIX manual page. Try it!
588
+
589
+ The single-line JSON message protocol used by these scripts is now
590
+ documented in their manual pages, so you should have everything you
591
+ need to create *your own custom user interface to TestR* if you wish! :-)
592
+
593
+ Patch:
594
+
595
+ * SIGCHLD does not awaken main thread in Ruby 1.9.3p0.
596
+
597
+ Other:
598
+
599
+ * Simplify watch(1) ps(1) process title monitoring.
600
+
601
+ * Testr: tell user to press ENTER after command key.
602
+
603
+ * README: add tip on loading factory_girl factories.
604
+
605
+ ## Version 14.0.3 (2011-10-11)
606
+
607
+ Patch:
608
+
609
+ * Forgot to migrate the `testr/config/rails` configuration helper to use the
610
+ new TestR configuration parameter names.
611
+
612
+ ## Version 14.0.2 (2011-10-11)
613
+
614
+ Patch:
615
+
616
+ * Fix updating passed/failed test files bookkeeping. Once a test file
617
+ failed, it was (incorrectly) always considered failed, even if it passed
618
+ later on.
619
+
620
+ * Do not requeue test files that are waiting to run.
621
+
622
+ Other:
623
+
624
+ * Rename `*.md` files to `*.markdown` to avoid ambiguity.
625
+
626
+ ## Version 14.0.1 (2011-10-10)
627
+
628
+ Patch:
629
+
630
+ * Use blue/red for pass/fail instead of green/red to accommodate the color
631
+ blind.
632
+
633
+ * Incorrect test name regexp was passed down to Test::Unit. This broke
634
+ focused testing, where only changed tests in a changed test file are run.
635
+
636
+ Other:
637
+
638
+ * Make `testr-master` wait for killed worker processes before exiting.
639
+
640
+ ## Version 14.0.0 (2011-10-09)
641
+
642
+ Major:
643
+
644
+ * Renamed this project and its resources from test-loop to TestR.
645
+
646
+ * Renamed the `reabsorb_file_globs` configuration parameter to
647
+ `reabsorb_file_greps`. It now contains regular expressions.
648
+
649
+ * Renamed the `test_file_matchers` configuration parameter to
650
+ `test_file_globbers`. Its keys are now regular expressions.
651
+
652
+ * Renamed the `test_name_parser` configuration parameter to
653
+ `test_name_extractor`.
654
+
655
+ * Renamed the `max_concurrent_tests` configuration parameter to
656
+ `max_forked_workers`.
657
+
658
+ * Renamed the `before_each_test` configuration parameter to
659
+ `after_fork_hooks`. Its function parameters have also changed.
660
+
661
+ * Removed the `delay_per_iteration` and `after_each_test` configuration
662
+ parameters.
663
+
664
+ * Removed the `test/loop/notify` and `test-loop/coco` libraries.
665
+
666
+ Minor:
667
+
668
+ * The file system is no longer polled to detect modified files. Instead, it
669
+ is monitored for file modification events in a portable and efficient
670
+ manner using the [Guard](https://github.com/guard/guard) library.
671
+
672
+ * The number of processors on your system is automatically detected for the
673
+ `max_forked_workers` configuration parameter.
674
+
675
+ * Added `overhead_load_paths`, `all_test_file_globs`, and
676
+ `before_fork_hooks` configuration parameters.
677
+
678
+ * Added ability to re-run passed and failed tests in the `testr` script.
679
+
680
+ Other:
681
+
682
+ * The monolithic `test-loop` script has been replaced by several smaller
683
+ ones that communicate with each other using single-line JSON messages via
684
+ their standard input & output streams. See "Architecture" in the README.
685
+
686
+ * Now using Bundler to manage development dependencies and gem packaging.
687
+
688
+ ## Version 13.0.1 (2011-09-21)
689
+
690
+ Other:
691
+
692
+ * Forgot to include `test/loop/coco` preset in gem package.
693
+
694
+ * Forgot to mention `test/loop/parallel_tests` preset in README.
695
+
696
+ ## Version 13.0.0 (2011-08-24)
697
+
698
+ Major:
699
+
700
+ * Pass worker sequence number as the last argument to lambda functions in
701
+ `Test::Loop.before_each_test` and `Test::Loop.after_each_test` arrays.
702
+
703
+ Minor:
704
+
705
+ * In the `test/loop/rails` configuration preset:
706
+
707
+ * Automatically test a controller when its model or factory is modified.
708
+
709
+ * Warn the user if Railtie (Rails 3) is not available for automatic
710
+ disabling of Rails' class caching mechanism under the test environment.
711
+
712
+ * Add `test/loop/parallel_tests` configuration preset for parallel_tests
713
+ gem. (Corné Verbruggen)
714
+
715
+ * Assign rotating sequence numbers to workers so that you can handle parallel
716
+ processes like connecting to separate databases better. (Corné
717
+ Verbruggen)
718
+
719
+ Other:
720
+
721
+ * README: move configuration presets above options.
722
+
723
+ * Eliminate 1 SLOC: .rb extension used in file glob.
724
+
725
+ * Turn off executable bit on loop.rb file mode.
726
+
727
+ * Pass child ENV directly to exec() for atomicity.
728
+
729
+ ## Version 12.3.1 (2011-07-19)
730
+
731
+ Patch:
732
+
733
+ * Binary data could not be stored in environment variable values.
734
+
735
+ Other:
736
+
737
+ * Forgot to add Jacob Helwig to the gemspec's authors list.
738
+
739
+ ## Version 12.3.0 (2011-07-19)
740
+
741
+ Minor:
742
+
743
+ * Add `Test::Loop::max_concurrent_tests` configuration parameter to limit
744
+ the number of test files run concurrently (default 4). Otherwise, with
745
+ large test suites, we could end up swamping the machine running the tests
746
+ by forking hundreds of test files at once. (Jacob Helwig)
747
+
748
+ * Rails: add matcher for `test/factories/*_factory.rb`.
749
+
750
+ Other:
751
+
752
+ * ENV returns a Hash with duplicate/frozen keys/values. (Brian D. Burns)
753
+
754
+ * Use Marshal to propagate resume_files to reabsorb.
755
+
756
+ * Store test_files in a Set instead of an Array.
757
+
758
+ ## Version 12.2.0 (2011-06-01)
759
+
760
+ * Prevent empty test suite run in master process. (Brian D. Burns)
761
+
762
+ * Report test execution statistics in `test/loop/notify` preset as
763
+ requested by Juan G. Hurtado..
764
+
765
+ * Add `test/loop/coco` preset for integrating the [Coco code coverage
766
+ library](http://lkdjiin.github.com/coco/).
767
+
768
+ ## Version 12.1.0 (2011-04-29)
769
+
770
+ Minor:
771
+
772
+ * Add `Test::Loop.delay_per_iteration` parameter to control the number of
773
+ seconds (or fractions thereof) to sleep in between test-loop iterations.
774
+
775
+ ## Version 12.0.4 (2011-04-29)
776
+
777
+ Patch:
778
+
779
+ * Reabsorb overhead when user's configuration file changes. (Brian D. Burns
780
+ and Daniel Pittman)
781
+
782
+ * `Thread.new { system() }` really is backgrounded so `fork { system() }` is
783
+ not necessary! [This issue](https://github.com/sunaku/test-loop/issues/5)
784
+ was solved by upgrading to the newer 2.6.38.4-1 Linux kernel on my system.
785
+
786
+ ## Version 12.0.3 (2011-04-25)
787
+
788
+ Patch:
789
+
790
+ * Fix SIGCHLD handling and test completion reporting (Daniel Pittman).
791
+
792
+ We need to reap all ready children in SIGCHLD, not just the first, and
793
+ should not be reporting completion in the signal handler.
794
+
795
+ On a fast machine, or where there is a slow hook executed at the
796
+ completion of a test run, more than one test child can terminate before
797
+ the SIGCHLD handler is invoked, or while it is running.
798
+
799
+ In that event we will only get another SIGCHLD when a new child
800
+ terminates, not to signal that there was more than one current
801
+ termination. We need to loop to collect all terminated children during
802
+ each invocation of the handler.
803
+
804
+ Since we don't know which child terminated, we wait on any terminated
805
+ child with NOHANG, until it informs us that there are no more zombies
806
+ hanging about.
807
+
808
+ Doing all the work of finishing the test case, cleaning up, and running
809
+ user hooks inside the SIGCHLD handler block was pretty slow. This could
810
+ lead to a big pile-up of children that needed to be cleaned up, especially
811
+ if the user hook did something like run another external process to signal
812
+ completion.
813
+
814
+ Moving the heavy work of completion outside the signal handler makes the
815
+ whole thing a lot faster, and less likely to bump into the low limit for
816
+ per-user processes on Mac OS-X.
817
+
818
+ * Send SIGTERM to each worker PGID to kill workers (Brian D. Burns).
819
+
820
+ Using Process.setsid() in the workers establishes each process "as a new
821
+ session and process group leader". So, the SIGTERM sent to the master's
822
+ process group was not recieved by the workers. kill_workers was simply
823
+ waiting for the workers to finish.
824
+
825
+ * Revert "skip at_exit() handlers defined in master process".
826
+
827
+ This reverts commit 0a0837f0b7ec92810e1c81d7506f2c8309f25f62 which was
828
+ originally written to skip the reporting of an empty test suite (master
829
+ does not load test files, workers do) by Test::Unit and Minitest in the
830
+ master process.
831
+
832
+ Such a harmless annoyance should not warrant the crippling of at_exit in
833
+ the master process because that would inhibit its valid uses as well:
834
+
835
+ > "UNIX was not designed to stop you from doing stupid things, because
836
+ > that would also stop you from doing clever things." ~Doug Gwyn
837
+
838
+ * `Thread.new { system() }` is not really backgrounded so `fork()` instead!
839
+ Many thanks to Brian D. Burns and Daniel Pittman for helping solve [this
840
+ issue](https://github.com/sunaku/test-loop/issues/5).
841
+
842
+ ## Version 12.0.2 (2011-04-21)
843
+
844
+ Patch:
845
+
846
+ * Consider DB schema dump file as overhead in Rails.
847
+
848
+ * Do not consider test factories as overhead in Rails.
849
+
850
+ * Run test files when test factory files change in Rails.
851
+
852
+ Other:
853
+
854
+ * Detach worker from master's terminal device sooner.
855
+
856
+ * All required signals must be present in irb check.
857
+
858
+ * Prevent ps(1) from truncating lines to $TERM width.
859
+
860
+ * Retain ps(1) column header in watch command output.
861
+
862
+ * Begin parameter descriptions with the noun itself.
863
+
864
+ ## Version 12.0.1 (2011-04-20)
865
+
866
+ Patch:
867
+
868
+ * Restore support for Ruby 1.8.7.
869
+
870
+ * Allow user's test execution overhead to fork.
871
+
872
+ Other:
873
+
874
+ * Freeze master's ENV properly; keep resume key.
875
+
876
+ * Remove completed test from running list sooner.
877
+
878
+ * Add instructions to check for POSIX prerequisites.
879
+
880
+ * Support multiple test-loop instances in watch command.
881
+
882
+ ## Version 12.0.0 (2011-04-19)
883
+
884
+ Major:
885
+
886
+ * You must now explicitly `require 'test/loop/rails'` for Rails support
887
+ because we can only *automatically* apply our Railtie (to disable class
888
+ caching) after the overhead has been loaded, and by then it's too late:
889
+ your models are already loaded & cached by the Rails environment.
890
+
891
+ * Your tests can no longer read from the user's terminal (master's STDIN);
892
+ instead they will read from an empty stream (the reading end of IO.popen).
893
+
894
+ Patch:
895
+
896
+ * Replace threads with SIGCHLD for reporting test results.
897
+
898
+ This fixes deadlock errors that sometimes occurred when the user's chosen
899
+ test library tried to print something to STDOUT/STDERR (even though those
900
+ streams were redirected to a log file in the worker process).
901
+
902
+ Thanks to Brian D. Burns for suggesting and verifying that the use of
903
+ threads to monitor workers was the culprit behind the deadlocks errors.
904
+
905
+ * Ctrl-C did not raise Interrupt in my Rails 3 test suite.
906
+
907
+ Other:
908
+
909
+ * Ensure a clean ENV when reabsorbing overhead. Environment variables set
910
+ by your test execution overhead are not propagated to subsequent
911
+ reabsorptions. (Brian D. Burns)
912
+
913
+ * Call `setsid()` to detach worker from master's terminal.
914
+ <http://stackoverflow.com/questions/1740308#1740314>
915
+
916
+ * Mutex is not needed since we only use GIL'ed array methods.
917
+ <http://www.ruby-forum.com/topic/174086#762788>
918
+
919
+ * Remove redundant STDOUT coercion after loading user's testing library.
920
+
921
+ * Further simplify `Test::Loop.run()` by higher-order programming.
922
+
923
+ * Add LICENSE file to gem package.
924
+
925
+ * Add prerequisites section about POSIX environment.
926
+
927
+ * Add tip about annihilating test-loop processes.
928
+
929
+ * Fix markdown formatting.
930
+
931
+ ## Version 11.0.1 (2011-04-14)
932
+
933
+ Patch:
934
+
935
+ * Only attempt to define Railtie if the current Rails version supports it.
936
+
937
+ ## Version 11.0.0 (2011-04-14)
938
+
939
+ Major:
940
+
941
+ * The `test/loop/rails` preset has been internalized and is now applied
942
+ automatically if your test execution overhead includes Ruby on Rails.
943
+
944
+ Minor:
945
+
946
+ * If you are using Rails 3, test-loop will automatically set
947
+ `config.cache_classes = false` for your test environment. (Brian D.
948
+ Burns)
949
+
950
+ Patch:
951
+
952
+ * Avoid deadlock errors when printing output from Test::Unit and MiniTest.
953
+ (Brian D. Burns)
954
+
955
+ `write': deadlock detected (fatal)
956
+
957
+ * Signaled worker termination is neither pass nor fail.
958
+ Do not treat it as a failure by printing the log file.
959
+
960
+ * Ignore SIGINT in workers; only master must honor it.
961
+
962
+ ## Version 10.0.1 (2011-04-08)
963
+
964
+ Patch:
965
+
966
+ * Workers must ignore SIGTSTP, otherwise master waits forever before
967
+ exiting.
968
+
969
+ * Unregister trap in workers upon first reception instead of racing to
970
+ unregister the trap handlers inherited from the master process.
971
+
972
+ * Prevent uncaught throw error on subsequent Ctrl-C.
973
+
974
+ * Simpler solution for terminating loop upon Ctrl-C.
975
+
976
+ ## Version 10.0.0 (2011-04-06)
977
+
978
+ Major:
979
+
980
+ * The `Test::Loop.before_each_test` and `Test::Loop.after_each_test`
981
+ parameters are arrays now.
982
+
983
+ ## Version 9.4.0 (2011-04-06)
984
+
985
+ Minor:
986
+
987
+ * Allow lambda functions in `Test::Loop.test_file_matchers` to return `nil`
988
+ so that you can exclude certain tests from being executed. (Brian D.
989
+ Burns)
990
+
991
+ * Prefix worker process title with "test-loop" for easier ps(1)
992
+ searchability. The monitoring command in the README is now simplified to
993
+ the following:
994
+
995
+ watch 'ps xf | grep test-loop | sed 1,3d'
996
+
997
+ Patch:
998
+
999
+ * Skip `at_exit()` when exiting master process. This prevents an empty test
1000
+ from being run when exiting the loop after having processed a test/spec
1001
+ helper that loads the Test::Unit library. (Brian D. Burns)
1002
+
1003
+ Other:
1004
+
1005
+ * Use throw/catch to break loop instead of raising SystemExit exception.
1006
+
1007
+ * Trap SIGTERM with IGNORE/DEFAULT instead of using a closure in master.
1008
+
1009
+ * Unregister master's custom signal handlers inside worker processes.
1010
+
1011
+ * Separate configuration parameters into subsections in README.
1012
+
1013
+ ## Version 9.3.0 (2011-04-01)
1014
+
1015
+ Minor:
1016
+
1017
+ * Resume currently running tests--as well as those currently needing to be
1018
+ run--after reabsorbing test execution overhead. (Brian D. Burns)
1019
+
1020
+ * Stop currently running tests (and wait for them to finish) before
1021
+ reabsorbing overhead. This greatly improves responsiveness because worker
1022
+ processes are no longer there to compete with the new master process for
1023
+ system resources.
1024
+
1025
+ * Notify user when running all tests and when exiting. (Brian D. Burns)
1026
+
1027
+ * Notify user when overhead changes instead of when restarting the loop.
1028
+
1029
+ * Use ANSI clear line command to erase control-key combinations outputted by
1030
+ shells such as BASH and ZSH in test-loop's output. (Brian D. Burns)
1031
+
1032
+ Patch:
1033
+
1034
+ * `@last_ran_at` was being set during every iteration of the loop. This is
1035
+ problematic when Ruby's `Time.now` is more precise than your filesystem's
1036
+ modification timestamp. For example, in the ext3 filesystem under Linux,
1037
+ file modification timestamps have a precision of 1 second. (Brian D.
1038
+ Burns)
1039
+
1040
+ * Exit gently on SIGINT by sending SIGTERM to all worker processes and then
1041
+ running waitall(), instead of sending SIGKILL to the entire process group.
1042
+ As a result, test-loop no longer exits with a non-zero status upon SIGINT.
1043
+
1044
+ * Remove 'ansi' gem dependency. (Brian D. Burns)
1045
+
1046
+ Other:
1047
+
1048
+ * Add tip on deleting logs for passing tests. (Brian D. Burns)
1049
+
1050
+ * Add tip on monitoring test processes with watch(1) in README.
1051
+
1052
+ ## Version 9.2.0 (2011-03-28)
1053
+
1054
+ * Extract Rails-specific configuration to 'test/loop/rails' sublibrary.
1055
+
1056
+ * Add 'test/loop/notify' sublibrary for OSD notifications on failures.
1057
+
1058
+ ## Version 9.1.1 (2011-03-15)
1059
+
1060
+ * $0 does not work from RubyGems wrapper executable.
1061
+ Thanks to Brian D. Burns for reporting this issue.
1062
+
1063
+ * Add information about sqlite3 errors & workaround in README.
1064
+
1065
+ ## Version 9.1.0 (2011-02-23)
1066
+
1067
+ * Print the status of completed tests in ANSI color.
1068
+
1069
+ * Print the failure log of failing tests to STDERR.
1070
+
1071
+ * `$?` is not defined when Errno::ECHILD is raised.
1072
+
1073
+ ## Version 9.0.1 (2011-02-18)
1074
+
1075
+ * Shield normal output from control-key combos printed into the terminal.
1076
+
1077
+ * Do not print worker PID in status messages because every test file has
1078
+ exactly one worker anyway.
1079
+
1080
+ * Reabsorb on any `*.{rb,yml}` changes beneath the `config/` directory.
1081
+
1082
+ * Do not reabsorb overhead when the configuration file changes.
1083
+
1084
+ * Add `after_each_test` example for failure-only notifications.
1085
+
1086
+ ## Version 9.0.0 (2011-02-15)
1087
+
1088
+ * Remove SIGUSR1 for killing worker processes.
1089
+
1090
+ * Handle Ctrl-Z signal from the very beginning.
1091
+
1092
+ ## Version 8.0.0 (2011-02-12)
1093
+
1094
+ * Move configuration into `Test::Loop` object itself.
1095
+
1096
+ * Allow loading `bin/test-loop` into IRB for testing.
1097
+
1098
+ * Simplify initialization of default configuration.
1099
+
1100
+ * Revise README: delete needless cruft; add examples.
1101
+
1102
+ * Add example on extending `before_each_test` function.
1103
+
1104
+ * DRY `sleep 1` commands into higher order function.
1105
+
1106
+ * Accept > 80 character lines in some cases.
1107
+
1108
+ * Freeze more constant values against modification.
1109
+
1110
+ ## Version 7.0.1 (2011-02-10)
1111
+
1112
+ * Fix minitest deadlock issues with I/O redirection.
1113
+
1114
+ * Do not signal to restart loop when overhead changes.
1115
+
1116
+ ## Version 7.0.0 (2011-02-10)
1117
+
1118
+ * Switch from shell-script style to modular Ruby style in the source code.
1119
+ This yields more lines of code, but the result is much easier to read.
1120
+
1121
+ * Replace the `$test_loop_config` global variable with the
1122
+ `Test::Loop::Config` constant.
1123
+
1124
+ * Do not wait for all test runs to finish before detecting more changes.
1125
+
1126
+ * Replace the `after_all_tests` parameter with `after_each_test`.
1127
+
1128
+ * Capture test run output into separate log files; one log per test file.
1129
+
1130
+ * The `before_each_test` function is now passed the path to a log file.
1131
+
1132
+ * Register signal handlers at the earliest and act upon signals immediately.
1133
+
1134
+ * Previously, SIGQUIT did not work if there were no test helpers.
1135
+
1136
+ * Send the SIGUSR1 signal to terminate workers and their subprocesses.
1137
+
1138
+ * Break long lines at 80 characters in the source code.
1139
+
1140
+ ## Version 6.0.0 (2011-02-09)
1141
+
1142
+ * Only consider `{test,spec}_helper.rb` as overhead, not all `*_helper.rb`.
1143
+
1144
+ * Give the user freedom to inspect and change the default configuration by
1145
+ storing it in a `$test_loop_config` global variable instead of returning
1146
+ the user's desired configuration as a hash from the user's configuration
1147
+ file.
1148
+
1149
+ * Change the method signature of the `after_all_tests` lambda function.
1150
+
1151
+ * Add support for growl and xmessage in the `after_all_tests` example.
1152
+
1153
+ * Add note about disabling class caching in Rails test environment.
1154
+
1155
+ * Add better explanation for the `test_file_matchers` example.
1156
+
1157
+ ## Version 5.0.3 (2011-01-25)
1158
+
1159
+ * Use "diff/lcs" library instead of "diff" for RSpec compatibility.
1160
+
1161
+ Thanks to millisami for reporting this bug:
1162
+ https://github.com/sunaku/test-loop/issues/3
1163
+
1164
+ * Terminate worker processes when user presses Control-C.
1165
+
1166
+ * Reabsorb when bundler is run, not when Gemfile changes.
1167
+
1168
+ ## Version 5.0.2 (2011-01-19)
1169
+
1170
+ * Support string interpolations that yield empty strings in test names.
1171
+
1172
+ * Accept extra characters before test name in test definition:
1173
+ * Whitespace between `def` and `test_` in traditional test methods.
1174
+ * Opening parenthesis between test name and test definition keyword.
1175
+
1176
+ * Mention that diff gem is necessary for manual git clone installation.
1177
+
1178
+ ## Version 5.0.1 (2011-01-18)
1179
+
1180
+ * Sanitize string interpolation in parsed test names.
1181
+
1182
+ * Remove useless use of #map; result is not reused.
1183
+
1184
+ * Mention parallelism and revise the introduction.
1185
+
1186
+ * DRY the mentioning of .test-loop file in README.
1187
+
1188
+ ## Version 5.0.0 (2011-01-17)
1189
+
1190
+ * The configuration file must now yield a Ruby
1191
+ hash instead of polluting the global Object
1192
+ private environment with instance variables.
1193
+
1194
+ * Shortened the `:source_file_glob_to_test_file_mapping`
1195
+ configuration parameter name to `:test_file_matchers`.
1196
+
1197
+ ## Version 4.0.1 (2011-01-14)
1198
+
1199
+ * Print how much time it took to run all tests.
1200
+
1201
+ * Do not print test file before loading because it
1202
+ is hard to follow parallel test execution anyway.
1203
+
1204
+ * Print rescued top-level exceptions to STDERR.
1205
+
1206
+ * Strip surrounding spaces from parsed test names.
1207
+
1208
+ * Use long options when passing test names in ARGV.
1209
+
1210
+ * Only prepend lib/, test/, and spec/ to $LOAD_PATH.
1211
+
1212
+ ## Version 4.0.0 (2011-01-13)
1213
+
1214
+ * Only run changed tests inside changed test files.
1215
+
1216
+ * Run tests in parallel: one worker per test file.
1217
+
1218
+ * Print the status of each test file after execution.
1219
+
1220
+ * Rename `@after_test_execution` to `@after_all_tests`
1221
+ and change its function signature.
1222
+
1223
+ * Clean up implementation and improve documentation.
1224
+
1225
+ ## Version 3.0.2 (2011-01-11)
1226
+
1227
+ * Reabsorb overhead upon Gemfile changes (Rails 3).
1228
+
1229
+ * Try to recover from all kinds of exceptions.
1230
+
1231
+ ## Version 3.0.1 (2011-01-05)
1232
+
1233
+ * Be resilient to $0 and ARGV being changed by tests.
1234
+
1235
+ * Reduce pollution by making `notify()` into lambda.
1236
+
1237
+ * Beautify markdown formatting and revise the README.
1238
+
1239
+ ## Version 3.0.0 (2011-01-04)
1240
+
1241
+ * Replace Rake pathmap usage with lambda functions
1242
+ in the `@source_file_to_test_file_mapping` hash.
1243
+
1244
+ * Be resilient to syntax errors from loaded files.
1245
+
1246
+ ## Version 2.0.2 (2011-01-02)
1247
+
1248
+ * Do not print stack trace when Control-C pressed.
1249
+
1250
+ * Reduce the amount of notifications shown to user.
1251
+
1252
+ ## Version 2.0.1 (2011-01-01)
1253
+
1254
+ * Fix syntax error caused by a dangling comma. Thanks
1255
+ to darthdeus (Jakub Arnold) for reporting [this bug](
1256
+ https://github.com/sunaku/test-loop/issues#issue/1 ).
1257
+
1258
+ * Notify user before reabsorbing overhead.
1259
+
1260
+ ## Version 2.0.0 (2010-12-31)
1261
+
1262
+ * Add support for loading configuration file, which
1263
+ allows you to define additional test file globs
1264
+ and mappings, from the current working directory.
1265
+
1266
+ * Add support for executing arbitrary logic after every test run
1267
+ via the `@after_test_execution` hook in the configuration file.
1268
+
1269
+ * Before running tests, print out their file paths.
1270
+
1271
+ * Automatically retry when overhead absorption fails.
1272
+
1273
+ ## Version 1.2.0 (2010-11-23)
1274
+
1275
+ * Notify user when absorbing overhead initially.
1276
+
1277
+ * DRY up the repetition of Time.at(0) calculation.
1278
+
1279
+ ## Version 1.1.0 (2010-11-22)
1280
+
1281
+ * All `*_{test,spec}_helper.rb` files inside `test/` and
1282
+ `spec/` are now considered to be absorable overhead.
1283
+
1284
+ ## Version 1.0.2 (2010-10-16)
1285
+
1286
+ * All *_helper.rb files inside test/ and spec/
1287
+ were absorbed as overhead instead of just
1288
+ the test_helper.rb and spec_helper.rb files.
1289
+
1290
+ ## Version 1.0.1 (2010-10-16)
1291
+
1292
+ * Ensure that $LOAD_PATH reflects `ruby -Ilib:test`.
1293
+
1294
+ ## Version 1.0.0 (2010-10-15)
1295
+
1296
+ * Remove ability to install as a Rails plugin.
1297
+
1298
+ * Move logic from `lib/` into `bin/` to keep it simple.
1299
+
1300
+ * Rely on $LOAD_PATH in `bin/` instead of relative paths.
1301
+
1302
+ * Display status messages for better user interactivity.
1303
+
1304
+ ## Version 0.0.2 (2010-10-11)
1305
+
1306
+ * Forgot to register `bin/test-loop` as gem executable.
1307
+
1308
+ * Revise Usage section into Invocation and Operation.
1309
+
1310
+ ## Version 0.0.1 (2010-10-10)
1311
+
1312
+ * First public release. Enjoy!