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.

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

fix(rate_limiter): persist uri_dictionary_name to state #828

Merged
merged 1 commit into from
Apr 8, 2024
Merged

fix(rate_limiter): persist uri_dictionary_name to state #828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 12 additions & 9 deletions fastly/block_fastly_service_ratelimiter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,15 +494,6 @@ func flattenRateLimiter(remoteState []*gofastly.ERL, _ ServiceMetadata) []map[st
if o.RateLimiterID != nil {
data["ratelimiter_id"] = *o.RateLimiterID
}
if o.ResponseObjectName != nil {
data["response_object_name"] = *o.ResponseObjectName
}
if o.RpsLimit != nil {
data["rps_limit"] = *o.RpsLimit
}
if o.WindowSize != nil {
data["window_size"] = int(*o.WindowSize)
}
if o.Response != nil && o.Response.ERLContent != nil && o.Response.ERLContentType != nil && o.Response.ERLStatus != nil {
data["response"] = []map[string]any{
{
Expand All @@ -512,6 +503,18 @@ func flattenRateLimiter(remoteState []*gofastly.ERL, _ ServiceMetadata) []map[st
},
}
}
if o.ResponseObjectName != nil {
data["response_object_name"] = *o.ResponseObjectName
}
if o.RpsLimit != nil {
data["rps_limit"] = *o.RpsLimit
}
if o.URIDictionaryName != nil {
data["uri_dictionary_name"] = *o.URIDictionaryName
}
if o.WindowSize != nil {
data["window_size"] = int(*o.WindowSize)
}

result = append(result, data)
}
Expand Down
112 changes: 102 additions & 10 deletions fastly/block_fastly_service_ratelimiter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,31 @@ func TestAccFastlyServiceVCLRateLimiter_basic(t *testing.T) {
WindowSize: gofastly.ToPointer(gofastly.ERLSize60),
}

erl1Updated := gofastly.ERL{
Action: gofastly.ToPointer(gofastly.ERLActionResponse),
ClientKey: []*string{
gofastly.ToPointer("req.http.Fastly-Client-IP"),
gofastly.ToPointer("req.http.User-Agent"),
},
FeatureRevision: gofastly.ToPointer(1),
HTTPMethods: []*string{
gofastly.ToPointer("POST"),
gofastly.ToPointer("PUT"),
gofastly.ToPointer("PATCH"),
gofastly.ToPointer("DELETE"),
},
Name: gofastly.ToPointer(rateLimiterName),
PenaltyBoxDuration: gofastly.ToPointer(31),
Response: &gofastly.ERLResponse{
ERLContent: gofastly.ToPointer("example"),
ERLContentType: gofastly.ToPointer("plain/text"),
ERLStatus: gofastly.ToPointer(429),
},
RpsLimit: gofastly.ToPointer(100),
WindowSize: gofastly.ToPointer(gofastly.ERLSize60),
URIDictionaryName: gofastly.ToPointer("rate_limit_endpoints"),
}

erl2 := gofastly.ERL{
Action: gofastly.ToPointer(gofastly.ERLActionResponse),
ClientKey: []*string{
Expand Down Expand Up @@ -151,19 +176,20 @@ func TestAccFastlyServiceVCLRateLimiter_basic(t *testing.T) {
{
Config: testAccServiceVCLRateLimiter(serviceName, domainName, rateLimiterName),
Check: resource.ComposeTestCheckFunc(
testAccCheckServiceExists("fastly_service_vcl.foo", &service),
resource.TestCheckResourceAttr("fastly_service_vcl.foo", "name", serviceName),
resource.TestCheckResourceAttr("fastly_service_vcl.foo", "rate_limiter.#", "1"),
testAccCheckServiceExists("fastly_service_vcl.example", &service),
resource.TestCheckResourceAttr("fastly_service_vcl.example", "name", serviceName),
resource.TestCheckResourceAttr("fastly_service_vcl.example", "rate_limiter.#", "1"),
testAccCheckFastlyServiceVCLRateLimiterAttributes(&service, []*gofastly.ERL{&erl1}),
),
},

{
Config: testAccServiceVCLRateLimiterUpdate(serviceName, domainName, rateLimiterName),
Check: resource.ComposeTestCheckFunc(
testAccCheckServiceExists("fastly_service_vcl.foo", &service),
resource.TestCheckResourceAttr("fastly_service_vcl.foo", "rate_limiter.#", "2"),
testAccCheckFastlyServiceVCLRateLimiterAttributes(&service, []*gofastly.ERL{&erl1, &erl2}),
testAccCheckServiceExists("fastly_service_vcl.example", &service),
testAccCheckRateLimiterURIDictName("fastly_service_vcl.example"),
resource.TestCheckResourceAttr("fastly_service_vcl.example", "rate_limiter.#", "2"),
testAccCheckFastlyServiceVCLRateLimiterAttributes(&service, []*gofastly.ERL{&erl1Updated, &erl2}),
),
},

Expand All @@ -177,14 +203,23 @@ func TestAccFastlyServiceVCLRateLimiter_basic(t *testing.T) {

func testAccServiceVCLRateLimiter(serviceName, domainName, rateLimiterName string) string {
return fmt.Sprintf(`
resource "fastly_service_vcl" "foo" {
variable "mydict" {
type = string
default = "rate_limit_endpoints"
}

resource "fastly_service_vcl" "example" {
name = "%s"

domain {
name = "%s"
comment = "demo"
}

dictionary {
name = var.mydict
}

rate_limiter {
action = "response"
client_key = "req.http.Fastly-Client-IP,req.http.User-Agent"
Expand All @@ -203,25 +238,52 @@ resource "fastly_service_vcl" "foo" {
}

force_destroy = true
}

resource "fastly_service_dictionary_items" "rate_limit_endpoints" {
service_id = fastly_service_vcl.example.id
dictionary_id = { for d in fastly_service_vcl.example.dictionary : d.name => d.dictionary_id }[var.mydict]
items = {
key1: "value1"
key2: "value2"
}
}`, serviceName, domainName, rateLimiterName)
}

// The following config...
//
// Updates:
// - penalty_box_duration (30 -> 31)
//
// Adds:
// - A second rate_limiter
// - uri_dictionary_name (to the first rate_limter).
func testAccServiceVCLRateLimiterUpdate(serviceName, domainName, rateLimiterName string) string {
return fmt.Sprintf(`
resource "fastly_service_vcl" "foo" {
variable "mydict" {
type = string
default = "rate_limit_endpoints"
}

resource "fastly_service_vcl" "example" {
name = "%s"

domain {
name = "%s"
comment = "demo"
}

dictionary {
name = var.mydict
}

rate_limiter {
action = "response"
client_key = "req.http.Fastly-Client-IP,req.http.User-Agent"
http_methods = "POST,PUT,PATCH,DELETE"
name = "%s"
penalty_box_duration = 30
penalty_box_duration = 31
uri_dictionary_name = var.mydict

response {
content = "example"
Expand Down Expand Up @@ -251,6 +313,15 @@ resource "fastly_service_vcl" "foo" {
}

force_destroy = true
}

resource "fastly_service_dictionary_items" "rate_limit_endpoints" {
service_id = fastly_service_vcl.example.id
dictionary_id = { for d in fastly_service_vcl.example.dictionary : d.name => d.dictionary_id }[var.mydict]
items = {
key1: "value1"
key2: "value2"
}
}`, serviceName, domainName, rateLimiterName, rateLimiterName)
}

Expand All @@ -262,7 +333,7 @@ resource "fastly_service_vcl" "foo" {
// The Fastly Terraform provider should return an error when generating the diff.
func testAccServiceVCLMultipleRateLimiters(serviceName, domainName, rateLimiterName string) string {
return fmt.Sprintf(`
resource "fastly_service_vcl" "foo" {
resource "fastly_service_vcl" "example" {
name = "%s"

domain {
Expand Down Expand Up @@ -375,3 +446,24 @@ func testAccCheckFastlyServiceVCLRateLimiterAttributes(service *gofastly.Service
return nil
}
}

// testAccCheckRateLimiterURIDictName validates uri_dictionary_name is set with
// a value after it is defined in the Terraform config.
func testAccCheckRateLimiterURIDictName(vclServiceName string) resource.TestCheckFunc {
return func(s *terraform.State) error {
rs, ok := s.RootModule().Resources[vclServiceName]
if !ok {
return fmt.Errorf("not found: %s", vclServiceName)
}
attrs := rs.Primary.Attributes
a := "rate_limiter.0.uri_dictionary_name"
v, ok := attrs[a]
if !ok {
return fmt.Errorf("failed to lookup %s", a)
}
if v == "" {
return fmt.Errorf("%s is empty", a)
}
return nil
}
}
Loading