Pylint updates, add experimental conditional re-cache dynamic groups

docs/admin/release_notes/version_2.1.md

@@ -11,6 +11,10 @@
 
 - [#792](https://github.com/nautobot/nautobot-app-golden-config/issues/792) - Fixed issue with dynamic groups not being called in 2.3.0.
 
+### Changed
+
+- [#792](https://github.com/nautobot/nautobot-app-golden-config/issues/792) - Added an experimental `_manual_dynamic_group_mgmt` config to collect feedback on appropriate methodology, use at your own risk!!.
+
 ### Housekeeping
 
 - [#786](https://github.com/nautobot/nautobot-app-golden-config/issues/786) - Fixed incorrect test data setup for `test_tags_filter()` test for `ConfigPlanFilterTestCase`.

docs/user/app_getting_started.md

@@ -306,7 +306,7 @@ Using the previous example, everything will use the napalm dispatcher, this is i
 }
 ```
 
-Using the previous example, everything will use the napalm dispatcher **except** forinet, which would use netmiko.
+Using the previous example, everything will use the napalm dispatcher **except** fortinet, which would use netmiko.
 
 ```json
 # DEFAULT_FRAMEWORK
@@ -321,7 +321,7 @@ Using the previous example, everything will use the napalm dispatcher **except**
 }
 ```
 
-Using the previous example, everything will use the napalm dispatcher **except** forinet **and** when using the `get_config` method for `arista_eos` and `cisco_nxos`, use netmiko.
+Using the previous example, everything will use the napalm dispatcher **except** fortinet **and** when using the `get_config` method for `arista_eos` and `cisco_nxos`, use netmiko.
 
 As you can see, you now have the flexibility to control which network_driver will use which framework for every method, as each constance setting is sanely named to match the method name (e.g. `GET_CONFIG_FRAMEWORK` maps the `get_config` method). Additionally, if the current `network_driver` and associated `network_driver_mappings` is not sufficient as is, you can extend the [NETWORK DRIVER](https://docs.nautobot.com/projects/core/en/stable/user-guide/administration/configuration/optional-settings/#network_drivers) settings as well.
 

nautobot_golden_config/__init__.py

@@ -36,6 +36,9 @@ class GoldenConfig(NautobotAppConfig):
         "per_feature_width": 13,
         "per_feature_height": 4,
         "get_custom_compliance": None,
+        # This is an experimental and undocumented setting that will change in the future!!
+        # Use at your own risk!!!!!
+        "_manual_dynamic_group_mgmt": False, 
         "jinja_env": {
             "undefined": "jinja2.StrictUndefined",
             "trim_blocks": True,

nautobot_golden_config/api/serializers.py

@@ -87,7 +87,7 @@ class Meta:
         fields = "__all__"
 
 
-class ConfigToPushSerializer(DeviceSerializer):
+class ConfigToPushSerializer(DeviceSerializer):  # pylint: disable=nb-sub-class-name
     """Serializer for ConfigToPush view."""
 
     config = serializers.SerializerMethodField()

nautobot_golden_config/filters.py

@@ -123,18 +123,7 @@ class Meta:
 
         model = models.GoldenConfig
         distinct = True
-        fields = [
-            "id",
-            "backup_config",
-            "backup_last_attempt_date",
-            "backup_last_success_date",
-            "intended_config",
-            "intended_last_attempt_date",
-            "intended_last_success_date",
-            "compliance_config",
-            "compliance_last_attempt_date",
-            "compliance_last_success_date",
-        ]
+        fields = "__all__"
 
 
 class ConfigComplianceFilterSet(GoldenConfigFilterSet):  # pylint: disable=too-many-ancestors
@@ -156,7 +145,7 @@ class Meta:
         """Meta class attributes for ConfigComplianceFilter."""
 
         model = models.ConfigCompliance
-        fields = ["id", "compliance", "actual", "intended", "missing", "extra", "ordered", "compliance_int", "rule"]
+        fields = "__all__"
 
 
 class ComplianceFeatureFilterSet(NautobotFilterSet):
@@ -175,7 +164,7 @@ class Meta:
         """Boilerplate filter Meta data for compliance feature."""
 
         model = models.ComplianceFeature
-        fields = ["id", "name", "slug", "description"]
+        fields = "__all__"
 
 
 class ComplianceRuleFilterSet(NautobotFilterSet):
@@ -200,7 +189,7 @@ class Meta:
         """Boilerplate filter Meta data for compliance rule."""
 
         model = models.ComplianceRule
-        fields = ["feature", "id"]
+        fields = "__all__"
 
 
 class ConfigRemoveFilterSet(NautobotFilterSet):
@@ -225,7 +214,7 @@ class Meta:
         """Boilerplate filter Meta data for Config Remove."""
 
         model = models.ConfigRemove
-        fields = ["id", "name"]
+        fields = "__all__"
 
 
 class ConfigReplaceFilterSet(NautobotFilterSet):
@@ -250,7 +239,7 @@ class Meta:
         """Boilerplate filter Meta data for Config Replace."""
 
         model = models.ConfigReplace
-        fields = ["id", "name"]
+        fields = "__all__"
 
 
 class GoldenConfigSettingFilterSet(NautobotFilterSet):
@@ -260,7 +249,7 @@ class Meta:
         """Boilerplate filter Meta data for Config Remove."""
 
         model = models.GoldenConfigSetting
-        fields = ["id", "name", "slug", "weight", "backup_repository", "intended_repository", "jinja_repository"]
+        fields = "__all__"
 
 
 class RemediationSettingFilterSet(NautobotFilterSet):
@@ -293,7 +282,7 @@ class Meta:
         """Boilerplate filter Meta data for Remediation Setting."""
 
         model = models.RemediationSetting
-        fields = ["id", "remediation_type"]
+        fields = "__all__"
 
 
 class ConfigPlanFilterSet(NautobotFilterSet):
@@ -433,4 +422,4 @@ class Meta:
         """Boilerplate filter Meta data for Config Plan."""
 
         model = models.ConfigPlan
-        fields = ["id", "created", "change_control_id", "plan_type", "tags"]
+        fields = "__all__"

nautobot_golden_config/forms.py

@@ -16,7 +16,7 @@
 # ConfigCompliance
 
 
-class DeviceRelatedFilterForm(NautobotFilterForm):
+class DeviceRelatedFilterForm(NautobotFilterForm):  # pylint: disable=nb-no-model-found
     """Base FilterForm for below FilterForms."""
 
     tenant_group_id = forms.DynamicModelMultipleChoiceField(
@@ -95,18 +95,6 @@ class DeviceRelatedFilterForm(NautobotFilterForm):
     )
 
 
-class GoldenConfigForm(NautobotModelForm):
-    """Filter Form for ComplianceFeature instances."""
-
-    slug = forms.SlugField()  # TODO: 2.1: Change from slugs once django-pivot is figured out
-
-    class Meta:
-        """Boilerplate form Meta data for compliance feature."""
-
-        model = models.ComplianceFeature
-        fields = ("name", "slug", "description", "tags")
-
-
 class GoldenConfigFilterForm(DeviceRelatedFilterForm):
     """Filter Form for GoldenConfig."""
 
@@ -144,16 +132,6 @@ class Meta:
         nullable_fields = []
 
 
-class ConfigComplianceForm(NautobotModelForm):
-    """Filter Form for ConfigCompliance instances."""
-
-    class Meta:
-        """Boilerplate form Meta data for compliance feature."""
-
-        model = models.ConfigCompliance
-        fields = []
-
-
 class ConfigComplianceFilterForm(DeviceRelatedFilterForm):
     """Filter Form for ConfigCompliance instances."""
 
@@ -204,17 +182,7 @@ class Meta:
         """Boilerplate form Meta data for compliance rule."""
 
         model = models.ComplianceRule
-        fields = (
-            "platform",
-            "feature",
-            "description",
-            "config_ordered",
-            "config_type",
-            "match_config",
-            "custom_compliance",
-            "config_remediation",
-            "tags",
-        )
+        fields = "__all__"
 
 
 class ComplianceRuleFilterForm(NautobotFilterForm):
@@ -263,7 +231,7 @@ class Meta:
         """Boilerplate form Meta data for compliance feature."""
 
         model = models.ComplianceFeature
-        fields = ("name", "slug", "description", "tags")
+        fields = "__all__"
 
 
 class ComplianceFeatureFilterForm(NautobotFilterForm):
@@ -300,13 +268,7 @@ class Meta:
         """Boilerplate form Meta data for removal feature."""
 
         model = models.ConfigRemove
-        fields = (
-            "platform",
-            "name",
-            "description",
-            "regex",
-            "tags",
-        )
+        fields = "__all__"
 
 
 class ConfigRemoveFilterForm(NautobotFilterForm):
@@ -347,14 +309,7 @@ class Meta:
         """Boilerplate form Meta data for removal feature."""
 
         model = models.ConfigReplace
-        fields = (
-            "platform",
-            "name",
-            "description",
-            "regex",
-            "replace",
-            "tags",
-        )
+        fields = "__all__"
 
 
 class ConfigReplaceFilterForm(NautobotFilterForm):
@@ -548,7 +503,7 @@ class Meta:
         fields = "__all__"
 
 
-class ConfigPlanUpdateForm(NautobotModelForm):
+class ConfigPlanUpdateForm(NautobotModelForm):  # pylint: disable=nb-sub-class-name
     """Form for ConfigPlan instances."""
 
     status = forms.DynamicModelChoiceField(
@@ -563,7 +518,7 @@ class Meta:
         """Boilerplate form Meta data for ConfigPlan."""
 
         model = models.ConfigPlan
-        fields = (
+        fields = (  # pylint: disable=nb-use-fields-all
             "change_control_id",
             "change_control_url",
             "status",

nautobot_golden_config/jobs.py

@@ -40,7 +40,11 @@
     generate_config_set_from_manual,
 )
 from nautobot_golden_config.utilities.git import GitRepo
-from nautobot_golden_config.utilities.helper import get_device_to_settings_map, get_job_filter, update_dynamic_groups_cache
+from nautobot_golden_config.utilities.helper import (
+    get_device_to_settings_map,
+    get_job_filter,
+    update_dynamic_groups_cache,
+)
 
 InventoryPluginRegister.register("nautobot-inventory", NautobotORMInventory)
 

nautobot_golden_config/tables.py

@@ -190,7 +190,7 @@ class Meta(BaseTable.Meta):
         # All other fields (ConfigCompliance names) are constructed dynamically at instantiation time - see views.py
 
 
-class ConfigComplianceGlobalFeatureTable(BaseTable):
+class ConfigComplianceGlobalFeatureTable(BaseTable):  # pylint: disable=nb-sub-class-name
     """Table for feature compliance report."""
 
     name = Column(accessor="rule__feature__slug", verbose_name="Feature")
@@ -213,7 +213,7 @@ class Meta(BaseTable.Meta):
         ]
 
 
-class ConfigComplianceDeleteTable(BaseTable):
+class ConfigComplianceDeleteTable(BaseTable):  # pylint: disable=nb-sub-class-name
     """Table for device compliance report."""
 
     feature = Column(accessor="rule__feature__name", verbose_name="Feature")
@@ -226,7 +226,7 @@ class Meta(BaseTable.Meta):
         fields = ("device", "feature")
 
 
-class DeleteGoldenConfigTable(BaseTable):
+class DeleteGoldenConfigTable(BaseTable):  # pylint: disable=nb-sub-class-name
     """
     Table used in bulk delete confirmation.
 

nautobot_golden_config/tests/forms/test_golden_config_settings.py

@@ -21,7 +21,7 @@ def setUp(self) -> None:
         GoldenConfigSetting.objects.all().delete()
 
     def test_no_query_no_scope_success(self):
-        """Testing GoldenConfigForm without specifying a unique scope or GraphQL Query."""
+        """Testing GoldenConfigSettingForm without specifying a unique scope or GraphQL Query."""
         with mock.patch("nautobot_golden_config.models.ENABLE_SOTAGG", False):
             form = GoldenConfigSettingForm(
                 data={
@@ -41,7 +41,7 @@ def test_no_query_no_scope_success(self):
             self.assertTrue(form.save())
 
     def test_no_query_fail(self):
-        """Testing GoldenConfigForm without specifying a unique scope or GraphQL Query."""
+        """Testing GoldenConfigSettingForm without specifying a unique scope or GraphQL Query."""
         with mock.patch("nautobot_golden_config.models.ENABLE_SOTAGG", True):
             form = GoldenConfigSettingForm(
                 data={

nautobot_golden_config/utilities/helper.py

@@ -282,5 +282,6 @@ def get_xml_subtree_with_full_path(config_xml, match_config):
 
 def update_dynamic_groups_cache():
     """Update dynamic group cache for all golden config dynamic groups."""
-    for setting in models.GoldenConfigSetting.objects.all():
-        setting.dynamic_group.update_cached_members()
+    if not settings.PLUGINS_CONFIG[app_config.name].get("_manual_dynamic_group_mgmt"):
+        for setting in models.GoldenConfigSetting.objects.all():
+            setting.dynamic_group.update_cached_members()

nautobot_golden_config/views.py

@@ -60,7 +60,6 @@ class GoldenConfigUIViewSet(  # pylint: disable=abstract-method
     table_class = tables.GoldenConfigTable
     filterset_class = filters.GoldenConfigFilterSet
     filterset_form_class = forms.GoldenConfigFilterForm
-    form_class = forms.GoldenConfigForm
     queryset = models.GoldenConfig.objects.all()
     serializer_class = serializers.GoldenConfigSerializer
     action_buttons = ("export",)