add JSON format to /status endpoint (#1013)

add JSON format to /status endpoint

lib/Status.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Nominatim;
+
+use Exception;
+use PEAR;
+
+class Status
+{
+    protected $oDB;
+
+    public function __construct(&$oDB)
+    {
+        $this->oDB =& $oDB;
+    }
+
+    public function status()
+    {
+        if (!$this->oDB || PEAR::isError($this->oDB)) {
+            throw new Exception('No database', 700);
+        }
+
+        $sStandardWord = $this->oDB->getOne("SELECT make_standard_name('a')");
+        if (PEAR::isError($sStandardWord)) {
+            throw new Exception('Module failed', 701);
+        }
+
+        if ($sStandardWord != 'a') {
+            throw new Exception('Module call failed', 702);
+        }
+
+        $sSQL = 'SELECT word_id, word_token, word, class, type, country_code, ';
+        $sSQL .= "operator, search_name_count FROM word WHERE word_token IN (' a')";
+        $iWordID = $this->oDB->getOne($sSQL);
+        if (PEAR::isError($iWordID)) {
+            throw new Exception('Query failed', 703);
+        }
+        if (!$iWordID) {
+            throw new Exception('No value', 704);
+        }
+    }
+
+    public function dataDate()
+    {
+        $sSQL = 'SELECT EXTRACT(EPOCH FROM lastimportdate) FROM import_status LIMIT 1';
+        $iDataDateEpoch = $this->oDB->getOne($sSQL);
+
+        if (PEAR::isError($iDataDateEpoch)) {
+            throw Exception('Data date query failed '.$iDataDateEpoch->getMessage(), 705);
+        }
+
+        return $iDataDateEpoch;
+    }
+}

test/bdd/api/status/failures.feature

@@ -0,0 +1,17 @@
+@UNKNOWNDB
+Feature: Status queries against unknown database
+    Testing status query
+
+    Scenario: Failed status as text
+        When sending text status query
+        Then a HTTP 500 is returned
+        And the page contents equals "ERROR: No database"
+
+    Scenario: Failed status as json
+        When sending json status query
+        Then a HTTP 200 is returned
+        And the result is valid json
+        And results contain
+          | status | message |
+          | 700    | No database |
+        And result has not attributes data_updated

test/bdd/api/status/simple.feature

@@ -0,0 +1,16 @@
+@APIDB
+Feature: Status queries
+    Testing status query
+
+    Scenario: Status as text
+        When sending status query
+        Then a HTTP 200 is returned
+        And the page contents equals "OK"
+
+    Scenario: Status as json
+        When sending json status query
+        Then the result is valid json
+        And results contain
+          | status | message |
+          | 0      | OK      |
+        And result has attributes data_updated

test/bdd/environment.py

@@ -122,6 +122,9 @@ class NominatimEnvironment(object):
     def setup_api_db(self, context):
         self.write_nominatim_config(self.api_test_db)
 
+    def setup_unknown_db(self, context):
+        self.write_nominatim_config('UNKNOWN_DATABASE_NAME')
+
     def setup_db(self, context):
         self.setup_template_db()
         self.write_nominatim_config(self.test_db)
@@ -261,6 +264,8 @@ def before_scenario(context, scenario):
         context.nominatim.setup_db(context)
     elif 'APIDB' in context.tags:
         context.nominatim.setup_api_db(context)
+    elif 'UNKNOWNDB' in context.tags:
+        context.nominatim.setup_unknown_db(context)
     context.scene = None
 
 def after_scenario(context, scenario):

test/bdd/steps/queries.py

@@ -236,6 +236,20 @@ class DetailsResponse(GenericResponse):
         self.result = [json.JSONDecoder(object_pairs_hook=OrderedDict).decode(self.page)]
 
 
+class StatusResponse(GenericResponse):
+
+    def __init__(self, page, fmt='text', errorcode=200):
+        self.page = page
+        self.format = fmt
+        self.errorcode = errorcode
+
+        if errorcode == 200 and fmt != 'text':
+            getattr(self, 'parse_' + fmt)()
+
+    def parse_json(self):
+        self.result = [json.JSONDecoder(object_pairs_hook=OrderedDict).decode(self.page)]
+
+
 @when(u'searching for "(?P<query>.*)"(?P<dups> with dups)?')
 def query_cmd(context, query, dups):
     """ Query directly via PHP script.
@@ -402,6 +416,18 @@ def website_lookup_request(context, fmt, query):
 
     context.response = SearchResponse(outp, outfmt, status)
 
+@when(u'sending (?P<fmt>\S+ )?status query')
+def website_status_request(context, fmt):
+    params = {}
+    outp, status = send_api_query('status', params, fmt, context)
+
+    if fmt is None:
+        outfmt = 'text'
+    else:
+        outfmt = fmt.strip()
+
+    context.response = StatusResponse(outp, outfmt, status)
+
 @step(u'(?P<operator>less than|more than|exactly|at least|at most) (?P<number>\d+) results? (?:is|are) returned')
 def validate_result_number(context, operator, number):
     eq_(context.response.errorcode, 200)
@@ -413,6 +439,10 @@ def validate_result_number(context, operator, number):
 def check_http_return_status(context, status):
     eq_(context.response.errorcode, int(status))
 
+@then(u'the page contents equals "(?P<text>.+)"')
+def check_page_content_equals(context, text):
+    eq_(context.response.page, text)
+
 @then(u'the result is valid (?P<fmt>\w+)')
 def step_impl(context, fmt):
     context.execute_steps("Then a HTTP 200 is returned")

test/php/Nominatim/StatusTest.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Nominatim;
+
+require_once('../../lib/Status.php');
+require_once('DB.php');
+
+use Exception;
+
+class StatusTest extends \PHPUnit_Framework_TestCase
+{
+
+
+    public function testNoDatabaseGiven()
+    {
+        $this->setExpectedException(Exception::class, 'No database', 700);
+
+        $oDB = null;
+        $oStatus = new Status($oDB);
+        $this->assertEquals('No database', $oStatus->status());
+    }
+
+    public function testNoDatabaseConnectionFail()
+    {
+        $this->setExpectedException(Exception::class, 'No database', 700);
+
+        // causes 'Non-static method should not be called statically, assuming $this from incompatible context'
+        // failure on travis
+        // $oDB = \DB::connect('', false); // returns a DB_Error instance
+
+        $oDB = new \DB_Error;
+        $oStatus = new Status($oDB);
+        $this->assertEquals('No database', $oStatus->status());
+
+        $oDB = null;
+        $oStatus = new Status($oDB);
+        $this->assertEquals('No database', $oStatus->status());
+    }
+
+
+    public function testModuleFail()
+    {
+        $this->setExpectedException(Exception::class, 'Module call failed', 702);
+
+        // stub has getOne method but doesn't return anything
+        $oDbStub = $this->getMock(\DB::class, array('getOne'));
+
+        $oStatus = new Status($oDbStub);
+        $this->assertNull($oStatus->status());
+    }
+
+
+    public function testWordIdQueryFail()
+    {
+        $this->setExpectedException(Exception::class, 'No value', 704);
+
+        $oDbStub = $this->getMock(\DB::class, array('getOne'));
+
+        // return no word_id
+        $oDbStub->method('getOne')
+                ->will($this->returnCallback(function ($sql) {
+                    if (preg_match("/make_standard_name\('a'\)/", $sql)) return 'a';
+                    if (preg_match('/SELECT word_id, word_token/', $sql)) return null;
+                }));
+
+        $oStatus = new Status($oDbStub);
+        $this->assertNull($oStatus->status());
+    }
+
+
+    public function testOK()
+    {
+        $oDbStub = $this->getMock(\DB::class, array('getOne'));
+
+        $oDbStub->method('getOne')
+                ->will($this->returnCallback(function ($sql) {
+                    if (preg_match("/make_standard_name\('(\w+)'\)/", $sql, $aMatch)) return $aMatch[1];
+                    if (preg_match('/SELECT word_id, word_token/', $sql)) return 1234;
+                }));
+
+        $oStatus = new Status($oDbStub);
+        $this->assertNull($oStatus->status());
+    }
+
+    public function testDataDate()
+    {
+        $oDbStub = $this->getMock(\DB::class, array('getOne'));
+     
+        $oDbStub->method('getOne')
+                ->willReturn(1519430221);
+
+        $oStatus = new Status($oDbStub);
+        $this->assertEquals(1519430221, $oStatus->dataDate());
+    }
+}

website/status.php

@@ -1,37 +1,51 @@
 <?php
+
 @define('CONST_ConnectionBucket_PageType', 'Status');
 
 require_once(dirname(dirname(__FILE__)).'/settings/settings.php');
 require_once(CONST_BasePath.'/lib/init-website.php');
+require_once(CONST_BasePath.'/lib/ParameterParser.php');
+require_once(CONST_BasePath.'/lib/Status.php');
+
+$oParams = new Nominatim\ParameterParser();
+$sOutputFormat = $oParams->getSet('format', array('text', 'json'), 'text');
+
+$oDB = DB::connect(CONST_Database_DSN, false);
+$oStatus = new Nominatim\Status($oDB);
 
 
-function statusError($sMsg)
-{
-    header('HTTP/1.0 500 Internal Server Error');
-    echo 'ERROR: '.$sMsg;
+if ($sOutputFormat == 'json') {
+    header('content-type: application/json; charset=UTF-8');
+}
+
+
+try {
+    $oStatus->status();
+} catch (Exception $oErr) {
+    if ($sOutputFormat == 'json') {
+        $aResponse = array(
+                  'status' => $oErr->getCode(),
+                  'message' => $oErr->getMessage()
+                 );
+        javascript_renderData($aResponse);
+    } else {
+        header('HTTP/1.0 500 Internal Server Error');
+        echo 'ERROR: '.$oErr->getMessage();
+    }
     exit;
 }
 
-$oDB =& DB::connect(CONST_Database_DSN, false);
-if (!$oDB || PEAR::isError($oDB)) {
-    statusError('No database');
+
+if ($sOutputFormat == 'json') {
+    $epoch = $oStatus->dataDate();
+    $aResponse = array(
+              'status' => 0,
+              'message' => 'OK',
+              'data_updated' => (new DateTime('@'.$epoch))->format(DateTime::RFC3339)
+             );
+    javascript_renderData($aResponse);
+} else {
+    echo 'OK';
 }
 
-$sStandardWord = $oDB->getOne("select make_standard_name('a')");
-if (PEAR::isError($sStandardWord)) {
-    statusError('Module failed');
-}
-if ($sStandardWord != 'a') {
-    statusError('Module call failed');
-}
-
-$iWordID = $oDB->getOne("select word_id,word_token, word, class, type, country_code, operator, search_name_count from word where word_token in (' a')");
-if (PEAR::isError($iWordID)) {
-    statusError('Query failed');
-}
-if (!$iWordID) {
-    statusError('No value');
-}
-
-echo 'OK';
 exit;