Test and officially bless generic views for use by plugins #474
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added a `README.md` and a `pyproject.toml` for it - Added it as a dev dependency to nautobot's root `pyproject.toml` - Asserted that unit tests ran: ``` Creating test database for alias 'default'... System check identified no issues (0 silenced). ..................... ---------------------------------------------------------------------- Ran 21 tests in 0.134s OK Destroying test database for alias 'default'... ```
- Added URLs and everything - Added a detail view template - Added tables, filters, forms, search, changelog
| verbose_name = "Dummy plugin" | ||
| version = "0.0" | ||
| description = "For testing purposes only" | ||
| base_url = "dummy-plugin" | ||
| min_version = "0.9" | ||
| max_version = "9.0" | ||
| middleware = ["nautobot.extras.tests.dummy_plugin.middleware.DummyMiddleware"] | ||
| middleware = ["dummy_plugin.middleware.DummyMiddleware"] | ||
| installed_apps = ["nautobot.extras.tests.dummy_plugin_dependency"] |
There was a problem hiding this comment.
Is the installed_app going to get moved to examples as well?
There was a problem hiding this comment.
I am on the fence about the dummy dependency moving.
- Add a version string to the plugin - Added a `to_csv()` method to `DummyModel`
- Updated plugin code quite a bit to use correct bases for API serializers/views to get all tests passing - Changed base of API `DummyModelViewSet` to use `nautobot.core.api.views.ModelViewSet` - Changed base of API `DummyModelSerializer` to use `nautobot.core.api.serializers.ValidatedModelSerializer` - Added `url` field to API `DummyModelSerializer` - Switched API urls to use `nautobot.core.api.OrderedDefaultRouter` to get bulk update/delete working correctly. - Updated Invoke tasks to also run black/flake8 on `examples/` - Added a `poetry.lock` file for `dummy_plugin`
jathanism
changed the title
examples/dummy_plugin/dummy_plugin/templates/dummy_plugin/dummymodel.html
Outdated
Show resolved
Hide resolved
examples/dummy_plugin/dummy_plugin/templates/dummy_plugin/dummymodel.html
Show resolved
Hide resolved
- Got rid of relative imports just for the sake of clarity and consistency - Made sure that bulk edit/delete UI operations are properly tested. - Added a nested API serializer
glennmatthews
approved these changes
May 24, 2021
I think it would make sense to include such documentation along side the plugin development docs maybe? |
This was referenced May 25, 2021
glennmatthews
added a commit
that referenced
this pull request
May 25, 2021
glennmatthews
added a commit
that referenced
this pull request
May 25, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #14
Moved
dummy_plugintoexamples/dummy_pluginat project rootREADME.mdand apyproject.tomlfor itpyproject.tomlto_csv()method toDummyModelDummyModelViewSetto usenautobot.core.api.views.ModelViewSetDummyModelSerializerto usenautobot.core.api.serializers.ValidatedModelSerializerurlfield to APIDummyModelSerializernautobot.core.api.OrderedDefaultRouterto get bulk update/delete working correctly.examples/poetry.lockfile fordummy_plugin