Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Role model definition #2822

Merged
merged 165 commits into from Jan 10, 2023
Merged

Role model definition #2822

merged 165 commits into from Jan 10, 2023

Conversation

timizuoebideri1
Copy link
Contributor

@timizuoebideri1 timizuoebideri1 commented Nov 14, 2022 •
edited

Closes: #1063

What's Changed

Role model and further related classes that are pertinent to Role models were created.

This PR only focuses on how role models would look like; If accepted, a different PR would be made that incorporates the role into the necessary models.

TODO

  • Explanation of Change(s)
  • Added change log fragment(s) (for more information see the documentation)
  • Attached Screenshots, Payload Example
  • Unit, Integration Tests
  • Documentation Updates (when adding/changing features)
  • Example Plugin Updates (when adding/changing features)
  • Outline Remaining Work, Constraints from Design

PR Milestones:

  • Create Role model
  • API view for role model, this PR would include: filterform, serializers, ViewSet and URLs -> PR
  • UI view for role model - CRUD operations -> PR
  • Add data migrations for roles i.e In IPAddress, there are several default roles that should be introduced automatically. and obtain existing roles in all apps -> PR
  • Add/update role fields to these models: Racks, Device, VirtualMachine, prefix, vlan, ipaddress
  • Remove outdated code and Models that was rendered obsolete by the implementation of a role model.
  • Add testcases
  • Add documentation

@timizuoebideri1 timizuoebideri1 linked an issue Nov 14, 2022 that may be closed by this pull request
Add a generic Role model #1063
Closed
@bryanculver bryanculver marked this pull request as ready for review November 14, 2022 16:20
@bryanculver
Copy link
Member

Looking for a model sanity check review.

glennmatthews
glennmatthews reviewed Nov 14, 2022
View reviewed changes
Copy link
Contributor

@glennmatthews glennmatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a solid start!

nautobot/extras/models/roles.py Outdated Show resolved Hide resolved
nautobot/extras/models/roles.py Outdated Show resolved Hide resolved
nautobot/extras/models/roles.py Outdated Show resolved Hide resolved
nautobot/extras/utils.py Outdated Show resolved Hide resolved
nautobot/extras/utils.py Outdated Show resolved Hide resolved
timizuoebideri1 and others added 2 commits November 15, 2022 05:16
@timizuoebideri1 @glennmatthews
Apply suggestions from code review
325a609 
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@timizuoebideri1
Create abstract BasePropertiesModel model
30f6aee
glennmatthews
glennmatthews reviewed Nov 16, 2022
View reviewed changes
nautobot/extras/fields.py Outdated Show resolved Hide resolved
nautobot/extras/fields.py Outdated Show resolved Hide resolved
nautobot/extras/fields.py Outdated Show resolved Hide resolved
nautobot/extras/models/base_properties.py Outdated Show resolved Hide resolved
nautobot/extras/models/base_properties.py Outdated Show resolved Hide resolved
nautobot/extras/models/base_properties.py Outdated Show resolved Hide resolved
nautobot/extras/models/roles.py Outdated Show resolved Hide resolved
nautobot/extras/models/roles.py Show resolved Hide resolved
nautobot/extras/models/statuses.py Outdated Show resolved Hide resolved
glennmatthews
glennmatthews requested changes Jan 3, 2023
View reviewed changes
nautobot/circuits/templates/circuits/circuit_retrieve.html Outdated Show resolved Hide resolved
nautobot/core/fields.py Outdated Show resolved Hide resolved
nautobot/core/models/name_color_content_types.py Outdated Show resolved Hide resolved
nautobot/docs/installation/upgrading-from-nautobot-v1.md Show resolved Hide resolved
nautobot/docs/installation/upgrading-from-nautobot-v1.md Show resolved Hide resolved
nautobot/extras/migrations/0056_alter_configcontext_roles.py Outdated Show resolved Hide resolved
nautobot/extras/querysets.py Outdated Show resolved Hide resolved
nautobot/extras/tests/test_filters.py Outdated Show resolved Hide resolved
nautobot/ipam/factory.py Show resolved Hide resolved
nautobot/ipam/views.py Show resolved Hide resolved
@timizuoebideri1
rename render_related_name_and_color to hyperlinked_object_with_color
ecca191
@timizuoebideri1
remove set_defaults in ForeignKeyLimitedByContentTypes move logic to …
38c75bb 
…__init__
@timizuoebideri1
update documentation
3b48b20
@timizuoebideri1
move LimitQuerysetChoicesSerializerMixin to core/api/mixins
336a263
@timizuoebideri1
add has_role to Factories,
0415dd6
@timizuoebideri1
doc update
1cf3b46
@timizuoebideri1
Account for config context and also add m2m field data migration
c5296ee
@timizuoebideri1
fix flake8
d413266
@timizuoebideri1
add missing functionality
83ec658
@timizuoebideri1
add missing functionality refactor
7f3b6f6
@timizuoebideri1
fix markdown lint
582935e
@timizuoebideri1
role filter done
09094d9
@timizuoebideri1
add config context test
3133893
@timizuoebideri1
Merge remote-tracking branch 'origin/next' into role-model-defenition
0c6cd21 
# Conflicts:
#	nautobot/docs/installation/upgrading-from-nautobot-v1.md
#	nautobot/extras/tests/test_jobs.py
@timizuoebideri1
reorder migration
6ed791b
@timizuoebideri1
All Unit test passing
73da615
@timizuoebideri1
markdownlint
6c601c4
glennmatthews
glennmatthews reviewed Jan 6, 2023
View reviewed changes
nautobot/docs/development/role-internals.md Show resolved Hide resolved
nautobot/extras/forms/mixins.py Outdated Show resolved Hide resolved
nautobot/docs/installation/upgrading-from-nautobot-v1.md Outdated Show resolved Hide resolved
nautobot/docs/installation/upgrading-from-nautobot-v1.md Outdated Show resolved Hide resolved
nautobot/docs/installation/upgrading-from-nautobot-v1.md Outdated Show resolved Hide resolved
nautobot/extras/templates/extras/role_retrieve.html Outdated Show resolved Hide resolved
nautobot/extras/templates/extras/role_retrieve.html Outdated Show resolved Hide resolved
nautobot/extras/templates/extras/role_retrieve.html Outdated Show resolved Hide resolved
nautobot/extras/templates/extras/role_retrieve.html Outdated Show resolved Hide resolved
nautobot/extras/templates/extras/role_retrieve.html Outdated Show resolved Hide resolved
glennmatthews
glennmatthews approved these changes Jan 6, 2023
View reviewed changes
Copy link
Contributor

@glennmatthews glennmatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix the integration tests and I think this is otherwise ready to go!

@glennmatthews glennmatthews merged commit 1a09645 into next Jan 10, 2023
@glennmatthews glennmatthews mentioned this pull request Jan 10, 2023
Closed
@gsnider2195 gsnider2195 mentioned this pull request Jan 31, 2023
Merged
2 tasks
@bryanculver bryanculver deleted the role-model-defenition branch February 14, 2023 14:38
@glennmatthews glennmatthews mentioned this pull request Feb 22, 2023
Merged
8 tasks
@glennmatthews glennmatthews mentioned this pull request Apr 18, 2023
Merged
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glennmatthews glennmatthews glennmatthews approved these changes

@jathanism jathanism Awaiting requested review from jathanism

@gsnider2195 gsnider2195 Awaiting requested review from gsnider2195

@bryanculver bryanculver Awaiting requested review from bryanculver

@HanlinMiao HanlinMiao Awaiting requested review from HanlinMiao

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add a generic Role model
6 participants
@timizuoebideri1 @bryanculver @glennmatthews @jathanism @HanlinMiao @gsnider2195