FAQ addition when to rebuild nominatim.so

[nominatim.git] / test / bdd / environment.py

diff --git a/test/bdd/environment.py b/test/bdd/environment.py
index aca7929d250de6fa6fd69a2c3c4b565bc2062fba..f0658c335f95530cce4a2d82e6e268e7e6db7030 100644 (file)
--- a/test/bdd/environment.py
+++ b/test/bdd/environment.py
@@ -14,10 +14,16 @@ userconfig = {
     'BUILDDIR' : os.path.join(os.path.split(__file__)[0], "../../build"),
     'REMOVE_TEMPLATE' : False,
     'KEEP_TEST_DB' : False,
     'BUILDDIR' : os.path.join(os.path.split(__file__)[0], "../../build"),
     'REMOVE_TEMPLATE' : False,
     'KEEP_TEST_DB' : False,

+    'DB_HOST' : None,
+    'DB_PORT' : None,
+    'DB_USER' : None,
+    'DB_PASS' : None,

     'TEMPLATE_DB' : 'test_template_nominatim',
     'TEST_DB' : 'test_nominatim',
     'API_TEST_DB' : 'test_api_nominatim',
     'TEMPLATE_DB' : 'test_template_nominatim',
     'TEST_DB' : 'test_nominatim',
     'API_TEST_DB' : 'test_api_nominatim',

-    'TEST_SETTINGS_FILE' : '/tmp/nominatim_settings.php'
+    'TEST_SETTINGS_FILE' : '/tmp/nominatim_settings.php',
+    'SERVER_MODULE_PATH' : None,
+    'PHPCOV' : False, # set to output directory to enable code coverage

 }
 
 use_step_matcher("re")
 }
 
 use_step_matcher("re")


@@ -28,20 +34,55 @@ class NominatimEnvironment(object):
 
     def __init__(self, config):
         self.build_dir = os.path.abspath(config['BUILDDIR'])
 
     def __init__(self, config):
         self.build_dir = os.path.abspath(config['BUILDDIR'])

+        self.src_dir = os.path.abspath(os.path.join(os.path.split(__file__)[0], "../.."))
+        self.db_host = config['DB_HOST']
+        self.db_port = config['DB_PORT']
+        self.db_user = config['DB_USER']
+        self.db_pass = config['DB_PASS']

         self.template_db = config['TEMPLATE_DB']
         self.test_db = config['TEST_DB']
         self.api_test_db = config['API_TEST_DB']
         self.template_db = config['TEMPLATE_DB']
         self.test_db = config['TEST_DB']
         self.api_test_db = config['API_TEST_DB']

+        self.server_module_path = config['SERVER_MODULE_PATH']

         self.local_settings_file = config['TEST_SETTINGS_FILE']
         self.reuse_template = not config['REMOVE_TEMPLATE']
         self.keep_scenario_db = config['KEEP_TEST_DB']
         self.local_settings_file = config['TEST_SETTINGS_FILE']
         self.reuse_template = not config['REMOVE_TEMPLATE']
         self.keep_scenario_db = config['KEEP_TEST_DB']

+        self.code_coverage_path = config['PHPCOV']
+        self.code_coverage_id = 1

         os.environ['NOMINATIM_SETTINGS'] = self.local_settings_file
 
         self.template_db_done = False
 
         os.environ['NOMINATIM_SETTINGS'] = self.local_settings_file
 
         self.template_db_done = False
 

+    def connect_database(self, dbname):
+        dbargs = {'database': dbname}
+        if self.db_host:
+            dbargs['host'] = self.db_host
+        if self.db_port:
+            dbargs['port'] = self.db_port
+        if self.db_user:
+            dbargs['user'] = self.db_user
+        if self.db_pass:
+            dbargs['password'] = self.db_pass
+        conn = psycopg2.connect(**dbargs)
+        return conn
+
+    def next_code_coverage_file(self):
+        fn = os.path.join(self.code_coverage_path, "%06d.cov" % self.code_coverage_id)
+        self.code_coverage_id += 1
+
+        return fn
+

     def write_nominatim_config(self, dbname):
         f = open(self.local_settings_file, 'w')
     def write_nominatim_config(self, dbname):
         f = open(self.local_settings_file, 'w')

-        f.write("<?php\n  @define('CONST_Database_DSN', 'pgsql://@/%s');\n" % dbname)
+        # https://secure.php.net/manual/en/ref.pdo-pgsql.connection.php
+        f.write("<?php\n  @define('CONST_Database_DSN', 'pgsql:dbname=%s%s%s%s%s');\n" %
+                (dbname,
+                 (';host=' + self.db_host) if self.db_host else '',
+                 (';port=' + self.db_port) if self.db_port else '',
+                 (';user=' + self.db_user) if self.db_user else '',
+                 (';password=' + self.db_pass) if self.db_pass else ''
+                 ))

         f.write("@define('CONST_Osm2pgsql_Flatnode_File', null);\n")
         f.write("@define('CONST_Osm2pgsql_Flatnode_File', null);\n")

+        f.write("@define('CONST_Import_Style', CONST_BasePath.'/settings/import-full.style');\n")

         f.close()
 
     def cleanup(self):
         f.close()
 
     def cleanup(self):


@@ -51,7 +92,7 @@ class NominatimEnvironment(object):
             pass # ignore missing file
 
     def db_drop_database(self, name):
             pass # ignore missing file
 
     def db_drop_database(self, name):

-        conn = psycopg2.connect(database='postgres')
+        conn = self.connect_database('postgres')

         conn.set_isolation_level(0)
         cur = conn.cursor()
         cur.execute('DROP DATABASE IF EXISTS %s' % (name, ))
         conn.set_isolation_level(0)
         cur = conn.cursor()
         cur.execute('DROP DATABASE IF EXISTS %s' % (name, ))


@@ -65,7 +106,7 @@ class NominatimEnvironment(object):
 
         if self.reuse_template:
             # check that the template is there
 
         if self.reuse_template:
             # check that the template is there

-            conn = psycopg2.connect(database='postgres')
+            conn = self.connect_database('postgres')

             cur = conn.cursor()
             cur.execute('select count(*) from pg_database where datname = %s',
                         (self.template_db,))
             cur = conn.cursor()
             cur.execute('select count(*) from pg_database where datname = %s',
                         (self.template_db,))


@@ -76,47 +117,55 @@ class NominatimEnvironment(object):
             # just in case... make sure a previous table has been dropped
             self.db_drop_database(self.template_db)
 
             # just in case... make sure a previous table has been dropped
             self.db_drop_database(self.template_db)
 

-        # call the first part of database setup
-        self.write_nominatim_config(self.template_db)
-        self.run_setup_script('create-db', 'setup-db')
-        # remove external data to speed up indexing for tests
-        conn = psycopg2.connect(database=self.template_db)
-        cur = conn.cursor()
-        cur.execute("""select tablename from pg_tables
-                       where tablename in ('gb_postcode', 'us_postcode')""")
-        for t in cur:
-            conn.cursor().execute('TRUNCATE TABLE %s' % (t[0],))
-        conn.commit()
-        conn.close()
+        try:
+            # call the first part of database setup
+            self.write_nominatim_config(self.template_db)
+            self.run_setup_script('create-db', 'setup-db')
+            # remove external data to speed up indexing for tests
+            conn = self.connect_database(self.template_db)
+            cur = conn.cursor()
+            cur.execute("""select tablename from pg_tables
+                           where tablename in ('gb_postcode', 'us_postcode')""")
+            for t in cur:
+                conn.cursor().execute('TRUNCATE TABLE %s' % (t[0],))
+            conn.commit()
+            conn.close()
+
+            # execute osm2pgsql import on an empty file to get the right tables
+            with tempfile.NamedTemporaryFile(dir='/tmp', suffix='.xml') as fd:
+                fd.write(b'<osm version="0.6"></osm>')
+                fd.flush()
+                self.run_setup_script('import-data',
+                                      'ignore-errors',
+                                      'create-functions',
+                                      'create-tables',
+                                      'create-partition-tables',
+                                      'create-partition-functions',
+                                      'load-data',
+                                      'create-search-indices',
+                                      osm_file=fd.name,
+                                      osm2pgsql_cache='200')
+        except:
+            self.db_drop_database(self.template_db)
+            raise

 
 

-        # execute osm2pgsql import on an empty file to get the right tables
-        with tempfile.NamedTemporaryFile(dir='/tmp', suffix='.xml') as fd:
-            fd.write(b'<osm version="0.6"></osm>')
-            fd.flush()
-            self.run_setup_script('import-data',
-                                  'ignore-errors',
-                                  'create-functions',
-                                  'create-tables',
-                                  'create-partition-tables',
-                                  'create-partition-functions',
-                                  'load-data',
-                                  'create-search-indices',
-                                  osm_file=fd.name,
-                                  osm2pgsql_cache='200')

 
     def setup_api_db(self, context):
         self.write_nominatim_config(self.api_test_db)
 
 
     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)
     def setup_db(self, context):
         self.setup_template_db()
         self.write_nominatim_config(self.test_db)

-        conn = psycopg2.connect(database=self.template_db)
+        conn = self.connect_database(self.template_db)

         conn.set_isolation_level(0)
         cur = conn.cursor()
         cur.execute('DROP DATABASE IF EXISTS %s' % (self.test_db, ))
         cur.execute('CREATE DATABASE %s TEMPLATE = %s' % (self.test_db, self.template_db))
         conn.close()
         conn.set_isolation_level(0)
         cur = conn.cursor()
         cur.execute('DROP DATABASE IF EXISTS %s' % (self.test_db, ))
         cur.execute('CREATE DATABASE %s TEMPLATE = %s' % (self.test_db, self.template_db))
         conn.close()

-        context.db = psycopg2.connect(database=self.test_db)
+        context.db = self.connect_database(self.test_db)

         if python_version[0] < 3:
             psycopg2.extras.register_hstore(context.db, globally=False, unicode=True)
         else:
         if python_version[0] < 3:
             psycopg2.extras.register_hstore(context.db, globally=False, unicode=True)
         else:


@@ -130,19 +179,24 @@ class NominatimEnvironment(object):
             self.db_drop_database(self.test_db)
 
     def run_setup_script(self, *args, **kwargs):
             self.db_drop_database(self.test_db)
 
     def run_setup_script(self, *args, **kwargs):

+        if self.server_module_path:
+            kwargs = dict(kwargs)
+            kwargs['module_path'] = self.server_module_path

         self.run_nominatim_script('setup', *args, **kwargs)
 
     def run_update_script(self, *args, **kwargs):
         self.run_nominatim_script('update', *args, **kwargs)
 
     def run_nominatim_script(self, script, *args, **kwargs):
         self.run_nominatim_script('setup', *args, **kwargs)
 
     def run_update_script(self, *args, **kwargs):
         self.run_nominatim_script('update', *args, **kwargs)
 
     def run_nominatim_script(self, script, *args, **kwargs):

-        cmd = [os.path.join(self.build_dir, 'utils', '%s.php' % script)]
+        cmd = ['/usr/bin/env', 'php', '-Cq']
+        cmd.append(os.path.join(self.build_dir, 'utils', '%s.php' % script))

         cmd.extend(['--%s' % x for x in args])
         for k, v in kwargs.items():
             cmd.extend(('--' + k.replace('_', '-'), str(v)))
         proc = subprocess.Popen(cmd, cwd=self.build_dir,
                                 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
         (outp, outerr) = proc.communicate()
         cmd.extend(['--%s' % x for x in args])
         for k, v in kwargs.items():
             cmd.extend(('--' + k.replace('_', '-'), str(v)))
         proc = subprocess.Popen(cmd, cwd=self.build_dir,
                                 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
         (outp, outerr) = proc.communicate()

+        outerr = outerr.decode('utf-8').replace('\\n', '\n')

         logger.debug("run_nominatim_script: %s\n%s\n%s" % (cmd, outp, outerr))
         assert (proc.returncode == 0), "Script '%s' failed:\n%s\n%s\n" % (script, outp, outerr)
 
         logger.debug("run_nominatim_script: %s\n%s\n%s" % (cmd, outp, outerr))
         assert (proc.returncode == 0), "Script '%s' failed:\n%s\n%s\n" % (script, outp, outerr)
 


@@ -245,9 +299,10 @@ def before_scenario(context, scenario):
         context.nominatim.setup_db(context)
     elif 'APIDB' in context.tags:
         context.nominatim.setup_api_db(context)
         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):
     if 'DB' in context.tags:
         context.nominatim.teardown_db(context)
     context.scene = None
 
 def after_scenario(context, scenario):
     if 'DB' in context.tags:
         context.nominatim.teardown_db(context)

-