31800: validate Incorporation Application share structure fields#4036
31800: validate Incorporation Application share structure fields#4036loneil wants to merge 9 commits intobcgov:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR tightens validation rules for share structures, enforcing consistent naming for share classes and series and adding comprehensive unit tests around these rules.
Changes:
- Introduced
EXCLUDED_WORDS_FOR_CLASSandEXCLUDED_WORDS_FOR_SERIESconstants and extendedvalidate_shares/validate_seriesto enforce a" Shares"suffix and to reject reserved words in class and series names. - Ensured series-level validations (max shares, rights/restrictions, duplicate names) now also include suffix and reserved-word checks while maintaining existing behavior.
- Added extensive unit tests in
test_common_validations.pyfor share-class and series names, as well as for end-to-endvalidate_share_structurebehavior over various valid and invalid share structures.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| legal-api/src/legal_api/services/filings/validations/common_validations.py | Adds reserved-word and suffix validations for share class and series names, and exposes exclusion word lists as constants used across filings. |
| legal-api/tests/unit/services/filings/validations/test_common_validations.py | Adds parameterized tests covering class/series name suffix rules, reserved words, whitespace/emptiness, duplication, and full share-structure validation behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
legal-api/src/legal_api/services/filings/validations/common_validations.py
Outdated
Show resolved
Hide resolved
legal-api/src/legal_api/services/filings/validations/common_validations.py
Outdated
Show resolved
Hide resolved
loneil
changed the title
loneil
force-pushed
the
31800shareValidationsForIa
branch
3 times, most recently
from
a6477dd to
3895c05
Compare
| ) | ||
|
|
||
|
|
||
| def has_at_least_one_share_class(filing_json, filing_type) -> Optional[str]: # pylint: disable=too-many-branches |
There was a problem hiding this comment.
Found this function was unused anywhere in the app (validation was done elsewhere)
Signed-off-by: Lucas <lucasoneil@gmail.com>
Signed-off-by: Lucas <lucasoneil@gmail.com>
Signed-off-by: Lucas <lucasoneil@gmail.com>
Signed-off-by: Lucas <lucasoneil@gmail.com>
Signed-off-by: Lucas <lucasoneil@gmail.com>
Signed-off-by: Lucas <lucasoneil@gmail.com>
Signed-off-by: Lucas <lucasoneil@gmail.com>
loneil
force-pushed
the
31800shareValidationsForIa
branch
from
2762cfb to
f1fd9f7
Compare
Signed-off-by: Lucas <lucasoneil@gmail.com>
Signed-off-by: Lucas <lucasoneil@gmail.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 11 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # For incorporation applications, at least one share class is required | ||
| if filing_type == Filing.FilingTypes.INCORPORATIONAPPLICATION and len(share_classes) == 0: | ||
| msg.append({ | ||
| "error": "A company must have least one Class of Shares.", | ||
| "path": f"/filing/{filing_type}/shareStructure/shareClasses" | ||
| }) |
There was a problem hiding this comment.
The condition filing_type == Filing.FilingTypes.INCORPORATIONAPPLICATION will never be true in practice because all current callers pass filing_type as a plain string (for example, 'incorporationApplication' in incorporation_application.validate), while FilingTypes is a str-based Enum and compares by enum identity, not raw string value. This means the new "at least one share class" validation is never executed for incorporation applications, and tests like test_share_structure_empty_share_classes_for_ia will fail. Consider comparing against Filing.FilingTypes.INCORPORATIONAPPLICATION.value (or normalizing filing_type to that value) so that both production code and tests correctly trigger this check.
| # For incorporation applications, at least one share class is required | ||
| if filing_type == Filing.FilingTypes.INCORPORATIONAPPLICATION and len(share_classes) == 0: | ||
| msg.append({ | ||
| "error": "A company must have least one Class of Shares.", |
There was a problem hiding this comment.
The error message text "A company must have least one Class of Shares." is grammatically incorrect; it should read "A company must have at least one Class of Shares." Since this message is surfaced to users and asserted in tests, please update the string here (and corresponding test expectations) to use the grammatically correct wording.
| "error": "A company must have least one Class of Shares.", | |
| "error": "A company must have at least one Class of Shares.", |
| # validate outcomes | ||
| if expected_code: | ||
| assert err.code == expected_code | ||
| # print exptected and actual for easier debugging |
There was a problem hiding this comment.
The inline comment text has a typo ("exptected"); it should be "expected" to avoid confusion when reading/debugging tests.
| # print exptected and actual for easier debugging | |
| # print expected and actual for easier debugging |
1 participant
Issue #: /bcgov/entity#31800
Description of changes:
WIP
Needs bcgov/business-schemas#202 merged so unit tests can be accomodated
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the lear license (Apache 2.0).