Version check for NVMe host

Updating the NVMe host in PowerFlex versions
earlier than 4.6 is not supported

docs/resources/nvme_host.md

@@ -26,6 +26,8 @@ description: |-
 
 This resource is used to manager NVMe host from the PowerFlex array. We can Create, Update and Delete the PowerFlex NVMe host using this resource. We can also import an existing NVMe host from PowerFlex array.
 
+Please note that due to certain limitations, updating the NVMe host in PowerFlex versions earlier than 4.6 is not supported
+
 ## Example Usage
 
 ```terraform
@@ -51,6 +53,7 @@ limitations under the License.
 # To import , check import.sh for more info
 # nqn is the required parameter to create
 # To check which attributes can be updated, please refer Product Guide in the documentation
+# Please note that due to certain limitations, updating the NVMe host in PowerFlex versions earlier than 4.6 is not supported
 
 # Example for adding NVMe host.
 resource "powerflex_nvme_host" "test-nvme-host" {

examples/resources/powerflex_nvme_host/resource.tf

@@ -20,6 +20,7 @@ limitations under the License.
 # To import , check import.sh for more info
 # nqn is the required parameter to create
 # To check which attributes can be updated, please refer Product Guide in the documentation
+# Please note that due to certain limitations, updating the NVMe host in PowerFlex versions earlier than 4.6 is not supported
 
 # Example for adding NVMe host.
 resource "powerflex_nvme_host" "test-nvme-host" {

go.mod

@@ -7,7 +7,7 @@ toolchain go1.23.2
 require (
 	github.com/bramvdbogaerde/go-scp v1.5.0
 	github.com/bytedance/mockey v1.2.13
-	github.com/dell/goscaleio v1.17.1-0.20241106124128-c895c8717b22
+	github.com/dell/goscaleio v1.17.1-0.20241112041929-3499a2af3b98
 	github.com/hashicorp/terraform-plugin-framework v1.11.0
 	github.com/hashicorp/terraform-plugin-framework-validators v0.13.0
 	github.com/hashicorp/terraform-plugin-go v0.23.0
@@ -95,7 +95,7 @@ require (
 	github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect
 	github.com/zclconf/go-cty v1.15.0 // indirect
 	golang.org/x/net v0.25.0 // indirect
-	golang.org/x/sys v0.26.0 // indirect
+	golang.org/x/sys v0.27.0 // indirect
 	golang.org/x/text v0.17.0 // indirect
 	google.golang.org/appengine v1.6.8 // indirect
 	google.golang.org/grpc v1.63.2 // indirect

go.sum

@@ -33,6 +33,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dell/goscaleio v1.17.1-0.20241106124128-c895c8717b22 h1:Ox4ra5FUj1LWL3M1ibMxPCzWLue2yRzYdhSuRsLYEDc=
 github.com/dell/goscaleio v1.17.1-0.20241106124128-c895c8717b22/go.mod h1:dB1a2wXevGps25VAda+6WDp+NTUdgMZXvQVM0YOBpX8=
+github.com/dell/goscaleio v1.17.1-0.20241112041929-3499a2af3b98 h1:MBv+SdBrNADVJIT1XBFgKVWP6BddGOVRpu11iDJQ+oA=
+github.com/dell/goscaleio v1.17.1-0.20241112041929-3499a2af3b98/go.mod h1:OGFdDzRGhiAkXDTyrOUM42mxco5Y/vnhUyw/G7uXDzs=
 github.com/dylanmei/iso8601 v0.1.0 h1:812NGQDBcqquTfH5Yeo7lwR0nzx/cKdsmf3qMjPURUI=
 github.com/dylanmei/iso8601 v0.1.0/go.mod h1:w9KhXSgIyROl1DefbMYIE7UVSIvELTbMrCfx+QkYnoQ=
 github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc=
@@ -280,6 +282,8 @@ golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo=
 golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.27.0 h1:wBqf8DvsY9Y/2P8gAfPDEYNuS30J4lPHJxXSb/nJZ+s=
+golang.org/x/sys v0.27.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=

powerflex/provider/POWERFLEX_TERRAFORM_TEST.env.sample

@@ -31,6 +31,10 @@ POWERFLEX_PROTECTION_DOMAIN_ID_SDS=
 POWERFLEX_STORAGE_POOL_NAME=
 POWERFLEX_SERVICE_ID=
 POWERFLEX_SERVICE_NAME=
+POWERFLEX_NVME_HOST_NAME=
+POWERFLEX_NVME_HOST_NAME_CREATE=
+POWERFLEX_NVME_HOST_NAME_UPDATE=
+POWERFLEX_NVME_HOST_NQN=
 POWERFLEX_NVME_TARGET_NAME=
 POWERFLEX_NVME_TARGET_NAME_CREATE=
 POWERFLEX_NVME_TARGET_NAME_UPDATE=

powerflex/provider/nvme_host_datasource_test.go

@@ -30,14 +30,15 @@ import (
 
 var nvmeHostDatasourceConfig = `
 data "powerflex_nvme_host" "nvme_host_datasource" {
-	filter {
-		name = ["nvme_acc_client1001"]
-	}
+	
 }
 `
-var nvmeHostDatasourceNoFilterConfig = `
+
+var nvmeHostDatasourceConfigFilter = `
 data "powerflex_nvme_host" "nvme_host_datasource" {
-	
+	filter {
+		name = ["` + NVMeHostName + `"]
+	}
 }
 `
 
@@ -49,15 +50,15 @@ data "powerflex_nvme_host" "nvme_host_datasource" {
 }
 `
 
-func TestAccDatasourceNvmeHost(t *testing.T) {
+func TestAccNvmeHostDatasource(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck:                 func() { testAccPreCheck(t) },
 		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
 		Steps: []resource.TestStep{
 			{
-				Config: ProviderConfigForTesting + nvmeHostDatasourceNoFilterConfig,
+				Config: ProviderConfigForTesting + nvmeHostDatasourceConfig,
 				Check: resource.ComposeAggregateTestCheckFunc(
-					resource.TestCheckResourceAttr("data.powerflex_nvme_host.nvme_host_datasource", "nvme_host_details.#", "1"),
+					listCountGreaterThan("data.powerflex_nvme_host.nvme_host_datasource", "nvme_host_details", 0),
 				),
 			},
 			{
@@ -69,7 +70,7 @@ func TestAccDatasourceNvmeHost(t *testing.T) {
 						{ID: "mock-id", HostType: "NVMeHost", SystemID: "mock-system-id", Name: "", Nqn: "mock-nqn", MaxNumPaths: 4, MaxNumSysPorts: 10},
 					}, nil).Build()
 				},
-				Config: ProviderConfigForTesting + nvmeHostDatasourceNoFilterConfig,
+				Config: ProviderConfigForTesting + nvmeHostDatasourceConfig,
 				Check: resource.ComposeAggregateTestCheckFunc(
 					resource.TestCheckResourceAttr("data.powerflex_nvme_host.nvme_host_datasource", "nvme_host_details.#", "1"),
 					resource.TestCheckResourceAttr("data.powerflex_nvme_host.nvme_host_datasource", "nvme_host_details.0.name", "NVMeHost:mock-id"),
@@ -92,18 +93,16 @@ func TestAccDatasourceNvmeHost(t *testing.T) {
 						FunctionMocker.UnPatch()
 					}
 				},
-				Config: ProviderConfigForTesting + nvmeHostDatasourceConfig,
+				Config: ProviderConfigForTesting + nvmeHostDatasourceConfigFilter,
 				Check: resource.ComposeAggregateTestCheckFunc(
-					resource.TestCheckResourceAttr("data.powerflex_nvme_host.nvme_host_datasource", "nvme_host_details.0.name", "nvme_acc_client1001"),
-					resource.TestCheckResourceAttr("data.powerflex_nvme_host.nvme_host_datasource", "nvme_host_details.0.max_num_paths", "4"),
-					resource.TestCheckResourceAttr("data.powerflex_nvme_host.nvme_host_datasource", "nvme_host_details.0.max_num_sys_ports", "10"),
+					resource.TestCheckResourceAttr("data.powerflex_nvme_host.nvme_host_datasource", "nvme_host_details.0.name", NVMeHostName),
 				),
 			},
 		},
 	})
 }
 
-func TestAccDatasourceNvmeHostNegative(t *testing.T) {
+func TestAccNvmeHostDatasourceNegative(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck:                 func() { testAccPreCheck(t) },
 		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
@@ -115,7 +114,7 @@ func TestAccDatasourceNvmeHostNegative(t *testing.T) {
 					}
 					FunctionMocker = Mock(helper.GetFirstSystem).Return(nil, fmt.Errorf("mock error")).Build()
 				},
-				Config:      ProviderConfigForTesting + nvmeHostDatasourceConfig,
+				Config:      ProviderConfigForTesting + nvmeHostDatasourceConfigFilter,
 				ExpectError: regexp.MustCompile(`.*Unable to Read Powerflex specific system*.`),
 			},
 			{
@@ -125,7 +124,7 @@ func TestAccDatasourceNvmeHostNegative(t *testing.T) {
 					}
 					FunctionMocker = Mock((*goscaleio.System).GetAllNvmeHosts).Return(nil, fmt.Errorf("mock error")).Build()
 				},
-				Config:      ProviderConfigForTesting + nvmeHostDatasourceConfig,
+				Config:      ProviderConfigForTesting + nvmeHostDatasourceConfigFilter,
 				ExpectError: regexp.MustCompile(`.*Unable to Read Powerflex NVMe Hosts*.`),
 			},
 		},

powerflex/provider/nvme_host_resource.go

@@ -224,6 +224,23 @@ func (r *NvmeHostResource) Update(ctx context.Context, req resource.UpdateReques
 		return
 	}
 
+	result, err := goscaleio.CheckPfmpVersion(r.client, "4.6")
+
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error checking PowerFlex version",
+			err.Error(),
+		)
+		return
+	}
+	if result < 0 {
+		resp.Diagnostics.AddError(
+			"Updating NVMe host is not supported",
+			"Updating the NVMe host is not supported in PowerFlex versions earlier than 4.6",
+		)
+		return
+	}
+
 	if !plan.Nqn.Equal(state.Nqn) {
 		resp.Diagnostics.AddError(
 			"nqn cannot be modified after creation",

powerflex/provider/nvme_host_resource_test.go

@@ -32,17 +32,17 @@ import (
 
 var nvmeHostResourceConfig = `
 resource "powerflex_nvme_host" "nvme_host_test" {
-		name              = "nvme_acc_client1002"
-		nqn               = "nqn.2014-08.org.nvmexpress:uuid:a10e4d56-a2c0-4cab-9a0a-9a7a4ebb8c0e"
+		name              = "` + NVMeHostNameCreate + `"
+		nqn               = "` + NVMeHostNqn + `"
 		max_num_paths     = 4
 		max_num_sys_ports = 10
 }
 `
 
 var nvmeHostResourceConfigUpdate = `
 resource "powerflex_nvme_host" "nvme_host_test" {
-		name              = "nvme_acc_client1002_update"
-		nqn               = "nqn.2014-08.org.nvmexpress:uuid:a10e4d56-a2c0-4cab-9a0a-9a7a4ebb8c0e"
+		name              = "` + NVMeHostNameUpdate + `"
+		nqn               = "` + NVMeHostNqn + `"
 		max_num_paths     = 8
 		max_num_sys_ports = 8
 }
@@ -57,8 +57,8 @@ func TestAccNvmeHostResource(t *testing.T) {
 			{
 				Config: ProviderConfigForTesting + nvmeHostResourceConfig,
 				Check: resource.ComposeAggregateTestCheckFunc(
-					resource.TestCheckResourceAttr(resourceName, "name", "nvme_acc_client1002"),
-					resource.TestCheckResourceAttr(resourceName, "nqn", "nqn.2014-08.org.nvmexpress:uuid:a10e4d56-a2c0-4cab-9a0a-9a7a4ebb8c0e"),
+					resource.TestCheckResourceAttr(resourceName, "name", NVMeHostNameCreate),
+					resource.TestCheckResourceAttr(resourceName, "nqn", NVMeHostNqn),
 					resource.TestCheckResourceAttr(resourceName, "max_num_paths", "4"),
 					resource.TestCheckResourceAttr(resourceName, "max_num_sys_ports", "10"),
 				),
@@ -73,7 +73,7 @@ func TestAccNvmeHostResource(t *testing.T) {
 			{
 				Config: ProviderConfigForTesting + nvmeHostResourceConfigUpdate,
 				Check: resource.ComposeAggregateTestCheckFunc(
-					resource.TestCheckResourceAttr(resourceName, "name", "nvme_acc_client1002_update"),
+					resource.TestCheckResourceAttr(resourceName, "name", NVMeHostNameUpdate),
 					resource.TestCheckResourceAttr(resourceName, "max_num_paths", "8"),
 					resource.TestCheckResourceAttr(resourceName, "max_num_sys_ports", "8"),
 				),
@@ -82,7 +82,7 @@ func TestAccNvmeHostResource(t *testing.T) {
 			{
 				Config: ProviderConfigForTesting + nvmeHostResourceConfig,
 				Check: resource.ComposeAggregateTestCheckFunc(
-					resource.TestCheckResourceAttr(resourceName, "name", "nvme_acc_client1002"),
+					resource.TestCheckResourceAttr(resourceName, "name", NVMeHostNameCreate),
 					resource.TestCheckResourceAttr(resourceName, "max_num_paths", "4"),
 					resource.TestCheckResourceAttr(resourceName, "max_num_sys_ports", "10"),
 				),
@@ -166,7 +166,7 @@ func TestAccNvmeHostResourceNegative(t *testing.T) {
 			{
 				Config: ProviderConfigForTesting + nvmeHostResourceConfig,
 				Check: resource.ComposeAggregateTestCheckFunc(
-					resource.TestCheckResourceAttr(resourceName, "name", "nvme_acc_client1002"),
+					resource.TestCheckResourceAttr(resourceName, "name", NVMeHostNameCreate),
 					resource.TestCheckResourceAttr(resourceName, "max_num_paths", "4"),
 					resource.TestCheckResourceAttr(resourceName, "max_num_sys_ports", "10"),
 				),
@@ -191,6 +191,16 @@ func TestAccNvmeHostResourceHelperNegative(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
 		Steps: []resource.TestStep{
+			{
+				PreConfig: func() {
+					if FunctionMocker != nil {
+						FunctionMocker.UnPatch()
+					}
+					FunctionMocker = Mock(helper.GetFirstSystem).Return(nil, fmt.Errorf("mock error")).Build()
+				},
+				Config:      ProviderConfigForTesting + nvmeHostResourceConfig,
+				ExpectError: regexp.MustCompile(`.*Error in getting system instance on the PowerFlex cluster.*`),
+			},
 			{
 				PreConfig: func() {
 					if FunctionMocker != nil {
@@ -242,6 +252,39 @@ func TestAccNvmeHostResourceHelperNegative(t *testing.T) {
 				Config:      ProviderConfigForTesting + nvmeHostResourceConfigUpdate,
 				ExpectError: regexp.MustCompile(`.*Could not read NVMe host struct.*`),
 			},
+			// mock checking PowerFlex version when udpating
+			{
+				PreConfig: func() {
+					if FunctionMocker != nil {
+						FunctionMocker.UnPatch()
+					}
+					FunctionMocker = Mock(goscaleio.CheckPfmpVersion).Return(-1, fmt.Errorf("mock error")).Build()
+				},
+				Config:      ProviderConfigForTesting + nvmeHostResourceConfigUpdate,
+				ExpectError: regexp.MustCompile(`.*Error checking PowerFlex version*.`),
+			},
+			// updating is not allowed prior to 4.6
+			{
+				PreConfig: func() {
+					if FunctionMocker != nil {
+						FunctionMocker.UnPatch()
+					}
+					FunctionMocker = Mock(goscaleio.CheckPfmpVersion).Return(-1, nil).Build()
+				},
+				Config:      ProviderConfigForTesting + nvmeHostResourceConfigUpdate,
+				ExpectError: regexp.MustCompile(`.*Updating NVMe host is not supported*.`),
+			},
+			// error deleting
+			{
+				PreConfig: func() {
+					if FunctionMocker != nil {
+						FunctionMocker.UnPatch()
+					}
+					FunctionMocker = Mock((*goscaleio.System).DeleteNvmeHost).Return(fmt.Errorf("mock error")).Build()
+				},
+				Config:      ProviderConfigForTesting,
+				ExpectError: regexp.MustCompile(`.*Unable to delete NVMe host*.`),
+			},
 			// rollback nvme host
 			{
 				PreConfig: func() {
@@ -251,7 +294,7 @@ func TestAccNvmeHostResourceHelperNegative(t *testing.T) {
 				},
 				Config: ProviderConfigForTesting + nvmeHostResourceConfig,
 				Check: resource.ComposeAggregateTestCheckFunc(
-					resource.TestCheckResourceAttr(resourceName, "name", "nvme_acc_client1002"),
+					resource.TestCheckResourceAttr(resourceName, "name", NVMeHostNameCreate),
 					resource.TestCheckResourceAttr(resourceName, "max_num_paths", "4"),
 					resource.TestCheckResourceAttr(resourceName, "max_num_sys_ports", "10"),
 				),

powerflex/provider/nvme_target_datasource_test.go

@@ -64,7 +64,7 @@ func listCountGreaterThan(resourceName, listName string, count int) resource.Tes
 	}
 }
 
-func TestAccDatasourceNvmeTarget(t *testing.T) {
+func TestAccNvmeTargetDatasource(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck:                 func() { testAccPreCheck(t) },
 		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
@@ -89,7 +89,7 @@ func TestAccDatasourceNvmeTarget(t *testing.T) {
 	})
 }
 
-func TestAccDatasourceNvmeTargetNegative(t *testing.T) {
+func TestAccNvmeTargetDatasourceNegative(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck:                 func() { testAccPreCheck(t) },
 		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,

powerflex/provider/powerflex.env

@@ -79,6 +79,10 @@ POWERFLEX_RCG_ID=
 POWERFLEX_SOURCE_PROTECTION_DOMAIN_ID=
 POWERFLEX_REMOTE_PROTECTION_DOMAIN_ID=
 POWERFLEX_DESTINATION_SYSTEM_ID=
+POWERFLEX_NVME_HOST_NAME=
+POWERFLEX_NVME_HOST_NAME_CREATE=
+POWERFLEX_NVME_HOST_NAME_UPDATE=
+POWERFLEX_NVME_HOST_NQN=
 POWERFLEX_NVME_TARGET_NAME=
 POWERFLEX_NVME_TARGET_NAME_CREATE=
 POWERFLEX_NVME_TARGET_NAME_UPDATE=

powerflex/provider/provider_test.go

@@ -357,6 +357,10 @@ var PeerMdmName = setDefault(globalEnvMap["POWERFLEX_PEER_MDM_NAME"], "tfacc_pee
 var PeerMdmID = setDefault(globalEnvMap["POWERFLEX_PEER_MDM_ID"], "tfacc_peer_mdm_id")
 var PeerMdmPort = setDefault(globalEnvMap["POWERFLEX_PEER_MDM_PORT"], "2222")
 var PeerMdmCouplingRC = setDefault(globalEnvMap["POWERFLEX_PEER_MDM_COUPLING_RC"], "tfacc_peer_mdm_coupling_rc")
+var NVMeHostName = setDefault(globalEnvMap["POWERFLEX_NVME_HOST_NAME"], "nvme_acc_client1001")
+var NVMeHostNameCreate = setDefault(globalEnvMap["POWERFLEX_NVME_HOST_NAME_CREATE"], "nvme_acc_client1002")
+var NVMeHostNameUpdate = setDefault(globalEnvMap["POWERFLEX_NVME_HOST_NAME_UPDATE"], "nvme_acc_client1002_update")
+var NVMeHostNqn = setDefault(globalEnvMap["POWERFLEX_NVME_HOST_NQN"], "nqn.2014-08.org.nvmexpress:uuid:a10e4d56-a2c0-4cab-9a0a-9a7a4ebb8c0e")
 var NVMeTargetName = setDefault(globalEnvMap["POWERFLEX_NVME_TARGET_NAME"], "mock-name-1")
 var NVMeTargetNameCreate = setDefault(globalEnvMap["POWERFLEX_NVME_TARGET_NAME_CREATE"], "tfacc_nvme_target_name")
 var NVMeTargetNameUpdate = setDefault(globalEnvMap["POWERFLEX_NVME_TARGET_NAME_UPDATE"], "tfacc_nvme_target_name_update")

templates/resources/nvme_host.md.tmpl

@@ -26,6 +26,8 @@ description: |-
 
 {{ .Description | trimspace }}
 
+Please note that due to certain limitations, updating the NVMe host in PowerFlex versions earlier than 4.6 is not supported
+
 {{ if .HasExample -}}
 ## Example Usage