feature: implemented the env_to_nginx() Perl utility function as per Rollin Crittendon's request. for example: env_to_nginx('foo', 'bar=hello world')

Author: agentzh

lib/Test/Nginx/Socket.pm

@@ -27,7 +27,7 @@ use IO::Socket;
 
 #our ($PrevRequest, $PrevConfig);
 
-our @EXPORT = qw( is_str plan run_tests run_test
+our @EXPORT = qw( env_to_nginx is_str plan run_tests run_test
   repeat_each config_preamble worker_connections
   master_process_enabled
   no_long_string workers master_on master_off
@@ -2178,6 +2178,71 @@ to run the specified number of duplicate requests for each test block. When it i
 
 Default to 1.
 
+=head2 env_to_nginx
+
+Specify additional system environmnt variables to be passed into the nginx server.
+
+For example,
+
+    env_to_nginx("foo", "bar=123", "baz=hello world");
+    run_tests();
+
+will result in the following lines to be inserted into the resulting F<nginx.conf> file generated by the test scaffold:
+
+    env foo;
+    env bar=123;
+    env 'baz=hello world';
+
+The latter two are examples of setting values directly to the environments. You can also set values directly on the Perl land, before calling this C<env_to_nginx> function, for instance,
+
+    $ENV{baz} = 'hello world';
+    env_to_nginx("baz");
+
+If you just want to pass certain environments to a particular test case (or test block), you can just
+use the C<--- main_config> secion directly. For example,
+
+    --- main_config
+    env foo;
+    env bar=123;
+
+You can check out nginx's official document on its C<env> directive below:
+
+L<http://nginx.org/r/env>
+
+By default, only the following environments are passed:
+
+=over
+
+=item *
+
+MOCKEAGAIN_VERBOSE
+
+=item *
+
+MOCKEAGAIN
+
+=item *
+
+MOCKEAGAIN_WRITE_TIMEOUT_PATTERN
+
+=item *
+
+LD_PRELOAD
+
+=item *
+
+LD_LIBRARY_PATH
+
+=item *
+
+DYLD_INSERT_LIBRARIES
+
+=item *
+
+DYLD_FORCE_FLAT_NAMESPACE
+
+=back
+
 =head2 workers
 
 Call this function before C<run_tests()> to configure Nginx's C<worker_processes> directive's value. For example,

lib/Test/Nginx/Util.pm

@@ -20,6 +20,7 @@ use Scalar::Util qw( looks_like_number );
 use IO::Socket::INET;
 use IO::Socket::UNIX;
 use Test::LongString;
+use Carp qw( croak );
 
 our $ConfigVersion;
 our $FilterHttpConfig;
@@ -240,6 +241,19 @@ our $ForceRestartOnTest     = (defined $ENV{TEST_NGINX_FORCE_RESTART_ON_TEST})
 our $ChildPid;
 our $UdpServerPid;
 our $TcpServerPid;
+our @EnvToNginx;
+
+sub env_to_nginx (@) {
+    if (!@_) {
+        croak "env_to_nginx: no arguments specified";
+    }
+    for my $v (@_) {
+        if ($v !~ /^[A-Za-z_]/ || $v =~ /\n/) {
+            croak "env_to_nginx: bad argument value: $v\n";
+        }
+        push @EnvToNginx, $v;
+    }
+}
 
 sub sleep_time {
     return $TestNginxSleep;
@@ -333,6 +347,7 @@ sub master_process_enabled (@) {
 }
 
 our @EXPORT = qw(
+    env_to_nginx
     is_str
     check_accum_error_log
     is_running
@@ -811,6 +826,16 @@ env LD_PRELOAD;
 env LD_LIBRARY_PATH;
 env DYLD_INSERT_LIBRARIES;
 env DYLD_FORCE_FLAT_NAMESPACE;
+_EOC_
+
+    for my $v (@EnvToNginx) {
+        if ($v =~ /\s/) {
+            $v = "'$v'";
+        }
+        print $out "env $v;\n";
+    }
+
+    print $out <<_EOC_;
 #env LUA_PATH;
 #env LUA_CPATH;