unicorn 5.0.1 → 6.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. checksums.yaml +5 -5
  2. data/.manifest +11 -5
  3. data/.olddoc.yml +16 -6
  4. data/Application_Timeouts +4 -4
  5. data/CONTRIBUTORS +6 -2
  6. data/Documentation/.gitignore +1 -3
  7. data/Documentation/unicorn.1 +222 -0
  8. data/Documentation/unicorn_rails.1 +207 -0
  9. data/FAQ +1 -1
  10. data/GIT-VERSION-FILE +1 -1
  11. data/GIT-VERSION-GEN +1 -1
  12. data/GNUmakefile +118 -58
  13. data/HACKING +2 -10
  14. data/ISSUES +40 -35
  15. data/KNOWN_ISSUES +2 -2
  16. data/LATEST +23 -28
  17. data/LICENSE +2 -2
  18. data/Links +13 -11
  19. data/NEWS +612 -0
  20. data/README +30 -29
  21. data/SIGNALS +1 -1
  22. data/Sandbox +8 -7
  23. data/TODO +0 -2
  24. data/TUNING +19 -1
  25. data/archive/slrnpull.conf +1 -1
  26. data/bin/unicorn +3 -1
  27. data/bin/unicorn_rails +2 -2
  28. data/examples/big_app_gc.rb +1 -1
  29. data/examples/init.sh +36 -8
  30. data/examples/logrotate.conf +17 -2
  31. data/examples/nginx.conf +4 -3
  32. data/examples/unicorn.conf.minimal.rb +2 -2
  33. data/examples/unicorn.conf.rb +2 -2
  34. data/examples/unicorn@.service +14 -0
  35. data/ext/unicorn_http/c_util.h +5 -13
  36. data/ext/unicorn_http/common_field_optimization.h +22 -5
  37. data/ext/unicorn_http/epollexclusive.h +124 -0
  38. data/ext/unicorn_http/ext_help.h +0 -44
  39. data/ext/unicorn_http/extconf.rb +32 -6
  40. data/ext/unicorn_http/global_variables.h +2 -2
  41. data/ext/unicorn_http/httpdate.c +2 -1
  42. data/ext/unicorn_http/unicorn_http.c +853 -498
  43. data/ext/unicorn_http/unicorn_http.rl +86 -30
  44. data/ext/unicorn_http/unicorn_http_common.rl +1 -1
  45. data/lib/unicorn/configurator.rb +93 -13
  46. data/lib/unicorn/http_request.rb +101 -11
  47. data/lib/unicorn/http_response.rb +8 -4
  48. data/lib/unicorn/http_server.rb +141 -72
  49. data/lib/unicorn/launcher.rb +1 -1
  50. data/lib/unicorn/oob_gc.rb +6 -6
  51. data/lib/unicorn/select_waiter.rb +6 -0
  52. data/lib/unicorn/socket_helper.rb +23 -7
  53. data/lib/unicorn/stream_input.rb +5 -4
  54. data/lib/unicorn/tee_input.rb +8 -10
  55. data/lib/unicorn/tmpio.rb +8 -2
  56. data/lib/unicorn/util.rb +3 -3
  57. data/lib/unicorn/version.rb +1 -1
  58. data/lib/unicorn/worker.rb +33 -8
  59. data/lib/unicorn.rb +55 -29
  60. data/man/man1/unicorn.1 +120 -118
  61. data/man/man1/unicorn_rails.1 +106 -107
  62. data/t/GNUmakefile +3 -72
  63. data/t/README +4 -4
  64. data/t/t0011-active-unix-socket.sh +1 -1
  65. data/t/t0012-reload-empty-config.sh +2 -1
  66. data/t/t0301-no-default-middleware-ignored-in-config.sh +25 -0
  67. data/t/t0301.ru +13 -0
  68. data/t/test-lib.sh +4 -3
  69. data/test/benchmark/README +14 -4
  70. data/test/benchmark/ddstream.ru +50 -0
  71. data/test/benchmark/readinput.ru +40 -0
  72. data/test/benchmark/uconnect.perl +66 -0
  73. data/test/exec/test_exec.rb +26 -24
  74. data/test/test_helper.rb +38 -30
  75. data/test/unit/test_ccc.rb +91 -0
  76. data/test/unit/test_droplet.rb +1 -1
  77. data/test/unit/test_http_parser.rb +46 -16
  78. data/test/unit/test_http_parser_ng.rb +81 -0
  79. data/test/unit/test_request.rb +10 -10
  80. data/test/unit/test_server.rb +86 -12
  81. data/test/unit/test_signals.rb +8 -8
  82. data/test/unit/test_socket_helper.rb +13 -9
  83. data/test/unit/test_upload.rb +9 -14
  84. data/test/unit/test_util.rb +31 -5
  85. data/test/unit/test_waiter.rb +34 -0
  86. data/unicorn.gemspec +21 -22
  87. metadata +21 -28
  88. data/Documentation/GNUmakefile +0 -30
  89. data/Documentation/unicorn.1.txt +0 -188
  90. data/Documentation/unicorn_rails.1.txt +0 -175
  91. data/t/hijack.ru +0 -43
  92. data/t/t0200-rack-hijack.sh +0 -30
@@ -1,195 +1,186 @@
1
- .TH UNICORN_RAILS 1 "September 17, 2009" "Unicorn User Manual"
1
+ .TH "UNICORN_RAILS" "1" "September 17, 2009" "Unicorn User Manual" ""
2
+ .hy
2
3
  .SH NAME
3
4
  .PP
4
- unicorn_rails - a script/server-like command to launch the Unicorn HTTP
5
- server
5
+ unicorn_rails \- unicorn launcher for Rails 1.x and 2.x users
6
6
  .SH SYNOPSIS
7
7
  .PP
8
- unicorn_rails [-c CONFIG_FILE] [-E RAILS_ENV] [-D] [RACKUP_FILE]
8
+ unicorn_rails [\-c CONFIG_FILE] [\-E RAILS_ENV] [\-D] [RACKUP_FILE]
9
9
  .SH DESCRIPTION
10
10
  .PP
11
- A rackup(1)-like command to launch Rails applications using Unicorn.
12
- It is expected to be started in your Rails application root
13
- (RAILS_ROOT), but the "working_directory" directive may be used in the
14
- CONFIG_FILE.
11
+ A rackup(1)\-like command to launch ancient Rails (2.x and earlier)
12
+ applications using Unicorn. Rails 3 (and later) support Rack natively,
13
+ so users are encouraged to use unicorn(1) instead of unicorn_rails(1).
15
14
  .PP
16
- It is designed to help Rails 1.x and 2.y users transition to Rack, but
17
- it is NOT needed for Rails 3 applications.
18
- Rails 3 users are encouraged to use unicorn(1) instead of
19
- unicorn_rails(1).
20
- Users of Rails 1.x/2.y may also use unicorn(1) instead of
21
- unicorn_rails(1).
15
+ It is expected to be started in your Rails application root (RAILS_ROOT),
16
+ but the "working_directory" directive may be used in the CONFIG_FILE.
22
17
  .PP
23
18
  The outward interface resembles rackup(1), the internals and default
24
19
  middleware loading is designed like the \f[C]script/server\f[] command
25
20
  distributed with Rails.
26
21
  .PP
27
- While Unicorn takes a myriad of command-line options for compatibility
22
+ While Unicorn takes a myriad of command\-line options for compatibility
28
23
  with ruby(1) and rackup(1), it is recommended to stick to the few
29
- command-line options specified in the SYNOPSIS and use the CONFIG_FILE
24
+ command\-line options specified in the SYNOPSIS and use the CONFIG_FILE
30
25
  as much as possible.
31
26
  .SH UNICORN OPTIONS
32
27
  .TP
33
- .B -c, --config-file CONFIG_FILE
34
- Path to the Unicorn-specific config file.
35
- The config file is implemented as a Ruby DSL, so Ruby code may executed.
36
- See the RDoc/ri for the \f[I]Unicorn::Configurator\f[] class for the
37
- full list of directives available from the DSL.
38
- Using an absolute path for for CONFIG_FILE is recommended as it makes
39
- multiple instances of Unicorn easily distinguishable when viewing ps(1)
40
- output.
28
+ .B \-c, \-\-config\-file CONFIG_FILE
29
+ Path to the Unicorn\-specific config file. The config file is
30
+ implemented as a Ruby DSL, so Ruby code may executed.
31
+ See the RDoc/ri for the \f[I]Unicorn::Configurator\f[] class for the full
32
+ list of directives available from the DSL.
33
+ Using an absolute path for for CONFIG_FILE is recommended as it
34
+ makes multiple instances of Unicorn easily distinguishable when
35
+ viewing ps(1) output.
41
36
  .RS
42
37
  .RE
43
38
  .TP
44
- .B -D, --daemonize
45
- Run daemonized in the background.
46
- The process is detached from the controlling terminal and stdin is
47
- redirected to "/dev/null".
39
+ .B \-D, \-\-daemonize
40
+ Run daemonized in the background. The process is detached from
41
+ the controlling terminal and stdin is redirected to "/dev/null".
48
42
  Unlike many common UNIX daemons, we do not chdir to "/" upon
49
- daemonization to allow more control over the startup/upgrade process.
50
- Unless specified in the CONFIG_FILE, stderr and stdout will also be
51
- redirected to "/dev/null".
43
+ daemonization to allow more control over the startup/upgrade
44
+ process.
45
+ Unless specified in the CONFIG_FILE, stderr and stdout will
46
+ also be redirected to "/dev/null".
52
47
  Daemonization will \f[I]skip\f[] loading of the
53
- \f[I]Rails::Rack::LogTailer\f[] middleware under Rails >= 2.3.x.
48
+ \f[I]Rails::Rack::LogTailer\f[]
49
+ middleware under Rails >= 2.3.x.
54
50
  By default, unicorn_rails(1) will create a PID file in
55
- \f[I]"RAILS_ROOT/tmp/pids/unicorn.pid"\f[].
56
- You may override this by specifying the "pid" directive to override this
57
- Unicorn config file.
51
+ \f[I]"RAILS_ROOT/tmp/pids/unicorn.pid"\f[]. You may override this
52
+ by specifying the "pid" directive to override this Unicorn config file.
58
53
  .RS
59
54
  .RE
60
55
  .TP
61
- .B -E, --env RAILS_ENV
62
- Run under the given RAILS_ENV.
63
- This sets the RAILS_ENV environment variable.
64
- Acceptable values are exactly those you expect in your Rails
56
+ .B \-E, \-\-env RAILS_ENV
57
+ Run under the given RAILS_ENV. This sets the RAILS_ENV environment
58
+ variable. Acceptable values are exactly those you expect in your Rails
65
59
  application, typically "development" or "production".
66
60
  .RS
67
61
  .RE
68
62
  .TP
69
- .B -l, --listen ADDRESS
70
- Listens on a given ADDRESS.
71
- ADDRESS may be in the form of HOST:PORT or PATH, HOST:PORT is taken to
72
- mean a TCP socket and PATH is meant to be a path to a UNIX domain
73
- socket.
63
+ .B \-l, \-\-listen ADDRESS
64
+ Listens on a given ADDRESS. ADDRESS may be in the form of
65
+ HOST:PORT or PATH, HOST:PORT is taken to mean a TCP socket
66
+ and PATH is meant to be a path to a UNIX domain socket.
74
67
  Defaults to "0.0.0.0:8080" (all addresses on TCP port 8080).
75
68
  For production deployments, specifying the "listen" directive in
76
- CONFIG_FILE is recommended as it allows fine-tuning of socket options.
69
+ CONFIG_FILE is recommended as it allows fine\-tuning of socket
70
+ options.
77
71
  .RS
78
72
  .RE
79
73
  .SH RACKUP COMPATIBILITY OPTIONS
80
74
  .TP
81
- .B -o, --host HOST
82
- Listen on a TCP socket belonging to HOST, default is "0.0.0.0" (all
83
- addresses).
84
- If specified multiple times on the command-line, only the last-specified
85
- value takes effect.
75
+ .B \-o, \-\-host HOST
76
+ Listen on a TCP socket belonging to HOST, default is
77
+ "0.0.0.0" (all addresses).
78
+ If specified multiple times on the command\-line, only the
79
+ last\-specified value takes effect.
86
80
  This option only exists for compatibility with the rackup(1) command,
87
- use of "-l"/"--listen" switch is recommended instead.
81
+ use of "\-l"/"\-\-listen" switch is recommended instead.
88
82
  .RS
89
83
  .RE
90
84
  .TP
91
- .B -p, --port PORT
85
+ .B \-p, \-\-port PORT
92
86
  Listen on the specified TCP PORT, default is 8080.
93
- If specified multiple times on the command-line, only the last-specified
87
+ If specified multiple times on the command\-line, only the last\-specified
94
88
  value takes effect.
95
89
  This option only exists for compatibility with the rackup(1) command,
96
- use of "-l"/"--listen" switch is recommended instead.
90
+ use of "\-l"/"\-\-listen" switch is recommended instead.
97
91
  .RS
98
92
  .RE
99
93
  .TP
100
- .B --path PATH
94
+ .B \-\-path PATH
101
95
  Mounts the Rails application at the given PATH (instead of "/").
102
- This is equivalent to setting the RAILS_RELATIVE_URL_ROOT environment
103
- variable.
104
- This is only supported under Rails 2.3 or later at the moment.
96
+ This is equivalent to setting the RAILS_RELATIVE_URL_ROOT
97
+ environment variable. This is only supported under Rails 2.3
98
+ or later at the moment.
105
99
  .RS
106
100
  .RE
107
101
  .SH RUBY OPTIONS
108
102
  .TP
109
- .B -e, --eval LINE
110
- Evaluate a LINE of Ruby code.
111
- This evaluation happens immediately as the command-line is being parsed.
103
+ .B \-e, \-\-eval LINE
104
+ Evaluate a LINE of Ruby code. This evaluation happens
105
+ immediately as the command\-line is being parsed.
112
106
  .RS
113
107
  .RE
114
108
  .TP
115
- .B -d, --debug
109
+ .B \-d, \-\-debug
116
110
  Turn on debug mode, the $DEBUG variable is set to true.
117
111
  For Rails >= 2.3.x, this loads the \f[I]Rails::Rack::Debugger\f[]
118
112
  middleware.
119
113
  .RS
120
114
  .RE
121
115
  .TP
122
- .B -w, --warn
116
+ .B \-w, \-\-warn
123
117
  Turn on verbose warnings, the $VERBOSE variable is set to true.
124
118
  .RS
125
119
  .RE
126
120
  .TP
127
- .B -I, --include PATH
128
- specify $LOAD_PATH.
129
- PATH will be prepended to $LOAD_PATH.
121
+ .B \-I, \-\-include PATH
122
+ specify $LOAD_PATH. PATH will be prepended to $LOAD_PATH.
130
123
  The \[aq]:\[aq] character may be used to delimit multiple directories.
131
- This directive may be used more than once.
132
- Modifications to $LOAD_PATH take place immediately and in the order they
133
- were specified on the command-line.
124
+ This directive may be used more than once. Modifications to
125
+ $LOAD_PATH take place immediately and in the order they were
126
+ specified on the command\-line.
134
127
  .RS
135
128
  .RE
136
129
  .TP
137
- .B -r, --require LIBRARY
138
- require a specified LIBRARY before executing the application.
139
- The "require" statement will be executed immediately and in the order
140
- they were specified on the command-line.
130
+ .B \-r, \-\-require LIBRARY
131
+ require a specified LIBRARY before executing the application. The
132
+ "require" statement will be executed immediately and in the order
133
+ they were specified on the command\-line.
141
134
  .RS
142
135
  .RE
143
136
  .SH RACKUP FILE
144
137
  .PP
145
- This defaults to "config.ru" in RAILS_ROOT.
146
- It should be the same file used by rackup(1) and other Rack launchers,
147
- it uses the \f[I]Rack::Builder\f[] DSL.
148
- Unlike many other Rack applications, RACKUP_FILE is completely
149
- \f[I]optional\f[] for Rails, but may be used to disable some of the
150
- default middleware for performance.
138
+ This defaults to "config.ru" in RAILS_ROOT. It should be the same
139
+ file used by rackup(1) and other Rack launchers, it uses the
140
+ \f[I]Rack::Builder\f[] DSL. Unlike many other Rack applications, RACKUP_FILE
141
+ is completely \f[I]optional\f[] for Rails, but may be used to disable
142
+ some of the default middleware for performance.
151
143
  .PP
152
- Embedded command-line options are mostly parsed for compatibility with
153
- rackup(1) but strongly discouraged.
144
+ Embedded command\-line options are mostly parsed for compatibility
145
+ with rackup(1) but strongly discouraged.
154
146
  .SH ENVIRONMENT VARIABLES
155
147
  .PP
156
- The RAILS_ENV variable is set by the aforementioned -E switch.
157
- The RAILS_RELATIVE_URL_ROOT is set by the aforementioned --path switch.
148
+ The RAILS_ENV variable is set by the aforementioned \-E switch. The
149
+ RAILS_RELATIVE_URL_ROOT is set by the aforementioned \-\-path switch.
158
150
  Either of these variables may also be set in the shell or the Unicorn
159
- CONFIG_FILE.
160
- All application or library-specific environment variables (e.g.
161
- TMPDIR, RAILS_ASSET_ID) may always be set in the Unicorn CONFIG_FILE in
162
- addition to the spawning shell.
163
- When transparently upgrading Unicorn, all environment variables set in
164
- the old master process are inherited by the new master process.
165
- Unicorn only uses (and will overwrite) the UNICORN_FD environment
166
- variable internally when doing transparent upgrades.
151
+ CONFIG_FILE. All application or library\-specific environment variables
152
+ (e.g. TMPDIR, RAILS_ASSET_ID) may always be set in the Unicorn
153
+ CONFIG_FILE in addition to the spawning shell. When transparently
154
+ upgrading Unicorn, all environment variables set in the old master
155
+ process are inherited by the new master process. Unicorn only uses (and
156
+ will overwrite) the UNICORN_FD environment variable internally when
157
+ doing transparent upgrades.
167
158
  .SH SIGNALS
168
159
  .PP
169
160
  The following UNIX signals may be sent to the master process:
170
161
  .IP \[bu] 2
171
- HUP - reload config file, app, and gracefully restart all workers
162
+ HUP \- reload config file, app, and gracefully restart all workers
172
163
  .IP \[bu] 2
173
- INT/TERM - quick shutdown, kills all workers immediately
164
+ INT/TERM \- quick shutdown, kills all workers immediately
174
165
  .IP \[bu] 2
175
- QUIT - graceful shutdown, waits for workers to finish their current
166
+ QUIT \- graceful shutdown, waits for workers to finish their current
176
167
  request before finishing.
177
168
  .IP \[bu] 2
178
- USR1 - reopen all logs owned by the master and all workers See
179
- Unicorn::Util.reopen_logs for what is considered a log.
169
+ USR1 \- reopen all logs owned by the master and all workers
170
+ See Unicorn::Util.reopen_logs for what is considered a log.
180
171
  .IP \[bu] 2
181
- USR2 - reexecute the running binary.
182
- A separate QUIT should be sent to the original process once the child is
183
- verified to be up and running.
172
+ USR2 \- reexecute the running binary. A separate QUIT
173
+ should be sent to the original process once the child is verified to
174
+ be up and running.
184
175
  .IP \[bu] 2
185
- WINCH - gracefully stops workers but keep the master running.
176
+ WINCH \- gracefully stops workers but keep the master running.
186
177
  This will only work for daemonized processes.
187
178
  .IP \[bu] 2
188
- TTIN - increment the number of worker processes by one
179
+ TTIN \- increment the number of worker processes by one
189
180
  .IP \[bu] 2
190
- TTOU - decrement the number of worker processes by one
181
+ TTOU \- decrement the number of worker processes by one
191
182
  .PP
192
- See the SIGNALS (http://unicorn.bogomips.org/SIGNALS.html) document for
183
+ See the SIGNALS (https://yhbt.net/unicorn/SIGNALS.html) document for
193
184
  full description of all signals used by Unicorn.
194
185
  .SH SEE ALSO
195
186
  .IP \[bu] 2
@@ -198,11 +189,19 @@ unicorn(1)
198
189
  \f[I]Rack::Builder\f[] ri/RDoc
199
190
  .IP \[bu] 2
200
191
  \f[I]Unicorn::Configurator\f[] ri/RDoc
192
+ .UR https://yhbt.net/unicorn/Unicorn/Configurator.html
193
+ .UE
201
194
  .IP \[bu] 2
202
- Unicorn RDoc (http://unicorn.bogomips.org/)
195
+ unicorn RDoc
196
+ .UR https://yhbt.net/unicorn/
197
+ .UE
203
198
  .IP \[bu] 2
204
- Rack RDoc (http://www.rubydoc.info/github/rack/rack/)
199
+ Rack RDoc
200
+ .UR https://www.rubydoc.info/github/rack/rack/
201
+ .UE
205
202
  .IP \[bu] 2
206
- Rackup HowTo (https://github.com/rack/rack/wiki/tutorial-rackup-howto)
203
+ Rackup HowTo
204
+ .UR https://github.com/rack/rack/wiki/(tutorial)-rackup-howto
205
+ .UE
207
206
  .SH AUTHORS
208
- The Unicorn Community <unicorn-public@bogomips.org>.
207
+ The Unicorn Community <unicorn-public@yhbt.net>.
data/t/GNUmakefile CHANGED
@@ -1,74 +1,5 @@
1
- # we can run tests in parallel with GNU make
1
+ # there used to be more, here, but we stopped relying on recursive make
2
2
  all::
3
+ $(MAKE) -C .. test-integration
3
4
 
4
- pid := $(shell echo $$PPID)
5
-
6
- RUBY = ruby
7
- RAKE = rake
8
- -include ../local.mk
9
- ifeq ($(RUBY_VERSION),)
10
- RUBY_VERSION := $(shell $(RUBY) -e 'puts RUBY_VERSION')
11
- endif
12
-
13
- ifeq ($(RUBY_VERSION),)
14
- $(error unable to detect RUBY_VERSION)
15
- endif
16
-
17
- RUBY_ENGINE := $(shell $(RUBY) -e 'puts((RUBY_ENGINE rescue "ruby"))')
18
- export RUBY_ENGINE
19
-
20
- MYLIBS := $(RUBYLIB)
21
-
22
- T = $(wildcard t[0-9][0-9][0-9][0-9]-*.sh)
23
-
24
- all:: $(T)
25
-
26
- # can't rely on "set -o pipefail" since we don't require bash or ksh93 :<
27
- t_pfx = trash/$@-$(RUBY_ENGINE)-$(RUBY_VERSION)
28
- TEST_OPTS =
29
- # TRACER = strace -f -o $(t_pfx).strace -s 100000
30
- # TRACER = /usr/bin/time -o $(t_pfx).time
31
-
32
- ifdef V
33
- ifeq ($(V),2)
34
- TEST_OPTS += --trace
35
- else
36
- TEST_OPTS += --verbose
37
- endif
38
- endif
39
-
40
- random_blob:
41
- dd if=/dev/urandom bs=1M count=30 of=$@.$(pid)
42
- mv $@.$(pid) $@
43
-
44
- $(T): random_blob
45
-
46
- dependencies := socat curl
47
- deps := $(addprefix .dep+,$(dependencies))
48
- $(deps): dep_bin = $(lastword $(subst +, ,$@))
49
- $(deps):
50
- @which $(dep_bin) > $@.$(pid) 2>/dev/null || :
51
- @test -s $@.$(pid) || \
52
- { echo >&2 "E '$(dep_bin)' not found in PATH=$(PATH)"; exit 1; }
53
- @mv $@.$(pid) $@
54
- dep: $(deps)
55
-
56
- test_prefix := $(CURDIR)/../test/$(RUBY_ENGINE)-$(RUBY_VERSION)
57
- $(test_prefix)/.stamp:
58
- $(MAKE) -C .. test-install
59
-
60
- $(T): export RUBY := $(RUBY)
61
- $(T): export RAKE := $(RAKE)
62
- $(T): export PATH := $(test_prefix)/bin:$(PATH)
63
- $(T): export RUBYLIB := $(test_prefix)/lib:$(MYLIBS)
64
- $(T): dep $(test_prefix)/.stamp trash/.gitignore
65
- $(TRACER) $(SHELL) $(SH_TEST_OPTS) $@ $(TEST_OPTS)
66
-
67
- trash/.gitignore:
68
- mkdir -p $(@D)
69
- echo '*' > $@
70
-
71
- clean:
72
- $(RM) -r trash/*
73
-
74
- .PHONY: $(T) clean
5
+ .PHONY: all
data/t/README CHANGED
@@ -10,17 +10,17 @@ comfortable writing integration tests with.
10
10
 
11
11
  == Requirements
12
12
 
13
- * {Ruby 1.9.3+}[https://www.ruby-lang.org/] (duh!)
14
- * {GNU make}[http://www.gnu.org/software/make/]
13
+ * {Ruby 2.0.0+}[https://www.ruby-lang.org/en/] (duh!)
14
+ * {GNU make}[https://www.gnu.org/software/make/]
15
15
  * {socat}[http://www.dest-unreach.org/socat/]
16
- * {curl}[http://curl.haxx.se/]
16
+ * {curl}[https://curl.haxx.se/]
17
17
  * standard UNIX shell utilities (Bourne sh, awk, sed, grep, ...)
18
18
 
19
19
  We do not use bashisms or any non-portable, non-POSIX constructs
20
20
  in our shell code. We use the "pipefail" option if available and
21
21
  mainly test with {ksh}[http://kornshell.com/], but occasionally
22
22
  with {dash}[http://gondor.apana.org.au/~herbert/dash/] and
23
- {bash}[http://www.gnu.org/software/bash/], too.
23
+ {bash}[https://www.gnu.org/software/bash/], too.
24
24
 
25
25
  == Running Tests
26
26
 
@@ -52,7 +52,7 @@ t_begin "worker pid unchanged (again)" && {
52
52
  }
53
53
 
54
54
  t_begin "nuking the existing Unicorn succeeds" && {
55
- kill -9 $unicorn_pid $worker_pid
55
+ kill -9 $unicorn_pid
56
56
  while kill -0 $unicorn_pid
57
57
  do
58
58
  sleep 1
@@ -18,7 +18,8 @@ after_fork { |s,w| }
18
18
  next if key =~ %r{\Astd(?:err|out)_path\z}
19
19
  key = key.to_sym
20
20
  def_value = defaults[key]
21
- srv_value = srv.__send__(key)
21
+ srv_value = srv.respond_to?(key) ? srv.__send__(key)
22
+ : srv.instance_variable_get("@#{key}")
22
23
  fp << "#{key}|#{srv_value}|#{def_value}\\n"
23
24
  end
24
25
  }
@@ -0,0 +1,25 @@
1
+ #!/bin/sh
2
+ . ./test-lib.sh
3
+ t_plan 3 "-N / --no-default-middleware option not supported in config.ru"
4
+
5
+ t_begin "setup and start" && {
6
+ unicorn_setup
7
+ RACK_ENV=development unicorn -D -c $unicorn_config t0301.ru
8
+ unicorn_wait_start
9
+ }
10
+
11
+ t_begin "check switches parsed as expected and -N ignored for Rack::Lint" && {
12
+ debug=false
13
+ lint=
14
+ eval "$(curl -sf http://$listen/vars)"
15
+ test x"$debug" = xtrue
16
+ test x"$lint" != x
17
+ test -f "$lint"
18
+ }
19
+
20
+ t_begin "killing succeeds" && {
21
+ kill $unicorn_pid
22
+ check_stderr
23
+ }
24
+
25
+ t_done
data/t/t0301.ru ADDED
@@ -0,0 +1,13 @@
1
+ #\-N --debug
2
+ run(lambda do |env|
3
+ case env['PATH_INFO']
4
+ when '/vars'
5
+ b = "debug=#{$DEBUG.inspect}\n" \
6
+ "lint=#{caller.grep(%r{rack/lint\.rb})[0].split(':')[0]}\n"
7
+ end
8
+ h = {
9
+ 'Content-Length' => b.size.to_s,
10
+ 'Content-Type' => 'text/plain',
11
+ }
12
+ [ 200, h, [ b ] ]
13
+ end)
data/t/test-lib.sh CHANGED
@@ -94,7 +94,8 @@ check_stderr () {
94
94
  set +u
95
95
  _r_err=${1-${r_err}}
96
96
  set -u
97
- if grep -v $T $_r_err | grep -i Error
97
+ if grep -v $T $_r_err | grep -i Error | \
98
+ grep -v NameError.*Unicorn::Waiter
98
99
  then
99
100
  die "Errors found in $_r_err"
100
101
  elif grep SIGKILL $_r_err
@@ -106,8 +107,8 @@ check_stderr () {
106
107
  # unicorn_setup
107
108
  unicorn_setup () {
108
109
  eval $(unused_listen)
109
- port=$(expr $listen : '[^:]*:\([0-9]\+\)')
110
- host=$(expr $listen : '\([^:]*\):[0-9]\+')
110
+ port=$(expr $listen : '[^:]*:\([0-9]*\)')
111
+ host=$(expr $listen : '\([^:][^:]*\):[0-9][0-9]*')
111
112
 
112
113
  rtmpfiles unicorn_config pid r_err r_out fifo tmp ok
113
114
  cat > $unicorn_config <<EOF
@@ -42,9 +42,19 @@ The benchmark client is usually httperf.
42
42
  Another gentle reminder: performance with slow networks/clients
43
43
  is NOT our problem. That is the job of nginx (or similar).
44
44
 
45
+ == ddstream.ru
46
+
47
+ Standalone Rack app intended to show how BAD we are at slow clients.
48
+ See usage in comments.
49
+
50
+ == readinput.ru
51
+
52
+ Standalone Rack app intended to show how bad we are with slow uploaders.
53
+ See usage in comments.
54
+
45
55
  == Contributors
46
56
 
47
- This directory is maintained independently in the "benchmark" branch
48
- based against v0.1.0. Only changes to this directory (test/benchmarks)
49
- are committed to this branch although the master branch may merge this
50
- branch occassionaly.
57
+ This directory is intended to remain stable. Do not make changes
58
+ to benchmarking code which can change performance and invalidate
59
+ results across revisions. Instead, write new benchmarks and update
60
+ coments/documentation as necessary.
@@ -0,0 +1,50 @@
1
+ # This app is intended to test large HTTP responses with or without
2
+ # a fully-buffering reverse proxy such as nginx. Without a fully-buffering
3
+ # reverse proxy, unicorn will be unresponsive when client count exceeds
4
+ # worker_processes.
5
+ #
6
+ # To demonstrate how bad unicorn is at slowly reading clients:
7
+ #
8
+ # # in one terminal, start unicorn with one worker:
9
+ # unicorn -E none -l 127.0.0.1:8080 test/benchmark/ddstream.ru
10
+ #
11
+ # # in a different terminal, start more slow curl processes than
12
+ # # unicorn workers and watch time outputs
13
+ # curl --limit-rate 8K --trace-time -vsN http://127.0.0.1:8080/ >/dev/null &
14
+ # curl --limit-rate 8K --trace-time -vsN http://127.0.0.1:8080/ >/dev/null &
15
+ # wait
16
+ #
17
+ # The last client won't see a response until the first one is done reading
18
+ #
19
+ # nginx note: do not change the default "proxy_buffering" behavior.
20
+ # Setting "proxy_buffering off" prevents nginx from protecting unicorn.
21
+
22
+ # totally standalone rack app to stream a giant response
23
+ class BigResponse
24
+ def initialize(bs, count)
25
+ @buf = "#{bs.to_s(16)}\r\n#{' ' * bs}\r\n"
26
+ @count = count
27
+ @res = [ 200,
28
+ { 'Transfer-Encoding' => -'chunked', 'Content-Type' => 'text/plain' },
29
+ self
30
+ ]
31
+ end
32
+
33
+ # rack response body iterator
34
+ def each
35
+ (1..@count).each { yield @buf }
36
+ yield -"0\r\n\r\n"
37
+ end
38
+
39
+ # rack app entry endpoint
40
+ def call(_env)
41
+ @res
42
+ end
43
+ end
44
+
45
+ # default to a giant (128M) response because kernel socket buffers
46
+ # can be ridiculously large on some systems
47
+ bs = ENV['bs'] ? ENV['bs'].to_i : 65536
48
+ count = ENV['count'] ? ENV['count'].to_i : 2048
49
+ warn "serving response with bs=#{bs} count=#{count} (#{bs*count} bytes)"
50
+ run BigResponse.new(bs, count)
@@ -0,0 +1,40 @@
1
+ # This app is intended to test large HTTP requests with or without
2
+ # a fully-buffering reverse proxy such as nginx. Without a fully-buffering
3
+ # reverse proxy, unicorn will be unresponsive when client count exceeds
4
+ # worker_processes.
5
+
6
+ DOC = <<DOC
7
+ To demonstrate how bad unicorn is at slowly uploading clients:
8
+
9
+ # in one terminal, start unicorn with one worker:
10
+ unicorn -E none -l 127.0.0.1:8080 test/benchmark/readinput.ru
11
+
12
+ # in a different terminal, upload 45M from multiple curl processes:
13
+ dd if=/dev/zero bs=45M count=1 | curl -T- -HExpect: --limit-rate 1M \
14
+ --trace-time -v http://127.0.0.1:8080/ &
15
+ dd if=/dev/zero bs=45M count=1 | curl -T- -HExpect: --limit-rate 1M \
16
+ --trace-time -v http://127.0.0.1:8080/ &
17
+ wait
18
+
19
+ # The last client won't see a response until the first one is done uploading
20
+ # You also won't be able to make GET requests to view this documentation
21
+ # while clients are uploading. You can also view the stderr debug output
22
+ # of unicorn (see logging code in #{__FILE__}).
23
+ DOC
24
+
25
+ run(lambda do |env|
26
+ input = env['rack.input']
27
+ buf = ''.b
28
+
29
+ # default logger contains timestamps, rely on that so users can
30
+ # see what the server is doing
31
+ l = env['rack.logger']
32
+
33
+ l.debug('BEGIN reading input ...') if l
34
+ :nop while input.read(16384, buf)
35
+ l.debug('DONE reading input ...') if l
36
+
37
+ buf.clear
38
+ [ 200, [ %W(Content-Length #{DOC.size}), %w(Content-Type text/plain) ],
39
+ [ DOC ] ]
40
+ end)