Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
// Copyright (c) IBM Corp. 2014, 2026
// SPDX-License-Identifier: MPL-2.0

package secretmanager

import (
"context"
"errors"
"fmt"
"regexp"

"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/list"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"

"github.com/hashicorp/terraform-provider-google/google/registry"
"github.com/hashicorp/terraform-provider-google/google/tpgresource"
transport_tpg "github.com/hashicorp/terraform-provider-google/google/transport"
)

func init() {
registry.FrameworkListResource{
Name: "google_secret_manager_secret_version",
ProductName: "secretmanager",
Func: NewGoogleSecretManagerSecretVersionListResource,
}.Register()
}

type GoogleSecretManagerSecretVersionListResource struct {
tpgresource.ListResourceMetadata
}

type GoogleSecretManagerSecretVersionListModel struct {
Project types.String `tfsdk:"project"`
Secret types.String `tfsdk:"secret"`
}

func NewGoogleSecretManagerSecretVersionListResource() list.ListResource {
listR := &GoogleSecretManagerSecretVersionListResource{}
listR.TypeName = "google_secret_manager_secret_version"
listR.SDKv2Resource = ResourceSecretManagerSecretVersion()
listR.ListConfigFields = []tpgresource.ListConfigField{
{Name: "project", Kind: tpgresource.ListConfigKindString, Optional: true},
{Name: "secret", Kind: tpgresource.ListConfigKindString, Optional: false},
}
return listR
}

func (listR *GoogleSecretManagerSecretVersionListResource) List(ctx context.Context, listReq list.ListRequest, stream *list.ListResultsStream) {
errStreamClosed := errors.New("stream closed")

var data GoogleSecretManagerSecretVersionListModel
diags := listReq.Config.Get(ctx, &data)
if diags.HasError() {
stream.Results = list.ListResultsStreamDiagnostics(diags)
return
}
if listR.Client == nil {
diags = append(diags, diag.NewErrorDiagnostic(
"Provider not configured",
"The Google provider client is not available; ensure the provider is configured (e.g. credentials and default project).",
))
stream.Results = list.ListResultsStreamDiagnostics(diags)
return
}

project := listR.GetProject(data.Project)
secret := data.Secret.ValueString()

stream.Results = func(push func(list.ListResult) bool) {
err := ListSecretManagerSecretVersions(listR.Client, project, secret, func(rd *schema.ResourceData) error {
result := listReq.NewListResult(ctx)

if err := listR.SetResult(ctx, listReq.IncludeResource, &result, rd, "version"); err != nil {
return err
}

if !push(result) {
return errStreamClosed
}
return nil
})
if err == nil || errors.Is(err, errStreamClosed) {
return
}
diags.AddError("API Error", err.Error())
result := listReq.NewListResult(ctx)
result.Diagnostics = diags
push(result)
}
}

func ListSecretManagerSecretVersions(config *transport_tpg.Config, project, secret string, callback func(*schema.ResourceData) error) error {
if config == nil {
return fmt.Errorf("provider client is not configured")
}

d := ResourceSecretManagerSecretVersion().Data(&terraform.InstanceState{})

if project != "" {
if err := d.Set("project", project); err != nil {
return fmt.Errorf("error setting project on temporary resource data: %w", err)
}
}

// Normalize secret to full resource name
fullSecret := secret
if matched, _ := regexp.MatchString(`^projects/[^/]+/secrets/[^/]+$`, secret); !matched {
fullSecret = fmt.Sprintf("projects/%s/secrets/%s", project, secret)
}
if err := d.Set("secret", fullSecret); err != nil {
return fmt.Errorf("error setting secret on temporary resource data: %w", err)
}

url := fmt.Sprintf("%sprojects/%s/secrets/%s/versions", transport_tpg.BaseUrl(Product, config), project, secret)

billingProject := project
if bp, err := tpgresource.GetBillingProject(d, config); err == nil {
billingProject = bp
}

userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)
if err != nil {
return err
}

secretRegex := regexp.MustCompile(`projects/(.+)/secrets/(.+)/versions/(.+)$`)

return transport_tpg.ListPages(transport_tpg.ListPagesOptions{
Config: config,
TempData: d,
Resource: ResourceSecretManagerSecretVersion(),
ListURL: url,
BillingProject: billingProject,
ItemName: "versions",
UserAgent: userAgent,
Flattener: func(res map[string]interface{}, d *schema.ResourceData, config *transport_tpg.Config) error {
name, ok := res["name"].(string)
if !ok || name == "" {
return fmt.Errorf("missing name in secret version list response")
}

matches := secretRegex.FindStringSubmatch(name)
if matches == nil {
return fmt.Errorf("secret version name %q does not match expected format", name)
}
// matches[1]=project, matches[2]=secret, matches[3]=version
versionProject := matches[1]
versionSecret := matches[2]
versionNum := matches[3]

if err := d.Set("project", versionProject); err != nil {
return err
}
if err := d.Set("secret", fmt.Sprintf("projects/%s/secrets/%s", versionProject, versionSecret)); err != nil {
return err
}
if err := d.Set("version", versionNum); err != nil {
return err
}
if err := d.Set("name", name); err != nil {
return err
}
if err := tpgresource.SetResourceIdentityAttributes(d, map[string]interface{}{
"project": versionProject,
"secret": fmt.Sprintf("projects/%s/secrets/%s", versionProject, versionSecret),
"version": versionNum,
}); err != nil {
return err
}
if state, ok := res["state"].(string); ok {
if err := d.Set("enabled", state == "ENABLED"); err != nil {
return err
}
}

d.SetId(name)
return nil
},
Callback: callback,
})
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
package secretmanager_test

import (
"fmt"
"testing"

"github.com/hashicorp/terraform-plugin-testing/helper/resource"
"github.com/hashicorp/terraform-plugin-testing/knownvalue"
"github.com/hashicorp/terraform-plugin-testing/querycheck"
"github.com/hashicorp/terraform-plugin-testing/tfversion"

"github.com/hashicorp/terraform-provider-google/google/acctest"
"github.com/hashicorp/terraform-provider-google/google/envvar"
_ "github.com/hashicorp/terraform-provider-google/google/services/secretmanager"
)

func TestAccSecretManagerSecretVersionListResource_basic(t *testing.T) {
t.Parallel()

project := envvar.GetTestProjectFromEnv()
secretName := fmt.Sprintf("tf-test-secret-%s", acctest.RandString(t, 10))

acctest.VcrTest(t, resource.TestCase{
TerraformVersionChecks: []tfversion.TerraformVersionCheck{
tfversion.SkipBelow(tfversion.Version1_14_0),
},
PreCheck: func() { acctest.AccTestPreCheck(t) },
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
Steps: []resource.TestStep{
{
Config: testAccSecretManagerSecretVersionListResourceBasic(project, secretName),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("google_secret_manager_secret.test", "secret_id", secretName),
resource.TestCheckResourceAttrSet("google_secret_manager_secret_version.test", "version"),
),
},
{
Query: true,
Config: testAccSecretManagerSecretVersionListResourceQuery(project, secretName),
QueryResultChecks: []querycheck.QueryResultCheck{
querycheck.ExpectLengthAtLeast("google_secret_manager_secret_version.all", 1),
querycheck.ExpectIdentity("google_secret_manager_secret_version.all", map[string]knownvalue.Check{
"project": knownvalue.StringExact(project),
"secret": knownvalue.StringExact(fmt.Sprintf("projects/%s/secrets/%s", project, secretName)),
"version": knownvalue.NotNull(),
}),
},
},
},
})
}

func testAccSecretManagerSecretVersionListResourceBasic(project, secretName string) string {
return fmt.Sprintf(`
resource "google_secret_manager_secret" "test" {
secret_id = %q
project = %q

replication {
auto {}
}
}

resource "google_secret_manager_secret_version" "test" {
secret = google_secret_manager_secret.test.id
secret_data = "my-secret-data"
}
`, secretName, project)
}

func testAccSecretManagerSecretVersionListResourceQuery(project, secretName string) string {
return fmt.Sprintf(`
provider "google" {}

list "google_secret_manager_secret_version" "all" {
provider = google

config {
project = %q
secret = %q
}
}
`, project, secretName)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
subcategory: "Secret Manager"
description: |-
List Secret Manager secret versions for use with terraform query
and .tfquery.hcl files.
---

# google_secret_manager_secret_version (list)

Lists Secret Manager secret versions for use with
[`terraform query`](https://developer.hashicorp.com/terraform/cli/commands/query) and
`.tfquery.hcl` files. Results correspond to existing
[`google_secret_manager_secret_version`](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/secret_manager_secret_version)
managed resources.

For how list resources work in this provider, Terraform version requirements, and shared
`list` block arguments, refer to the guide
[Use list resources with terraform query (Google Cloud provider)](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/using_list_resources_with_terraform_query).

## Example

```hcl
list "google_secret_manager_secret_version" "all" {
provider = google

config {
# Optional. Defaults to the provider project when omitted.
# project = "my-project"
secret = "my-secret"
}
}
```

Run `terraform query` from the directory that contains the `.tfquery.hcl` file.

## Configuration (`config` block)

* `project` - (Optional) Project ID containing the secret. If unset, the provider project is used.

* `secret` - (Required) Secret name or full resource name (`projects/{project}/secrets/{secret}`).

## Results

By default each result includes resource identity for `google_secret_manager_secret_version`:

* `project` - Project ID.

* `secret` - Full secret resource name.

* `version` - Version number.

With `include_resource = true` on the `list` block, results also include the full resource-style
attributes documented for the managed
[`google_secret_manager_secret_version` resource](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/secret_manager_secret_version#attributes-reference).
Loading