# ============LICENSE_START=================================================== # Copyright (C) 2019-2020 Nordix Foundation. # ============================================================================ # 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. # # SPDX-License-Identifier: Apache-2.0 # ============LICENSE_END===================================================== import json import os from test.support import EnvironmentVarGuard from unittest import TestCase from unittest.mock import patch import responses from requests import Session from tenacity import stop_after_attempt from mod import db, get_db_connection_url, create_app from mod.db_models import SubscriptionModel from mod.pmsh_utils import AppConfig, policy_response_handle_functions from mod.subscription import Subscription from mod.network_function import NetworkFunction class PmshUtilsTestCase(TestCase): @patch('mod.create_app') @patch('mod.get_db_connection_url') def setUp(self, mock_get_db_url, mock_app): mock_get_db_url.return_value = 'sqlite://' with open(os.path.join(os.path.dirname(__file__), 'data/cbs_data_1.json'), 'r') as data: self.cbs_data = json.load(data) self.app_conf = AppConfig(**self.cbs_data['config']) self.sub = Subscription(**self.cbs_data['policy']['subscription']) self.env = EnvironmentVarGuard() self.env.set('LOGS_PATH', './unit_test_logs') self.policy_mr_sub = self.app_conf.get_mr_sub('policy_pm_subscriber') self.mock_app = mock_app self.app = create_app() self.app_context = self.app.app_context() self.app_context.push() db.create_all() def test_utils_get_mr_sub(self): mr_policy_sub = self.app_conf.get_mr_sub('policy_pm_subscriber') self.assertTrue(mr_policy_sub.aaf_id, 'dcae@dcae.onap.org') def test_utils_get_mr_sub_fails_with_invalid_name(self): with self.assertRaises(KeyError): self.app_conf.get_mr_sub('invalid_sub') def test_utils_get_mr_pub(self): mr_policy_pub = self.app_conf.get_mr_pub('policy_pm_publisher') self.assertTrue(mr_policy_pub.aaf_pass, 'demo123456!') def test_utils_get_mr_pub_fails_with_invalid_name(self): with self.assertRaises(KeyError): self.app_conf.get_mr_pub('invalid_pub') def test_utils_get_cert_data(self): self.assertTrue(self.app_conf.cert_params, ('/opt/app/pm-mapper/etc/certs/cert.pem', '/opt/app/pm-mapper/etc/certs/key.pem')) @patch.object(Session, 'post') def test_mr_pub_publish_to_topic_success(self, mock_session): mock_session.return_value.status_code = 200 mr_policy_pub = self.app_conf.get_mr_pub('policy_pm_publisher') with patch('requests.Session.post') as session_post_call: mr_policy_pub.publish_to_topic({"dummy_val": "43c4ee19-6b8d-4279-a80f-c507850aae47"}) session_post_call.assert_called_once() @responses.activate def test_mr_pub_publish_to_topic_fail(self): responses.add(responses.POST, 'https://node:30226/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS', json={'error': 'Client Error'}, status=400) mr_policy_pub = self.app_conf.get_mr_pub('policy_pm_publisher') with self.assertRaises(Exception): mr_policy_pub.publish_to_topic({"dummy_val": "43c4ee19-6b8d-4279-a80f-c507850aae47"}) def test_mr_pub_publish_sub_event_data_success(self): mr_policy_pub = self.app_conf.get_mr_pub('policy_pm_publisher') with patch('mod.pmsh_utils._MrPub.publish_to_topic') as pub_to_topic_call: mr_policy_pub.publish_subscription_event_data(self.sub, 'pnf201', self.app_conf) pub_to_topic_call.assert_called_once() @responses.activate def test_mr_sub_get_from_topic_success(self): responses.add(responses.GET, 'https://node:30226/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS/' 'dcae_pmsh_cg/1?timeout=1000', json={"dummy_val": "43c4ee19-6b8d-4279-a80f-c507850aae47"}, status=200) mr_topic_data = self.policy_mr_sub.get_from_topic(1) self.assertIsNotNone(mr_topic_data) @responses.activate def test_mr_sub_get_from_topic_fail(self): responses.add(responses.GET, 'https://node:30226/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS/' 'dcae_pmsh_cg/1?timeout=1000', json={"dummy_val": "43c4ee19-6b8d-4279-a80f-c507850aae47"}, status=400) mr_topic_data = self.policy_mr_sub.get_from_topic(1) self.assertIsNone(mr_topic_data) def test_get_db_connection_url_success(self): self.env = EnvironmentVarGuard() self.env.set('PMSH_PG_URL', '1.2.3.4') self.env.set('PMSH_PG_USERNAME', 'pmsh') self.env.set('PMSH_PG_PASSWORD', 'pass') db_url = get_db_connection_url() self.assertEqual(db_url, 'postgres+psycopg2://pmsh:pass@1.2.3.4:5432/pmsh') def test_get_db_connection_url_fail(self): self.env = EnvironmentVarGuard() self.env.set('PMSH_PG_USERNAME', 'pmsh') self.env.set('PMSH_PG_PASSWORD', 'pass') with self.assertRaises(Exception): get_db_connection_url() @patch('mod.pmsh_utils.NetworkFunction.delete') def test_handle_response_locked_success(self, mock_delete): with patch.dict(policy_response_handle_functions, {'LOCKED': {'success': mock_delete}}): administrative_state = 'LOCKED' nf = NetworkFunction(nf_name='nf1') self.policy_mr_sub._handle_response(self.sub.subscriptionName, administrative_state, nf.nf_name, 'success') mock_delete.assert_called() @patch('mod.subscription.Subscription.update_sub_nf_status') def test_handle_response_locked_failed(self, mock_update_sub_nf): with patch.dict(policy_response_handle_functions, {'LOCKED': {'failed': mock_update_sub_nf}}): administrative_state = 'LOCKED' nf = NetworkFunction(nf_name='nf1') self.policy_mr_sub._handle_response(self.sub.subscriptionName, administrative_state, nf.nf_name, 'failed') mock_update_sub_nf.assert_called() @patch('mod.subscription.Subscription.update_sub_nf_status') def test_handle_response_unlocked_success(self, mock_update_sub_nf): with patch.dict(policy_response_handle_functions, {'UNLOCKED': {'success': mock_update_sub_nf}}): nf = NetworkFunction(nf_name='nf1') self.policy_mr_sub._handle_response(self.sub.subscriptionName, self.sub.administrativeState, nf.nf_name, 'success') mock_update_sub_nf.assert_called() @patch('mod.subscription.Subscription.update_sub_nf_status') def test_handle_response_unlocked_failed(self, mock_update_sub_nf): with patch.dict(policy_response_handle_functions, {'UNLOCKED': {'failed': mock_update_sub_nf}}): nf = NetworkFunction(nf_name='nf1') self.policy_mr_sub._handle_response(self.sub.subscriptionName, self.sub.administrativeState, nf.nf_name, 'failed') mock_update_sub_nf.assert_called() def test_handle_response_exception(self): self.assertRaises(Exception, self.policy_mr_sub._handle_response, 'sub1', 'wrong_state', 'nf1', 'wrong_message') @patch('mod.pmsh_utils._MrSub.get_from_topic') @patch('mod.pmsh_utils._MrSub._handle_response') @patch('mod.subscription.Subscription.get') @patch('threading.Timer') def test_poll_policy_topic_calls_methods_correct_sub(self, mock_thread, mock_get_sub, mock_handle_response, mock_get_from_topic): result_data = ['{"name": "ResponseEvent","status": { "subscriptionName": ' '"ExtraPM-All-gNB-R2B", "nfName": "pnf300", "message": "success" } }'] mock_get_from_topic.return_value = result_data mock_thread.start.return_value = 1 mock_get_sub.return_value = SubscriptionModel(subscription_name='ExtraPM-All-gNB-R2B', status='UNLOCKED') self.policy_mr_sub.poll_policy_topic(self.sub.subscriptionName, self.mock_app) mock_get_from_topic.assert_called() mock_handle_response.assert_called_with(self.sub.subscriptionName, 'UNLOCKED', 'pnf300', 'success') @patch('mod.pmsh_utils._MrSub.get_from_topic') @patch('mod.pmsh_utils._MrSub._handle_response') @patch('mod.subscription.Subscription.get') @patch('threading.Timer') def test_poll_policy_topic_no_method_calls_incorrect_sub(self, mock_thread, mock_get_sub, mock_handle_response, mock_get_from_topic): result_data = ['{"name": "ResponseEvent","status": { "subscriptionName": ' '"demo-subscription", "nfName": "pnf300", "message": "success" } }'] mock_get_from_topic.return_value = result_data mock_thread.start.return_value = 1 mock_get_sub.return_value = SubscriptionModel(subscription_name='ExtraPM-All-gNB-R2B', status='UNLOCKED') self.policy_mr_sub.poll_policy_topic(self.sub, self.mock_app) mock_get_from_topic.assert_called() mock_handle_response.assert_not_called() @patch('mod.subscription.Subscription.get') @patch('mod.pmsh_utils._MrSub.get_from_topic') def test_poll_policy_topic_exception(self, mock_get_from_topic, mock_get_sub): mock_get_from_topic.return_value = 'wrong_return' mock_get_sub.return_value = SubscriptionModel(subscription_name='ExtraPM-All-gNB-R2B', status='UNLOCKED') self.policy_mr_sub.poll_policy_topic.retry.stop = stop_after_attempt(1) self.assertRaises(Exception, self.policy_mr_sub.poll_policy_topic, 'sub1', self.mock_app)