[uss_qualifier] Rename crdb/cochroachdb to datastore (#1037)

Author: the-glu

monitoring/uss_qualifier/configurations/dev/dss_probing.yaml

@@ -64,4 +64,4 @@ v1:
         pass_condition:
           elements:
             count:
-              equal_to: 6 # 6 CRDBAccess scenarios are skipped
+              equal_to: 6 # 6 DatastoreAccess scenarios are skipped

monitoring/uss_qualifier/configurations/dev/library/environment_containers.yaml

@@ -207,13 +207,13 @@ scd_dss_instances:
 
 # ===== DSS CockroachDB nodes =====
 
-dss_crdb_cluster:
+dss_datastore_cluster:
   $content_schema: monitoring/uss_qualifier/resources/definitions/ResourceDeclaration.json
-  resource_type: resources.interuss.crdb.CockroachDBClusterResource
+  resource_type: resources.interuss.datastore.DatastoreDBClusterResource
   specification:
     nodes:
       - participant_id: uss1
-        host: crdb.uss1.localutm
+        host: datastore.uss1.localutm
         port: 26257
 
 # ===== mock_uss instances =====

monitoring/uss_qualifier/configurations/dev/library/environment_localhost.yaml

@@ -206,9 +206,9 @@ scd_dss_instances:
 
 # ===== DSS CockroachDB nodes =====
 
-dss_crdb_cluster:
+dss_datastore_cluster:
   $content_schema: monitoring/uss_qualifier/resources/definitions/ResourceDeclaration.json
-  resource_type: resources.interuss.crdb.CockroachDBClusterResource
+  resource_type: resources.interuss.datastore.DatastoreDBClusterResource
   specification:
     nodes:
       - participant_id: uss1

monitoring/uss_qualifier/configurations/dev/minimal_probing.yaml

@@ -87,4 +87,4 @@ v1:
         pass_condition:
           elements:
             count:
-              equal_to: 2 # 2 CRDBAccess scenarios are skipped
+              equal_to: 2 # 2 DatastoreAccess scenarios are skipped

monitoring/uss_qualifier/configurations/dev/netrid_v19.yaml

@@ -71,4 +71,4 @@ v1:
         pass_condition:
           elements:
             count:
-              equal_to: 2 # 2 CRDBAccess scenarios are skipped
+              equal_to: 2 # 2 DatastoreAccess scenarios are skipped

monitoring/uss_qualifier/configurations/dev/netrid_v22a.yaml

@@ -71,4 +71,4 @@ v1:
         pass_condition:
           elements:
             count:
-              equal_to: 2 # 2 CRDBAccess scenarios are skipped
+              equal_to: 2 # 2 DatastoreAccess scenarios are skipped

monitoring/uss_qualifier/configurations/dev/uspace.yaml

@@ -184,4 +184,4 @@ v1:
         pass_condition:
           elements:
             count:
-              equal_to: 4 # 4 CRDBAccess scenarios are skipped
+              equal_to: 4 # 4 DatastoreAccess scenarios are skipped

monitoring/uss_qualifier/configurations/dev/utm_implementation_us_lib/baseline.libsonnet

@@ -31,7 +31,7 @@ function(env) {
             planning_area: 'planning_area',
             problematically_big_area: 'problematically_big_area',
             system_identity: 'system_identity',
-            // dss_crdb_cluster: dss_crdb_cluster  # TODO: Provide once local DSS uses a multi-node cluster
+            // dss_datastore_cluster: dss_datastore_cluster  # TODO: Provide once local DSS uses a multi-node cluster
             test_exclusions: 'test_exclusions',
           },
         },
@@ -49,7 +49,7 @@ function(env) {
         'v1.test_run.resources.resource_declarations.dss',
         'v1.test_run.resources.resource_declarations.dss_instances',
         'v1.test_run.resources.resource_declarations.mock_uss',
-        'v1.test_run.resources.resource_declarations.dss_crdb_cluster',
+        'v1.test_run.resources.resource_declarations.dss_datastore_cluster',
         'v1.artifacts.tested_requirements[0].aggregate_participants',
         'v1.artifacts.tested_requirements[0].participant_requirements',
       ],

monitoring/uss_qualifier/configurations/interuss/library/environment.yaml

@@ -105,9 +105,9 @@ scd_dss_instances:
       - participant_id: uss2
         base_url: https://dss.ci.aws-interuss.uspace.dev
 
-dss_crdb_cluster:
-  $content_schema: monitoring/uss_qualifier/resources/interuss/crdb/crdb/CockroachDBClusterResource.json
-  resource_type: resources.interuss.crdb.crdb.CockroachDBClusterResource
+dss_datastore_cluster:
+  $content_schema: monitoring/uss_qualifier/resources/interuss/datastore/datastore/DatastoreDBClusterResource.json
+  resource_type: resources.interuss.datastore.datastore.DatastoreDBClusterResource
   specification:
     nodes:
       - participant_id: uss1

monitoring/uss_qualifier/configurations/interuss/pooled_dss_probing.yaml

@@ -11,7 +11,7 @@ v1:
         second_utm_auth: {$ref: './library/environment.yaml#/second_utm_auth'}
         utm_client_identity: { $ref: '../dev/library/resources.yaml#/utm_client_identity' }
         id_generator: { $ref: '../dev/library/resources.yaml#/id_generator' }
-        dss_crdb_cluster: { $ref: './library/environment.yaml#/dss_crdb_cluster' }
+        dss_datastore_cluster: { $ref: './library/environment.yaml#/dss_datastore_cluster' }
         scd_dss_instances: { $ref: './library/environment.yaml#/scd_dss_instances' }
         netrid_dss_instances_v22a: { $ref: './library/environment.yaml#/netrid_dss_instances_v22a' }
         netrid_dss_instances_v19: { $ref: './library/environment.yaml#/netrid_dss_instances_v19' }
@@ -20,7 +20,7 @@ v1:
     non_baseline_inputs:
       - v1.test_run.resources.resource_declarations.utm_auth
       - v1.test_run.resources.resource_declarations.second_utm_auth
-      - v1.test_run.resources.resource_declarations.dss_crdb_cluster
+      - v1.test_run.resources.resource_declarations.dss_datastore_cluster
       - v1.test_run.resources.resource_declarations.scd_dss_instances
       - v1.test_run.resources.resource_declarations.netrid_dss_instances_v22a
       - v1.test_run.resources.resource_declarations.netrid_dss_instances_v19
@@ -31,7 +31,7 @@ v1:
           f3411v19_dss_instances: netrid_dss_instances_v19
           f3411v22a_dss_instances: netrid_dss_instances_v22a
           f3548v21_dss_instances: scd_dss_instances
-          dss_crdb_cluster: dss_crdb_cluster
+          dss_datastore_cluster: dss_datastore_cluster
           utm_client_identity: utm_client_identity
           id_generator: id_generator
           service_area: kentland_service_area

monitoring/uss_qualifier/resources/interuss/crdb/__init__.py

@@ -0,0 +1,5 @@
+from .datastore import (
+    DatastoreDBClusterResource,
+    DatastoreDBNode,
+    DatastoreDBNodeResource,
+)

monitoring/uss_qualifier/resources/interuss/datastore/__init__.py

@@ -2,75 +2,74 @@
 
 from typing import List, Optional, Tuple
 
-import psycopg.errors
+import psycopg
 from implicitdict import ImplicitDict
-from psycopg import crdb
 
 from monitoring.uss_qualifier.resources.resource import Resource
 
 
-class CockroachDBNodeSpecification(ImplicitDict):
+class DatastoreDBNodeSpecification(ImplicitDict):
     participant_id: str
-    """ID of the USS responsible for this CockroachDB node"""
+    """ID of the USS responsible for this DatastoreDB node"""
 
     host: str
-    """Host where the CockroachDB node is reachable."""
+    """Host where the DatastoreDB node is reachable."""
 
     port: int
-    """Port to which CockroachDB node is listening to."""
+    """Port to which DatastoreDB node is listening to."""
 
     def __init__(self, *args, **kwargs):
         super().__init__(**kwargs)
 
 
-class CockroachDBNodeResource(Resource[CockroachDBNodeSpecification]):
-    _specification: CockroachDBNodeSpecification
+class DatastoreDBNodeResource(Resource[DatastoreDBNodeSpecification]):
+    _specification: DatastoreDBNodeSpecification
 
     def __init__(
         self,
-        specification: CockroachDBNodeSpecification,
+        specification: DatastoreDBNodeSpecification,
         resource_origin: str,
     ):
-        super(CockroachDBNodeResource, self).__init__(specification, resource_origin)
+        super(DatastoreDBNodeResource, self).__init__(specification, resource_origin)
         self._specification = specification
 
-    def get_client(self) -> CockroachDBNode:
-        return CockroachDBNode(
+    def get_client(self) -> DatastoreDBNode:
+        return DatastoreDBNode(
             self._specification.participant_id,
             self._specification.host,
             self._specification.port,
         )
 
-    def is_same_as(self, other: CockroachDBNodeResource) -> bool:
+    def is_same_as(self, other: DatastoreDBNodeResource) -> bool:
         return self._specification == other._specification
 
     @property
     def participant_id(self) -> str:
         return self._specification.participant_id
 
 
-class CockroachDBClusterSpecification(ImplicitDict):
-    nodes: List[CockroachDBNodeSpecification]
+class DatastoreDBClusterSpecification(ImplicitDict):
+    nodes: List[DatastoreDBNodeSpecification]
 
 
-class CockroachDBClusterResource(Resource[CockroachDBClusterSpecification]):
-    nodes: List[CockroachDBNodeResource]
+class DatastoreDBClusterResource(Resource[DatastoreDBClusterSpecification]):
+    nodes: List[DatastoreDBNodeResource]
 
     def __init__(
         self,
-        specification: CockroachDBClusterSpecification,
+        specification: DatastoreDBClusterSpecification,
         resource_origin: str,
     ):
-        super(CockroachDBClusterResource, self).__init__(specification, resource_origin)
+        super(DatastoreDBClusterResource, self).__init__(specification, resource_origin)
         self.nodes = [
-            CockroachDBNodeResource(
+            DatastoreDBNodeResource(
                 specification=s, resource_origin=f"node {i + 1} in {resource_origin}"
             )
             for i, s in enumerate(specification.nodes)
         ]
 
 
-class CockroachDBNode(object):
+class DatastoreDBNode(object):
     participant_id: str
     host: str
     port: int
@@ -85,8 +84,8 @@ def __init__(
         self.host = host
         self.port = port
 
-    def connect(self, **kwargs) -> crdb.connection.CrdbConnection:
-        return crdb.connect(
+    def connect(self, **kwargs) -> psycopg.Connection:
+        return psycopg.connect(
             host=self.host,
             port=self.port,
             user="dummy",

monitoring/uss_qualifier/resources/interuss/crdb/crdb.py renamed to monitoring/uss_qualifier/resources/interuss/datastore/datastore.py

@@ -1,23 +1,23 @@
 from typing import List
 
-from monitoring.uss_qualifier.resources.interuss.crdb import (
-    CockroachDBClusterResource,
-    CockroachDBNode,
+from monitoring.uss_qualifier.resources.interuss.datastore import (
+    DatastoreDBClusterResource,
+    DatastoreDBNode,
 )
 from monitoring.uss_qualifier.scenarios.scenario import GenericTestScenario
 from monitoring.uss_qualifier.suites.suite import ExecutionContext
 
 
-class CRDBAccess(GenericTestScenario):
-    crdb_nodes: List[CockroachDBNode] = []
+class DatastoreAccess(GenericTestScenario):
+    datastore_nodes: List[DatastoreDBNode] = []
 
     def __init__(
         self,
-        crdb_cluster: CockroachDBClusterResource,
+        datastore_cluster: DatastoreDBClusterResource,
     ):
         super().__init__()
-        for node in crdb_cluster.nodes:
-            self.crdb_nodes.append(node.get_client())
+        for node in datastore_cluster.nodes:
+            self.datastore_nodes.append(node.get_client())
 
     def run(self, context: ExecutionContext):
         self.begin_test_scenario(context)
@@ -34,7 +34,7 @@ def run(self, context: ExecutionContext):
 
     def _setup(self) -> None:
         self.begin_test_step("Validate nodes are reachable")
-        for node in self.crdb_nodes:
+        for node in self.datastore_nodes:
             with self.check(
                 "Node is reachable",
                 node.participant_id,
@@ -50,7 +50,7 @@ def _setup(self) -> None:
 
     def _attempt_connection(self) -> None:
         self.begin_test_step("Attempt to connect in insecure mode")
-        for node in self.crdb_nodes:
+        for node in self.datastore_nodes:
             with self.check(
                 "Node runs in secure mode",
                 node.participant_id,
@@ -64,7 +64,7 @@ def _attempt_connection(self) -> None:
         self.end_test_step()
 
         self.begin_test_step("Attempt to connect with legacy encryption protocol")
-        for node in self.crdb_nodes:
+        for node in self.datastore_nodes:
             with self.check(
                 "Node rejects legacy encryption protocols",
                 node.participant_id,

monitoring/uss_qualifier/scenarios/astm/dss/crdb_access.py renamed to monitoring/uss_qualifier/scenarios/astm/dss/datastore_access.py

@@ -1,4 +1,4 @@
-from .crdb_access import CRDBAccess
+from .datastore_access import DatastoreAccess
 from .endpoint_encryption import EndpointEncryption
 from .heavy_traffic_concurrent import HeavyTrafficConcurrent
 from .isa_expiry import ISAExpiry

monitoring/uss_qualifier/scenarios/astm/netrid/v19/dss/__init__.py

@@ -1,17 +1,17 @@
-# ASTM NetRID DSS: Direct CRDB access test scenario
+# ASTM NetRID DSS: Direct datastore access test scenario
 
 ## Overview
 
-Attempt to directly access the CockroachDB (CRDB) nodes intercommunicating to form the DSS Airspace Representation for the DSS instances under test, for the purpose of determining compliance to certain DSS interoperability requirements.
-The psycopg library is used to attempt standard PostgreSQL connections to the nodes as it is the most straightforward way of connecting directly to the CockroachDB nodes while controlling the connection parameters (such as for encryption).
+Attempt to directly access the datastore (CockroachDB or Yugabyte) nodes intercommunicating to form the DSS Airspace Representation for the DSS instances under test, for the purpose of determining compliance to certain DSS interoperability requirements.
+The psycopg library is used to attempt standard PostgreSQL connections to the nodes as it is the most straightforward way of connecting directly to the datastore nodes while controlling the connection parameters (such as for encryption).
 
 This scenario aims at validating the following requirements:
 - **[astm.f3411.v19.DSS0110](../../../../../requirements/astm/f3411/v19.md)**
 - **[astm.f3411.v19.DSS0120](../../../../../requirements/astm/f3411/v19.md)**
 
 ## Resources
-### crdb_cluster
-CockroachDBClusterResource that provides access to a set of CockroachDB nodes constituting the DSS instances under test.
+### datastore_cluster
+DatastoreDBClusterResource that provides access to a set of CockroachDB or Yugabyte nodes constituting the DSS instances under test.
 
 ## Setup test case
 ### Validate nodes are reachable test step

monitoring/uss_qualifier/scenarios/astm/netrid/v19/dss/crdb_access.py

@@ -0,0 +1,8 @@
+from monitoring.uss_qualifier.scenarios.astm.dss.datastore_access import (
+    DatastoreAccess as CommonDatastoreAccess,
+)
+from monitoring.uss_qualifier.scenarios.scenario import TestScenario
+
+
+class DatastoreAccess(TestScenario, CommonDatastoreAccess):
+    pass

monitoring/uss_qualifier/scenarios/astm/netrid/v19/dss/crdb_access.md renamed to monitoring/uss_qualifier/scenarios/astm/netrid/v19/dss/datastore_access.md

@@ -1,4 +1,4 @@
-from .crdb_access import CRDBAccess
+from .datastore_access import DatastoreAccess
 from .endpoint_encryption import EndpointEncryption
 from .heavy_traffic_concurrent import HeavyTrafficConcurrent
 from .isa_expiry import ISAExpiry

monitoring/uss_qualifier/scenarios/astm/netrid/v19/dss/datastore_access.py

@@ -1,17 +1,17 @@
-# ASTM NetRID DSS: Direct CRDB access test scenario
+# ASTM NetRID DSS: Direct datastore access test scenario
 
 ## Overview
 
-Attempt to directly access the CockroachDB (CRDB) nodes intercommunicating to form the DSS Airspace Representation for the DSS instances under test, for the purpose of determining compliance to certain DSS interoperability requirements.
-The psycopg library is used to attempt standard PostgreSQL connections to the nodes as it is the most straightforward way of connecting directly to the CockroachDB nodes while controlling the connection parameters (such as for encryption).
+Attempt to directly access the datastore (CockroachDB or Yugabyte) nodes intercommunicating to form the DSS Airspace Representation for the DSS instances under test, for the purpose of determining compliance to certain DSS interoperability requirements.
+The psycopg library is used to attempt standard PostgreSQL connections to the nodes as it is the most straightforward way of connecting directly to the datastore nodes while controlling the connection parameters (such as for encryption).
 
 This scenario aims at validating the following requirements:
 - **[astm.f3411.v22a.DSS0110](../../../../../requirements/astm/f3411/v22a.md)**
 - **[astm.f3411.v22a.DSS0120](../../../../../requirements/astm/f3411/v22a.md)**
 
 ## Resources
-### crdb_cluster
-CockroachDBClusterResource that provides access to a set of CockroachDB nodes constituting the DSS instances under test.
+### datastore_cluster
+DatastoreDBClusterResource that provides access to a set of CockroachDB or Yugabyte nodes constituting the DSS instances under test.
 
 ## Setup test case
 ### Validate nodes are reachable test step

monitoring/uss_qualifier/scenarios/astm/netrid/v22a/dss/__init__.py

@@ -0,0 +1,8 @@
+from monitoring.uss_qualifier.scenarios.astm.dss.datastore_access import (
+    DatastoreAccess as CommonDatastoreAccess,
+)
+from monitoring.uss_qualifier.scenarios.scenario import TestScenario
+
+
+class DatastoreAccess(TestScenario, CommonDatastoreAccess):
+    pass

monitoring/uss_qualifier/scenarios/astm/netrid/v22a/dss/crdb_access.py

@@ -1,5 +1,5 @@
 from .constraint_ref_simple import CRSimple
-from .crdb_access import CRDBAccess
+from .datastore_access import DatastoreAccess
 from .dss_interoperability import DSSInteroperability
 from .oir_explicit_sub_handling import OIRExplicitSubHandling
 from .oir_implicit_sub_handling import OIRImplicitSubHandling