feat: add terraform provider template #41
Conversation
The RenderTemplate function in the generator has been refactored for clarity and maintainability. Functions to handle each step of template processing (i.e., processing the template and writing data to the file) were extracted. These changes improve the separation of concerns and should make future modifications easier.
# Conflicts: # cmd/codegen/config.yaml # pkg/properties/normalized.go
Add logic to copy assets only related to the current run
A new Makefile has been added to run build, test SDK, and clean commands. Meanwhile, the go.sum dependencies have been updated, removing some unused dependencies and adding new ones. This should streamline build and test processes, while keeping the dependencies aligned with the project requirements.
Updated the way imports are managed in the "pkg/imports/manager.go" and "pkg/translate/imports.go" files, switching to a v2 manager that handles import types more effectively. Also implemented a new Terraform provider template and enhanced the go.mod file to require additional necessary dependencies. Some other minor code adjustments were made across various files for better alignment with the new implementation.
Various configuration changes have been made to improve the functioning of the Terraform provider. The configuration file `cmd/codegen/config.yaml` has been updated with several new entries and adjustments, and an erroneous import has been removed from `pkg/translate/imports.go`. Several new script files and GitHub workflow files have been added to the `assets/tf_provider/scripts` and `assets/tf_provider/.github/workflows` directories, respectively, to automate tasks like error checking, code formatting, and building. Additionally, several documentation updates have been made, focusing primarily on providing examples and descriptions for the Terraform provider.
The source paths in `config.yaml` were updated to reflect the changed structure of the project. All files from the assets directory and its subdirectories have been moved to the SDK subdirectory to maintain organization and to centralize all necessary files.
Refactored 'Managerv2' to 'ImportManager' in 'pkg/imports', and updated corresponding tests. Added new tests for 'File', 'CopyAssets' and 'Unmarshal'. Also deleted 'tools.go' and modified 'provider.tmpl' to loop over provided specs rather than defining fixed data sources and resources.
Revised the code in generator.go by adding a filter to specifically check and continue processing only if the entry name matches specification name in 'exclusive' mode. This change allows the generator to correctly identify and work with the relevant template files, by ignoring unnecessary or unmatched ones.
… statements Updated the generator.go package to import additional translation and generation functions. Also, removed all debug print statements from the code.
# Conflicts: # pkg/translate/imports.go
The RenderImports function has been updated to accept an array of template types. This allows multiple templates to be processed in a single call, simplifying processing whilst retaining existing functionality. This change impacts the addTemplateImports function too, which now loops over each template type input.
pimielowski
changed the title
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "panos_tfid Data Source - panos" | ||
| subcategory: "" |
There was a problem hiding this comment.
This will probably need a subcategory, tho I don't know what it should be at this point...
Just keep it in mind, we'll need to set this subcategory to something that makes sense for users before the provider is released.
Additionally I may need to update this as I'm working on the uuid-style resource, so I'm not sure that the data source or the docs are in a final state right now.
There was a problem hiding this comment.
So, this isn't really going to be a static file... The version of literally everything in the require block is not set in stone, especially the pango version, which will probably increment in the process of generating the SDK + provider. Some more thought will have to go into how this file is created.
There was a problem hiding this comment.
Let's leave it now, we don't have to take care of it now. ultimately for MVP we can place latest as a version and remove the sum file.
There was a problem hiding this comment.
Same goes for this: this is certainly not a static file.
There was a problem hiding this comment.
For MVP we can remove it and regenerate through go mod tidy if we have time we will figure it out.
| terraform_provider_path: | ||
| - 'internal' | ||
| - 'provider' |
There was a problem hiding this comment.
So, this is an interesting situation.
If you're making the provider path configurable, then this means that when ./internal/provider/provider.go imports and makes various data sources and resources available to the user to use, then those NewFooBarResource, lines could end up needing to be thelib.NewFooBarResource, instead...
If you're wanting to have that flexibility to be able to have subdirectories in the provider, then it's going to take more work when generating provider.go.
The alternative is that you always default the provider path and don't let it be configurable.
There was a problem hiding this comment.
It was easiest implementation of the where this path should be created -> https://github.com/PaloAltoNetworks/pan-os-codegen/pull/41/files#diff-e48568539bcd76ff7386b82112418449f557df819113f9db8b7e0eb90bc613f2R94
I think I can hardcode the path for the resources like this:
var tfProviderPath string
if len(c.Spec.TerraformProviderPath) > 0 {
tfProviderPath = filepath.Join(c.Spec.TerraformProviderPath...)
} else {
tfProviderPath = filepath.Join([]string{"internal", "provider"}...)
}And return it in the createFullFilePath function as a part of the filepath.
I understand that if we change this path it could break stuff, maybe in the future we will need that and we need to figure it out how to handle this stuff, but right now I have no time to refactor this to handle custom path, so we can talk about it today how to address it.
@shinmog |
Several scripts and GitHub action workflows related to the Terraform Provider repository have been deleted. Changes have also been made to the generator code to improve file path generation for different types of output files. Release workflow script has been updated to use more recent versions and improve repository content permissions.
The tf_provider_scripts section was removed from the cmd/codegen/config.yaml file. This adjustment is required due to a re-structuring of the project, where certain scripts are no longer needed for the Terraform provider.
The code changes remove the 'exclusive' field from spec files and the related logic in the codebase. Instead, custom templates support has been added. This update enables developers to use a custom template for a specific resource rather than being restricted to exclusive resources. The changes also include some refactoring and error handling improvements.
|
Ok I add a logic for running code one more time from |
|
|
||
| // CreateResourceList creates a string containing a list of resources or data sources based on the elementType parameter. | ||
| // The function returns the generated list as a string. | ||
| func CreateResourceList(elementType string) string { |
There was a problem hiding this comment.
This isn't what I have been advocating for / against in yesterday's meeting. Going to take this offline to try and communicate this better.
|
The idea here is not to generate 100% of the pango and panos provider repo content. Please remove the inclusion of all the GitHub actions and anything not related to the provider go code itself @pimielowski |
Removed |
|
@migara said we don't go with this. |
Description
Motivation and Context
#52 #51
How Has This Been Tested?
Run local tests
Checklist