wbcompliance 2.2.1__py2.py3-none-any.whl

wbcompliance/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"

wbcompliance/admin/__init__.py

@@ -0,0 +1,16 @@
+from .compliance_form import (
+    ComplianceFormAdmin,
+    ComplianceFormRuleAdmin,
+    ComplianceFormSectionAdmin,
+    ComplianceFormSignatureAdmin,
+    ComplianceFormSignatureRuleAdmin,
+    ComplianceFormSignatureSectionAdmin,
+    ComplianceFormTypeAdmin,
+)
+from .compliance_task import (
+    ComplianceActionAdmin,
+    ComplianceEventAdmin,
+    ReviewComplianceTaskAdmin,
+)
+from .compliance_type import ComplianceTypeAdmin
+from .risk_management import *

wbcompliance/admin/compliance_form.py

@@ -0,0 +1,56 @@
+from django.contrib import admin
+from reversion_compare.admin import CompareVersionAdmin
+from wbcompliance.models import (
+    ComplianceForm,
+    ComplianceFormRule,
+    ComplianceFormSection,
+    ComplianceFormSignature,
+    ComplianceFormSignatureRule,
+    ComplianceFormSignatureSection,
+    ComplianceFormType,
+)
+
+
+@admin.register(ComplianceFormType)
+class ComplianceFormTypeAdmin(CompareVersionAdmin):
+    list_display = ["name", "type"]
+
+
+@admin.register(ComplianceForm)
+class ComplianceFormAdmin(CompareVersionAdmin):
+    list_display = ["status", "creator", "created", "title"]
+
+    autocomplete_fields = ["creator"]
+
+    def reversion_register(self, model, **options):
+        options = {
+            "ignore_duplicates": True,
+        }
+        super().reversion_register(model, **options)
+
+
+@admin.register(ComplianceFormSignature)
+class ComplianceFormSignatureAdmin(CompareVersionAdmin):
+    list_display = ["compliance_form", "version", "signed", "person"]
+
+    autocomplete_fields = ["person"]
+
+
+@admin.register(ComplianceFormSection)
+class ComplianceFormSectionAdmin(CompareVersionAdmin):
+    list_display = ["compliance_form", "name"]
+
+
+@admin.register(ComplianceFormRule)
+class ComplianceFormRuleAdmin(CompareVersionAdmin):
+    list_display = ["section", "text", "ticked"]
+
+
+@admin.register(ComplianceFormSignatureSection)
+class ComplianceFormSignatureSectionAdmin(CompareVersionAdmin):
+    list_display = ["compliance_form_signature", "name"]
+
+
+@admin.register(ComplianceFormSignatureRule)
+class ComplianceFormSignatureRuleAdmin(CompareVersionAdmin):
+    list_display = ["section", "text", "ticked", "comments"]

wbcompliance/admin/compliance_task.py

@@ -0,0 +1,135 @@
+import pandas as pd
+from django.contrib import admin
+from reversion_compare.admin import CompareVersionAdmin
+from wbcompliance.models import (
+    ComplianceAction,
+    ComplianceEvent,
+    ComplianceTask,
+    ComplianceTaskGroup,
+    ComplianceTaskInstance,
+    ComplianceType,
+    ReviewComplianceTask,
+)
+from wbcore.admin import ExportCsvMixin
+
+from .utils import CustomImportCsvMixin
+
+
+@admin.register(ComplianceTaskGroup)
+class ComplianceTaskGroupAdmin(ExportCsvMixin, CustomImportCsvMixin, CompareVersionAdmin):
+    list_display = ["name", "order"]
+
+    def manipulate_df(self, df):
+        df["name"] = df["name"].fillna("")
+        return df
+
+    def get_import_fields(self):
+        return [
+            "name",
+        ]
+
+    def process_model(self, model):
+        if model.get("name"):
+            _, created = self.model.objects.get_or_create(name=model.get("name"))
+            return 1 if created else 0
+        return 0
+
+
+@admin.register(ComplianceTask)
+class ComplianceTaskAdmin(ExportCsvMixin, CustomImportCsvMixin, CompareVersionAdmin):
+    list_display = ["title", "occurrence", "active", "risk_level", "group", "type"]
+
+    def manipulate_df(self, df):
+        df["type"] = df["type_name"].apply(lambda x: ComplianceType.objects.filter(name__exact=x).first())
+        df["group"] = df.apply(
+            lambda x: ComplianceTaskGroup.objects.filter(name__exact=x["group_name"]).first(), axis=1
+        )
+        return df
+
+    def get_import_fields(self):
+        return ["type_name", "group_name", "occurrence", "title", "description"]
+
+    def process_model(self, model):
+        if model.get("title"):
+            _, created = self.model.objects.update_or_create(
+                title=model.get("title"),
+                defaults={
+                    "type": model.get("type"),
+                    "group": model.get("group"),
+                    "occurrence": model.get("occurrence"),
+                    # 'description': model.get('description')
+                },
+            )
+            return 1 if created else 0
+        return 0
+
+
+@admin.register(ComplianceTaskInstance)
+class ComplianceTaskInstanceAdmin(ExportCsvMixin, CustomImportCsvMixin, CompareVersionAdmin):
+    list_display = ["task", "occured", "status"]
+
+    def manipulate_df(self, df):
+        df["task"] = df.apply(lambda x: ComplianceTask.objects.filter(title__exact=x["task_name"]).first(), axis=1)
+        df["occured"] = pd.to_datetime(df["occured"])
+        return df
+
+    def get_import_fields(self):
+        return ["task_name", "occured", "status", "text"]
+
+    def process_model(self, model):
+        if (task := model.get("task")) and (occured := model.get("occured")):
+            obj, created = self.model.objects.update_or_create(
+                task=task,
+                occured=occured,
+                defaults={
+                    "status": model.get("status"),
+                    "text": model.get("text"),
+                },
+            )
+            if created:
+                obj.occured = occured
+                obj.save()
+
+            return 1 if created else 0
+        return 0
+
+
+@admin.register(ComplianceAction)
+class ComplianceActionAdmin(CompareVersionAdmin):
+    search_fields = ["title"]
+    list_display = [
+        "title",
+        "deadline",
+        "progress",
+        "status",
+        "type",
+        "creator",
+        "created",
+        "changer",
+        "last_modified",
+    ]
+
+
+@admin.register(ComplianceEvent)
+class ComplianceEventAdmin(CompareVersionAdmin):
+    search_fields = ["title"]
+    list_display = ["title", "type", "level", "type", "confidential", "creator", "created", "changer", "last_modified"]
+
+
+@admin.register(ReviewComplianceTask)
+class ReviewComplianceTaskAdmin(CompareVersionAdmin):
+    list_display = [
+        "id",
+        "year",
+        "title",
+        "from_date",
+        "to_date",
+        "status",
+        "occurrence",
+        "is_instance",
+        "changer",
+        "changed",
+        "review_task",
+        "occured",
+    ]
+    search_fields = ["title"]

wbcompliance/admin/compliance_type.py

@@ -0,0 +1,8 @@
+from django.contrib import admin
+from reversion_compare.admin import CompareVersionAdmin
+from wbcompliance.models import ComplianceType
+
+
+@admin.register(ComplianceType)
+class ComplianceTypeAdmin(CompareVersionAdmin):
+    list_display = ["name"]

wbcompliance/admin/risk_management/__init__.py

@@ -0,0 +1,3 @@
+from .checks import RiskCheckModelAdmin
+from .incidents import RiskIncidentModelAdmin
+from .rules import RiskRuleModelAdmin, RuleBackendModelAdmin

wbcompliance/admin/risk_management/checks.py

@@ -0,0 +1,7 @@
+from django.contrib import admin
+from wbcompliance.models.risk_management.checks import RiskCheck
+
+
+@admin.register(RiskCheck)
+class RiskCheckModelAdmin(admin.ModelAdmin):
+    list_display = ["rule_checked_object_relationship", "creation_datetime", "evaluation_date"]

wbcompliance/admin/risk_management/incidents.py

@@ -0,0 +1,50 @@
+from django.contrib import admin
+from wbcompliance.models.risk_management.incidents import (
+    CheckedObjectIncidentRelationship,
+    RiskIncident,
+    RiskIncidentType,
+)
+
+
+class CheckedObjectIncidentRelationshipInLine(admin.TabularInline):
+    model = CheckedObjectIncidentRelationship
+    fields = ["status", "severity", "incident", "rule_check", "breached_value", "report_details", "report"]
+    extra = 0
+    raw_id_fields = ["incident", "rule_check"]
+    readonly_fields = ["status", "severity", "incident", "rule_check"]
+
+
+class IncidentInLine(admin.TabularInline):
+    show_change_link = True
+    model = RiskIncident
+    fields = ["status", "severity", "date_range", "breached_content_type", "breached_object_id"]
+    extra = 0
+
+
+@admin.register(RiskIncidentType)
+class RiskIncidentTypeModelAdmin(admin.ModelAdmin):
+    list_display = [
+        "name",
+        "severity_order",
+        "color",
+        "is_ignorable",
+        "is_automatically_closed",
+        "is_informational",
+    ]
+
+
+@admin.register(RiskIncident)
+class RiskIncidentModelAdmin(admin.ModelAdmin):
+    list_display = [
+        "status",
+        "severity",
+        "date_range",
+        "rule",
+        "breached_content_type",
+        "breached_object_id",
+        "resolved_by",
+    ]
+
+    inlines = [
+        CheckedObjectIncidentRelationshipInLine,
+    ]

wbcompliance/admin/risk_management/rules.py

@@ -0,0 +1,63 @@
+from django.contrib import admin
+from guardian.admin import GuardedModelAdmin
+from wbcompliance.models.risk_management.rules import (
+    RiskRule,
+    RuleBackend,
+    RuleCheckedObjectRelationship,
+    RuleGroup,
+    RuleThreshold,
+)
+
+from .incidents import IncidentInLine
+
+
+class RuleThresholdInLine(admin.TabularInline):
+    model = RuleThreshold
+    fields = ["range", "severity", "notifiable_users", "notifiable_groups"]
+    extra = 0
+    autocomplete_fields = ["notifiable_users"]
+    raw_id_fields = ["notifiable_users", "notifiable_groups", "rule"]
+
+
+class RuleCheckedObjectRelationshipInLine(admin.TabularInline):
+    model = RuleCheckedObjectRelationship
+    fields = [
+        "checked_object_content_type",
+        "checked_object_id",
+    ]
+    extra = 0
+    raw_id_fields = ["checked_object_content_type", "rule"]
+
+
+@admin.register(RuleGroup)
+class RuleGroupModelAdmin(admin.ModelAdmin):
+    list_display = [
+        "key",
+        "name",
+    ]
+
+
+@admin.register(RuleBackend)
+class RuleBackendModelAdmin(admin.ModelAdmin):
+    list_display = [
+        "name",
+        "rule_group",
+        "backend_class_path",
+        "backend_class_name",
+        "allowed_checked_object_content_type",
+    ]
+    raw_id_fields = ["allowed_checked_object_content_type"]
+
+
+@admin.register(RiskRule)
+class RiskRuleModelAdmin(GuardedModelAdmin):
+    list_display = [
+        "name",
+        "rule_backend",
+        "is_enable",
+        "only_passive_check_allowed",
+        "is_silent",
+        "is_mandatory",
+        "parameters",
+    ]
+    inlines = [RuleThresholdInLine, IncidentInLine, RuleCheckedObjectRelationshipInLine]

wbcompliance/admin/utils.py

@@ -0,0 +1,46 @@
+from io import StringIO
+
+import pandas as pd
+from django.shortcuts import redirect, render
+from reversion.errors import RevertError
+from wbcore.admin import CsvImportForm, ImportCsvMixin
+
+
+class CustomImportCsvMixin(ImportCsvMixin):
+    def _import_csv(self, request, _sep=";"):
+        if request.method == "POST":
+            csv_file = request.FILES["csv_file"]
+
+            str_text = ""
+            for line in csv_file:
+                str_text = str_text + line.decode()
+            # Import csv as df
+            df = pd.read_csv(StringIO(str_text), sep=_sep)
+            # Sanitize dataframe
+            df = df.where(pd.notnull(df), None)
+            df = df.drop(df.columns.difference(self.get_import_fields()), axis=1)
+
+            # Overide this function if there is foreign key ids in the dataframe
+            df = self.manipulate_df(df)
+            errors = 0
+            revert_errors = 0
+            nb_added = 0
+            for model in df.to_dict("records"):
+                # by default, process the modela as a create request. Can be override to change the behavior
+                try:
+                    nb_added += self.process_model(model)
+                # https://django-reversion.readthedocs.io/en/stable/common-problems.html
+                except RevertError:
+                    revert_errors += 1
+                except Exception as e:
+                    print(e)  # noqa: T201
+                    errors += 1
+            msg = f"""Your csv file has been imported : {df.shape[0] - errors - revert_errors} imported
+                 ({nb_added} added, {df.shape[0] - errors - revert_errors - nb_added} updated), {errors} errors,
+                 {revert_errors} revert errors found due to failure to restore old versions
+            """
+            self.message_user(request, msg)
+            return redirect("..")
+        form = CsvImportForm()
+        payload = {"form": form}
+        return render(request, "wbcore/admin/csv_form.html", payload)

wbcompliance/apps.py

@@ -0,0 +1,14 @@
+from django.apps import AppConfig
+from django.db.models.signals import post_migrate
+from wbcompliance.management import autodiscover_riskmanagement_backends
+
+
+class WbcomplianceConfig(AppConfig):
+    name = "wbcompliance"
+
+    #
+    def ready(self) -> None:
+        post_migrate.connect(
+            autodiscover_riskmanagement_backends,
+            dispatch_uid="wbcrm.synchronization.initialize_task",
+        )

wbcompliance/factories/__init__.py

@@ -0,0 +1,21 @@
+from .compliance import (
+    ComplianceActionFactory,
+    ComplianceEventFactory,
+    ComplianceFormFactory,
+    ComplianceFormRuleFactory,
+    ComplianceFormSectionFactory,
+    ComplianceFormSignatureFactory,
+    ComplianceFormSignatureRuleFactory,
+    ComplianceFormSignatureSectionFactory,
+    ComplianceFormTypeFactory,
+    ComplianceTaskFactory,
+    ComplianceTaskGroupFactory,
+    ComplianceTaskInstanceFactory,
+    ComplianceTaskInstanceReviewFactory,
+    ComplianceTaskInstanceReviewNoGroupFactory,
+    ComplianceTaskReviewFactory,
+    ComplianceTaskReviewNoGroupFactory,
+    ComplianceTypeFactory,
+    UnsignedComplianceFormSignatureFactory,
+)
+from .risk_management import *

wbcompliance/factories/compliance.py

@@ -0,0 +1,246 @@
+import factory
+import pytz
+from wbcompliance.models import (
+    ComplianceAction,
+    ComplianceEvent,
+    ComplianceForm,
+    ComplianceFormRule,
+    ComplianceFormSection,
+    ComplianceFormSignature,
+    ComplianceFormSignatureRule,
+    ComplianceFormSignatureSection,
+    ComplianceFormType,
+    ComplianceTask,
+    ComplianceTaskGroup,
+    ComplianceTaskInstance,
+    ComplianceType,
+    ReviewComplianceTask,
+)
+
+
+class ComplianceFormTypeFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceFormType
+
+    name = factory.Faker("text", max_nb_chars=32)
+
+
+class ComplianceFormFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceForm
+
+    form_type = factory.SubFactory(ComplianceFormTypeFactory)
+    creator = factory.SubFactory("wbcore.contrib.authentication.factories.AuthenticatedPersonFactory")
+    created = factory.Faker("date_time", tzinfo=pytz.utc)
+    changer = factory.SubFactory("wbcore.contrib.authentication.factories.AuthenticatedPersonFactory")
+    changed = factory.Faker("date_time", tzinfo=pytz.utc)
+    title = factory.Faker("text", max_nb_chars=64)
+    policy = factory.Faker("paragraph", nb_sentences=5)
+    only_internal = factory.Faker("pybool")
+    start = factory.Faker("date_between", start_date="+2d", end_date="+3d")
+    end = factory.Faker("date_between", start_date="+4d", end_date="+5d")
+    compliance_type = factory.SubFactory("wbcompliance.factories.ComplianceTypeFactory")
+
+    @factory.post_generation
+    def assigned_to(self, create, extracted, **kwargs):
+        if not create:
+            return
+
+        if extracted:
+            for group in extracted:
+                self.assigned_to.add(group)
+
+
+class UnsignedComplianceFormSignatureFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceFormSignature
+
+    compliance_form = factory.SubFactory(ComplianceFormFactory)
+    policy = factory.Faker("paragraph", nb_sentences=5)
+    person = factory.SubFactory("wbcore.contrib.authentication.factories.AuthenticatedPersonFactory")
+    remark = factory.Faker("paragraph", nb_sentences=5)
+    start = factory.Faker("date_between", start_date="+2d", end_date="+3d")
+    end = factory.Faker("date_between", start_date="+4d", end_date="+5d")
+
+
+class ComplianceFormSignatureFactory(UnsignedComplianceFormSignatureFactory):
+    signed = factory.Faker("date_time", tzinfo=pytz.utc)
+
+
+class ComplianceFormSectionFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceFormSection
+
+    compliance_form = factory.SubFactory(ComplianceFormFactory)
+    name = factory.Faker("text", max_nb_chars=32)
+
+
+class ComplianceFormRuleFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceFormRule
+
+    section = factory.SubFactory(ComplianceFormSectionFactory)
+    text = factory.Faker("text", max_nb_chars=255)
+
+
+class ComplianceFormSignatureSectionFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceFormSignatureSection
+
+    compliance_form_signature = factory.SubFactory(UnsignedComplianceFormSignatureFactory)
+    name = factory.Faker("text", max_nb_chars=32)
+
+
+class ComplianceFormSignatureRuleFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceFormSignatureRule
+
+    section = factory.SubFactory(ComplianceFormSignatureSectionFactory)
+    text = factory.Faker("text", max_nb_chars=255)
+
+
+class ComplianceTypeFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceType
+
+    name = factory.Faker("text", max_nb_chars=32)
+    description = factory.Faker("text", max_nb_chars=255)
+
+    @factory.post_generation
+    def in_charge(self, create, extracted, **kwargs):
+        if not create:
+            return
+
+        if extracted:
+            for group in extracted:
+                self.in_charge.add(group)
+
+
+class ComplianceTaskGroupFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceTaskGroup
+
+    name = factory.Faker("text", max_nb_chars=32)
+    order = factory.Faker("pyint", min_value=0, max_value=9999)
+
+
+class ParentReviewComplianceTaskFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ReviewComplianceTask
+
+    title = factory.Faker("text", max_nb_chars=32)
+    from_date = factory.Faker("date_between", start_date="+2d", end_date="+3d")
+    to_date = factory.Faker("date_between", start_date="+4d", end_date="+5d")
+    description = factory.Faker("text", max_nb_chars=255)
+    year = factory.Faker("year")
+    creator = factory.SubFactory("wbcore.contrib.authentication.factories.AuthenticatedPersonFactory")
+    created = factory.Faker("date_time", tzinfo=pytz.utc)
+    changer = factory.SubFactory("wbcore.contrib.authentication.factories.AuthenticatedPersonFactory")
+    changed = factory.Faker("date_time", tzinfo=pytz.utc)
+    review_task = None
+    occured = factory.Faker("date")
+    type = factory.SubFactory("wbcompliance.factories.ComplianceTypeFactory")
+
+
+class ReviewComplianceTaskFactory(ParentReviewComplianceTaskFactory):
+    class Meta:
+        model = ReviewComplianceTask
+
+    review_task = factory.SubFactory(ParentReviewComplianceTaskFactory)
+
+
+class ComplianceTaskFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceTask
+
+    title = factory.Faker("text", max_nb_chars=32)
+    description = factory.Faker("text", max_nb_chars=255)
+    group = factory.SubFactory(ComplianceTaskGroupFactory)
+    type = factory.SubFactory(ComplianceTypeFactory)
+    risk_level = "LOW"
+    remarks = factory.Faker("text", max_nb_chars=255)
+
+    @factory.post_generation
+    def review(self, create, extracted, **kwargs):
+        if not create:
+            return
+
+        if extracted:
+            for item in extracted:
+                self.review.add(item)
+
+
+class ComplianceTaskReviewFactory(ComplianceTaskFactory):
+    @factory.post_generation
+    def review(self, create, extracted, **kwargs):
+        review = ReviewComplianceTaskFactory()
+        self.review.add(review)
+
+
+class ComplianceTaskReviewNoGroupFactory(ComplianceTaskReviewFactory):
+    group = None
+
+
+class ComplianceTaskInstanceFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceTaskInstance
+
+    text = factory.Faker("text", max_nb_chars=255)
+    summary_text = factory.Faker("text", max_nb_chars=255)
+    task = factory.SubFactory(ComplianceTaskFactory)
+
+    @factory.post_generation
+    def review(self, create, extracted, **kwargs):
+        if not create:
+            return
+
+        if extracted:
+            for item in extracted:
+                self.review.add(item)
+
+
+class ComplianceTaskInstanceReviewFactory(ComplianceTaskInstanceFactory):
+    @factory.post_generation
+    def review(self, create, extracted, **kwargs):
+        review = ReviewComplianceTaskFactory()
+        self.review.add(review)
+
+
+class ComplianceTaskInstanceReviewNoGroupFactory(ComplianceTaskInstanceFactory):
+    @factory.post_generation
+    def review(self, create, extracted, **kwargs):
+        self.task.group = None
+        review = ReviewComplianceTaskFactory()
+        self.review.add(review)
+        self.task.save()
+
+
+class ComplianceActionFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceAction
+
+    title = factory.Faker("text", max_nb_chars=32)
+    description = factory.Faker("text", max_nb_chars=255)
+    summary_description = factory.Faker("text", max_nb_chars=255)
+    deadline = factory.Faker("date_between", start_date="+2d", end_date="+3d")
+    type = factory.SubFactory(ComplianceTypeFactory)
+    creator = factory.SubFactory("wbcore.contrib.authentication.factories.AuthenticatedPersonFactory")
+    created = factory.Faker("date_time", tzinfo=pytz.utc)
+    changer = factory.SubFactory("wbcore.contrib.authentication.factories.AuthenticatedPersonFactory")
+
+
+class ComplianceEventFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ComplianceEvent
+
+    title = factory.Faker("text", max_nb_chars=32)
+    exec_summary = factory.Faker("text", max_nb_chars=255)
+    exec_summary_board = factory.Faker("text", max_nb_chars=255)
+    description = factory.Faker("text", max_nb_chars=255)
+    actions_taken = factory.Faker("text", max_nb_chars=255)
+    consequences = factory.Faker("text", max_nb_chars=255)
+    future_suggestions = factory.Faker("text", max_nb_chars=255)
+    type = factory.SubFactory(ComplianceTypeFactory)
+    creator = factory.SubFactory("wbcore.contrib.authentication.factories.AuthenticatedPersonFactory")
+    created = factory.Faker("date_time", tzinfo=pytz.utc)
+    changer = factory.SubFactory("wbcore.contrib.authentication.factories.AuthenticatedPersonFactory")