X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=tests%2Ftest_controller.py;h=971ce3ffd534e9ef904bf5e35eb5ce36298ee77f;hb=refs%2Fchanges%2F01%2F1901%2F1;hp=63831b0d81ce606e84e2744f8814da4bceddee51;hpb=8bcc51a6d44d40a1a338fb6a721b5ee8f992f323;p=ric-plt%2Fa1.git diff --git a/tests/test_controller.py b/tests/test_controller.py index 63831b0..971ce3f 100644 --- a/tests/test_controller.py +++ b/tests/test_controller.py @@ -1,3 +1,6 @@ +""" +tests for controller +""" # ================================================================================== # Copyright (c) 2019 Nokia # Copyright (c) 2018-2019 AT&T Intellectual Property. @@ -16,21 +19,24 @@ # ================================================================================== import time +import json from rmr.rmr_mocks import rmr_mocks from a1 import a1rmr - -ADM_CTRL = "admission_control_policy" -ADM_CTRL_POLICIES = "/a1-p/policytypes/20000/policies" -ADM_CTRL_INSTANCE = ADM_CTRL_POLICIES + "/" + ADM_CTRL +RCV_ID = "test_receiver" +ADM_CRTL_TID = 6660666 +ADM_CTRL_IID = "admission_control_policy" +ADM_CTRL_POLICIES = "/a1-p/policytypes/{0}/policies".format(ADM_CRTL_TID) +ADM_CTRL_INSTANCE = ADM_CTRL_POLICIES + "/" + ADM_CTRL_IID ADM_CTRL_INSTANCE_STATUS = ADM_CTRL_INSTANCE + "/status" -ADM_CTRL_TYPE = "/a1-p/policytypes/20000" -TEST_TYPE = "/a1-p/policytypes/20001" +ADM_CTRL_TYPE = "/a1-p/policytypes/{0}".format(ADM_CRTL_TID) def _fake_dequeue(): """for monkeypatching with a good status""" - pay = b'{"policy_type_id": 20000, "policy_instance_id": "admission_control_policy", "handler_id": "test_receiver", "status": "OK"}' + pay = json.dumps( + {"policy_type_id": ADM_CRTL_TID, "policy_instance_id": ADM_CTRL_IID, "handler_id": RCV_ID, "status": "OK"} + ).encode() fake_msg = {"payload": pay} return [fake_msg] @@ -44,20 +50,28 @@ def _fake_dequeue_deleted(): """for monkeypatching with a DELETED status""" new_msgs = [] - # insert some that don't exist to make sure nothing blows up - pay = b'{"policy_type_id": 20666, "policy_instance_id": "admission_control_policy", "handler_id": "test_receiver", "status": "DELETED"}' + # non existent type + pay = json.dumps( + {"policy_type_id": 911, "policy_instance_id": ADM_CTRL_IID, "handler_id": RCV_ID, "status": "DELETED"} + ).encode() fake_msg = {"payload": pay} new_msgs.append(fake_msg) - pay = b'{"policy_type_id": 20000, "policy_instance_id": "darkness", "handler_id": "test_receiver", "status": "DELETED"}' + pay = json.dumps( + {"policy_type_id": ADM_CRTL_TID, "policy_instance_id": "darkness", "handler_id": RCV_ID, "status": "DELETED"} + ).encode() fake_msg = {"payload": pay} new_msgs.append(fake_msg) # insert a bad one with a malformed body to make sure we keep going - fake_msg = {"payload": "asdf"} - new_msgs.append(fake_msg) + new_msgs.append({"payload": "asdf"}) - pay = b'{"policy_type_id": 20000, "policy_instance_id": "admission_control_policy", "handler_id": "test_receiver", "status": "DELETED"}' + # not even a json + new_msgs.append("asdf") + + pay = json.dumps( + {"policy_type_id": ADM_CRTL_TID, "policy_instance_id": ADM_CTRL_IID, "handler_id": RCV_ID, "status": "DELETED"} + ).encode() fake_msg = {"payload": pay} new_msgs.append(fake_msg) @@ -77,7 +91,7 @@ def _test_put_patch(monkeypatch): monkeypatch.setattr("rmr.rmr.rmr_free_msg", noop) # we need to repatch alloc (already patched in patch_rmr) to fix the transactionid, alloc is called in send and recieve - def fake_alloc(_unused, _alsounused): + def fake_alloc(_unused1, _unused2, _unused3, _unused4, _unused5): sbuf = rmr_mocks.Rmr_mbuf_t() sbuf.contents.xaction = b"d49b53e478b711e9a1130242ac110002" return sbuf @@ -91,28 +105,7 @@ def _test_put_patch(monkeypatch): monkeypatch.setattr("rmr.rmr.generate_and_set_transaction_id", fake_set_transactionid) -# Module level Hack - - -RMR_THREAD = None - - -def setup_module(): - """module level setup""" - global RMR_THREAD - - def noop(): - pass - - # launch the thread with a fake init func and a patched rcv func; we will "repatch" later - RMR_THREAD = a1rmr.start_rmr_thread(init_func_override=noop, rcv_func_override=_fake_dequeue_none) - - -# Actual Tests - - -def test_workflow_nothing_there_yet(client): - """ test policy put good""" +def _no_ac(client): # no type there yet res = client.get(ADM_CTRL_TYPE) assert res.status_code == 404 @@ -127,31 +120,49 @@ def test_workflow_nothing_there_yet(client): assert res.status_code == 404 -def test_workflow(client, monkeypatch, adm_type_good, adm_instance_good): - """ - test a full A1 workflow - """ +def _put_ac_type(client, typedef): + _no_ac(client) + # put the type - res = client.put(ADM_CTRL_TYPE, json=adm_type_good) + res = client.put(ADM_CTRL_TYPE, json=typedef) assert res.status_code == 201 # cant replace types - res = client.put(ADM_CTRL_TYPE, json=adm_type_good) + res = client.put(ADM_CTRL_TYPE, json=typedef) assert res.status_code == 400 # type there now res = client.get(ADM_CTRL_TYPE) assert res.status_code == 200 - assert res.json == adm_type_good + assert res.json == typedef + + # type in type list res = client.get("/a1-p/policytypes") assert res.status_code == 200 - assert res.json == [20000] + assert res.json == [ADM_CRTL_TID] # instance 200 but empty list res = client.get(ADM_CTRL_POLICIES) assert res.status_code == 200 assert res.json == [] + +def _delete_ac_type(client): + res = client.delete(ADM_CTRL_TYPE) + assert res.status_code == 204 + + # cant get + res = client.get(ADM_CTRL_TYPE) + assert res.status_code == 404 + + # cant invoke delete on it again + res = client.delete(ADM_CTRL_TYPE) + assert res.status_code == 404 + + _no_ac(client) + + +def _put_ac_instance(client, monkeypatch, instancedef): # no instance there yet res = client.get(ADM_CTRL_INSTANCE) assert res.status_code == 404 @@ -160,38 +171,20 @@ def test_workflow(client, monkeypatch, adm_type_good, adm_instance_good): # create a good instance _test_put_patch(monkeypatch) - res = client.put(ADM_CTRL_INSTANCE, json=adm_instance_good) + res = client.put(ADM_CTRL_INSTANCE, json=instancedef) assert res.status_code == 202 # replace is allowed on instances - res = client.put(ADM_CTRL_INSTANCE, json=adm_instance_good) + res = client.put(ADM_CTRL_INSTANCE, json=instancedef) assert res.status_code == 202 # instance 200 and in list res = client.get(ADM_CTRL_POLICIES) assert res.status_code == 200 - assert res.json == [ADM_CTRL] - - def get_instance_good(expected): - # get the instance - res = client.get(ADM_CTRL_INSTANCE) - assert res.status_code == 200 - assert res.json == adm_instance_good - - # get the instance status - res = client.get(ADM_CTRL_INSTANCE_STATUS) - assert res.status_code == 200 - assert res.get_data(as_text=True) == expected - - # try a status get but we didn't get any ACKs yet to test NOT IN EFFECT - time.sleep(1) # wait for the rmr thread - get_instance_good("NOT IN EFFECT") + assert res.json == [ADM_CTRL_IID] - # now pretend we did get a good ACK - RMR_THREAD._rcv_func = _fake_dequeue - time.sleep(1) # wait for the rmr thread - get_instance_good("IN EFFECT") +def _delete_instance(client): # cant delete type until there are no instances res = client.delete(ADM_CTRL_TYPE) assert res.status_code == 400 @@ -199,34 +192,140 @@ def test_workflow(client, monkeypatch, adm_type_good, adm_instance_good): # delete it res = client.delete(ADM_CTRL_INSTANCE) assert res.status_code == 202 - res = client.delete(ADM_CTRL_INSTANCE) # should be able to do multiple deletes + + # should be able to do multiple deletes until it's actually gone + res = client.delete(ADM_CTRL_INSTANCE) assert res.status_code == 202 - # status after a delete, but there are no messages yet, should still return - time.sleep(1) # wait for the rmr thread - get_instance_good("IN EFFECT") - # now pretend we deleted successfully - RMR_THREAD._rcv_func = _fake_dequeue_deleted - time.sleep(1) # wait for the rmr thread +def _instance_is_gone(client, seconds_to_try=10): + for _ in range(seconds_to_try): + # idea here is that we have to wait for the seperate thread to process the event + try: + res = client.get(ADM_CTRL_INSTANCE_STATUS) + assert res.status_code == 404 + except AssertionError: + time.sleep(1) + + res = client.get(ADM_CTRL_INSTANCE_STATUS) + assert res.status_code == 404 + # list still 200 but no instance res = client.get(ADM_CTRL_POLICIES) assert res.status_code == 200 assert res.json == [] - res = client.get(ADM_CTRL_INSTANCE_STATUS) # cant get status - assert res.status_code == 404 - res = client.get(ADM_CTRL_INSTANCE) # cant get instance + + # cant get instance + res = client.get(ADM_CTRL_INSTANCE) assert res.status_code == 404 + +def _verify_instance_and_status(client, expected_instance, expected_status, expected_deleted, seconds_to_try=5): + # get the instance + res = client.get(ADM_CTRL_INSTANCE) + assert res.status_code == 200 + assert res.json == expected_instance + + for _ in range(seconds_to_try): + # idea here is that we have to wait for the seperate thread to process the event + res = client.get(ADM_CTRL_INSTANCE_STATUS) + assert res.status_code == 200 + assert res.json["has_been_deleted"] == expected_deleted + try: + assert res.json["instance_status"] == expected_status + return + except AssertionError: + time.sleep(1) + assert res.json["instance_status"] == expected_status + + +# Module level Hack + + +def setup_module(): + """module level setup""" + + def noop(): + pass + + # launch the thread with a fake init func and a patched rcv func; we will "repatch" later + a1rmr.start_rmr_thread(init_func_override=noop, rcv_func_override=_fake_dequeue_none) + + +# Actual Tests + + +def test_workflow(client, monkeypatch, adm_type_good, adm_instance_good): + """ + test a full A1 workflow + """ + _put_ac_type(client, adm_type_good) + _put_ac_instance(client, monkeypatch, adm_instance_good) + + """ + we test the state transition diagram of all 5 states here; + 1. not in effect, not deleted + 2. in effect, not deleted + 3. in effect, deleted + 4. not in effect, deleted + 5. gone (timeout expires) + """ + + # try a status get but we didn't get any ACKs yet to test NOT IN EFFECT + _verify_instance_and_status(client, adm_instance_good, "NOT IN EFFECT", False) + + # now pretend we did get a good ACK + a1rmr.replace_rcv_func(_fake_dequeue) + _verify_instance_and_status(client, adm_instance_good, "IN EFFECT", False) + + # delete the instance + _delete_instance(client) + + # status after a delete, but there are no messages yet, should still return + _verify_instance_and_status(client, adm_instance_good, "IN EFFECT", True) + + # now pretend we deleted successfully + a1rmr.replace_rcv_func(_fake_dequeue_deleted) + + # status should be reflected first (before delete triggers) + _verify_instance_and_status(client, adm_instance_good, "NOT IN EFFECT", True) + + # instance should be totally gone after a few seconds + _instance_is_gone(client) + # delete the type - res = client.delete(ADM_CTRL_TYPE) - assert res.status_code == 204 + _delete_ac_type(client) - # cant touch this - res = client.get(ADM_CTRL_TYPE) - assert res.status_code == 404 - res = client.delete(ADM_CTRL_TYPE) - assert res.status_code == 404 + +def test_cleanup_via_t1(client, monkeypatch, adm_type_good, adm_instance_good): + """ + create a type, create an instance, but no acks ever come in, delete instance + """ + _put_ac_type(client, adm_type_good) + + a1rmr.replace_rcv_func(_fake_dequeue_none) + + _put_ac_instance(client, monkeypatch, adm_instance_good) + + """ + here we test the state transition diagram when it never goes into effect: + 1. not in effect, not deleted + 2. not in effect, deleted + 3. gone (timeout expires) + """ + + _verify_instance_and_status(client, adm_instance_good, "NOT IN EFFECT", False) + + # delete the instance + _delete_instance(client) + + _verify_instance_and_status(client, adm_instance_good, "NOT IN EFFECT", True) + + # instance should be totally gone after a few seconds + _instance_is_gone(client) + + # delete the type + _delete_ac_type(client) def test_bad_instances(client, monkeypatch, adm_type_good): @@ -251,8 +350,7 @@ def test_bad_instances(client, monkeypatch, adm_type_good): assert res.status_code == 404 # get a non existent instance - RMR_THREAD._rcv_func = _fake_dequeue - time.sleep(1) + a1rmr.replace_rcv_func(_fake_dequeue) res = client.get(ADM_CTRL_INSTANCE + "DARKNESS") assert res.status_code == 404 @@ -261,13 +359,13 @@ def test_bad_instances(client, monkeypatch, adm_type_good): assert res.status_code == 204 -def test_illegal_types(client, monkeypatch, adm_type_good): +def test_illegal_types(client, adm_type_good): """ Test illegal types """ - res = client.put("/a1-p/policytypes/19999", json=adm_type_good) + res = client.put("/a1-p/policytypes/0", json=adm_type_good) assert res.status_code == 400 - res = client.put("/a1-p/policytypes/21024", json=adm_type_good) + res = client.put("/a1-p/policytypes/2147483648", json=adm_type_good) assert res.status_code == 400 @@ -281,4 +379,4 @@ def test_healthcheck(client): def teardown_module(): """module teardown""" - RMR_THREAD.stop() + a1rmr.stop_rmr_thread()