Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Cloud Run Locations datasource #4360

Merged
merged 12 commits into from
Jan 13, 2021
Merged
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
Expand Up @@ -10,7 +10,7 @@ resource "google_cloud_run_service" "<%= ctx[:primary_resource_id] %>" {
template {
spec {
containers {
image = "gcr.io/cloudrun/hello"
image = "us-docker.pkg.dev/cloudrun/container/hello"
rileykarson marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ resource "google_cloud_run_service" "<%= ctx[:primary_resource_id] %>" {
template {
spec {
containers {
image = "gcr.io/cloudrun/hello"
image = "us-docker.pkg.dev/cloudrun/container/hello"
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ resource "google_cloud_run_service" "<%= ctx[:primary_resource_id] %>" {
template {
spec {
containers {
image = "gcr.io/cloudrun/hello"
image = "us-docker.pkg.dev/cloudrun/container/hello"
env {
name = "SOURCE"
value = "remote"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ resource "google_cloud_run_service" "<%= ctx[:primary_resource_id] %>" {
template {
spec {
containers {
image = "gcr.io/cloudrun/hello"
image = "us-docker.pkg.dev/cloudrun/container/hello"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion templates/terraform/examples/cloud_run_service_sql.tf.erb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ resource "google_cloud_run_service" "<%= ctx[:primary_resource_id] %>" {
template {
spec {
containers {
image = "gcr.io/cloudrun/hello"
image = "us-docker.pkg.dev/cloudrun/container/hello"
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ resource "google_cloud_run_service" "<%= ctx[:primary_resource_id] %>" {
template {
spec {
containers {
image = "gcr.io/cloudrun/hello"
image = "us-docker.pkg.dev/cloudrun/container/hello"
}
}
metadata {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ resource "google_cloud_run_service" "<%= ctx[:primary_resource_id] %>" {
template {
spec {
containers {
image = "gcr.io/cloudrun/hello"
image = "us-docker.pkg.dev/cloudrun/container/hello"
}
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
package google

import (
"fmt"
"log"
"sort"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)

func dataSourceGoogleCloudRunLocations() *schema.Resource {
return &schema.Resource{
Read: dataSourceGoogleCloudRunLocationsRead,
Schema: map[string]*schema.Schema{
"project": {
Type: schema.TypeString,
Optional: true,
Computed: true,
},
"locations": {
Type: schema.TypeList,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
},
}
}

func dataSourceGoogleCloudRunLocationsRead(d *schema.ResourceData, meta interface{}) error {
config := meta.(*Config)
userAgent, err := generateUserAgentString(d, config.userAgent)
if err != nil {
return err
}

project, err := getProject(d, config)
if err != nil {
return err
}

url, err := replaceVars(d, config, "https://run.googleapis.com/v1/projects/{{project}}/locations")
if err != nil {
return err
}

res, err := sendRequest(config, "GET", project, url, userAgent, nil)
if err != nil {
return fmt.Errorf("Error listing Cloud Run Locations : %s", err)
}

locationsRaw := flattenCloudRunLocations(res)

locations := make([]string, len(locationsRaw))
for i, loc := range locationsRaw {
locations[i] = loc.(string)
}
sort.Strings(locations)

log.Printf("[DEBUG] Received Google Cloud Run Locations: %q", locations)

if err := d.Set("project", project); err != nil {
return fmt.Errorf("Error setting project: %s", err)
}
if err := d.Set("locations", locations); err != nil {
return fmt.Errorf("Error setting location: %s", err)
}

d.SetId(fmt.Sprintf("projects/%s", project))

return nil
}

func flattenCloudRunLocations(resp map[string]interface{}) []interface{} {
regionList := resp["locations"].([]interface{})
regions := make([]interface{}, len(regionList))
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why we don't use strong types here? Locations response struct exists in run/v1 package.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general it's fine either way- for example I want to say the TPU service library didn't exist yet, or we hadn't imported the service library and preferred not to.

for i, v := range regionList {
regionObj := v.(map[string]interface{})
regions[i] = regionObj["locationId"]
}
return regions
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package google

import (
"errors"
"fmt"
"strconv"
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
)

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

vcrTest(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
Config: testAccDataSourceGoogleCloudRunLocationsBasic,
Check: resource.ComposeTestCheckFunc(
testAccCheckGoogleCloudRunLocations("data.google_cloud_run_locations.default"),
),
},
},
})
}

func testAccCheckGoogleCloudRunLocations(n string) resource.TestCheckFunc {
return func(s *terraform.State) error {
rs, ok := s.RootModule().Resources[n]
if !ok {
return fmt.Errorf("Can't find cloud run locations data source: %s", n)
}

if rs.Primary.ID == "" {
return errors.New("data source id not set")
}

count, ok := rs.Primary.Attributes["locations.#"]
if !ok {
return errors.New("can't find 'locations' attribute")
}

cnt, err := strconv.Atoi(count)
if err != nil {
return errors.New("failed to read number of locations")
}
if cnt < 5 {
return fmt.Errorf("expected at least 5 locations, received %d, this is most likely a bug", cnt)
}

for i := 0; i < cnt; i++ {
idx := fmt.Sprintf("locations.%d", i)
_, ok := rs.Primary.Attributes[idx]
if !ok {
return fmt.Errorf("expected %q, location not found", idx)
}
}
return nil
}
}

const testAccDataSourceGoogleCloudRunLocationsBasic = `
data "google_cloud_run_locations" "default" {}
`
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ func testAccCheckGoogleTpuTensorflowVersions(n string) resource.TestCheckFunc {
}

if rs.Primary.ID == "" {
return errors.New("data source ID not set.")
return errors.New("data source id not set")
}

count, ok := rs.Primary.Attributes["versions.#"]
if !ok {
return errors.New("can't find 'names' attribute")
return errors.New("can't find 'versions' attribute")
}

cnt, err := strconv.Atoi(count)
Expand Down
3 changes: 2 additions & 1 deletion third_party/terraform/utils/provider.go.erb
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ func Provider() *schema.Provider {
"google_cloudfunctions_function": dataSourceGoogleCloudFunctionsFunction(),
"google_cloud_identity_groups": dataSourceGoogleCloudIdentityGroups(),
"google_cloud_identity_group_memberships": dataSourceGoogleCloudIdentityGroupMemberships(),
"google_cloud_run_locations": dataSourceGoogleCloudRunLocations(),
"google_cloud_run_service": dataSourceGoogleCloudRunService(),
"google_composer_environment": dataSourceGoogleComposerEnvironment(),
"google_composer_image_versions": dataSourceGoogleComposerImageVersions(),
Expand All @@ -191,7 +192,7 @@ func Provider() *schema.Provider {
"google_compute_default_service_account": dataSourceGoogleComputeDefaultServiceAccount(),
"google_compute_forwarding_rule": dataSourceGoogleComputeForwardingRule(),
"google_compute_global_address": dataSourceGoogleComputeGlobalAddress(),
"google_compute_global_forwarding_rule": dataSourceGoogleComputeGlobalForwardingRule(),
"google_compute_global_forwarding_rule": dataSourceGoogleComputeGlobalForwardingRule(),
"google_compute_image": dataSourceGoogleComputeImage(),
"google_compute_instance": dataSourceGoogleComputeInstance(),
"google_compute_instance_serial_port": dataSourceGoogleComputeInstanceSerialPort(),
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
subcategory: "Cloud Run"
layout: "google"
page_title: "Google: google_cloud_run_locations"
sidebar_current: "docs-google-datasource-cloud-run-locations"
description: |-
Get Cloud Run locations available for a project.
---

# google\_cloud\_run\_locations

Get Cloud Run locations available for a project.

To get more information about Cloud Run, see:

* [API documentation](https://cloud.google.com/run/docs/reference/rest/v1/projects.locations)
* How-to Guides
* [Official Documentation](https://cloud.google.com/run/docs/)

## Example Usage

```hcl
data "google_cloud_run_locations" "available" {
}
```

## Example Usage: Multi-regional Cloud Run deployment

```hcl
data "google_cloud_run_locations" "available" {
}

resource "google_cloud_run_service" "service_one" {
name = "service-one"
location = data.google_cloud_run_locations.available.locations[0]

template {
spec {
containers {
image = "us-docker.pkg.dev/cloudrun/container/hello"
}
}
}
traffic {
percent = 100
latest_revision = true
}
}

resource "google_cloud_run_service" "service_two" {
name = "service-two"
location = data.google_cloud_run_locations.available.locations[1]

template {
spec {
containers {
image = "us-docker.pkg.dev/cloudrun/container/hello""
}
}
}
traffic {
percent = 100
latest_revision = true
}
}
```

## Argument Reference

The following arguments are supported:

* `project` - (Optional) The project to list versions for. If it
is not provided, the provider project is used.

## Attributes Reference

The following attributes are exported:

* `locations` - The list of Cloud Run locations available for the given project.