Package

nautobot_version_control

This is the main module that contains the code for the Dolt backed Version Control plugin.

NautobotVersionControl

Bases: PluginConfig

NautobotVersionControl initializes the dolt configs, middleware, and sets up migrations.

Source code in nautobot_version_control/__init__.py

class NautobotVersionControl(PluginConfig):
    """NautobotVersionControl initializes the dolt configs, middleware, and sets up migrations."""

    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 = "opensource@networktocode.com"
    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": [
            "nautobot_version_control.routers.GlobalStateRouter",
        ],
        "SESSION_ENGINE": "django.contrib.sessions.backends.signed_cookies",
        "CACHEOPS_ENABLED": False,
    }
    middleware = [
        "nautobot_version_control.middleware.dolt_health_check_intercept_middleware",
        "nautobot_version_control.middleware.DoltBranchMiddleware",
        "nautobot_version_control.middleware.DoltAutoCommitMiddleware",
    ]

    def ready(self):
        super().ready()

        # disable the GlobalStateRouter during migrations.
        pre_migrate.connect(switch_global_router_off, sender=self)
        post_migrate.connect(switch_global_router_on, sender=self)

        # make a Dolt commit to save database migrations.
        post_migrate.connect(auto_dolt_commit_migration, sender=self)

diff_table_for_model(model)

Returns a table object for a model, if it exists in the __DIFF_TABLE_REGISTRY__.

Source code in nautobot_version_control/__init__.py

def diff_table_for_model(model):
    """
    Returns a table object for a model, if it exists in
    the ` __DIFF_TABLE_REGISTRY__`.
    """
    return query_registry(model, __DIFF_TABLE_REGISTRY__)

is_global_router_enabled()

Returns true if the GLOBAL_ROUTER_SWITCH is turned on

Source code in nautobot_version_control/__init__.py

def is_global_router_enabled():
    """Returns true if the __GLOBAL_ROUTER_SWITCH__ is turned on"""
    global __GLOBAL_ROUTER_SWITCH__  # pylint: disable=W0602
    return __GLOBAL_ROUTER_SWITCH__

is_versioned_model(model)

Determines whether a model's is under version control. See MODELS_UNDER_VERSION_CONTROL for more info.

Source code in nautobot_version_control/__init__.py

def is_versioned_model(model):
    """
    Determines whether a model's is under version control.
    See __MODELS_UNDER_VERSION_CONTROL__ for more info.
    """
    registry = __VERSIONED_MODEL_REGISTRY___
    return bool(query_registry(model, registry))

query_registry(model, registry)

Performs a lookup on a content type registry.

Parameters:

Name	Type	Description	Default
model	django.db.models.Model	a Django model class	required
registry	dict	a python dictionary like { "my_app_label": True, "my_other_model": { "my_model": True, }, } The type of <value> is specific to each registry. A return value of None signals that nothing is registered for that model.	required

Source code in nautobot_version_control/__init__.py

def query_registry(model, registry):
    """Performs a lookup on a content type registry.
    Args:
        model (django.db.models.Model): a Django model class
        registry (dict): a python dictionary like
            ```
            {
                "my_app_label": True,
                "my_other_model": {
                    "my_model": True,
                },
            }
            ```
            The type of `<value>` is specific to each
            registry. A return value of `None` signals
            that nothing is registered for that `model`.
    """
    app_label = model._meta.app_label
    model = model.__name__.lower()

    if app_label not in registry:
        return None
    if not isinstance(registry[app_label], dict):
        return registry[app_label]

    # subset specified
    if model not in registry[app_label]:
        return None
    return registry[app_label][model]

register_diff_tables(registry)

Register additional tables to be used in diffs. Registry values must be subclasses of django_tables2.Table.

Parameters:

Name	Type	Description	Default
registry	dict	a python dict of content types that will be placed under version control: { "my_app_label": True, "my_other_model": { "my_model": True, }, }	required

Source code in nautobot_version_control/__init__.py

def register_diff_tables(registry):
    """Register additional tables to be used in diffs.
    Registry values must be subclasses of django_tables2.Table.

    Args:
        registry (dict): a python dict of content types that
            will be placed under version control:
            ```
            {
                "my_app_label": True,
                "my_other_model": {
                    "my_model": True,
                },
            }
            ```
    """
    err = ValueError("invalid diff table registry")
    for key, val in registry.items():
        if not isinstance(key, str):
            # key must be string
            raise err
        if not isinstance(val, dict):
            # val must be dict
            raise err
        for k, v in val.items():
            if not isinstance(k, str):
                # k must be string
                raise err
            if not issubclass(v, django_tables2.tables.Table):
                # v must be Table
                raise err
    __DIFF_TABLE_REGISTRY__.update(registry)

register_versioned_models(registry)

Register additional content types to be versioned.

Parameters:

Name	Type	Description	Default
registry	dict	a python dict of content types that will be placed under version control: { "my_app_label": True, "my_other_model": { "my_model": True, }, }	required

Source code in nautobot_version_control/__init__.py

def register_versioned_models(registry):
    """Register additional content types to be versioned.
    Args:
        registry (dict): a python dict of content types that
            will be placed under version control:
            ```
            {
                "my_app_label": True,
                "my_other_model": {
                    "my_model": True,
                },
            }
            ```
    """
    err = ValueError("invalid versioned model registry")
    for key, val in registry.items():
        if not isinstance(key, str):
            # key must be string
            raise err
        if isinstance(val, bool):
            # val may be bool
            continue
        if not isinstance(val, dict):
            # val must be dict if not bool
            raise err
        # validate nested dict
        for k, v in val.items():
            if not isinstance(k, str):
                # k must be string
                raise err
            if not isinstance(v, bool):
                # v must be bool
                raise err
    __VERSIONED_MODEL_REGISTRY___.update(registry)

switch_global_router_off(kwargs)

Sets __GLOBAL_ROUTER_SWITCH to false

Source code in nautobot_version_control/__init__.py

def switch_global_router_off(**kwargs):
    """Sets __GLOBAL_ROUTER_SWITCH to false"""
    global __GLOBAL_ROUTER_SWITCH__
    __GLOBAL_ROUTER_SWITCH__ = False

switch_global_router_on(kwargs)

Sets __GLOBAL_ROUTER_SWITCH to true

Source code in nautobot_version_control/__init__.py

def switch_global_router_on(**kwargs):
    """Sets __GLOBAL_ROUTER_SWITCH to true"""

    global __GLOBAL_ROUTER_SWITCH__
    __GLOBAL_ROUTER_SWITCH__ = True