Remove NGINX_PATH_MODULES and NGINX_CONFIG_PATH (#57)

* Remove NGINX_PATH_MODULES and NGINX_CONFIG_PATH

The removal of `NGINXMODULES_PATH` and `NGINX_CONF_PATH` has the
advantage of facilitating the execution of our tests, optimizing the
utilization of matrix jobs on CircleCI, and streamlining the development
workflow.

* Update all tests *.conf with the module absolute path.
* Update default nginx.conf.
* Run nginx on a specific configuration.

Author: dmehala

.circleci/config.yml

@@ -28,13 +28,6 @@
 #     BASE_IMAGE is not required for the "build" make target, but is required
 #     for "test", "build-in-docker", and "lab" targets.
 #
-# NGINX_MODULES_PATH
-#     This variable is used during testing.  It's the path to the nginx modules
-#     directory in the nginx installation available within $BASE_IMAGE.
-#
-#     NGINX_MODULES_PATH is not required for the "build" or "build-in-docker"
-#     make targets, but is required for the "test" and "lab" targets.
-#
 # ARCH
 #     The docker image architecture to use. The following values are supported:
 #
@@ -46,13 +39,10 @@
 
 NGINX_VERSION=1.24.0
 BASE_IMAGE=nginx:1.24.0-alpine
-NGINX_MODULES_PATH=/usr/lib/nginx/modules
 ARCH=amd64
 
 # NGINX_VERSION=1.14.1
 # BASE_IMAGE=nginx:1.14.1
-# NGINX_MODULES_PATH=/usr/lib/nginx/modules
 
 # NGINX_VERSION=1.22.1
 # BASE_IMAGE=amazonlinux:2.0.20230119.1
-# NGINX_MODULES_PATH=/usr/share/nginx/modules

bin/generate_jobs_yaml.sh

@@ -6,16 +6,10 @@ set -e
 
 . ../nginx-version-info
 export BASE_IMAGE
-export NGINX_MODULES_PATH="${NGINX_MODULES_PATH:-/usr/lib/nginx/modules}"
-export NGINX_CONF_PATH="${NGINX_CONF_PATH:-/etc/nginx/nginx.conf}"
 
-printf  "===============================\n"
-printf  "Running test with:\n"
-printf  " - ARCH=%s\n" "${ARCH}"
-printf  " - BASE_IMAGE=%s\n" "${BASE_IMAGE}"
-printf  " - NGINX_CONF_PATH=%s\n" "${NGINX_CONF_PATH}"
-printf  " - NGINX_MODULES_PATH=%s\n" "${NGINX_MODULES_PATH}"
-printf  "===============================\n"
+printf "      arch : %s\n" "${ARCH}"
+printf "base image : %s\n" "${BASE_IMAGE}"
+printf " test args : %s\n" "$@"
 
 docker compose build --parallel
 python3 -m unittest "$@"

nginx-version-info.example

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 error_log stderr info;
 

test/bin/run

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 error_log stderr info;
 

test/cases/access_log/conf/default_format.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 error_log stderr info;
 

test/cases/access_log/conf/json_format.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/access_log/conf/without_tracing.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/fastcgi_auto.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/fastcgi_disabled_at_http.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/fastcgi_disabled_at_location.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/fastcgi_disabled_at_server.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/grpc_auto.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/grpc_disabled_at_http.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/grpc_disabled_at_location.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/grpc_disabled_at_server.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/http_auto.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/http_disabled_at_http.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/http_disabled_at_location.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/http_disabled_at_server.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/uwsgi_auto.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/uwsgi_disabled_at_http.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/uwsgi_disabled_at_location.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/auto_propagation/conf/uwsgi_disabled_at_server.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/duplicate/agent_url.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/duplicate/environment.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/duplicate/propagation_styles.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/duplicate/service_name.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/error_in_main/agent_url.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/error_in_main/environment.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/error_in_main/propagation_styles.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/error_in_main/service_name.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/error_in_server/agent_url.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/error_in_server/environment.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/error_in_server/propagation_styles.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/error_in_server/service_name.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/in_http.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;

test/cases/configuration/conf/propagation_styles.conf

@@ -1,4 +1,7 @@
-load_module modules/ngx_http_datadog_module.so;
+# "/datadog-tests" is a directory created by the docker build
+# of the nginx test image. It contains the module, the
+# nginx config, and "index.html".
+load_module /datadog-tests/ngx_http_datadog_module.so;
 
 events {
     worker_connections  1024;