Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 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,152 @@
// Copyright (c) IBM Corp. 2014, 2026
// SPDX-License-Identifier: MPL-2.0

package storage

import (
"context"
"errors"
"fmt"

"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"

"google.golang.org/api/storage/v1"

"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_storage_bucket",
ProductName: "storage",
Func: NewGoogleStorageBucketListResource,
}.Register()
}


type GoogleStorageBucketListResource struct {
tpgresource.ListResourceMetadata
}

type GoogleStorageBucketListModel struct {
Project types.String `tfsdk:"project"`
}

func NewGoogleStorageBucketListResource() list.ListResource {
listR := &GoogleStorageBucketListResource{}
listR.TypeName = "google_storage_bucket"
listR.SDKv2Resource = ResourceStorageBucket()
listR.ListConfigFields = []tpgresource.ListConfigField{
{Name: "project", Kind: tpgresource.ListConfigKindString, Optional: true},
}
return listR
}

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

var data GoogleStorageBucketListModel
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)

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

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

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

func flattenStorageBucketListItem(res map[string]interface{}, d *schema.ResourceData, config *transport_tpg.Config) error {
var bucket storage.Bucket
if err := tpgresource.Convert(res, &bucket); err != nil {
return fmt.Errorf("error converting storage bucket list response: %w", err)
}
if bucket.Name == "" {
return fmt.Errorf("missing name in storage bucket list response")
}
if err := d.Set("name", bucket.Name); err != nil {
return err
}
userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)
if err != nil {
return err
}
return setStorageBucket(d, config, &bucket, bucket.Name, userAgent)
}

func ListStorageBuckets(config *transport_tpg.Config, project string, callback func(rd *schema.ResourceData) error) error {
if config == nil {
return fmt.Errorf("provider client is not configured")
}
d := ResourceStorageBucket().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)
}
}
url, err := tpgresource.ReplaceVars(d, config, "{{"{{"}}StorageBasePath{{"}}"}}b?project={{"{{"}}project{{"}}"}}")
if err != nil {
return err
}

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

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

return transport_tpg.ListPages(transport_tpg.ListPagesOptions{
Config: config,
TempData: d,
Resource: ResourceStorageBucket(),
ListURL: url,
BillingProject: billingProject,
UserAgent: userAgent,
Flattener: flattenStorageBucketListItem,
Callback: callback,
})
}



Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
// Copyright (c) IBM Corp. 2014, 2026
// SPDX-License-Identifier: MPL-2.0

package storage_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/querycheck/queryfilter"
"github.com/hashicorp/terraform-plugin-testing/tfjsonpath"
"github.com/hashicorp/terraform-plugin-testing/tfversion"

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

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

project := envvar.GetTestProjectFromEnv()
bucketName := "tf-test-" + 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: testAccStorageBucketBasic(bucketName, project),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("google_storage_bucket.test", "project", project),
resource.TestCheckResourceAttr("google_storage_bucket.test", "name", bucketName),
),
},
{
Query: true,
Config: testAccStorageBucketListQuery(project, true),
QueryResultChecks: []querycheck.QueryResultCheck{
querycheck.ExpectIdentity("google_storage_bucket.all_in_project", map[string]knownvalue.Check{
"name": knownvalue.StringExact(bucketName),
"project": knownvalue.StringExact(project),
}),
querycheck.ExpectLengthAtLeast("google_storage_bucket.all_in_project", 1),
querycheck.ExpectResourceKnownValues(
"google_storage_bucket.all_in_project",
queryfilter.ByDisplayName(knownvalue.StringExact(bucketName)),
[]querycheck.KnownValueCheck{
{
Path: tfjsonpath.New("name"),
KnownValue: knownvalue.StringExact(bucketName),
},
{
Path: tfjsonpath.New("project"),
KnownValue: knownvalue.StringExact(project),
},
{
Path: tfjsonpath.New("location"),
KnownValue: knownvalue.StringExact("US"),
},
},
),
},
},
},
})
}

func testAccStorageBucketBasic(name, project string) string {
return fmt.Sprintf(`
resource "google_storage_bucket" "test" {
name = %q
location = "US"
project = %q
}
`, name, project)
}

func testAccStorageBucketListQuery(project string, includeResource bool) string {
includeResourceBlock := ""
if includeResource {
includeResourceBlock = " include_resource = true"
}

return fmt.Sprintf(`
provider "google" {}

list "google_storage_bucket" "all_in_project" {
provider = google
%s
limit = 1000

config {
project = %q
}
}
`, includeResourceBlock, project)
}
Comment thread
tavasyag marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,22 @@ func ResourceStorageBucket() *schema.Resource {
tpgresource.DefaultProviderDeletionPolicy("DELETE"),
),

Identity: &schema.ResourceIdentity{
Version: 1,
SchemaFunc: func() map[string]*schema.Schema {
return map[string]*schema.Schema{
"project": {
Type: schema.TypeString,
OptionalForImport: true,
},
"name": {
Type: schema.TypeString,
RequiredForImport: true,
},
}
},
},

Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(10 * time.Minute),
Update: schema.DefaultTimeout(4 * time.Minute),
Expand Down Expand Up @@ -1365,6 +1381,35 @@ func resourceStorageBucketDelete(d *schema.ResourceData, meta interface{}) error
}

func resourceStorageBucketStateImporter(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
if d.Id() == "" {
identity, err := d.Identity()
if err != nil {
return nil, fmt.Errorf("Error reading import identity: %s", err)
}
if identity == nil {
return nil, fmt.Errorf("import requires bucket name")
}

nameValue, ok := identity.GetOk("name")
if !ok || nameValue.(string) == "" {
return nil, fmt.Errorf("import requires bucket name")
}

name := nameValue.(string)
if err := d.Set("name", name); err != nil {
return nil, fmt.Errorf("Error setting name: %s", err)
}

if projectValue, ok := identity.GetOk("project"); ok && projectValue.(string) != "" {
if err := d.Set("project", projectValue.(string)); err != nil {
return nil, fmt.Errorf("Error setting project: %s", err)
}
d.SetId(fmt.Sprintf("%s/%s", projectValue.(string), name))
} else {
d.SetId(name)
}
}

// We need to support project/bucket_name and bucket_name formats. This will allow
// importing a bucket that is in a different project than the provider default.
// ParseImportID can't be used because having no project will cause an error but it
Expand Down Expand Up @@ -2459,12 +2504,24 @@ func setStorageBucket(d *schema.ResourceData, config *transport_tpg.Config, res
if err := tpgresource.SetLabels(res.Labels, d, "labels"); err != nil {
return fmt.Errorf("Error setting labels: %s", err)
}
if err := tpgresource.SetLabels(res.Labels, d, "terraform_labels"); err != nil {
return fmt.Errorf("Error setting terraform_labels: %s", err)
}
if err := d.Set("effective_labels", res.Labels); err != nil {
return fmt.Errorf("Error setting labels: %s", err)
}
terraformLabels := make(map[string]string)
for key, value := range config.DefaultLabels {
terraformLabels[key] = value
}
if config.AddTerraformAttributionLabel {
if _, ok := res.Labels[transport_tpg.AttributionKey]; ok {
terraformLabels[transport_tpg.AttributionKey] = transport_tpg.AttributionValue
}
}
for key, value := range d.Get("labels").(map[string]interface{}) {
terraformLabels[key] = value.(string)
}
if err := d.Set("terraform_labels", terraformLabels); err != nil {
return fmt.Errorf("Error setting terraform_labels: %s", err)
}
Comment thread
tavasyag marked this conversation as resolved.
Outdated
if err := d.Set("website", flattenBucketWebsite(res.Website)); err != nil {
return fmt.Errorf("Error setting website: %s", err)
}
Expand Down Expand Up @@ -2529,7 +2586,11 @@ func setStorageBucket(d *schema.ResourceData, config *transport_tpg.Config, res


d.SetId(res.Id)
return nil

return tpgresource.SetResourceIdentityAttributes(d, map[string]interface{}{
"name": res.Name,
"project": d.Get("project").(string),
})
Comment thread
tavasyag marked this conversation as resolved.
}

func hierachicalNamespaceDiffSuppress(k, old, new string, r *schema.ResourceData) bool {
Expand Down
Loading
Loading