Add ping resource and test

* Add ping resource and test
* Adding charset to /ping
* Set cache-control explicitly

smoke_tests.sh

@@ -4,6 +4,9 @@ set -ex
 local_hostname=$(hostname)
 hostname=${1:-$local_hostname}
 
+echo "Ping"
+[ $(curl --write-out %{http_code} --silent --output /dev/null "${hostname}/ping") == 200 ]
+
 echo "Homepage"
 [ $(curl --write-out %{http_code} --silent --output /dev/null "$hostname") == 200 ]
 

src/modules/jcms_ping/jcms_ping.info.yml

@@ -0,0 +1,5 @@
+name: Journal CMS (Ping)
+type: module
+description: Check to see the site is up
+core: 8.x
+package: Journal CMS

src/modules/jcms_ping/jcms_ping.routing.yml

@@ -0,0 +1,8 @@
+jcms_ping.check.json:
+  path: '/ping'
+  defaults:
+    _controller: \Drupal\jcms_ping\Controller\PingController::siteStatus
+  options:
+    no_cache: TRUE
+  requirements:
+    _access: 'TRUE'

src/modules/jcms_ping/src/Controller/PingController.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Drupal\jcms_ping\Controller;
+
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * Controller to handle a ping request for journal-cms.
+ */
+class PingController {
+
+  /**
+   * String sent in responses, to verify site status.
+   *
+   * @var string
+   */
+  const SITE_STATUS_RESPONSE = 'pong';
+
+  /**
+   * Checks the site status.
+   *
+   * @return \Symfony\Component\HttpFoundation\Response
+   *   The response.
+   */
+  public function siteStatus() {
+    $response = new Response(self::SITE_STATUS_RESPONSE);
+    $response->headers->set('Content-Type', 'text/plain; charset=UTF-8');
+    $response->headers->set('Cache-Control', 'must-revalidate, no-cache, no-store, private');
+    return $response;
+  }
+
+}

sync/core.extension.yml

@@ -37,6 +37,7 @@ module:
   jcms_article_fragment: 0
   jcms_migrate: 0
   jcms_notifications: 0
+  jcms_ping: 0
   jcms_rest: 0
   jsonb: 0
   link: 0