🚀 release: 1.0.0 #97

mfiedorowicz · 2025-04-24T18:24:58Z

🚀 Major improvements and breaking changes:

Expanded support for NetBox object types: broader compatibility with additional NetBox models to enhance integration capabilities
OAuth2 authentication added: introduces support for OAuth2, enabling more secure and flexible authentication workflows (API key authentication deprecated)
Streamlined plugin setup: no longer requires manual user or token provisioning

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

* enable netbox_branching plugin by default in development/test docker image * include netbox-worker * add development setting defaults * don't pin branching plugin

* chore: add safe redirect to login Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * chore: gha - add missing permissions Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * chore: gha - pin actions to commit hashes Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * tidy up Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> --------- Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

* updates sdk to pick up ignored state * handle unknown states gracefully

* chore: security improvements (#53) * chore: add safe redirect to login Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * chore: gha - add missing permissions Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * chore: gha - pin actions to commit hashes Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * tidy up Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> --------- Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * update protobufs * update constants in tests --------- Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> Co-authored-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

* chore: remove reconciler sdk Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * fix: docker setup with netbox 4.1.11 for netbox-branching plugin Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * feat: remove ingestion logs view Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * chore: update CODEOWNERS Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> --------- Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

* fix: retrieve object states using concrete models Search backend/CachedValue is global and doesn't seem to be reliable with branching Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * tidy up Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * chore: bump netbox min version and netbox-docker Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * chore: bump netbox min version Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * fix tests Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * use clean_fields() and tidy up Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * fix: add backwards compatible support for mac_address field (#62) * fix: add backwards compatible support for mac_address field * feat: extract and serialize site from scope Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * feat: apply change set - handle scope site Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> --------- Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> Co-authored-by: Luke Tucker <64618+ltucker@users.noreply.github.com>

* fix: retrieving object states of tags Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * fix: skip creating objects if already exist Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * chore: refactor apply change set view complexity Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * tidy up Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> --------- Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

* fix: scope support on apply change set (#64) Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * wip diff api * set default values and missing slugs Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * tidy up setting defaults Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * remove unused imports Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * fix constructor of object type Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * set slugs (if not present) after resolving existing instances Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * emit ref_id instead of variable object_id field for new objects * improve entity field mapping coverage * fill in primary value mapping, use primary value for slug * use canonical field ordering in change dicts * first pass at certain common circular refs * remove ref id to itself Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * tidy up Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * add applier Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * fix resolve ref before lookup, use field name directly, not field attr * don't query with unresolved references * fix _build_expressions_queryset Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * resolve lint issues Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * exclude fields with GenericRelation type Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * fix sorting dict we may get ints strings etc Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * rework applier logic Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * applier with content type fields Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * fix content type related existing value Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * exclude foreign key fields with many to one rel Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * fix: support for post create updates eg (primary mac address) (#68) * fix: support for post create updates eg (primary mac address) * use serializers, fix relevent tests * linting * filter fields in the prior state * add some basic smoke tests for diff / diff+apply * Change set validation (#69) * add change set validation Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * remove redundant serializers Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * remove redundant serializers tests Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * tidy up Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * adjust tests, lighter validation of refs on diff, handle generic --------- Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> Co-authored-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> * fix: expand support for cycle breaking, add additional logical matchers (#70) * fix: fix error fingerprinting tags (#71) * fix: all noops -> no changes, show noops as only prior state (#72) --------- Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com> Co-authored-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

basic support for custom fields

cleanup error messages

special transformations to format inputs the way serializers expect adds handling for date only fields, decimal (vs float) and integer range

* fix: special handling for ip address network defaulting * fix: match ips ignoring mask value, use specific matchers

* fix: fix complex vm interface update case * lint

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

…x Plugin - Added DiodeOAuth2Authentication class for handling OAuth2 token validation. - Introduced IsDiodeOAuth2Authenticated permission class to check OAuth2 authentication. - Updated GenerateDiffView and ApplyChangeSetView to use the new authentication and permission classes. Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

…s files Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

* fix: handle callable defaults, defaults with non serializable values * fix: mark circuits.provider.accounts as circular * fix: error deduplicating device types * fix: report merge errors as 400 not 500 * fix: mark device oob_ip as circular * fix: adjust fingerprint matching for complex module bay case * fix: test virtual machine with primary_ip4 errors, logical cluster matching * fix: harmonize ZoneInfo values * fix: fix logical prefix in vrf lookup * fix: handle IntegrityError nicely * fix: support cached scope for matching * fix: add additional logical matchers * fix: don't alter arrays. output prior states for other ref types * fix: add table test for create/update of various types * fix: additional fixes from testing * fix: reduce logging, guard expensive trace logging with flag * fix: linting

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

…concurrency) Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

…output handling in workflow Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

github-actions · 2025-04-24T18:30:41Z

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
2824	2630	93%	0%	🟢

New Files

File	Coverage	Status
netbox_diode_plugin/api/applier.py	92%	🟢
netbox_diode_plugin/api/authentication.py	96%	🟢
netbox_diode_plugin/api/common.py	88%	🟢
netbox_diode_plugin/api/differ.py	94%	🟢
netbox_diode_plugin/api/matcher.py	88%	🟢
netbox_diode_plugin/api/plugin_utils.py	82%	🟢
netbox_diode_plugin/api/supported_models.py	91%	🟢
netbox_diode_plugin/api/transformer.py	89%	🟢
netbox_diode_plugin/tests/test_api_diff_and_apply.py	100%	🟢
netbox_diode_plugin/tests/test_api_generate_diff.py	100%	🟢
netbox_diode_plugin/tests/test_authentication.py	99%	🟢
netbox_diode_plugin/tests/test_updates.py	93%	🟢
TOTAL	93%	🟢

Modified Files

File	Coverage	Status
netbox_diode_plugin/init.py	100%	🟢
netbox_diode_plugin/api/init.py	100%	🟢
netbox_diode_plugin/api/permissions.py	100%	🟢
netbox_diode_plugin/api/serializers.py	0%	🟢
netbox_diode_plugin/api/urls.py	100%	🟢
netbox_diode_plugin/api/views.py	79%	🟢
netbox_diode_plugin/forms.py	100%	🟢
netbox_diode_plugin/models.py	100%	🟢
netbox_diode_plugin/navigation.py	100%	🟢
netbox_diode_plugin/plugin_config.py	96%	🟢
netbox_diode_plugin/tests/init.py	100%	🟢
netbox_diode_plugin/tests/test_api_apply_change_set.py	99%	🟢
netbox_diode_plugin/tests/test_forms.py	100%	🟢
netbox_diode_plugin/tests/test_models.py	100%	🟢
netbox_diode_plugin/tests/test_plugin_config.py	100%	🟢
netbox_diode_plugin/tests/test_version.py	100%	🟢
netbox_diode_plugin/tests/test_views.py	100%	🟢
netbox_diode_plugin/urls.py	100%	🟢
netbox_diode_plugin/version.py	100%	🟢
netbox_diode_plugin/views.py	100%	🟢
TOTAL	94%	🟢

updated for commit: c8e6b9c by action🐍

leoparente

LGTM 🚀

mfiedorowicz and others added 30 commits October 14, 2024 16:55

chore: add v0.6.0 to netbox-plugin manifest (#44)

102f95e

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

chore: run lint and tests workflow on plugin code change only (#45)

abaea64

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

chore: add GitHub issue templates (#46)

2f5a863

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

chore: GHA release - use GITHUB_TOKEN (#48)

a49113b

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

chore: GHA release - set permissions (#49)

5f44578

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

feat: enable netbox_branching plugin by default (#51)

7838f9d

* enable netbox_branching plugin by default in development/test docker image * include netbox-worker * add development setting defaults * don't pin branching plugin

fix: do not treat _branch parameter as search criterion (#52)

3477b04

chore: update reconciler sdk to pick up ignored state (#54)

cd55ef8

* updates sdk to pick up ignored state * handle unknown states gracefully

chore: regenerate reconciler sdk (#56)

1fa65a4

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

chore: regenerate reconciler proto (#57)

89adbae

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

fix: scope support on apply change set (#64)

93e4c9b

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

fix: adjust result structure (#74)

fd79324

feat: basic support for custom fields (#75)

905e2c8

basic support for custom fields

fix: fix errors attempting value harmonization (#76)

a8019f9

cleanup error messages

fix: merge tags rather than overwrite (#77)

6275570

fix: accept both valid forms of protoJSON (snake and camel) (#78)

4ee1b5e

fix: add special format transformations (#80)

53158b2

special transformations to format inputs the way serializers expect adds handling for date only fields, decimal (vs float) and integer range

fix: special cases for ip network defaulting (#81)

9b01b3e

* fix: special handling for ip address network defaulting * fix: match ips ignoring mask value, use specific matchers

fix: fix complex vm interface update case (#82)

adf151f

* fix: fix complex vm interface update case * lint

fix: fix decimal / eui previous values (#83)

d847a00

fix: update dependency versions to allow for newer releases (#84)

bfe4788

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

chore: update copyright year in authentication, permissions, and view…

f0a8af4

…s files Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

ltucker and others added 18 commits April 23, 2025 16:59

fix: sanitize branch name

ef1bee6

Potential fix for code scanning alert no. 21: Log Injection

8c46fd2

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

Potential fix for code scanning alert no. 16: Log Injection

3a70229

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

fix: fix flakey tag sorting, test cleanup

ece4fe8

feat: diode data plugin 1.0 rc (#88)

28672d5

perf: license update to NetBox Limited Use License 1.0

d86ce16

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

fix: generate diff - set branch for the change set

16e2a14

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

fix: generate diff - set branch for the change set (#90)

886d916

perf: license update to NetBox Limited Use License 1.0 (#89)

9616d2c

fix: consider object type in fingerprint all deduplication

203ef34

fix: consider object type in fingerprint all deduplication (#91)

65c16f3

fix: handle validation errors by finding existing objects on create (…

3c3b61c

…concurrency) Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

chore: linux extra hosts (#92)

c4dee43

fix: apply fails to create already existing object (#93)

794a325

chore: create tests for double created objects

8bf87ec

chore: create tests for double created objects (#94)

700ad6e

chore: update Python package name format and improve release version …

48b7c56

…output handling in workflow Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

fix: update release GHA workflow (#96)

c8e6b9c

mfiedorowicz requested a review from ltucker April 24, 2025 18:24

mfiedorowicz self-assigned this Apr 24, 2025

mfiedorowicz requested a review from leoparente as a code owner April 24, 2025 18:24

github-actions bot added markdown dependencies python github-actions internal github-templates labels Apr 24, 2025

leoparente approved these changes Apr 24, 2025

View reviewed changes

mfiedorowicz merged commit a1a7f57 into release Apr 24, 2025
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

🚀 release: 1.0.0 #97

🚀 release: 1.0.0 #97

Uh oh!

mfiedorowicz commented Apr 24, 2025

Uh oh!

github-actions bot commented Apr 24, 2025

Uh oh!

leoparente left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

🚀 release: 1.0.0 #97

🚀 release: 1.0.0 #97

Uh oh!

Conversation

mfiedorowicz commented Apr 24, 2025

Uh oh!

github-actions bot commented Apr 24, 2025

☂️ Python Coverage

Overall Coverage

New Files

Modified Files

Uh oh!

leoparente left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants