Merge branch 'develop' into loose_matching

Author: leoparente

.github/CODEOWNERS

@@ -1 +1 @@
-* @leoparente @ltucker @mfiedorowicz
+* @jajeffries @leoparente @ltucker @mfiedorowicz @MicahParks

.github/workflows/lint-tests.yml

@@ -26,6 +26,7 @@ jobs:
     strategy:
       matrix:
         python: [ "3.10" ]
+        netbox: [ "", "v4.2.3" ]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -40,15 +41,25 @@ jobs:
           pip install .[dev]
           pip install .[test]
       - name: Lint with Ruff
+        id: lint
         run: |
           ruff check --output-format=github netbox_diode_plugin/
         continue-on-error: true
       - name: Test
+        id: test
         run: |
-          make docker-compose-netbox-plugin-test-cover
+          make NETBOX_VERSION=${{ matrix.netbox }} docker-compose-netbox-plugin-test-cover
+        continue-on-error: true
+      - name: Check results
+        if: always()
+        run: |
+          if [[ "${{ steps.lint.outcome }}" == "failure" || "${{ steps.test.outcome }}" == "failure" ]]; then
+            echo "Either linting or tests failed"
+            exit 1
+          fi
       - name: Coverage comment
         uses: orgoro/coverage@3f13a558c5af7376496aa4848bf0224aead366ac # v3.2
-        if: github.event.pull_request.head.repo.full_name == github.repository
+        if: github.event.pull_request.head.repo.full_name == github.repository && matrix.netbox == ''
         with:
           coverageFile: ./docker/coverage/report.xml
           token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -29,5 +29,6 @@ dist/
 # Docker
 docker/coverage
 !docker/netbox/env
+!docker/*/netbox/env
 docker/oauth2/secrets/*
 !docker/oauth2/secrets/.gitkeep

Makefile

@@ -4,20 +4,48 @@ else
   DOCKER_COMPOSE := docker-compose
 endif
 
+NETBOX_VERSION ?=
+ifneq ($(NETBOX_VERSION),)
+  DOCKER_PATH := docker/$(NETBOX_VERSION)
+  TEST_SELECTOR := "/opt/netbox/netbox/netbox_diode_plugin/tests/$(NETBOX_VERSION)/tests/"
+else
+  DOCKER_PATH := docker
+  TEST_SELECTOR = netbox_diode_plugin
+endif 
+
 .PHONY: docker-compose-netbox-plugin-up
 docker-compose-netbox-plugin-up:
-	@$(DOCKER_COMPOSE) -f docker/docker-compose.yaml up -d --build
+	@$(DOCKER_COMPOSE) -f $(DOCKER_PATH)/docker-compose.yaml up -d --build
 
 .PHONY: docker-compose-netbox-plugin-down
 docker-compose-netbox-plugin-down:
-	@$(DOCKER_COMPOSE) -f docker/docker-compose.yaml down
+	@$(DOCKER_COMPOSE) -f $(DOCKER_PATH)/docker-compose.yaml down
 
 .PHONY: docker-compose-netbox-plugin-test
 docker-compose-netbox-plugin-test:
-	-@$(DOCKER_COMPOSE) -f docker/docker-compose.yaml -f docker/docker-compose.test.yaml run -u root --rm netbox ./manage.py test $(TEST_FLAGS) --keepdb netbox_diode_plugin
-	@$(MAKE) docker-compose-netbox-plugin-down
+	@$(DOCKER_COMPOSE) -f $(DOCKER_PATH)/docker-compose.yaml -f $(DOCKER_PATH)/docker-compose.test.yaml run -u root --rm netbox ./manage.py test $(TEST_FLAGS) --keepdb $(TEST_SELECTOR); \
+	EXIT_CODE=$$?; \
+	$(MAKE) docker-compose-netbox-plugin-down; \
+	exit $$EXIT_CODE
+
+.PHONY: docker-compose-netbox-plugin-test-lint
+docker-compose-netbox-plugin-test-lint:
+	@$(DOCKER_COMPOSE) -f $(DOCKER_PATH)/docker-compose.yaml -f $(DOCKER_PATH)/docker-compose.test.yaml run -u root --rm netbox ruff check --output-format=github netbox_diode_plugin; \
+	EXIT_CODE=$$?; \
+	$(MAKE) docker-compose-netbox-plugin-down; \
+	exit $$EXIT_CODE
 
 .PHONY: docker-compose-netbox-plugin-test-cover
 docker-compose-netbox-plugin-test-cover:
-	-@$(DOCKER_COMPOSE) -f docker/docker-compose.yaml -f docker/docker-compose.test.yaml run --rm -u root -e COVERAGE_FILE=/opt/netbox/netbox/coverage/.coverage netbox sh -c "coverage run --source=netbox_diode_plugin --omit=*/migrations/* ./manage.py test --keepdb netbox_diode_plugin && coverage xml -o /opt/netbox/netbox/coverage/report.xml && coverage report -m | tee /opt/netbox/netbox/coverage/report.txt"
-	@$(MAKE) docker-compose-netbox-plugin-down
+	@$(DOCKER_COMPOSE) -f $(DOCKER_PATH)/docker-compose.yaml -f $(DOCKER_PATH)/docker-compose.test.yaml run --rm -u root -e COVERAGE_FILE=/opt/netbox/netbox/coverage/.coverage netbox sh -c "coverage run --source=netbox_diode_plugin --omit=*/migrations/* ./manage.py test --keepdb $(TEST_SELECTOR) && coverage xml -o /opt/netbox/netbox/coverage/report.xml && coverage report -m | tee /opt/netbox/netbox/coverage/report.txt"; \
+	EXIT_CODE=$$?; \
+	$(MAKE) docker-compose-netbox-plugin-down; \
+	exit $$EXIT_CODE
+
+.PHONY: docker-compose-generate-matching-docs
+docker-compose-generate-matching-docs:
+	@$(DOCKER_COMPOSE) -f $(DOCKER_PATH)/docker-compose.yaml -f $(DOCKER_PATH)/docker-compose.test.yaml run --rm netbox python manage.py generate_matching_docs | awk '/Generating markdown documentation.../{p=1;next} p' > ./docs/matching-criteria-documentation.md
+
+.PHONY: docker-compose-migrate
+docker-compose-migrate:
+	@$(DOCKER_COMPOSE) -f $(DOCKER_PATH)/docker-compose.yaml -f $(DOCKER_PATH)/docker-compose.test.yaml run --rm netbox python manage.py migrate

README.md

@@ -17,6 +17,10 @@ at [https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in
 |    >= 3.7.2    |     0.1.0      |
 |    >= 4.1.0    |     0.4.0      |
 |    >= 4.2.3    |     1.0.0      |
+|    >= 4.2.3    |     1.1.0      |
+|    >= 4.2.3    |     1.2.0      |
+|    >= 4.4.0    |     1.4.0      |
+|    >= 4.4.0    |     1.4.1      |
 
 ## Installation
 
@@ -97,6 +101,12 @@ cd /opt/netbox/netbox
 make docker-compose-netbox-plugin-test
 ```
 
+## Generating Documentation
+Generates documentation on how diode entities are matched. The generated documentation is output to [here](./docs/matching-criteria-documentation.md).
+```shell
+make docker-compose-generate-matching-docs
+```
+
 ## License
 
 Distributed under the NetBox Limited Use License 1.0. See [LICENSE.md](./LICENSE.md) for more information.

docker/Dockerfile

@@ -0,0 +1,13 @@
+FROM netboxcommunity/netbox:v4.4.2-3.4.1
+
+COPY ./netbox/configuration/ /etc/netbox/config/
+RUN chmod 755 /etc/netbox/config/* && \
+    chown unit:root /etc/netbox/config/*
+
+COPY ./netbox/local_settings.py /opt/netbox/netbox/netbox/local_settings.py
+RUN chmod 755 /opt/netbox/netbox/netbox/local_settings.py && \
+    chown unit:root /opt/netbox/netbox/netbox/local_settings.py
+
+COPY ./requirements-diode-netbox-plugin.txt /opt/netbox/
+ENV VIRTUAL_ENV=/opt/netbox/venv
+RUN /usr/local/bin/uv pip install -r /opt/netbox/requirements-diode-netbox-plugin.txt

docker/docker-compose.yaml

@@ -1,10 +1,10 @@
 name: diode-netbox-plugin
 services:
   netbox: &netbox
-    image: netboxcommunity/netbox:v4.2.3-3.1.1-diode-netbox-plugin
+    image: netboxcommunity/netbox:v4.4.2-3.4.1-diode-netbox-plugin
     build:
       context: .
-      dockerfile: Dockerfile-diode-netbox-plugin
+      dockerfile: Dockerfile
       pull: true
     depends_on:
       - netbox-postgres