Serialize Workflow Job Template inventories by natural key - related #7798 #7805
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
|
Build succeeded.
|
…nsible#7798 This changeset introduces two changes: 1. Update the API representation of Workflow Job Templates to use the natural key of the Inventory type instead of its id; 2. Override the related property of the CLI's WorkflowJobTemplate page type to patch the related references during the export process, allowing the resource to be serialised using the natural key of the Inventory type instead of the id. Change n.2 is a workaround that is used when exporting resources from AWX/Tower instances that don't have change n.1. It can be removed in the future.
zedr
force-pushed
the
fix-workflow-inventories-by-natural-key
branch
from
ad0c9f1 to
5238d72
Compare
|
Build succeeded.
|
jbradberry
reviewed
Aug 10, 2020
| @@ -3404,6 +3404,12 @@ def get_related(self, obj): | |||
| res['organization'] = self.reverse('api:organization_detail', kwargs={'pk': obj.organization.pk}) | |||
| if obj.webhook_credential_id: | |||
| res['webhook_credential'] = self.reverse('api:credential_detail', kwargs={'pk': obj.webhook_credential_id}) | |||
| if obj.inventory: | |||
jbradberry
reviewed
Aug 10, 2020
| @@ -15,6 +15,27 @@ class WorkflowJobTemplate(HasCopy, HasCreate, HasNotifications, HasSurvey, Unifi | |||
| optional_dependencies = [Organization] | |||
| NATURAL_KEY = ('organization', 'name') | |||
|
|
|||
| @property | |||
| def related(self): | |||
There was a problem hiding this comment.
I'm pretty uncomfortable with doing it this way. However, fortunately, I do note that the inventory field shows up as of type 'id' in the OPTIONS call on the api endpoint even under current devel awx. I think it would be easy enough to check for the case of an id field that fails to show up in related in the _export() method, and attempt to construct the natural key by other means (probably by doing a _filtered_list() call).
There was a problem hiding this comment.
OK. Good suggestion. I'll look into it and push an update if I get something working.
|
I've gone ahead and rebased this branch against the latest devel, and made the change I recommended. The new PR is #8353. |
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.
SUMMARY
Related #7798
This changeset introduces two changes:
natural key of the Inventory type instead of its id;
type to patch the related references during the export process,
allowing the resource to be serialised using the natural key of the
Inventory type instead of the id.
Change n.2 is a workaround that is used when exporting resources from
AWX/Tower instances that don't have change n.1. It can be removed in the
future.
ISSUE TYPE
COMPONENT NAME
AWX VERSION