Merge pull request #53 from force-h2020/silence-id-warnings

Silenced warnings for IDs not specified by specifying them

doc/source/api/force_bdss.tests.rst

@@ -27,10 +27,10 @@ force_bdss.tests.test_bundle_registry_plugin module
     :undoc-members:
     :show-inheritance:
 
-force_bdss.tests.test_id_generators module
-------------------------------------------
+force_bdss.tests.test_ids module
+--------------------------------
 
-.. automodule:: force_bdss.tests.test_id_generators
+.. automodule:: force_bdss.tests.test_ids
     :members:
     :undoc-members:
     :show-inheritance:

force_bdss/api.py

 from .base_extension_plugin import BaseExtensionPlugin  # noqa
-from .ids import bundle_id  # noqa
+from .ids import bundle_id, plugin_id  # noqa
 
 from .data_sources.base_data_source_model import BaseDataSourceModel  # noqa
 from .data_sources.data_source_result import DataSourceResult  # noqa

force_bdss/core_evaluation_driver.py

@@ -3,17 +3,21 @@ from __future__ import print_function
 import sys
 from traits.api import on_trait_change
 
+from .ids import plugin_id
 from .base_core_driver import BaseCoreDriver
 from .io.workflow_reader import (
     InvalidVersionException,
     InvalidFileException
 )
 
+CORE_EVALUATION_DRIVER_ID = plugin_id("core", "CoreEvaluationDriver")
+
 
 class CoreEvaluationDriver(BaseCoreDriver):
     """Main plugin that handles the execution of the MCO
     or the evaluation.
     """
+    id = CORE_EVALUATION_DRIVER_ID
 
     @on_trait_change("application:started")
     def application_started(self):

force_bdss/core_mco_driver.py

@@ -4,17 +4,21 @@ import sys
 
 from traits.api import on_trait_change
 
+from .ids import plugin_id
 from .base_core_driver import BaseCoreDriver
 from .io.workflow_reader import (
     InvalidVersionException,
     InvalidFileException
 )
 
+CORE_MCO_DRIVER_ID = plugin_id("core", "CoreMCODriver")
+
 
 class CoreMCODriver(BaseCoreDriver):
     """Main plugin that handles the execution of the MCO
     or the evaluation.
     """
+    id = CORE_MCO_DRIVER_ID
 
     @on_trait_change("application:started")
     def application_started(self):

force_bdss/core_plugins/dummy/dummy_plugin.py

-from force_bdss.api import BaseExtensionPlugin
+from force_bdss.api import BaseExtensionPlugin, plugin_id
 from .csv_extractor.csv_extractor_bundle import CSVExtractorBundle
 from .kpi_adder.kpi_adder_bundle import KPIAdderBundle
 from .dummy_dakota.dakota_bundle import DummyDakotaBundle
@@ -9,6 +9,8 @@ from .dummy_kpi_calculator.dummy_kpi_calculator_bundle import (
 
 
 class DummyPlugin(BaseExtensionPlugin):
+    id = plugin_id("enthought", "DummyPlugin")
+
     def _data_source_bundles_default(self):
         return [DummyDataSourceBundle(),
                 CSVExtractorBundle()]

force_bdss/ids.py

@@ -33,9 +33,18 @@ def bundle_id(producer, identifier):
 
 
 def mco_parameter_id(producer, identifier):
+    """Creates an ID for an MCO parameter, so that it can be identified
+    uniquely."""
     return _string_id("mco_parameter", producer, identifier)
 
 
+def plugin_id(producer, identifier):
+    """Creates an ID for the plugins. These must be defined, otherwise
+    the envisage system will complain (but not break)
+    """
+    return _string_id("plugin", producer, identifier)
+
+
 def _string_id(entity_namespace, producer, identifier):
     """Creates an id for a generic entity.
 

force_bdss/tests/test_id_generators.py → force_bdss/tests/test_ids.py

 import unittest
 
-from force_bdss.ids import bundle_id
+from force_bdss.ids import bundle_id, plugin_id
 
 
 class TestIdGenerators(unittest.TestCase):
@@ -13,3 +13,12 @@ class TestIdGenerators(unittest.TestCase):
                 bundle_id(bad_entry, "bar")
             with self.assertRaises(ValueError):
                 bundle_id("foo", bad_entry)
+
+    def test_plugin_id(self):
+        self.assertEqual(plugin_id("foo", "bar"), "force.bdss.plugin.foo.bar")
+
+        for bad_entry in ["", None, "   ", "foo bar"]:
+            with self.assertRaises(ValueError):
+                plugin_id(bad_entry, "bar")
+            with self.assertRaises(ValueError):
+                plugin_id("foo", bad_entry)