Finalize before release #146
Merged
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
Summary is now printed including field mappings, the argument was not necessary.
- Added default value to `CustomField.label`.
Custom importer is not necessary anymore as the default integer importer truncates to integer and adds an importer issue.
Added better documentation in the code to be used in docs.
- Renamed `DiffSummary` to `DiffSyncSummary`. - Added `NautobotModelSummary`, `NautobotModelsStats` and `SourceModelStats`. - Moved issues to appropriate `NautobotModelSummary`. - Fixed printing stats based on changes. - Moved first and second pass to separate `SourceModel` methods. - Added more detailed stats calculating.
- Replaced hard-coded summaries in `test_import.py` with stats stored in summaries. - Added `--build-fixtures` argument to `invoke unittest`. - Fixed order of arguments in `self.assertX()`, to pass expected as the first argument. - Replaced dynamic test cases by defined, e.g. `test_3_6()`.
snaselj
requested review from
glennmatthews,
lampwins and
chadell
as code owners
glennmatthews
approved these changes
Feb 27, 2024
docs/dev/generator.md
Outdated
| @@ -46,11 +46,14 @@ This is achieved through `adapter.configure_model(content_type: ContentTypeStr)` | |||
| - `identifiers`: A list of fields identifiable as unique references in the source data. | |||
| - `default_reference`: A `RecordData` dictionary of default values to reference this model. This is useful when the source data does not provide a reference that is required in Nautobot. | |||
| - `extend_content_type`: Define this when a source model extends another source model to merge into a single Nautobot model. | |||
| - `forward_references`: Define to forward references to another content type. This is useful when the source data references a content type that is not directly related to the Nautobot content type. For example, a source data references a `dcim.location` content type, but the Nautobot content type is `dcim.locationtype`. | |||
| - `disable_related_reference`: Define, to disable storing references to this content type from other content types. This is useful for e.g. `ObjectChange` model. | |||
| - `pre_import`: Define a callable to be executed before importing the source data. Can be used to alter or cache the source data before importing. | |||
There was a problem hiding this comment.
Would be good to document:
- the args that the callable should accept
- the fact that it actually gets called twice during the import process
| nautobot = "^2.1.2" | ||
| nautobot = "^2.0.6" |
There was a problem hiding this comment.
Why this change? Why 2.0.6 in particular?
There was a problem hiding this comment.
Reverted the change made by dependabot. 2.0.6 was there before as it was the latest 2.0 version without security issues AFAIK.
There was a problem hiding this comment.
The reason for the revert was that there are more changes to be made to support 2.1.2, and I didn't want to mix it here. Should I update it in a separate PR, or leave it for the release? WDYT @glennmatthews
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.
Closes: NaN
What's Changed
DiffSummarytoDiffSyncSummary.NautobotModelSummary,NautobotModelsStatsandSourceModelStats.NautobotModelSummary.SourceModelmethods and added more detailed stats calculating.unitsfield importer.u_heightfield to use default importer.CustomField.labelfield is empty.CustomField.label.add_issue()instead oflogger.warning()source_field.set_nautobot_value()instead ofsetattr().print_field_mappingsargument.test_import.pywith stats stored in summaries.--build-fixturesargument toinvoke unittestto build fixtures.self.assertX(), to pass expected as the first argument.test_3_6().