ADD add sentinel in front of flow names for unit tests

Author: mfeurer

openml/config.py

@@ -16,6 +16,8 @@
 cachedir = ""
 privatedir = ""
 
+_testmode = False
+
 if sys.version_info[0] < 3:
     import ConfigParser as configparser
     from StringIO import StringIO

openml/flows/flow.py

@@ -3,6 +3,7 @@
 import sklearn
 
 from .._api_calls import _perform_api_call
+from .. import config
 
 
 class OpenMLFlow(object):
@@ -50,10 +51,16 @@ def _generate_flow_xml(self):
             Flow represented as XML string.
         """
         model = self.model
+
+        if config._testmode:
+            flow_name = '%s%s' % (config.testsentinel, self.name)
+        else:
+            flow_name = self.name
+
         flow_dict = OrderedDict()
         flow_dict['oml:flow'] = OrderedDict()
         flow_dict['oml:flow']['@xmlns:oml'] = 'http://openml.org/openml'
-        flow_dict['oml:flow']['oml:name'] = self.name
+        flow_dict['oml:flow']['oml:name'] = flow_name
         flow_dict['oml:flow']['oml:external_version'] = self.external_version
         flow_dict['oml:flow']['oml:description'] = self.description
 
@@ -136,6 +143,12 @@ def _check_flow_exists(name, version):
     if not (type(version) is str and len(version) > 0):
         raise ValueError('Argument \'version\' should be a non-empty string')
 
+    if config._testmode:
+        # It could already be in the name, for example when checking if a
+        # downloaded flow exists on the server
+        if config.testsentinel not in name:
+            name = '%s%s' % (config.testsentinel, name)
+
     return_code, xml_response = _perform_api_call(
         "flow/exists/%s/%s" % (name, version))
     # TODO check with latest version of code if this raises an exception

openml/testing.py

@@ -1,3 +1,4 @@
+import hashlib
 import inspect
 import os
 import shutil
@@ -39,6 +40,18 @@ def setUp(self):
         os.mkdir(self.workdir)
         os.chdir(self.workdir)
 
+        # Remove testmode once mock.wraps is available?
+        openml.config._testmode = True
+        apikey = openml.config.apikey
+        pid = os.getpid()
+        md5 = hashlib.md5()
+        md5.update(apikey.encode('utf-8'))
+        md5.update(str(pid).encode('utf-8'))
+        sentinel = md5.hexdigest()
+        # For testing the hash code mustn't be bulletproof
+        self.sentinel = '%sTESTSENTINEL999' % sentinel[:8]
+        openml.config.testsentinel = self.sentinel
+
         self.cached = True
         # amueller's read/write key that he will throw away later
         openml.config.apikey = "610344db6388d9ba34f6db45a3cf71de"
@@ -49,4 +62,6 @@ def tearDown(self):
         os.chdir(self.cwd)
         shutil.rmtree(self.workdir)
 
+        openml.config._testmode = False
+
 __all__ = ['TestBase']

tests/flows/test_flow.py

@@ -17,7 +17,7 @@ def check_flow(flow):
         for flow in flows:
             check_flow(flow)
 
-    @unittest.skip('Not tested until test sentinels are added back.')
+    # @unittest.skip('Not tested until test sentinels are added back.')
     def test_upload_flow(self):
         flow = openml.OpenMLFlow(model=DummyClassifier(), description="test description")
         return_code, return_value = flow.publish()