X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=tests%2Ftest_controller.py;h=e5c3ac7e848fa76358e731c7aa5de4b6ffe4af86;hb=6b69910923309e05820706dc025e1441463906c9;hp=32f6d8737469bb676c5d438ed32c01ed6352b2a7;hpb=40caa314d23122f0bd25c0e66b65d10303538164;p=ric-plt%2Fa1.git diff --git a/tests/test_controller.py b/tests/test_controller.py index 32f6d87..e5c3ac7 100644 --- a/tests/test_controller.py +++ b/tests/test_controller.py @@ -14,37 +14,22 @@ # See the License for the specific language governing permissions and # limitations under the License. # ================================================================================== -import tempfile -import os +import time from rmr.rmr_mocks import rmr_mocks -from a1 import app -import testing_helpers -import pytest +from a1 import run ADM_CTRL = "admission_control_policy" -ADM_CTRL_INSTANCE = "/a1-p/policytypes/20000/policies/" + ADM_CTRL +ADM_CTRL_POLICIES = "/a1-p/policytypes/20000/policies" +ADM_CTRL_INSTANCE = ADM_CTRL_POLICIES + "/" + ADM_CTRL ADM_CTRL_INSTANCE_STATUS = ADM_CTRL_INSTANCE + "/status" +ADM_CTRL_TYPE = "/a1-p/policytypes/20000" +TEST_TYPE = "/a1-p/policytypes/20001" -# http://flask.pocoo.org/docs/1.0/testing/ -@pytest.fixture -def client(): - db_fd, app.app.config["DATABASE"] = tempfile.mkstemp() - app.app.config["TESTING"] = True - cl = app.app.test_client() - - yield cl - - os.close(db_fd) - os.unlink(app.app.config["DATABASE"]) - - -def _fake_dequeue(_filter_type): - """ - for monkeypatching a1rmnr.dequeue_all_messages - """ +def _fake_dequeue(_mrc, _filter_type): + """for monkeypatching with a good status""" fake_msg = {} pay = b'{"policy_type_id": 20000, "policy_instance_id": "admission_control_policy", "handler_id": "test_receiver", "status": "OK"}' fake_msg["payload"] = pay @@ -52,9 +37,42 @@ def _fake_dequeue(_filter_type): return new_messages +def _fake_dequeue_none(_mrc, _filter_type): + """for monkeypatching with no waiting messages""" + return [] + + +def _fake_dequeue_deleted(_mrc, _filter_type): + """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"}' + 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"}' + fake_msg = {"payload": pay} + new_msgs.append(fake_msg) + + pay = b'{"policy_type_id": 20000, "policy_instance_id": "admission_control_policy", "handler_id": "test_receiver", "status": "DELETED"}' + fake_msg = {"payload": pay} + new_msgs.append(fake_msg) + + return new_msgs + + def _test_put_patch(monkeypatch): - testing_helpers.patch_all(monkeypatch) - monkeypatch.setattr("rmr.rmr.rmr_send_msg", rmr_mocks.send_mock_generator(0)) # good sends for this whole batch + rmr_mocks.patch_rmr(monkeypatch) + # assert that rmr bad states don't cause problems + monkeypatch.setattr("rmr.rmr.rmr_send_msg", rmr_mocks.send_mock_generator(10)) + + # we need this because free expects a real sbuf + # TODO: move this into rmr_mocks + def noop(_sbuf): + pass + + 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): @@ -71,37 +89,65 @@ 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 + RMR_THREAD = run.start_rmr_thread(real_init=False) + + # Actual Tests -# def test_policy_get(client, monkeypatch): -# """ -# test policy GET -# """ -# _test_put_patch(monkeypatch) -# monkeypatch.setattr( -# "a1.a1rmr.dequeue_all_waiting_messages", -# _fake_dequeue(monkeypatch, msg_payload={"GET ack": "pretend policy is here"}, msg_type=20003), -# ) -# res = client.get("/a1-p/policies/admission_control_policy") -# assert res.status_code == 200 -# assert res.json == {"GET ack": "pretend policy is here"} -# -# -# def test_policy_get_unsupported(client, monkeypatch): -# """ -# test policy GET -# """ -# testing_helpers.patch_all(monkeypatch, nofetch=True) -# res = client.get("/a1-p/policies/admission_control_policy") -# assert res.status_code == 400 -# assert res.data == b'"POLICY DOES NOT SUPPORT FETCHING"\n' -# -# -def test_xapp_put_good(client, monkeypatch): +def test_workflow_nothing_there_yet(client, monkeypatch, adm_type_good, adm_instance_good): """ test policy put good""" + monkeypatch.setattr("rmr.helpers.rmr_rcvall_msgs", _fake_dequeue_none) + # no type there yet + res = client.get(ADM_CTRL_TYPE) + assert res.status_code == 404 + + # no types at all + res = client.get("/a1-p/policytypes") + assert res.status_code == 200 + assert res.json == [] + + # instance 404 because type not there yet + res = client.get(ADM_CTRL_POLICIES) + assert res.status_code == 404 + + +def test_workflow(client, monkeypatch, adm_type_good, adm_instance_good): + """ + test a full A1 workflow + """ + monkeypatch.setattr("rmr.helpers.rmr_rcvall_msgs", _fake_dequeue_none) + # put the type + res = client.put(ADM_CTRL_TYPE, json=adm_type_good) + assert res.status_code == 201 + + # cant replace types + res = client.put(ADM_CTRL_TYPE, json=adm_type_good) + 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 + res = client.get("/a1-p/policytypes") + assert res.status_code == 200 + assert res.json == [20000] + + # instance 200 but empty list + res = client.get(ADM_CTRL_POLICIES) + assert res.status_code == 200 + assert res.json == [] - # nothing there yet + # no instance there yet res = client.get(ADM_CTRL_INSTANCE) assert res.status_code == 404 res = client.get(ADM_CTRL_INSTANCE_STATUS) @@ -109,78 +155,87 @@ def test_xapp_put_good(client, monkeypatch): # create a good instance _test_put_patch(monkeypatch) - res = client.put(ADM_CTRL_INSTANCE, json=testing_helpers.good_payload()) - assert res.status_code == 201 + res = client.put(ADM_CTRL_INSTANCE, json=adm_instance_good) + assert res.status_code == 202 - # get the instance - res = client.get(ADM_CTRL_INSTANCE) + # replace is allowed on instances + res = client.put(ADM_CTRL_INSTANCE, json=adm_instance_good) + assert res.status_code == 202 + + # instance 200 and in list + res = client.get(ADM_CTRL_POLICIES) assert res.status_code == 200 - assert res.json == testing_helpers.good_payload() + 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") + + # now pretend we did get a good ACK + monkeypatch.setattr("rmr.helpers.rmr_rcvall_msgs", _fake_dequeue) + time.sleep(1) # wait for the rmr thread + get_instance_good("IN EFFECT") + + # cant delete type until there are no instances + res = client.delete(ADM_CTRL_TYPE) + assert res.status_code == 400 - # get the instance status - monkeypatch.setattr("a1.a1rmr.dequeue_all_waiting_messages", _fake_dequeue) - res = client.get(ADM_CTRL_INSTANCE_STATUS) + # 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 + assert res.status_code == 202 + + # status after a delete, but there are no messages yet, should still return + monkeypatch.setattr("rmr.helpers.rmr_rcvall_msgs", _fake_dequeue) + time.sleep(1) # wait for the rmr thread + get_instance_good("IN EFFECT") + + # now pretend we deleted successfully + monkeypatch.setattr("rmr.helpers.rmr_rcvall_msgs", _fake_dequeue_deleted) + time.sleep(1) # wait for the rmr thread + res = client.get(ADM_CTRL_INSTANCE_STATUS) # cant get status + assert res.status_code == 404 + res = client.get(ADM_CTRL_INSTANCE) # cant get instance + 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 == [{"handler_id": "test_receiver", "status": "OK"}] + assert res.json == [] - # assert that rmr bad states don't cause problems - monkeypatch.setattr("rmr.rmr.rmr_send_msg", rmr_mocks.send_mock_generator(10)) - res = client.put(ADM_CTRL_INSTANCE, json=testing_helpers.good_payload()) - assert res.status_code == 201 + # delete the type + res = client.delete(ADM_CTRL_TYPE) + assert res.status_code == 204 - monkeypatch.setattr("rmr.rmr.rmr_send_msg", rmr_mocks.send_mock_generator(5)) - res = client.put(ADM_CTRL_INSTANCE, json=testing_helpers.good_payload()) - assert res.status_code == 201 + # 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_xapp_put_bad(client, monkeypatch): -# """Test policy put fails""" -# _test_put_patch(monkeypatch) -# # return from policy handler has a status indicating FAIL -# monkeypatch.setattr( -# "a1.a1rmr.dequeue_all_waiting_messages", _fake_dequeue(monkeypatch, msg_payload={"status": "FAIL", "foo": "bar"}) -# ) -# res = client.put("/a1-p/policies/admission_control_policy", json=testing_helpers.good_payload()) -# assert res.status_code == 502 -# assert res.json["reason"] == "BAD STATUS" -# assert res.json["return_payload"] == {"status": "FAIL", "foo": "bar"} -# -# # return from policy handler has no status field -# monkeypatch.setattr("a1.a1rmr.dequeue_all_waiting_messages", _fake_dequeue(monkeypatch, msg_payload={"foo": "bar"})) -# res = client.put("/a1-p/policies/admission_control_policy", json=testing_helpers.good_payload()) -# assert res.status_code == 502 -# assert res.json["reason"] == "NO STATUS" -# assert res.json["return_payload"] == {"foo": "bar"} -# -# # return from policy handler not a json -# monkeypatch.setattr( -# "a1.a1rmr.dequeue_all_waiting_messages", _fake_dequeue(monkeypatch, msg_payload="booger", jsonb=False) -# ) -# res = client.put("/a1-p/policies/admission_control_policy", json=testing_helpers.good_payload()) -# assert res.status_code == 502 -# assert res.json["reason"] == "NOT JSON" -# assert res.json["return_payload"] == "booger" -# -# # bad type -# monkeypatch.setattr("a1.a1rmr.dequeue_all_waiting_messages", _fake_dequeue(monkeypatch, msg_type=666)) -# res = client.put("/a1-p/policies/admission_control_policy", json=testing_helpers.good_payload()) -# assert res.status_code == 504 -# assert res.data == b"\"A1 was expecting an ACK back but it didn't receive one or didn't recieve the expected ACK\"\n" -# -# # bad state -# monkeypatch.setattr("a1.a1rmr.dequeue_all_waiting_messages", _fake_dequeue(monkeypatch, msg_state=666)) -# res = client.put("/a1-p/policies/admission_control_policy", json=testing_helpers.good_payload()) -# assert res.status_code == 504 -# assert res.data == b"\"A1 was expecting an ACK back but it didn't receive one or didn't recieve the expected ACK\"\n" -# -# -def test_bad_requests(client, monkeypatch): +def test_bad_instances(client, monkeypatch, adm_type_good): """ - Test bad send failures + test various failure modes """ - testing_helpers.patch_all(monkeypatch) + # put the type (needed for some of the tests below) + rmr_mocks.patch_rmr(monkeypatch) + res = client.put(ADM_CTRL_TYPE, json=adm_type_good) + assert res.status_code == 201 + + # bad body res = client.put(ADM_CTRL_INSTANCE, json={"not": "expected"}) assert res.status_code == 400 @@ -188,36 +243,29 @@ def test_bad_requests(client, monkeypatch): res = client.put(ADM_CTRL_INSTANCE, data="notajson") assert res.status_code == 415 - # test a PUT body against a poliucy not expecting one - res = client.put("/a1-p/policytypes/20001/policies/test_policy", json=testing_helpers.good_payload()) - assert res.status_code == 400 - assert res.data == b'"BODY SUPPLIED BUT POLICY HAS NO EXPECTED BODY"\n' + # delete a non existent instance + res = client.delete(ADM_CTRL_INSTANCE + "DARKNESS") + assert res.status_code == 404 + # get a non existent instance + monkeypatch.setattr("rmr.helpers.rmr_rcvall_msgs", _fake_dequeue) + time.sleep(1) + res = client.get(ADM_CTRL_INSTANCE + "DARKNESS") + assert res.status_code == 404 -# def test_bad_requests(client, monkeypatch): -# """Test bad requests""" -# testing_helpers.patch_all(monkeypatch) -# -# # test a 404 -# res = client.put("/a1-p/policies/noexist", json=testing_helpers.good_payload()) -# assert res.status_code == 404 + # delete the type (as cleanup) + res = client.delete(ADM_CTRL_TYPE) + assert res.status_code == 204 -# def test_missing_manifest(client, monkeypatch): -# """ -# test that we get a 500 with an approrpiate message on a missing manifest -# """ -# -# def f(): -# raise exceptions.MissingManifest() -# -# monkeypatch.setattr("a1.utils.get_ric_manifest", f) -# -# res = client.put("/a1-p/policies/admission_control_policy", json=testing_helpers.good_payload()) -# assert res.status_code == 500 -# assert res.data == b'"A1 was unable to find the required RIC manifest. report this!"\n' -# -# +def test_illegal_types(client, monkeypatch, adm_type_good): + """ + Test illegal types + """ + res = client.put("/a1-p/policytypes/19999", json=adm_type_good) + assert res.status_code == 400 + res = client.put("/a1-p/policytypes/21024", json=adm_type_good) + assert res.status_code == 400 def test_healthcheck(client): @@ -226,3 +274,8 @@ def test_healthcheck(client): """ res = client.get("/a1-p/healthcheck") assert res.status_code == 200 + + +def teardown_module(): + """module teardown""" + RMR_THREAD.stop()