Merge pull request #566 from labd/565-currently-the-resource-commercetools_tax_category_rate-does-not-support-a-key

feat: added tax category rate key

Author: demeyerthom

.changes/unreleased/Fixed-20250214-100041.yaml

@@ -0,0 +1,3 @@
+kind: Fixed
+body: Added tax category rate key
+time: 2025-02-14T10:00:41.057277942+01:00

commercetools/resource_tax_category.go

@@ -24,7 +24,7 @@ func resourceTaxCategory() *schema.Resource {
 		},
 		Schema: map[string]*schema.Schema{
 			"key": {
-				Description: "User-specific unique identifier for the category",
+				Description: "User-specific unique identifier for the tax category",
 				Type:        schema.TypeString,
 				Optional:    true,
 			},

commercetools/resource_tax_category_rate.go

@@ -29,6 +29,11 @@ func resourceTaxCategoryRate() *schema.Resource {
 				Type:     schema.TypeString,
 				Required: true,
 			},
+			"key": {
+				Description: "User-specific unique identifier for the tax category rate",
+				Type:        schema.TypeString,
+				Optional:    true,
+			},
 			"name": {
 				Type:     schema.TypeString,
 				Required: true,
@@ -185,6 +190,7 @@ func resourceTaxCategoryRateRead(ctx context.Context, d *schema.ResourceData, m
 }
 
 func setTaxRateState(d *schema.ResourceData, taxRate *platform.TaxRate) {
+	_ = d.Set("key", taxRate.Key)
 	_ = d.Set("name", taxRate.Name)
 	_ = d.Set("amount", taxRate.Amount)
 	_ = d.Set("included_in_price", taxRate.IncludedInPrice)
@@ -223,7 +229,7 @@ func resourceTaxCategoryRateUpdate(ctx context.Context, d *schema.ResourceData,
 		Actions: []platform.TaxCategoryUpdateAction{},
 	}
 
-	if d.HasChange("name") || d.HasChange("amount") || d.HasChange("included_in_price") || d.HasChange("country") || d.HasChange("state") || d.HasChange("sub_rate") {
+	if d.HasChange("key") || d.HasChange("name") || d.HasChange("amount") || d.HasChange("included_in_price") || d.HasChange("country") || d.HasChange("state") || d.HasChange("sub_rate") {
 		taxRateDraft, err := createTaxRateDraft(d)
 		if err != nil {
 			// Workaround invalid state to be written, see
@@ -282,6 +288,11 @@ func createTaxRateDraft(d *schema.ResourceData) (*platform.TaxRateDraft, error)
 		}
 	}
 
+	var key *string
+	if value, ok := d.Get("key").(string); ok && value != "" {
+		key = &value
+	}
+
 	var countryCode string
 	if value, ok := d.Get("country").(string); ok {
 		countryCode = value
@@ -290,6 +301,7 @@ func createTaxRateDraft(d *schema.ResourceData) (*platform.TaxRateDraft, error)
 	amountRaw := d.Get("amount").(float64)
 
 	taxRateDraft := platform.TaxRateDraft{
+		Key:             key,
 		Name:            d.Get("name").(string),
 		Amount:          &amountRaw,
 		IncludedInPrice: d.Get("included_in_price").(bool),

commercetools/resource_tax_category_rate_test.go

@@ -23,37 +23,40 @@ func TestAccTaxCategoryRate_createAndUpdateWithID(t *testing.T) {
 		CheckDestroy:      testAccCheckTaxCategoryRateDestroy,
 		Steps: []resource.TestStep{
 			{
-				Config: testAccTaxCategoryRateConfig(name, amount, true, country),
+				Config: testAccTaxCategoryRateConfig(name, amount, true, country, ""),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr(resourceName, "name", name),
 					resource.TestCheckResourceAttr(resourceName, "amount", "0.2"),
 					resource.TestCheckResourceAttr(resourceName, "included_in_price", "true"),
 					resource.TestCheckResourceAttr(resourceName, "country", country),
+					resource.TestCheckResourceAttr(resourceName, "key", ""),
 				),
 			},
 			{
-				Config: testAccTaxCategoryRateConfig(name, amount, false, country),
+				Config: testAccTaxCategoryRateConfig(name, amount, false, country, "some-key"),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr(resourceName, "name", name),
 					resource.TestCheckResourceAttr(resourceName, "amount", "0.2"),
 					resource.TestCheckResourceAttr(resourceName, "included_in_price", "false"),
 					resource.TestCheckResourceAttr(resourceName, "country", country),
+					resource.TestCheckResourceAttr(resourceName, "key", "some-key"),
 				),
 			},
 			{
-				Config: testAccTaxCategoryRateConfig(name, 0.0, true, country),
+				Config: testAccTaxCategoryRateConfig(name, 0.0, true, country, ""),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr(resourceName, "name", name),
 					resource.TestCheckResourceAttr(resourceName, "amount", "0"),
 					resource.TestCheckResourceAttr(resourceName, "included_in_price", "true"),
 					resource.TestCheckResourceAttr(resourceName, "country", country),
+					resource.TestCheckResourceAttr(resourceName, "key", ""),
 				),
 			},
 		},
 	})
 }
 
-func testAccTaxCategoryRateConfig(name string, amount float64, includedInPrice bool, country string) string {
+func testAccTaxCategoryRateConfig(name string, amount float64, includedInPrice bool, country, key string) string {
 	return hclTemplate(`
 		resource "commercetools_tax_category" "standard" {
 			key = "test-rate-category"
@@ -64,6 +67,10 @@ func testAccTaxCategoryRateConfig(name string, amount float64, includedInPrice b
 		resource "commercetools_tax_category_rate" "test_rate" {
 			tax_category_id = commercetools_tax_category.standard.id
 
+			{{if .key }}
+			key = "{{ .key }}"
+			{{end}}
+
 			name = "{{ .name }}"
 			amount = {{ .amount }}
 			included_in_price = {{ .includedInPrice }}
@@ -75,6 +82,7 @@ func testAccTaxCategoryRateConfig(name string, amount float64, includedInPrice b
 			"amount":          amount,
 			"includedInPrice": includedInPrice,
 			"country":         country,
+			"key":             key,
 		})
 }
 

docs/resources/tax_category.md

@@ -33,7 +33,7 @@ resource "commercetools_tax_category" "my-tax-category" {
 ### Optional
 
 - `description` (String)
-- `key` (String) User-specific unique identifier for the category
+- `key` (String) User-specific unique identifier for the tax category
 
 ### Read-Only
 

docs/resources/tax_category_rate.md

@@ -17,11 +17,13 @@ See also [Tax Rate API Documentation](https://docs.commercetools.com/api/project
 
 ```terraform
 resource "commercetools_tax_category" "my-tax-category" {
+  key         = "my-tax-category"
   name        = "Standard tax category"
   description = "Example category"
 }
 
 resource "commercetools_tax_category_rate" "standard-tax-category-DE" {
+  key               = "standard-tax-category-DE"
   tax_category_id   = commercetools_tax_category.my-tax-category.id
   name              = "19% MwSt"
   amount            = 0.19
@@ -34,6 +36,7 @@ resource "commercetools_tax_category_rate" "standard-tax-category-DE" {
 }
 
 resource "commercetools_tax_category_rate" "standard-tax-category-NL" {
+  key               = "standard-tax-category-NL"
   tax_category_id   = commercetools_tax_category.my-tax-category.id
   name              = "21% BTW"
   amount            = 0.21
@@ -55,6 +58,7 @@ resource "commercetools_tax_category_rate" "standard-tax-category-NL" {
 ### Optional
 
 - `amount` (Number) Number Percentage in the range of [0..1]. The sum of the amounts of all subRates, if there are any
+- `key` (String) User-specific unique identifier for the tax category rate
 - `state` (String) The state in the country
 - `sub_rate` (Block List) For countries (for example the US) where the total tax is a combination of multiple taxes (for example state and local taxes) (see [below for nested schema](#nestedblock--sub_rate))
 

examples/resources/commercetools_tax_category_rate/resource.tf

@@ -1,9 +1,11 @@
 resource "commercetools_tax_category" "my-tax-category" {
+  key         = "my-tax-category"
   name        = "Standard tax category"
   description = "Example category"
 }
 
 resource "commercetools_tax_category_rate" "standard-tax-category-DE" {
+  key               = "standard-tax-category-DE"
   tax_category_id   = commercetools_tax_category.my-tax-category.id
   name              = "19% MwSt"
   amount            = 0.19
@@ -16,6 +18,7 @@ resource "commercetools_tax_category_rate" "standard-tax-category-DE" {
 }
 
 resource "commercetools_tax_category_rate" "standard-tax-category-NL" {
+  key               = "standard-tax-category-NL"
   tax_category_id   = commercetools_tax_category.my-tax-category.id
   name              = "21% BTW"
   amount            = 0.21