-
Notifications
You must be signed in to change notification settings - Fork 9.2k
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
New Resource: aws_api_gateway_vpc_link #2512
Changes from 7 commits
64134dd
93bf79d
0bbcedc
1b40524
19ab262
70a6355
d18c6bf
c91d313
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,204 @@ | ||
package aws | ||
|
||
import ( | ||
"fmt" | ||
"log" | ||
"time" | ||
|
||
"github.com/aws/aws-sdk-go/aws" | ||
"github.com/aws/aws-sdk-go/service/apigateway" | ||
"github.com/hashicorp/terraform/helper/resource" | ||
"github.com/hashicorp/terraform/helper/schema" | ||
) | ||
|
||
func resourceAwsApiGatewayVpcLink() *schema.Resource { | ||
return &schema.Resource{ | ||
Create: resourceAwsApiGatewayVpcLinkCreate, | ||
Read: resourceAwsApiGatewayVpcLinkRead, | ||
Update: resourceAwsApiGatewayVpcLinkUpdate, | ||
Delete: resourceAwsApiGatewayVpcLinkDelete, | ||
|
||
Schema: map[string]*schema.Schema{ | ||
"name": { | ||
Type: schema.TypeString, | ||
Required: true, | ||
}, | ||
"description": { | ||
Type: schema.TypeString, | ||
Optional: true, | ||
}, | ||
"target_arns": { | ||
Type: schema.TypeSet, | ||
Required: true, | ||
ForceNew: true, | ||
Elem: &schema.Schema{Type: schema.TypeString}, | ||
}, | ||
}, | ||
} | ||
} | ||
|
||
func resourceAwsApiGatewayVpcLinkCreate(d *schema.ResourceData, meta interface{}) error { | ||
conn := meta.(*AWSClient).apigateway | ||
|
||
input := &apigateway.CreateVpcLinkInput{ | ||
Name: aws.String(d.Get("name").(string)), | ||
TargetArns: expandStringList(d.Get("target_arns").(*schema.Set).List()), | ||
} | ||
if v, ok := d.GetOk("description"); ok { | ||
input.Description = aws.String(v.(string)) | ||
} | ||
|
||
resp, err := conn.CreateVpcLink(input) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
d.SetId(*resp.Id) | ||
|
||
stateConf := &resource.StateChangeConf{ | ||
Pending: []string{apigateway.VpcLinkStatusPending}, | ||
Target: []string{apigateway.VpcLinkStatusAvailable}, | ||
Refresh: apigatewayVpcLinkRefreshStatusFunc(conn, *resp.Id), | ||
Timeout: 8 * time.Minute, | ||
MinTimeout: 3 * time.Second, | ||
} | ||
|
||
_, err = stateConf.WaitForState() | ||
if err != nil { | ||
d.SetId("") | ||
return fmt.Errorf("[WARN] Error waiting for APIGateway Vpc Link status to be \"%s\": %s", apigateway.VpcLinkStatusAvailable, err) | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func resourceAwsApiGatewayVpcLinkRead(d *schema.ResourceData, meta interface{}) error { | ||
conn := meta.(*AWSClient).apigateway | ||
|
||
input := &apigateway.GetVpcLinkInput{ | ||
VpcLinkId: aws.String(d.Id()), | ||
} | ||
|
||
resp, err := conn.GetVpcLink(input) | ||
if err != nil { | ||
if isAWSErr(err, apigateway.ErrCodeNotFoundException, "") { | ||
log.Printf("[WARN] VPC Link %s not found, removing from state", d.Id()) | ||
d.SetId("") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nitpick: Do you mind adding our usual |
||
return nil | ||
} | ||
return err | ||
} | ||
|
||
d.Set("name", resp.Name) | ||
d.Set("description", resp.Description) | ||
d.Set("target_arn", flattenStringList(resp.TargetArns)) | ||
return nil | ||
} | ||
|
||
func resourceAwsApiGatewayVpcLinkUpdate(d *schema.ResourceData, meta interface{}) error { | ||
conn := meta.(*AWSClient).apigateway | ||
|
||
operations := make([]*apigateway.PatchOperation, 0) | ||
|
||
if d.HasChange("name") { | ||
operations = append(operations, &apigateway.PatchOperation{ | ||
Op: aws.String("replace"), | ||
Path: aws.String("/name"), | ||
Value: aws.String(d.Get("name").(string)), | ||
}) | ||
} | ||
|
||
if d.HasChange("description") { | ||
operations = append(operations, &apigateway.PatchOperation{ | ||
Op: aws.String("replace"), | ||
Path: aws.String("/description"), | ||
Value: aws.String(d.Get("description").(string)), | ||
}) | ||
} | ||
|
||
input := &apigateway.UpdateVpcLinkInput{ | ||
VpcLinkId: aws.String(d.Id()), | ||
PatchOperations: operations, | ||
} | ||
|
||
_, err := conn.UpdateVpcLink(input) | ||
if err != nil { | ||
if isAWSErr(err, apigateway.ErrCodeNotFoundException, "") { | ||
log.Printf("[WARN] VPC Link %s not found, removing from state", d.Id()) | ||
d.SetId("") | ||
return nil | ||
} | ||
return err | ||
} | ||
|
||
stateConf := &resource.StateChangeConf{ | ||
Pending: []string{apigateway.VpcLinkStatusPending}, | ||
Target: []string{apigateway.VpcLinkStatusAvailable}, | ||
Refresh: apigatewayVpcLinkRefreshStatusFunc(conn, d.Id()), | ||
Timeout: 8 * time.Minute, | ||
MinTimeout: 3 * time.Second, | ||
} | ||
|
||
_, err = stateConf.WaitForState() | ||
if err != nil { | ||
return fmt.Errorf("[WARN] Error waiting for APIGateway Vpc Link status to be \"%s\": %s", apigateway.VpcLinkStatusAvailable, err) | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func resourceAwsApiGatewayVpcLinkDelete(d *schema.ResourceData, meta interface{}) error { | ||
conn := meta.(*AWSClient).apigateway | ||
|
||
input := &apigateway.DeleteVpcLinkInput{ | ||
VpcLinkId: aws.String(d.Id()), | ||
} | ||
|
||
_, err := conn.DeleteVpcLink(input) | ||
if err != nil { | ||
if isAWSErr(err, apigateway.ErrCodeNotFoundException, "") { | ||
return nil | ||
} | ||
return err | ||
} | ||
|
||
stateConf := resource.StateChangeConf{ | ||
Pending: []string{apigateway.VpcLinkStatusPending, | ||
apigateway.VpcLinkStatusAvailable, | ||
apigateway.VpcLinkStatusDeleting}, | ||
Target: []string{""}, | ||
Timeout: 5 * time.Minute, | ||
MinTimeout: 1 * time.Second, | ||
Refresh: func() (interface{}, string, error) { | ||
resp, err := conn.GetVpcLink(&apigateway.GetVpcLinkInput{ | ||
VpcLinkId: aws.String(d.Id()), | ||
}) | ||
if err != nil { | ||
if isAWSErr(err, apigateway.ErrCodeNotFoundException, "") { | ||
return 1, "", nil | ||
} | ||
return nil, "failed", err | ||
} | ||
return resp, *resp.Status, nil | ||
}, | ||
} | ||
|
||
if _, err := stateConf.WaitForState(); err != nil { | ||
return err | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func apigatewayVpcLinkRefreshStatusFunc(conn *apigateway.APIGateway, vl string) resource.StateRefreshFunc { | ||
return func() (interface{}, string, error) { | ||
input := &apigateway.GetVpcLinkInput{ | ||
VpcLinkId: aws.String(vl), | ||
} | ||
resp, err := conn.GetVpcLink(input) | ||
if err != nil { | ||
return nil, "failed", err | ||
} | ||
return resp, *resp.Status, nil | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
package aws | ||
|
||
import ( | ||
"fmt" | ||
"testing" | ||
|
||
"github.com/aws/aws-sdk-go/aws" | ||
"github.com/aws/aws-sdk-go/service/apigateway" | ||
"github.com/hashicorp/terraform/helper/acctest" | ||
"github.com/hashicorp/terraform/helper/resource" | ||
"github.com/hashicorp/terraform/terraform" | ||
) | ||
|
||
func TestAccAwsAPIGatewayVpcLink_basic(t *testing.T) { | ||
rName := acctest.RandString(5) | ||
resource.Test(t, resource.TestCase{ | ||
PreCheck: func() { testAccPreCheck(t) }, | ||
Providers: testAccProviders, | ||
CheckDestroy: testAccCheckAwsAPIGatewayVpcLinkDestroy, | ||
Steps: []resource.TestStep{ | ||
{ | ||
Config: testAccAPIGatewayVpcLinkConfig(rName), | ||
Check: resource.ComposeTestCheckFunc( | ||
testAccCheckAwsAPIGatewayVpcLinkExists("aws_api_gateway_vpc_link.test"), | ||
resource.TestCheckResourceAttr("aws_api_gateway_vpc_link.test", "name", fmt.Sprintf("tf-apigateway-%s", rName)), | ||
resource.TestCheckResourceAttr("aws_api_gateway_vpc_link.test", "description", "test"), | ||
resource.TestCheckResourceAttr("aws_api_gateway_vpc_link.test", "target_arns.#", "2"), | ||
), | ||
}, | ||
{ | ||
Config: testAccAPIGatewayVpcLinkConfig_Update(rName), | ||
Check: resource.ComposeTestCheckFunc( | ||
testAccCheckAwsAPIGatewayVpcLinkExists("aws_api_gateway_vpc_link.test"), | ||
resource.TestCheckResourceAttr("aws_api_gateway_vpc_link.test", "name", fmt.Sprintf("tf-apigateway-update-%s", rName)), | ||
resource.TestCheckResourceAttr("aws_api_gateway_vpc_link.test", "description", "test update"), | ||
resource.TestCheckResourceAttr("aws_api_gateway_vpc_link.test", "target_arns.#", "2"), | ||
), | ||
}, | ||
}, | ||
}) | ||
} | ||
|
||
func testAccCheckAwsAPIGatewayVpcLinkDestroy(s *terraform.State) error { | ||
conn := testAccProvider.Meta().(*AWSClient).apigateway | ||
|
||
for _, rs := range s.RootModule().Resources { | ||
if rs.Type != "aws_api_gateway_vpc_link" { | ||
continue | ||
} | ||
|
||
input := &apigateway.GetVpcLinkInput{ | ||
VpcLinkId: aws.String(rs.Primary.ID), | ||
} | ||
|
||
_, err := conn.GetVpcLink(input) | ||
if err != nil { | ||
if isAWSErr(err, apigateway.ErrCodeNotFoundException, "") { | ||
return nil | ||
} | ||
return err | ||
} | ||
|
||
return fmt.Errorf("Expected VPC Link to be destroyed, %s found", rs.Primary.ID) | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func testAccCheckAwsAPIGatewayVpcLinkExists(name string) resource.TestCheckFunc { | ||
return func(s *terraform.State) error { | ||
rs, ok := s.RootModule().Resources[name] | ||
if !ok { | ||
return fmt.Errorf("Not found: %s", name) | ||
} | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you mind checking the API here also? |
||
conn := testAccProvider.Meta().(*AWSClient).apigateway | ||
|
||
input := &apigateway.GetVpcLinkInput{ | ||
VpcLinkId: aws.String(rs.Primary.ID), | ||
} | ||
|
||
_, err := conn.GetVpcLink(input) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
return nil | ||
} | ||
} | ||
|
||
func testAccAPIGatewayVpcLinkConfig_basis(rName string) string { | ||
return fmt.Sprintf(` | ||
resource "aws_lb" "test_a" { | ||
name = "tf-lb-%s" | ||
internal = true | ||
load_balancer_type = "network" | ||
subnets = ["${aws_subnet.test.id}"] | ||
} | ||
|
||
resource "aws_lb" "test_b" { | ||
name = "tf-lb-%s" | ||
internal = true | ||
load_balancer_type = "network" | ||
subnets = ["${aws_subnet.test.id}"] | ||
} | ||
|
||
resource "aws_vpc" "test" { | ||
cidr_block = "10.10.0.0/16" | ||
} | ||
|
||
data "aws_availability_zones" "test" {} | ||
|
||
resource "aws_subnet" "test" { | ||
vpc_id = "${aws_vpc.test.id}" | ||
cidr_block = "10.10.0.0/21" | ||
availability_zone = "${data.aws_availability_zones.test.names[0]}" | ||
} | ||
`, rName, rName) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The main reason the test is failing the way it's failing is because two resources ( There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Once you fix that you get more reasonable error which I think we can just present to the user:
As you rightly mentioned Amazon currently doesn't support more than 1 LB though, so we'll have to keep this test focused on single LB only. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's right! Thank you for correct. |
||
} | ||
|
||
func testAccAPIGatewayVpcLinkConfig(rName string) string { | ||
return testAccAPIGatewayVpcLinkConfig_basis(rName) + fmt.Sprintf(` | ||
resource "aws_api_gateway_vpc_link" "test" { | ||
name = "tf-apigateway-%s" | ||
description = "test" | ||
target_arns = ["${aws_lb.test_a.arn}","${aws_lb.test_b.arn}"] | ||
} | ||
`, rName) | ||
} | ||
|
||
func testAccAPIGatewayVpcLinkConfig_Update(rName string) string { | ||
return testAccAPIGatewayVpcLinkConfig_basis(rName) + fmt.Sprintf(` | ||
resource "aws_api_gateway_vpc_link" "test" { | ||
name = "tf-apigateway-update-%s" | ||
description = "test update" | ||
target_arns = ["${aws_lb.test_a.arn}","${aws_lb.test_b.arn}"] | ||
} | ||
`, rName) | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should also add a test with an actual API Gateway and a HTTP endpoint, so that we ensure it's all ok. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sorry, I couldn't understand what you meant so cloud you describe more details:bow: ? @Ninir There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I guess what @Ninir means is that we should add a test which tests the full setup including API Gateway integration leveraging the VPC Link. It seems we'd also need to update other API Gateway resources to make that happen, namely to add few more attributes to I'm personally ok with shipping this resource as is and addressing the above in a separate PR to keep diffs small and easier to review - what do you think @Ninir ? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any particular reason this should be implemented as 1-1 relationship instead of reflecting the API, i.e. allowing users to assign multiple LBs to one VPC link?