add a KPI contacts check for ISO 3166 alpha-3 country (#140)

tomkralidis · tomkralidis · commit e181af604b35 · 2025-08-13T10:18:56.000-04:00
diff --git a/pywcmp/resources/example-ca-eccc-msc.nwp-gdps.json b/pywcmp/resources/example-ca-eccc-msc.nwp-gdps.json
@@ -97,7 +97,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "contactInstructions": "email",
diff --git a/pywcmp/wcmp2/kpi.py b/pywcmp/wcmp2/kpi.py
@@ -2,7 +2,7 @@
 #
 # Authors: Tom Kralidis <tomkralidis@gmail.com>
 #
-# Copyright (c) 2024 Tom Kralidis
+# Copyright (c) 2025 Tom Kralidis
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
@@ -31,6 +31,7 @@
 import uuid
 
 from bs4 import BeautifulSoup
+import pycountry
 
 import pywcmp
 from pywcmp.util import (check_spelling, check_url,
@@ -414,8 +415,10 @@ def kpi_contacts(self) -> tuple:
 
         host_contact = None
         email_found = False
+        countries = []
+        valid_countries = True
 
-        total = 3
+        total = 4
         score = 0
         comments = []
 
@@ -428,6 +431,21 @@ def kpi_contacts(self) -> tuple:
             if 'host' in contact['roles']:
                 host_contact = contact
 
+            for address in contact.get('addresses', []):
+                if address.get('country') is not None:
+                    countries.append(address['country'])
+
+        if countries:
+            for country in countries:
+                if pycountry.countries.get(alpha_3=country) is None:
+                    valid_countries = False
+                    break
+
+        if not valid_countries:
+            comments.append('countries should be ISO 3166-1 alpha-3')
+        else:
+            score += 1
+
         if host_contact is None:
             comments.append('No host contact found')
         else:
diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,7 @@
 beautifulsoup4
 click
 jsonschema
+pycountry
 pyspellchecker
 pywis-topics
 rfc3339-validator
diff --git a/tests/data/wcmp2-failing-created-none.json b/tests/data/wcmp2-failing-created-none.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-failing-invalid-centre-id.json b/tests/data/wcmp2-failing-invalid-centre-id.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-failing-invalid-geometry-range.json b/tests/data/wcmp2-failing-invalid-geometry-range.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-failing-invalid-identifier-empty.json b/tests/data/wcmp2-failing-invalid-identifier-empty.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-failing-invalid-identifier-space.json b/tests/data/wcmp2-failing-invalid-identifier-space.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-failing-invalid-link-channel-centre-id.json b/tests/data/wcmp2-failing-invalid-link-channel-centre-id.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-failing-invalid-link-channel-data-policy.json b/tests/data/wcmp2-failing-invalid-link-channel-data-policy.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-failing-invalid-link-channel-wis2-topic.json b/tests/data/wcmp2-failing-invalid-link-channel-wis2-topic.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-failing-invalid-time-resolution.json b/tests/data/wcmp2-failing-invalid-time-resolution.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-failing.json b/tests/data/wcmp2-failing.json
@@ -100,7 +100,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-passing-no-centre-id.json b/tests/data/wcmp2-passing-no-centre-id.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-passing-null-time.json b/tests/data/wcmp2-passing-null-time.json
@@ -96,7 +96,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-passing-test-centre-id.json b/tests/data/wcmp2-passing-test-centre-id.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/data/wcmp2-passing.json b/tests/data/wcmp2-passing.json
@@ -102,7 +102,7 @@
                         "city": "Fredericton",
                         "administrativeArea": "NB",
                         "postalCode": "E3B 6Z4",
-                        "country": "Canada"
+                        "country": "CAN"
                     }
                 ],
                 "links": [
diff --git a/tests/run_tests.py b/tests/run_tests.py
@@ -308,8 +308,8 @@ def test_kpi_evaluate(self):
         self.assertEqual(results['report_type'], 'kpi')
         self.assertEqual(results['metadata_id'], data['id'])
 
-        self.assertEqual(results['summary']['total'], 32)
-        self.assertEqual(results['summary']['score'], 32)
+        self.assertEqual(results['summary']['total'], 33)
+        self.assertEqual(results['summary']['score'], 33)
         self.assertEqual(results['summary']['percentage'], 100)
         self.assertEqual(results['summary']['grade'], 'A')
 

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@`
`97`	`97`	`"city": "Fredericton",`
`98`	`98`	`"administrativeArea": "NB",`
`99`	`99`	`"postalCode": "E3B 6Z4",`
`100`		`- "country": "Canada"`
	`100`	`+ "country": "CAN"`
`101`	`101`	`}`
`102`	`102`	`],`
`103`	`103`	`"contactInstructions": "email",`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@`
`102`	`102`	`"city": "Fredericton",`
`103`	`103`	`"administrativeArea": "NB",`
`104`	`104`	`"postalCode": "E3B 6Z4",`
`105`		`- "country": "Canada"`
	`105`	`+ "country": "CAN"`
`106`	`106`	`}`
`107`	`107`	`],`
`108`	`108`	`"links": [`