Merge pull request #44155 from tabito-hara/f-aws_opensearch_package-add_engine_version_argument

[Enhancement] aws_opensearch_package: Add `engine_version` argument and waiter to ensure package validation completes

Author: ewbankkit

.changelog/44155.txt

@@ -0,0 +1,7 @@
+```release-note:enhancement
+resource/aws_opensearch_package: Add `engine_version` argument
+```
+
+```release-note:enhancement
+resource/aws_opensearch_package: Add waiter to ensure package validation completes
+```

internal/service/opensearch/package.go

@@ -5,8 +5,11 @@ package opensearch
 
 import (
 	"context"
+	"fmt"
 	"log"
+	"time"
 
+	"github.com/YakDriver/regexache"
 	"github.com/aws/aws-sdk-go-v2/aws"
 	"github.com/aws/aws-sdk-go-v2/service/opensearch"
 	awstypes "github.com/aws/aws-sdk-go-v2/service/opensearch/types"
@@ -39,6 +42,12 @@ func resourcePackage() *schema.Resource {
 				Type:     schema.TypeString,
 				Computed: true,
 			},
+			names.AttrEngineVersion: {
+				Type:         schema.TypeString,
+				Optional:     true,
+				ForceNew:     true,
+				ValidateFunc: validation.StringMatch(regexache.MustCompile(`^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$`), "must be in the format 'Elasticsearch_X.Y' or 'OpenSearch_X.Y'"),
+			},
 			"package_description": {
 				Type:     schema.TypeString,
 				Optional: true,
@@ -94,6 +103,10 @@ func resourcePackageCreate(ctx context.Context, d *schema.ResourceData, meta any
 		PackageType:        awstypes.PackageType(d.Get("package_type").(string)),
 	}
 
+	if v, ok := d.GetOk(names.AttrEngineVersion); ok {
+		input.EngineVersion = aws.String(v.(string))
+	}
+
 	if v, ok := d.GetOk("package_source"); ok {
 		input.PackageSource = expandPackageSource(v.([]any)[0].(map[string]any))
 	}
@@ -106,6 +119,9 @@ func resourcePackageCreate(ctx context.Context, d *schema.ResourceData, meta any
 
 	d.SetId(aws.ToString(output.PackageDetails.PackageID))
 
+	if _, err := waitPackageValidationCompleted(ctx, conn, d.Id()); err != nil {
+		return sdkdiag.AppendErrorf(diags, "waiting for package validation (%s) completed: %s", d.Id(), err)
+	}
 	return append(diags, resourcePackageRead(ctx, d, meta)...)
 }
 
@@ -126,6 +142,7 @@ func resourcePackageRead(ctx context.Context, d *schema.ResourceData, meta any)
 	}
 
 	d.Set("available_package_version", pkg.AvailablePackageVersion)
+	d.Set(names.AttrEngineVersion, pkg.EngineVersion)
 	d.Set("package_description", pkg.PackageDescription)
 	d.Set("package_id", pkg.PackageID)
 	d.Set("package_name", pkg.PackageName)
@@ -230,3 +247,46 @@ func expandPackageSource(v any) *awstypes.PackageSource {
 		S3Key:        aws.String(v.(map[string]any)["s3_key"].(string)),
 	}
 }
+
+func waitPackageValidationCompleted(ctx context.Context, conn *opensearch.Client, id string) (*opensearch.DescribePackagesOutput, error) {
+	stateConf := &retry.StateChangeConf{
+		Pending:    []string{"COPYING", "VALIDATING"},
+		Target:     []string{"AVAILABLE"},
+		Refresh:    statusPackageValidation(ctx, conn, id),
+		Timeout:    20 * time.Minute,
+		MinTimeout: 15 * time.Second,
+		Delay:      30 * time.Second,
+	}
+
+	outputRaw, err := stateConf.WaitForStateContext(ctx)
+
+	if output, ok := outputRaw.(*opensearch.DescribePackagesOutput); ok {
+		return output, err
+	}
+
+	return nil, err
+}
+
+func statusPackageValidation(ctx context.Context, conn *opensearch.Client, id string) retry.StateRefreshFunc {
+	return func() (any, string, error) {
+		output, err := findPackageByID(ctx, conn, id)
+
+		if tfresource.NotFound(err) {
+			return nil, "", nil
+		}
+
+		if err != nil {
+			return nil, "", err
+		}
+
+		if output == nil {
+			return nil, "", nil
+		}
+
+		if output.ErrorDetails != nil {
+			return nil, string(output.PackageStatus), fmt.Errorf("package validation failed: %s, %s, %s", string(output.PackageStatus), aws.ToString(output.ErrorDetails.ErrorType), aws.ToString(output.ErrorDetails.ErrorMessage))
+		}
+
+		return output, string(output.PackageStatus), nil
+	}
+}

internal/service/opensearch/package_test.go

@@ -8,6 +8,8 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/YakDriver/regexache"
+	awstypes "github.com/aws/aws-sdk-go-v2/service/opensearch/types"
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-plugin-testing/terraform"
 	"github.com/hashicorp/terraform-provider-aws/internal/acctest"
@@ -32,12 +34,12 @@ func TestAccOpenSearchPackage_basic(t *testing.T) {
 				Config: testAccPackageConfig_basic(pkgName),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					testAccCheckPackageExists(ctx, resourceName),
-					resource.TestCheckResourceAttr(resourceName, "available_package_version", ""),
+					resource.TestCheckResourceAttr(resourceName, "available_package_version", "v1"),
 					resource.TestCheckResourceAttr(resourceName, "package_description", ""),
 					resource.TestCheckResourceAttrSet(resourceName, "package_id"),
 					resource.TestCheckResourceAttr(resourceName, "package_name", pkgName),
 					resource.TestCheckResourceAttr(resourceName, "package_source.#", "1"),
-					resource.TestCheckResourceAttr(resourceName, "package_type", "TXT-DICTIONARY"),
+					resource.TestCheckResourceAttr(resourceName, "package_type", string(awstypes.PackageTypeTxtDictionary)),
 				),
 			},
 			{
@@ -53,6 +55,48 @@ func TestAccOpenSearchPackage_basic(t *testing.T) {
 	})
 }
 
+func TestAccOpenSearchPackage_packageTypeZipPlugin(t *testing.T) {
+	ctx := acctest.Context(t)
+	pkgName := testAccRandomDomainName()
+	resourceName := "aws_opensearch_package.test"
+
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.PreCheck(ctx, t) },
+		ErrorCheck:               acctest.ErrorCheck(t, names.OpenSearchServiceID),
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
+		CheckDestroy:             testAccCheckPackageDestroy(ctx),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccPackageConfig_packageTypeZipPlugin(pkgName, "OpenSearch_2.17"),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testAccCheckPackageExists(ctx, resourceName),
+					resource.TestCheckResourceAttr(resourceName, "available_package_version", "v1"),
+					resource.TestCheckResourceAttr(resourceName, names.AttrEngineVersion, "OpenSearch_2.17"),
+					resource.TestCheckResourceAttr(resourceName, "package_description", ""),
+					resource.TestCheckResourceAttrSet(resourceName, "package_id"),
+					resource.TestCheckResourceAttr(resourceName, "package_name", pkgName),
+					resource.TestCheckResourceAttr(resourceName, "package_source.#", "1"),
+					resource.TestCheckResourceAttr(resourceName, "package_type", string(awstypes.PackageTypeZipPlugin)),
+				),
+			},
+			{
+				ResourceName:      resourceName,
+				ImportState:       true,
+				ImportStateVerify: true,
+				ImportStateVerifyIgnore: []string{
+					"available_package_version",
+					"package_source", // This isn't returned by the API
+				},
+			},
+			{
+				// If engin_version is different from specified in the plugin zip file, it should return an error
+				Config:      testAccPackageConfig_packageTypeZipPlugin(pkgName, "OpenSearch_2.11"),
+				ExpectError: regexache.MustCompile(`doesn't matches with the provided EngineVersion`),
+			},
+		},
+	})
+}
+
 func TestAccOpenSearchPackage_disappears(t *testing.T) {
 	ctx := acctest.Context(t)
 	pkgName := testAccRandomDomainName()
@@ -140,3 +184,35 @@ resource "aws_opensearch_package" "test" {
 }
 `, rName)
 }
+
+func testAccPackageConfig_packageTypeZipPlugin(rName, engineVersion string) string {
+	return fmt.Sprintf(`
+resource "aws_s3_bucket" "test" {
+  bucket = %[1]q
+}
+
+
+# example-opensearch-plugin.zip was created from the sample repository provided by AWS using the following commands:
+# > git clone https://github.com/aws-samples/kr-tech-blog-sample-code.git
+# > cd kr-tech-blog-sample-code/opensearch_custom_plugin
+# > gradele build
+# > cp build/distributions/opensearch-custom-plugin-1.0.0.zip terraform-provider-aws/internal/service/opensearch/test-fixtures/example-opensearch-plugin.zip
+
+resource "aws_s3_object" "test" {
+  bucket = aws_s3_bucket.test.bucket
+  key    = %[1]q
+  source = "./test-fixtures/example-opensearch-plugin.zip"
+  etag   = filemd5("./test-fixtures/example-opensearch-plugin.zip")
+}
+
+resource "aws_opensearch_package" "test" {
+  engine_version = %[2]q
+  package_name   = %[1]q
+  package_source {
+    s3_bucket_name = aws_s3_bucket.test.bucket
+    s3_key         = aws_s3_object.test.key
+  }
+  package_type = "ZIP-PLUGIN"
+}
+`, rName, engineVersion)
+}

internal/service/opensearch/test-fixtures/example-opensearch-plugin.zip

@@ -41,8 +41,9 @@ resource "aws_opensearch_package" "example" {
 This resource supports the following arguments:
 
 * `region` - (Optional) Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
+* `engine_version` - (Optional, Forces new resources) Engine version that the package is compatible with. This argument is required and only valid when `package_type` is `ZIP-PLUGIN`. Format: `OpenSearch_X.Y` or `Elasticsearch_X.Y`, where `X` and `Y` are the major and minor version numbers, respectively.
 * `package_name` - (Required, Forces new resource) Unique name for the package.
-* `package_type` - (Required, Forces new resource) The type of package.
+* `package_type` - (Required, Forces new resource) The type of package. Valid values are `TXT-DICTIONARY`, `ZIP-PLUGIN`, `PACKAGE-LICENSE` and `PACKAGE-CONFIG`.
 * `package_source` - (Required, Forces new resource) Configuration block for the package source options.
 * `package_description` - (Optional, Forces new resource) Description of the package.