| Access List |
@@ -32,6 +33,7 @@
+ Details
| Remark |
{{ object.get_remark_display|placeholder }} |
diff --git a/netbox_acls/templates/netbox_acls/aclinterfaceassignment.html b/netbox_acls/templates/netbox_acls/aclinterfaceassignment.html
index 4cabeb0..606f99e 100644
--- a/netbox_acls/templates/netbox_acls/aclinterfaceassignment.html
+++ b/netbox_acls/templates/netbox_acls/aclinterfaceassignment.html
@@ -8,6 +8,7 @@
+ Host
| Host |
diff --git a/netbox_acls/templates/netbox_acls/aclstandardrule.html b/netbox_acls/templates/netbox_acls/aclstandardrule.html
index 4a83b3c..c8e2562 100644
--- a/netbox_acls/templates/netbox_acls/aclstandardrule.html
+++ b/netbox_acls/templates/netbox_acls/aclstandardrule.html
@@ -7,6 +7,7 @@
+ ACL Standard Rule
| Access List |
@@ -32,6 +33,7 @@
+ Details
| Remark |
{{ object.get_remark_display|placeholder }} |
diff --git a/netbox_acls/tests/__init__.py b/netbox_acls/tests/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/netbox_acls/tests/test_api.py b/netbox_acls/tests/test_api.py
new file mode 100644
index 0000000..207f1dd
--- /dev/null
+++ b/netbox_acls/tests/test_api.py
@@ -0,0 +1,97 @@
+from dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Site
+from django.contrib.contenttypes.models import ContentType
+from django.urls import reverse
+from rest_framework import status
+from utilities.testing import APITestCase, APIViewTestCases
+
+from netbox_acls.choices import *
+from netbox_acls.models import *
+
+
+class AppTest(APITestCase):
+ def test_root(self):
+ url = reverse("plugins-api:netbox_acls-api:api-root")
+ response = self.client.get(f"{url}?format=api", **self.header)
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+
+class ACLTestCase(
+ APIViewTestCases.APIViewTestCase,
+):
+ """Test the AccessList Test"""
+
+ model = AccessList
+ view_namespace = "plugins-api:netbox_acls"
+ brief_fields = ["display", "id", "name", "url"]
+
+ @classmethod
+ def setUpTestData(cls):
+ site = Site.objects.create(name="Site 1", slug="site-1")
+ manufacturer = Manufacturer.objects.create(
+ name="Manufacturer 1",
+ slug="manufacturer-1",
+ )
+ devicetype = DeviceType.objects.create(
+ manufacturer=manufacturer,
+ model="Device Type 1",
+ )
+ devicerole = DeviceRole.objects.create(
+ name="Device Role 1",
+ slug="device-role-1",
+ )
+ device = Device.objects.create(
+ name="Device 1",
+ site=site,
+ device_type=devicetype,
+ device_role=devicerole,
+ )
+
+ access_lists = (
+ AccessList(
+ name="testacl1",
+ assigned_object_type=ContentType.objects.get_for_model(Device),
+ assigned_object_id=device.id,
+ type=ACLTypeChoices.TYPE_STANDARD,
+ default_action=ACLActionChoices.ACTION_DENY,
+ ),
+ AccessList(
+ name="testacl2",
+ assigned_object_type=ContentType.objects.get_for_model(Device),
+ assigned_object_id=device.id,
+ type=ACLTypeChoices.TYPE_STANDARD,
+ default_action=ACLActionChoices.ACTION_DENY,
+ ),
+ AccessList(
+ name="testacl3",
+ assigned_object_type=ContentType.objects.get_for_model(Device),
+ assigned_object_id=device.id,
+ type=ACLTypeChoices.TYPE_STANDARD,
+ default_action=ACLActionChoices.ACTION_DENY,
+ ),
+ )
+ AccessList.objects.bulk_create(access_lists)
+
+ cls.create_data = [
+ {
+ "name": "testacl4",
+ "assigned_object_type": "dcim.device",
+ "assigned_object_id": device.id,
+ "type": ACLTypeChoices.TYPE_STANDARD,
+ "default_action": ACLActionChoices.ACTION_DENY,
+ },
+ {
+ "name": "testacl5",
+ "assigned_object_type": "dcim.device",
+ "assigned_object_id": device.id,
+ "type": ACLTypeChoices.TYPE_EXTENDED,
+ "default_action": ACLActionChoices.ACTION_DENY,
+ },
+ {
+ "name": "testacl6",
+ "assigned_object_type": "dcim.device",
+ "assigned_object_id": device.id,
+ "type": ACLTypeChoices.TYPE_STANDARD,
+ "default_action": ACLActionChoices.ACTION_DENY,
+ },
+ ]
diff --git a/netbox_acls/urls.py b/netbox_acls/urls.py
index c5f07a1..d7624a1 100644
--- a/netbox_acls/urls.py
+++ b/netbox_acls/urls.py
@@ -5,7 +5,7 @@ Map Views to URLs.
from django.urls import include, path
from utilities.urls import get_model_urls
-from . import models, views
+from . import views
urlpatterns = (
# Access Lists
@@ -47,7 +47,11 @@ urlpatterns = (
views.ACLInterfaceAssignmentEditView.as_view(),
name="aclinterfaceassignment_add",
),
- # path('interface-assignments/edit/', views.ACLInterfaceAssignmentBulkEditView.as_view(), name='aclinterfaceassignment_bulk_edit'),
+ # path(
+ # "interface-assignments/edit/",
+ # views.ACLInterfaceAssignmentBulkEditView.as_view(),
+ # name="aclinterfaceassignment_bulk_edit"
+ # ),
path(
"interface-assignments/delete/",
views.ACLInterfaceAssignmentBulkDeleteView.as_view(),
diff --git a/netbox_acls/version.py b/netbox_acls/version.py
index bc86c94..67bc602 100644
--- a/netbox_acls/version.py
+++ b/netbox_acls/version.py
@@ -1 +1 @@
-__version__ = "1.2.2"
+__version__ = "1.3.0"
diff --git a/netbox_acls/views.py b/netbox_acls/views.py
index d986945..9f1fa81 100644
--- a/netbox_acls/views.py
+++ b/netbox_acls/views.py
@@ -50,7 +50,8 @@ class AccessListView(generic.ObjectView):
def get_extra_context(self, request, instance):
"""
- Depending on the Access List type, the list view will return the required ACL Rule using the previous defined tables in tables.py.
+ Depending on the Access List type, the list view will return
+ the required ACL Rule using the previous defined tables in tables.py.
"""
if instance.type == choices.ACLTypeChoices.TYPE_EXTENDED:
@@ -227,8 +228,7 @@ class ACLInterfaceAssignmentEditView(generic.ObjectEditView):
"""
return {
- "access_list": request.GET.get("access_list")
- or request.POST.get("access_list"),
+ "access_list": request.GET.get("access_list") or request.POST.get("access_list"),
"direction": request.GET.get("direction") or request.POST.get("direction"),
}
@@ -360,8 +360,7 @@ class ACLStandardRuleEditView(generic.ObjectEditView):
"""
return {
- "access_list": request.GET.get("access_list")
- or request.POST.get("access_list"),
+ "access_list": request.GET.get("access_list") or request.POST.get("access_list"),
}
@@ -443,8 +442,7 @@ class ACLExtendedRuleEditView(generic.ObjectEditView):
"""
return {
- "access_list": request.GET.get("access_list")
- or request.POST.get("access_list"),
+ "access_list": request.GET.get("access_list") or request.POST.get("access_list"),
}
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..ab061a4
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,23 @@
+
+[tool.black]
+line-length = 140
+
+[tool.isort]
+profile = "black"
+include_trailing_comma = true
+multi_line_output = 3
+
+[tool.pylint]
+max-line-length = 140
+
+[tool.pyright]
+include = ["netbox_secrets"]
+exclude = [
+ "**/node_modules",
+ "**/__pycache__",
+]
+reportMissingImports = true
+reportMissingTypeStubs = false
+
+[tool.ruff]
+line-length = 140
diff --git a/setup.py b/setup.py
index 1b55f67..c8faa97 100644
--- a/setup.py
+++ b/setup.py
@@ -1,20 +1,30 @@
+"""
+Configuration for setuptools.
+"""
import codecs
import os.path
from setuptools import find_packages, setup
-with open("README.md", encoding="utf-8") as fh:
- long_description = fh.read()
+script_dir = os.path.abspath(os.path.dirname(__file__))
+
+with open(os.path.join(script_dir, "README.md"), encoding="utf-8") as fh:
+ long_description = fh.read().replace("(docs/img/", "(https://raw.githubusercontent.com/ryanmerolle/netbox-acls/release/docs/img/")
-def read(rel_path):
- here = os.path.abspath(os.path.dirname(__file__))
- with codecs.open(os.path.join(here, rel_path), "r") as fp:
+def read(relative_path):
+ """
+ Read a file and return its contents.
+ """
+ with codecs.open(os.path.join(script_dir, relative_path), "r") as fp:
return fp.read()
-def get_version(rel_path):
- for line in read(rel_path).splitlines():
+def get_version(relative_path):
+ """
+ Extract the version number from a file without importing it.
+ """
+ for line in read(relative_path).splitlines():
if not line.startswith("__version__"):
raise RuntimeError("Unable to find version string.")
delim = '"' if '"' in line else "'"
@@ -33,7 +43,19 @@ setup(
include_package_data=True,
zip_safe=False,
classifiers=[
- "Framework :: Django",
+ "Development Status :: 5 - Production/Stable",
+ "Natural Language :: English",
+ "License :: OSI Approved :: Apache Software License",
+ "Programming Language :: Python",
"Programming Language :: Python :: 3",
+ "Programming Language :: Python :: 3 :: Only",
+ "Programming Language :: Python :: 3.9",
+ "Programming Language :: Python :: 3.10",
+ "Programming Language :: Python :: 3.11",
+ "Intended Audience :: System Administrators",
+ "Intended Audience :: Telecommunications Industry",
+ "Framework :: Django",
+ "Topic :: System :: Networking",
+ "Topic :: Internet",
],
)
diff --git a/test.sh b/test.sh
new file mode 100755
index 0000000..5fc2e06
--- /dev/null
+++ b/test.sh
@@ -0,0 +1,38 @@
+#!/bin/bash
+# Runs the NetBox plugin unit tests
+# Usage:
+# ./test.sh latest
+# ./test.sh v2.9.7
+# ./test.sh develop-2.10
+
+# exit when a command exits with an exit code != 0
+set -e
+
+# NETBOX_VARIANT is used by `Dockerfile` to determine the tag
+NETBOX_VARIANT="${1-latest}"
+
+# The docker compose command to use
+doco="docker compose --file docker-compose.yml"
+
+test_netbox_unit_tests() {
+ echo "⏱ Running NetBox Unit Tests"
+ $doco run --rm netbox python manage.py makemigrations netbox_acls --check
+ $doco run --rm netbox python manage.py test netbox_acls
+}
+
+test_cleanup() {
+ echo "💣 Cleaning Up"
+ $doco down -v
+ $doco rm -fsv
+ docker image rm docker.io/library/netbox-acls-netbox || echo ''
+}
+
+export NETBOX_VARIANT=${NETBOX_VARIANT}
+
+echo "🐳🐳🐳 Start testing '${NETBOX_VARIANT}'"
+
+# Make sure the cleanup script is executed
+trap test_cleanup EXIT ERR
+test_netbox_unit_tests
+
+echo "🐳🐳🐳 Done testing '${NETBOX_VARIANT}'"
| | |