Added testing framework (#121)

* added api test case for access list

* initial testing framework

Author: abhi1693

.github/linters/.flake8

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+# This ensures that previous jobs for the workflow are canceled when the ref is
+# updated.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  run-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      - name: Lint Code Base
+        uses: github/super-linter/slim@v4
+        env:
+          DEFAULT_BRANCH: dev
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SUPPRESS_POSSUM: true
+          LINTER_RULES_PATH: /
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_DOCKERFILE: false
+          VALIDATE_JSCPD: true
+          FILTER_REGEX_EXCLUDE: (.*/)?(configuration/.*)
+
+  test:
+    runs-on: ubuntu-latest
+    name: Runs plugin tests
+    needs: run-lint
+    steps:
+      - id: git-checkout
+        name: Checkout
+        uses: actions/checkout@v3
+
+      - id: docker-test
+        name: Test the image
+        run: ./test.sh snapshot

.github/linters/.isort.cfg

@@ -0,0 +1,4 @@
+{
+    "threshold": 10,
+    "ignore": ["**/tests/**"]
+}

.github/linters/.jscpd.json

@@ -9,6 +9,8 @@ repos:
       - id: debug-statements
       - id: end-of-file-fixer
       - id: name-tests-test
+        args:
+          - "--django"
       - id: requirements-txt-fixer
       - id: trailing-whitespace
   - repo: https://github.com/PyCQA/isort

.github/workflows/ci.yml

@@ -0,0 +1,9 @@
+ARG NETBOX_VARIANT=v3.4
+
+FROM netboxcommunity/netbox:${NETBOX_VARIANT}
+
+RUN mkdir -pv /plugins/netbox-acls
+COPY . /plugins/netbox-acls
+
+RUN /opt/netbox/venv/bin/python3 /plugins/netbox-acls/setup.py develop
+RUN cp -rf /plugins/netbox-acls/netbox_acls/ /opt/netbox/venv/lib/python3.10/site-packages/netbox_acls

.github/workflows/super-linter.yml

@@ -1,4 +1,3 @@
 include README.md
 include LICENSE
 recursive-include netbox_acls/templates *
-recursive-include netbox_acls/static *

.jscpd.json

@@ -0,0 +1,99 @@
+####
+## We recommend to not edit this file.
+## Create separate files to overwrite the settings.
+## See `extra.py` as an example.
+####
+
+from os import environ
+from os.path import abspath, dirname
+
+# For reference see https://netbox.readthedocs.io/en/stable/configuration/
+# Based on https://github.com/netbox-community/netbox/blob/master/netbox/netbox/configuration.example.py
+
+# Read secret from file
+def _read_secret(secret_name, default=None):
+    try:
+        f = open("/run/secrets/" + secret_name, encoding="utf-8")
+    except OSError:
+        return default
+    else:
+        with f:
+            return f.readline().strip()
+
+
+_BASE_DIR = dirname(dirname(abspath(__file__)))
+
+#########################
+#                       #
+#   Required settings   #
+#                       #
+#########################
+
+# This is a list of valid fully-qualified domain names (FQDNs) for the NetBox server. NetBox will not permit write
+# access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name.
+#
+# Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local']
+ALLOWED_HOSTS = environ.get("ALLOWED_HOSTS", "*").split(" ")
+
+# PostgreSQL database configuration. See the Django documentation for a complete list of available parameters:
+#   https://docs.djangoproject.com/en/stable/ref/settings/#databases
+DATABASE = {
+    "NAME": environ.get("DB_NAME", "netbox"),  # Database name
+    "USER": environ.get("DB_USER", ""),  # PostgreSQL username
+    "PASSWORD": _read_secret("db_password", environ.get("DB_PASSWORD", "")),
+    # PostgreSQL password
+    "HOST": environ.get("DB_HOST", "localhost"),  # Database server
+    "PORT": environ.get("DB_PORT", ""),  # Database port (leave blank for default)
+    "OPTIONS": {"sslmode": environ.get("DB_SSLMODE", "prefer")},
+    # Database connection SSLMODE
+    "CONN_MAX_AGE": int(environ.get("DB_CONN_MAX_AGE", "300")),
+    # Max database connection age
+    "DISABLE_SERVER_SIDE_CURSORS": environ.get(
+        "DB_DISABLE_SERVER_SIDE_CURSORS",
+        "False",
+    ).lower()
+    == "true",
+    # Disable the use of server-side cursors transaction pooling
+}
+
+# Redis database settings. Redis is used for caching and for queuing background tasks such as webhook events. A separate
+# configuration exists for each. Full connection details are required in both sections, and it is strongly recommended
+# to use two separate database IDs.
+REDIS = {
+    "tasks": {
+        "HOST": environ.get("REDIS_HOST", "localhost"),
+        "PORT": int(environ.get("REDIS_PORT", 6379)),
+        "PASSWORD": _read_secret("redis_password", environ.get("REDIS_PASSWORD", "")),
+        "DATABASE": int(environ.get("REDIS_DATABASE", 0)),
+        "SSL": environ.get("REDIS_SSL", "False").lower() == "true",
+        "INSECURE_SKIP_TLS_VERIFY": environ.get(
+            "REDIS_INSECURE_SKIP_TLS_VERIFY",
+            "False",
+        ).lower()
+        == "true",
+    },
+    "caching": {
+        "HOST": environ.get("REDIS_CACHE_HOST", environ.get("REDIS_HOST", "localhost")),
+        "PORT": int(environ.get("REDIS_CACHE_PORT", environ.get("REDIS_PORT", 6379))),
+        "PASSWORD": _read_secret(
+            "redis_cache_password",
+            environ.get("REDIS_CACHE_PASSWORD", environ.get("REDIS_PASSWORD", "")),
+        ),
+        "DATABASE": int(environ.get("REDIS_CACHE_DATABASE", 1)),
+        "SSL": environ.get("REDIS_CACHE_SSL", environ.get("REDIS_SSL", "False")).lower()
+        == "true",
+        "INSECURE_SKIP_TLS_VERIFY": environ.get(
+            "REDIS_CACHE_INSECURE_SKIP_TLS_VERIFY",
+            environ.get("REDIS_INSECURE_SKIP_TLS_VERIFY", "False"),
+        ).lower()
+        == "true",
+    },
+}
+
+# This key is used for secure generation of random numbers and strings. It must never be exposed outside of this file.
+# For optimal security, SECRET_KEY should be at least 50 characters in length and contain a mix of letters, numbers, and
+# symbols. NetBox will not run without this defined. For more information, see
+# https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-SECRET_KEY
+SECRET_KEY = _read_secret("secret_key", environ.get("SECRET_KEY", ""))
+
+DEVELOPER = True