Unify api serializers (#16 )

Version bump NetBox 3.4.7 (#15 )
Closes #14
2023-04-19 10:14:32 +02:00 · 2023-03-31 10:02:35 +02:00 · 2023-03-29 22:00:48 +02:00 · 2022-05-19 11:08:57 +02:00 · 2022-05-19 11:06:34 +02:00 · 2022-05-03 15:21:18 +02:00
54 changed files with 743 additions and 567 deletions
@@ -0,0 +1,3 @@
+COMPOSE_PATH_SEPARATOR=:
+COMPOSE_FILE=ci/docker-compose.yml:ci/docker-compose.ci.yml
+COMPOSE_PROJECT_NAME=netbox-docker
@@ -0,0 +1,36 @@
+name: Docker Image CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Build the Docker image
+      run: docker compose build --no-cache
+
+    - name: Verify the Docker image
+      # clearcache is provided by Django extras, which is not loaded if netbox-slm cannot be loaded
+      run: docker compose run netbox sh -c "/opt/netbox/venv/bin/python manage.py clearcache"
+
+    - name: Run Django tests with coverage for netbox_slm
+      run: |
+        chmod go+w ci/reports
+        docker compose run netbox sh -c " \
+          /opt/netbox/venv/bin/coverage run --source='netbox_slm' manage.py test netbox_slm && \
+          /opt/netbox/venv/bin/coverage report --fail-under=0 && \
+          /opt/netbox/venv/bin/coverage xml -o /ci/reports/coverage.xml"
+
+    - name: Sonarcloud scan
+      if: env.SONAR_TOKEN != null
+      uses: sonarsource/sonarcloud-github-action@master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
@@ -1,3 +1,4 @@
+**/netbox
 **/netbox-docker
 **/*.pyc
 **/__pycache__
@@ -5,3 +6,6 @@
 **/.vscode
 **/dist
 **/netbox_slm.egg-info
+ci/docker-compose.override.yml
+ci/reports
+out/production
@@ -4,7 +4,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

-    http://www.apache.org/licenses/LICENSE-2.0
+   http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -0,0 +1,4 @@
+include ../LICENSE
+include ../README.md
+include ../SECURITY.md
+recursive-include netbox_slm/templates *
@@ -1,43 +1,48 @@
-Software Lifecycle Management
-----------------------------
+<h1 align="center">NetBox SLM</h1>

-*Netbox Plugin for lifecycle management of software components, including versions and installations*
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+<p align="center"><i>Netbox SLM is a plugin for lifecycle management of software components, including versions and installations.</i></p>

--------------
+<div align="center">
+<a href="https://pypi.org/project/netbox_slm/"><img src="https://img.shields.io/pypi/v/netbox_slm" alt="PyPi"/></a>
+<a href="https://github.com/ICTU/netbox_slm/stargazers"><img src="https://img.shields.io/github/stars/ICTU/netbox_slm" alt="Stars Badge"/></a>
+<a href="https://github.com/ICTU/netbox_slm/network/members"><img src="https://img.shields.io/github/forks/ICTU/netbox_slm" alt="Forks Badge"/></a>
+<a href="https://github.com/ICTU/netbox_slm/pulls"><img src="https://img.shields.io/github/issues-pr/ICTU/netbox_slm" alt="Pull Requests Badge"/></a>
+<a href="https://github.com/ICTU/netbox_slm/issues"><img src="https://img.shields.io/github/issues/ICTU/netbox_slm" alt="Issues Badge"/></a>
+<a href="https://github.com/ICTU/netbox_slm/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/ICTU/netbox_slm?color=2b9348"></a>
+<a href="https://github.com/ICTU/netbox_slm/blob/master/LICENSE"><img src="https://img.shields.io/github/license/ICTU/netbox_slm?color=2b9348" alt="License Badge"/></a>
+</div>

-Installation Guide
-~~~~~~~~~~~~~~~~~~

-WARNING: This plugin is only tested with Netbox 3.2 at this time.
+## Known Issues

-When using the Docker version of Netbox, first follow the `netbox-docker
-quickstart <https://github.com/netbox-community/netbox-docker#quickstart>`__
-instructions to clone the netbox-docker repo and set up the
-``docker-compose.override.yml``.
+- WARNING: This plugin is only tested with a single Netbox version at this time.
+- CSV/Bulk imports for SoftwareProduct, Version and Installation are currently broken (WIP)

-Next, follow these instructions (based on the `Netbox docker variant
-instructions <https://github.com/netbox-community/netbox-docker/wiki/Configuration#custom-configuration-files>`__)
+## Installation Guide
+
+When using the Docker version of Netbox, first follow the netbox-docker [quickstart](https://github.com/netbox-community/netbox-docker#quickstart) instructions to clone the netbox-docker repo and set up the ``docker-compose.override.yml``.
+
+Next, follow these instructions (based on the Netbox docker variant
+[instructions](https://github.com/netbox-community/netbox-docker/wiki/Configuration#custom-configuration-files))
 to install the Netbox SLM plugin:

 1. Add ``netbox_slm`` to the ``PLUGINS`` list in
   ``configuration/extra.py``.
-2. Create a ``plugin_requirements.txt`` with ``netbox-slm==0.98`` as
+2. Create a ``plugin_requirements.txt`` with ``netbox-slm==1.2`` as
   contents.
 3. Create a ``Dockerfile-SLM`` with contents:

-.. code:: dockerfile
-
-   FROM netboxcommunity/netbox:v3.2.X
+   ```
+   FROM netboxcommunity/netbox:vX.Y.Z

   COPY ./plugin_requirements.txt /
   RUN /opt/netbox/venv/bin/pip install --no-warn-script-location -r /plugin_requirements.txt
+   ```

 4. Create a ``docker-compose.override.yml`` with contents:

-.. code:: yaml
-
-   version: '3.4'
+   ```
+   version: '3.7'
   services:
     netbox:
       ports:
@@ -50,24 +55,24 @@ to install the Netbox SLM plugin:
       image: netbox:slm
     netbox-housekeeping:
       image: netbox:slm
+   ```

 Now, build the image: ``docker compose build --no-cache``

 And finally, run Netbox with the SLM plugin: ``docker compose up``

-Releasing Guide
-~~~~~~~~~~~~~~~
+## Releasing Guide

 To draft a release;

 update the setup.py file to reflect the new version, then from the *src*
 directory run

-::
-
+   ```
   # make sure to update the version in netbox_slm/__init__.py
   $ python setup.py sdist
   $ twine upload dist/*
+   ```

 On Github.com create a similar tag and version. These steps could be
 automated with a github workflow.
@@ -75,55 +80,56 @@ automated with a github workflow.
 n.b. Currently the plugin is configured to use a personal pypi account,
 this should be changed.

-Developer Guide (local installation)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+## Developer Guide (local installation)

 *Follow the steps below on your local system to run netbox and the
 netbox_slm plugin in developer mode*

-Setup
-~~~~~
+### Setup

 The goal below is to run all Netbox components in Docker and run a local
 Netbox Django copy with auto-reload to develop the plugin pointing to
 the Dockerized postgres and redis instances, basically ignoring the
 netbox docker runtime server.

-Steps
-~~~~~
-
-::
+### Steps

   from your projects directory clone the netbox repository

+   ```
   $ git clone https://github.com/netbox-community/netbox
   $ cd netbox
+   ```
   
   install the virtual environment
   
+   ```
   $ pipenv shell
   $ pipenv install
+   ```

   create and edit netbox/configuration.py (based on the template file) add these lines at the end of the file;
   
+   ```
   DEBUG = True
   SECRET_KEY = 'dummy'
   DEVELOPER = True
   PLUGINS = [
       'netbox_slm',
   ]
+   ```

 The Netbox installation above will be used to run Django management
 commands like runserver, makemigrations and migrate, which will be
 explained in the next steps below;

-::
-
   from your projects directory clone the netbox-slm repository

+   ```
   $ git clone https://github.com/ICTU/netbox_slm
   $ cd netbox_slm
   $ ./start-netbox.sh
+   ```
   
 This will start Netbox locally (requires Docker) and forward the redis
 and postgres ports to the localhost (make sure there’s no processes
@@ -131,20 +137,24 @@ using these ports or change the dockerfiles accordingly)

 Note, you can also start and stop netbox by hand:

-::
-
+   ```
   $ cd netbox-docker
   $ docker-compose up -d
+   ```
   
   or stop the stack with

+   ```
   $ docker-compose down
+   ```
   
   # to start fresh:

+   ```
   $ docker-compose down
   $ docker volume rm netbox-docker_netbox-postgres-data  # et cetera
   $ docker-compose up -d --force-recreate
+   ```
   
   this will require you to re-run the migrate commando's for netbox-slm, see further down below

@@ -153,8 +163,7 @@ redis connection strings (username, password) to the ones the netbox
 docker backend is using, for example (using default user and passwords
 from the netbox docker example):

-::
-
+   ```
   <<collapsed>>

   # PostgreSQL database configuration. See the Django documentation for a complete list of available parameters:
@@ -201,15 +210,16 @@ from the netbox docker example):
   }

   <<collapsed>>
+   ```
   
 Now you can run commands from the netbox repository like this;

-::
-
+   ```
   $ cd netbox/netbox
-   $ export PYTHONPATH=../../netbox-slm/src/
+   $ export PYTHONPATH=../../netbox_slm/netbox_slm/  # or with the pipenv activated run `python3 setup.py develop` from the netbox_slm directory
   $ python3 manage.py migrate netbox_slm
   $ python3 manage.py runserver 8001
+   ```

-Visit http://127.0.0.1:8001 in the browesr to see the auto reloading
+Visit http://127.0.0.1:8001 in the browser to see the auto reloading
 version of the netbox UI. Port 8000 is taken by the docker ran variant.
@@ -0,0 +1,13 @@
+# Security Policy
+
+## Current status
+
+Netbox SLM is a plugin for Netbox with mostly default configuration. We advise to monitor Netbox security findings and update accordingly.
+
+## Supported Versions
+
+Only the latest version of Netbox SLM is currently being supported with security updates. We aim to keep the plugin compatible with the latest Netbox version, but have no incentive to patch older tags at this point.
+
+## Reporting a Vulnerability
+
+Please report security vulnerabilities by opening a ticket. The aim is to get back to you within 24 hours with a confirmation of the issue and a brief action plan or a request for more information. 
@@ -0,0 +1,16 @@
+ARG PYTHON_VERSION=3.10
+FROM python:${PYTHON_VERSION}-alpine AS compile-image
+
+WORKDIR /build
+RUN python -m venv /opt/netbox/venv
+ENV PATH="/opt/netbox/venv/bin:$PATH"
+
+COPY ../ /build
+
+RUN python setup.py sdist
+RUN pip install --no-index /build
+
+FROM netboxcommunity/netbox:v3.4.7
+
+ARG PYTHON_VERSION=3.10
+COPY --from=compile-image /opt/netbox/venv/lib/python${PYTHON_VERSION}/site-packages/netbox_slm /opt/netbox/venv/lib/python${PYTHON_VERSION}/site-packages/netbox_slm
@@ -0,0 +1,7 @@
+FROM netboxcommunity/netbox:v3.4.7
+
+RUN mkdir /ci && chmod go+w /ci
+COPY ../ci/requirements_ci.txt /ci/
+RUN pip install -r /ci/requirements_ci.txt
+
+COPY ../netbox_slm /opt/netbox/netbox/netbox_slm
@@ -0,0 +1,256 @@
+####
+## We recommend to not edit this file.
+## Create separate files to overwrite the settings.
+## See `extra.py` as an example.
+####
+
+import re
+from os import environ
+from os.path import abspath, dirname, join
+
+# 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, 'r', encoding='utf-8')
+    except EnvironmentError:
+        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', ''))
+
+
+#########################
+#                       #
+#   Optional settings   #
+#                       #
+#########################
+
+# Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of
+# application errors (assuming correct email settings are provided).
+ADMINS = [
+    # ['John Doe', 'jdoe@example.com'],
+]
+
+# URL schemes that are allowed within links in NetBox
+ALLOWED_URL_SCHEMES = (
+    'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp',
+)
+
+# Optionally display a persistent banner at the top and/or bottom of every page. HTML is allowed. To display the same
+# content in both banners, define BANNER_TOP and set BANNER_BOTTOM = BANNER_TOP.
+BANNER_TOP = environ.get('BANNER_TOP', '')
+BANNER_BOTTOM = environ.get('BANNER_BOTTOM', '')
+
+# Text to include on the login page above the login form. HTML is allowed.
+BANNER_LOGIN = environ.get('BANNER_LOGIN', '')
+
+# Base URL path if accessing NetBox within a directory. For example, if installed at http://example.com/netbox/, set:
+# BASE_PATH = 'netbox/'
+BASE_PATH = environ.get('BASE_PATH', '')
+
+# Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. (Default: 90)
+CHANGELOG_RETENTION = int(environ.get('CHANGELOG_RETENTION', 90))
+
+# API Cross-Origin Resource Sharing (CORS) settings. If CORS_ORIGIN_ALLOW_ALL is set to True, all origins will be
+# allowed. Otherwise, define a list of allowed origins using either CORS_ORIGIN_WHITELIST or
+# CORS_ORIGIN_REGEX_WHITELIST. For more information, see https://github.com/ottoyiu/django-cors-headers
+CORS_ORIGIN_ALLOW_ALL = environ.get('CORS_ORIGIN_ALLOW_ALL', 'False').lower() == 'true'
+CORS_ORIGIN_WHITELIST = list(filter(None, environ.get('CORS_ORIGIN_WHITELIST', 'https://localhost').split(' ')))
+CORS_ORIGIN_REGEX_WHITELIST = [re.compile(r) for r in list(filter(None, environ.get('CORS_ORIGIN_REGEX_WHITELIST', '').split(' ')))]
+
+# Cross-Site-Request-Forgery-Attack settings. If Netbox is sitting behind a reverse proxy, you might need to set the CSRF_TRUSTED_ORIGINS flag.
+# Django 4.0 requires to specify the URL Scheme in this setting. An example environment variable could be specified like:
+# CSRF_TRUSTED_ORIGINS=https://demo.netbox.dev http://demo.netbox.dev
+CSRF_TRUSTED_ORIGINS = list(filter(None, environ.get('CSRF_TRUSTED_ORIGINS', '').split(' ')))
+
+# Set to True to enable server debugging. WARNING: Debugging introduces a substantial performance penalty and may reveal
+# sensitive information about your installation. Only enable debugging while performing testing. Never enable debugging
+# on a production system.
+DEBUG = environ.get('DEBUG', 'False').lower() == 'true'
+
+# Email settings
+EMAIL = {
+    'SERVER': environ.get('EMAIL_SERVER', 'localhost'),
+    'PORT': int(environ.get('EMAIL_PORT', 25)),
+    'USERNAME': environ.get('EMAIL_USERNAME', ''),
+    'PASSWORD': _read_secret('email_password', environ.get('EMAIL_PASSWORD', '')),
+    'USE_SSL': environ.get('EMAIL_USE_SSL', 'False').lower() == 'true',
+    'USE_TLS': environ.get('EMAIL_USE_TLS', 'False').lower() == 'true',
+    'SSL_CERTFILE': environ.get('EMAIL_SSL_CERTFILE', ''),
+    'SSL_KEYFILE': environ.get('EMAIL_SSL_KEYFILE', ''),
+    'TIMEOUT': int(environ.get('EMAIL_TIMEOUT', 10)),  # seconds
+    'FROM_EMAIL': environ.get('EMAIL_FROM', ''),
+}
+
+# Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce unique IP space within the global table
+# (all prefixes and IP addresses not assigned to a VRF), set ENFORCE_GLOBAL_UNIQUE to True.
+ENFORCE_GLOBAL_UNIQUE = environ.get('ENFORCE_GLOBAL_UNIQUE', 'False').lower() == 'true'
+
+# Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and
+# by anonymous users. List models in the form `<app>.<model>`. Add '*' to this list to exempt all models.
+EXEMPT_VIEW_PERMISSIONS = list(filter(None, environ.get('EXEMPT_VIEW_PERMISSIONS', '').split(' ')))
+
+# Enable GraphQL API.
+GRAPHQL_ENABLED = environ.get('GRAPHQL_ENABLED', 'True').lower() == 'true'
+
+# Enable custom logging. Please see the Django documentation for detailed guidance on configuring custom logs:
+#   https://docs.djangoproject.com/en/stable/topics/logging/
+LOGGING = {}
+
+# Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users
+# are permitted to access most data in NetBox (excluding secrets) but not make any changes.
+LOGIN_REQUIRED = environ.get('LOGIN_REQUIRED', 'False').lower() == 'true'
+
+# The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to
+# re-authenticate. (Default: 1209600 [14 days])
+LOGIN_TIMEOUT = int(environ.get('LOGIN_TIMEOUT', 1209600))
+
+# Setting this to True will display a "maintenance mode" banner at the top of every page.
+MAINTENANCE_MODE = environ.get('MAINTENANCE_MODE', 'False').lower() == 'true'
+
+# Maps provider
+MAPS_URL = environ.get('MAPS_URL', None)
+
+# An API consumer can request an arbitrary number of objects =by appending the "limit" parameter to the URL (e.g.
+# "?limit=1000"). This setting defines the maximum limit. Setting it to 0 or None will allow an API consumer to request
+# all objects by specifying "?limit=0".
+MAX_PAGE_SIZE = int(environ.get('MAX_PAGE_SIZE', 1000))
+
+# The file path where uploaded media such as image attachments are stored. A trailing slash is not needed. Note that
+# the default value of this setting is derived from the installed location.
+MEDIA_ROOT = environ.get('MEDIA_ROOT', join(_BASE_DIR, 'media'))
+
+# Expose Prometheus monitoring metrics at the HTTP endpoint '/metrics'
+METRICS_ENABLED = environ.get('METRICS_ENABLED', 'False').lower() == 'true'
+
+# Credentials that NetBox will uses to authenticate to devices when connecting via NAPALM.
+NAPALM_USERNAME = environ.get('NAPALM_USERNAME', '')
+NAPALM_PASSWORD = _read_secret('napalm_password', environ.get('NAPALM_PASSWORD', ''))
+
+# NAPALM timeout (in seconds). (Default: 30)
+NAPALM_TIMEOUT = int(environ.get('NAPALM_TIMEOUT', 30))
+
+# NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must
+# be provided as a dictionary.
+NAPALM_ARGS = {}
+
+# Determine how many objects to display per page within a list. (Default: 50)
+PAGINATE_COUNT = int(environ.get('PAGINATE_COUNT', 50))
+
+# Enable installed plugins. Add the name of each plugin to the list.
+PLUGINS = ['netbox_slm']
+
+# Plugins configuration settings. These settings are used by various plugins that the user may have installed.
+# Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings.
+PLUGINS_CONFIG = {
+}
+
+# When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to
+# prefer IPv4 instead.
+PREFER_IPV4 = environ.get('PREFER_IPV4', 'False').lower() == 'true'
+
+# Rack elevation size defaults, in pixels. For best results, the ratio of width to height should be roughly 10:1.
+RACK_ELEVATION_DEFAULT_UNIT_HEIGHT = int(environ.get('RACK_ELEVATION_DEFAULT_UNIT_HEIGHT', 22))
+RACK_ELEVATION_DEFAULT_UNIT_WIDTH = int(environ.get('RACK_ELEVATION_DEFAULT_UNIT_WIDTH', 220))
+
+# Remote authentication support
+REMOTE_AUTH_ENABLED = environ.get('REMOTE_AUTH_ENABLED', 'False').lower() == 'true'
+REMOTE_AUTH_BACKEND = environ.get('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend')
+REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER')
+REMOTE_AUTH_AUTO_CREATE_USER = environ.get('REMOTE_AUTH_AUTO_CREATE_USER', 'True').lower() == 'true'
+REMOTE_AUTH_DEFAULT_GROUPS = list(filter(None, environ.get('REMOTE_AUTH_DEFAULT_GROUPS', '').split(' ')))
+
+# This repository is used to check whether there is a new release of NetBox available. Set to None to disable the
+# version check or use the URL below to check for release in the official NetBox repository.
+# https://api.github.com/repos/netbox-community/netbox/releases
+RELEASE_CHECK_URL = environ.get('RELEASE_CHECK_URL', None)
+
+# The file path where custom reports will be stored. A trailing slash is not needed. Note that the default value of
+# this setting is derived from the installed location.
+REPORTS_ROOT = environ.get('REPORTS_ROOT', '/etc/netbox/reports')
+
+# Maximum execution time for background tasks, in seconds.
+RQ_DEFAULT_TIMEOUT = int(environ.get('RQ_DEFAULT_TIMEOUT', 300))
+
+# The file path where custom scripts will be stored. A trailing slash is not needed. Note that the default value of
+# this setting is derived from the installed location.
+SCRIPTS_ROOT = environ.get('SCRIPTS_ROOT', '/etc/netbox/scripts')
+
+# By default, NetBox will store session data in the database. Alternatively, a file path can be specified here to use
+# local file storage instead. (This can be useful for enabling authentication on a standby instance with read-only
+# database access.) Note that the user as which NetBox runs must have read and write permissions to this path.
+SESSION_FILE_PATH = environ.get('SESSIONS_ROOT', None)
+
+# Time zone (default: UTC)
+TIME_ZONE = environ.get('TIME_ZONE', 'UTC')
+
+# Date/time formatting. See the following link for supported formats:
+# https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date
+DATE_FORMAT = environ.get('DATE_FORMAT', 'N j, Y')
+SHORT_DATE_FORMAT = environ.get('SHORT_DATE_FORMAT', 'Y-m-d')
+TIME_FORMAT = environ.get('TIME_FORMAT', 'g:i a')
+SHORT_TIME_FORMAT = environ.get('SHORT_TIME_FORMAT', 'H:i:s')
+DATETIME_FORMAT = environ.get('DATETIME_FORMAT', 'N j, Y g:i a')
+SHORT_DATETIME_FORMAT = environ.get('SHORT_DATETIME_FORMAT', 'Y-m-d H:i')
@@ -0,0 +1,11 @@
+PLUGINS = ['netbox_slm']
+DEBUG = True
+SECRET_KEY = 'dummy'
+DEVELOPER = True
+PLUGINS_CONFIG = {
+    'netbox_slm': dict(
+        TEST_RUNNER='xmlrunner.extra.djangotestrunner.XMLTestRunner',
+        TEST_OUTPUT_DIR='/ci/reports/',
+        TEST_OUTPUT_FILE_NAME='junit.xml',
+    )
+}
@@ -0,0 +1,23 @@
+version: '3.7'
+services:
+  netbox:
+    ports:
+      - "8001:8080"
+    build:
+      context: ..
+      dockerfile: ci/Dockerfile-CI
+    image: netbox:slm
+    environment:
+      - COVERAGE_FILE=/ci/.coverage
+    volumes:
+      - ./reports:/ci/reports
+  netbox-worker:
+    image: netbox:slm
+  netbox-housekeeping:
+    image: netbox:slm
+  postgres:
+    ports:
+      - "5432:5432"
+  redis:
+    ports:
+      - "6379:6379"
@@ -0,0 +1,63 @@
+version: '3.7'
+services:
+  netbox: &netbox
+    image: netboxcommunity/netbox:${VERSION-v3.3-2.2.0}
+    depends_on:
+    - postgres
+    - redis
+    - redis-cache
+    - netbox-worker
+    env_file: env/netbox.env
+    user: 'unit:root'
+    volumes:
+    - ./configuration:/etc/netbox/config:z,ro
+    - netbox-media-files:/opt/netbox/netbox/media:z
+  netbox-worker:
+    <<: *netbox
+    depends_on:
+    - redis
+    - postgres
+    command:
+    - /opt/netbox/venv/bin/python
+    - /opt/netbox/netbox/manage.py
+    - rqworker
+  netbox-housekeeping:
+    <<: *netbox
+    depends_on:
+    - redis
+    - postgres
+    command:
+    - /opt/netbox/housekeeping.sh
+
+  # postgres
+  postgres:
+    image: postgres:14-alpine
+    env_file: env/postgres.env
+    volumes:
+    - netbox-postgres-data:/var/lib/postgresql/data
+
+  # redis
+  redis:
+    image: redis:7-alpine
+    command:
+    - sh
+    - -c # this is to evaluate the $REDIS_PASSWORD from the env
+    - redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+    env_file: env/redis.env
+    volumes:
+    - netbox-redis-data:/data
+  redis-cache:
+    image: redis:7-alpine
+    command:
+    - sh
+    - -c # this is to evaluate the $REDIS_PASSWORD from the env
+    - redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+    env_file: env/redis-cache.env
+
+volumes:
+  netbox-media-files:
+    driver: local
+  netbox-postgres-data:
+    driver: local
+  netbox-redis-data:
+    driver: local
@@ -0,0 +1,42 @@
+CORS_ORIGIN_ALLOW_ALL=True
+DB_HOST=postgres
+DB_NAME=netbox
+DB_PASSWORD=J5brHrAXFLQSif0K
+DB_USER=netbox
+EMAIL_FROM=netbox@bar.com
+EMAIL_PASSWORD=
+EMAIL_PORT=25
+EMAIL_SERVER=localhost
+EMAIL_SSL_CERTFILE=
+EMAIL_SSL_KEYFILE=
+EMAIL_TIMEOUT=5
+EMAIL_USERNAME=netbox
+# EMAIL_USE_SSL and EMAIL_USE_TLS are mutually exclusive, i.e. they can't both be `true`!
+EMAIL_USE_SSL=false
+EMAIL_USE_TLS=false
+GRAPHQL_ENABLED=true
+HOUSEKEEPING_INTERVAL=86400
+MAX_PAGE_SIZE=1000
+MEDIA_ROOT=/opt/netbox/netbox/media
+METRICS_ENABLED=false
+NAPALM_PASSWORD=
+NAPALM_TIMEOUT=10
+NAPALM_USERNAME=
+REDIS_CACHE_DATABASE=1
+REDIS_CACHE_HOST=redis-cache
+REDIS_CACHE_INSECURE_SKIP_TLS_VERIFY=false
+REDIS_CACHE_PASSWORD=t4Ph722qJ5QHeQ1qfu36
+REDIS_CACHE_SSL=false
+REDIS_DATABASE=0
+REDIS_HOST=redis
+REDIS_INSECURE_SKIP_TLS_VERIFY=false
+REDIS_PASSWORD=H733Kdjndks81
+REDIS_SSL=false
+RELEASE_CHECK_URL=https://api.github.com/repos/netbox-community/netbox/releases
+SECRET_KEY=r8OwDznj!!dci#P9ghmRfdu1Ysxm0AiPeDCQhKE+N_rClfWNj
+SKIP_SUPERUSER=false
+SUPERUSER_API_TOKEN=0123456789abcdef0123456789abcdef01234567
+SUPERUSER_EMAIL=admin@example.com
+SUPERUSER_NAME=admin
+SUPERUSER_PASSWORD=admin
+WEBHOOKS_ENABLED=true
@@ -0,0 +1,3 @@
+POSTGRES_DB=netbox
+POSTGRES_PASSWORD=J5brHrAXFLQSif0K
+POSTGRES_USER=netbox
@@ -0,0 +1 @@
+REDIS_PASSWORD=t4Ph722qJ5QHeQ1qfu36
@@ -0,0 +1 @@
+REDIS_PASSWORD=H733Kdjndks81
@@ -0,0 +1,2 @@
+coverage==7.2.2
+unittest-xml-reporting==3.2.0
@@ -4,14 +4,15 @@ from extras.plugins import PluginConfig
 class SLMConfig(PluginConfig):
    name = 'netbox_slm'
    verbose_name = 'Software Lifecycle Management'
-    description = 'Software Lifecycle Management'
-    version = '0.98'
-    author = 'Hedde van der Heide'
-    author_email = 'hedde.vanderheide@ictu.nl'
+    description = 'Software Lifecycle Management Netbox Plugin.'
+    version = '1.3'
+    author = 'ICTU'
+    author_email = 'open-source-projects@ictu.nl'
    base_url = 'slm'
    required_settings = []
    default_settings = {
        'version_info': False
    }

+
 config = SLMConfig
@@ -1,9 +1,7 @@
 from rest_framework import serializers

 from netbox.api.serializers import NetBoxModelSerializer
-from netbox_slm.models import (
-    SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation,
-)
+from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation


 class SoftwareProductSerializer(NetBoxModelSerializer):
@@ -19,7 +17,7 @@ class SoftwareProductSerializer(NetBoxModelSerializer):
        ]

    def get_display(self, obj):
-        return f"{obj.manufacturer.name} - {obj.name}"
+        return f"{obj.manufacturer} - {obj}"


 class SoftwareProductVersionSerializer(NetBoxModelSerializer):
@@ -35,7 +33,7 @@ class SoftwareProductVersionSerializer(NetBoxModelSerializer):
        ]

    def get_display(self, obj):
-        return obj.name
+        return f"{obj}"


 class SoftwareProductInstallationSerializer(NetBoxModelSerializer):
@@ -52,4 +50,4 @@ class SoftwareProductInstallationSerializer(NetBoxModelSerializer):
        ]

    def get_display(self, obj):
-        return obj
+        return f"{obj}"
@@ -1,18 +1,13 @@
-from rest_framework import serializers
-from rest_framework.decorators import action
-from rest_framework.response import Response
 from rest_framework.routers import APIRootView

 from netbox.api.viewsets import NetBoxModelViewSet
 from netbox_slm.api.serializers import (
    SoftwareProductSerializer, SoftwareProductVersionSerializer, SoftwareProductInstallationSerializer,
 )
-from netbox_slm.filters import (
-    SoftwareProductFilter, SoftwareProductVersionFilter, SoftwareProductInstallationFilter,
-)
-from netbox_slm.models import (
-    SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation,
+from netbox_slm.filtersets import (
+    SoftwareProductFilterSet, SoftwareProductVersionFilterSet, SoftwareProductInstallationFilterSet,
 )
+from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation


 class NetboxSLMRootView(APIRootView):
@@ -27,16 +22,16 @@ class NetboxSLMRootView(APIRootView):
 class SoftwareProductViewSet(NetBoxModelViewSet):
    queryset = SoftwareProduct.objects.all()
    serializer_class = SoftwareProductSerializer
-    filterset_class = SoftwareProductFilter
+    filterset_class = SoftwareProductFilterSet


 class SoftwareProductVersionViewSet(NetBoxModelViewSet):
    queryset = SoftwareProductVersion.objects.all()
    serializer_class = SoftwareProductVersionSerializer
-    filterset_class = SoftwareProductVersionFilter
+    filterset_class = SoftwareProductVersionFilterSet


 class SoftwareProductInstallationViewSet(NetBoxModelViewSet):
    queryset = SoftwareProductInstallation.objects.all()
    serializer_class = SoftwareProductInstallationSerializer
-    filterset_class = SoftwareProductInstallationFilter
+    filterset_class = SoftwareProductInstallationFilterSet
@@ -0,0 +1,55 @@
+from django.db.models import Q
+
+from netbox.filtersets import NetBoxModelFilterSet
+from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
+
+
+class SoftwareProductFilterSet(NetBoxModelFilterSet):
+    """Filter capabilities for SoftwareProduct instances."""
+
+    class Meta:
+        model = SoftwareProduct
+        fields = tuple()
+
+    def search(self, queryset, name, value):
+        """Perform the filtered search."""
+        if not value.strip():
+            return queryset
+        qs_filter = Q(name__icontains=value) | Q(manufacturer__name__icontains=value)
+        return queryset.filter(qs_filter)
+
+
+class SoftwareProductVersionFilterSet(NetBoxModelFilterSet):
+    """Filter capabilities for SoftwareProductVersion instances."""
+
+    class Meta:
+        model = SoftwareProductVersion
+        fields = (
+            "software_product",
+        )
+
+    def search(self, queryset, name, value):
+        """Perform the filtered search."""
+        if not value.strip():
+            return queryset
+        qs_filter = Q(name__icontains=value) | \
+                    Q(software_product__name__icontains=value) | \
+                    Q(software_product__manufacturer__name__icontains=value)
+        return queryset.filter(qs_filter)
+
+
+class SoftwareProductInstallationFilterSet(NetBoxModelFilterSet):
+    """Filter capabilities for SoftwareProductInstallation instances."""
+
+    class Meta:
+        model = SoftwareProductInstallation
+        fields = tuple()
+
+    def search(self, queryset, name, value):
+        """Perform the filtered search."""
+        if not value.strip():
+            return queryset
+        qs_filter = Q(software_product__name__icontains=value) | \
+                    Q(software_product__manufacturer__name__icontains=value) | \
+                    Q(version__name__icontains=value)
+        return queryset.filter(qs_filter)
@@ -1,17 +1,11 @@
 from django import forms
 from django.urls import reverse_lazy
 from django.utils.translation import gettext as _
-from netbox.forms import (
-    NetBoxModelForm,
-    NetBoxModelCSVForm,
-    NetBoxModelBulkEditForm,
-    NetBoxModelFilterSetForm,
-)
+
 from dcim.models import Manufacturer, Device
+from netbox.forms import NetBoxModelForm, NetBoxModelCSVForm, NetBoxModelBulkEditForm, NetBoxModelFilterSetForm
 from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
-from utilities.forms import (
-    BootstrapMixin, DynamicModelChoiceField, APISelect, DynamicModelMultipleChoiceField
-)
+from utilities.forms import DynamicModelChoiceField, APISelect, TagFilterField
 from virtualization.models import VirtualMachine


@@ -20,10 +14,7 @@ class SoftwareProductForm(NetBoxModelForm):

    manufacturer = DynamicModelChoiceField(
        queryset=Manufacturer.objects.all(),
-        required=False,
-        # initial_params={
-        #     'device_types': 'device_type'
-        # }
+        required=True,
    )

    class Meta:
@@ -32,24 +23,18 @@ class SoftwareProductForm(NetBoxModelForm):


 class SoftwareProductFilterForm(NetBoxModelFilterSetForm):
-    """Form for filtering SoftwareProduct instances."""
-
    model = SoftwareProduct
-
-    q = forms.CharField(required=False, label="Search")
-
-    name = forms.CharField(
-        required=False,
-        label="Name",
+    fieldsets = (
+        (None, ('q', 'tag')),
    )

-    # tag = TagFilterField(SoftwareProduct)
+    tag = TagFilterField(model)


 class SoftwareProductCSVForm(NetBoxModelCSVForm):
    class Meta:
        model = SoftwareProduct
-        fields = ("name",)
+        fields = ("name", "manufacturer",)


 class SoftwareProductBulkEditForm(NetBoxModelBulkEditForm):
@@ -78,24 +63,14 @@ class SoftwareProductVersionForm(NetBoxModelForm):
        model = SoftwareProductVersion
        fields = ("name", "software_product", "tags")

-    # def clean(self):
-    #     import pdb;pdb.set_trace()
-    #     return super(SoftwareProductVersionForm, self).clean()
-

 class SoftwareProductVersionFilterForm(NetBoxModelFilterSetForm):
-    """Form for filtering SoftwareProductVersion instances."""
-
    model = SoftwareProductVersion
-
-    q = forms.CharField(required=False, label="Search")
-
-    name = forms.CharField(
-        required=False,
-        label="Name",
+    fieldsets = (
+        (None, ('q', 'tag')),
    )

-    # tag = TagFilterField(SoftwareProduct)
+    tag = TagFilterField(model)


 class SoftwareProductVersionCSVForm(NetBoxModelCSVForm):
@@ -121,16 +96,10 @@ class SoftwareProductInstallationForm(NetBoxModelForm):
    device = DynamicModelChoiceField(
        queryset=Device.objects.all(),
        required=False,
-        # initial_params={
-        #     'device_types': 'device_type'
-        # }
    )
    virtualmachine = DynamicModelChoiceField(
        queryset=VirtualMachine.objects.all(),
        required=False,
-        # initial_params={
-        #     'device_types': 'device_type'
-        # }
    )
    software_product = DynamicModelChoiceField(
        queryset=SoftwareProduct.objects.all(),
@@ -154,6 +123,14 @@ class SoftwareProductInstallationForm(NetBoxModelForm):
        model = SoftwareProductInstallation
        fields = ("device", "virtualmachine", "software_product", "version", "tags")

+    def clean_version(self):
+        version = self.cleaned_data['version']
+        software_product = self.cleaned_data['software_product']
+        if version not in software_product.softwareproductversion_set.all():
+            raise forms.ValidationError(_(f"Version `{version}` doesn't exist on {software_product}, make sure you've "
+                                          f"selected a compatible version or first select the software product."))
+        return version
+
    def clean(self):
        if not any([self.cleaned_data['device'], self.cleaned_data['virtualmachine']]):
            raise forms.ValidationError(_("Installation requires atleast one virtualmachine or device destination."))
@@ -161,13 +138,12 @@ class SoftwareProductInstallationForm(NetBoxModelForm):


 class SoftwareProductInstallationFilterForm(NetBoxModelFilterSetForm):
-    """Form for filtering SoftwareProductInstallation instances."""
-
    model = SoftwareProductInstallation
+    fieldsets = (
+        (None, ('q', 'tag',)),
+    )

-    q = forms.CharField(required=False, label="Search")
-
-    # tag = TagFilterField(SoftwareProduct)
+    tag = TagFilterField(model)


 class SoftwareProductInstallationCSVForm(NetBoxModelCSVForm):
@@ -189,4 +165,3 @@ class SoftwareProductInstallationBulkEditForm(NetBoxModelBulkEditForm):
    fieldsets = (
        (None, ('software_product', 'version',)),
    )
-    # nullable_fields = ('',)
@@ -1,16 +1,12 @@
 from django.db import models
 from django.urls import reverse, reverse_lazy
 from django.utils import safestring
-# from extras.utils import extras_features  # todo this changed in netbox 3.1.X and higher, currently not used but checkout why
+
 from netbox.models import NetBoxModel
 from utilities.querysets import RestrictedQuerySet


-# @extras_features('custom_fields', 'custom_links', 'export_templates', 'tags', 'webhooks')
 class SoftwareProduct(NetBoxModel):
-    """
-    A SoftwareProduct represents ...
-    """
    name = models.CharField(max_length=128)
    description = models.CharField(max_length=255, null=True, blank=True)

@@ -36,7 +32,6 @@ class SoftwareProduct(NetBoxModel):
        )) if count else "0"


-# @extras_features('custom_fields', 'custom_links', 'export_templates', 'tags', 'webhooks')
 class SoftwareProductVersion(NetBoxModel):
    software_product = models.ForeignKey(
        to='netbox_slm.SoftwareProduct',
@@ -60,7 +55,6 @@ class SoftwareProductVersion(NetBoxModel):
        )) if count else "0"


-# @extras_features('custom_fields', 'custom_links', 'export_templates', 'tags', 'webhooks')
 class SoftwareProductInstallation(NetBoxModel):
    device = models.ForeignKey(
        to='dcim.Device',
@@ -71,8 +65,8 @@ class SoftwareProductInstallation(NetBoxModel):
    virtualmachine = models.ForeignKey(
        to='virtualization.VirtualMachine',
        on_delete=models.PROTECT,
-        null = True,
-        blank = True
+        null=True,
+        blank=True
    )
    software_product = models.ForeignKey(
        to='netbox_slm.SoftwareProduct',
@@ -95,4 +89,4 @@ class SoftwareProductInstallation(NetBoxModel):
        return self.device or self.virtualmachine

    def render_type(self):
-        return f"{'device' if self.device else 'virtualmachine'}"
+        return 'device' if self.device else 'virtualmachine'
@@ -1,9 +1,9 @@
 import django_tables2 as tables
-
 from django.db.models import Count
 from django_tables2.utils import Accessor
+
+from netbox.tables import NetBoxTable, ToggleColumn, columns
 from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
-from netbox.tables import NetBoxTable, ChoiceFieldColumn, ToggleColumn, columns


 class SoftwareProductTable(NetBoxTable):
@@ -0,0 +1,36 @@
+from django.test import TestCase
+
+from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
+
+
+class ModelTestCase(TestCase):
+    def setUp(self):
+        self.p_name = "test product"
+        self.v_name = "test version"
+
+        self.software_product = SoftwareProduct.objects.create(name=self.p_name)
+        self.software_product_version = SoftwareProductVersion.objects.create(
+            name=self.v_name, software_product=self.software_product
+        )
+        self.software_product_installation = SoftwareProductInstallation.objects.create(
+            software_product=self.software_product, version=self.software_product_version
+        )
+
+    def test_model_name(self):
+        self.assertEqual(self.p_name, str(self.software_product))
+        self.assertEqual(self.v_name, str(self.software_product_version))
+        self.assertTrue(str(self.software_product_installation).isnumeric())  # should be PK
+
+    def test_absolute_url(self):
+        self.assertEqual("/plugins/slm/software-products/1/", self.software_product.get_absolute_url())
+        self.assertEqual("/plugins/slm/versions/1/", self.software_product_version.get_absolute_url())
+        self.assertEqual("/plugins/slm/installations/1/", self.software_product_installation.get_absolute_url())
+
+    def test_get_installation_count(self):
+        installation_ss = '<a href="/plugins/slm/installations/?q={}">1</a>'
+        self.assertEqual(installation_ss.format(self.p_name), self.software_product.get_installation_count())
+        self.assertEqual(installation_ss.format(self.v_name), self.software_product_version.get_installation_count())
+
+    def test_product_installation_methods(self):
+        self.assertEqual("virtualmachine", self.software_product_installation.render_type())
+        self.assertIsNone(self.software_product_installation.get_platform())
@@ -1,4 +1,5 @@
 from django.urls import path
+
 from netbox.views.generic import ObjectChangeLogView
 from netbox_slm import views
 from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
@@ -1,25 +1,15 @@
 from netbox.views import generic
-from netbox_slm.filters import SoftwareProductFilter, SoftwareProductVersionFilter, SoftwareProductInstallationFilter
-from netbox_slm.forms import (
-    SoftwareProductForm, SoftwareProductFilterForm, SoftwareProductCSVForm, SoftwareProductBulkEditForm,
-    SoftwareProductVersionForm, SoftwareProductVersionFilterForm, SoftwareProductVersionCSVForm,
-    SoftwareProductVersionBulkEditForm, SoftwareProductInstallationForm, SoftwareProductInstallationFilterForm,
-    SoftwareProductInstallationCSVForm, SoftwareProductInstallationBulkEditForm
-)
-from netbox_slm.models import (
-    SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
-)
-from netbox_slm.tables import SoftwareProductTable, SoftwareProductVersionTable, SoftwareProductInstallationTable
+from netbox_slm import filtersets, forms, tables
+from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation


 class SoftwareProductListView(generic.ObjectListView):
    """View for listing all existing SoftwareProducts."""

    queryset = SoftwareProduct.objects.all()
-    filterset = SoftwareProductFilter
-    filterset_form = SoftwareProductFilterForm
-    table = SoftwareProductTable
-    # template_name = "netbox_slm/object_list.html"
+    filterset = filtersets.SoftwareProductFilterSet
+    filterset_form = forms.SoftwareProductFilterForm
+    table = tables.SoftwareProductTable


 class SoftwareProductView(generic.ObjectView):
@@ -36,7 +26,7 @@ class SoftwareProductEditView(generic.ObjectEditView):
    """View for editing and creating a SoftwareProduct instance."""

    queryset = SoftwareProduct.objects.all()
-    form = SoftwareProductForm
+    form = forms.SoftwareProductForm


 class SoftwareProductDeleteView(generic.ObjectDeleteView):
@@ -47,30 +37,30 @@ class SoftwareProductDeleteView(generic.ObjectDeleteView):

 class SoftwareProductBulkImportView(generic.BulkImportView):
    queryset = SoftwareProduct.objects.all()
-    model_form = SoftwareProductCSVForm
-    table = SoftwareProductTable
+    model_form = forms.SoftwareProductCSVForm
+    table = tables.SoftwareProductTable


 class SoftwareProductBulkEditView(generic.BulkEditView):
    queryset = SoftwareProduct.objects.all()
-    filterset = SoftwareProductFilter
-    table = SoftwareProductTable
-    form = SoftwareProductBulkEditForm
+    filterset = filtersets.SoftwareProductFilterSet
+    filterset_form = forms.SoftwareProductFilterForm
+    table = tables.SoftwareProductTable
+    form = forms.SoftwareProductBulkEditForm


 class SoftwareProductBulkDeleteView(generic.BulkDeleteView):
    queryset = SoftwareProduct.objects.all()
-    table = SoftwareProductTable
+    table = tables.SoftwareProductTable


 class SoftwareProductVersionListView(generic.ObjectListView):
    """View for listing all existing SoftwareProductVersions."""

    queryset = SoftwareProductVersion.objects.all()
-    filterset = SoftwareProductVersionFilter
-    filterset_form = SoftwareProductVersionFilterForm
-    table = SoftwareProductVersionTable
-    # template_name = "netbox_slm/object_list.html"
+    filterset = filtersets.SoftwareProductVersionFilterSet
+    filterset_form = forms.SoftwareProductVersionFilterForm
+    table = tables.SoftwareProductVersionTable


 class SoftwareProductVersionView(generic.ObjectView):
@@ -87,7 +77,7 @@ class SoftwareProductVersionEditView(generic.ObjectEditView):
    """View for editing and creating a SoftwareProductVersion instance."""

    queryset = SoftwareProductVersion.objects.all()
-    form = SoftwareProductVersionForm
+    form = forms.SoftwareProductVersionForm


 class SoftwareProductVersionDeleteView(generic.ObjectDeleteView):
@@ -98,30 +88,29 @@ class SoftwareProductVersionDeleteView(generic.ObjectDeleteView):

 class SoftwareProductVersionBulkImportView(generic.BulkImportView):
    queryset = SoftwareProductVersion.objects.all()
-    model_form = SoftwareProductVersionCSVForm
-    table = SoftwareProductVersionTable
+    model_form = forms.SoftwareProductVersionCSVForm
+    table = tables.SoftwareProductVersionTable


 class SoftwareProductVersionBulkEditView(generic.BulkEditView):
    queryset = SoftwareProductVersion.objects.all()
-    filterset = SoftwareProductVersionFilter
-    table = SoftwareProductVersionTable
-    form = SoftwareProductVersionBulkEditForm
+    filterset = filtersets.SoftwareProductVersionFilterSet
+    table = tables.SoftwareProductVersionTable
+    form = forms.SoftwareProductVersionBulkEditForm


 class SoftwareProductVersionBulkDeleteView(generic.BulkDeleteView):
    queryset = SoftwareProductVersion.objects.all()
-    table = SoftwareProductVersionTable
+    table = tables.SoftwareProductVersionTable


 class SoftwareProductInstallationListView(generic.ObjectListView):
    """View for listing all existing SoftwareProductInstallations."""

    queryset = SoftwareProductInstallation.objects.all()
-    filterset = SoftwareProductInstallationFilter
-    filterset_form = SoftwareProductInstallationFilterForm
-    table = SoftwareProductInstallationTable
-    # template_name = "netbox_slm/object_list.html"
+    filterset = filtersets.SoftwareProductInstallationFilterSet
+    filterset_form = forms.SoftwareProductInstallationFilterForm
+    table = tables.SoftwareProductInstallationTable


 class SoftwareProductInstallationView(generic.ObjectView):
@@ -129,16 +118,12 @@ class SoftwareProductInstallationView(generic.ObjectView):

    queryset = SoftwareProductInstallation.objects.all()

-    # def get_extra_context(self, request, instance):
-    #     records = instance.record_set.all()
-    #     return {"records": records}
-

 class SoftwareProductInstallationEditView(generic.ObjectEditView):
    """View for editing and creating a SoftwareProductInstallation instance."""

    queryset = SoftwareProductInstallation.objects.all()
-    form = SoftwareProductInstallationForm
+    form = forms.SoftwareProductInstallationForm


 class SoftwareProductInstallationDeleteView(generic.ObjectDeleteView):
@@ -149,17 +134,17 @@ class SoftwareProductInstallationDeleteView(generic.ObjectDeleteView):

 class SoftwareProductInstallationBulkImportView(generic.BulkImportView):
    queryset = SoftwareProductInstallation.objects.all()
-    model_form = SoftwareProductInstallationCSVForm
-    table = SoftwareProductInstallationTable
+    model_form = forms.SoftwareProductInstallationCSVForm
+    table = tables.SoftwareProductInstallationTable


 class SoftwareProductInstallationBulkEditView(generic.BulkEditView):
    queryset = SoftwareProductInstallation.objects.all()
-    filterset = SoftwareProductInstallationFilter
-    table = SoftwareProductInstallationTable
-    form = SoftwareProductInstallationBulkEditForm
+    filterset = filtersets.SoftwareProductInstallationFilterSet
+    table = tables.SoftwareProductInstallationTable
+    form = forms.SoftwareProductInstallationBulkEditForm


 class SoftwareProductInstallationBulkDeleteView(generic.BulkDeleteView):
    queryset = SoftwareProductInstallation.objects.all()
-    table = SoftwareProductInstallationTable
+    table = tables.SoftwareProductInstallationTable
@@ -1,11 +1,9 @@
 [metadata]
 name = netbox-slm
-version = 0.98
+version = 1.3
 description = Software Lifecycle Management Netbox Plugin.
-# long_description = file: README.rst
-# long_description_content_type='text/x-rst'
-author = Hedde van der Heide
-author_email = hedde.vanderheide@ictu.nl
+author = ICTU
+author_email = open-source-projects@ictu.nl
 license = Apache 2.0
 classifiers =
    Environment :: Web Environment
@@ -16,13 +14,13 @@ classifiers =
    Programming Language :: Python
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3 :: Only
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
    Topic :: Internet :: WWW/HTTP
    Topic :: Internet :: WWW/HTTP :: Dynamic Content

 [options]
 include_package_data = true
 packages = find:
-python_requires = >=3.7
+python_requires = >=3.9
@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()
@@ -0,0 +1,13 @@
+# Project metadata
+sonar.organization=ictu
+sonar.projectKey=ICTU_netbox_slm
+sonar.projectName=netbox-slm
+sonar.projectVersion=1.3
+
+# Path is relative to the sonar-project.properties file
+sonar.sources=netbox_slm
+sonar.python.version=3.9
+
+# Unit tests
+sonar.python.xunit.reportPath=ci/reports/junit.xml
+sonar.python.coverage.reportPaths=ci/reports/coverage.xml
@@ -1,13 +0,0 @@
-Copyright 2022 ICTU
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
@@ -1,3 +0,0 @@
-include ../LICENSE
-include ../README.rst
-recursive-include netbox_slm/templates *
@@ -1,215 +0,0 @@
-Software Lifecycle Management
-----------------------------
-
-*Netbox Plugin for lifecycle management of software components, including versions and installations*
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
--------------
-
-Installation Guide
-~~~~~~~~~~~~~~~~~~
-
-WARNING: This plugin is only tested with Netbox 3.2 at this time.
-
-When using the Docker version of Netbox, first follow the `netbox-docker
-quickstart <https://github.com/netbox-community/netbox-docker#quickstart>`__
-instructions to clone the netbox-docker repo and set up the
-``docker-compose.override.yml``.
-
-Next, follow these instructions (based on the `Netbox docker variant
-instructions <https://github.com/netbox-community/netbox-docker/wiki/Configuration#custom-configuration-files>`__)
-to install the Netbox SLM plugin:
-
-1. Add ``netbox_slm`` to the ``PLUGINS`` list in
-   ``configuration/extra.py``.
-2. Create a ``plugin_requirements.txt`` with ``netbox-slm==0.98`` as
-   contents.
-3. Create a ``Dockerfile-SLM`` with contents:
-
-.. code:: dockerfile
-
-   FROM netboxcommunity/netbox:v3.2.X
-
-   COPY ./plugin_requirements.txt /
-   RUN /opt/netbox/venv/bin/pip install --no-warn-script-location -r /plugin_requirements.txt
-
-4. Create a ``docker-compose.override.yml`` with contents:
-
-.. code:: yaml
-
-   version: '3.4'
-   services:
-     netbox:
-       ports:
-         - 8000:8080
-       build:
-         context: .
-         dockerfile: Dockerfile-SLM
-       image: netbox:slm
-     netbox-worker:
-       image: netbox:slm
-     netbox-housekeeping:
-       image: netbox:slm
-
-Now, build the image: ``docker compose build --no-cache``
-
-And finally, run Netbox with the SLM plugin: ``docker compose up``
-
-Releasing Guide
-~~~~~~~~~~~~~~~
-
-To draft a release;
-
-update the setup.py file to reflect the new version, then from the *src*
-directory run
-
-::
-
-   # make sure to update the version in netbox_slm/__init__.py
-   $ python setup.py sdist
-   $ twine upload dist/*
-
-On Github.com create a similar tag and version. These steps could be
-automated with a github workflow.
-
-n.b. Currently the plugin is configured to use a personal pypi account,
-this should be changed.
-
-Developer Guide (local installation)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-*Follow the steps below on your local system to run netbox and the
-netbox_slm plugin in developer mode*
-
-Setup
-~~~~~
-
-The goal below is to run all Netbox components in Docker and run a local
-Netbox Django copy with auto-reload to develop the plugin pointing to
-the Dockerized postgres and redis instances, basically ignoring the
-netbox docker runtime server.
-
-Steps
-~~~~~
-
-::
-
-   from your projects directory clone the netbox repository
-
-   $ git clone https://github.com/netbox-community/netbox
-   $ cd netbox
-
-   install the virtual environment
-
-   $ pipenv shell
-   $ pipenv install
-
-   create and edit netbox/configuration.py (based on the template file) add these lines at the end of the file;
-
-   DEBUG = True
-   SECRET_KEY = 'dummy'
-   DEVELOPER = True
-   PLUGINS = [
-       'netbox_slm',
-   ]
-
-The Netbox installation above will be used to run Django management
-commands like runserver, makemigrations and migrate, which will be
-explained in the next steps below;
-
-::
-
-   from your projects directory clone the netbox-slm repository
-
-   $ git clone https://github.com/ICTU/netbox_slm
-   $ cd netbox_slm
-   $ ./start-netbox.sh
-
-This will start Netbox locally (requires Docker) and forward the redis
-and postgres ports to the localhost (make sure there’s no processes
-using these ports or change the dockerfiles accordingly)
-
-Note, you can also start and stop netbox by hand:
-
-::
-
-   $ cd netbox-docker
-   $ docker-compose up -d
-
-   or stop the stack with
-
-   $ docker-compose down
-
-   # to start fresh:
-
-   $ docker-compose down
-   $ docker volume rm netbox-docker_netbox-postgres-data  # et cetera
-   $ docker-compose up -d --force-recreate
-
-   this will require you to re-run the migrate commando's for netbox-slm, see further down below
-
-Go back to the netbox configuration.py file and update the postgres and
-redis connection strings (username, password) to the ones the netbox
-docker backend is using, for example (using default user and passwords
-from the netbox docker example):
-
-::
-
-   <<collapsed>>
-
-   # 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': 'netbox',               # Database name
-       'USER': 'netbox',               # PostgreSQL username
-       'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password
-       'HOST': 'localhost',            # Database server
-       'PORT': '',                     # Database port (leave blank for default)
-       'CONN_MAX_AGE': 300,            # Max database connection age
-   }
-
-   # 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': 'localhost',
-           'PORT': 6379,
-           # Comment out `HOST` and `PORT` lines and uncomment the following if using Redis Sentinel
-           # 'SENTINELS': [('mysentinel.redis.example.com', 6379)],
-           # 'SENTINEL_SERVICE': 'netbox',
-           'PASSWORD': 'H733Kdjndks81',
-           'DATABASE': 0,
-           'SSL': False,
-           # Set this to True to skip TLS certificate verification
-           # This can expose the connection to attacks, be careful
-           # 'INSECURE_SKIP_TLS_VERIFY': False,
-       },
-       'caching': {
-           'HOST': 'localhost',
-           'PORT': 6379,
-           # Comment out `HOST` and `PORT` lines and uncomment the following if using Redis Sentinel
-           # 'SENTINELS': [('mysentinel.redis.example.com', 6379)],
-           # 'SENTINEL_SERVICE': 'netbox',
-           'PASSWORD': 'H733Kdjndks81',
-           'DATABASE': 1,
-           'SSL': False,
-           # Set this to True to skip TLS certificate verification
-           # This can expose the connection to attacks, be careful
-           # 'INSECURE_SKIP_TLS_VERIFY': False,
-       }
-   }
-
-   <<collapsed>>
-
-Now you can run commands from the netbox repository like this;
-
-::
-
-   $ cd netbox/netbox
-   $ export PYTHONPATH=../../netbox-slm/src/
-   $ python3 manage.py migrate netbox_slm
-   $ python3 manage.py runserver 8001
-
-Visit http://127.0.0.1:8001 in the browesr to see the auto reloading
-version of the netbox UI. Port 8000 is taken by the docker ran variant.
@@ -1,14 +0,0 @@
-from django.contrib import admin
-from netbox_slm.models import SoftwareProduct, SoftwareProductVersion
-
-
-class SoftwareProductVersionInline(admin.TabularInline):
-    model = SoftwareProductVersion
-    fields = ('name',)
-    extra = 0
-
-
-@admin.register(SoftwareProduct)
-class SoftwareProductAdmin(admin.ModelAdmin):
-    list_display = ('name',)
-    inlines = (SoftwareProductVersionInline,)
@@ -1,50 +0,0 @@
-from django.forms import BoundField
-from django.urls import reverse
-
-from utilities.forms import DynamicModelMultipleChoiceField
-
-
-class CustomDynamicModelMultipleChoiceField(DynamicModelMultipleChoiceField):
-    def get_bound_field(self, form, field_name):
-        bound_field = BoundField(form, self, field_name)
-
-        # Set initial value based on prescribed child fields (if not already set)
-        if not self.initial and self.initial_params:
-            filter_kwargs = {}
-            for kwarg, child_field in self.initial_params.items():
-                value = form.initial.get(child_field.lstrip("$"))
-                if value:
-                    filter_kwargs[kwarg] = value
-            if filter_kwargs:
-                self.initial = self.queryset.filter(**filter_kwargs).first()
-
-        # Modify the QuerySet of the field before we return it. Limit choices to any data already bound: Options
-        # will be populated on-demand via the APISelect widget.
-        data = bound_field.value()
-
-        if data:
-            field_name = getattr(self, "to_field_name") or "pk"
-            filter = self.filter(field_name=field_name)
-            try:
-                self.queryset = filter.filter(self.queryset, data)
-            except (TypeError, ValueError):
-                # Catch any error caused by invalid initial data passed from the user
-                self.queryset = self.queryset.none()
-        else:
-            self.queryset = self.queryset.none()
-
-        # Set the data URL on the APISelect widget (if not already set)
-        widget = bound_field.field.widget
-        if not widget.attrs.get("data-url"):
-            app_label = self.queryset.model._meta.app_label
-            model_name = self.queryset.model._meta.model_name
-
-            #
-            # Custom url for work with plugin api
-            #
-            data_url = reverse(
-                "plugins-api:{}-api:{}-list".format(app_label, model_name)
-            )
-            widget.attrs["data-url"] = data_url
-
-        return bound_field
@@ -1,75 +0,0 @@
-import django_filters
-from django.db.models import Q
-from django.utils.translation import gettext as _
-from extras.filters import TagFilter
-from netbox.filtersets import NetBoxModelFilterSet
-from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
-from utilities.forms import DynamicModelMultipleChoiceField
-
-
-class BaseFilter(NetBoxModelFilterSet):
-    q = django_filters.CharFilter(
-        method="search",
-        label="Search",
-    )
-
-
-class SoftwareProductFilter(BaseFilter):
-    """Filter capabilities for SoftwareProduct instances."""
-
-    name = django_filters.CharFilter(
-        lookup_expr="icontains",
-    )
-    # tag = TagFilter()
-
-    class Meta:
-        model = SoftwareProduct
-        fields = ("name",)  # "tag")
-
-    def search(self, queryset, name, value):
-        """Perform the filtered search."""
-        if not value.strip():
-            return queryset
-        qs_filter = Q(name__icontains=value)  # | Q(status__icontains=value)
-        return queryset.filter(qs_filter)
-
-
-class SoftwareProductVersionFilter(BaseFilter):
-    name = django_filters.CharFilter(
-        lookup_expr="icontains", label="Version"
-    )
-    # software_product_id = django_filters.ModelMultipleChoiceFilter(
-    #     queryset=SoftwareProduct.objects.all(),
-    #     label='SoftwareProduct (ID)',
-    # )
-    # software_product = django_filters.ModelMultipleChoiceFilter(
-    #     field_name='software_product__name',
-    #     queryset=SoftwareProduct.objects.all(),
-    #     to_field_name='name',
-    #     label='SoftwareProduct (name)',
-    # )
-    # tag = TagFilter()
-
-    class Meta:
-        model = SoftwareProductVersion
-        fields = ("name", "software_product")  # "tag")
-
-    def search(self, queryset, name, value):
-        """Perform the filtered search."""
-        if not value.strip():
-            return queryset
-        qs_filter = Q(name__icontains=value)  # | Q(status__icontains=value)
-        return queryset.filter(qs_filter)
-
-
-class SoftwareProductInstallationFilter(BaseFilter):
-    class Meta:
-        model = SoftwareProductInstallation
-        fields = tuple()  # "tag")
-
-    def search(self, queryset, name, value):
-        """Perform the filtered search."""
-        if not value.strip():
-            return queryset
-        qs_filter = Q(software_product__name__icontains=value) | Q(version__name__icontains=value)
-        return queryset.filter(qs_filter)
@@ -1,3 +0,0 @@
-from setuptools import setup, Extension
-
-setup()
@@ -1,7 +1,7 @@
 git clone -b release https://github.com/netbox-community/netbox-docker.git
 cd netbox-docker
 tee docker-compose.override.yml <<EOF
-version: '3.4'
+version: '3.7'
 services:
  netbox:
    ports:
Author	SHA1	Message	Date
wkoot	88edcde8d6	Unify api serializers (#16 )	2023-04-19 10:14:32 +02:00
wkoot	7f18a3ad6f	Version bump NetBox 3.4.7 (#15 ) Closes #14	2023-03-31 10:02:35 +02:00
wkoot	1925be271a	Set up continuous integration (#13 ) Closes #3	2023-03-29 22:00:48 +02:00
Hedde van der Heide	a53486ca23	bump version to 1.2	2022-05-19 11:08:57 +02:00
Hedde van der Heide	4bc418a5d0	fixed filter bug versions api and set required on manufacturer for softwareproducts add	2022-05-19 11:06:34 +02:00
Hedde van der Heide	e952111a53	version bump 1.1	2022-05-03 15:21:18 +02:00
Hedde van der Heide	e73cb5fa1a	Merge branch 'master' of https://github.com/ICTU/netbox_slm	2022-05-03 15:19:55 +02:00
Hedde van der Heide	56552bdd02	fixed filter search	2022-05-03 15:19:53 +02:00
Hedde van der Heide	f914e78812	Update README.md	2022-05-02 12:39:47 +02:00
Hedde van der Heide	c9a7b2315e	Update README.md	2022-05-02 12:37:36 +02:00
Hedde van der Heide	a8c9fc5fbe	Delete LICENSE.md	2022-05-02 12:37:18 +02:00
Hedde van der Heide	a1f6e3dc92	Create LICENSE	2022-05-02 12:37:11 +02:00
Hedde van der Heide	4f8053c0f6	Rename LICENSE to LICENSE.md	2022-05-02 12:32:20 +02:00
Hedde van der Heide	3b3a6d63d4	Update and rename README.rst to README.md	2022-05-02 12:32:08 +02:00
Hedde van der Heide	ce283dea52	updated README	2022-04-22 14:04:29 +02:00
Hedde van der Heide	f3579cce63	updated README	2022-04-22 13:57:49 +02:00
Hedde van der Heide	3bb711ea84	updated README	2022-04-22 13:57:45 +02:00
Hedde van der Heide	9d76bb421d	normalized project structure	2022-04-22 13:52:26 +02:00
Hedde van der Heide	7a24221444	moved top level files	2022-04-22 13:33:17 +02:00
Hedde van der Heide	ac198ef7cf	Large overhaul of naming conventions and code clean ups	2022-04-22 13:30:10 +02:00