additional_checks: Link to schema docs, count in header

#13 Also fix broken if clause - some errors would not have been shown Not sure how to do trans blocks correctly but it's not important for now so leaving for later
Open-Telecoms-Data · Nov 8, 2022 · b284839 · b284839
1 parent 9dd1c5f
commit b284839
Show file tree

Hide file tree

Showing 2 changed files with 95 additions and 38 deletions.
diff --git a/cove_ofds/templates/cove_ofds/additional_checks_table.html b/cove_ofds/templates/cove_ofds/additional_checks_table.html
@@ -2,14 +2,16 @@
 
 
 {% if 'span_start_node_not_found' in additional_checks or 'span_end_node_not_found' in additional_checks  %}
-    <h3>{% trans 'Node references'  %}</h3>
-    <p>{% trans 'Your data contains spans with node references that cannot be resolved. `Span.start` and `Span.end` must match the `.id` of exactly one node in the `/nodes` array.'  %}</p>
-    {% if 'span_start_node_not_found' in additional_checks %}
-        <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Span,start">{% trans 'Schema Documentation' %}</a></p>
-    {% endif %}
-    {% if 'span_end_node_not_found' in additional_checks %}
-        <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Span,end">{% trans 'Schema Documentation' %}</a></p>
-    {% endif %}
+    <h3>
+        {% trans 'Node references'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.span_start_node_not_found list2=additional_checks.span_end_node_not_found %}
+    </h3>
+    <p>
+        {% trans 'Your data contains spans with node references that cannot be resolved. `Span.start` and `Span.end` must match the `.id` of exactly one node in the `/nodes` array.'  %}
+        For more information, see
+        <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Span,start">`Span.start`</a> and
+        <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Span,end">`Span.end`</a>.
+    </p>
     <table class="table">
         <thead>
             <tr>
@@ -51,9 +53,14 @@ <h3>{% trans 'Node references'  %}</h3>
 
 
 {% if 'node_location_type_incorrect' in additional_checks %}
-    <h3>{% trans 'Node location type'  %}</h3>
-    <p>{% trans 'Your data contains nodes with incorrect location types. `/nodes/location/type` must be `Point`.'  %}</p>
-    <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,type">{% trans 'Schema Documentation' %}</a></p>
+    <h3>
+        {% trans 'Node location type'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.node_location_type_incorrect %}
+    </h3>
+    <p>
+        {% trans 'Your data contains nodes with incorrect location types. `/nodes/location/type` must be `Point`.'  %}
+        For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,type">`Geometry.type`</a>.
+    </p>
     <table class="table">
         <thead>
             <tr>
@@ -78,9 +85,14 @@ <h3>{% trans 'Node location type'  %}</h3>
 
 
 {% if 'node_location_coordinates_incorrect' in additional_checks %}
-    <h3>{% trans 'Node location coordinates'  %}</h3>
-    <p>{% trans 'Your data contains nodes with incorrectly formatted location coordinates. `/nodes/location/coordinates` must be a single position, i.e. an array of numbers.'  %}</p>
-    <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,coordinates">{% trans 'Schema Documentation' %}</a></p>
+    <h3>
+        {% trans 'Node location coordinates'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.node_location_coordinates_incorrect %}
+    </h3>
+    <p>
+        {% trans 'Your data contains nodes with incorrectly formatted location coordinates. `/nodes/location/coordinates` must be a single position, i.e. an array of numbers.'  %}
+        For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,coordinates">`Geometry.coordinates`</a>.
+    </p>
     <table class="table">
         <thead>
             <tr>
@@ -105,9 +117,14 @@ <h3>{% trans 'Node location coordinates'  %}</h3>
 
 
 {% if 'span_route_type_incorrect' in additional_checks %}
-    <h3>{% trans 'Span route geometry'  %}</h3>
-    <p>{% trans 'Your data contains spans with incorrect route types. `/spans/route/type` must be `LineString`.'  %}</p>
-    <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,type">{% trans 'Schema Documentation' %}</a></p>
+    <h3>
+        {% trans 'Span route geometry'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.span_route_type_incorrect %}
+    </h3>
+    <p>
+        {% trans 'Your data contains spans with incorrect route types. `/spans/route/type` must be `LineString`.'  %}
+        For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,type">`Geometry.type`</a>.
+    </p>
     <table class="table">
         <thead>
             <tr>
@@ -132,9 +149,14 @@ <h3>{% trans 'Span route geometry'  %}</h3>
 
 
 {% if 'span_route_coordinates_incorrect' in additional_checks %}
-    <h3>{% trans 'Span route coordinates'  %}</h3>
-    <p>{% trans 'Your data contains spans with incorrectly formatted route coordinates. `/spans/route/coordinates` must be an array of positions, i.e. an array of arrays of numbers.'  %}</p>
-    <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,coordinates">{% trans 'Schema Documentation' %}</a></p>
+    <h3>
+        {% trans 'Span route coordinates'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.span_route_coordinates_incorrect %}
+    </h3>
+    <p>
+        {% trans 'Your data contains spans with incorrectly formatted route coordinates. `/spans/route/coordinates` must be an array of positions, i.e. an array of arrays of numbers.'  %}
+        For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,coordinates">`Geometry.coordinates`</a>.
+    </p>
     <table class="table">
         <thead>
             <tr>
@@ -159,9 +181,14 @@ <h3>{% trans 'Span route coordinates'  %}</h3>
 
 
 {% if 'node_phase_reference_id_not_found' in additional_checks or 'span_phase_reference_id_not_found' in additional_checks or 'contract_related_phase_reference_id_not_found' in additional_checks  %}
-    <h3>{% trans 'Phase references'  %}</h3>
-    <p>{% trans 'Your data contains phase references that cannot be resolved. The `.id` of each phase reference must match the `.id` of exactly one phase in the `/phases` array.'  %}</p>
-    <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/PhaseReference,id">{% trans 'Schema Documentation' %}</a></p>
+    <h3>
+        {% trans 'Phase references'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.node_phase_reference_id_not_found list2=additional_checks.span_phase_reference_id_not_found list3=additional_checks.contract_related_phase_reference_id_not_found %}
+    </h3>
+    <p>
+        {% trans 'Your data contains phase references that cannot be resolved. The `.id` of each phase reference must match the `.id` of exactly one phase in the `/phases` array.'  %}
+        For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/PhaseReference,id">`PhaseReference.id`</a>.
+    </p>
     {% if 'node_phase_reference_id_not_found' in additional_checks %}
         <table class="table">
             <thead>
@@ -234,9 +261,14 @@ <h3>{% trans 'Phase references'  %}</h3>
 
 
 {% if 'node_phase_reference_name_does_not_match' in additional_checks or 'span_phase_reference_name_does_not_match' in additional_checks or 'contract_related_phase_reference_name_does_not_match' in additional_checks %}
-    <h3>{% trans 'Phase names'  %}</h3>
-    <p>{% trans 'Your data contains phase references with inconsistent names. The `.name` of each phase reference must match the `.name` of the phase it references.'  %}</p>
-    <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/PhaseReference,name">{% trans 'Schema Documentation' %}</a></p>
+    <h3>
+        {% trans 'Phase names'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.node_phase_reference_name_does_not_match list2=additional_checks.span_phase_reference_name_does_not_match list3=additional_checks.contract_related_phase_reference_name_does_not_match %}
+    </h3>
+    <p>
+        {% trans 'Your data contains phase references with inconsistent names. The `.name` of each phase reference must match the `.name` of the phase it references.'  %}
+        For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/PhaseReference,name">`PhaseReference.name`</a>.
+    </p>
     {% if 'node_phase_reference_name_does_not_match' in additional_checks %}
         <table class="table">
             <thead>
@@ -306,10 +338,15 @@ <h3>{% trans 'Phase names'  %}</h3>
 {% endif %}
 
 
-{% if 'node_organisation_reference_id_not_found' in additional_checks or 'node_organisation_reference_id_not_found' in additional_checks or 'phase_organisation_reference_id_not_found' in additional_checks %}
-    <h3>{% trans 'Organisation references'  %}</h3>
-    <p>{% trans 'Your data contains organisation references that cannot be resolved. The `.id` of each organisation reference must match the `.id` of exactly one organisation in the `/organisations` array.'  %}</p>
-    <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/OrganisationReference,id">{% trans 'Schema Documentation' %}</a></p>
+{% if 'node_organisation_reference_id_not_found' in additional_checks or 'span_organisation_reference_id_not_found' in additional_checks or 'phase_organisation_reference_id_not_found' in additional_checks %}
+    <h3>
+        {% trans 'Organisation references'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.node_organisation_reference_id_not_found list2=additional_checks.span_organisation_reference_id_not_found list3=additional_checks.phase_organisation_reference_id_not_found %}
+    </h3>
+    <p>
+        {% trans 'Your data contains organisation references that cannot be resolved. The `.id` of each organisation reference must match the `.id` of exactly one organisation in the `/organisations` array.'  %}
+        For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/OrganisationReference,id">`OrganisationReference.id`</a>.
+    </p>
     {% if 'node_organisation_reference_id_not_found' in additional_checks %}
         <table class="table">
             <thead>
@@ -388,10 +425,15 @@ <h3>{% trans 'Organisation references'  %}</h3>
 
 
 
-{% if 'node_organisation_reference_name_does_not_match' in additional_checks %}
-    <h3>{% trans 'Organisation names'  %}</h3>
-    <p>{% trans 'Your data contains organisation references with inconsistent names. The `.name` of each organisation reference must match the `.name` of the organisation it references.'  %}</p>
-    <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/OrganisationReference,name">{% trans 'Schema Documentation' %}</a></p>
+{% if 'node_organisation_reference_name_does_not_match' in additional_checks or 'span_organisation_reference_name_does_not_match' in additional_checks or 'phase_organisation_reference_name_does_not_match' in additional_checks %}
+    <h3>
+        {% trans 'Organisation names'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.node_organisation_reference_name_does_not_match list2=additional_checks.span_organisation_reference_name_does_not_match list3=additional_checks.phase_organisation_reference_name_does_not_match %}
+    </h3>
+    <p>
+        {% trans 'Your data contains organisation references with inconsistent names. The `.name` of each organisation reference must match the `.name` of the organisation it references.'  %}
+        For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/OrganisationReference,name">`OrganisationReference.name`</a>.
+    </p>
     {% if 'node_organisation_reference_name_does_not_match' in additional_checks %}
         <table class="table">
             <thead>
@@ -470,9 +512,14 @@ <h3>{% trans 'Organisation names'  %}</h3>
 
 
 {% if 'node_international_connections_country_not_set' in additional_checks %}
-    <h3>{% trans 'International connection countries'  %}</h3>
-    <p>{% trans 'Your data contains nodes with international connections that do not specify a country. `.country` must be set for each international connection in `/nodes/internationalConnections`.'  %}</p>
-    <p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Node,internationalConnections">{% trans 'Schema Documentation' %}</a></p>
+    <h3>
+        {% trans 'International connection countries'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.node_international_connections_country_not_set  %}
+    </h3>
+    <p>
+        {% trans 'Your data contains nodes with international connections that do not specify a country. `.country` must be set for each international connection in `/nodes/internationalConnections`.'  %}
+        For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Node,internationalConnections">`Node.internationalConnections`</a>.
+    </p>
     <table class="table">
         <thead>
             <tr>
@@ -497,7 +544,10 @@ <h3>{% trans 'International connection countries'  %}</h3>
 
 
 {% if 'node_not_used_in_any_spans' in additional_checks %}
-    <h3>{% trans 'Unreferenced nodes'  %}</h3>
+    <h3>
+        {% trans 'Unreferenced nodes'  %}
+        {% include 'cove_ofds/additional_checks_table_failure_counter.html' with list1=additional_checks.node_not_used_in_any_spans  %}
+    </h3>
     <p>{% trans 'Your data contains nodes that are not referenced by any spans.'  %}</p>
     <table class="table">
         <thead>

diff --git a/cove_ofds/templates/cove_ofds/additional_checks_table_failure_counter.html b/cove_ofds/templates/cove_ofds/additional_checks_table_failure_counter.html
@@ -0,0 +1,7 @@
+{% load i18n %}
+
+{% with l1l=list1|length l2l=list2|length l3l=list3|length%}
+    {% with count=l1l|add:l2l|add:l3l %}
+            ({% if count == 1 %}1 failure{% else %}{{ count }} {% trans 'failures'  %}{% endif %})
+    {% endwith %}
+{% endwith %}