class QgisServerCheckerDialogTest(unittest.TestCase):
"""Test dialog works."""
def setUp(self):
"""Runs before each test."""
self.dialog = QgisServerCheckerDialog(None)
def tearDown(self):
"""Runs after each test."""
self.dialog = None
def test_dialog_ok(self):
"""Test we can click OK."""
button = self.dialog.button_box.button(QDialogButtonBox.Ok)
button.click()
result = self.dialog.result()
self.assertEqual(result, QDialog.Accepted)
def test_dialog_cancel(self):
"""Test we can click cancel."""
button = self.dialog.button_box.button(QDialogButtonBox.Cancel)
button.click()
result = self.dialog.result()
self.assertEqual(result, QDialog.Rejected)
def __init__(self, iface):
"""Constructor.
:param iface: An interface instance that will be passed to this class
which provides the hook by which you can manipulate the QGIS
application at run time.
:type iface: QgsInterface
"""
# Save reference to the QGIS interface
self.iface = iface
# initialize plugin directory
self.plugin_dir = os.path.dirname(__file__)
# initialize locale
locale = QSettings().value('locale/userLocale')[0:2]
locale_path = os.path.join(
self.plugin_dir,
'i18n',
'{}.qm'.format(locale))
#'QgisServerChecker_{}.qm'.format(locale))
if os.path.exists(locale_path):
self.translator = QTranslator()
self.translator.load(locale_path)
if qVersion() > '4.3.3':
QCoreApplication.installTranslator(self.translator)
# Create the dialog (after translation) and keep reference
self.dlg = QgisServerCheckerDialog()
# Declare instance attributes
self.actions = []
self.menu = self.tr(u'&QGIS Server Checker')
# TODO: We are going to let the user set this up in a future iteration
self.toolbar = self.iface.addToolBar(u'QgisServerChecker')
self.toolbar.setObjectName(u'QgisServerChecker')
class QgisServerChecker:
"""QGIS Plugin Implementation."""
def __init__(self, iface):
"""Constructor.
:param iface: An interface instance that will be passed to this class
which provides the hook by which you can manipulate the QGIS
application at run time.
:type iface: QgsInterface
"""
# Save reference to the QGIS interface
self.iface = iface
# initialize plugin directory
self.plugin_dir = os.path.dirname(__file__)
# initialize locale
locale = QSettings().value('locale/userLocale')[0:2]
locale_path = os.path.join(
self.plugin_dir,
'i18n',
'{}.qm'.format(locale))
#'QgisServerChecker_{}.qm'.format(locale))
if os.path.exists(locale_path):
self.translator = QTranslator()
self.translator.load(locale_path)
if qVersion() > '4.3.3':
QCoreApplication.installTranslator(self.translator)
# Create the dialog (after translation) and keep reference
self.dlg = QgisServerCheckerDialog()
# Declare instance attributes
self.actions = []
self.menu = self.tr(u'&QGIS Server Checker')
# TODO: We are going to let the user set this up in a future iteration
self.toolbar = self.iface.addToolBar(u'QgisServerChecker')
self.toolbar.setObjectName(u'QgisServerChecker')
# noinspection PyMethodMayBeStatic
def tr(self, message):
"""Get the translation for a string using Qt translation API.
We implement this ourselves since we do not inherit QObject.
:param message: String for translation.
:type message: str, QString
:returns: Translated version of message.
:rtype: QString
"""
# noinspection PyTypeChecker,PyArgumentList,PyCallByClass
return QCoreApplication.translate('QgisServerChecker', message)
def add_action(
self,
icon_path,
text,
callback,
enabled_flag=True,
add_to_menu=True,
add_to_toolbar=True,
status_tip=None,
whats_this=None,
parent=None):
"""Add a toolbar icon to the toolbar.
:param icon_path: Path to the icon for this action. Can be a resource
path (e.g. ':/plugins/foo/bar.png') or a normal file system path.
:type icon_path: str
:param text: Text that should be shown in menu items for this action.
:type text: str
:param callback: Function to be called when the action is triggered.
:type callback: function
:param enabled_flag: A flag indicating if the action should be enabled
by default. Defaults to True.
:type enabled_flag: bool
:param add_to_menu: Flag indicating whether the action should also
be added to the menu. Defaults to True.
:type add_to_menu: bool
:param add_to_toolbar: Flag indicating whether the action should also
be added to the toolbar. Defaults to True.
:type add_to_toolbar: bool
:param status_tip: Optional text to show in a popup when mouse pointer
hovers over the action.
:type status_tip: str
:param parent: Parent widget for the new action. Defaults None.
:type parent: QWidget
:param whats_this: Optional text to show in the status bar when the
mouse pointer hovers over the action.
:returns: The action that was created. Note that the action is also
added to self.actions list.
:rtype: QAction
"""
icon = QIcon(icon_path)
action = QAction(icon, text, parent)
action.triggered.connect(callback)
action.setEnabled(enabled_flag)
if status_tip is not None:
action.setStatusTip(status_tip)
if whats_this is not None:
action.setWhatsThis(whats_this)
if add_to_toolbar:
self.toolbar.addAction(action)
if add_to_menu:
self.iface.addPluginToMenu(
self.menu,
action)
self.actions.append(action)
return action
def initGui(self):
"""Create the menu entries and toolbar icons inside the QGIS GUI."""
icon_path = ':/plugins/QgisServerChecker/icon.png'
self.add_action(
icon_path,
text=self.tr(u'QGIS Server Checker'),
callback=self.run,
parent=self.iface.mainWindow())
self.dlg.mCheckButton.clicked.connect( self.checkQGISServer )
def unload(self):
"""Removes the plugin menu item and icon from QGIS GUI."""
for action in self.actions:
self.iface.removePluginMenu(
self.tr(u'&QGIS Server Checker'),
action)
self.iface.removeToolBarIcon(action)
# remove the toolbar
del self.toolbar
def checkQGISServer(self):
"""Check the QGIS Server configuration"""
self.dlg.bar.clearWidgets()
self.dlg.mMessageText.clear()
self.dlg.mMessageText.append(self.tr("Start checking QGIS Server"))
treeRoot = self.iface.layerTreeView().layerTreeModel().rootGroup()
layerNames = []
groupNames = []
encodingMessages = []
self.checkGroupQGISServer(treeRoot, layerNames, groupNames, encodingMessages)
duplicateNames = []
for name in layerNames:
if name in duplicateNames:
continue
if name in groupNames or layerNames.count(name) > 1:
duplicateNames.append( name )
for name in groupNames:
if name in duplicateNames:
continue
if name in layerNames or groupNames.count(name) > 1:
duplicateNames.append( name )
if len(duplicateNames):
self.dlg.bar.pushMessage(self.tr("Name"), self.tr("Some layers and groups have the same name"), level=QgsMessageBar.CRITICAL)
self.dlg.mMessageText.append(self.tr("Duplicate names:"))
for n in duplicateNames:
self.dlg.mMessageText.append(n)
if len(encodingMessages):
self.dlg.bar.pushMessage(self.tr("Encoding"), self.tr("Some layer encoding not set"), level=QgsMessageBar.CRITICAL)
for m in encodingMessages:
self.dlg.mMessageText.append(m)
if not len(duplicateNames) and not len(encodingMessages):
self.dlg.bar.pushMessage(self.tr("Result"), self.tr("Well configured project"), level=QgsMessageBar.INFO)
self.dlg.mMessageText.append(self.tr("End checking QGIS Server"))
def checkGroupQGISServer(self, treeGroup, layerNames, groupNames, encodingMessages):
for child in treeGroup.children():
if isinstance(child, QgsLayerTreeGroup):
groupNames.append(child.name())
self.checkGroupQGISServer( child, layerNames, groupNames, encodingMessages )
elif isinstance(child, QgsLayerTreeLayer):
l = child.layer()
layerNames.append(l.name())
if hasattr( l.dataProvider(), 'encoding' ):
enc = l.dataProvider().encoding()
if enc == 'System':
if not len(encodingMessages):
encodingMessages.append(self.tr('Encoding messages:'))
encodingMessages.append(self.tr('Update layer "%s" encoding') % l.name())
def run(self):
"""Run method that performs all the real work"""
# show the dialog
self.dlg.show()
# Run the dialog event loop
result = self.dlg.exec_()
# See if OK was pressed
if result:
# Do something useful here - delete the line containing pass and
# substitute with your code.
pass
def setUp(self):
"""Runs before each test."""
self.dialog = QgisServerCheckerDialog(None)