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.

Sign up for GitHub

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

Jump to bottom

add new data source aws_api_gateway_rest_api #4172

Merged

bflad merged 3 commits into hashicorp:master from timborrowdale:master

Apr 12, 2018

Contributor

timborrowdale commented Apr 11, 2018

make testacc TEST=./aws TESTARGS='-run=TestAccDataSourceAwsApiGatewayRestApi'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -run=TestAccDataSourceAwsApiGatewayRestApi -timeout 120m
=== RUN   TestAccDataSourceAwsApiGatewayRestApi
--- PASS: TestAccDataSourceAwsApiGatewayRestApi (28.58s)
PASS
ok      github.com/terraform-providers/terraform-provider-aws/aws       29.862s

I've had issues trying to get the terraform-website project working to check the docs locally - I think they're ok but would be good if someone could check.


          add new data source aws_api_gateway_rest_api

25d1777

ghost added the size/L label

bflad added new-data-source service/apigateway labels

bflad reviewed

View reviewed changes

Contributor

bflad left a comment

Hi @timborrowdale 👋 Thanks for this contribution. I left some initial comments below. Can you please take a look and let me know if you have any questions?

aws/data_source_aws_api_gateway_rest_api.go Outdated

+              				Type:     schema.TypeString,
+              				Required: true,
+              			},
+              			"id": {

Contributor

bflad Apr 11, 2018

id does not need to be declared as a schema attribute 👍

aws/data_source_aws_api_gateway_rest_api.go Outdated

+              				matchedApis = append(matchedApis, api)
+              			}
+              		}
+              		return true

Contributor

bflad Apr 11, 2018

Should use return !lastPage here

aws/data_source_aws_api_gateway_rest_api.go Outdated

+              	log.Printf("[DEBUG] Reading API Gateway REST APIs: %s", params)
+              	err := conn.GetRestApisPages(params, func(page *apigateway.GetRestApisOutput, lastPage bool) bool {
+              		for _, api := range page.Items {
+              			if *api.Name == target {

Contributor

bflad Apr 11, 2018

To prevent a potential crash, we should wrap this with aws.StringValue(api.Name) in the unlikely scenario that its returned as nil

aws/data_source_aws_api_gateway_rest_api.go Outdated

+              		return true
+              	})
+              	if err != nil {
+              		return errwrap.Wrapf("error describing API Gateway REST APIs: {{err}}", err)

Contributor

bflad Apr 11, 2018

We do not need the context of the error when returning a message back to the user here. We can use the simpler fmt.Errorf("error describing API Gateway REST APIs: %s", err) here 👍

aws/data_source_aws_api_gateway_rest_api.go Outdated


		d.SetId(*match.Id)

		if err = dataSourceAwsApiGatewayRestApiRefreshResources(d, meta); err != nil {

Contributor

bflad Apr 11, 2018

We do not need the extra function here, its contents can be included in the read function 👍

aws/data_source_aws_api_gateway_rest_api_test.go Outdated

+              }
+              const testAccDataSourceAwsApiGatewayRestApiConfig = `
+              provider "aws" {

Contributor

bflad Apr 11, 2018

We do not need to declare the provider block in the testing framework, it defaults to us-west-2 if not provided via AWS_DEFAULT_REGION

aws/data_source_aws_api_gateway_rest_api_test.go Outdated

+              }
+              resource "aws_api_gateway_rest_api" "tf_test" {
+                name        = "tf_test"

Contributor

bflad Apr 11, 2018

These should have randomized names to prevent hitting the multiple match error condition after test panics/AWS failures. Usually we achieve this by wrapping the test configuration in fmt.Sprintf() and passing a randomized name from the test function, e.g. rName := acctest.StringWithPrefix("tf_acc_test_")

bflad added the waiting-response label


          refactor d/aws_api_gateway_rest_api and it's test after code review

9d5bd75

ghost added the size/L label


          add missing Sprintf arguments to d/aws_api_gateway_rest_api test

9dcff38

Contributor Author

timborrowdale commented Apr 12, 2018

@bflad Thanks for the feedback - I've had a go at addressing those issues.

bflad removed the waiting-response label

bflad added this to the v1.15.0 milestone

bflad approved these changes

View reviewed changes

Contributor

bflad left a comment

Awesome job, LGTM! 🚀

1 test passed (all tests)
=== RUN   TestAccDataSourceAwsApiGatewayRestApi
--- PASS: TestAccDataSourceAwsApiGatewayRestApi (8.06s)

bflad merged commit 3c05780 into hashicorp:master

bflad added a commit that referenced this pull request


          Update CHANGELOG for #4172

3aa1372

Contributor

bflad commented Apr 18, 2018

This has been released in version 1.15.0 of the AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

ghost commented Apr 6, 2020

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

ghost locked and limited conversation to collaborators

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.