test: Link unit tests with nginx library.

Some unit tests may use C functions from nginx. To support this
scenario, special static library is built. Necessary linker flags are also
added. Since these changes are needed for specific unit tests only,
new feature "unittest" is defined.

Author: ensh63

Cargo.lock

@@ -2,6 +2,7 @@
 members = [
     "nginx-src",
     "nginx-sys",
+    "nginx-unittest",
     "examples",
 ]
 
@@ -40,7 +41,7 @@ targets = []
 allocator-api2 = { version = "0.3.1", default-features = false }
 async-task = { version = "4.7.1", optional = true }
 lock_api = "0.4.13"
-nginx-sys = { path = "nginx-sys", version = "0.5.0"}
+nginx-sys = { path = "nginx-sys", version = "0.5.0" }
 pin-project-lite = { version = "0.2.16", optional = true }
 
 [features]
@@ -70,3 +71,7 @@ maintenance = { status = "experimental" }
 
 [dev-dependencies]
 tempfile = { version = "3.20.0", default-features = false }
+
+[target.'cfg(not(windows))'.dev-dependencies]
+nginx-sys = { path = "nginx-sys", version = "0.5.0", features = ["unittest"] }
+nginx-unittest = { path = "nginx-unittest", version = "0.1.0" }

Cargo.toml

@@ -0,0 +1,7 @@
+
+# Copyright (C) Nginx, Inc.
+
+
+ngx_addon_name="libnginx"
+
+CFLAGS="$CFLAGS $ngx_pic_opt"

nginx-src/libnginx/config

@@ -0,0 +1,73 @@
+
+# Copyright (C) Nginx, Inc.
+
+
+ngx_addon_name=libnginx
+ngx_module=$ngx_addon_name
+ngx_module_c=$ngx_addon_dir/libnginx.c
+
+ngx_ar="\$(AR)"
+ngx_libext=.a
+ngx_libout="r "
+
+case "$NGX_CC_NAME" in
+
+    msvc)
+        ngx_ar=lib
+        ngx_libext=.lib
+        ngx_libout="/OUT:"
+    ;;
+
+esac
+
+if test -n "$NGX_PCH"; then
+    ngx_cc="\$(CC) $ngx_compile_opt \$(CFLAGS) $ngx_use_pch \$(ALL_INCS)"
+else
+    ngx_cc="\$(CC) $ngx_compile_opt \$(CFLAGS) \$(CORE_INCS)"
+fi
+
+ngx_module_objs=
+for ngx_src in $ngx_module_c
+do
+    ngx_obj="addon/`basename \`dirname $ngx_src\``"
+
+    test -d $NGX_OBJS/$ngx_obj || mkdir -p $NGX_OBJS/$ngx_obj
+
+    ngx_obj=`echo $ngx_obj/\`basename $ngx_src\` \
+        | sed -e "s/\//$ngx_regex_dirsep/g" \
+              -e "s#^\(.*\.\)c\\$#$ngx_objs_dir\1$ngx_objext#g"`
+    
+    ngx_module_objs="$ngx_module_objs $ngx_obj"
+
+    cat << END                                                >> $NGX_MAKEFILE
+
+$ngx_obj:	\$(CORE_DEPS)$ngx_cont$ngx_src
+	$ngx_cc$ngx_tab$ngx_objout$ngx_obj$ngx_tab$ngx_src$NGX_AUX
+
+END
+
+done
+
+ngx_objs=`echo $ngx_module_objs $ngx_modules_obj $ngx_all_objs \
+    | sed -e "s/[^ ]*\\/nginx\\.$ngx_objext//g" \
+          -e "s/  *\([^ ][^ ]*\)/$ngx_long_regex_cont\1/g" \
+          -e "s/\//$ngx_regex_dirsep/g"`
+
+ngx_deps=`echo $ngx_module_objs $ngx_modules_obj $ngx_all_objs \
+    | sed -e "s/[^ ]*\\/nginx\\.$ngx_objext//g" \
+          -e "s/  *\([^ ][^ ]*\)/$ngx_regex_cont\1/g" \
+          -e "s/\//$ngx_regex_dirsep/g"`
+
+ngx_obj=$NGX_OBJS$ngx_dirsep$ngx_module$ngx_libext
+
+cat << END                                                    >> $NGX_MAKEFILE
+
+modules:	$ngx_obj
+
+$ngx_obj:	$ngx_deps$ngx_spacer
+	$ngx_ar $ngx_long_start$ngx_libout$ngx_obj$ngx_long_cont$ngx_objs
+$ngx_long_end
+
+LIBNGINX_LDFLAGS = $NGX_LD_OPT $CORE_LIBS
+
+END

nginx-src/libnginx/config.make

@@ -0,0 +1,196 @@
+
+/*
+ * Copyright (C) Nginx, Inc.
+ */
+
+
+#include <ngx_config.h>
+#include <ngx_core.h>
+#include <nginx.h>
+
+#include "libnginx.h"
+
+
+/* 
+ * We need to build nginx.c to correctly initialize ngx_core_module,
+ * but exclude an existing definition of main.
+ */
+#define  main  main_unused
+#include "nginx.c"
+#undef  main
+
+
+static ngx_int_t libngx_write_temp_conf_file(ngx_cycle_t *cycle,
+    ngx_str_t *data, ngx_str_t *name);
+
+
+ngx_cycle_t *
+libngx_init(u_char *prefix)
+{
+    static ngx_cycle_t   *cycle, init_cycle;
+    static ngx_atomic_t   lock;
+
+    ngx_log_t    *log;
+    char *const   argv[] = { "nginx" };
+
+    ngx_rwlock_wlock(&lock);
+
+    if (cycle != NULL) {
+        ngx_rwlock_unlock(&lock);
+        return cycle;
+    }
+
+    ngx_conf_params = (u_char *) "daemon off; master_process off;";
+    ngx_error_log = (u_char *) "";
+    ngx_prefix = prefix;
+
+    ngx_debug_init();
+
+    if (ngx_strerror_init() != NGX_OK) {
+        goto error;
+    }
+
+    ngx_max_sockets = -1;
+
+    ngx_time_init();
+
+#if (NGX_PCRE)
+    ngx_regex_init();
+#endif
+
+    ngx_pid = ngx_getpid();
+    ngx_parent = ngx_getppid();
+
+    log = ngx_log_init(ngx_prefix, ngx_error_log);
+    if (log == NULL) {
+        goto error;
+    }
+
+    log->log_level = NGX_LOG_INFO;
+
+#if (NGX_OPENSSL)
+    ngx_ssl_init(log);
+#endif
+
+    ngx_memzero(&init_cycle, sizeof(ngx_cycle_t));
+    init_cycle.log = log;
+    init_cycle.log_use_stderr = 1;
+    ngx_cycle = &init_cycle;
+
+    init_cycle.pool = ngx_create_pool(1024, log);
+    if (init_cycle.pool == NULL) {
+        goto error;
+    }
+
+    if (ngx_save_argv(&init_cycle, sizeof(argv)/sizeof(argv[0]), argv)
+        != NGX_OK) 
+    {
+        goto error;
+    }
+
+    if (ngx_process_options(&init_cycle) != NGX_OK) {
+        goto error;
+    }
+
+    if (ngx_os_init(log) != NGX_OK) {
+        goto error;
+    }
+
+    if (ngx_crc32_table_init() != NGX_OK) {
+        goto error;
+    }
+
+    ngx_slab_sizes_init();
+
+    if (ngx_preinit_modules() != NGX_OK) {
+        goto error;
+    }
+
+    cycle = &init_cycle;
+    ngx_rwlock_unlock(&lock);
+    return cycle;
+
+error:
+    ngx_rwlock_unlock(&lock);
+    return NULL;
+}
+
+
+ngx_int_t
+libngx_create_cycle(ngx_cycle_t *cycle, ngx_str_t *conf)
+{
+    ngx_str_t  conf_file;
+
+    ngx_cycle = cycle;
+
+    if (libngx_write_temp_conf_file(cycle, conf, &conf_file) != NGX_OK) {
+        return NGX_ERROR;
+    }
+
+    ngx_conf_file = conf_file.data;
+
+    if (ngx_process_options(cycle) != NGX_OK) {
+        return NGX_ERROR;
+    }
+
+    cycle = ngx_init_cycle(cycle);
+    if (cycle == NULL) {
+        return NGX_ERROR;
+    }
+
+    ngx_cycle = cycle;
+
+    return NGX_OK;
+}
+
+
+static ngx_int_t
+libngx_write_temp_conf_file(ngx_cycle_t *cycle, ngx_str_t *data,
+    ngx_str_t *name)
+{
+    ngx_int_t         rc;
+    ngx_path_t       *path;
+    ngx_temp_file_t   tf;
+
+    path = ngx_pcalloc(cycle->pool, sizeof(ngx_path_t));
+    if (path == NULL) {
+        return NGX_ERROR;
+    }
+
+    ngx_memzero(&tf, sizeof(ngx_temp_file_t));
+
+    tf.file.fd = NGX_INVALID_FILE;
+    tf.file.log = cycle->log;
+    tf.access = NGX_FILE_OWNER_ACCESS;
+    tf.clean = 1;
+    tf.path = path;
+    tf.pool = cycle->pool;
+    tf.persistent = 1;
+
+    ngx_str_set(&path->name, "conf");
+
+    rc = ngx_conf_full_name(cycle, &path->name, 0);
+    if (rc != NGX_OK) {
+        return rc;
+    }
+
+    if (ngx_create_dir(path->name.data, ngx_dir_access(tf.access))
+        == NGX_FILE_ERROR)
+    {
+        return ngx_errno;
+    }
+
+    rc = ngx_create_temp_file(&tf.file, tf.path, tf.pool, tf.persistent,
+                              tf.clean, tf.access);
+    if (rc != NGX_OK) {
+        return rc;
+    }
+
+    if (ngx_write_file(&tf.file, data->data, data->len, 0) == NGX_ERROR) {
+        return NGX_ERROR;
+    }
+
+    *name = tf.file.name;
+
+    return NGX_OK;
+}

nginx-src/libnginx/libnginx.c

@@ -0,0 +1,14 @@
+
+/*
+ * Copyright (C) Nginx, Inc
+ */
+
+
+#ifndef _LIBNGINX_H_INCLUDED_
+#define _LIBNGINX_H_INCLUDED_
+
+ngx_cycle_t *libngx_init(u_char *prefix);
+ngx_int_t libngx_create_cycle(ngx_cycle_t *cycle, ngx_str_t *conf);
+
+
+#endif /* _LIBNGINX_H_INCLUDED_ */

nginx-src/libnginx/libnginx.h

@@ -113,6 +113,11 @@ fn nginx_configure_flags(vendored: &[String]) -> Vec<String> {
         nginx_opts.push(format!("--with-ld-opt={ldflags}"));
     }
 
+    nginx_opts.push(format!(
+        "--add-module={}/libnginx",
+        env!("CARGO_MANIFEST_DIR")
+    ));
+
     nginx_opts
 }
 

nginx-src/src/lib.rs

@@ -34,3 +34,4 @@ shlex = "1.3"
 
 [features]
 vendored = ["dep:nginx-src"]
+unittest = ["vendored"]