Merge pull request #98 from govCMS/feature/nginx-testing

[GOVCMSD7-276] Add BDD/Unit testing for nginx configuration.

.circleci/config.yml

@@ -49,6 +49,12 @@ jobs:
             else
               echo "Redis success: Redis contains $redisKeys keys."
             fi
+      - run:
+          name: Test nginx configuration
+          command: |
+            docker-compose exec nginx nginx -t
+            composer install -d .docker/images/nginx/tests
+            .docker/images/nginx/tests/vendor/bin/phpunit -c .docker/images/nginx/tests/phpunit.xml
 workflows:
   version: 2
   main:

.docker/Dockerfile.nginx-drupal

@@ -6,8 +6,6 @@ FROM amazeeio/nginx-drupal:${LAGOON_IMAGE_VERSION}
 
 # nginx config.
 COPY .docker/images/nginx/helpers/ /etc/nginx/helpers/
-COPY .docker/images/nginx/x_frame_options.conf /etc/nginx/conf.d/drupal/location_drupal_append_x_frame_options.conf
-COPY .docker/images/nginx/no_robots_govcms_host.conf /etc/nginx/conf.d/drupal/location_drupal_prepend_no_robots_govcms_host.conf
 COPY .docker/images/nginx/no-robots.sh /lagoon/entrypoints/20-no-robots.sh
 RUN fix-permissions /etc/nginx
 

.docker/images/nginx/helpers/acsf_redirects.conf → .docker/images/nginx/helpers/202-acsf_redirects.conf

@@ -1,7 +1,7 @@
 ## ACSF Redirects.
 
 # Theme directory.
-rewrite ^\/sites\/g\/files\/net(\d+)\/themes\/site\/(.+)\/(.*)$ /sites/default/themes/custom/$2/$3?acsf_theme_redirect last;
+rewrite ^\/sites\/g\/files\/net(\d+)\/themes\/site\/(.+)\/(.*)$ /sites/default/themes/custom/$2/$3?acsf_theme_redirect permanent;
 
 # Files directory.
 location ~* ^/sites/g/files/net(?:\d+)/f/(.+)$ {

.docker/images/nginx/helpers/206-x_robots_tag_header.conf

@@ -0,0 +1,14 @@
+###
+### Add the X-Robots-Tag to the server response
+### @see https://developers.google.com/search/reference/robots_meta_tag
+###
+
+# All is default and essentially has no effect.
+set $robots_header "all";
+
+if ($host ~* ^(?!www\.govcms\.gov\.au$)(?:[\w\-]+\.)+govcms\.gov\.au$){
+  # None = noindex, nofollow.
+  set $robots_header "none";
+}
+
+add_header X-Robots-Tag $robots_header;

.docker/images/nginx/tests/.gitignore

@@ -0,0 +1,2 @@
+vendor/
+.phpunit*

.docker/images/nginx/tests/bootstrap.php

@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * PHPUnit Bootstrap file.
+ */
+
+include_once __DIR__ . '/vendor/autoload.php';
+
+function get_curl_headers($path = "/", $opts = NULL) {
+  $uri = getenv('LOCALDEV_URL') ?: 'http://nginx:8080';
+
+  $response = null;
+
+  $path = '/' . ltrim($path, '/');
+
+  exec("docker-compose exec -T test curl {$uri}{$path} -I {$opts} 2>/dev/null", $response);
+
+  if (empty($response)) {
+    return [];
+  }
+
+  $response = array_map('trim', $response);
+
+  foreach ($response as $line) {
+    if (strpos($line, 'HTTP') !== false) {
+      $part = explode(' ', $line);
+      $headers['Status'] = trim($part[1]);
+      continue;
+    }
+    $part = explode(':', $line);
+    if (count($part) == 2) {
+      $headers[$part[0]] = trim($part[1]);
+    }
+  }
+
+  return $headers;
+}
+
+function curl_get_content($path = "/", $opts = NULL) {
+  $uri = getenv('LOCALDEV_URL') ?: 'http://nginx:8080';
+
+  $response = null;
+  $path = '/' . ltrim($path, '/');
+
+  exec("docker-compose exec -T test curl {$uri}{$path} {$opts} 2>/dev/null", $response);
+
+  if (empty($response)) {
+    return FALSE;
+  }
+
+  return $response;
+}

.docker/images/nginx/tests/composer.json

@@ -0,0 +1,19 @@
+{
+    "name": "govcmstests/nginx",
+    "description": "Testing framework for the nginx image.",
+    "type": "project",
+    "authors": [
+        {
+            "name": "Steve Worley",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "phpunit/phpunit": "^7.5"
+    },
+    "autoload": {
+      "psr-4": {
+        "GovCMSTests\\": "src/"
+      }
+    }
+}