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.

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

pythonvalidate: unique ID checks return all places the ID is used #61

Merged
merged 1 commit into from
Dec 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

### Changed

- Python Validate:
- [#51](https://github.com/Open-Telecoms-Data/lib-cove-ofds/issues/51) - unique ID checks return all places the non-unique ID is used. (Previously would not return first one)

## [0.6.0] - 2022-12-07

### Added
Expand Down
101 changes: 55 additions & 46 deletions libcoveofds/python_validate.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
from collections import defaultdict

from libcoveofds.schema import OFDSSchema


Expand Down Expand Up @@ -38,7 +40,7 @@ def check_organisation_second_pass(self, organisation: dict, path: str):
def check_contract_second_pass(self, contract: dict, path: str):
pass

def get_additional_check_results(self):
def get_additional_check_results(self) -> list:
return self._additional_check_results

def skip_if_any_links_have_external_node_data(self) -> bool:
Expand Down Expand Up @@ -518,71 +520,78 @@ def skip_if_any_links_have_external_span_data(self) -> bool:
class UniqueIDsAdditionalCheckForNetwork(AdditionalCheckForNetwork):
def __init__(self, schema_object: OFDSSchema):
super().__init__(schema_object)
self._node_ids_seen: list = []
self._span_ids_seen: list = []
self._phase_ids_seen: list = []
self._organisation_ids_seen: list = []
self._contract_ids_seen: list = []
self._node_ids_seen: defaultdict = defaultdict(list)
self._span_ids_seen: defaultdict = defaultdict(list)
self._phase_ids_seen: defaultdict = defaultdict(list)
self._organisation_ids_seen: defaultdict = defaultdict(list)
self._contract_ids_seen: defaultdict = defaultdict(list)

def check_node_first_pass(self, node: dict, path: str):
id = node.get("id")
if id and isinstance(id, str):
if id in self._node_ids_seen:
self._additional_check_results.append(
{"type": "duplicate_node_id", "node_id": id, "path": path}
)
else:
self._node_ids_seen.append(id)

pass
self._node_ids_seen[id].append(path)

def check_span_first_pass(self, span: dict, path: str):
id = span.get("id")
if id and isinstance(id, str):
if id in self._span_ids_seen:
self._additional_check_results.append(
{"type": "duplicate_span_id", "span_id": id, "path": path}
)
else:
self._span_ids_seen.append(id)
self._span_ids_seen[id].append(path)

def check_phase_first_pass(self, phase: dict, path: str):
id = phase.get("id")
if id and isinstance(id, str):
if id in self._phase_ids_seen:
self._additional_check_results.append(
{"type": "duplicate_phase_id", "phase_id": id, "path": path}
)
else:
self._phase_ids_seen.append(id)

pass
self._phase_ids_seen[id].append(path)

def check_organisation_first_pass(self, organisation: dict, path: str):
id = organisation.get("id")
if id and isinstance(id, str):
if id in self._organisation_ids_seen:
self._additional_check_results.append(
{
"type": "duplicate_organisation_id",
"organisation_id": id,
"path": path,
}
)
else:
self._organisation_ids_seen.append(id)

pass
self._organisation_ids_seen[id].append(path)

def check_contract_first_pass(self, contract: dict, path: str):
id = contract.get("id")
if id and isinstance(id, str):
if id in self._contract_ids_seen:
self._additional_check_results.append(
{"type": "duplicate_contract_id", "contract_id": id, "path": path}
)
else:
self._contract_ids_seen.append(id)
self._contract_ids_seen[id].append(path)

def get_additional_check_results(self) -> list:
out: list = []
for id, paths in self._node_ids_seen.items():
if len(paths) > 1:
for path in paths:
out.append(
{"type": "duplicate_node_id", "node_id": id, "path": path}
)
for id, paths in self._span_ids_seen.items():
if len(paths) > 1:
for path in paths:
out.append(
{"type": "duplicate_span_id", "span_id": id, "path": path}
)
for id, paths in self._phase_ids_seen.items():
if len(paths) > 1:
for path in paths:
out.append(
{"type": "duplicate_phase_id", "phase_id": id, "path": path}
)
for id, paths in self._organisation_ids_seen.items():
if len(paths) > 1:
for path in paths:
out.append(
{
"type": "duplicate_organisation_id",
"organisation_id": id,
"path": path,
}
)
for id, paths in self._contract_ids_seen.items():
if len(paths) > 1:
for path in paths:
out.append(
{
"type": "duplicate_contract_id",
"contract_id": id,
"path": path,
}
)
return out

def skip_if_any_links_have_external_node_data(self) -> bool:
return False
Expand Down
1 change: 1 addition & 0 deletions make_expected_test_data.sh
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,5 @@ libcoveofds pv tests/fixtures/pythonvalidate/span_route_type_incorrect_1.input.j
libcoveofds pv tests/fixtures/pythonvalidate/start_node_not_found_1.input.json > tests/fixtures/pythonvalidate/start_node_not_found_1.expected.json
libcoveofds pv tests/fixtures/pythonvalidate/start_node_not_found_but_has_external_nodes_1.input.json > tests/fixtures/pythonvalidate/start_node_not_found_but_has_external_nodes_1.expected.json
libcoveofds pv tests/fixtures/pythonvalidate/unique_ids_1.input.json > tests/fixtures/pythonvalidate/unique_ids_1.expected.json
libcoveofds pv tests/fixtures/pythonvalidate/unique_ids_2.input.json > tests/fixtures/pythonvalidate/unique_ids_2.expected.json

30 changes: 30 additions & 0 deletions tests/fixtures/pythonvalidate/unique_ids_1.expected.json
Original file line number Diff line number Diff line change
@@ -1,28 +1,58 @@
[
{
"type": "duplicate_node_id",
"node_id": "2",
"path": "/networks/0/nodes/1",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_node_id",
"node_id": "2",
"path": "/networks/0/nodes/2",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_span_id",
"span_id": "1",
"path": "/networks/0/spans/0",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_span_id",
"span_id": "1",
"path": "/networks/0/spans/1",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_phase_id",
"phase_id": "2",
"path": "/networks/0/phases/0",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_phase_id",
"phase_id": "2",
"path": "/networks/0/phases/1",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_organisation_id",
"organisation_id": "2",
"path": "/networks/0/organisations/0",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_organisation_id",
"organisation_id": "2",
"path": "/networks/0/organisations/1",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_contract_id",
"contract_id": "2",
"path": "/networks/0/contracts/0",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_contract_id",
"contract_id": "2",
Expand Down
92 changes: 92 additions & 0 deletions tests/fixtures/pythonvalidate/unique_ids_2.expected.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
[
{
"type": "duplicate_node_id",
"node_id": "2",
"path": "/networks/0/nodes/1",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_node_id",
"node_id": "2",
"path": "/networks/0/nodes/2",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_node_id",
"node_id": "2",
"path": "/networks/0/nodes/3",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_span_id",
"span_id": "1",
"path": "/networks/0/spans/0",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_span_id",
"span_id": "1",
"path": "/networks/0/spans/1",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_span_id",
"span_id": "1",
"path": "/networks/0/spans/2",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_phase_id",
"phase_id": "2",
"path": "/networks/0/phases/0",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_phase_id",
"phase_id": "2",
"path": "/networks/0/phases/1",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_phase_id",
"phase_id": "2",
"path": "/networks/0/phases/2",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_organisation_id",
"organisation_id": "2",
"path": "/networks/0/organisations/0",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_organisation_id",
"organisation_id": "2",
"path": "/networks/0/organisations/1",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_organisation_id",
"organisation_id": "2",
"path": "/networks/0/organisations/2",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_contract_id",
"contract_id": "2",
"path": "/networks/0/contracts/0",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_contract_id",
"contract_id": "2",
"path": "/networks/0/contracts/1",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
},
{
"type": "duplicate_contract_id",
"contract_id": "2",
"path": "/networks/0/contracts/2",
"network_id": "a096d627-72e1-4f9b-b129-951b1737bff4"
}
]
Loading