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, 57 insertions, 15 deletions

diff --git a/tests/mock_tracker.py b/tests/mock_tracker.py
index 4e69afd..a5fffd5 100644
--- a/tests/mock_tracker.py
+++ b/tests/mock_tracker.py
@@ -1,5 +1,5 @@
 # ============LICENSE_START=======================================================
-# Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
+# Copyright (c) 2018-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.
@@ -14,19 +14,18 @@
 # limitations under the License.
 # ============LICENSE_END=========================================================
 #
-# ECOMP is a trademark and service mark of AT&T Intellectual Property.
 """record all the messages going outside policy-handler during testing"""
 
 import copy
 import json
 
+from policyhandler.config import Config
 from policyhandler.onap.audit import REQUEST_X_ECOMP_REQUESTID
-from policyhandler.policy_utils import Utils
-
-from .mock_expected import HISTORY_EXPECTED
-from .mock_settings import Settings
+from policyhandler.utils import Utils
 
 RESPONSE = "res"
+PEP_INSTANCE = "ONAPInstance"
+_LOGGER = Utils.get_logger(__file__)
 
 class _MockHttpRequestInResponse(object):
     """Mock http request in reponse object"""
@@ -89,20 +88,24 @@ class Tracker(object):
     """record all the messages going outside policy-handler during testing"""
     test_name = None
     messages = []
+    test_names = []
+    validated_tests = {}
+    valid_tests = {}
 
     @staticmethod
-    def reset(test_name):
+    def reset(test_name=None):
         """remove all the messages from history"""
         Tracker.test_name = test_name
         Tracker.messages.clear()
+        Tracker.test_names.append(test_name)
 
     @staticmethod
     def track(message):
         """append the tracked message to the history"""
         message = copy.deepcopy(message)
         Tracker.messages.append(message)
-        if Settings.logger:
-            Settings.logger.info("tracked_message: %s", json.dumps(message, sort_keys=True))
+        if _LOGGER:
+            _LOGGER.info("tracked_message: %s", json.dumps(message, sort_keys=True))
 
     @staticmethod
     def to_string():
@@ -110,13 +113,44 @@ class Tracker(object):
         return json.dumps(Tracker.messages, sort_keys=True)
 
     @staticmethod
+    def get_status(test_name=None):
+        """get the status of validation"""
+        if Tracker.valid_tests.get(test_name):
+            return "success"
+        if Tracker.validated_tests.get(test_name):
+            return "failed"
+        if test_name in Tracker.test_names:
+            return "covered"
+        return "unknown"
+
+    @staticmethod
+    def log_all_tests():
+        """log the covered and not covered test names"""
+        _LOGGER.info("-"*75)
+        _LOGGER.info("tracked test_names[%s]", len(Tracker.test_names))
+        for idx, test_name in enumerate(Tracker.test_names):
+            _LOGGER.info("%s[%s]: %s", Tracker.get_status(test_name), (idx + 1), test_name)
+
+        _LOGGER.info("not tracked test_names listed in main.mock_expected")
+        from .main.mock_expected import HISTORY_EXPECTED as main_history
+        for test_name in main_history:
+            if test_name not in Tracker.test_names:
+                _LOGGER.info("untracked: %s", test_name)
+
+        _LOGGER.info("not tracked test_names listed in pdp_api_v0.mock_expected")
+        from .pdp_api_v0.mock_expected import HISTORY_EXPECTED as pdp_api_v0_history
+        for test_name in pdp_api_v0_history:
+            if test_name not in Tracker.test_names:
+                _LOGGER.info("untracked: %s", test_name)
+
+    @staticmethod
     def _hide_volatiles(obj):
         """hides the volatile field values"""
         if not isinstance(obj, dict):
             return obj
 
         for key, value in obj.items():
-            if key in [REQUEST_X_ECOMP_REQUESTID, RESPONSE]:
+            if key in [REQUEST_X_ECOMP_REQUESTID, RESPONSE, PEP_INSTANCE]:
                 obj[key] = "*"
             elif isinstance(value, dict):
                 obj[key] = Tracker._hide_volatiles(value)
@@ -126,13 +160,21 @@ class Tracker(object):
     @staticmethod
     def validate():
         """validate that the message history is as expected"""
-        Settings.logger.info("Tracker.validate(%s)", Tracker.test_name)
+        _LOGGER.info("Tracker.validate(%s)", Tracker.test_name)
         messages = [Tracker._hide_volatiles(copy.deepcopy(message))
                     for message in Tracker.messages]
-        expected = HISTORY_EXPECTED.get(Tracker.test_name, [])
+        Tracker.validated_tests[Tracker.test_name] = True
+
+        if Config.is_pdp_api_default():
+            from .main.mock_expected import HISTORY_EXPECTED as main_history
+            expected = main_history.get(Tracker.test_name, [])
+        else:
+            from .pdp_api_v0.mock_expected import HISTORY_EXPECTED as pdp_api_v0_history
+            expected = pdp_api_v0_history.get(Tracker.test_name, [])
 
-        Settings.logger.info("messages: %s", json.dumps(messages, sort_keys=True))
-        Settings.logger.info("expected: %s", json.dumps(expected, sort_keys=True))
+        _LOGGER.info("messages: %s", json.dumps(messages, sort_keys=True))
+        _LOGGER.info("expected: %s", json.dumps(expected, sort_keys=True))
         assert Utils.are_the_same(messages, expected)
 
-        Settings.logger.info("history valid for Tracker.validate(%s)", Tracker.test_name)
+        _LOGGER.info("history valid for Tracker.validate(%s)", Tracker.test_name)
+        Tracker.valid_tests[Tracker.test_name] = True