Special char issue 3 #1891
Special char issue 3 #1891
Conversation
code_rabbit_change
code_rabbit_change
code_rabbit_change
code_rabbit_change
code_rabbit_change
all test case success
WalkthroughThe changes enhance input validation across the codebase. Updates include importing and using new regular expression constants for validating bot names, user names, and story names. The modifications add validator methods in the registration data model and update validation logic in processor classes. Additionally, redundant utility methods have been removed and tests have been refactored to cover these new validation rules while consolidating repeated test cases. Changes
Sequence Diagram(s)sequenceDiagram
participant Client as Client
participant Processor as Processor
participant Validator as Utility/Regex
Client->>Processor: Send request (add/update bot, user, or story)
Processor->>Validator: Validate input (using RE_VALID_NAME / RE_ALPHA_NUM)
alt Input valid
Processor->>Client: Process request and return success
else Input invalid
Processor->>Client: Raise AppException with error message
end
Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (5)
kairon/shared/data/constant.py (2)
268-269: Fix spacing in variable assignment and add documentationThere's a missing space in the assignment for
RE_VALID_NAME=. Also, consider adding docstrings to explain what these regex patterns are used for and what specific characters they allow.-RE_ALPHA_NUM = re.compile(r"^[a-zA-Z0-9 _]+$").search -RE_VALID_NAME= re.compile(r"^[a-zA-Z0-9 _-]+$").search +# Regex for validating user names (first/last names) - allows alphanumeric, spaces and underscores +RE_ALPHA_NUM = re.compile(r"^[a-zA-Z0-9 _]+$").search +# Regex for validating bot names and story names - allows alphanumeric, spaces, underscores and hyphens +RE_VALID_NAME = re.compile(r"^[a-zA-Z0-9 _-]+$").search
268-269: Consider more descriptive naming for the regex constantsThe current names don't fully capture what these regex patterns are validating.
RE_ALPHA_NUMallows underscores which aren't alphanumeric, and both patterns serve specific validation purposes in the application.-RE_ALPHA_NUM = re.compile(r"^[a-zA-Z0-9 _]+$").search -RE_VALID_NAME= re.compile(r"^[a-zA-Z0-9 _-]+$").search +RE_VALID_USER_NAME = re.compile(r"^[a-zA-Z0-9 _]+$").search +RE_VALID_BOT_STORY_NAME = re.compile(r"^[a-zA-Z0-9 _-]+$").searchkairon/shared/data/processor.py (1)
3-3: Remove unused import.The
remodule is imported but never directly used in this file. It should be removed to maintain clean code.-import re🧰 Tools
🪛 Ruff (0.8.2)
3-3:
reimported but unusedRemove unused import:
re(F401)
tests/unit_test/utility_test.py (2)
850-851: Use context manager for file operations.Using
open()without a context manager can lead to resource leaks if exceptions occur.- Utility.email_conf["email"]["templates"]["verification"] = ( - open("template/emails/verification.html", "rb").read().decode() - ) + with open("template/emails/verification.html", "rb") as file: + Utility.email_conf["email"]["templates"]["verification"] = file.read().decode()🧰 Tools
🪛 Ruff (0.8.2)
850-850: Use a context manager for opening files
(SIM115)
878-879: Use context manager for file operations.Using
open()without a context manager can lead to resource leaks if exceptions occur.- Utility.email_conf["email"]["templates"]["verification"] = ( - open("template/emails/verification.html", "rb").read().decode() - ) + with open("template/emails/verification.html", "rb") as file: + Utility.email_conf["email"]["templates"]["verification"] = file.read().decode()🧰 Tools
🪛 Ruff (0.8.2)
878-878: Use a context manager for opening files
(SIM115)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
kairon/shared/account/processor.py(5 hunks)kairon/shared/data/constant.py(2 hunks)kairon/shared/data/data_models.py(2 hunks)kairon/shared/data/processor.py(6 hunks)kairon/shared/utils.py(0 hunks)tests/integration_test/services_test.py(1 hunks)tests/unit_test/api/api_processor_test.py(1 hunks)tests/unit_test/data_processor/data_processor_test.py(6 hunks)tests/unit_test/utility_test.py(2 hunks)
💤 Files with no reviewable changes (1)
- kairon/shared/utils.py
🧰 Additional context used
🧬 Code Definitions (6)
kairon/shared/account/processor.py (3)
kairon/shared/data/data_objects.py (1)
BotSettings(903-943)kairon/shared/data/constant.py (4)
ACCESS_ROLES(159-166)ACTIVITY_STATUS(169-173)INTEGRATION_STATUS(176-179)ONBOARDING_STATUS(114-118)kairon/shared/utils.py (2)
Utility(92-2261)special_match(677-685)
tests/unit_test/api/api_processor_test.py (1)
kairon/shared/account/processor.py (2)
AccountProcessor(51-1475)add_bot(149-213)
tests/unit_test/data_processor/data_processor_test.py (2)
kairon/shared/data/processor.py (2)
add_complex_story(3366-3444)get_stories(3667-3778)kairon/shared/data/data_objects.py (1)
Stories(640-671)
kairon/shared/data/data_models.py (1)
kairon/shared/utils.py (3)
Utility(92-2261)check_empty_string(147-159)special_match(677-685)
kairon/shared/data/processor.py (2)
kairon/shared/data/constant.py (1)
DEMO_REQUEST_STATUS(86-90)kairon/shared/utils.py (1)
special_match(677-685)
tests/unit_test/utility_test.py (1)
kairon/shared/utils.py (4)
Utility(92-2261)MailUtility(2496-2795)format_and_send_mail(2498-2534)special_match(677-685)
🪛 Ruff (0.8.2)
kairon/shared/data/processor.py
3-3: re imported but unused
Remove unused import: re
(F401)
tests/unit_test/utility_test.py
850-850: Use a context manager for opening files
(SIM115)
878-878: Use a context manager for opening files
(SIM115)
2873-2873: Redefinition of unused test_special_match from line 2860
(F811)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (21)
kairon/shared/data/constant.py (2)
1-1: Import module placement looks goodThe addition of the
remodule import is correctly placed at the top of the file.
268-269:✅ Verification successful
Verify all implementations use these new regex validators correctly
These new regex patterns are used for validation in multiple places according to the PR summary. Let's verify that they're being used consistently throughout the application.
🏁 Script executed:
#!/bin/bash # Search for all occurrences of the new regex constants in the codebase echo "Searching for RE_ALPHA_NUM usage:" rg "RE_ALPHA_NUM" --type py echo "\nSearching for RE_VALID_NAME usage:" rg "RE_VALID_NAME" --type pyLength of output: 1616
Regex Validator Usage Verified
All usages of the new regex constants are consistent across the codebase. Specifically:
RE_ALPHA_NUMis correctly used in:
kairon/shared/data/data_models.pykairon/shared/account/processor.pyRE_VALID_NAMEis correctly used in:
kairon/shared/data/processor.pykairon/shared/account/processor.pyNo discrepancies were found in their implementation.
kairon/shared/data/processor.py (5)
136-136: Approve addingRE_VALID_NAMEconstant import.Adding
RE_VALID_NAMEimport is appropriate as it's used for validating story names throughout the file.
3384-3385: Enhance input validation for story names.Adding validation for story names to ensure they only contain letters, numbers, hyphens, and underscores is a good security practice. This prevents potential issues with special characters in story names.
3466-3467: Approve consistent validation in multiflow stories.The same validation pattern is appropriately applied to multiflow stories, maintaining consistency across the codebase.
3536-3537: Approve validation in story updates.Adding validation to the update method ensures that invalid names cannot be introduced during updates, maintaining data integrity.
3602-3603: Approve validation in multiflow story updates.The validation is consistently applied to multiflow story updates, completing the validation across all story-related methods.
tests/integration_test/services_test.py (1)
20946-20952: Update to Story Name Validation in Test Cases.The change modifying the story name to
"stop form - continue"is consistent with the new validation rules (usingRE_VALID_NAME) that restrict special characters. This update ensures that the test reflects the desired format and avoids invalid characters (such as+) which were previously problematic.tests/unit_test/api/api_processor_test.py (1)
110-113: Good refactoring of test casesThe refactoring consolidates multiple individual test cases into a single loop that iterates over a list of invalid bot names. This improves code maintainability while maintaining the same test coverage.
tests/unit_test/data_processor/data_processor_test.py (6)
9646-9646: Story name change looks appropriateThe change from "stop form + continue" to "stop form - continue" aligns with the special character issue fix. Based on the relevant code snippets, the validation now only allows letters, numbers, hyphens (-), and underscores (_) in story names.
Also applies to: 9648-9648, 9655-9655
9672-9672: Consistent naming convention appliedSimilar to the previous change, "stop form + stop" has been replaced with "stop form - stop" to comply with the new validation rules that restrict special characters in story names.
Also applies to: 9674-9674, 9680-9680
10466-10466: Error message reference updated correctlyThe story name in the error message validation has been updated to match the new naming convention.
10486-10486: Test assertions updated consistentlyThe DoesNotExist assertions have been updated to use the new story names, maintaining consistency with earlier changes.
Also applies to: 10488-10488
15227-15229: Empty lines added for better readabilityThese added blank lines improve code readability by separating test methods.
15446-15457: Good addition of test for invalid story namesThis test correctly verifies that story names with invalid special characters (like "@" and "!") are rejected, which aligns with the validation in the processor.py file that restricts story names to letters, numbers, hyphens, and underscores.
kairon/shared/data/data_models.py (1)
19-19: Good addition of the required regular expression constant.Adding
RE_ALPHA_NUMimport properly supports the new validation methods.kairon/shared/account/processor.py (5)
1-1: Good import addition.The import of
BotSettingsfromkairon.shared.data.data_objectsis proper and seems to be required for the implementation.
41-42: Good import of regular expression constants.Properly importing the regex constants
RE_ALPHA_NUMandRE_VALID_NAMEto be used for validation.
173-174: Improved validation for bot names.Updating the validation to use the new regex pattern
RE_VALID_NAMEimproves the code by providing more specific validation for bot names.
229-230: Consistent validation applied for bot names in update method.The same validation is properly applied in the
update_botmethod, ensuring consistency across the application.
698-703:❓ Verification inconclusive
Improved validation for user names.
The new validation ensures that first and last names only contain alphanumeric characters, addressing the special character issue mentioned in the PR.
However, verify that this validation is consistent with the requirements. For example, some names may contain hyphens or apostrophes that would be rejected by this validation.
🏁 Script executed:
#!/bin/bash # Check if there are any existing user names in the database that would fail # with the new validation rules echo "Running regex check on first names and last names..." # This command would need to be adapted to your actual database query capabilities # For example, using mongodb's $regex operator to find names with special characters echo "Note: You should consider if names with apostrophes (O'Connor) or hyphens (Smith-Jones) should be allowed"Length of output: 338
Action Required: Confirm User Name Validation Requirements
The updated validation now restricts first and last names to alphanumeric characters only. This change addresses the special character issue mentioned in the PR. However, please verify that this stricter check aligns with the business requirements—particularly whether names with hyphens (e.g., Smith-Jones) or apostrophes (e.g., O'Connor) should be permitted.
- Validation Added: Ensures only alphanumeric characters are allowed.
- Consideration Needed: Confirm if names with hyphens/apostrophes are valid per requirements.
| def test_update_valid_complex_story_name(self): | ||
| processor = MongoProcessor() | ||
| events = [ | ||
| {"name": "greeting", "type": "INTENT"}, | ||
| {"name": "utter_greet", "type": "BOT"}, | ||
| {"name": "mood_great", "type": "INTENT"}, | ||
| {"name": "utter_greet", "type": "BOT"} | ||
| ] | ||
| with pytest.raises(AppException): | ||
| story_dict = {'name': "Invalid_Name", 'steps': events, 'type': 'STORY', 'template_type': 'CUSTOM'} | ||
| processor.update_complex_story(pytest.story_id, story_dict, "tests", "testUser") | ||
|
|
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Test expects exception for a valid name
The test name suggests it's testing a valid story name, but it's expecting an exception for "Invalid_Name" which appears to be valid according to the rules (contains only letters, numbers, and underscores).
There seems to be a contradiction between the test name and its implementation. Either:
- The test name should be changed to reflect that it's testing an invalid case, or
- The assertion should be removed if "Invalid_Name" is actually valid according to the validation rules
Verify whether "Invalid_Name" should pass or fail validation based on the RE_VALID_NAME regex pattern:
🏁 Script executed:
#!/bin/bash
# Check how the regex pattern is defined and whether it would match "Invalid_Name"
rg -A 2 "RE_VALID_NAME" --include="*.py"Length of output: 482
Action: Verify Regex Behavior for Story Name Validation
There is an inconsistency in the test test_update_valid_complex_story_name in tests/unit_test/data_processor/data_processor_test.py:
- The test name implies that a valid story name is being verified.
- However, it expects an exception when using the name
"Invalid_Name", which appears valid (consisting only of letters, numbers, and underscores).
Next Steps:
- Run the above script to inspect the
RE_VALID_NAMEdefinition in the codebase. - Confirm whether the regex regards underscores as valid characters.
- Based on the outcome:
- If
"Invalid_Name"is indeed valid, update either the test name or the assertion. - Otherwise, adjust the regex if the intended behavior is to reject such names.
- If
Please verify the regex output and update the test accordingly.
🏁 Script executed:
#!/bin/bash
# Use ripgrep with a corrected file include flag to search for the RE_VALID_NAME pattern
rg -g '*.py' -A 2 "RE_VALID_NAME"Length of output: 2229
Attention: Inconsistent Exception Expectation in Story Name Test
After verifying the regex definition (RE_VALID_NAME = re.compile(r"^[a-zA-Z0-9 _-]+$")) used for validating story names, it's clear that underscores are allowed. This means that "Invalid_Name" is considered a valid name. Consequently, the test in tests/unit_test/data_processor/data_processor_test.py:
- Uses the name
"Invalid_Name"(which conforms to the allowed pattern) but still expects anAppException. - The test name
test_update_valid_complex_story_namesuggests that it checks for a valid story name, which contradicts the expectation of raising an exception.
Recommendations:
- Option 1: If the intention is to test invalid names, update the test input to use a truly invalid name (one that violates the regex).
- Option 2: If the goal is to verify valid story updates, remove the exception assertion (i.e., remove the
pytest.raises(AppException)context) and adjust the test name accordingly.
Please adjust the test to align with the intended validation behavior.
| @validator("first_name") | ||
| def validate_first_name(cls, v): | ||
| from kairon.shared.utils import Utility | ||
|
|
||
| if Utility.check_empty_string(v): | ||
| raise ValueError("First name cannot be empty or blank spaces") | ||
|
|
||
| if not Utility.special_match(v, RE_ALPHA_NUM): | ||
| raise ValueError("First name can only contain letters.") | ||
|
|
||
| return v | ||
|
|
||
| @validator("last_name") | ||
| def validate_last_name(cls, v): | ||
| from kairon.shared.utils import Utility | ||
|
|
||
| if Utility.check_empty_string(v): | ||
| raise ValueError("Last name cannot be empty or blank spaces") | ||
|
|
||
| if not Utility.special_match(v, RE_ALPHA_NUM): | ||
| raise ValueError("Last name can only contain letters.") | ||
|
|
||
| return v |
There was a problem hiding this comment.
Inconsistency between error message and validation logic.
The error messages state that names "can only contain letters", but the RE_ALPHA_NUM regex pattern (based on its name) would allow both letters and numbers. This creates an inconsistency with the processor implementation where the error message correctly mentions "letters and numbers".
Modify the error messages to match the actual validation behavior:
- raise ValueError("First name can only contain letters.")
+ raise ValueError("First name can only contain letters and numbers.")- raise ValueError("Last name can only contain letters.")
+ raise ValueError("Last name can only contain letters and numbers.")📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| @validator("first_name") | |
| def validate_first_name(cls, v): | |
| from kairon.shared.utils import Utility | |
| if Utility.check_empty_string(v): | |
| raise ValueError("First name cannot be empty or blank spaces") | |
| if not Utility.special_match(v, RE_ALPHA_NUM): | |
| raise ValueError("First name can only contain letters.") | |
| return v | |
| @validator("last_name") | |
| def validate_last_name(cls, v): | |
| from kairon.shared.utils import Utility | |
| if Utility.check_empty_string(v): | |
| raise ValueError("Last name cannot be empty or blank spaces") | |
| if not Utility.special_match(v, RE_ALPHA_NUM): | |
| raise ValueError("Last name can only contain letters.") | |
| return v | |
| @validator("first_name") | |
| def validate_first_name(cls, v): | |
| from kairon.shared.utils import Utility | |
| if Utility.check_empty_string(v): | |
| raise ValueError("First name cannot be empty or blank spaces") | |
| if not Utility.special_match(v, RE_ALPHA_NUM): | |
| raise ValueError("First name can only contain letters and numbers.") | |
| return v | |
| @validator("last_name") | |
| def validate_last_name(cls, v): | |
| from kairon.shared.utils import Utility | |
| if Utility.check_empty_string(v): | |
| raise ValueError("Last name cannot be empty or blank spaces") | |
| if not Utility.special_match(v, RE_ALPHA_NUM): | |
| raise ValueError("Last name can only contain letters and numbers.") | |
| return v |
| @pytest.mark.parametrize("input_str, expected", [ | ||
| ("Testing@123", True), | ||
| ("Testing 123", True), | ||
| ("Testing-123", True), | ||
| ("Testing_123", False), | ||
| ("Tom & Jerry", True) | ||
| ]) | ||
| def test_special_match(self, input_str, expected): | ||
| assert Utility.special_match(strg=input_str) is expected |
There was a problem hiding this comment.
Parameterized test implementation issue.
The test_special_match function is redefined here while the original implementation still exists at line 2860, causing duplicate test function definition.
This is likely intended to replace the previous individual test methods for special character matching. Make sure to remove the original implementation and update any deleted test methods that were referenced in the AI summary.
Also, consider adding additional test cases covering more special characters to ensure comprehensive validation.
🧰 Tools
🪛 Ruff (0.8.2)
2873-2873: Redefinition of unused test_special_match from line 2860
(F811)
| @pytest.mark.asyncio | ||
| @patch("kairon.shared.utils.MailUtility.validate_and_send_mail", autospec=True) | ||
| async def test_handle_verification_with_invalid_first_name_special_chars(self, validate_and_send_mail_mock): | ||
| mail_type = "verification" | ||
| email = "sampletest@gmail.com" | ||
| first_name = "Sample" # Valid first name | ||
| base_url = Utility.environment["app"]["frontend_url"] | ||
|
|
||
| Utility.email_conf["email"]["templates"]["verification"] = ( | ||
| open("template/emails/verification.html", "rb").read().decode() | ||
| ) | ||
|
|
||
| expected_body = Utility.email_conf["email"]["templates"]["verification"] | ||
| expected_body = ( | ||
| expected_body.replace("FIRST_NAME", first_name) | ||
| .replace("USER_EMAIL", email) | ||
| .replace("BASE_URL", base_url) | ||
| ) | ||
| expected_subject = Utility.email_conf["email"]["templates"]["confirmation_subject"] | ||
|
|
||
| await MailUtility.format_and_send_mail( | ||
| mail_type=mail_type, email=email, first_name=first_name | ||
| ) | ||
|
|
||
| validate_and_send_mail_mock.assert_called_once_with( | ||
| email, expected_subject, expected_body | ||
| ) | ||
|
|
||
| @pytest.mark.asyncio | ||
| @patch("kairon.shared.utils.MailUtility.validate_and_send_mail", autospec=True) | ||
| async def test_handle_verification_with_valid_first_name_no_special_chars(self, validate_and_send_mail_mock): | ||
| mail_type = "verification" | ||
| email = "sampletest@gmail.com" | ||
| first_name = "Samp#le" # InValid first name | ||
| base_url = Utility.environment["app"]["frontend_url"] | ||
|
|
||
| Utility.email_conf["email"]["templates"]["verification"] = ( | ||
| open("template/emails/verification.html", "rb").read().decode() | ||
| ) | ||
|
|
||
| expected_body = Utility.email_conf["email"]["templates"]["verification"] | ||
| expected_body = ( | ||
| expected_body.replace("FIRST_NAME", first_name) | ||
| .replace("USER_EMAIL", email) | ||
| .replace("BASE_URL", base_url) | ||
| ) | ||
| expected_subject = Utility.email_conf["email"]["templates"]["confirmation_subject"] | ||
|
|
||
| await MailUtility.format_and_send_mail( | ||
| mail_type=mail_type, email=email, first_name=first_name | ||
| ) | ||
|
|
||
| validate_and_send_mail_mock.assert_called_once_with( | ||
| email, expected_subject, expected_body | ||
| ) | ||
|
|
There was a problem hiding this comment.
Inconsistent method naming vs. functionality.
The method names don't match their actual test behavior:
test_handle_verification_with_invalid_first_name_special_charsuses a valid first name with no special characterstest_handle_verification_with_valid_first_name_no_special_charsuses an invalid first name with special characters
This creates confusion for other developers reading the tests.
Apply this diff to correct the method names:
- async def test_handle_verification_with_invalid_first_name_special_chars(self, validate_and_send_mail_mock):
+ async def test_handle_verification_with_valid_first_name_no_special_chars(self, validate_and_send_mail_mock):
- async def test_handle_verification_with_valid_first_name_no_special_chars(self, validate_and_send_mail_mock):
+ async def test_handle_verification_with_invalid_first_name_special_chars(self, validate_and_send_mail_mock):Also, consider using context managers for opening files:
- Utility.email_conf["email"]["templates"]["verification"] = (
- open("template/emails/verification.html", "rb").read().decode()
- )
+ with open("template/emails/verification.html", "rb") as file:
+ Utility.email_conf["email"]["templates"]["verification"] = file.read().decode()📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| @pytest.mark.asyncio | |
| @patch("kairon.shared.utils.MailUtility.validate_and_send_mail", autospec=True) | |
| async def test_handle_verification_with_invalid_first_name_special_chars(self, validate_and_send_mail_mock): | |
| mail_type = "verification" | |
| email = "sampletest@gmail.com" | |
| first_name = "Sample" # Valid first name | |
| base_url = Utility.environment["app"]["frontend_url"] | |
| Utility.email_conf["email"]["templates"]["verification"] = ( | |
| open("template/emails/verification.html", "rb").read().decode() | |
| ) | |
| expected_body = Utility.email_conf["email"]["templates"]["verification"] | |
| expected_body = ( | |
| expected_body.replace("FIRST_NAME", first_name) | |
| .replace("USER_EMAIL", email) | |
| .replace("BASE_URL", base_url) | |
| ) | |
| expected_subject = Utility.email_conf["email"]["templates"]["confirmation_subject"] | |
| await MailUtility.format_and_send_mail( | |
| mail_type=mail_type, email=email, first_name=first_name | |
| ) | |
| validate_and_send_mail_mock.assert_called_once_with( | |
| email, expected_subject, expected_body | |
| ) | |
| @pytest.mark.asyncio | |
| @patch("kairon.shared.utils.MailUtility.validate_and_send_mail", autospec=True) | |
| async def test_handle_verification_with_valid_first_name_no_special_chars(self, validate_and_send_mail_mock): | |
| mail_type = "verification" | |
| email = "sampletest@gmail.com" | |
| first_name = "Samp#le" # InValid first name | |
| base_url = Utility.environment["app"]["frontend_url"] | |
| Utility.email_conf["email"]["templates"]["verification"] = ( | |
| open("template/emails/verification.html", "rb").read().decode() | |
| ) | |
| expected_body = Utility.email_conf["email"]["templates"]["verification"] | |
| expected_body = ( | |
| expected_body.replace("FIRST_NAME", first_name) | |
| .replace("USER_EMAIL", email) | |
| .replace("BASE_URL", base_url) | |
| ) | |
| expected_subject = Utility.email_conf["email"]["templates"]["confirmation_subject"] | |
| await MailUtility.format_and_send_mail( | |
| mail_type=mail_type, email=email, first_name=first_name | |
| ) | |
| validate_and_send_mail_mock.assert_called_once_with( | |
| email, expected_subject, expected_body | |
| ) | |
| @pytest.mark.asyncio | |
| @patch("kairon.shared.utils.MailUtility.validate_and_send_mail", autospec=True) | |
| async def test_handle_verification_with_valid_first_name_no_special_chars(self, validate_and_send_mail_mock): | |
| mail_type = "verification" | |
| email = "sampletest@gmail.com" | |
| first_name = "Sample" # Valid first name | |
| base_url = Utility.environment["app"]["frontend_url"] | |
| with open("template/emails/verification.html", "rb") as file: | |
| Utility.email_conf["email"]["templates"]["verification"] = file.read().decode() | |
| expected_body = Utility.email_conf["email"]["templates"]["verification"] | |
| expected_body = ( | |
| expected_body.replace("FIRST_NAME", first_name) | |
| .replace("USER_EMAIL", email) | |
| .replace("BASE_URL", base_url) | |
| ) | |
| expected_subject = Utility.email_conf["email"]["templates"]["confirmation_subject"] | |
| await MailUtility.format_and_send_mail( | |
| mail_type=mail_type, email=email, first_name=first_name | |
| ) | |
| validate_and_send_mail_mock.assert_called_once_with( | |
| email, expected_subject, expected_body | |
| ) | |
| @pytest.mark.asyncio | |
| @patch("kairon.shared.utils.MailUtility.validate_and_send_mail", autospec=True) | |
| async def test_handle_verification_with_invalid_first_name_special_chars(self, validate_and_send_mail_mock): | |
| mail_type = "verification" | |
| email = "sampletest@gmail.com" | |
| first_name = "Samp#le" # InValid first name | |
| base_url = Utility.environment["app"]["frontend_url"] | |
| with open("template/emails/verification.html", "rb") as file: | |
| Utility.email_conf["email"]["templates"]["verification"] = file.read().decode() | |
| expected_body = Utility.email_conf["email"]["templates"]["verification"] | |
| expected_body = ( | |
| expected_body.replace("FIRST_NAME", first_name) | |
| .replace("USER_EMAIL", email) | |
| .replace("BASE_URL", base_url) | |
| ) | |
| expected_subject = Utility.email_conf["email"]["templates"]["confirmation_subject"] | |
| await MailUtility.format_and_send_mail( | |
| mail_type=mail_type, email=email, first_name=first_name | |
| ) | |
| validate_and_send_mail_mock.assert_called_once_with( | |
| email, expected_subject, expected_body | |
| ) |
🧰 Tools
🪛 Ruff (0.8.2)
850-850: Use a context manager for opening files
(SIM115)
878-878: Use a context manager for opening files
(SIM115)
special char issue on demo bot_name, update_story, add_story, user_names
Summary by CodeRabbit
New Features
Tests