Skip to content
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

v0.6.156 - Add issue identifiers #914

Merged
merged 3 commits into from
Feb 27, 2025
Merged

v0.6.156 - Add issue identifiers #914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b4d761
1789: Issue identifiers
ahernp Feb 26, 2025
1702f6b
1789: Don't use WCAG state field on 12-week retest pages
ahernp Feb 26, 2025
3b1d557
Merge pull request #890 from alphagov/1789-issue-id
ahernp Feb 27, 2025
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
20 changes: 16 additions & 4 deletions accessibility_monitoring_platform/apps/audits/admin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,14 @@ class CheckResultAdmin(admin.ModelAdmin):
"""Django admin configuration for CheckResult model"""

search_fields = [
"issue_identifier",
"audit__case__organisation_name",
"audit__case__case_number",
"wcag_definition__name",
"page__name",
"page__page_type",
]
list_display = ["__str__", "audit", "page"]
list_display = ["issue_identifier", "__str__", "audit", "page"]
list_filter = ["check_result_state"]


Expand All @@ -75,7 +76,14 @@ class StatementCheckAdmin(admin.ModelAdmin):
"""Django admin configuration for StatementCheck model"""

search_fields = ["label", "success_criteria", "report_text"]
list_display = ["label", "type", "position", "date_start", "date_end"]
list_display = [
"issue_number",
"label",
"type",
"position",
"date_start",
"date_end",
]
list_filter = ["type"]
fieldsets = (
(
Expand All @@ -97,12 +105,13 @@ class StatementCheckResultAdmin(admin.ModelAdmin):
"""Django admin configuration for StatementCheck model"""

search_fields = [
"issue_identifier",
"audit__case__organisation_name",
"statement_check__label",
"statement_check__success_criteria",
"statement_check__report_text",
]
list_display = ["statement_check", "audit", "is_deleted"]
list_display = ["issue_identifier", "statement_check", "audit", "is_deleted"]
list_filter = ["is_deleted", "check_result_state", "retest_state"]
fieldsets = (
(
Expand Down Expand Up @@ -154,12 +163,14 @@ class RetestCheckResultAdmin(admin.ModelAdmin):
"""Django admin configuration for RetestCheckResult model"""

search_fields = [
"issue_identifier",
"check_result__wcag_definition__name",
"retest__case__organisation_name",
"retest_page__page__name",
"retest_page__page__url",
]
list_display = [
"issue_identifier",
"check_result",
"retest",
"retest_page",
Expand All @@ -182,13 +193,14 @@ class RetestStatementCheckResultAdmin(admin.ModelAdmin):
"""Django admin configuration for RetestStatementCheckResult model"""

search_fields = [
"issue_identifier",
"retest__case__case_number",
"retest__case__organisation_name",
"statement_check__label",
"comment",
]
list_display = [
"id",
"issue_identifier",
"retest",
"type",
"check_result_state",
Expand Down
77 changes: 77 additions & 0 deletions ...itoring_platform/apps/audits/migrations/0012_retestcheckresult_id_within_case_and_more.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Generated by Django 5.1.4 on 2025-01-21 08:46

from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
("audits", "0011_remove_audit_accessibility_statement_backup_url_and_more"),
]

operations = [
migrations.AddField(
model_name="checkresult",
name="issue_identifier",
field=models.CharField(max_length=20, default=""),
),
migrations.AddField(
model_name="retestcheckresult",
name="id_within_case",
field=models.IntegerField(blank=True, default=0),
),
migrations.AddField(
model_name="retestcheckresult",
name="issue_identifier",
field=models.CharField(max_length=20, default=""),
),
migrations.AddField(
model_name="reteststatementcheckresult",
name="id_within_case",
field=models.IntegerField(blank=True, default=0),
),
migrations.AddField(
model_name="reteststatementcheckresult",
name="issue_identifier",
field=models.CharField(max_length=20, default=""),
),
migrations.AddField(
model_name="statementcheck",
name="issue_number",
field=models.IntegerField(blank=True, default=0),
),
migrations.AddField(
model_name="statementcheckresult",
name="id_within_case",
field=models.IntegerField(blank=True, default=0),
),
migrations.AddField(
model_name="statementcheckresult",
name="issue_identifier",
field=models.CharField(max_length=20, default=""),
),
migrations.AddIndex(
model_name="checkresult",
index=models.Index(
fields=["issue_identifier"], name="audits_chec_issue_i_a8fd9c_idx"
),
),
migrations.AddIndex(
model_name="retestcheckresult",
index=models.Index(
fields=["issue_identifier"], name="audits_rete_issue_i_4df993_idx"
),
),
migrations.AddIndex(
model_name="reteststatementcheckresult",
index=models.Index(
fields=["issue_identifier"], name="audits_rete_issue_i_a854a4_idx"
),
),
migrations.AddIndex(
model_name="statementcheckresult",
index=models.Index(
fields=["issue_identifier"], name="audits_stat_issue_i_d20fe4_idx"
),
),
]
94 changes: 94 additions & 0 deletions accessibility_monitoring_platform/apps/audits/migrations/0013_populate_ids_within_case.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Generated by Django 5.1.4 on 2025-01-21 08:48

from django.db import migrations

ISSUE_IDENTIFIER_WCAG: str = "A"
ISSUE_IDENTIFIER_STATEMENT: str = "S"
CUSTOM_ISSUE: str = "C"


def build_issue_identifier(case, issue, issue_type):
"""Format and return issue identifier"""
return f"{case.case_number}-{issue_type}-{issue.id_within_case}"


def populate_id_within_case(apps, schema_editor): # pylint: disable=unused-argument
Audit = apps.get_model("audits", "Audit")
CheckResult = apps.get_model("audits", "CheckResult")
StatementCheck = apps.get_model("audits", "StatementCheck")
StatementCheckResult = apps.get_model("audits", "StatementCheckResult")
Retest = apps.get_model("audits", "Retest")
RetestCheckResult = apps.get_model("audits", "RetestCheckResult")
RetestStatementCheckResult = apps.get_model("audits", "RetestStatementCheckResult")

issue_number = 0
for statement_check in StatementCheck.objects.all():
issue_number += 1
statement_check.issue_number = issue_number
statement_check.save()

for audit in Audit.objects.all():
for check_result in CheckResult.objects.filter(audit=audit):
check_result.issue_identifier = build_issue_identifier(
case=audit.case,
issue=check_result,
issue_type=ISSUE_IDENTIFIER_WCAG,
)
check_result.save()
id_within_case = 0

for statement_check_result in StatementCheckResult.objects.filter(audit=audit):
id_within_case += 1
statement_check_result.id_within_case = id_within_case
issue_type = ISSUE_IDENTIFIER_STATEMENT
if statement_check_result.statement_check is None:
issue_type += CUSTOM_ISSUE
statement_check_result.issue_identifier = build_issue_identifier(
case=audit.case,
issue=statement_check_result,
issue_type=issue_type,
)
statement_check_result.save()

for retest in Retest.objects.all():
for retest_check_result in RetestCheckResult.objects.filter(retest=retest):
retest_check_result.id_within_case = (
retest_check_result.check_result.id_within_case
)
retest_check_result.issue_identifier = build_issue_identifier(
case=audit.case,
issue=retest_check_result,
issue_type=ISSUE_IDENTIFIER_WCAG,
)
retest_check_result.save()

id_within_case = 0
for retest_statement_check_result in RetestStatementCheckResult.objects.filter(
retest=retest
):
id_within_case += 1
retest_statement_check_result.id_within_case = id_within_case
issue_type = ISSUE_IDENTIFIER_STATEMENT
if retest_statement_check_result.statement_check is None:
issue_type += CUSTOM_ISSUE
retest_statement_check_result.issue_identifier = build_issue_identifier(
case=retest.case,
issue=retest_statement_check_result,
issue_type=issue_type,
)
retest_statement_check_result.save()


def reverse_code(apps, schema_editor): # pylint: disable=unused-argument
pass


class Migration(migrations.Migration):

dependencies = [
("audits", "0012_retestcheckresult_id_within_case_and_more"),
]

operations = [
migrations.RunPython(populate_id_within_case, reverse_code=reverse_code),
]
Loading
Loading