5.0.0 policy-handler - new PDP API or old PDP API4.0.0-ONAPdublin

- in R4 Dublin the policy-engine introduced a totally new API
- policy-handler now has a startup option to either use the new PDP API
  or the old PDP API that was created-updated before the end of 2018
- see README.md and README_pdp_api_v0.md for instructions on how to
  setup the policy-handler running either with the new PDP API
  or the old (pdp_api_v0) PDP API
- this is a massive refactoring that changed almost all the source files,
  but kept the old logic when using the old (pdp_api_v0) PDP API
- all the code related to PDP API version is split into two subfolders
  = pdp_api/ contains the new PDP API source code
  = pdp_api_v0/ contains the old (2018) PDP API source code
  = pdp_client.py imports from either pdp_api or pdp_api_v0
  = the rest of the code is only affected when it needs to branch
    the logic
- logging to policy_handler.log now shows the path of the source file to
  allow tracing which PDP API is actually used
- when the new PDP API is used, the policy-update flow is disabled
  = passive mode of operation
  = no web-socket
  = no periodic catch_up
  = no policy-filters
  = reduced web-API - only a single /policy_latest endpoint is available
    /policies_latest returns 404
    /catch_up request is accepted, but ignored
- on new PDP API: http /policy_latest returns the new data from the
  new PDP API with the following fields added by the policy-handler
  to keep other policy related parts intact in R4
  (see pdp_api/policy_utils.py)
  = "policyName" = policy_id + "." + "policyVersion" + ".xml"
  = "policyVersion" = str("metadata"."policy-version")
  = "config" - is the renamed "properties" from the new PDP API response
- unit tests are split into two subfolders as well
  = main/ for the new PDP API testing
  = pdp_api_v0/ for the old (2018) PDP API
- removed the following line from the license text of changed files
  ECOMP is a trademark and service mark of AT&T Intellectual Property.

- the new PDP API is expected to be extended and redesigned in R5 El Alto
- on retiring the old PDP API - the intention is to be able to remove
  the pdp_api_v0/ subfolder and minimal related cleanup of the code
  that imports that as well as the cleanup of the config.py, etc.

Change-Id: Ief9a2ae4541300308caaf97377f4ed051535dbe4
Signed-off-by: Alex Shatov <alexs@att.com>
Issue-ID: DCAEGEN2-1128

1 files changed, 199 insertions, 0 deletions

diff --git a/tests/utils/test_step_timer.py b/tests/utils/test_step_timer.py
new file mode 100644
index 0000000..152836d
--- /dev/null
+++ b/tests/utils/test_step_timer.py
@@ -0,0 +1,199 @@
+# ============LICENSE_START=======================================================
+# Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved.
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ============LICENSE_END=========================================================
+#
+
+"""test of the step_timer"""
+
+import json
+import time
+from datetime import datetime
+
+from policyhandler.step_timer import StepTimer
+from policyhandler.utils import Utils
+
+_LOGGER = Utils.get_logger(__file__)
+
+class MockTimerController(object):
+    """testing step_timer"""
+    INIT = "init"
+    NEXT = "next"
+    STARTED = "started"
+    PAUSED = "paused"
+    STOPPING = "stopping"
+    STOPPED = "stopped"
+
+    def __init__(self, name, interval):
+        """step_timer test settings"""
+        self.name = name or "step_timer"
+        self.interval = interval or 5
+        self.step_timer = None
+        self.status = None
+        self.run_counter = 0
+        self.status_ts = datetime.utcnow()
+        self.exe_ts = None
+        self.exe_interval = None
+        self.set_status(MockTimerController.INIT)
+
+    def __enter__(self):
+        """constructor"""
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        """destructor"""
+        self.stop_timer()
+
+    def on_time(self, *args, **kwargs):
+        """timer event"""
+        self.exe_ts = datetime.utcnow()
+        self.exe_interval = (self.exe_ts - self.status_ts).total_seconds()
+        _LOGGER.info("run on_time[%s] (%s, %s) in %s for %s",
+                     self.run_counter, json.dumps(args), json.dumps(kwargs),
+                     self.exe_interval, self.get_status())
+        time.sleep(3)
+        _LOGGER.info("done on_time[%s] (%s, %s) in %s for %s",
+                     self.run_counter, json.dumps(args), json.dumps(kwargs),
+                     self.exe_interval, self.get_status())
+
+    def verify_last_event(self):
+        """assertions needs to be in the main thread"""
+        if self.exe_interval is None:
+            _LOGGER.info("not executed: %s", self.get_status())
+            return
+
+        _LOGGER.info("verify exe %s for %s", self.exe_interval, self.get_status())
+        assert self.exe_interval >= (self.interval - 0.01)
+        assert self.exe_interval < 2 * self.interval
+        _LOGGER.info("success %s", self.get_status())
+
+    def run_timer(self):
+        """create and start the step_timer"""
+        if self.step_timer:
+            self.step_timer.next()
+            self.set_status(MockTimerController.NEXT)
+            return
+
+        self.step_timer = StepTimer(self.name, self.interval, MockTimerController.on_time, self)
+        self.step_timer.start()
+        self.set_status(MockTimerController.STARTED)
+
+    def pause_timer(self):
+        """pause step_timer"""
+        if self.step_timer:
+            self.step_timer.pause()
+            self.set_status(MockTimerController.PAUSED)
+
+    def stop_timer(self):
+        """stop step_timer"""
+        if self.step_timer:
+            self.set_status(MockTimerController.STOPPING)
+            self.step_timer.stop()
+            self.step_timer.join()
+            self.step_timer = None
+            self.set_status(MockTimerController.STOPPED)
+
+    def set_status(self, status):
+        """set the status of the timer"""
+        if status in [MockTimerController.NEXT, MockTimerController.STARTED]:
+            self.run_counter += 1
+
+        self.status = status
+        utcnow = datetime.utcnow()
+        time_step = (utcnow - self.status_ts).total_seconds()
+        self.status_ts = utcnow
+        _LOGGER.info("[%s]: %s", time_step, self.get_status())
+
+    def get_status(self):
+        """string representation"""
+        status = "{0}[{1}] {2} in {3} from {4} last exe {5}".format(
+            self.status, self.run_counter, self.name, self.interval,
+            str(self.status_ts), str(self.exe_ts)
+        )
+        if self.step_timer:
+            return "{0}: {1}".format(status, self.step_timer.get_timer_status())
+        return status
+
+
+def test_step_timer():
+    """test step_timer"""
+    _LOGGER.info("============ test_step_timer =========")
+    with MockTimerController("step_timer", 5) as step_timer:
+        step_timer.run_timer()
+        time.sleep(1)
+        step_timer.verify_last_event()
+
+        time.sleep(1 + step_timer.interval)
+        step_timer.verify_last_event()
+
+        step_timer.pause_timer()
+        time.sleep(2)
+        step_timer.verify_last_event()
+
+        step_timer.pause_timer()
+        time.sleep(2)
+        step_timer.verify_last_event()
+
+        step_timer.run_timer()
+        time.sleep(3 * step_timer.interval)
+        step_timer.verify_last_event()
+
+        step_timer.run_timer()
+        time.sleep(3 * step_timer.interval)
+        step_timer.verify_last_event()
+
+
+def test_interrupt_step_timer():
+    """test step_timer"""
+    _LOGGER.info("============ test_interrupt_step_timer =========")
+    with MockTimerController("step_timer", 5) as step_timer:
+        step_timer.run_timer()
+        time.sleep(1)
+        step_timer.verify_last_event()
+
+        step_timer.pause_timer()
+        time.sleep(2 + step_timer.interval)
+        step_timer.verify_last_event()
+
+        step_timer.pause_timer()
+        time.sleep(2)
+        step_timer.verify_last_event()
+
+        step_timer.pause_timer()
+        time.sleep(2)
+        step_timer.verify_last_event()
+
+        step_timer.run_timer()
+        time.sleep(2)
+        step_timer.verify_last_event()
+
+        step_timer.run_timer()
+        time.sleep(2 + step_timer.interval)
+        step_timer.verify_last_event()
+
+        step_timer.run_timer()
+        time.sleep(2)
+        step_timer.verify_last_event()
+
+        step_timer.pause_timer()
+        time.sleep(2)
+        step_timer.verify_last_event()
+
+        step_timer.run_timer()
+        time.sleep(2)
+        step_timer.verify_last_event()
+
+        step_timer.run_timer()
+        time.sleep(3 * step_timer.interval)
+        step_timer.verify_last_event()