From e6bfac9e009c81cb15f722b13bac2726bdd69f4e Mon Sep 17 00:00:00 2001 From: kovalch Date: Mon, 1 Jul 2024 19:51:08 +0200 Subject: [PATCH] feat: Add tests for recaptcha_failure and recaptcha_success Create a new class and set apply_recaptcha to true Add teardown to not use apply_recaptcha in next tests --- ckanext/subscribe/tests/test_action.py | 81 ++++++++++++++++++++++++++ test.ini | 2 +- 2 files changed, 82 insertions(+), 1 deletion(-) diff --git a/ckanext/subscribe/tests/test_action.py b/ckanext/subscribe/tests/test_action.py index 985d108..f2d8e08 100644 --- a/ckanext/subscribe/tests/test_action.py +++ b/ckanext/subscribe/tests/test_action.py @@ -2,6 +2,7 @@ import datetime +import ckan.plugins.toolkit as tk import mock from ckan import model from ckan.plugins.toolkit import ValidationError @@ -224,6 +225,86 @@ def test_dataset_and_group_at_same_time(self, send_request_email): assert not send_request_email.called +# The reCAPTCHA tests +class TestRecaptchaOfSubscribeSignup(object): + def setup(self): + helpers.reset_db() + tk.config["ckanext.subscribe.apply_recaptcha"] = "true" + + def teardown(self): + tk.config["ckanext.subscribe.apply_recaptcha"] = "false" + + # mock the _verify_recaptcha function and test both + # successful and unsuccessful reCAPTCHA verification scenarios + @mock.patch("requests.post") + @mock.patch("ckanext.subscribe.email_verification.send_request_email") + @mock.patch("ckanext.subscribe.action._verify_recaptcha") + def test_verify_recaptcha_success( + self, mock_verify_recaptcha, send_request_email, mock_post + ): + # Mocking the reCAPTCHA verification to return True + mock_verify_recaptcha.return_value = True + mock_post.return_value = mock.Mock( + status_code=200, json=lambda: {"success": True} + ) + + dataset = factories.Dataset() + + # Calling the subscribe_signup action with a mock reCAPTCHA response + subscription = helpers.call_action( + "subscribe_signup", + {}, + email="bob@example.com", + dataset_id=dataset["id"], + g_recaptcha_response="test-recaptcha-response", + ) + + # Asserting that the email verification function was called once + send_request_email.assert_called_once() + eq(send_request_email.call_args[0][0].object_type, "dataset") + eq(send_request_email.call_args[0][0].object_id, dataset["id"]) + eq(send_request_email.call_args[0][0].email, "bob@example.com") + + # Asserting that the subscription was created with the correct details + eq(subscription["object_type"], "dataset") + eq(subscription["object_id"], dataset["id"]) + eq(subscription["email"], "bob@example.com") + eq(subscription["verified"], False) + assert "verification_code" not in subscription + + # Checking that the subscription object exists in the database + subscription_obj = model.Session.query(subscribe_model.Subscription).get( + subscription["id"] + ) + assert subscription_obj + + @mock.patch("ckanext.subscribe.email_verification.send_request_email") + @mock.patch("ckanext.subscribe.action._verify_recaptcha") + def test_verify_recaptcha_failure(self, mock_verify_recaptcha, send_request_email): + # Mocking the reCAPTCHA verification to return False + mock_verify_recaptcha.return_value = False + + dataset = factories.Dataset() + + # Attempting to call subscribe_signup action with an invalid reCAPTCHA + try: + helpers.call_action( + "subscribe_signup", + {}, + email="bob@example.com", + dataset_id=dataset["id"], + g_recaptcha_response="wrong_recaptcha", + ) + except ValidationError as e: + # Asserting that the error is raised with the correct message + assert "Invalid reCAPTCHA. Please try again." in str(e.error_dict) + + # Ensuring the email is not sent due to invalid reCAPTCHA + assert not send_request_email.called + else: + assert False, "ValidationError not raised" + + class TestSubscribeVerify(object): def setup(self): helpers.reset_db() diff --git a/test.ini b/test.ini index 2d61a4e..6f784b3 100644 --- a/test.ini +++ b/test.ini @@ -9,7 +9,7 @@ host = 0.0.0.0 port = 5000 [app:main] -use = config:/usr/lib/ckan/venv/src/ckan/test-core.ini +use = config:../ckan/test-core.ini # Insert any custom config settings to be used when running your extension's # tests here.