test: added backup restore from backup id example (#180)

Author: Aashiq-J

README.md

@@ -22,6 +22,7 @@ This module implements an instance of the IBM Cloud Databases for etcd service.
     * [Basic example](./examples/basic)
     * [Complete example with BYOK encryption, autoscaling, and service credential creation](./examples/complete)
     * [Financial Services Cloud profile example with autoscaling enabled](./examples/fscloud)
+    * [Restore from backup example](./examples/backup-restore)
 * [Contributing](#contributing)
 <!-- END OVERVIEW HOOK -->
 

examples/backup-restore/README.md

@@ -0,0 +1,6 @@
+# Restore from backup example
+
+This example provides an end-to-end executable flow of how a etcd DB can be created from a backup instance. This example uses the IBM Cloud terraform provider to:
+
+- Create a new resource group if one is not passed in.
+- Create a restored ICD etcd database instance pointing to the lastest backup of the existing etcd database instance crn passed.

examples/backup-restore/main.tf

@@ -0,0 +1,27 @@
+##############################################################################
+# Resource Group
+##############################################################################
+
+module "resource_group" {
+  source  = "terraform-ibm-modules/resource-group/ibm"
+  version = "1.1.6"
+  # if an existing resource group is not set (null) create a new one using prefix
+  resource_group_name          = var.resource_group == null ? "${var.prefix}-resource-group" : null
+  existing_resource_group_name = var.resource_group
+}
+
+data "ibm_database_backups" "backup_database" {
+  deployment_id = var.etcd_db_crn
+}
+
+# New etcd db instance pointing to the backup instance
+module "restored_etcd_db" {
+  source            = "../.."
+  resource_group_id = module.resource_group.resource_group_id
+  name              = "${var.prefix}-etcd-restored"
+  region            = var.region
+  etcd_version      = var.etcd_version
+  access_tags       = var.access_tags
+  tags              = var.resource_tags
+  backup_crn        = data.ibm_database_backups.backup_database.backups[0].backup_id
+}

examples/backup-restore/outputs.tf

@@ -0,0 +1,13 @@
+##############################################################################
+# Outputs
+##############################################################################
+
+output "restored_etcd_db_id" {
+  description = "Restored etcd db instance id"
+  value       = module.restored_etcd_db.id
+}
+
+output "restored_etcd_db_version" {
+  description = "Restored etcd instance version"
+  value       = module.restored_etcd_db.version
+}

examples/backup-restore/provider.tf

@@ -0,0 +1,4 @@
+provider "ibm" {
+  ibmcloud_api_key = var.ibmcloud_api_key
+  region           = var.region
+}

examples/backup-restore/variables.tf

@@ -0,0 +1,46 @@
+variable "ibmcloud_api_key" {
+  type        = string
+  description = "The IBM Cloud API Key"
+  sensitive   = true
+}
+
+variable "region" {
+  type        = string
+  description = "Region to provision all resources created by this example"
+  default     = "us-south"
+}
+
+variable "prefix" {
+  type        = string
+  description = "Prefix to append to all resources created by this example"
+  default     = "etcd-restore"
+}
+
+variable "resource_group" {
+  type        = string
+  description = "An existing resource group name to use for this example, if unset a new resource group will be created"
+  default     = null
+}
+
+variable "etcd_version" {
+  type        = string
+  description = "Version of etcd to deploy"
+  default     = null
+}
+
+variable "resource_tags" {
+  type        = list(string)
+  description = "Optional list of tags to be added to created resources"
+  default     = []
+}
+
+variable "access_tags" {
+  type        = list(string)
+  description = "A list of access tags to apply to the etcd instance created by the module, see https://cloud.ibm.com/docs/account?topic=account-access-tags-tutorial for more details"
+  default     = []
+}
+
+variable "etcd_db_crn" {
+  type        = string
+  description = "The existing CRN of a etcd instance to fetch the latest backup crn."
+}

examples/backup-restore/version.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_version = ">= 1.3.0"
+  required_providers {
+    # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works
+    ibm = {
+      source  = "IBM-Cloud/ibm"
+      version = ">=1.62.0, <2.0.0"
+    }
+  }
+}

tests/other_test.go

@@ -2,6 +2,7 @@
 package test
 
 import (
+	"fmt"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -52,3 +53,23 @@ func TestPlanICDVersions(t *testing.T) {
 		t.Run(version, func(t *testing.T) { testPlanICDVersions(t, version) })
 	}
 }
+
+func TestRunRestoredDBExample(t *testing.T) {
+	t.Parallel()
+
+	options := testhelper.TestOptionsDefaultWithVars(&testhelper.TestOptions{
+		Testing:       t,
+		TerraformDir:  "examples/backup-restore",
+		Prefix:        "etcd-restored",
+		ResourceGroup: resourceGroup,
+		Region:        fmt.Sprint(permanentResources["etcd_region"]),
+		TerraformVars: map[string]interface{}{
+			"etcd_db_crn": permanentResources["etcd_crn"],
+		},
+		CloudInfoService: sharedInfoSvc,
+	})
+
+	output, err := options.RunTestConsistency()
+	assert.Nil(t, err, "This should not have errored")
+	assert.NotNil(t, output, "Expected some output")
+}