Add Secrets and SecretsGroup as versioned models, fix user/email handling (#154) (#156)

Author: glennmatthews

dolt/__init__.py

@@ -123,6 +123,8 @@ def query_registry(model, registry):
         "objectchange": True,
         "relationship": True,
         "relationshipassociation": True,
+        "secret": True,
+        "secretsgroup": True,
         "status": True,
         "tag": True,
         "taggeditem": True,

dolt/diffs.py

@@ -5,8 +5,9 @@
 from django.db import models
 from django.db.models.expressions import RawSQL
 
-from nautobot.dcim.tables import cables, devices, devicetypes, power, racks, sites
 from nautobot.circuits import tables as circuits_tables
+from nautobot.dcim.tables import cables, devices, devicetypes, power, racks, sites
+from nautobot.extras import tables as extras_tables
 from nautobot.ipam import tables as ipam_tables
 from nautobot.tenancy import tables as tenancy_tables
 from nautobot.virtualization import tables as virtualization_tables
@@ -140,6 +141,12 @@ def json_diff_fields(tbl_name):
 
 register_diff_tables(
     {
+        "circuits": {
+            "circuit": circuits_tables.CircuitTable,
+            # "circuittermination": None,
+            "circuittype": circuits_tables.CircuitTypeTable,
+            "provider": circuits_tables.ProviderTable,
+        },
         "dcim": {
             # "baseinterface": devices.BaseInterfaceTable,
             "cable": cables.CableTable,
@@ -190,11 +197,9 @@ def json_diff_fields(tbl_name):
             "site": sites.SiteTable,
             "virtualchassis": devices.VirtualChassisTable,
         },
-        "circuits": {
-            "circuit": circuits_tables.CircuitTable,
-            # "circuittermination": None,
-            "circuittype": circuits_tables.CircuitTypeTable,
-            "provider": circuits_tables.ProviderTable,
+        "extras": {
+            "secret": extras_tables.SecretTable,
+            "secretsgroup": extras_tables.SecretsGroupTable,
         },
         "ipam": {
             "aggregate": ipam_tables.AggregateTable,

dolt/tests.py

@@ -29,7 +29,10 @@ class TestBranches(DoltTestCase):
 
     def setUp(self):
         """setUp is ran before every testcase."""
-        self.user = User.objects.get_or_create(username="branch-test", is_superuser=True)[0]
+        self.user, _ = User.objects.get_or_create(
+            username="branch-test", email="branch-test@example.com", is_superuser=True
+        )
+        self.user_no_email, _ = User.objects.get_or_create(username="branch-test-no-email", is_superuser=True)
 
     def tearDown(self):
         """tearDown is ran after every testcase."""
@@ -77,11 +80,21 @@ def test_merge_ff(self):
 
         Commit(message="commit any changes").save(user=self.user)
 
+        # Commit().save() doesn't update the PK correctly, it appears - .refresh_from_db() fails with
+        # "Commit matching query does not exist". So we need to load it fresh from the DB instead:
+        commit = Commit.objects.order_by("date").last()
+        self.assertEqual(commit.committer, self.user.username)
+        self.assertEqual(commit.email, self.user.email)
+
         # Checkout to the other branch and make a change
         other.checkout()
         Manufacturer.objects.all().delete()
         Manufacturer.objects.create(name="m1", slug="m-1")
-        Commit(message="added a manufacturer").save(user=self.user)
+        Commit(message="added a manufacturer").save(user=self.user_no_email)
+
+        commit = Commit.objects.order_by("date").last()
+        self.assertEqual(commit.committer, self.user_no_email.username)
+        self.assertEqual(commit.email, f"{self.user_no_email.username}@nautobot.invalid")
 
         # Now do a merge
         main.checkout()
@@ -106,7 +119,7 @@ def test_merge_no_ff(self):
         # Checkout to the other branch and make a change
         other.checkout()
         Manufacturer.objects.create(name="m3", slug="m-3")
-        Commit(message="commit m3").save(user=self.user)
+        Commit(message="commit m3").save(user=self.user_no_email)
 
         # Now do a merge
         main.checkout()

dolt/utils.py

@@ -15,12 +15,18 @@ class DoltError(Exception):
     pass  # pylint: disable=W0107
 
 
-def author_from_user(usr):
-    """author_from_user returns an author string from a user object."""
-    if usr and usr.username and usr.email:
-        return f"{usr.username} <{usr.email}>"
+def author_from_user(user):
+    """author_from_user returns an author string from a user object.
+
+    Note that while user.email is optional in Django, it's mandatory for Dolt.
+    """
+    if user:
+        if user.email:
+            return f"{user.username} <{user.email}>"
+        # RFC 6761 defines .invalid as a reserved TLD that will never be used for real-world domains
+        return f"{user.username} <{user.username}@nautobot.invalid>"
     # default to generic user
-    return "nautobot <nautobot@ntc.com>"
+    return "unknown <unknown@nautobot.invalid>"
 
 
 def is_dolt_model(model):