Merge pull request #213 from dinesh-aot/regulatory_fix

Regulatory fix

Author: nitheesh-aot

compliance-api/Makefile

@@ -68,7 +68,7 @@ install-dev: ## Install local application
 ci: lint flake8 test ## CI flow
 
 pylint: ## Linting with pylint
-	. venv/bin/activate && pylint --rcfile=setup.cfg  src/$(PROJECT_NAME)
+	. venv/bin/activate && pylint --rcfile=setup.cfg --persistent=yes --jobs=4 src/$(PROJECT_NAME)
 
 flake8: ## Linting with flake8
 	. venv/bin/activate && flake8 --ignore=Q000,W503 src/$(PROJECT_NAME) tests

compliance-api/migrations/versions/88ed0885be9e_inspection_requirement_chagne_for_.py

@@ -0,0 +1,51 @@
+"""inspection requirement chagne for regulatory considerations
+
+Revision ID: 88ed0885be9e
+Revises: c42e6b5815dd
+Create Date: 2025-01-29 21:22:17.966961
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '88ed0885be9e'
+down_revision = 'c42e6b5815dd'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    inspectionrequirementtypeenum = sa.Enum('REQ', 'REG', name='inspectionrequirementtypeenum')
+    inspectionrequirementtypeenum.create(op.get_bind())
+    with op.batch_alter_table('inspection_requirements', schema=None) as batch_op:
+        batch_op.add_column(sa.Column('agency_id', sa.Integer(), nullable=True, comment='Associated agency if the type is regulatory consideration'))
+        batch_op.add_column(sa.Column('req_type', sa.Enum('REQ', 'REG', name='inspectionrequirementtypeenum'), nullable=True))
+        batch_op.create_foreign_key('inspection_req_agency_id', 'agencies', ['agency_id'], ['id'])
+
+    with op.batch_alter_table('inspection_requirements_version', schema=None) as batch_op:
+        batch_op.add_column(sa.Column('agency_id', sa.Integer(), autoincrement=False, nullable=True, comment='Associated agency if the type is regulatory consideration'))
+        batch_op.add_column(sa.Column('req_type', sa.Enum('REQ', 'REG', name='inspectionrequirementtypeenum'), autoincrement=False, nullable=True))
+        batch_op.add_column(sa.Column('agency_id_mod', sa.Boolean(), server_default=sa.text('false'), nullable=False))
+        batch_op.add_column(sa.Column('req_type_mod', sa.Boolean(), server_default=sa.text('false'), nullable=False))
+    op.execute("UPDATE inspection_requirements SET req_type='REQ'")
+    op.alter_column('inspection_requirements', 'req_type', nullable=False)
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('inspection_requirements_version', schema=None) as batch_op:
+        batch_op.drop_column('req_type_mod')
+        batch_op.drop_column('agency_id_mod')
+        batch_op.drop_column('req_type')
+        batch_op.drop_column('agency_id')
+
+    with op.batch_alter_table('inspection_requirements', schema=None) as batch_op:
+        batch_op.drop_constraint('inspection_req_agency_id', type_='foreignkey')
+        batch_op.drop_column('req_type')
+        batch_op.drop_column('agency_id')
+
+    # ### end Alembic commands ###

compliance-api/requirements.txt

@@ -29,7 +29,7 @@
     Inspection, InspectionAgency, InspectionAttendance, InspectionAttendanceOption, InspectionAttendanceOptionEnum,
     InspectionFirstnation, InspectionInitiationOption, InspectionOfficer, InspectionOtherAttendance,
     InspectionReqDetailDocument, InspectionReqEnforcementMap, InspectionReqSourceDetail, InspectionRequirement,
-    InspectionStatusEnum, InspectionType, InspectionTypeOption, IRStatusOption)
+    InspectionRequirementTypeEnum, InspectionStatusEnum, InspectionType, InspectionTypeOption, IRStatusOption)
 from .position import Position
 from .project import Project
 from .req_source_document_map import RequirementSourceDocumentMap

compliance-api/src/compliance_api/models/__init__.py

@@ -12,5 +12,5 @@
 from .inspection_req_detail_doc import InspectionReqDetailDocument
 from .inspection_req_enforcement_map import InspectionReqEnforcementMap
 from .inspection_req_source_detail import InspectionReqSourceDetail
-from .inspection_requirement import InspectionRequirement
+from .inspection_requirement import InspectionRequirement, InspectionRequirementTypeEnum
 from .inspection_type import InspectionType

compliance-api/src/compliance_api/models/inspection/__init__.py

@@ -1,13 +1,22 @@
 """InspectionRequirement Model."""
 
-from sqlalchemy import Boolean, Column, ForeignKey, Integer, String
+import enum
+
+from sqlalchemy import Boolean, Column, Enum, ForeignKey, Integer, String
 from sqlalchemy.orm import relationship
 
 from compliance_api.utils.constant import DELETE_DIC_PARAMS
 
 from ..base_model import BaseModelVersioned, db
 
 
+class InspectionRequirementTypeEnum(enum.Enum):
+    """Type of inspection requirements."""
+
+    REQ = "Requirement"
+    REG = "Regulatory Consideration"
+
+
 class InspectionRequirement(BaseModelVersioned):
     """InspectionRequirementModel."""
 
@@ -32,6 +41,17 @@ class InspectionRequirement(BaseModelVersioned):
         nullable=False,
         comment="The topic of the requirement",
     )
+    agency_id = Column(
+        Integer,
+        ForeignKey("agencies.id", name="inspection_req_agency_id"),
+        nullable=True,
+        comment="Associated agency if the type is regulatory consideration",
+    )
+    req_type = Column(
+        Enum(InspectionRequirementTypeEnum),
+        nullable=False,
+        default=InspectionRequirementTypeEnum.REG,
+    )
     compliance_finding_id = Column(
         Integer,
         ForeignKey(
@@ -50,6 +70,9 @@ class InspectionRequirement(BaseModelVersioned):
     compliance_finding = relationship(
         "ComplianceFindingOption", foreign_keys=[compliance_finding_id], lazy="joined"
     )
+    agency = relationship(
+        "Agency", foreign_keys=[agency_id], lazy="joined"
+    )
     requirement_source_details = relationship(
         "InspectionReqSourceDetail",
         back_populates="inspection_requirement",

compliance-api/src/compliance_api/models/inspection/inspection_requirement.py

@@ -33,6 +33,7 @@
 from .enforcement_action import API as ENFORCEMENT_ACTION_API
 from .inspection import API as INSPECTION_API
 from .inspection_requirement import API as INSPECTION_REQUIREMENT_API
+from .inspection_requirement_type import API as REQUIREMENT_TYPE_API
 from .ops import API as OPS_API
 from .position import API as POSITION_API
 from .project import API as PROJECT_API
@@ -87,5 +88,8 @@
 API.add_namespace(CONTINUATION_REPORT_API)
 API.add_namespace(ENFORCEMENT_ACTION_API)
 API.add_namespace(COMPLIANCE_FINDING_API)
-API.add_namespace(INSPECTION_REQUIREMENT_API, path="inspections/<int:inspection_id>/requirements")
+API.add_namespace(
+    INSPECTION_REQUIREMENT_API, path="inspections/<int:inspection_id>/requirements"
+)
 API.add_namespace(DOCUMENT_TYPE_API)
+API.add_namespace(REQUIREMENT_TYPE_API)

compliance-api/src/compliance_api/resources/__init__.py

@@ -0,0 +1,53 @@
+# Copyright © 2024 Province of British Columbia
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""API endpoints for managing Inspection Requirement Type."""
+
+from http import HTTPStatus
+
+from flask_restx import Namespace, Resource
+
+from compliance_api.auth import auth
+from compliance_api.schemas import KeyValueSchema
+from compliance_api.services import InspectionRequirementTypeService
+from compliance_api.utils.util import cors_preflight
+
+from .apihelper import Api as ApiHelper
+
+
+API = Namespace(
+    "inspection-requirement-types",
+    description="Endpoints for Inspection Requirement Type",
+)
+
+key_value_list_model = ApiHelper.convert_ma_schema_to_restx_model(
+    API, KeyValueSchema(), "List"
+)
+
+
+@cors_preflight("GET, OPTIONS, POST")
+@API.route("", methods=["POST", "GET", "OPTIONS"])
+class InspectionRequirementTypes(Resource):
+    """Resource for inspection requirement types."""
+
+    @staticmethod
+    @API.response(code=200, description="Success", model=[key_value_list_model])
+    @ApiHelper.swagger_decorators(
+        API, endpoint_description="Fetch all insection requirement types"
+    )
+    @auth.require
+    def get():
+        """Fetch all inspection requirement types."""
+        types = InspectionRequirementTypeService.get_inspection_requirement_types()
+        type_schema = KeyValueSchema(many=True)
+        return type_schema.dump(types), HTTPStatus.OK

compliance-api/src/compliance_api/resources/inspection_requirement_type.py

@@ -12,9 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Inspection requirement Schema Schema."""
-from marshmallow import EXCLUDE, ValidationError, fields, pre_dump, validates_schema
+from marshmallow import EXCLUDE, ValidationError, fields, post_dump, pre_dump, validates_schema
+from marshmallow_enum import EnumField
 
-from compliance_api.models import InspectionReqDetailDocument, InspectionReqSourceDetail, InspectionRequirement
+from compliance_api.models import (
+    EnforcementActionOptionEnum, InspectionReqDetailDocument, InspectionReqSourceDetail, InspectionRequirement,
+    InspectionRequirementTypeEnum)
 from compliance_api.models.requirement_source import RequirementSourceEnum
 
 from .base_schema import AutoSchemaBase, BaseSchema
@@ -153,6 +156,11 @@ class InspectionReqSourceDetailUpdateSchema(InspectionReqSourceDetailCreateSchem
 class InspectionRequirementCreateSchema(BaseSchema):
     """InspectionRequirementCreateSchema."""
 
+    req_type = EnumField(
+        InspectionRequirementTypeEnum,
+        metadata={"description": "The type of inspection requirement"},
+        required=True,
+    )
     summary = fields.Str(
         metadata={"description": "The summary of the requirement."}, required=True
     )
@@ -162,13 +170,20 @@ class InspectionRequirementCreateSchema(BaseSchema):
         },
         required=True,
     )
+    agency_id = fields.Int(
+        metadata={
+            "description": "The unique identifier of the agency only if the requirement"
+            "type is regulatory considerations"
+        },
+        allow_none=True,
+    )
     enforcement_action_ids = fields.List(
         fields.Int(metadata={"description": "The enforcement action identifier."}),
         allow_none=True,
     )
     compliance_finding_id = fields.Int(
         metadata={"description": "The unique identifier of the compliance findings."},
-        allow_none=True
+        allow_none=True,
     )
     findings = fields.Str(
         metadata={"description": "The requirement findings in html format."},
@@ -178,6 +193,29 @@ class InspectionRequirementCreateSchema(BaseSchema):
         fields.Nested(InspectionReqSourceDetailCreateSchema)
     )
 
+    @validates_schema
+    def validate_agency_id(
+        self, data, **kwargs
+    ):  # pylint: disable=no-self-use, unused-argument
+        """Validate the agency if the requirement type is regulatory considerations."""
+        req_type = data.get("req_type")
+        agency_id = data.get("agency_id", None)
+        if req_type == InspectionRequirementTypeEnum.REG and not agency_id:
+            raise ValidationError(
+                "Agency is required if the requirement type is Regulatory Consideration",
+                field_name="agency_id",
+            )
+        enforcement_action_ids = data.get("enforcement_action_ids")
+        if (
+            EnforcementActionOptionEnum.REFERRAL_TO_ANOTHER_AGENCY
+            in enforcement_action_ids
+            and not agency_id
+        ):
+            raise ValidationError(
+                "Agency is required if the enforcement actions include REFERRAL_TO_ANOTHER_AGENCY",
+                field_name="agency_id",
+            )
+
 
 class InspectionRequirementUpdateSchema(InspectionRequirementCreateSchema):
     """InspectionRequirementUpdateSchema."""
@@ -247,6 +285,7 @@ class Meta(AutoSchemaBase.Meta):  # pylint: disable=too-few-public-methods
     )
     topic = fields.Nested(KeyValueSchema)
     compliance_finding = fields.Nested(KeyValueSchema)
+    agency = fields.Nested(KeyValueSchema)
     enforcement_action_data = fields.List(fields.Nested(KeyValueSchema))
 
     @pre_dump
@@ -266,3 +305,14 @@ def pre_dump_enforcement_actions(
                     )
             obj.enforcement_action_data = prepared_enforcement_actions
         return obj
+
+    @post_dump
+    def nullify_nested(
+        self, data, **kwargs
+    ):  # pylint: disable=no-self-use, unused-argument
+        """Make nested objects null if the referenced ID is null."""
+        data["req_type"] = {
+            "id": data.get("req_type").name,
+            "name": data.get("req_type").value,
+        }
+        return data

compliance-api/src/compliance_api/schemas/inspection_requirement.py

@@ -21,6 +21,7 @@
 from .enforcement_action import EnforcementActionService
 from .inspection import InspectionService
 from .inspection_requirement import InspectionRequirementService
+from .inspection_requirement_type import InspectionRequirementTypeService
 from .position import PositionService
 from .project import ProjectService
 from .project_status import ProjectStatusService