Fix lock path management

The way we were managing the locking mechanism was wrong, as we cannot
use the set_override method for this. We can pass our lock_path to the
decorator directly.

Fixes #55

Author: alvarolopez

caso/manager.py

@@ -62,8 +62,6 @@
 CONF.register_opts(opts)
 CONF.register_cli_opts(cli_opts)
 
-CONF.set_override("lock_path", override_lock, group="oslo_concurrency")
-
 
 class Manager(object):
     def __init__(self):
@@ -73,6 +71,8 @@ def __init__(self):
         self.extractor_manager = caso.extract.manager.Manager()
         self.messenger = caso.messenger.Manager()
 
+        self.lock_path = CONF.lock_path
+
     @property
     def lastrun(self):
         if os.path.exists(self.last_run_file):
@@ -88,10 +88,14 @@ def lastrun(self):
             raise
         return date
 
-    @lockutils.synchronized("caso_should_not_run_in_parallel", external=True)
     def run(self):
-        records = self.extractor_manager.get_records(lastrun=self.lastrun)
-        if not CONF.dry_run:
-            self.messenger.push_to_all(records)
-            with open(self.last_run_file, "w") as fd:
-                fd.write(str(datetime.datetime.now(tz.tzutc())))
+        @lockutils.synchronized("caso_should_not_run_in_parallel",
+                                lock_path=self.lock_path, external=True)
+        def synchronized():
+            records = self.extractor_manager.get_records(lastrun=self.lastrun)
+            if not CONF.dry_run:
+                self.messenger.push_to_all(records)
+                with open(self.last_run_file, "w") as fd:
+                    fd.write(str(datetime.datetime.now(tz.tzutc())))
+
+        return synchronized()

caso/tests/base.py

@@ -18,7 +18,9 @@
 import os
 
 import fixtures
+from oslo_concurrency import lockutils
 from oslo_config import cfg
+from oslo_config import fixture as config_fixture
 import six
 import testtools
 
@@ -31,6 +33,8 @@ class TestCase(testtools.TestCase):
 
     """Test case base class for all unit tests."""
 
+    REQUIRES_LOCKING = False
+
     def setUp(self):
         """Run before each test method to initialize test environment."""
 
@@ -56,6 +60,12 @@ def setUp(self):
 
         self.log_fixture = self.useFixture(fixtures.FakeLogger())
 
+        if self.REQUIRES_LOCKING:
+            lock_path = self.useFixture(fixtures.TempDir()).path
+            self.fixture = self.useFixture(
+                config_fixture.Config(lockutils.CONF))
+            self.fixture.config(lock_path=lock_path)
+
     def flags(self, **kw):
         """Override flag variables for a test."""
         group = kw.pop('group', None)

caso/tests/test_manager.py

@@ -28,6 +28,9 @@
 
 
 class TestCasoManager(base.TestCase):
+
+    REQUIRES_LOCKING = True
+
     def setUp(self):
         self.useFixture(lock_fixture.ExternalLockFixture())
         super(TestCasoManager, self).setUp()

etc/caso/caso-config-generator.conf

@@ -4,4 +4,3 @@ wrap_width = 79
 namespace = caso
 namespace = caso.config
 namespace = oslo.log
-namespace = oslo.concurrency

etc/caso/caso.conf.sample

@@ -286,22 +286,6 @@
 #port = 5000
 
 
-[oslo_concurrency]
-
-#
-# From oslo.concurrency
-#
-
-# Enables or disables inter-process locks. (boolean value)
-#disable_process_locking = false
-
-# Directory to use for lock files.  For security, the specified directory
-# should only be writable by the user running the processes that need locking.
-# Defaults to environment variable OSLO_LOCK_PATH. If external locks are used,
-# a lock path must be set. (string value)
-#lock_path = <None>
-
-
 [ssm]
 
 #

requirements.txt

@@ -3,7 +3,7 @@
 # process, which may cause wedges in the gate later.
 pbr>=1.6
 oslo.config>=2.3.0 # Apache-2.0
-oslo.concurrency
+oslo.concurrency>=3.20.0 # Apache-2.0
 oslo.log>=1.8.0 # Apache-2.0
 oslo.utils!=2.6.0,>=2.0.0 # Apache-2.0