Merge branch 'feature/PI-631-generate_product_ids' into release/2024-12-05

Author: jameslinnell

README.md

@@ -21,6 +21,7 @@
 4. [Workflow](#workflow)
 5. [Swagger](#swagger)
 6. [ETL](#etl)
+7. [Administration](#administration)
 
 ---
 
@@ -429,6 +430,18 @@ and
 make etl--clear-state WORKSPACE=dev SET_CHANGELOG_NUMBER=540210
 ```
 
+## Administration
+
+### Generating Ids
+
+In order to generate a persistent list of Ids across environments then run... (The example given will generate 100 ids.)
+
+```
+make admin--generate-ids--product SET_GENERATOR_COUNT=100
+```
+
+Any previously generated ids will not be overwritten.
+
 ### Documentation
 
 We have several locations for the Swagger to keep things as visible as possible

pyproject.toml

@@ -56,6 +56,7 @@ boto3-stubs = { extras = [
 ], version = "^1.34.37" }
 pytest-timeout = "^2.2.0"
 lz4 = "^4.3.3"
+pytest-repeat = "^0.9.3"
 
 [tool.poetry.group.local]
 optional = true

scripts/administration/administration.mk

@@ -0,0 +1,4 @@
+SET_GENERATOR_COUNT :=
+
+admin--generate-ids--product: ## Generate product Ids
+	poetry run python scripts/administration/id_generator.py --count="$(SET_GENERATOR_COUNT)"

scripts/administration/id_generator.py

@@ -0,0 +1,56 @@
+import argparse
+import json
+import os
+
+from domain.core.cpm_system_id import ProductId
+
+ID_FILE_MAP = {
+    "product": f"{os.getcwd()}/src/layers/domain/core/cpm_system_id/generated_ids/product_ids.json",
+}
+
+ID_CLASS_MAP = {
+    "product": ProductId,
+}
+
+
+def generator(id_type="product"):
+    id_class = ID_CLASS_MAP.get(id_type)
+    generator = id_class.create()
+    return generator.__root__
+
+
+def open_file(id_type="product"):
+    if os.path.exists(ID_FILE_MAP.get(id_type)):
+        with open(ID_FILE_MAP.get(id_type), "r") as file:
+            return set(json.load(file))
+    return set()
+
+
+def save_file(ids, id_type="product"):
+    with open(ID_FILE_MAP.get(id_type), "w") as file:
+        json.dump(list(ids), file)
+
+
+def bulk_generator(id_count=1, id_type="product"):
+    ids = open_file(id_type=id_type)
+    starting_id_count = len(ids)
+    while len(ids) - starting_id_count < id_count:
+        ids.add(generator())
+    save_file(ids, id_type)
+    return ids
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Generate unique Product Ids.")
+    parser.add_argument(
+        "--count", type=int, default=1, help="Number of Product Ids to generate."
+    )
+    args = parser.parse_args()
+    ids = bulk_generator(args.count)
+    id_type = "product"
+    print(f"Generated {id_type.capitalize()} Ids...")  # noqa
+    print("========================")  # noqa
+    for id in ids:
+        print(id)  # noqa
+
+    print("========================")  # noqa

src/layers/domain/core/cpm_system_id/generated_ids/product_ids.json

@@ -0,0 +1,102 @@
+[
+  "P.RKK-P46",
+  "P.MNE-V6V",
+  "P.HPM-9MC",
+  "P.PLT-9YV",
+  "P.46W-MHJ",
+  "P.7JD-MUC",
+  "P.3GG-DW6",
+  "P.AE9-96P",
+  "P.K6N-D4X",
+  "P.RVC-APA",
+  "P.JFX-3M4",
+  "P.HKM-MGU",
+  "P.NXD-R7N",
+  "P.66R-VWJ",
+  "P.D3Y-H7J",
+  "P.T46-YEE",
+  "P.XTW-LG3",
+  "P.WTJ-FJT",
+  "P.XWA-VFF",
+  "P.6YL-D93",
+  "P.CPY-J4W",
+  "P.JNH-MWV",
+  "P.K7C-X7D",
+  "P.MLH-97C",
+  "P.PV9-GTU",
+  "P.JUW-CRP",
+  "P.HUX-WFD",
+  "P.9RJ-VTW",
+  "P.EGF-DHU",
+  "P.XMX-4CN",
+  "P.4RE-CKC",
+  "P.HR9-9PU",
+  "P.U9F-D3X",
+  "P.49J-A7U",
+  "P.JV6-H4R",
+  "P.THY-GVT",
+  "P.AY3-ERX",
+  "P.6DP-3MK",
+  "P.DUG-WPW",
+  "P.DKM-L96",
+  "P.CXW-CRT",
+  "P.EKF-XRK",
+  "P.JG7-LCA",
+  "P.LRN-UWP",
+  "P.9AK-LMH",
+  "P.K96-UND",
+  "P.YUP-T9J",
+  "P.EJK-ACK",
+  "P.H9X-PD4",
+  "P.VKF-LUV",
+  "P.HWC-GLY",
+  "P.D3C-YW7",
+  "P.KM7-439",
+  "P.RK9-CKM",
+  "P.CCW-G73",
+  "P.RYF-MMM",
+  "P.4CU-UKP",
+  "P.GV7-FPE",
+  "P.AEP-C4V",
+  "P.CTC-UEM",
+  "P.DYD-3RG",
+  "P.H6K-7VL",
+  "P.U6J-EEU",
+  "P.EWX-ACY",
+  "P.4HC-WJN",
+  "P.A4C-EKV",
+  "P.6AK-96A",
+  "P.L9N-Y3T",
+  "P.TVU-MVK",
+  "P.WW7-FCD",
+  "P.PPW-73K",
+  "P.JPT-6AY",
+  "P.G9T-UAR",
+  "P.6LF-D3M",
+  "P.4NT-EGL",
+  "P.7JR-XAP",
+  "P.PEH-UFM",
+  "P.6KC-WPU",
+  "P.464-URD",
+  "P.3DR-EK3",
+  "P.KG3-CHW",
+  "P.3FL-PTA",
+  "P.GT4-9DY",
+  "P.9RW-9FX",
+  "P.HTJ-YFF",
+  "P.NMX-MHC",
+  "P.4KJ-DHT",
+  "P.3KL-X6F",
+  "P.DUM-YKT",
+  "P.F7G-GVH",
+  "P.4H4-4FJ",
+  "P.9XP-NX6",
+  "P.4VH-YLN",
+  "P.VRA-F9U",
+  "P.97J-HN9",
+  "P.3WF-CNA",
+  "P.TUR-X4P",
+  "P.DXE-FWE",
+  "P.C9W-CLJ",
+  "P.JVG-CA4"
+]

src/layers/domain/core/cpm_system_id/tests/test_cpm_system_id_v1.py

@@ -1,5 +1,21 @@
+import os
+from pathlib import Path
+
 import pytest
 from domain.core.cpm_system_id import AsidId, PartyKeyId, ProductId
+from event.json import json_load
+
+PATH_TO_CPM_SYSTEM_IDS = Path(__file__).parent.parent
+PRODUCT_IDS_GENERATED_FILE = f"{PATH_TO_CPM_SYSTEM_IDS}/generated_ids/product_ids.json"
+generated_product_ids = set()
+
+
+@pytest.fixture(scope="module")
+def _get_generated_ids():
+    global generated_product_ids
+    if os.path.exists(PRODUCT_IDS_GENERATED_FILE):
+        with open(PRODUCT_IDS_GENERATED_FILE, "r") as file:
+            generated_product_ids = set(json_load(file))
 
 
 def test_party_key_generator_format_key():
@@ -71,9 +87,11 @@ def test_asid_generator_increment_number():
     assert generator.id == "223456789013"
 
 
-def test_product_id_generator_format_key():
+@pytest.mark.repeat(50)
+def test_product_id_generator_format_key(_get_generated_ids):
     generator = ProductId.create()
     assert generator.id is not None
+    assert generator.id not in generated_product_ids
 
 
 @pytest.mark.parametrize(

src/layers/domain/core/cpm_system_id/v1.py

@@ -1,13 +1,17 @@
+import os
 import random
 import re
 from abc import ABC, abstractmethod
 from datetime import datetime
+from functools import cache
+from pathlib import Path
 from uuid import uuid4
 
 from domain.core.base import BaseModel
 from domain.core.device_key import validate_key
 from domain.core.error import InvalidKeyPattern
 from domain.core.product_key import ProductKeyType
+from event.json import json_load
 from pydantic import validator
 
 FIRST_ASID = 200000099999
@@ -19,11 +23,22 @@
 PRODUCT_ID_PATTERN = re.compile(
     rf"^P\.[{PRODUCT_ID_VALID_CHARS}]{{{PRODUCT_ID_PART_LENGTH}}}-[{PRODUCT_ID_VALID_CHARS}]{{{PRODUCT_ID_PART_LENGTH}}}$"
 )
+
+PATH_TO_CPM_SYSTEM_IDS = Path(__file__).parent
+PRODUCT_IDS_GENERATED_FILE = f"{PATH_TO_CPM_SYSTEM_IDS}/generated_ids/product_ids.json"
 PRODUCT_TEAM_ID_PATTERN = re.compile(
     r"^[a-zA-Z0-9]+\.([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})$"
 )
 
 
+@cache
+def _load_existing_ids():
+    if os.path.exists(PRODUCT_IDS_GENERATED_FILE):
+        with open(PRODUCT_IDS_GENERATED_FILE, "r") as file:
+            return set(json_load(file))
+    return set()
+
+
 class CpmSystemId(BaseModel, ABC):
     __root__: str = None
 
@@ -111,13 +126,19 @@ def create(cls):
             "".join(rng.choices(PRODUCT_ID_VALID_CHARS, k=PRODUCT_ID_PART_LENGTH))
             for _ in range(PRODUCT_ID_NUMBER_OF_PARTS)
         )
+        if f"P.{product_id}" in cls.load_existing_ids():
+            return cls.create()
         return cls(__root__=f"P.{product_id}")
 
     @classmethod
     def validate_cpm_system_id(cls, cpm_system_id: str) -> bool:
         """Validate that the ProductId has the correct format."""
         return PRODUCT_ID_PATTERN.match(cpm_system_id) is not None
 
+    @classmethod
+    def load_existing_ids(cls):
+        return _load_existing_ids()
+
 
 class ProductTeamId(CpmSystemId):
     @classmethod