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, 133 insertions, 0 deletions

diff --git a/tests/pdp_api_v0/conftest.py b/tests/pdp_api_v0/conftest.py
new file mode 100644
index 0000000..07e566f
--- /dev/null
+++ b/tests/pdp_api_v0/conftest.py
@@ -0,0 +1,133 @@
+# ============LICENSE_START=======================================================
+# 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.
+# 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=========================================================
+#
+"""
+startdard pytest file that contains the shared fixtures
+https://docs.pytest.org/en/latest/fixture.html
+"""
+
+import pytest
+
+from policyhandler import pdp_client
+from policyhandler.pdp_api_v0.pdp_consts import POLICY_NAME
+from policyhandler.utils import Utils
+
+from ..mock_settings import MockSettings
+from ..mock_tracker import MockHttpResponse
+from .mock_policy_engine import MockPolicyEngine2018
+from .mock_websocket import MockWebSocket
+
+_LOGGER = Utils.get_logger(__file__)
+
+@pytest.fixture(scope="session", autouse=True)
+def _auto_setup_policy_engine_pdp_api_v0():
+    """initialize the mock-policy-engine_pdp_api_v0 per the whole test session"""
+    _LOGGER.info("create _auto_setup_policy_engine_pdp_api_v0")
+    MockPolicyEngine2018.init()
+    yield _auto_setup_policy_engine_pdp_api_v0
+    _LOGGER.info("teardown _auto_setup_policy_engine_pdp_api_v0")
+
+
+@pytest.fixture(scope="module")
+def fix_pdp_api_v0():
+    """test on the old (pdp_api_v0) pdp API"""
+    _LOGGER.info("setup fix_pdp_api_v0 %s", MockSettings.OLD_PDP_API_VERSION)
+    MockSettings.setup_pdp_api(MockSettings.OLD_PDP_API_VERSION)
+
+    yield fix_pdp_api_v0
+    MockSettings.setup_pdp_api()
+    _LOGGER.info("teardown fix_pdp_api_v0 %s", MockSettings.OLD_PDP_API_VERSION)
+
+@pytest.fixture()
+def fix_pdp_post(monkeypatch):
+    """monkeyed request /getConfig to PDP"""
+    def monkeyed_policy_rest_post(uri, json=None, **kwargs):
+        """monkeypatch for the POST to policy-engine"""
+        res_json = MockPolicyEngine2018.get_config(json.get(POLICY_NAME))
+        return MockHttpResponse("post", uri, res_json, json=json, **kwargs)
+
+    _LOGGER.info("setup fix_pdp_post")
+    pdp_client.PolicyRest._lazy_init()
+    monkeypatch.setattr('policyhandler.pdp_client.PolicyRest._requests_session.post',
+                        monkeyed_policy_rest_post)
+    yield fix_pdp_post
+    _LOGGER.info("teardown fix_pdp_post")
+
+@pytest.fixture()
+def fix_pdp_post_big(monkeypatch):
+    """monkeyed request /getConfig to PDP"""
+    def monkeyed_policy_rest_post(uri, **kwargs):
+        """monkeypatch for the POST to policy-engine"""
+        res_json = MockPolicyEngine2018.get_configs_all()
+        return MockHttpResponse("post", uri, res_json, **kwargs)
+
+    _LOGGER.info("setup fix_pdp_post_big")
+    pdp_client.PolicyRest._lazy_init()
+    monkeypatch.setattr('policyhandler.pdp_client.PolicyRest._requests_session.post',
+                        monkeyed_policy_rest_post)
+    yield fix_pdp_post_big
+    _LOGGER.info("teardown fix_pdp_post_big")
+
+
+class MockException(Exception):
+    """mock exception"""
+    pass
+
+@pytest.fixture()
+def fix_pdp_post_boom(monkeypatch):
+    """monkeyed request /getConfig to PDP - exception"""
+    def monkeyed_policy_rest_post_boom(uri, **_):
+        """monkeypatch for the POST to policy-engine"""
+        raise MockException("fix_pdp_post_boom {}".format(uri))
+
+    _LOGGER.info("setup fix_pdp_post_boom")
+    pdp_client.PolicyRest._lazy_init()
+    monkeypatch.setattr('policyhandler.pdp_client.PolicyRest._requests_session.post',
+                        monkeyed_policy_rest_post_boom)
+    yield fix_pdp_post_boom
+    _LOGGER.info("teardown fix_pdp_post_boom")
+
+
+@pytest.fixture()
+def fix_policy_receiver_websocket(monkeypatch):
+    """monkeyed websocket for policy_receiver"""
+    _LOGGER.info("setup fix_policy_receiver_websocket")
+    monkeypatch.setattr('policyhandler.pdp_api_v0.policy_listener.websocket', MockWebSocket)
+
+    yield fix_policy_receiver_websocket
+    _LOGGER.info("teardown fix_policy_receiver_websocket")
+
+class MockBoom(Exception):
+    """mock exception"""
+    pass
+
+@pytest.fixture()
+def fix_select_latest_policies_boom(monkeypatch):
+    """monkeyed exception"""
+    def monkeyed_boom(*_, **__):
+        """monkeypatch for the select_latest_policies"""
+        raise MockBoom("fix_select_latest_policies_boom")
+
+    policy_utils_path = 'policyhandler.pdp_api_v0.policy_utils.PolicyUtils'
+
+    _LOGGER.info("setup fix_select_latest_policies_boom at %s", policy_utils_path)
+
+    monkeypatch.setattr('{}.select_latest_policies'.format(policy_utils_path), monkeyed_boom)
+    monkeypatch.setattr('{}.select_latest_policy'.format(policy_utils_path), monkeyed_boom)
+    monkeypatch.setattr('{}.extract_policy_id'.format(policy_utils_path), monkeyed_boom)
+
+    yield fix_select_latest_policies_boom
+    _LOGGER.info("teardown fix_select_latest_policies_boom at %s", policy_utils_path)