Replace dolt with nautobot_version_control (#162)

* Update base URL and other plugin info
* The great renaming
* Improve database migration commit message
* Fix tasks
* Cleanup

Author: glennmatthews

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ jobs:
   black:
     runs-on: "ubuntu-20.04"
     env:
-      INVOKE_NAUTOBOT_DOLT_LOCAL: "True"
+      INVOKE_NAUTOBOT_VERSION_CONTROL_LOCAL: "True"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v2"
@@ -19,7 +19,7 @@ jobs:
   bandit:
     runs-on: "ubuntu-20.04"
     env:
-      INVOKE_NAUTOBOT_DOLT_LOCAL: "True"
+      INVOKE_NAUTOBOT_VERSION_CONTROL_LOCAL: "True"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v2"
@@ -33,7 +33,7 @@ jobs:
   pydocstyle:
     runs-on: "ubuntu-20.04"
     env:
-      INVOKE_NAUTOBOT_DOLT_LOCAL: "True"
+      INVOKE_NAUTOBOT_VERSION_CONTROL_LOCAL: "True"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v2"
@@ -47,7 +47,7 @@ jobs:
   flake8:
     runs-on: "ubuntu-20.04"
     env:
-      INVOKE_NAUTOBOT_DOLT_LOCAL: "True"
+      INVOKE_NAUTOBOT_VERSION_CONTROL_LOCAL: "True"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v2"
@@ -61,7 +61,7 @@ jobs:
   yamllint:
     runs-on: "ubuntu-20.04"
     env:
-      INVOKE_NAUTOBOT_DOLT_LOCAL: "True"
+      INVOKE_NAUTOBOT_VERSION_CONTROL_LOCAL: "True"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v2"
@@ -110,11 +110,11 @@ jobs:
       fail-fast: true
       matrix:
         python-version: ["3.6", "3.7", "3.8", "3.9"]
-        nautobot-version: ["1.1.2"]
+        nautobot-version: ["1.2.0-beta.1"]
     runs-on: "ubuntu-20.04"
     env:
-      INVOKE_NAUTOBOT_DOLT_PYTHON_VER: "${{ matrix.python-version }}"
-      INVOKE_NAUTOBOT_DOLT_NAUTOBOT_VER: "${{ matrix.nautobot-version }}"
+      INVOKE_NAUTOBOT_VERSION_CONTROL_PYTHON_VER: "${{ matrix.python-version }}"
+      INVOKE_NAUTOBOT_VERSION_CONTROL_NAUTOBOT_VER: "${{ matrix.nautobot-version }}"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v2"

README.md

@@ -199,9 +199,9 @@ Add this to your `nautobot_config.py`:
 # database so that it may generate diffs.
 DATABASES["global"] = DATABASES["default"]
 
-# Add Dolt to your list of plugins.
+# Add Nautobot Version Control to your list of plugins.
 PLUGINS += [
-   "dolt",
+   "nautobot_version_control",
 ]
 ```
 
@@ -215,7 +215,7 @@ After migrations have been run, then you must enable the `DATABASE_ROUTERS` requ
 
 ```python
 # Dolt requires a custom database router to generate the before & after queries for generating diffs.
-DATABASE_ROUTERS = ["dolt.routers.GlobalStateRouter"]
+DATABASE_ROUTERS = ["nautobot_version_control.routers.GlobalStateRouter"]
 ```
 
 Note that any time you need to perform database migrations (such as when upgrading Nautobot or Dolt) you **absolutely must comment out/disable `DATABASE_ROUTERS` from your `nautobot_config.py`** or you will encounter errors.
@@ -226,4 +226,4 @@ To be written
 
 ### Version Control Installation (migrating an existing Nautobot install)
 
-To be written
+To be written

development/docker-compose.dev.yml

@@ -7,14 +7,14 @@ version: "3.4"
 services:
   nautobot:
     environment:
-      DATABASE_ROUTERS: "dolt.routers.GlobalStateRouter"
+      DATABASE_ROUTERS: "nautobot_version_control.routers.GlobalStateRouter"
     command: "nautobot-server runserver 0.0.0.0:8080"
     volumes:
       - "./nautobot_config.py:/opt/nautobot/nautobot_config.py"
       - "../:/source"
   worker:
     environment:
-      DATABASE_ROUTERS: "dolt.routers.GlobalStateRouter"
+      DATABASE_ROUTERS: "nautobot_version_control.routers.GlobalStateRouter"
     volumes:
       - "./nautobot_config.py:/opt/nautobot/nautobot_config.py"
       - "../:/source"

development/nautobot_config.py

@@ -61,9 +61,9 @@ def is_truthy(arg):
         "PORT": os.getenv("DOLT_PORT", ""),  # Database port (leave blank for default)
         "ENGINE": "django.db.backends.mysql",
     },
-    # TODO: use `dolt.constants.GLOBAL_STATE_DB`
+    # TODO: use `nautobot_version_control.constants.GLOBAL_STATE_DB`
     "global": {
-        # TODO: use `dolt.constants.DOLT_DEFAULT_BRANCH`
+        # TODO: use `nautobot_version_control.constants.DOLT_DEFAULT_BRANCH`
         "NAME": "nautobot",  # Database username
         "USER": os.getenv("DOLT_USER", ""),  # Database username
         "PASSWORD": os.getenv("DOLT_PASSWORD", ""),  # Database password
@@ -263,7 +263,7 @@ def is_truthy(arg):
 
 # Enable installed plugins. Add the name of each plugin to the list.
 PLUGINS = [
-    "dolt",
+    "nautobot_version_control",
 ]
 
 # Pull the list of routers from environment variable to be able to disable all routers when we are running the migrations

docs/design.md

@@ -46,7 +46,7 @@ When the server receives a request, it looks for this state and uses it to selec
 ![active branch banner](images/active-branch-banner.png)
 
 The business logic to handle branch selection is performed in [middleware](https://docs.djangoproject.com/en/stable/topics/http/middleware/), 
-specifically in [DoltBranchMiddleware](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/middleware.py#L36) 
+specifically in [DoltBranchMiddleware](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/middleware.py#L36)
 
 ## Database Versioning
 
@@ -55,8 +55,8 @@ Database connections outside of the web server, such as through nbshell are also
 When connecting directly to the database you can check your current branch with the active_branch() function and switch branches with the checkout() method:
 
 ```python
->>> from dolt.models import Branch
->>> from dolt.utils import active_branch
+>>> from nautobot_version_control.models import Branch
+>>> from nautobot_version_control.utils import active_branch
 >>> active_branch()
     'main'
 >>> Branch.objects.get(name="foo").checkout()
@@ -70,13 +70,13 @@ The Version Control app extends the Nautobot's core [REST API](https://nautobot.
 
 ## REST API EndPoints
 
-The top level API endpoint is `/api/plugins/dolt/`. 
+The top level API endpoint is `/api/plugins/version-control/`.
 Below this, there are endpoints for the following models:
 
-- Branch: `api/plugins/dolt/branches`
-- Commit: `api/plugins/dolt/commits`
-- Pull Request: `api/plugins/dolt/pull_requests` 
-- Pull Request Reviews: `api/plugins/dolt/pull_requests_reviews`
+- Branch: `api/plugins/version-control/branches`
+- Commit: `api/plugins/version-control/commits`
+- Pull Request: `api/plugins/version-control/pull_requests`
+- Pull Request Reviews: `api/plugins/version-control/pull_requests_reviews`
 
 The Version Control API shares a common implementation with Nautobot's core API.
 Features suchs as [pagination](https://nautobot.readthedocs.io/en/stable/rest-api/overview/#pagination) and
@@ -96,7 +96,7 @@ For example, the following request will list all the commits from `my-feature-br
 $ curl -s \
 -H "Authorization: Token 90579810c8d2d2e98fb34d69025f6a1cc3fa9943" \
 -H "dolt-branch: my-feature-branch"  \
-0.0.0.0:8080/api/plugins/dolt/commits/
+0.0.0.0:8080/api/plugins/version-control/commits/
 ```
 
 Versioning requests works with all API endpoints, not just models from the Version Control app. This example queries for devices in a `my-branch`: 
@@ -133,18 +133,18 @@ pprint(response.json())
 ## Commit Logic
 
 The committing logic is implemented using a combination of middleware and [Django signals](https://docs.djangoproject.com/en/stable/topics/signals/),
-specifically [DoltAutoCommitMiddleWare](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/middleware.py#L118). 
-DoltAutoCommitMiddleWare wraps every server request in a [AutoDoltCommit](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/middleware.py#L134)
+specifically [DoltAutoCommitMiddleWare](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/middleware.py#L118).
+DoltAutoCommitMiddleWare wraps every server request in a [AutoDoltCommit](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/middleware.py#L134)
 context manager which listens for and responds to database writes made while processing the request. 
 AutoDoltCommit listens for signals fired by Django model updates and makes a Dolt commit if updates were made during the lifetime of the context manager. 
 The message for the commit is derived from the model signals that were captured.
 
 ## DoltSystemTables
 
-[DoltSystemTable](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/models.py#L22)
+[DoltSystemTable](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/models.py#L22)
 is an abstract base class that forms the basis of Django models that expose Dolt system tables
 to the Object Relational Mapping (ORM). 
-Plugin models such as *Commit* and *Branch* that inherit from DoltSystemTable are [unmanaged](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/models.py#L31
+Plugin models such as *Commit* and *Branch* that inherit from DoltSystemTable are [unmanaged](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/models.py#L31
 meaning that Django will ignore these models for the purposes of database migrations. 
 This is important because Dolt system tables exist from the time the database is created and cannot be modified or deleted. 
 Internally, Dolt generates system table data on-the-fly rather than reading it from a traditional database index.
@@ -154,7 +154,7 @@ Internally, Dolt generates system table data on-the-fly rather than reading it f
 The Branch model is one such "unmanaged" model. 
 It exposes the dolt_branches system table to the ORM. 
 System tables have a static schema, so additional object fields such as "created by" and "source branch" must be stored in another model. 
-The [BranchMeta](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/models.py#L205) model does exactly that. 
+The [BranchMeta](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/models.py#L205) model does exactly that.
 Each Branch object has an associated BranchMeta object where the `BranchMeta.branch field` is equal to the name field of the associated branch. 
 However, this relationship is not formalized with a Foreign Key due to limitations with the dolt_branches table.
 Branch objects lookup their associated BranchMeta objects on a best-effort basis.
@@ -194,15 +194,15 @@ Non-versioned models:
 ## Global State Router
 
 The business logic for differentiating versioned and non-versioned models is implemented in a Django [database router](https://docs.djangoproject.com/en/stable/topics/db/multi-db/#automatic-database-routing), 
-specifically the [GlobalStateRouter](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/routers.py#L10). 
+specifically the [GlobalStateRouter](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/routers.py#L10).
 The GlobalStateRouter is responsible for choosing a database connection to read an object from or write an object to, depending on its model class. 
 There are two connections to choose from when accessing the database. 
 The “default” connection will access the database on the Dolt branch that was specified in the request. 
 This connection is used to read and write versioned models. 
 The “global” connection always accesses the database on the main branch, it is used for non-versioned models.
 
 In order to choose a connection for a model, the router first references the 
-[versioned model registry](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/__init__.py#L87)
+[versioned model registry](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/__init__.py#L87)
 to determine if the model is under version control. 
 Currently, this registry is a hardcoded mapping from ContentType to versioned/non-versioned. 
 The versioned model registry is structured as an ["allow-list"](https://help.dnsfilter.com/hc/en-us/articles/1500008111381-Allow-and-Block-Lists).
@@ -211,7 +211,7 @@ If a model is absent from the list, it is assumed to be non-versioned.
 in Nautobot core will make it possible for models to declare themselves whether they should be version controlled.
 
 Database connections for versioned and non-versioned models are defined in 
-[nautobot_config.py](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/development/nautobot_config.py#L55). 
+[nautobot_config.py](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/development/nautobot_config.py#L55).
 The database configuration is as follows:
 ```python
 DATABASES = {
@@ -259,7 +259,7 @@ Custom rendering functions are added to apply diff styling to the list view.
 
 Diff table classes are created dynamically at runtime. 
 When a diff table is needed to display model changes, the core model's table is looked up from the 
-[diff table registry](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/__init__.py#L179)
+[diff table registry](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/__init__.py#L179)
 and then a new subclass is created to extend the core table.
 The diff table registry works much like the versioned model registry, it is a mapping from a models content type to its table.
 Tables in Nautobot core are all subclasses of [`django-tables2`](https://django-tables2.readthedocs.io/en/latest/).
@@ -270,8 +270,8 @@ All entries in the diff table registry must also be subclasses of `django-tables
 The Version Control app is designed to be used in coordination with other Nautobot plugins.
 By default, any models registered by other plugins will be considered non-versioned. 
 In order to make use of version control and diff features, plugins must register their models in 
-the [versioned models registry](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/__init__.py#L143) 
-and the [diff table registry](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/dolt/__init__.py#L190). 
+the [versioned models registry](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/__init__.py#L143)
+and the [diff table registry](https://github.com/nautobot/nautobot-plugin-version-control/blob/develop/nautobot_version_control/__init__.py#L190).
 Both of these functions take nested dictionaries as arguments:
 ```python
 register_versioned_models({

dolt/__init__.py nautobot_version_control/__init__.py

@@ -1,37 +1,46 @@
 """ This is the main module that contains the code for the Dolt backed Version Control plugin. """
+try:
+    from importlib import metadata
+except ImportError:
+    # Python version < 3.8
+    import importlib_metadata as metadata
 
 from django.db.models.signals import pre_migrate, post_migrate
+import django_tables2
 
 from nautobot.extras.plugins import PluginConfig
 
-import django_tables2
+from nautobot_version_control.migrations import auto_dolt_commit_migration
 
-from dolt.migrations import auto_dolt_commit_migration
+__version__ = metadata.version(__name__)
 
 
-class NautobotDolt(PluginConfig):
-    """NautobotDolt initializes the dolt configs, middleware, and sets up migrations."""
+class NautobotVersionControl(PluginConfig):
+    """NautobotVersionControl initializes the dolt configs, middleware, and sets up migrations."""
 
-    name = "dolt"
-    verbose_name = "Nautobot Dolt"
-    description = "Nautobot + Dolt"
-    version = "0.1"
-    author = "Andy Arthur"
-    author_email = "[email protected]"
+    name = "nautobot_version_control"
+    verbose_name = "Nautobot Version Control"
+    description = "Nautobot Version Control with Dolt"
+    base_url = "version-control"
+    version = __version__
+    author = "Network to Code, LLC"
+    author_email = "[email protected]"
+    min_version = "1.2.0-beta.1"
+    max_version = "1.999"
     required_settings = []
     default_settings = {
         # TODO: are these respected?
         #   this is also set in /development/nautobot_config.py
         "DATABASE_ROUTERS": [
-            "dolt.routers.GlobalStateRouter",
+            "nautobot_version_control.routers.GlobalStateRouter",
         ],
         "SESSION_ENGINE": "django.contrib.sessions.backends.signed_cookies",
         "CACHEOPS_ENABLED": False,
     }
     middleware = [
-        "dolt.middleware.dolt_health_check_intercept_middleware",
-        "dolt.middleware.DoltBranchMiddleware",
-        "dolt.middleware.DoltAutoCommitMiddleware",
+        "nautobot_version_control.middleware.dolt_health_check_intercept_middleware",
+        "nautobot_version_control.middleware.DoltBranchMiddleware",
+        "nautobot_version_control.middleware.DoltAutoCommitMiddleware",
     ]
 
     def ready(self):
@@ -45,7 +54,7 @@ def ready(self):
         post_migrate.connect(auto_dolt_commit_migration, sender=self)
 
 
-config = NautobotDolt  # pylint: disable=C0103
+config = NautobotVersionControl  # pylint: disable=C0103
 
 
 def query_registry(model, registry):
@@ -85,7 +94,7 @@ def query_registry(model, registry):
 # may also be a nest dict containing a subset of version-controlled models
 # within the app_label.
 __VERSIONED_MODEL_REGISTRY___ = {
-    "dolt": {
+    "nautobot_version_control": {
         # Pull Requests are not versioned
         "pullrequest": False,
         "pullrequestreviewcomments": False,

dolt/admin.py nautobot_version_control/admin.py

@@ -1,6 +1,6 @@
 """serializers.py implements serializers for different modules."""
 from nautobot.core.api import ValidatedModelSerializer
-from dolt.models import Branch, Commit, PullRequest, PullRequestReview
+from nautobot_version_control.models import Branch, Commit, PullRequest, PullRequestReview
 
 
 class BranchSerializer(ValidatedModelSerializer):

dolt/api/__init__.py nautobot_version_control/api/__init__.py

@@ -13,5 +13,5 @@
 router.register("pull_requests", views.PullRequestViewSet)
 router.register("pull_requests_reviews", views.PullRequestReviewViewSet)
 
-app_name = "dolt-api"
+app_name = "nautobot_version_control-api"
 urlpatterns = router.urls

dolt/api/serializers.py nautobot_version_control/api/serializers.py

@@ -3,8 +3,8 @@
 from rest_framework.routers import APIRootView
 from nautobot.extras.api.views import CustomFieldModelViewSet
 
-from dolt import filters
-from dolt.models import Branch, Commit, PullRequest, PullRequestReview
+from nautobot_version_control import filters
+from nautobot_version_control.models import Branch, Commit, PullRequest, PullRequestReview
 
 from . import serializers
 

dolt/api/urls.py nautobot_version_control/api/urls.py

@@ -5,8 +5,8 @@
 from nautobot.extras.choices import BannerClassChoices
 from nautobot.extras.plugins import PluginBanner
 
-from dolt.constants import DOLT_BRANCH_KEYWORD
-from dolt.utils import active_branch
+from nautobot_version_control.constants import DOLT_BRANCH_KEYWORD
+from nautobot_version_control.utils import active_branch
 
 
 def banner(context, *args, **kwargs):

dolt/api/views.py nautobot_version_control/api/views.py

@@ -12,9 +12,9 @@
 from nautobot.tenancy import tables as tenancy_tables
 from nautobot.virtualization import tables as virtualization_tables
 
-from dolt.dynamic.diff_factory import DiffListViewFactory
-from dolt.models import Commit
-from dolt.utils import db_for_commit
+from nautobot_version_control.dynamic.diff_factory import DiffListViewFactory
+from nautobot_version_control.models import Commit
+from nautobot_version_control.utils import db_for_commit
 
 from . import diff_table_for_model, register_diff_tables