tork 20.0.0 → 20.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/VERSION.markdown +8 -0
- data/bin/tork +3 -3
- data/bin/tork-driver +3 -3
- data/bin/tork-engine +3 -3
- data/bin/tork-herald +3 -3
- data/bin/tork-master +3 -3
- data/bin/tork-notify +3 -3
- data/bin/tork-remote +2 -2
- data/bin/tork-runner +3 -3
- data/lib/tork/version.rb +1 -1
- data/man/index.html +1 -1
- data/man/man0/README.html +14 -14
- data/man/man0/README.markdown +1 -0
- data/man/man0/VERSION.html +164 -159
- data/man/man0/VERSION.markdown +1 -0
- data/man/man1/tork-driver.1 +3 -3
- data/man/man1/tork-driver.1.html +5 -5
- data/man/man1/tork-engine.1 +3 -3
- data/man/man1/tork-engine.1.html +5 -5
- data/man/man1/tork-herald.1 +3 -3
- data/man/man1/tork-herald.1.html +3 -3
- data/man/man1/tork-master.1 +3 -3
- data/man/man1/tork-master.1.html +6 -6
- data/man/man1/tork-notify.1 +3 -3
- data/man/man1/tork-notify.1.html +3 -3
- data/man/man1/tork-remote.1 +2 -2
- data/man/man1/tork-remote.1.html +3 -3
- data/man/man1/tork-runner.1 +3 -3
- data/man/man1/tork-runner.1.html +3 -3
- data/man/man1/tork.1 +3 -3
- data/man/man1/tork.1.html +5 -5
- data/man/style.css +7 -2
- data/tork.gemspec +2 -2
- metadata +7 -7
- data/man/man0/README.markdown +0 -214
- data/man/man0/VERSION.markdown +0 -1693
@@ -0,0 +1 @@
|
|
1
|
+
../../VERSION.markdown
|
data/man/man1/tork-driver.1
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH TORK\-DRIVER 1
|
1
|
+
.TH TORK\-DRIVER 1 2016\-02\-13 20.0.1
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
tork\-driver \- drives
|
@@ -51,8 +51,8 @@ and
|
|
51
51
|
are also reproduced here.
|
52
52
|
.SH OPTIONS
|
53
53
|
.TP
|
54
|
-
\fB\fC\-h\fR, \fB\fC\-\-help\fR
|
55
|
-
Show this help manual.
|
54
|
+
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
55
|
+
Show this help manual and search for \fIPATTERN\fP regular expression therein.
|
56
56
|
.SH FILES
|
57
57
|
.TP
|
58
58
|
\fI\&.tork/config.rb\fP
|
data/man/man1/tork-driver.1.html
CHANGED
@@ -2,17 +2,17 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
|
6
6
|
<title>tork-driver(1) — drives tork-engine(1) when files change</title>
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
9
9
|
</head>
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-driver.1</span></div></div><div class="container-fluid"><h1 id="tork-driver-1-
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-driver.1</span></div></div><div class="container-fluid"><h1 id="tork-driver-1-2016-02-13-20-0-1"><span class="md2man-title">TORK-DRIVER</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">20.0.1</span><a name="tork-driver-1-2016-02-13-20-0-1" href="#tork-driver-1-2016-02-13-20-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>tork-driver - drives <a class="md2man-reference" href="../man1/tork-engine.1.html">tork-engine(1)</a> when files change</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>tork-driver</code> [<em>OPTION</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program drives <a class="md2man-reference" href="../man1/tork-engine.1.html">tork-engine(1)</a> when <a class="md2man-reference" href="../man1/tork-herald.1.html">tork-herald(1)</a> reports files changes.</p><p>This program can be controlled remotely by multiple <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a> instances.</p><h3 id="input">Input<a name="input" href="#input" class="md2man-permalink" title="permalink"></a></h3><p>This program reads the following commands, which are single-line JSON arrays,
|
11
11
|
from stdin and then performs the associated actions. For lines read from
|
12
12
|
stdin that are single-line JSON arrays, it splits each of them into an array
|
13
13
|
of words, using the same word-splitting algorithm as <a class="md2man-reference">sh(1)</a>, before processing
|
14
|
-
them. For example, the line <code>a "b c"</code> is split into the <code>["a", "b c"]</code> array.</p><dl><dt><code>["test!"]</code></dt><dd>Runs all test files found within and beneath the current working directory.</dd></dl><dl><dt><em>...</em></dt><dd>Commands for <a class="md2man-reference" href="../man1/tork-engine.1.html">tork-engine(1)</a> are also accepted here.</dd></dl><h3 id="output"
|
15
|
-
to stdout.</p><dl><dt><code>["boot!",</code> <em>overhead_file</em><code>]</code></dt><dd>Reabsorbing test execution overhead because <em>overhead_file</em> has changed.</dd></dl><dl><dt><em>...</em></dt><dd>Messages from <a class="md2man-reference" href="../man1/tork-engine.1.html">tork-engine(1)</a> and <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a> are also reproduced here.</dd></dl><h2 id="options"
|
14
|
+
them. For example, the line <code>a "b c"</code> is split into the <code>["a", "b c"]</code> array.</p><dl><dt><code>["test!"]</code></dt><dd>Runs all test files found within and beneath the current working directory.</dd></dl><dl><dt><em>...</em></dt><dd>Commands for <a class="md2man-reference" href="../man1/tork-engine.1.html">tork-engine(1)</a> are also accepted here.</dd></dl><h3 id="output">Output<a name="output" href="#output" class="md2man-permalink" title="permalink"></a></h3><p>This program prints the following messages, which are single-line JSON arrays,
|
15
|
+
to stdout.</p><dl><dt><code>["boot!",</code> <em>overhead_file</em><code>]</code></dt><dd>Reabsorbing test execution overhead because <em>overhead_file</em> has changed.</dd></dl><dl><dt><em>...</em></dt><dd>Messages from <a class="md2man-reference" href="../man1/tork-engine.1.html">tork-engine(1)</a> and <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a> are also reproduced here.</dd></dl><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="files">FILES<a name="files" href="#files" class="md2man-permalink" title="permalink"></a></h2><dl><dt><em>.tork/config.rb</em></dt><dd>Optional Ruby script that is loaded inside this Tork process on startup.
|
16
16
|
It can read and change the <code>ENV['TORK_CONFIGS']</code> environment variable.</dd></dl><dl><dt><code>.tork/driver.rb</code></dt><dd>Optional Ruby script that is loaded inside the driver process on startup.
|
17
17
|
It can read and change the following variables.</dd></dl>
|
18
18
|
<blockquote>
|
@@ -87,5 +87,5 @@ write:</p><pre><code>Tork::Driver::TEST_FILE_GLOBBERS.update(
|
|
87
87
|
</code></pre>
|
88
88
|
</blockquote>
|
89
89
|
</blockquote>
|
90
|
-
<h2 id="environment"
|
90
|
+
<h2 id="environment">ENVIRONMENT<a name="environment" href="#environment" class="md2man-permalink" title="permalink"></a></h2><p>See <a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>.</p><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>, <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a>, <a class="md2man-reference" href="../man1/tork-herald.1.html">tork-herald(1)</a>, <a class="md2man-reference" href="../man1/tork-engine.1.html">tork-engine(1)</a>, <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a></p></div></body>
|
91
91
|
</html>
|
data/man/man1/tork-engine.1
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH TORK\-ENGINE 1
|
1
|
+
.TH TORK\-ENGINE 1 2016\-02\-13 20.0.1
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
tork\-engine \- wraps
|
@@ -80,8 +80,8 @@ Messages from
|
|
80
80
|
are also reproduced here.
|
81
81
|
.SH OPTIONS
|
82
82
|
.TP
|
83
|
-
\fB\fC\-h\fR, \fB\fC\-\-help\fR
|
84
|
-
Show this help manual.
|
83
|
+
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
84
|
+
Show this help manual and search for \fIPATTERN\fP regular expression therein.
|
85
85
|
.SH FILES
|
86
86
|
.TP
|
87
87
|
\fI\&.tork/config.rb\fP
|
data/man/man1/tork-engine.1.html
CHANGED
@@ -2,12 +2,12 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
|
6
6
|
<title>tork-engine(1) — wraps tork-master(1) with bookkeeping</title>
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
9
9
|
</head>
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-engine.1</span></div></div><div class="container-fluid"><h1 id="tork-engine-1-
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-engine.1</span></div></div><div class="container-fluid"><h1 id="tork-engine-1-2016-02-13-20-0-1"><span class="md2man-title">TORK-ENGINE</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">20.0.1</span><a name="tork-engine-1-2016-02-13-20-0-1" href="#tork-engine-1-2016-02-13-20-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>tork-engine - wraps <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a> with bookkeeping</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>tork-engine</code> [<em>OPTION</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program uses <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a> to run tests and keeps track of the results.</p><p>This program can be controlled remotely by multiple <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a> instances.</p><h3 id="input">Input<a name="input" href="#input" class="md2man-permalink" title="permalink"></a></h3><p>This program reads the following commands, which are single-line JSON arrays,
|
11
11
|
from stdin and then performs the associated actions. For lines read from
|
12
12
|
stdin that are single-line JSON arrays, it splits each of them into an array
|
13
13
|
of words, using the same word-splitting algorithm as <a class="md2man-reference">sh(1)</a>, before processing
|
@@ -18,9 +18,9 @@ execution overhead, and then re-runs those stopped test files.</dd></dl><p><code
|
|
18
18
|
given <em>test_file</em>. If no <em>line_numbers</em> are given, then only those lines
|
19
19
|
that have changed since the last run of <em>test_file</em> will be substituted.
|
20
20
|
If any <em>line_numbers</em> are zero, then the entire <em>test_file</em> will be run.</p><dl><dt><code>["test?"]</code></dt><dd>Lists all test files that are currently running.</dd></dl><dl><dt><code>["stop"</code>, <em>signal</em><code>]</code></dt><dd>Stops test files that are currently running by sending the given <em>signal</em>
|
21
|
-
(optional; defaults to "SIGTERM") to their respective worker processes.</dd></dl><dl><dt><code>["pass!"]</code></dt><dd>Runs all test files that have passed during their most recent run.</dd></dl><dl><dt><code>["pass?"]</code></dt><dd>Lists all test files that have passed during their most recent run.</dd></dl><dl><dt><code>["fail!"]</code></dt><dd>Runs all test files that have failed during their most recent run.</dd></dl><dl><dt><code>["fail?"]</code></dt><dd>Lists all test files that have failed during their most recent run.</dd></dl><dl><dt><code>["quit"]</code></dt><dd>Stops all tests that are currently running and exits.</dd></dl><h3 id="output"
|
21
|
+
(optional; defaults to "SIGTERM") to their respective worker processes.</dd></dl><dl><dt><code>["pass!"]</code></dt><dd>Runs all test files that have passed during their most recent run.</dd></dl><dl><dt><code>["pass?"]</code></dt><dd>Lists all test files that have passed during their most recent run.</dd></dl><dl><dt><code>["fail!"]</code></dt><dd>Runs all test files that have failed during their most recent run.</dd></dl><dl><dt><code>["fail?"]</code></dt><dd>Lists all test files that have failed during their most recent run.</dd></dl><dl><dt><code>["quit"]</code></dt><dd>Stops all tests that are currently running and exits.</dd></dl><h3 id="output">Output<a name="output" href="#output" class="md2man-permalink" title="permalink"></a></h3><p>This program prints the following messages, which are single-line JSON arrays,
|
22
22
|
to stdout.</p><dl><dt><code>["done",</code> <em>ran<em>test</em>files</em><code>,</code> <em>passed<em>test</em>files</em><code>,</code> <em>failed<em>test</em>files</em><code>]</code></dt><dd>All queued tests have finished running and no new tests have been queued.
|
23
23
|
In particular, <em>ran<em>test</em>files</em> test files have run, <em>passed<em>test</em>files</em>
|
24
|
-
test files have passed, and <em>failed<em>test</em>files</em> test files have failed.</dd></dl><dl><dt><code>["fail!",</code> <em>test_file</em><code>,</code> <em>message</em><code>]</code></dt><dd>A previously passing <em>test_file</em> has now failed. See <em>message</em> for details.</dd></dl><dl><dt><code>["pass!",</code> <em>test_file</em><code>,</code> <em>message</em><code>]</code></dt><dd>A previously failing <em>test_file</em> has now passed. See <em>message</em> for details.</dd></dl><dl><dt><em>...</em></dt><dd>Messages from <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a> are also reproduced here.</dd></dl><h2 id="options"
|
25
|
-
It can read and change the <code>ENV['TORK_CONFIGS']</code> environment variable.</dd></dl><dl><dt><em>.tork/engine.rb</em></dt><dd>Optional Ruby script that is loaded inside the master process on startup.</dd></dl><h2 id="environment"
|
24
|
+
test files have passed, and <em>failed<em>test</em>files</em> test files have failed.</dd></dl><dl><dt><code>["fail!",</code> <em>test_file</em><code>,</code> <em>message</em><code>]</code></dt><dd>A previously passing <em>test_file</em> has now failed. See <em>message</em> for details.</dd></dl><dl><dt><code>["pass!",</code> <em>test_file</em><code>,</code> <em>message</em><code>]</code></dt><dd>A previously failing <em>test_file</em> has now passed. See <em>message</em> for details.</dd></dl><dl><dt><em>...</em></dt><dd>Messages from <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a> are also reproduced here.</dd></dl><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="files">FILES<a name="files" href="#files" class="md2man-permalink" title="permalink"></a></h2><dl><dt><em>.tork/config.rb</em></dt><dd>Optional Ruby script that is loaded inside this Tork process on startup.
|
25
|
+
It can read and change the <code>ENV['TORK_CONFIGS']</code> environment variable.</dd></dl><dl><dt><em>.tork/engine.rb</em></dt><dd>Optional Ruby script that is loaded inside the master process on startup.</dd></dl><h2 id="environment">ENVIRONMENT<a name="environment" href="#environment" class="md2man-permalink" title="permalink"></a></h2><p>See <a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>.</p><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>, <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a>, <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a></p></div></body>
|
26
26
|
</html>
|
data/man/man1/tork-herald.1
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH TORK\-HERALD 1
|
1
|
+
.TH TORK\-HERALD 1 2016\-02\-13 20.0.1
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
tork\-herald \- reports modified files
|
@@ -12,8 +12,8 @@ recursively. When any files therein are modified, it prints their relative
|
|
12
12
|
paths in a single\-line JSON array to stdout.
|
13
13
|
.SH OPTIONS
|
14
14
|
.TP
|
15
|
-
\fB\fC\-h\fR, \fB\fC\-\-help\fR
|
16
|
-
Show this help manual.
|
15
|
+
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
16
|
+
Show this help manual and search for \fIPATTERN\fP regular expression therein.
|
17
17
|
.SH SEE ALSO
|
18
18
|
.PP
|
19
19
|
.BR tork (1),
|
data/man/man1/tork-herald.1.html
CHANGED
@@ -2,12 +2,12 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
|
6
6
|
<title>tork-herald(1) — reports modified files</title>
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
9
9
|
</head>
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-herald.1</span></div></div><div class="container-fluid"><h1 id="tork-herald-1-
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-herald.1</span></div></div><div class="container-fluid"><h1 id="tork-herald-1-2016-02-13-20-0-1"><span class="md2man-title">TORK-HERALD</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">20.0.1</span><a name="tork-herald-1-2016-02-13-20-0-1" href="#tork-herald-1-2016-02-13-20-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>tork-herald - reports modified files</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>tork-herald</code> [<em>OPTION</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program monitors the current working directory and all those below it
|
11
11
|
recursively. When any files therein are modified, it prints their relative
|
12
|
-
paths in a single-line JSON array to stdout.</p><h2 id="options"
|
12
|
+
paths in a single-line JSON array to stdout.</p><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>, <a class="md2man-reference" href="../man1/tork-driver.1.html">tork-driver(1)</a></p></div></body>
|
13
13
|
</html>
|
data/man/man1/tork-master.1
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH TORK\-MASTER 1
|
1
|
+
.TH TORK\-MASTER 1 2016\-02\-13 20.0.1
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
tork\-master \- absorbs overhead and runs tests
|
@@ -57,8 +57,8 @@ Test has passed.
|
|
57
57
|
Test has failed.
|
58
58
|
.SH OPTIONS
|
59
59
|
.TP
|
60
|
-
\fB\fC\-h\fR, \fB\fC\-\-help\fR
|
61
|
-
Show this help manual.
|
60
|
+
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
61
|
+
Show this help manual and search for \fIPATTERN\fP regular expression therein.
|
62
62
|
.SH FILES
|
63
63
|
.TP
|
64
64
|
\fI\&.tork/config.rb\fP
|
data/man/man1/tork-master.1.html
CHANGED
@@ -2,24 +2,24 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
|
6
6
|
<title>tork-master(1) — absorbs overhead and runs tests</title>
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
9
9
|
</head>
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-master.1</span></div></div><div class="container-fluid"><h1 id="tork-master-1-
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-master.1</span></div></div><div class="container-fluid"><h1 id="tork-master-1-2016-02-13-20-0-1"><span class="md2man-title">TORK-MASTER</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">20.0.1</span><a name="tork-master-1-2016-02-13-20-0-1" href="#tork-master-1-2016-02-13-20-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>tork-master - absorbs overhead and runs tests</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>tork-master</code> [<em>OPTION</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program absorbs your Ruby application's test execution overhead once and
|
11
11
|
simply <a class="md2man-reference">fork(3)</a>s worker processses to run your tests thereafter. As a result,
|
12
12
|
your tests run faster because they no longer spend any time absorbing the test
|
13
|
-
execution overhead: worker processes simply inherit the overhead when forked.</p><p>This program can be controlled remotely by multiple <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a> instances.</p><h3 id="input"
|
13
|
+
execution overhead: worker processes simply inherit the overhead when forked.</p><p>This program can be controlled remotely by multiple <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a> instances.</p><h3 id="input">Input<a name="input" href="#input" class="md2man-permalink" title="permalink"></a></h3><p>This program reads the following commands, which are single-line JSON arrays,
|
14
14
|
from stdin and then performs the associated actions. For lines read from
|
15
15
|
stdin that are single-line JSON arrays, it splits each of them into an array
|
16
16
|
of words, using the same word-splitting algorithm as <a class="md2man-reference">sh(1)</a>, before processing
|
17
17
|
them. For example, the line <code>a "b c"</code> is split into the <code>["a", "b c"]</code> array.</p><dl><dt><code>["test",</code> <em>test_file</em><code>,</code> <em>line_numbers</em><code>]</code></dt><dd>Forks a worker process to run tests that correspond to the given
|
18
18
|
<em>line_numbers</em> in the given <em>test_file</em>. If <em>line_numbers</em> is empty, then
|
19
19
|
the entire <em>test_file</em> will be run.</dd></dl><dl><dt><code>["stop",</code> <em>signal</em><code>]</code></dt><dd>Stops all tests that are currently running by sending the given <em>signal</em>
|
20
|
-
(optional; defaults to "SIGTERM") to their respective worker processes.</dd></dl><dl><dt><code>["quit"]</code></dt><dd>Stops all tests that are currently running and exits.</dd></dl><h3 id="output"
|
20
|
+
(optional; defaults to "SIGTERM") to their respective worker processes.</dd></dl><dl><dt><code>["quit"]</code></dt><dd>Stops all tests that are currently running and exits.</dd></dl><h3 id="output">Output<a name="output" href="#output" class="md2man-permalink" title="permalink"></a></h3><p>This program prints the following messages, which are single-line JSON arrays,
|
21
21
|
to stdout.</p><dl><dt><code>["boot"]</code></dt><dd>Test execution overhead has been absorbed. We are ready for testing!</dd></dl><dl><dt><code>["test",</code> <em>test_file</em><code>,</code> <em>line_numbers</em><code>,</code> <em>log_file</em><code>,</code> <em>worker_number</em><code>]</code></dt><dd>Test has begun running. Its output (both stdout and stderr) is being
|
22
|
-
captured into <em>log_file</em> in real time, so you can watch it with <code>tail -f</code>.</dd></dl><dl><dt><code>["pass",</code> <em>test_file</em><code>,</code> <em>line_numbers</em><code>,</code> <em>log_file</em><code>,</code> <em>worker_number</em><code>,</code> <em>exit_code</em><code>,</code> <em>exit_info</em><code>]</code></dt><dd>Test has passed.</dd></dl><dl><dt><code>["fail",</code> <em>test_file</em><code>,</code> <em>line_numbers</em><code>,</code> <em>log_file</em><code>,</code> <em>worker_number</em><code>,</code> <em>exit_code</em><code>,</code> <em>exit_info</em><code>]</code></dt><dd>Test has failed.</dd></dl><h2 id="options"
|
22
|
+
captured into <em>log_file</em> in real time, so you can watch it with <code>tail -f</code>.</dd></dl><dl><dt><code>["pass",</code> <em>test_file</em><code>,</code> <em>line_numbers</em><code>,</code> <em>log_file</em><code>,</code> <em>worker_number</em><code>,</code> <em>exit_code</em><code>,</code> <em>exit_info</em><code>]</code></dt><dd>Test has passed.</dd></dl><dl><dt><code>["fail",</code> <em>test_file</em><code>,</code> <em>line_numbers</em><code>,</code> <em>log_file</em><code>,</code> <em>worker_number</em><code>,</code> <em>exit_code</em><code>,</code> <em>exit_info</em><code>]</code></dt><dd>Test has failed.</dd></dl><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="files">FILES<a name="files" href="#files" class="md2man-permalink" title="permalink"></a></h2><dl><dt><em>.tork/config.rb</em></dt><dd>Optional Ruby script that is loaded inside this Tork process on startup.
|
23
23
|
It can read and change the <code>ENV['TORK_CONFIGS']</code> environment variable.</dd></dl><dl><dt><em>.tork/master.rb</em></dt><dd>Optional Ruby script that is loaded inside the master process on startup.
|
24
24
|
It can read and change the following variables.</dd></dl>
|
25
25
|
<blockquote>
|
@@ -34,5 +34,5 @@ worker process is forked. It can read and change the following variables.</dd><
|
|
34
34
|
it is forked. It can read and change the following variables.</dd></dl>
|
35
35
|
<blockquote>
|
36
36
|
<dl><dt><code>$tork_test_file</code></dt><dd>Path of the test file that will be run by this worker process.</dd></dl><dl><dt><code>$tork_line_numbers</code></dt><dd>Array of line numbers in the test file that were requested to be run.</dd></dl><dl><dt><code>$tork_log_file</code></dt><dd>Path of the log file that will hold the output of this worker process.</dd></dl><dl><dt><code>$tork_worker_number</code></dt><dd>Sequence number of this worker process.</dd></dl></blockquote>
|
37
|
-
<h2 id="environment"
|
37
|
+
<h2 id="environment">ENVIRONMENT<a name="environment" href="#environment" class="md2man-permalink" title="permalink"></a></h2><p>See <a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>.</p><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>, <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a></p></div></body>
|
38
38
|
</html>
|
data/man/man1/tork-notify.1
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH TORK\-NOTIFY 1
|
1
|
+
.TH TORK\-NOTIFY 1 2016\-02\-13 20.0.1
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
tork\-notify \- notifies you of test status changes
|
@@ -15,8 +15,8 @@ passing tests fail (or vice versa) through libnotify, xmessage, or growl. If
|
|
15
15
|
none are available on your system, then the notification is printed to stdout.
|
16
16
|
.SH OPTIONS
|
17
17
|
.TP
|
18
|
-
\fB\fC\-h\fR, \fB\fC\-\-help\fR
|
19
|
-
Show this help manual.
|
18
|
+
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
19
|
+
Show this help manual and search for \fIPATTERN\fP regular expression therein.
|
20
20
|
.SH EXIT STATUS
|
21
21
|
.PP
|
22
22
|
See
|
data/man/man1/tork-notify.1.html
CHANGED
@@ -2,13 +2,13 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
|
6
6
|
<title>tork-notify(1) — notifies you of test status changes</title>
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
9
9
|
</head>
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-notify.1</span></div></div><div class="container-fluid"><h1 id="tork-notify-1-
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-notify.1</span></div></div><div class="container-fluid"><h1 id="tork-notify-1-2016-02-13-20-0-1"><span class="md2man-title">TORK-NOTIFY</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">20.0.1</span><a name="tork-notify-1-2016-02-13-20-0-1" href="#tork-notify-1-2016-02-13-20-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>tork-notify - notifies you of test status changes</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>tork-notify</code> [<em>OPTION</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program serves as an example of how to receive and process messages sent
|
11
11
|
by the various programs in the <a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a> suite. It notifies you when previously
|
12
12
|
passing tests fail (or vice versa) through libnotify, xmessage, or growl. If
|
13
|
-
none are available on your system, then the notification is printed to stdout.</p><h2 id="options"
|
13
|
+
none are available on your system, then the notification is printed to stdout.</p><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="exit-status">EXIT STATUS<a name="exit-status" href="#exit-status" class="md2man-permalink" title="permalink"></a></h2><p>See <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a>.</p><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a>, <a class="md2man-reference" href="../man1/tork-engine.1.html">tork-engine(1)</a></p></div></body>
|
14
14
|
</html>
|
data/man/man1/tork-remote.1
CHANGED
@@ -15,8 +15,8 @@ It also prints lines, received in response, from the given \fIPROGRAM\fP either
|
|
15
15
|
to stdout if they are valid single\-line JSON arrays or to stderr otherwise.
|
16
16
|
.SH OPTIONS
|
17
17
|
.TP
|
18
|
-
\fB\fC\-h\fR, \fB\fC\-\-help\fR
|
19
|
-
Show this help manual.
|
18
|
+
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
19
|
+
Show this help manual and search for \fIPATTERN\fP regular expression therein.
|
20
20
|
.SH EXIT STATUS
|
21
21
|
.TP
|
22
22
|
1
|
data/man/man1/tork-remote.1.html
CHANGED
@@ -2,13 +2,13 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
|
6
6
|
<title>tork-remote(1) — controls tork(1) programs</title>
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
9
9
|
</head>
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-remote.1</span></div></div><div class="container-fluid"><h1 id="tork-remote-1-2012-09-26-18-2-3"><
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-remote.1</span></div></div><div class="container-fluid"><h1 id="tork-remote-1-2012-09-26-18-2-3"><span class="md2man-title">TORK-REMOTE</span> <span class="md2man-section">1</span> <span class="md2man-date">2012-09-26</span> <span class="md2man-source">18.2.3</span><a name="tork-remote-1-2012-09-26-18-2-3" href="#tork-remote-1-2012-09-26-18-2-3" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>tork-remote - controls <a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a> programs</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>tork-remote</code> [<em>OPTION</em>]... <em>PROGRAM</em></p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program reads lines from its stdin and sends them to the given <em>PROGRAM</em>,
|
11
11
|
which must already be running in the same working directory as this program.
|
12
12
|
It also prints lines, received in response, from the given <em>PROGRAM</em> either
|
13
|
-
to stdout if they are valid single-line JSON arrays or to stderr otherwise.</p><h2 id="options"
|
13
|
+
to stdout if they are valid single-line JSON arrays or to stderr otherwise.</p><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="exit-status">EXIT STATUS<a name="exit-status" href="#exit-status" class="md2man-permalink" title="permalink"></a></h2><dl><dt>1</dt><dd>Could not connect to the <em>PROGRAM</em>.</dd></dl><dl><dt>2</dt><dd>Lost connection to the <em>PROGRAM</em>.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>, <a class="md2man-reference" href="../man1/tork-driver.1.html">tork-driver(1)</a>, <a class="md2man-reference" href="../man1/tork-engine.1.html">tork-engine(1)</a>, <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a></p></div></body>
|
14
14
|
</html>
|
data/man/man1/tork-runner.1
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH TORK\-RUNNER 1
|
1
|
+
.TH TORK\-RUNNER 1 2016\-02\-13 20.0.1
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
tork\-runner \- runs tests once, non\-interactively
|
@@ -30,8 +30,8 @@ This program prints the following messages to stderr if it is a TTY device.
|
|
30
30
|
So far, \fIT\fP test files were tested, \fIP\fP of them passed, \fIF\fP of them failed.
|
31
31
|
.SH OPTIONS
|
32
32
|
.TP
|
33
|
-
\fB\fC\-h\fR, \fB\fC\-\-help\fR
|
34
|
-
Show this help manual.
|
33
|
+
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
34
|
+
Show this help manual and search for \fIPATTERN\fP regular expression therein.
|
35
35
|
.SH EXIT STATUS
|
36
36
|
.TP
|
37
37
|
0
|
data/man/man1/tork-runner.1.html
CHANGED
@@ -2,13 +2,13 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
|
6
6
|
<title>tork-runner(1) — runs tests once, non-interactively</title>
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
9
9
|
</head>
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-runner.1</span></div></div><div class="container-fluid"><h1 id="tork-runner-1-
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork-runner.1</span></div></div><div class="container-fluid"><h1 id="tork-runner-1-2016-02-13-20-0-1"><span class="md2man-title">TORK-RUNNER</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">20.0.1</span><a name="tork-runner-1-2016-02-13-20-0-1" href="#tork-runner-1-2016-02-13-20-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>tork-runner - runs tests once, non-interactively</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>tork-runner</code> [<em>OPTION</em>]... [<em>TEST_FILE_GLOB</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program can be thought of as a non-interactive version of <a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>. It
|
11
11
|
runs all test files that match the given <em>TEST_FILE_GLOB</em>s and then exits
|
12
12
|
with a nonzero status if any tests failed. If none are given, it runs all
|
13
|
-
test files known to <code>Tork::Driver::TEST_FILE_GLOBBERS</code> in <a class="md2man-reference" href="../man1/tork-driver.1.html">tork-driver(1)</a>.</p><h3 id="output"
|
13
|
+
test files known to <code>Tork::Driver::TEST_FILE_GLOBBERS</code> in <a class="md2man-reference" href="../man1/tork-driver.1.html">tork-driver(1)</a>.</p><h3 id="output">Output<a name="output" href="#output" class="md2man-permalink" title="permalink"></a></h3><p>This program prints the following messages to stdout.</p><dl><dt><code>>></code> <em>failed_test_log_file</em> <code><<</code></dt><dd>This message will be followed by the content of <em>failed_test_log_file</em>.</dd></dl><dl><dt><em>T</em> <code>tested,</code> <em>P</em> <code>passed,</code> <em>F</em> <code>failed</code></dt><dd><em>T</em> test files were tested and <em>P</em> of them passed but <em>F</em> of them failed.</dd></dl><p>This program prints the following messages to stderr if it is a TTY device.</p><dl><dt><em>T</em> <code>tested,</code> <em>P</em> <code>passed,</code> <em>F</em> <code>failed</code></dt><dd>So far, <em>T</em> test files were tested, <em>P</em> of them passed, <em>F</em> of them failed.</dd></dl><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="exit-status">EXIT STATUS<a name="exit-status" href="#exit-status" class="md2man-permalink" title="permalink"></a></h2><dl><dt>0</dt><dd>All test files passed.</dd></dl><dl><dt>1</dt><dd>One or more test files failed.</dd></dl><h2 id="environment">ENVIRONMENT<a name="environment" href="#environment" class="md2man-permalink" title="permalink"></a></h2><p>See <a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>.</p><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a>, <a class="md2man-reference" href="../man1/tork-driver.1.html">tork-driver(1)</a></p></div></body>
|
14
14
|
</html>
|
data/man/man1/tork.1
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH TORK 1
|
1
|
+
.TH TORK 1 2016\-02\-13 20.0.1
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
tork \- Continuous testing tool for Ruby
|
@@ -39,8 +39,8 @@ This program can be controlled remotely by multiple
|
|
39
39
|
instances.
|
40
40
|
.SH OPTIONS
|
41
41
|
.TP
|
42
|
-
\fB\fC\-h\fR, \fB\fC\-\-help\fR
|
43
|
-
Show this help manual.
|
42
|
+
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
43
|
+
Show this help manual and search for \fIPATTERN\fP regular expression therein.
|
44
44
|
.SH FILES
|
45
45
|
.TP
|
46
46
|
\fI\&.tork/config.rb\fP
|
data/man/man1/tork.1.html
CHANGED
@@ -2,12 +2,12 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
|
6
6
|
<title>tork(1) — Continuous testing tool for Ruby</title>
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
9
9
|
</head>
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork.1</span></div></div><div class="container-fluid"><h1 id="tork-1-
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/tork.1</span></div></div><div class="container-fluid"><h1 id="tork-1-2016-02-13-20-0-1"><span class="md2man-title">TORK</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">20.0.1</span><a name="tork-1-2016-02-13-20-0-1" href="#tork-1-2016-02-13-20-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>tork - Continuous testing tool for Ruby</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>tork</code> [<em>OPTION</em>]... [<em>CONFIG</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program can be thought of as an interactive version of <a class="md2man-reference" href="../man1/tork-runner.1.html">tork-runner(1)</a>.
|
11
11
|
It functions as a rudimentary command-line user interface to <a class="md2man-reference" href="../man1/tork-driver.1.html">tork-driver(1)</a>.</p><p>First, it applies the given <em>CONFIG</em> values, which are either (1) paths to
|
12
12
|
directories that contain configuration files or (2) names of configuration
|
13
13
|
helpers listed in the description of the <code>TORK_CONFIGS</code> environment variable.</p><p>Next, it waits for you to supply interactive commands either (1) directly on
|
@@ -16,8 +16,8 @@ and press ENTER to see a help message that shows a menu of accepted commands.</p
|
|
16
16
|
on the given list of <em>line_number</em>s. If no <em>line_number</em>s are given, then
|
17
17
|
only those tests that have changed since the last run of the <em>test_file</em>
|
18
18
|
will now be run.</dd></dl><dl><dt><code>s</code> [<em>signal</em>]</dt><dd>Stops test files that are currently running by sending the given <em>signal</em>
|
19
|
-
(optional; defaults to <code>SIGTERM</code>) to their respective worker processes.</dd></dl><p>This program can be controlled remotely by multiple <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a> instances.</p><h2 id="options"
|
20
|
-
It can read and change the <code>ENV['TORK_CONFIGS']</code> environment variable.</dd></dl><h2 id="environment"
|
19
|
+
(optional; defaults to <code>SIGTERM</code>) to their respective worker processes.</dd></dl><p>This program can be controlled remotely by multiple <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a> instances.</p><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="files">FILES<a name="files" href="#files" class="md2man-permalink" title="permalink"></a></h2><dl><dt><em>.tork/config.rb</em></dt><dd>Optional Ruby script that is loaded inside this Tork process on startup.
|
20
|
+
It can read and change the <code>ENV['TORK_CONFIGS']</code> environment variable.</dd></dl><h2 id="environment">ENVIRONMENT<a name="environment" href="#environment" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>TORK_CONFIGS</code></dt><dd>Colon-separated (:) list of either paths to directories that contain
|
21
21
|
configuration files or names of the following configuration helpers.</dd></dl>
|
22
22
|
<blockquote>
|
23
23
|
<dl><dt><code>dotlog</code></dt><dd>Hides log files by prefixing their names with a period (dot).</dd></dl><dl><dt><code>logdir</code></dt><dd>Keeps log files away from your tests, in the <code>log/</code> directory.</dd></dl><dl><dt><code>coverage</code></dt><dd>Measures C0 code coverage under Ruby 1.9 and dumps a hash in YAML
|
@@ -27,5 +27,5 @@ directories (the key) mapped to the following information (the value):</dd></dl>
|
|
27
27
|
<blockquote>
|
28
28
|
<dl><dt><code>:grade</code></dt><dd>Percentage of source lines that were C0 covered.</dd></dl><dl><dt><code>:nsloc</code></dt><dd>Total number of source lines of code in the file.</dd></dl><dl><dt><code>:holes</code></dt><dd>Line numbers of source lines that were not covered.</dd></dl></blockquote>
|
29
29
|
<dl><dt><code>test</code></dt><dd>Supports the Test::Unit standard library.</dd></dl><dl><dt><code>spec</code></dt><dd>Supports the <a href="http://rspec.info">RSpec</a> testing framework.</dd></dl><dl><dt><code>cucumber</code></dt><dd>Supports the <a href="https://cukes.info">Cucumber</a> testing framework.</dd></dl><dl><dt><code>bundler</code></dt><dd>Supports the <a href="http://bundler.io">Bundler</a> dependency framework.</dd></dl><dl><dt><code>rails</code></dt><dd>Supports the <a href="http://rubyonrails.org">Ruby on Rails</a> web framework.</dd></dl><dl><dt><code>devise</code></dt><dd>Supports the <a href="https://github.com/plataformatec/devise">Devise</a> authentication framework.</dd></dl><dl><dt><code>factory_girl</code></dt><dd>Supports the <a href="https://github.com/thoughtbot/factory_girl">factory_girl</a> testing library.</dd></dl><dl><dt><code>parallel_tests</code></dt><dd>Supports the <a href="https://github.com/grosser/parallel_tests">parallel_tests</a> testing library.</dd></dl></blockquote>
|
30
|
-
<h2 id="see-also"
|
30
|
+
<h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/tork-runner.1.html">tork-runner(1)</a>, <a class="md2man-reference" href="../man1/tork-driver.1.html">tork-driver(1)</a>, <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a></p></div></body>
|
31
31
|
</html>
|
data/man/style.css
CHANGED
@@ -40,15 +40,20 @@
|
|
40
40
|
float: left;
|
41
41
|
margin-left: -1em;
|
42
42
|
opacity: 0.25;
|
43
|
+
font-size: xx-large;
|
43
44
|
}
|
44
45
|
|
45
46
|
a.md2man-permalink:before {
|
46
|
-
content: '\
|
47
|
+
content: '\2605'; /* ★ */
|
47
48
|
}
|
48
49
|
|
49
50
|
a.md2man-permalink:hover,
|
50
51
|
*:target > a.md2man-permalink {
|
51
|
-
opacity:
|
52
|
+
opacity: inherit;
|
53
|
+
}
|
54
|
+
|
55
|
+
*:target > a.md2man-permalink {
|
56
|
+
color: red;
|
52
57
|
}
|
53
58
|
}
|
54
59
|
|
data/tork.gemspec
CHANGED
@@ -21,9 +21,9 @@ Gem::Specification.new do |s|
|
|
21
21
|
|
22
22
|
s.files += Dir['man/man?/*.?'] # UNIX man pages
|
23
23
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
24
|
-
s.add_development_dependency 'md2man', '~>
|
24
|
+
s.add_development_dependency 'md2man', '~> 5.0'
|
25
25
|
|
26
|
-
s.add_runtime_dependency 'binman', '~>
|
26
|
+
s.add_runtime_dependency 'binman', '~> 5.0'
|
27
27
|
s.add_runtime_dependency 'json', '~> 1.6'
|
28
28
|
s.add_runtime_dependency 'listen', '~> 1.0'
|
29
29
|
s.add_runtime_dependency 'diff-lcs', '~> 1.1'
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tork
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 20.0.
|
4
|
+
version: 20.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Suraj N. Kurapati
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date:
|
12
|
+
date: 2016-02-13 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: md2man
|
@@ -17,28 +17,28 @@ dependencies:
|
|
17
17
|
requirements:
|
18
18
|
- - "~>"
|
19
19
|
- !ruby/object:Gem::Version
|
20
|
-
version: '
|
20
|
+
version: '5.0'
|
21
21
|
type: :development
|
22
22
|
prerelease: false
|
23
23
|
version_requirements: !ruby/object:Gem::Requirement
|
24
24
|
requirements:
|
25
25
|
- - "~>"
|
26
26
|
- !ruby/object:Gem::Version
|
27
|
-
version: '
|
27
|
+
version: '5.0'
|
28
28
|
- !ruby/object:Gem::Dependency
|
29
29
|
name: binman
|
30
30
|
requirement: !ruby/object:Gem::Requirement
|
31
31
|
requirements:
|
32
32
|
- - "~>"
|
33
33
|
- !ruby/object:Gem::Version
|
34
|
-
version: '
|
34
|
+
version: '5.0'
|
35
35
|
type: :runtime
|
36
36
|
prerelease: false
|
37
37
|
version_requirements: !ruby/object:Gem::Requirement
|
38
38
|
requirements:
|
39
39
|
- - "~>"
|
40
40
|
- !ruby/object:Gem::Version
|
41
|
-
version: '
|
41
|
+
version: '5.0'
|
42
42
|
- !ruby/object:Gem::Dependency
|
43
43
|
name: json
|
44
44
|
requirement: !ruby/object:Gem::Requirement
|
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
209
209
|
version: '0'
|
210
210
|
requirements: []
|
211
211
|
rubyforge_project:
|
212
|
-
rubygems_version: 2.
|
212
|
+
rubygems_version: 2.5.1
|
213
213
|
signing_key:
|
214
214
|
specification_version: 4
|
215
215
|
summary: test with fork
|
data/man/man0/README.markdown
DELETED
@@ -1,214 +0,0 @@
|
|
1
|
-
|
2
|
-
_______ _______
|
3
|
-
___ /___________ /__
|
4
|
-
_ __/ __ \ __/ /_/
|
5
|
-
/ /_/ /_/ / / / ,\
|
6
|
-
\__/\____/_/ /_/|_\
|
7
|
-
>>>------>
|
8
|
-
|
9
|
-
* Manuals: <https://sunaku.github.io/tork/man>
|
10
|
-
* Sources: <https://github.com/sunaku/tork>
|
11
|
-
* Support: <https://github.com/sunaku/tork/issues>
|
12
|
-
* Package: <https://rubygems.org/gems/tork>
|
13
|
-
|
14
|
-
# _Test with fork_
|
15
|
-
|
16
|
-
Tork runs your tests as they change, in parallel:
|
17
|
-
|
18
|
-
1. Absorbs test execution overhead into a master process.
|
19
|
-
|
20
|
-
2. Forks to inherit overhead and run test files in parallel.
|
21
|
-
|
22
|
-
3. Avoids running unchanged tests inside changed test files.
|
23
|
-
|
24
|
-
## Features
|
25
|
-
|
26
|
-
* No configuration necessary: simply run `tork` to start testing *now!*
|
27
|
-
|
28
|
-
* Runs test files in parallel using fork for multi-core/CPU utilization.
|
29
|
-
|
30
|
-
* Tests *changes* your Ruby application for rapid TDD: avoids running (1)
|
31
|
-
unchanged test files and (2) unchanged tests inside changed test files.
|
32
|
-
|
33
|
-
* Supports MiniTest, Test::Unit, RSpec, and *any testing framework* that (1)
|
34
|
-
exits with a nonzero status to indicate test failures and (2) is loaded by
|
35
|
-
your application's `test/test_helper.rb` or `spec/spec_helper.rb` file.
|
36
|
-
|
37
|
-
* Logs the output from your tests into separate files: one log per test.
|
38
|
-
|
39
|
-
* Configurable through Ruby scripts in your current working directory.
|
40
|
-
|
41
|
-
* You can override the modular `tork*` programs with your own in $PATH.
|
42
|
-
|
43
|
-
* You can remotely control other `tork*` programs using tork-remote(1).
|
44
|
-
|
45
|
-
### Architecture
|
46
|
-
|
47
|
-
Following UNIX philosophy, Tork is composed of simple text-based programs that
|
48
|
-
*do one thing well*. As a result, you can even create your own user interface
|
49
|
-
for Tork by wrapping the tork-driver(1) program appropriately!
|
50
|
-
|
51
|
-
* tork(1) is an interactive command-line user interface for tork-driver(1)
|
52
|
-
* tork-runner(1) runs your test suite once, non-interactively, and then exits
|
53
|
-
* tork-herald(1) monitors current directory tree and reports changed files
|
54
|
-
* tork-driver(1) drives the engine according to the herald's observations
|
55
|
-
* tork-engine(1) tells master to run tests and keeps track of test results
|
56
|
-
* tork-master(1) absorbs test execution overhead and forks to run your tests
|
57
|
-
* tork-remote(1) remotely controls any Tork program running in the same `pwd`
|
58
|
-
* tork-notify(1) notifies you when previously passing tests fail or vice versa
|
59
|
-
|
60
|
-
When the herald observes that files in or beneath the current directory have
|
61
|
-
been written to, it tells the driver, which then commands the master to fork a
|
62
|
-
worker process to run the tests affected by those changed files. This is all
|
63
|
-
performed *automatically*. However, to run a test file *manually*, you can:
|
64
|
-
|
65
|
-
1. Simply save the file! When you do, Tork tries to figure out which tests
|
66
|
-
inside your newly saved test file have changed (using diff and regexps)
|
67
|
-
and then attempts to run just those. To make it run *all* tests in your
|
68
|
-
saved file, simply save the file *again* without changing it.
|
69
|
-
|
70
|
-
2. Type `t` followed by a space and the file you want to run into tork(1):
|
71
|
-
|
72
|
-
# run all of test/some_test.rb
|
73
|
-
t test/some_test.rb
|
74
|
-
|
75
|
-
# run lines 4, 33, and 21 of test/some_test.rb
|
76
|
-
t test/some_test.rb 4 33 21
|
77
|
-
|
78
|
-
3. Send a `["run_test_file"]` message to tork-engine(1) using tork-remote(1):
|
79
|
-
|
80
|
-
# run all of test/some_test.rb
|
81
|
-
echo run_test_file test/some_test.rb | tork-remote tork-engine
|
82
|
-
|
83
|
-
# run lines 4, 33, and 21 of test/some_test.rb
|
84
|
-
echo run_test_file test/some_test.rb 4 33 21 | tork-remote tork-engine
|
85
|
-
|
86
|
-
Alternatively, you can use tork-runner(1) to run your test suite in one shot
|
87
|
-
and then exit with a nonzero status if tests failed, similar to `rake test`.
|
88
|
-
|
89
|
-
## Installation
|
90
|
-
|
91
|
-
gem install tork
|
92
|
-
|
93
|
-
### Prerequisites
|
94
|
-
|
95
|
-
* Ruby 1.8.7 or 1.9.3 or newer.
|
96
|
-
|
97
|
-
* Operating system that supports POSIX signals and the `fork()` system call.
|
98
|
-
To check if your system qualifies, launch irb(1) and enter the following:
|
99
|
-
|
100
|
-
Process.respond_to? :fork # must be true
|
101
|
-
Signal.list.key? 'TERM' # must be true
|
102
|
-
Signal.list.key? 'KILL' # must be true
|
103
|
-
|
104
|
-
* To make the tork-herald(1) program's filesystem monitoring more efficient:
|
105
|
-
|
106
|
-
gem install rb-inotify # linux
|
107
|
-
gem install rb-fsevent # macosx
|
108
|
-
|
109
|
-
### Development
|
110
|
-
|
111
|
-
git clone git://github.com/sunaku/tork
|
112
|
-
cd tork
|
113
|
-
bundle install
|
114
|
-
bundle exec tork --help # run it directly
|
115
|
-
bundle exec rake --tasks # packaging tasks
|
116
|
-
|
117
|
-
## Usage
|
118
|
-
|
119
|
-
### At the command line
|
120
|
-
|
121
|
-
tork --help
|
122
|
-
|
123
|
-
You can add line editing, history, and filename completion:
|
124
|
-
|
125
|
-
rlwrap -c tork
|
126
|
-
|
127
|
-
You can control tork(1) interactively from another terminal:
|
128
|
-
|
129
|
-
tork-remote tork-engine
|
130
|
-
# type your commands here, one per line.
|
131
|
-
# press Control-D to exit tork-remote(1)
|
132
|
-
|
133
|
-
You can also do the same non-interactively using a pipeline:
|
134
|
-
|
135
|
-
# run lines 4, 33, and 21 of test/some_test.rb
|
136
|
-
echo run_test_file test/some_test.rb 4 33 21 | tork-remote tork-engine
|
137
|
-
|
138
|
-
You can monitor your test processes from another terminal:
|
139
|
-
|
140
|
-
watch 'pgrep -f ^tork | xargs -r ps uf'
|
141
|
-
|
142
|
-
### With Bundler
|
143
|
-
|
144
|
-
The `bundler` configuration helper loads a Bundler bundle into tork-master(1).
|
145
|
-
The `default` configuration helper does this for you automatically if there is
|
146
|
-
a `Gemfile` or `Gemfile.lock` file present in your current working directory.
|
147
|
-
|
148
|
-
As a result, you don't need to add Tork to your `Gemfile` _just_ to run tests!
|
149
|
-
Instead, installing Tork as a Ruby gem _outside_ of your bundle is sufficient.
|
150
|
-
|
151
|
-
Try it: go into any bundled application and call `tork` to run its test suite.
|
152
|
-
|
153
|
-
### With MiniTest
|
154
|
-
|
155
|
-
MiniTest 1.3.2 and newer contain a bug where `minitest/autorun` won't run any
|
156
|
-
tests if someone calls `Kernel#exit` explicitly or simply loads a library
|
157
|
-
(such as RSpec) which makes the call implicitly. Use Tork 19.0.2+ to avoid
|
158
|
-
this problem or [apply this patch to the minitest library](
|
159
|
-
https://github.com/seattlerb/minitest/pull/183/files ) to fix the problem.
|
160
|
-
|
161
|
-
### With RSpec
|
162
|
-
|
163
|
-
RSpec 2.9.0 and newer contain a bug where RSpec's autorun helper won't run any
|
164
|
-
specs if someone calls `Kernel#exit` explicitly or simply loads a library
|
165
|
-
(such as Test::Unit) which makes the call implicitly. Use Tork 19.0.2+ to
|
166
|
-
avoid this problem or [apply this patch to the rspec-core library](
|
167
|
-
https://github.com/rspec/rspec-core/pull/720/files ) to fix the problem.
|
168
|
-
|
169
|
-
RSpec 2.8.0 and older contain [a bug](
|
170
|
-
https://github.com/sunaku/tork/issues/31 ) where a nonzero exit status (caused
|
171
|
-
by an uncaught exception) is overridden by RSpec's `Kernel#at_exit` handler to
|
172
|
-
be zero, thereby falsely indicating that a spec had passed. [This patch](
|
173
|
-
https://github.com/rspec/rspec-core/pull/569/files ) fixes the problem.
|
174
|
-
|
175
|
-
### With [Ruby on Rails]
|
176
|
-
|
177
|
-
For Rails 3 or newer, use the `rails` configuration helper *before* the `test`
|
178
|
-
or `spec` helpers. Otherwise your test helper will load Rails *before* the
|
179
|
-
specified `rails` configuration helper has a chance to disable class caching!
|
180
|
-
|
181
|
-
For older Rails, make sure your `config/environments/test.rb` file contains:
|
182
|
-
|
183
|
-
config.cache_classes = false
|
184
|
-
|
185
|
-
For older Rails, to use SQLite3 as your test database, install the [in-memory
|
186
|
-
database adapter][memory_test_fix]. Otherwise, you *might* face these errors:
|
187
|
-
|
188
|
-
> SQLite3::BusyException: database is locked
|
189
|
-
|
190
|
-
> cannot start a transaction within a transaction
|
191
|
-
|
192
|
-
For older Rails, to use SQLite3 as your test database along with browser-based
|
193
|
-
acceptance testing frameworks such as Capybara, see
|
194
|
-
http://www.spacevatican.org/2012/8/18/threading-the-rat/
|
195
|
-
|
196
|
-
## Configuration
|
197
|
-
|
198
|
-
Tork looks for a configuration directory named `.tork/` inside its working
|
199
|
-
directory. The configuration directory contains specially-named Ruby scripts,
|
200
|
-
within which you can query and modify the settings for various tork programs.
|
201
|
-
See the "FILES" sections in the manual pages of tork programs for details.
|
202
|
-
|
203
|
-
Note that tork *does not* automatically reload changes from your configuration
|
204
|
-
directory. Consequently, you must restart tork if your configuration changes.
|
205
|
-
|
206
|
-
## License
|
207
|
-
|
208
|
-
Released under the ISC license. See the LICENSE file for details.
|
209
|
-
|
210
|
-
[factory_girl]: https://github.com/thoughtbot/factory_girl
|
211
|
-
[memory_test_fix]: https://github.com/stepahn/memory_test_fix
|
212
|
-
[parallel_tests]: https://github.com/grosser/parallel_tests
|
213
|
-
[Ruby on Rails]: http://rubyonrails.org
|
214
|
-
[Cucumber]: https://cukes.info
|