def init_qgis():
"""QGIS Initialization
This function must be called exactly once for each server process and
before using any QGIS API call.
"""
global QGS_APPLICATION, QGS_SERVER_SETTINGS, QGS_SERVER
# create a reference to the QgsApplication
# setting the second argument to True enables the GUI, which we do not need to do
# since this is a custom application
QGS_APPLICATION = QgsApplication([], False)
# load providers
QGS_APPLICATION.initQgis()
if hasattr(settings, 'QGIS_AUTH_PASSWORD') and settings.QGIS_AUTH_PASSWORD:
if not QgsApplication.authManager().setMasterPassword(
settings.QGIS_AUTH_PASSWORD, True):
raise ImproperlyConfigured(
'Error setting QGIS Auth DB master password from settings.QGIS_AUTH_PASSWORD'
)
# Do any environment manipulation here, before we create the server
# and the settings are read
os.environ['QGIS_SERVER_IGNORE_BAD_LAYERS'] = '1'
QGS_SERVER_SETTINGS = QgsServerSettings()
QGS_SERVER_SETTINGS.load()
# Create a singleton server instance, this is not really necessary but it
# may be a little faster than creating a new instance every time we handle
# a request
QGS_SERVER = QgsServer()
def setUp(self):
self.settings = QgsServerSettings()
self.testdata_path = unitTestDataPath("qgis_server_settings")
class TestQgsServerSettings(unittest.TestCase):
def setUp(self):
self.settings = QgsServerSettings()
self.testdata_path = unitTestDataPath("qgis_server_settings")
def tearDown(self):
pass
def test_env_parallel_rendering(self):
env = "QGIS_SERVER_PARALLEL_RENDERING"
# test parallel rendering value from environment variable
os.environ[env] = "1"
self.settings.load()
self.assertTrue(self.settings.parallelRendering())
os.environ.pop(env)
os.environ[env] = "0"
self.settings.load()
self.assertFalse(self.settings.parallelRendering())
os.environ.pop(env)
def test_env_log_level(self):
env = "QGIS_SERVER_LOG_LEVEL"
# test log level value from environment variable
os.environ[env] = "3"
self.settings.load()
self.assertEqual(self.settings.logLevel(), 3)
os.environ.pop(env)
os.environ[env] = "1"
self.settings.load()
self.assertEqual(self.settings.logLevel(), 1)
os.environ.pop(env)
def test_env_log_file(self):
env = "QGIS_SERVER_LOG_FILE"
# test parallel rendering value from environment variable
os.environ[env] = "/tmp/qgisserv.log"
self.settings.load()
self.assertEqual(self.settings.logFile(), "/tmp/qgisserv.log")
os.environ.pop(env)
os.environ[env] = "/tmp/qserv.log"
self.settings.load()
self.assertEqual(self.settings.logFile(), "/tmp/qserv.log")
os.environ.pop(env)
def test_env_project_file(self):
env = "QGIS_PROJECT_FILE"
# test parallel rendering value from environment variable
os.environ[env] = "/tmp/myproject.qgs"
self.settings.load()
self.assertEqual(self.settings.projectFile(), "/tmp/myproject.qgs")
os.environ.pop(env)
os.environ[env] = "/tmp/myproject2.qgs"
self.settings.load()
self.assertEqual(self.settings.projectFile(), "/tmp/myproject2.qgs")
os.environ.pop(env)
def test_env_max_cache_layers(self):
env = "MAX_CACHE_LAYERS"
# test parallel rendering value from environment variable
os.environ[env] = "3"
self.settings.load()
self.assertEqual(self.settings.maxCacheLayers(), 3)
os.environ.pop(env)
os.environ[env] = "100"
self.settings.load()
self.assertEqual(self.settings.maxCacheLayers(), 100)
os.environ.pop(env)
def test_env_max_threads(self):
env = "QGIS_SERVER_MAX_THREADS"
# test parallel rendering value from environment variable
os.environ[env] = "3"
self.settings.load()
self.assertEqual(self.settings.maxThreads(), 3)
os.environ.pop(env)
os.environ[env] = "5"
self.settings.load()
self.assertEqual(self.settings.maxThreads(), 5)
os.environ.pop(env)
def test_env_cache_size(self):
env = "QGIS_SERVER_CACHE_SIZE"
self.assertEqual(self.settings.cacheSize(), 50 * 1024 * 1024)
os.environ[env] = "1024"
self.settings.load()
self.assertEqual(self.settings.cacheSize(), 1024)
os.environ.pop(env)
def test_env_cache_directory(self):
env = "QGIS_SERVER_CACHE_DIRECTORY"
os.environ[env] = "/tmp/fake"
self.settings.load()
self.assertEqual(self.settings.cacheDirectory(), "/tmp/fake")
os.environ.pop(env)
def test_priority(self):
env = "QGIS_OPTIONS_PATH"
dpath = "conf0"
QCoreApplication.setOrganizationName(dpath)
# load settings
os.environ[env] = self.testdata_path
self.settings.load()
# test conf
self.assertTrue(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 3)
# set environment variables and test priority
env_pr = "QGIS_SERVER_PARALLEL_RENDERING"
os.environ[env_pr] = "0"
env_mt = "QGIS_SERVER_MAX_THREADS"
os.environ[env_mt] = "5"
self.settings.load()
self.assertFalse(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 5)
# clear environment
os.environ.pop(env)
os.environ.pop(env_pr)
os.environ.pop(env_mt)
def test_options_path_conf0(self):
env = "QGIS_OPTIONS_PATH"
dpath = "conf0"
ini = "{0}.ini".format(os.path.join(self.testdata_path, dpath))
QCoreApplication.setOrganizationName(dpath)
# load settings
os.environ[env] = self.testdata_path
self.settings.load()
# test ini file
self.assertEqual(ini, self.settings.iniFile())
# test conf
self.assertTrue(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 3)
self.assertEqual(self.settings.cacheSize(), 52428800)
# default value when an empty string is indicated in ini file
self.assertEqual(self.settings.cacheDirectory(), "cache")
# clear environment
os.environ.pop(env)
def test_options_path_conf1(self):
env = "QGIS_OPTIONS_PATH"
dpath = "conf1"
ini = "{0}.ini".format(os.path.join(self.testdata_path, dpath))
QCoreApplication.setOrganizationName(dpath)
# load settings
os.environ[env] = self.testdata_path
self.settings.load()
# test ini file
self.assertEqual(ini, self.settings.iniFile())
# test conf
self.assertFalse(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 5)
self.assertEqual(self.settings.cacheSize(), 52428800)
self.assertEqual(self.settings.cacheDirectory(), "/tmp/mycache")
# clear environment
os.environ.pop(env)
def setUp(self):
self.settings = QgsServerSettings()
self.testdata_path = unitTestDataPath("qgis_server_settings")
class TestQgsServerSettings(unittest.TestCase):
def setUp(self):
self.settings = QgsServerSettings()
self.testdata_path = unitTestDataPath("qgis_server_settings")
def tearDown(self):
pass
def test_env_parallel_rendering(self):
env = "QGIS_SERVER_PARALLEL_RENDERING"
# test parallel rendering value from environment variable
os.environ[env] = "1"
self.settings.load()
self.assertTrue(self.settings.parallelRendering())
os.environ.pop(env)
os.environ[env] = "0"
self.settings.load()
self.assertFalse(self.settings.parallelRendering())
os.environ.pop(env)
def test_env_log_level(self):
env = "QGIS_SERVER_LOG_LEVEL"
# test log level value from environment variable
os.environ[env] = "3"
self.settings.load()
self.assertEqual(self.settings.logLevel(), 3)
os.environ.pop(env)
os.environ[env] = "1"
self.settings.load()
self.assertEqual(self.settings.logLevel(), 1)
os.environ.pop(env)
def test_env_log_file(self):
env = "QGIS_SERVER_LOG_FILE"
# test parallel rendering value from environment variable
os.environ[env] = "/tmp/qgisserv.log"
self.settings.load()
self.assertEqual(self.settings.logFile(), "/tmp/qgisserv.log")
os.environ.pop(env)
os.environ[env] = "/tmp/qserv.log"
self.settings.load()
self.assertEqual(self.settings.logFile(), "/tmp/qserv.log")
os.environ.pop(env)
def test_env_project_file(self):
env = "QGIS_PROJECT_FILE"
# test parallel rendering value from environment variable
os.environ[env] = "/tmp/myproject.qgs"
self.settings.load()
self.assertEqual(self.settings.projectFile(), "/tmp/myproject.qgs")
os.environ.pop(env)
os.environ[env] = "/tmp/myproject2.qgs"
self.settings.load()
self.assertEqual(self.settings.projectFile(), "/tmp/myproject2.qgs")
os.environ.pop(env)
def test_env_max_cache_layers(self):
env = "MAX_CACHE_LAYERS"
# test parallel rendering value from environment variable
os.environ[env] = "3"
self.settings.load()
self.assertEqual(self.settings.maxCacheLayers(), 3)
os.environ.pop(env)
os.environ[env] = "100"
self.settings.load()
self.assertEqual(self.settings.maxCacheLayers(), 100)
os.environ.pop(env)
def test_env_max_threads(self):
env = "QGIS_SERVER_MAX_THREADS"
# test parallel rendering value from environment variable
os.environ[env] = "3"
self.settings.load()
self.assertEqual(self.settings.maxThreads(), 3)
os.environ.pop(env)
os.environ[env] = "5"
self.settings.load()
self.assertEqual(self.settings.maxThreads(), 5)
os.environ.pop(env)
def test_env_cache_size(self):
env = "QGIS_SERVER_CACHE_SIZE"
self.assertEqual(self.settings.cacheSize(), 50 * 1024 * 1024)
os.environ[env] = "1024"
self.settings.load()
self.assertEqual(self.settings.cacheSize(), 1024)
os.environ.pop(env)
def test_env_cache_directory(self):
env = "QGIS_SERVER_CACHE_DIRECTORY"
os.environ[env] = "/tmp/fake"
self.settings.load()
self.assertEqual(self.settings.cacheDirectory(), "/tmp/fake")
os.environ.pop(env)
def test_priority(self):
env = "QGIS_OPTIONS_PATH"
dpath = "conf0"
QCoreApplication.setOrganizationName(dpath)
# load settings
os.environ[env] = self.testdata_path
self.settings.load()
# test conf
self.assertTrue(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 3)
# set environment variables and test priority
env_pr = "QGIS_SERVER_PARALLEL_RENDERING"
os.environ[env_pr] = "0"
env_mt = "QGIS_SERVER_MAX_THREADS"
os.environ[env_mt] = "5"
self.settings.load()
self.assertFalse(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 5)
# clear environment
os.environ.pop(env)
os.environ.pop(env_pr)
os.environ.pop(env_mt)
def test_options_path_conf0(self):
env = "QGIS_OPTIONS_PATH"
dpath = "conf0"
ini = "{0}.ini".format(os.path.join(self.testdata_path, dpath))
QCoreApplication.setOrganizationName(dpath)
# load settings
os.environ[env] = self.testdata_path
self.settings.load()
# test ini file
self.assertEqual(ini, self.settings.iniFile())
# test conf
self.assertTrue(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 3)
self.assertEqual(self.settings.cacheSize(), 52428800)
# default value when an empty string is indicated in ini file
self.assertEqual(self.settings.cacheDirectory(), "cache")
# clear environment
os.environ.pop(env)
def test_options_path_conf1(self):
env = "QGIS_OPTIONS_PATH"
dpath = "conf1"
ini = "{0}.ini".format(os.path.join(self.testdata_path, dpath))
QCoreApplication.setOrganizationName(dpath)
# load settings
os.environ[env] = self.testdata_path
self.settings.load()
# test ini file
self.assertEqual(ini, self.settings.iniFile())
# test conf
self.assertFalse(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 5)
self.assertEqual(self.settings.cacheSize(), 52428800)
self.assertEqual(self.settings.cacheDirectory(), "/tmp/mycache")
# clear environment
os.environ.pop(env)
# or if virtualenv messes up with the paths
QgsApplication.setPrefixPath("/usr", True)
# create a reference to the QgsApplication
# setting the second argument to True enables the GUI, which we do not need to do
# since this is a custom application
QGS_APPLICATION = QgsApplication([], False)
# load providers
QGS_APPLICATION.initQgis()
# Do any environment manipulation here, before we create the server
# and the settings are read
os.environ['QGIS_SERVER_IGNORE_BAD_LAYERS'] = '1'
QGS_SERVER_SETTINGS = QgsServerSettings()
QGS_SERVER_SETTINGS.load()
# Create a singleton server instance, this is not really necessary but it
# may be a little faster than creating a new instance every time we handle
# a request
QGS_SERVER = QgsServer()
def get_qgs_project(path):
"""Reads and returns a project from the cache, trying to load it
if it's not there.
A None is returned if the project could not be loaded.
:param path: the filesystem path to the project
:type path: str
def test_env_name(self):
env = QgsServerSettingsEnv.QGIS_SERVER_LANDING_PAGE_PROJECTS_DIRECTORIES
name = QgsServerSettings.name(env)
self.assertEqual(name, "QGIS_SERVER_LANDING_PAGE_PROJECTS_DIRECTORIES")
class TestQgsServerSettings(unittest.TestCase):
def setUp(self):
self.settings = QgsServerSettings()
self.testdata_path = unitTestDataPath("qgis_server_settings")
def tearDown(self):
pass
def test_env_parallel_rendering(self):
env = "QGIS_SERVER_PARALLEL_RENDERING"
# test parallel rendering value from environment variable
os.environ[env] = "1"
self.settings.load()
self.assertTrue(self.settings.parallelRendering())
os.environ.pop(env)
os.environ[env] = "0"
self.settings.load()
self.assertFalse(self.settings.parallelRendering())
os.environ.pop(env)
def test_env_log_level(self):
env = "QGIS_SERVER_LOG_LEVEL"
# test log level value from environment variable
os.environ[env] = "3"
self.settings.load()
self.assertEqual(self.settings.logLevel(), 3)
os.environ.pop(env)
os.environ[env] = "1"
self.settings.load()
self.assertEqual(self.settings.logLevel(), 1)
os.environ.pop(env)
def test_env_log_file(self):
env = "QGIS_SERVER_LOG_FILE"
# test parallel rendering value from environment variable
os.environ[env] = "/tmp/qgisserv.log"
self.settings.load()
self.assertEqual(self.settings.logFile(), "/tmp/qgisserv.log")
os.environ.pop(env)
os.environ[env] = "/tmp/qserv.log"
self.settings.load()
self.assertEqual(self.settings.logFile(), "/tmp/qserv.log")
os.environ.pop(env)
def test_env_project_file(self):
env = "QGIS_PROJECT_FILE"
# test parallel rendering value from environment variable
os.environ[env] = "/tmp/myproject.qgs"
self.settings.load()
self.assertEqual(self.settings.projectFile(), "/tmp/myproject.qgs")
os.environ.pop(env)
os.environ[env] = "/tmp/myproject2.qgs"
self.settings.load()
self.assertEqual(self.settings.projectFile(), "/tmp/myproject2.qgs")
os.environ.pop(env)
def test_env_max_cache_layers(self):
env = "MAX_CACHE_LAYERS"
# test parallel rendering value from environment variable
os.environ[env] = "3"
self.settings.load()
self.assertEqual(self.settings.maxCacheLayers(), 3)
os.environ.pop(env)
os.environ[env] = "100"
self.settings.load()
self.assertEqual(self.settings.maxCacheLayers(), 100)
os.environ.pop(env)
def test_env_max_threads(self):
env = "QGIS_SERVER_MAX_THREADS"
# test parallel rendering value from environment variable
os.environ[env] = "3"
self.settings.load()
self.assertEqual(self.settings.maxThreads(), 3)
os.environ.pop(env)
os.environ[env] = "5"
self.settings.load()
self.assertEqual(self.settings.maxThreads(), 5)
os.environ.pop(env)
def test_env_cache_size(self):
env = "QGIS_SERVER_CACHE_SIZE"
self.assertEqual(self.settings.cacheSize(), 50 * 1024 * 1024)
os.environ[env] = "1024"
self.settings.load()
self.assertEqual(self.settings.cacheSize(), 1024)
os.environ.pop(env)
def test_env_cache_directory(self):
env = "QGIS_SERVER_CACHE_DIRECTORY"
os.environ[env] = "/tmp/fake"
self.settings.load()
self.assertEqual(self.settings.cacheDirectory(), "/tmp/fake")
os.environ.pop(env)
def test_env_trust_layer_metadata(self):
env = "QGIS_SERVER_TRUST_LAYER_METADATA"
self.assertFalse(self.settings.trustLayerMetadata())
os.environ[env] = "1"
self.settings.load()
self.assertTrue(self.settings.trustLayerMetadata())
os.environ.pop(env)
os.environ[env] = "0"
self.settings.load()
self.assertFalse(self.settings.trustLayerMetadata())
os.environ.pop(env)
def test_env_load_layouts_disabled(self):
env = "QGIS_SERVER_DISABLE_GETPRINT"
self.assertFalse(self.settings.getPrintDisabled())
os.environ[env] = "1"
self.settings.load()
self.assertTrue(self.settings.getPrintDisabled())
os.environ.pop(env)
os.environ[env] = "0"
self.settings.load()
self.assertFalse(self.settings.getPrintDisabled())
os.environ.pop(env)
def test_priority(self):
env = "QGIS_OPTIONS_PATH"
dpath = "conf0"
QCoreApplication.setOrganizationName(dpath)
# load settings
os.environ[env] = self.testdata_path
self.settings.load()
# test conf
self.assertTrue(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 3)
# set environment variables and test priority
env_pr = "QGIS_SERVER_PARALLEL_RENDERING"
os.environ[env_pr] = "0"
env_mt = "QGIS_SERVER_MAX_THREADS"
os.environ[env_mt] = "5"
self.settings.load()
self.assertFalse(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 5)
# clear environment
os.environ.pop(env)
os.environ.pop(env_pr)
os.environ.pop(env_mt)
def test_options_path_conf0(self):
env = "QGIS_OPTIONS_PATH"
dpath = "conf0"
ini = "{0}.ini".format(os.path.join(self.testdata_path, dpath))
QCoreApplication.setOrganizationName(dpath)
# load settings
os.environ[env] = self.testdata_path
self.settings.load()
# test ini file
self.assertEqual(ini, self.settings.iniFile())
# test conf
self.assertTrue(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 3)
self.assertEqual(self.settings.cacheSize(), 52428800)
# default value when an empty string is indicated in ini file
self.assertEqual(self.settings.cacheDirectory(), "cache")
# clear environment
os.environ.pop(env)
def test_options_path_conf1(self):
env = "QGIS_OPTIONS_PATH"
dpath = "conf1"
ini = "{0}.ini".format(os.path.join(self.testdata_path, dpath))
QCoreApplication.setOrganizationName(dpath)
# load settings
os.environ[env] = self.testdata_path
self.settings.load()
# test ini file
self.assertEqual(ini, self.settings.iniFile())
# test conf
self.assertFalse(self.settings.parallelRendering())
self.assertEqual(self.settings.maxThreads(), 5)
self.assertEqual(self.settings.cacheSize(), 52428800)
self.assertEqual(self.settings.cacheDirectory(), "/tmp/mycache")
# clear environment
os.environ.pop(env)
def test_env_actual(self):
env = "QGIS_SERVER_LANDING_PAGE_PROJECTS_DIRECTORIES"
env2 = "QGIS_SERVER_LANDING_PAGE_PROJECTS_PG_CONNECTIONS"
os.environ[env] = "/tmp/initial"
os.environ[env2] = "pg:initial"
# test initial value
self.settings.load()
self.assertEqual(self.settings.landingPageProjectsDirectories(),
"/tmp/initial")
self.assertEqual(self.settings.landingPageProjectsPgConnections(),
"pg:initial")
# set new environment variable
os.environ[env] = "/tmp/new"
os.environ[env2] = "pg:new"
# test new environment variable
self.assertEqual(self.settings.landingPageProjectsDirectories(),
"/tmp/new")
self.assertEqual(self.settings.landingPageProjectsPgConnections(),
"pg:new")
# current environment variable are popped
os.environ.pop(env)
os.environ.pop(env2)
# fallback to initial values
self.assertEqual(self.settings.landingPageProjectsDirectories(),
"/tmp/initial")
self.assertEqual(self.settings.landingPageProjectsPgConnections(),
"pg:initial")
def test_env_name(self):
env = QgsServerSettingsEnv.QGIS_SERVER_LANDING_PAGE_PROJECTS_DIRECTORIES
name = QgsServerSettings.name(env)
self.assertEqual(name, "QGIS_SERVER_LANDING_PAGE_PROJECTS_DIRECTORIES")
