Migration to Terraform provider framework #167

Run the following commands: - `go get -u ./...` - `go mod tidy` - `go mod vendor` With this, we also update Go version to 1.21.

- Move `github.com/hashicorp/terraform-plugin-framework` package from indirect dependency to direct dependency - `go get -u ./...` - `go mod tidy` - `go mod vendor`

Currently, the provider doesn't implement any functions. Therefore, these files are removed.

This client will be used by the provider to create, read, update and delete items using either Connect or 1Password CLI. This client is also capable of fetching vault data.

Changes made compared to `onepassword/connectctx/wrapper.go` - NewClient function is now responsible of creating the Connect client with user agent. - Renaming the struct for clarity and cleanliness.

Changes made compared to the code in `internal/onepassword/cli` directory: - New function is renamed to NewClient and implements the initializeCLI function - Enable password generation when updating an item (to be consistent with the Connect client).

This function will return either the Connect or the CLI client.

- Name the struct as OnePasswordProvider - Implement provider schema - Implement provider data model What changed from the previous implementation is that we marked the service account token and connect token as sensitive.

- Load default values from environment variables - Initialize the 1Password client (either Connect or CLI client based on the configuration)

This is used to add validators to schemas (e.g. dependencies between attributes). Some of these will be used by the vault data source.

With the vault data source fully implemented, we add it to the list of data sources the provider supports.

Changes made here as part of the migration: - Add a new constant `terraformItemIDDescription` which will be used for both item resource and data source for consistency. - The slices of categories, field purposes, and field types are now based on the constants available in the Connect Go SDK to eliminate hardcoding the string values (these apply to both Connect and CLI clients).

These new ones are used by the item resource schema.

With the new framework, Terraform wants to be more predictable, therefore any computed values will be recomputed whenever something in the resource changes. What this modifier does is that it will use the existing value in the state unless one of the following two scenarios happen: - The value is set to a specific new one in the plan. - The password recipe (which was used to generate it) is changed.

This converts an item into a data source model. It’s a rewrite of the same function that exists in the old provider code. A couple of improvements have been added as part of the migration: - No longer throw cause Terraform to trigger a change or an inconsistency error if the tags are the same, but in different order. This is because 1Password sorts the tags alphabetically, which can have a different order than the one tags passed in Terraform have. - With the new framework, Terraform will throw an inconsistency error if the planned value is null (i.e. not set) and the result is empty string). That's why we use the custom `setStringValue` function to set a value on each attribute based on the actual value in 1Password.

This converts the Terraform data into a 1Password item. It's a rewrite of the same function that exists in the old provider code. We also implemented the functions associated to it: - parseGeneratorRecipe - currently missing the case in which the attribute is not defined (or Nil) - addRecipe - identical to the one in the old provider code

This function extracts the vault and item UUIDs from the terraform ID. This matches the function with the same name from the old provider code.

Implement configure, create, read, update and delete functions for item resource

These will help with the following: - easily generate the items that we will use for testing. - have a mock server that will act as a Connect server during the tests. Co-authored-by: jillianwilson <jillian.morgan@agilebits.com>

Co-authored-by: jillianwilson <jillian.morgan@agilebits.com>

This came as part of the scaffolding. We remove it since the 1Password Terraform provider is under the MIT license.

- Add make command for running acceptance tests. - Update conditional compilation for tools package. Since Go 1.18 the new conditional compilation is `//go:build` instead of `// + build`. - Add terraform-registry-manifest.json file. This file is part of the new framework structure. It's used by the terraform registry to get additional data about the provider being published. For details check this link: https://developer.hashicorp.com/terraform/registry/providers/publishing#terraform-registry-manifest-file - Update goreleaser to use the registry manifest file

Update the docs based on the migrated provider and add small improvements to existing examples.

We also do the following adjustments: - Update Go version in the pipeline to 1.21. - Run the test step with TF_ACC=1 to enable acceptance tests (which are the ones we implemented in the migration). - Switch the `paultyng/ghaction-import-gpg@v2.1.0` action to `crazy-max/ghaction-import-gpg@v6` since the previous one is deprecated and it was recommended to use the upstream action that we now use.

Field of type OTP require a special field ID. Adding this validator achieves the following: - Ensures that the user will have a functional OTP field. - Terraform will not throw inconsistency errors when the CLI tries to correct the custom ID for OTP field.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migration to Terraform provider framework #167

Migration to Terraform provider framework #167

Commits on May 2, 2024