Fix Key Finding Function (#131)

Fixes a bug where some items were getting mistaken as fides keys.

Author: ThomasLaPiana

.github/workflows/pr_checks.yml

@@ -84,6 +84,7 @@ jobs:
         python_version: ["3.8", "3.9", "3.10", "3.11"]
         pydantic_version: ["1.8.2", "1.9.2", "1.10.9"]
     runs-on: ubuntu-latest
+    continue-on-error: true
     steps:
       - name: Checkout
         uses: actions/checkout@v3

noxfile.py

@@ -1,6 +1,7 @@
 import nox
 
 nox.options.sessions = []
+nox.options.reuse_existing_virtualenvs = True
 
 TESTED_PYTHON_VERSIONS = ["3.8", "3.9", "3.10", "3.11"]
 TESTED_PYDANTIC_VERSIONS = ["1.8.2", "1.9.2", "1.10.9"]

pyproject.toml

@@ -81,8 +81,7 @@ log_level = "DEBUG"
 addopts = ["--cov=fideslang",
             "--cov-report=term-missing",
             "-vv",
-            "--no-cov-on-fail",
-            "--disable-pytest-warnings"]
+            "--no-cov-on-fail",]
 markers = [
     "unit: only runs tests that don't require non-python dependencies (i.e. a database)",
 ]

src/fideslang/relationships.py

@@ -35,8 +35,9 @@ def find_referenced_fides_keys(resource: object) -> Set[FidesKey]:
     """
     referenced_fides_keys: Set[FidesKey] = set()
 
+    # Str type doesn't have a signature, so we return early
     if isinstance(resource, str) and not isinstance(resource, Enum):
-        return {resource}
+        return set()
 
     signature = inspect.signature(type(resource), follow_wrapped=True)
     attributes = filter(
@@ -59,15 +60,15 @@ def find_referenced_fides_keys(resource: object) -> Set[FidesKey]:
             ):
                 nested_keys = find_nested_keys_in_list(attribute_value)
                 referenced_fides_keys.update(nested_keys)
-            # If it is an object, recurse this function
-            elif hasattr(attribute_value, "__dict__"):
+            # If it is a Pydantic Model then recurse
+            elif isinstance(attribute_value, BaseModel):
                 referenced_fides_keys.update(
                     find_referenced_fides_keys(attribute_value)
                 )
     return referenced_fides_keys
 
 
-def get_referenced_missing_keys(taxonomy: Taxonomy) -> List[FidesKey]:
+def get_referenced_missing_keys(taxonomy: Taxonomy) -> Set[FidesKey]:
     """
     Iterate through the Taxonomy and create a set of all of the FidesKeys
     that are contained within it.
@@ -80,9 +81,9 @@ def get_referenced_missing_keys(taxonomy: Taxonomy) -> List[FidesKey]:
     key_set: Set[FidesKey] = set(
         reduce(lambda x, y: set().union(x).union(y), referenced_keys)
     )
-    keys_not_in_taxonomy = [
+    keys_not_in_taxonomy = {
         fides_key
         for fides_key in key_set
         if get_resource_by_fides_key(taxonomy, fides_key) is None
-    ]
+    }
     return keys_not_in_taxonomy

tests/fideslang/test_models.py

@@ -1,11 +1,43 @@
 from pytest import deprecated_call, mark, raises
 
-from fideslang import DataFlow, Dataset, PrivacyDeclaration, System
-from fideslang.models import DatasetCollection, DatasetField
+from fideslang import DataFlow, Dataset, Organization, PrivacyDeclaration, System
+from fideslang.models import ContactDetails, DatasetCollection, DatasetField
 
 pytestmark = mark.unit
 
 
+class TestOrganization:
+    def test_valid_organization(self) -> None:
+        """Create a standard organization"""
+
+    organization = Organization(
+        fides_key="default_organization",
+        name="Demo Organization",
+        description="An e-commerce organization",
+        security_policy="https://ethyca.com/privacy-policy/",
+        controller=ContactDetails(
+            name="Con Troller",
+            address="123 demo street, New York, NY, USA",
+            email="controller@demo_company.com",
+            phone="+1 555 555 5555",
+        ),
+        data_protection_officer=ContactDetails(
+            name="DataPro Tection",
+            address="123 demo street, New York, NY, USA",
+            email="dpo@demo_company.com",
+            phone="+1 555 555 5555",
+        ),
+        representative=ContactDetails(
+            name="Rep Resentative",
+            address="123 demo street, New York, NY, USA",
+            email="representative@demo_company.com",
+            phone="+1 555 555 5555",
+        ),
+        fidesctl_meta=None,
+    )
+    assert organization
+
+
 class TestDataFlow:
     def test_dataflow_valid(self) -> None:
         assert DataFlow(