Implement key pair resource (#578)

* feat: Implement key pair resource

* feat: Implement acceptance test

* fix: Minor fixes to server and public IP resources

* fix: Lint fixes

* fix: Generalize description

* feat: Update examples to read key from file; Add datasource example

* fix: Fix field descriptions

* fix: Fix example

* feat: Add link to key pair resource in server example

* feat: Add links to key pair resource in other examples
This commit is contained in:
João Palet 2024-11-05 09:50:55 +00:00 committed by GitHub
parent c1ada319ce
commit 153947fd7b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
16 changed files with 1261 additions and 117 deletions

View file

@ -12,6 +12,7 @@ import (
"github.com/stackitcloud/stackit-sdk-go/core/config"
"github.com/stackitcloud/stackit-sdk-go/core/utils"
"github.com/stackitcloud/stackit-sdk-go/services/iaas"
"github.com/stackitcloud/stackit-sdk-go/services/iaasalpha"
"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/core"
"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/testutil"
)
@ -96,6 +97,14 @@ var publicIpResource = map[string]string{
"network_interface_id": testutil.IaaSNetworkInterfaceId,
}
// Key pair resource data
var keyPairResource = map[string]string{
"name": "key-pair-name",
"public_key": `ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIDsPd27M449akqCtdFg2+AmRVJz6eWio0oMP9dVg7XZ`,
"label1": "value1",
"label1-updated": "value1-updated",
}
func networkResourceConfig(name, nameservers string) string {
return fmt.Sprintf(`
resource "stackit_network" "network" {
@ -323,6 +332,13 @@ func testAccPublicIpConfig(publicIpResourceConfig string) string {
)
}
func testAccKeyPairConfig(keyPairResourceConfig string) string {
return fmt.Sprintf("%s\n\n%s",
testutil.IaaSProviderConfig(),
keyPairResourceConfig,
)
}
func TestAccNetworkArea(t *testing.T) {
resource.Test(t, resource.TestCase{
ProtoV6ProviderFactories: testutil.TestAccProtoV6ProviderFactories,
@ -1113,6 +1129,117 @@ func TestAccPublicIp(t *testing.T) {
})
}
func TestAccKeyPair(t *testing.T) {
resource.Test(t, resource.TestCase{
ProtoV6ProviderFactories: testutil.TestAccProtoV6ProviderFactories,
CheckDestroy: testAccCheckIaaSKeyPairDestroy,
Steps: []resource.TestStep{
// Creation
{
Config: testAccKeyPairConfig(
fmt.Sprintf(`
resource "stackit_key_pair" "key_pair" {
name = "%s"
public_key = "%s"
labels = {
"label1" = "%s"
}
}
`,
keyPairResource["name"],
keyPairResource["public_key"],
keyPairResource["label1"],
),
),
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr("stackit_key_pair.key_pair", "name", keyPairResource["name"]),
resource.TestCheckResourceAttr("stackit_key_pair.key_pair", "labels.label1", keyPairResource["label1"]),
resource.TestCheckResourceAttr("stackit_key_pair.key_pair", "public_key", keyPairResource["public_key"]),
resource.TestCheckResourceAttrSet("stackit_key_pair.key_pair", "fingerprint"),
),
},
// Data source
{
Config: fmt.Sprintf(`
%s
data "stackit_key_pair" "key_pair" {
name = stackit_key_pair.key_pair.name
}
`,
testAccKeyPairConfig(
fmt.Sprintf(`
resource "stackit_key_pair" "key_pair" {
name = "%s"
public_key = "%s"
labels = {
"label1" = "%s"
}
}
`,
keyPairResource["name"],
keyPairResource["public_key"],
keyPairResource["label1"],
),
),
),
Check: resource.ComposeAggregateTestCheckFunc(
// Instance
resource.TestCheckResourceAttr("data.stackit_key_pair.key_pair", "name", keyPairResource["name"]),
resource.TestCheckResourceAttr("data.stackit_key_pair.key_pair", "public_key", keyPairResource["public_key"]),
resource.TestCheckResourceAttr("stackit_key_pair.key_pair", "labels.label1", keyPairResource["label1"]),
resource.TestCheckResourceAttrPair(
"stackit_key_pair.key_pair", "fingerprint",
"data.stackit_key_pair.key_pair", "fingerprint",
),
),
},
// Import
{
ResourceName: "stackit_key_pair.key_pair",
ImportStateIdFunc: func(s *terraform.State) (string, error) {
r, ok := s.RootModule().Resources["stackit_key_pair.key_pair"]
if !ok {
return "", fmt.Errorf("couldn't find resource stackit_key_pair.key_pair")
}
keyPairName, ok := r.Primary.Attributes["name"]
if !ok {
return "", fmt.Errorf("couldn't find attribute name")
}
return keyPairName, nil
},
ImportState: true,
ImportStateVerify: true,
},
// Update
{
Config: testAccKeyPairConfig(
fmt.Sprintf(`
resource "stackit_key_pair" "key_pair" {
name = "%s"
public_key = "%s"
labels = {
"label1" = "%s"
}
}
`,
keyPairResource["name"],
keyPairResource["public_key"],
keyPairResource["label1-updated"],
),
),
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr("stackit_key_pair.key_pair", "name", keyPairResource["name"]),
resource.TestCheckResourceAttr("stackit_key_pair.key_pair", "labels.label1", keyPairResource["label1-updated"]),
resource.TestCheckResourceAttrSet("stackit_key_pair.key_pair", "fingerprint"),
),
},
// Deletion is done by the framework implicitly
},
})
}
func testAccCheckNetworkAreaDestroy(s *terraform.State) error {
ctx := context.Background()
var client *iaas.APIClient
@ -1388,3 +1515,49 @@ func testAccCheckIaaSPublicIpDestroy(s *terraform.State) error {
}
return nil
}
func testAccCheckIaaSKeyPairDestroy(s *terraform.State) error {
ctx := context.Background()
var client *iaasalpha.APIClient
var err error
if testutil.IaaSCustomEndpoint == "" {
client, err = iaasalpha.NewAPIClient(
config.WithRegion("eu01"),
)
} else {
client, err = iaasalpha.NewAPIClient(
config.WithEndpoint(testutil.IaaSCustomEndpoint),
)
}
if err != nil {
return fmt.Errorf("creating client: %w", err)
}
keyPairsToDestroy := []string{}
for _, rs := range s.RootModule().Resources {
if rs.Type != "stackit_key_pair" {
continue
}
// Key pair terraform ID: "[name]"
keyPairsToDestroy = append(keyPairsToDestroy, rs.Primary.ID)
}
keyPairsResp, err := client.ListKeyPairsExecute(ctx)
if err != nil {
return fmt.Errorf("getting key pairs: %w", err)
}
keyPairs := *keyPairsResp.Items
for i := range keyPairs {
if keyPairs[i].Name == nil {
continue
}
if utils.Contains(keyPairsToDestroy, *keyPairs[i].Name) {
err := client.DeleteKeyPairExecute(ctx, *keyPairs[i].Name)
if err != nil {
return fmt.Errorf("destroying key pair %s during CheckDestroy: %w", *keyPairs[i].Name, err)
}
}
}
return nil
}