Add job templates TF resource (+data res) with API calls #138
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
Adds the Foreman "job templates" objects to the provider. Use "foreman_jobtemplate" as a (data) resource to manage the templates in Foreman. Tested with Foreman v3.6 TODO: Handle inputs; example .tf file Signed-off-by: Dominik Pataky <[email protected]>
Handling the nested template inputs in the new job templates is difficult in the current state of the provider. In earlier implementation, the compute profiles did the same, by utilising JSON marshalling and unmarshalling. I'm trying new ways, so this commit is a WIP snapshot. Signed-off-by: Dominik Pataky <[email protected]>
After different approaches to handle the nested template input resources/objecs, I switched back to JSON marshalling of the struct. With this, the creation and destruction of job_template Terraform resources now work. Signed-off-by: Dominik Pataky <[email protected]>
Uses the existing JSON unmarshaling logic from other structs to handle the conversion of differnent value types. Signed-off-by: Dominik Pataky <[email protected]>
Signed-off-by: Dominik Pataky <[email protected]>
|
In this PR I followed a different implementation than the one used for compute_profiles and their compute_attributes. The job_templates in this PR contain template_inputs, which are their own Terraform resource themselves. The nested structure made it pretty difficult to get the parsing right but this implementation allows defining the template inputs in the Commit caa12e2 was tested for creating, modifying and destroying a job_template with multiple template_inputs. |
Tested with an existing job_template in Foreman, successfully imported. Signed-off-by: Dominik Pataky <[email protected]>
Signed-off-by: Dominik Pataky <[email protected]>
Since the value_type value is not returned from the Foreman API, the provider cannot read the value of existing template inputs. This commit therefore introduces two things: 1. Use omitempty to skip the field when parsing to JSON, removing errors during updates (Foreman rejects the request because value_type cannot be an empty string) 2. Use a diff suppression function if value_type is read as empty string, but the default is "plain" and so the provider thinks there's an update to do. Signed-off-by: Dominik Pataky <[email protected]>
The template inputs are a list inside the job_templates objects. After creating the resources through the Foreman API, reading the job_template might result in a different order of template_inputs. This causes Terraform to think there was a change. This commit introduces a sort function which keeps the template_inputs in order, according to their unique ID. Signed-off-by: Dominik Pataky <[email protected]>
Signed-off-by: Dominik Pataky <[email protected]>
…urce Signed-off-by: Dominik Pataky <[email protected]>
lhw
reviewed
Dec 13, 2023
lhw
reviewed
Dec 13, 2023
The testdata was missing two fields in the query response: template and locked. These are not returned in the upstream Foreman API when the query is used. They are only contained in the detailed GET request for a specific resource at /api/job_templates/<ID>. This complicates the tests and therefore the testdata now returns the fields as well, otherwise a refactoring to split single_query and read would be needed. Signed-off-by: Dominik Pataky <[email protected]>
Adds remaining test cases and functions for job_templates. Signed-off-by: Dominik Pataky <[email protected]>
commit 875b6b7 Author: Dominik Pataky <[email protected]> Date: Mon Dec 18 08:20:04 2023 +0000 Fixes for Katello repositories and sync_plans (terraform-coop#143) * (cherry pick) katello_product: fix product data source query by adding orgId As seen in https://apidocs.theforeman.org/katello/latest/apidoc/v2/products.html, the organization_id is a required parameter for the GET endpoint. It is now sent with the name query term. * katello_product: Fix orgID parameter in creation call * katello_repo: fix "label" field due to missing "computed" The "label" field was missing the "computed" attribute, marking it as changed every time if not specified in the .tf file * katello_repo: replace mirror_on_sync by mirroring_policy; marshalJSON "mirror_on_sync" is deprecated and removed from Katello (in 4.9 it seems). It is replaced by "mirroring_policy". This commit also adds a JSON marshaler to katello_repository for better handling of fields and use cases (especially the content_type). * katello_repo: Add DiffSuppression to "download_concurrency" parameter. The "download_concurrency" parameter is not returned from the Katello API, but still exists in the source code of Katello in v4.9. It's unclear what happens with the value, if supplied. But as it is not returned to reflect the Terraform input, TF will always see a change from 0 -> X. Therefore, DiffSuppression captures theses cases. * (cherry pick) Katello product: re-add SSL-related fields * katello_sync_plan: Handle "sync_date" diffs better The "sync_date" field allows passing in a datetime as string. It specifies the first time a sync plan should run. This field requires a specific format to allow Go to parse the value. Use the specified format: YYYY-MM-DD HH:MM:SS +0000, where '+0000' is the timezone difference. A value of '+0000' means UTC. Additionally, the time zone suffix was documented as "UTC". There is now an exception handler for this case, converting "UTC" to "+0000" internally. The diff suppression func in this commit allows using shorter fields like "2023-12-11", which is then parsed to "2023-12-11 00:00:00 +0000". * katello sync_plan: Add ValidateDiagFunc for sync_date value --------- Signed-off-by: Dominik Pataky <[email protected]> Signed-off-by: Dominik Pataky <[email protected]>
Signed-off-by: Dominik Pataky <[email protected]>
They are to be included in an extra branch, see discussion terraform-coop#138 (comment) Signed-off-by: Dominik Pataky <[email protected]>
|
OK, branch is ready for merge. Includes job_templates resource and data source with API wrapper. Tests on provider level were added (meaning, the resource and data source have unit tests). The new util logging functions were removed and will be re-added in a new PR. |
lhw
approved these changes
Dec 18, 2023
bitkeks
added a commit
to mindfulsecurity/terraform-provider-foreman
that referenced
this pull request
Dec 19, 2023
Implements the TraceFunctionCall function in 'utils.go'. All 'log.Tracef()' calls in foreman/api were replaced by the new trace function. Refs terraform-coop#138 terraform-coop#138 (comment) Signed-off-by: Dominik Pataky <[email protected]>
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.
Adds the Foreman "job templates" objects to the provider. Use "foreman_jobtemplate" as a (data) resource to manage the templates in Foreman.
Tested with Foreman v3.6
TODO: Handle inputs; example .tf file