city_retrofit/hub/unittests/test_db_factory.py

"""
Test db factory
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2022 Concordia CERC group
Project Coder Peter Yefi peteryefi@gmail.com
"""
import os
import unittest
from unittest import TestCase
from pathlib import Path
import sqlalchemy.exc

from hub.imports.geometry_factory import GeometryFactory
from hub.imports.construction_factory import ConstructionFactory
from hub.imports.usage_factory import UsageFactory
from hub.persistence.db_control import DBControl
from hub.persistence.repository import Repository
from sqlalchemy import create_engine
from hub.persistence.models import City, Application, CityObject
from hub.persistence.models import User, UserRoles
from hub.helpers.dictionaries import Dictionaries
from sqlalchemy.exc import ProgrammingError
import uuid


class Control:
  _skip_test = False
  _skip_reason = 'PostgreSQL not properly installed in host machine'

  def __init__(self):
    """
    Test
    setup
    :return: None
    """
    self._skip_test = False
    # Create test database
    dotenv_path = Path("{}/.local/etc/hub/.env".format(os.path.expanduser('~'))).resolve()
    if not dotenv_path.exists():
      self._skip_test = True
      self._skip_reason = f'.env file missing at {dotenv_path}'
      return
    dotenv_path = str(dotenv_path)
    repository = Repository(db_name='hub_unittests', app_env='TEST', dotenv_path=dotenv_path)
    engine = create_engine(repository.configuration.connection_string)
    try:
      # delete test database if it exists
      connection = engine.connect()
      connection.close()
    except ProgrammingError:
      print(f'Database does not exist. Nothing to delete')
    except sqlalchemy.exc.OperationalError as operational_error:
      self._skip_test = True
      self._skip_reason = f'{operational_error}'
      return

    Application.__table__.create(bind=repository.engine, checkfirst=True)
    User.__table__.create(bind=repository.engine, checkfirst=True)
    City.__table__.create(bind=repository.engine, checkfirst=True)
    CityObject.__table__.create(bind=repository.engine, checkfirst=True)

    city_file = "tests_data/FZK_Haus_LoD_2.gml"
    self._city = GeometryFactory('citygml',
                                 city_file,
                                 function_to_hub=Dictionaries().alkis_function_to_hub_function).city
    ConstructionFactory('nrcan', self._city).enrich()
    UsageFactory('nrcan', self._city).enrich()

    self._database = DBControl(
      db_name=repository.configuration.db_name,
      app_env='TEST',
      dotenv_path=dotenv_path)

    self._unique_id = str(uuid.uuid4())
    self._application = self._database.persist_application("test", "test application", self.unique_id)
    self._user = self._database.create_user("Admin", self.application.id, "Admin@123", UserRoles.Admin)
    self._pickle_path = 'tests_data/pickle_path.bz2'

  @property
  def database(self):
    return self._database

  @property
  def unique_id(self):
    return self._unique_id

  @property
  def application(self):
    return self._application

  @property
  def user(self):
    return self._user

  @property
  def skip_test(self):
    return self._skip_test

  @property
  def skip_reason(self):
    return self._skip_reason

  @property
  def message(self):
    return self._skip_reason

  @property
  def city(self):
    return self._city

  @property
  def pickle_path(self):
    return self._pickle_path


control = Control()


class TestDBFactory(TestCase):
  """
TestDBFactory
"""

  @unittest.skipIf(control.skip_test, control.skip_reason)
  def test_save_application(self):
    self.assertEqual(control.application.name, "test")
    self.assertEqual(control.application.description, "test application")
    self.assertEqual(str(control.application.application_uuid), control.unique_id)

  @unittest.skipIf(control.skip_test, control.skip_reason)
  def test_save_city(self):
    control.city.name = "Montreal"
    city = control.database.persist_city(
      control.city,
      control.pickle_path,
      control.application.id,
      control.user.id)
    self.assertEqual(city.name, 'Montreal')
    self.assertEqual(city.pickle_path, control.pickle_path)
    self.assertEqual(city.level_of_detail, control.city.level_of_detail.geometry)
    control.database.delete_city(city.id)
    os.unlink(control.pickle_path)

  @unittest.skipIf(control.skip_test, control.skip_reason)
  def test_get_update_city(self):
    city = control.database.persist_city(control.city,
                                         control.pickle_path,
                                         control.application.id,
                                         control._user.id)
    city.name = "Ottawa"
    control.database.update_city(city.id, control.city)
    cities = control.database.cities_by_user_and_application(
      control.user.id,
      control.application.id)
    for updated_city in cities:
      if updated_city.id == city.id:
        self.assertEqual(updated_city.name, city.name)
        break
    control.database.delete_city(city.id)