fix(nginx): allow skip envsubst (#946)

* Update README.md

* add test

* fix: tests

* fix test

* fix

* fix

* fix

* fix

nginx/README.md

@@ -18,6 +18,8 @@ add_header X-Content-Type-Options "nosniff";
 
 As default, in every files in the `/usr/share/nginx/html` directory, the [`envsub.sh`](./envsub.sh) script replaces `%%KEY%%` by `VALUE` where `export KEY=VALUE` in the global env var.
 
+You can disable this by setting the `SKIP_ENVSUBST` environment variable.
+
 So :
 
 ```sh

nginx/envsub.sh

@@ -21,7 +21,7 @@ echo "PORT=${PORT:="80"}" >> /tmp/env-vars
 while IFS='=' read -r KEY VALUE
 do
   # In every files in the dir, replace the environment variables value
-  find ${WWW_DIRECTORY} -type f -regex ".*\.\(conf\|txt\|html\|htm\|js\|css\)"  -exec \
+  [ -z "$SKIP_ENVSUBST" ] && find ${WWW_DIRECTORY} -type f -regex ".*\.\(conf\|txt\|html\|htm\|js\|css\)"  -exec \
     sed -i -e "s|${DELIMITER}${KEY}${DELIMITER}|${VALUE}|g" {} \;
   # replace in nginx.conf too
   sed -i -e "s|${DELIMITER}${KEY}${DELIMITER}|${VALUE}|g" /etc/nginx/nginx.conf

nginx/tests/404.bats

@@ -5,7 +5,7 @@ load '../../.bats/common.bats.bash'
 setup_file() {
   docker-compose run \
     --detach \
-    --publish 8888:80 \
+    --publish 8889:80 \
     --rm \
     --volume ${BATS_TEST_DIRNAME}/fixtures:/usr/share/nginx/html \
     alpine
@@ -16,12 +16,12 @@ teardown_file() {
 }
 
 @test "nginx: should return status 404 (not a SPA)" {
-  run wget --server-response --quiet http://localhost:8888/pouet
+  run wget --server-response --quiet http://localhost:8889/pouet
   assert_output --partial "HTTP/1.1 404 Not Found"
 }
 
 @test "nginx: should return custom 404 page (not a SPA)" {
-  run wget --content-on-error --output-document - http://localhost:8888/pouet
+  run wget --content-on-error --output-document - http://localhost:8889/pouet
   assert_output --partial "CUSTOM 404 PAGE"
 }
 

nginx/tests/fixtures-envsubst/404.html

@@ -0,0 +1 @@
+CUSTOM 404 PAGE

nginx/tests/fixtures-envsubst/foo/bar/bar.js

@@ -0,0 +1 @@
+// nginx/test/foo/bar/bar.js with VERSION=%%VERSION%%

nginx/tests/fixtures-envsubst/index.html

@@ -0,0 +1 @@
+nginx/test/index.html with VERSION=%%VERSION%%

nginx/tests/skip-envsub.bats

@@ -0,0 +1,34 @@
+#!/usr/bin/env bats
+
+load '../../.bats/common.bats.bash'
+
+setup_file() {
+  cp -r ${BATS_TEST_DIRNAME}/fixtures-envsubst/ ${BATS_RUN_TMPDIR}/www2
+
+  docker-compose run \
+    --detach \
+    -e VERSION=x.y.z \
+    -e SKIP_ENVSUBST=true \
+    --publish 8888:80 \
+    --rm \
+    --volume ${BATS_RUN_TMPDIR}/www2:/usr/share/nginx/html \
+    alpine
+}
+
+teardown_file() {
+  docker-compose rm -sf
+}
+
+@test "nginx: should NOT replace the VERSION with x.y.z in index.html" {
+  run wget -qO - localhost:8888
+  assert_output "nginx/test/index.html with VERSION=%%VERSION%%"
+  assert_success
+}
+
+@test "nginx: should NOT replace the VERSION with x.y.z in foo/bar/bar.js" {
+  run wget -qO - localhost:8888/foo/bar/bar.js
+  assert_output "// nginx/test/foo/bar/bar.js with VERSION=%%VERSION%%" ]
+  assert_success
+}
+
+

nginx4spa/README.md

@@ -19,6 +19,8 @@ add_header X-Content-Type-Options "nosniff";
 
 As default, in every files in the `/usr/share/nginx/html` directory, the [`envsub.sh`](./envsub.sh) script replaces `%%KEY%%` by `VALUE` where `export KEY=VALUE` in the global env var.
 
+You can disable this by setting the `SKIP_ENVSUBST` environment variable.
+
 So :
 
 ```sh

nginx4spa/envsub.sh

@@ -21,7 +21,7 @@ echo "PORT=${PORT:="80"}" >> /tmp/env-vars
 while IFS='=' read -r KEY VALUE
 do
   # In every files in the dir, replace the environment variables value
-  find ${WWW_DIRECTORY} -type f -regex ".*\.\(conf\|txt\|html\|htm\|js\|css\)"  -exec \
+  [ -z "$SKIP_ENVSUBST" ] && find ${WWW_DIRECTORY} -type f -regex ".*\.\(conf\|txt\|html\|htm\|js\|css\)"  -exec \
     sed -i -e "s|${DELIMITER}${KEY}${DELIMITER}|${VALUE}|g" {} \;
   # replace in nginx.conf too
   sed -i -e "s|${DELIMITER}${KEY}${DELIMITER}|${VALUE}|g" /etc/nginx/nginx.conf

nginx4spa/tests/fixtures-envsubst/foo/bar/bar.js

@@ -0,0 +1 @@
+// nginx4spa/test/foo/bar/bar.js with VERSION=%%VERSION%%

nginx4spa/tests/fixtures-envsubst/index.html

@@ -0,0 +1 @@
+nginx4spa/test/index.html with VERSION=%%VERSION%%

nginx4spa/tests/skip-envsub.bats

@@ -0,0 +1,34 @@
+#!/usr/bin/env bats
+
+load '../../.bats/common.bats.bash'
+
+setup_file() {
+  cp -r ${BATS_TEST_DIRNAME}/fixtures-envsubst/ ${BATS_RUN_TMPDIR}/www2
+
+  docker-compose run \
+    --detach \
+    -e VERSION=x.y.z \
+    -e SKIP_ENVSUBST=true \
+    --publish 8889:80 \
+    --rm \
+    --volume ${BATS_RUN_TMPDIR}/www2:/usr/share/nginx/html \
+    alpine
+}
+
+teardown_file() {
+  docker-compose rm -sf
+}
+
+@test "nginx4spa: should NOT replace the VERSION with x.y.z in index.html" {
+  run wget -qO - localhost:8889
+  assert_output "nginx4spa/test/index.html with VERSION=%%VERSION%%"
+  assert_success
+}
+
+@test "nginx4spa: should NOT replace the VERSION with x.y.z in foo/bar/bar.js" {
+  run wget -qO - localhost:8889/foo/bar/bar.js
+  assert_output "// nginx4spa/test/foo/bar/bar.js with VERSION=%%VERSION%%" ]
+  assert_success
+}
+
+