Skip to content

31800: validate Incorporation Application share structure fields #4036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
loneil wants to merge 10 commits into
base: main
Choose a base branch
from
+1,119 −339
Open

31800: validate Incorporation Application share structure fields #4036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
76f2daa
validate share structure
loneil Jan 28, 2026
84bb290
Unit test data adjustments
loneil Jan 29, 2026
e39e7e8
Validate IA includes a share class
loneil Jan 29, 2026
db78afc
Validate details on share max number
loneil Jan 29, 2026
df8d47e
Formatting
loneil Jan 29, 2026
0ee8243
Update business-schemas
loneil Feb 3, 2026
f1fd9f7
Validation refactor
loneil Feb 3, 2026
d63e94f
Update registry scehema and test data
loneil Feb 4, 2026
46d1c2e
Unit testing
loneil Feb 4, 2026
eefc9e1
Fixes from review
loneil Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 4 additions & 40 deletions legal-api/poetry.lock
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion legal-api/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ dependencies = [
"blinker (==1.4)",
"pyjwt (==2.8.0)",

"registry_schemas @ git+https://github.com/bcgov/business-schemas.git@2.18.58#egg=registry_schemas",
"registry_schemas @ git+https://github.com/bcgov/business-schemas.git@2.18.60#egg=registry_schemas",
"sql-versioning @ git+https://github.com/bcgov/lear.git@main#subdirectory=python/common/sql-versioning",
"gcp-queue @ git+https://github.com/bcgov/sbc-connect-common.git@main#subdirectory=python/gcp-queue",
"structured-logging @ git+https://github.com/bcgov/sbc-connect-common.git@main#subdirectory=python/structured-logging"
Expand Down
129 changes: 109 additions & 20 deletions legal-api/src/legal_api/services/filings/validations/common_validations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from flask import current_app, g, request
from flask_babel import _

from legal_api.core.filing import Filing
from legal_api.errors import Error
from legal_api.models import Address, Business, PartyRole
from legal_api.models.configuration import EMAIL_PATTERN
Expand Down Expand Up @@ -50,16 +51,11 @@
)


def has_at_least_one_share_class(filing_json, filing_type) -> Optional[str]: # pylint: disable=too-many-branches
Copy link
Collaborator Author

@loneil loneil Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found this function was unused anywhere in the app (validation was done elsewhere)

"""Ensure that share structure contain at least 1 class by the end of the alteration or IA Correction filing."""
if filing_type in filing_json["filing"] and "shareStructure" in filing_json["filing"][filing_type]:
share_classes = filing_json["filing"][filing_type] \
.get("shareStructure", {}).get("shareClasses", [])

if len(share_classes) == 0:
return "A company must have a minimum of one share class."

return None
# Share structure constants
EXCLUDED_WORDS_FOR_CLASS = ["share", "shares", "value"]
EXCLUDED_WORDS_FOR_SERIES = ["share", "shares"]
SHARE_NAME_SUFFIX = " Shares"
MAX_SHARE_DIGITS = 16


def validate_resolution_date_in_share_structure(filing_json, filing_type) -> Optional[dict]:
Expand Down Expand Up @@ -93,6 +89,14 @@ def validate_share_structure(incorporation_json, filing_type, legal_type) -> Err
msg = []
memoize_names = []

# For incorporation applications, at least one share class is required, for Alteration can not include if not changing
if filing_type == Filing.FilingTypes.INCORPORATIONAPPLICATION.value and len(share_classes) == 0:
msg.append({
"error": "A company must have at least one Class of Shares.",
"path": f"/filing/{filing_type}/shareStructure/shareClasses"
})
return msg

for index, item in enumerate(share_classes):
shares_msg = validate_shares(item, memoize_names, filing_type, index, legal_type)
if shares_msg:
Expand All @@ -104,7 +108,15 @@ def validate_share_structure(incorporation_json, filing_type, legal_type) -> Err
return None


def validate_series(item, memoize_names, filing_type, index) -> Error:
def _series_name_has_reserved_words(series_name: str) -> bool:
"""Check if the series name contains reserved words (excluding the required suffix)."""
suffix_len = len(SHARE_NAME_SUFFIX)
name_without_suffix = series_name[:-suffix_len] if series_name.endswith(SHARE_NAME_SUFFIX) else series_name
series_name_words = name_without_suffix.lower().split()
return any(word in EXCLUDED_WORDS_FOR_SERIES for word in series_name_words)


def validate_series(item, memoize_names, filing_type, index) -> Error: # noqa: PLR0912
"""Validate shareStructure includes a wellformed series."""
msg = []
for series_index, series in enumerate(item.get("series", [])):
Expand All @@ -124,29 +136,73 @@ def validate_series(item, memoize_names, filing_type, index) -> Error:
"error": "Share series name cannot start or end with whitespace.",
"path": f"{err_path}/name/"
})

elif not series_name.endswith(SHARE_NAME_SUFFIX):
msg.append({
"error": f"Share series name '{series_name}' must end with '{SHARE_NAME_SUFFIX}'.",
"path": f"{err_path}/name/"
})

elif _series_name_has_reserved_words(series_name):
msg.append({
"error": "Share series name cannot contain the words 'share' or 'shares'.",
"path": f"{err_path}/name/"
})

elif series_name in memoize_names:
msg.append({"error": f"Share series {series_name} name already used in a share class or series.",
"path": err_path})
else:
memoize_names.append(series_name)


if series["hasMaximumShares"]:
if not series.get("maxNumberOfShares", None):
max_shares = series.get("maxNumberOfShares", None)
if max_shares is None:
msg.append({
"error": f"Share series {series['name']} must provide value for maximum number of shares",
"path": f"{err_path}/maxNumberOfShares"
})
elif not (isinstance(max_shares, int) and not isinstance(max_shares, bool)):
msg.append({
"error": "Must be a whole number",
"path": f"{err_path}/maxNumberOfShares"
})
elif max_shares <= 0:
msg.append({
"error": "Number must be greater than 0",
"path": f"{err_path}/maxNumberOfShares"
})
elif len(str(abs(max_shares))) >= MAX_SHARE_DIGITS:
msg.append({
"error": "Share series {} must provide value for maximum number of shares".format(series["name"]),
"error": "Number must be less than 16 digits",
"path": f"{err_path}/maxNumberOfShares"
})
elif item["hasMaximumShares"] and item.get("maxNumberOfShares", None) and \
int(series["maxNumberOfShares"]) > int(item["maxNumberOfShares"]):
# Check series shares do not exceed class shares
elif (
item["hasMaximumShares"]
and item.get("maxNumberOfShares", None)
and isinstance(item["maxNumberOfShares"], int)
and not isinstance(item["maxNumberOfShares"], bool)
and max_shares > item["maxNumberOfShares"]
):
msg.append({
"error": "Series {} share quantity must be less than or equal to that of its class {}".format(series["name"], item["name"]),
"error": f"Series {series['name']} share quantity must be less than or equal to that of its class {item['name']}",
"path": f"{err_path}/maxNumberOfShares"
})
return msg


def validate_shares(item, memoize_names, filing_type, index, legal_type) -> Error:
def _class_name_has_reserved_words(share_name: str) -> bool:
# Validate share class name does not contain reserved words (excluding the required suffix)
# Remove the suffix before checking for reserved words
suffix_len = len(SHARE_NAME_SUFFIX)
name_without_suffix = share_name[:-suffix_len] if share_name.endswith(SHARE_NAME_SUFFIX) else share_name
name_words = name_without_suffix.lower().split()
return any(word in EXCLUDED_WORDS_FOR_CLASS for word in name_words)


def validate_shares(item, memoize_names, filing_type, index, legal_type) -> Error: # noqa: PLR0912
"""Validate a wellformed share structure."""
msg = []

Expand All @@ -166,6 +222,20 @@ def validate_shares(item, memoize_names, filing_type, index, legal_type) -> Erro
"error": "Share class name cannot start or end with whitespace.",
"path": err_path
})

elif not share_name.endswith(SHARE_NAME_SUFFIX):
err_path = f"/filing/{filing_type}/shareClasses/{index}/name/"
msg.append({
"error": f"Share class name '{share_name}' must end with '{SHARE_NAME_SUFFIX}'.",
"path": err_path
})

elif _class_name_has_reserved_words(share_name):
err_path = f"/filing/{filing_type}/shareClasses/{index}/name/"
msg.append({
"error": "Share class name cannot contain the words 'share', 'shares', or 'value'.",
"path": err_path
})

elif share_name in memoize_names:
err_path = f"/filing/{filing_type}/shareClasses/{index}/name/"
Expand All @@ -174,10 +244,29 @@ def validate_shares(item, memoize_names, filing_type, index, legal_type) -> Erro
else:
memoize_names.append(share_name)

if item["hasMaximumShares"] and not item.get("maxNumberOfShares", None):
if item["hasMaximumShares"]:
max_shares = item.get("maxNumberOfShares", None)
err_path = f"/filing/{filing_type}/shareClasses/{index}/maxNumberOfShares/"
msg.append({"error": "Share class {} must provide value for maximum number of shares".format(item["name"]),
"path": err_path})
if max_shares is None:
msg.append({
"error": f"Share class {item['name']} must provide value for maximum number of shares",
"path": err_path
})
elif not (isinstance(max_shares, int) and not isinstance(max_shares, bool)):
msg.append({
"error": "Must be a whole number",
"path": err_path
})
elif max_shares <= 0:
msg.append({
"error": "Number must be greater than 0",
"path": err_path
})
elif len(str(abs(max_shares))) >= MAX_SHARE_DIGITS:
msg.append({
"error": "Number must be less than 16 digits",
"path": err_path
})
if item["hasParValue"]:
if not item.get("parValue", None):
err_path = f"/filing/{filing_type}/shareClasses/{index}/parValue/"
Expand Down
4 changes: 2 additions & 2 deletions legal-api/tests/unit/models/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ def factory_share_class(business_identifier: str):
"""Create a share class."""
business = factory_business(business_identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1000,
Expand All @@ -373,7 +373,7 @@ def factory_share_class(business_identifier: str):
business_id=business.id
)
share_series_1 = ShareSeries(
name='Share Series 1',
name='Series 1 Shares',
priority=1,
max_share_flag=True,
max_shares=500,
Expand Down
12 changes: 6 additions & 6 deletions legal-api/tests/unit/models/test_share_class.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def test_valid_share_class_save(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1000,
Expand All @@ -50,7 +50,7 @@ def test_share_class_json(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1000,
Expand Down Expand Up @@ -81,7 +81,7 @@ def test_invalid_share_quantity(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=None,
Expand All @@ -105,7 +105,7 @@ def test_invalid_par_value(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1000,
Expand All @@ -129,7 +129,7 @@ def test_share_class_currency(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1000,
Expand All @@ -153,7 +153,7 @@ def test_find_by_share_class_id(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1000,
Expand Down
22 changes: 11 additions & 11 deletions legal-api/tests/unit/models/test_share_series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def test_valid_share_series_save(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1000,
Expand All @@ -42,14 +42,14 @@ def test_valid_share_series_save(session):
business_id=business.id
)
share_series_1 = ShareSeries(
name='Share Series 1',
name='Series 1 Shares',
priority=1,
max_share_flag=True,
max_shares=500,
special_rights_flag=False
)
share_series_2 = ShareSeries(
name='Share Series 2',
name='Series 2 Shares',
priority=2,
max_share_flag=True,
max_shares=1000,
Expand All @@ -67,7 +67,7 @@ def test_share_series_json(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1000,
Expand All @@ -78,7 +78,7 @@ def test_share_series_json(session):
business_id=business.id
)
share_series_1 = ShareSeries(
name='Share Series 1',
name='Series 1 Shares',
priority=1,
max_share_flag=True,
max_shares=500,
Expand Down Expand Up @@ -116,7 +116,7 @@ def test_invalid_share_quantity(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1000,
Expand All @@ -127,7 +127,7 @@ def test_invalid_share_quantity(session):
business_id=business.id
)
share_series_1 = ShareSeries(
name='Share Series 1',
name='Series 1 Shares',
priority=1,
max_share_flag=True,
max_shares=None,
Expand All @@ -150,7 +150,7 @@ def test_validate_share_quantity_not_exceed_class_value(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1000,
Expand All @@ -161,7 +161,7 @@ def test_validate_share_quantity_not_exceed_class_value(session):
business_id=business.id
)
share_series_1 = ShareSeries(
name='Share Series 1',
name='Series 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1500,
Expand All @@ -184,7 +184,7 @@ def test_share_quantity_when_no_max_share_for_parent(session):
identifier = 'CP1234567'
business = factory_business(identifier)
share_class = ShareClass(
name='Share Class 1',
name='Class 1 Shares',
priority=1,
max_share_flag=False,
max_shares=None,
Expand All @@ -195,7 +195,7 @@ def test_share_quantity_when_no_max_share_for_parent(session):
business_id=business.id
)
share_series_1 = ShareSeries(
name='Share Series 1',
name='Series 1 Shares',
priority=1,
max_share_flag=True,
max_shares=1500,
Expand Down
Loading