Releasing version 19.1.0

Releasing version 19.1.0

Author: pelliu

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 
+## 19.1.0 - 2020-05-05
+### Added
+- Support for updating the license type of database systems in the Database service
+- Support for updating the version of 19c autonomous databases in the Database service
+- Support for backup and restore functionality in the Key Management service
+- Support for reports in the Marketplace service
+- Support for calling Oracle Cloud Infrastructure services in the ap-hyderabad-1 region
+
 ## 19.0.0 - 2020-04-28
 ### Added
 - Support for the MySQL Database service

common/common.go

@@ -4,7 +4,11 @@
 package common
 
 import (
+	"encoding/json"
 	"fmt"
+	"io/ioutil"
+	"os"
+	"path"
 	"regexp"
 	"strings"
 )
@@ -35,6 +39,8 @@ const (
 	RegionAPSeoul1 Region = "ap-seoul-1"
 	//RegionAPMumbai1 region for mumbai
 	RegionAPMumbai1 Region = "ap-mumbai-1"
+	//RegionAPHyderabad1 region for Hyderabad
+	RegionAPHyderabad1 Region = "ap-hyderabad-1"
 	//RegionAPMelbourne1 region for Melbourne
 	RegionAPMelbourne1 Region = "ap-melbourne-1"
 	//RegionAPSydney1 region for Sydney
@@ -60,6 +66,25 @@ const (
 	RegionUSGovPhoenix1 Region = "us-gov-phoenix-1"
 	//RegionUKGovLondon1 gov region London
 	RegionUKGovLondon1 Region = "uk-gov-london-1"
+
+	//RegionUKGovCardiff1 gov region Cardiff
+	RegionUKGovCardiff1 Region = "uk-gov-cardiff-1"
+
+	//RegionUSTacoma1 region for us-tacoma-1
+	RegionUSTacoma1 Region = "us-tacoma-1"
+
+	// Region Metadata Configuration File
+	regionMetadataCfgDirName  = ".oci"
+	regionMetadataCfgFileName = "regions-config.json"
+
+	// Region Metadata Environment Variable
+	regionMetadataEnvVarName = "OCI_REGION_METADATA"
+
+	// Region Metadata
+	regionIdentifierPropertyName     = "regionIdentifier"     // e.g. "ap-sydney-1"
+	realmKeyPropertyName             = "realmKey"             // e.g. "oc1"
+	realmDomainComponentPropertyName = "realmDomainComponent" // e.g. "oraclecloud.com"
+	regionKeyPropertyName            = "regionKey"            // e.g. "SYD"
 )
 
 var realm = map[string]string{
@@ -81,6 +106,7 @@ var regionRealm = map[Region]string{
 	RegionAPSeoul1:     "oc1",
 	RegionAPSydney1:    "oc1",
 	RegionAPMumbai1:    "oc1",
+	RegionAPHyderabad1: "oc1",
 	RegionAPMelbourne1: "oc1",
 	RegionMEJeddah1:    "oc1",
 	RegionEUZurich1:    "oc1",
@@ -100,7 +126,7 @@ func (region Region) Endpoint(service string) string {
 	return fmt.Sprintf("%s.%s.%s", service, region, region.secondLevelDomain())
 }
 
-// EndpointForTemplate returns a endpoint for a service based on template
+// EndpointForTemplate returns a endpoint for a service based on template, only unknown region name can fall back to "oc1", but not short code region name.
 func (region Region) EndpointForTemplate(service string, serviceEndpointTemplate string) string {
 	if serviceEndpointTemplate == "" {
 		return region.Endpoint(service)
@@ -154,6 +180,8 @@ func StringToRegion(stringRegion string) (r Region) {
 		r = RegionAPSeoul1
 	case "bom", "ap-mumbai-1":
 		r = RegionAPMumbai1
+	case "hyd", "ap-hyderabad-1":
+		r = RegionAPHyderabad1
 	case "mel", "ap-melbourne-1":
 		r = RegionAPMelbourne1
 	case "syd", "ap-sydney-1":
@@ -179,8 +207,8 @@ func StringToRegion(stringRegion string) (r Region) {
 	case "ltn", "uk-gov-london-1":
 		r = RegionUKGovLondon1
 	default:
-		r = Region(stringRegion)
 		Debugf("region named: %s, is not recognized", stringRegion)
+		r = checkAndAddRegionMetadata(stringRegion)
 	}
 	return
 }
@@ -195,3 +223,121 @@ func canStringBeRegion(stringRegion string) (region string, err error) {
 	}
 	return stringRegion, nil
 }
+
+// check region info from original map
+func checkAndAddRegionMetadata(region string) Region {
+	switch {
+	case SetRegionMetadataFromCfgFile(&region):
+	case SetRegionMetadataFromEnvVar(&region):
+	case SetRegionFromInstanceMetadataService(&region):
+	default:
+		//err := fmt.Errorf("failed to get region metadata information.")
+		return Region(region)
+	}
+	return Region(region)
+}
+
+// SetRegionMetadataFromEnvVar checks if region metadata env variable is provided, once it's there, parse and added it to region map
+func SetRegionMetadataFromEnvVar(region *string) bool {
+	// check from env variable
+	if jsonStr, existed := os.LookupEnv(regionMetadataEnvVarName); existed {
+		Debugf("Raw content of region metadata env var:", jsonStr)
+		var regionSchema map[string]string
+		if err := json.Unmarshal([]byte(jsonStr), &regionSchema); err != nil {
+			Debugf("Can't unmarshal env var, the error info is", err)
+			return false
+		}
+		// check if the specified region is in the env var.
+		if checkSchemaItems(regionSchema) {
+			// set mapping table
+			addRegionSchema(regionSchema)
+			if regionSchema[regionKeyPropertyName] == *region ||
+				regionSchema[regionIdentifierPropertyName] == *region {
+				*region = regionSchema[regionIdentifierPropertyName]
+				return true
+			}
+		}
+		return false
+	}
+	Debugf("The Region Metadata Schema wasn't set in env variable - OCI_REGION_METADATA.")
+	return false
+}
+
+// SetRegionMetadataFromCfgFile checks if region metadata config file is provided, once it's there, parse and added it to region map
+func SetRegionMetadataFromCfgFile(region *string) bool {
+	homeFolder := getHomeFolder()
+	configFile := path.Join(homeFolder, regionMetadataCfgDirName, regionMetadataCfgFileName)
+	if jsonArr, ok := readAndParseConfigFile(&configFile); ok {
+		added := false
+		for _, jsonItem := range jsonArr {
+			if checkSchemaItems(jsonItem) {
+				addRegionSchema(jsonItem)
+				if jsonItem[regionKeyPropertyName] == *region ||
+					jsonItem[regionIdentifierPropertyName] == *region {
+					*region = jsonItem[regionIdentifierPropertyName]
+					added = true
+				}
+			}
+		}
+		return added
+	}
+	return false
+}
+
+func readAndParseConfigFile(configFileName *string) (fileContent []map[string]string, ok bool) {
+
+	if content, err := ioutil.ReadFile(*configFileName); err == nil {
+		Debugf("Raw content of region metadata config file content:", string(content[:]))
+		if err := json.Unmarshal(content, &fileContent); err != nil {
+			Debugf("Can't unmarshal env var, the error info is", err)
+			return
+		}
+		ok = true
+		return
+	}
+	Debugf("No Region Metadata Config File provided.")
+	return
+
+}
+
+// check map regionRealm's region name, if it's already there, no need to add it.
+func addRegionSchema(regionSchema map[string]string) {
+	r := Region(strings.ToLower(regionSchema[regionIdentifierPropertyName]))
+	if _, ok := regionRealm[r]; !ok {
+		// set mapping table
+		realm[regionSchema[realmKeyPropertyName]] = regionSchema[realmDomainComponentPropertyName]
+		regionRealm[r] = regionSchema[realmKeyPropertyName]
+		return
+	}
+	Debugf("Region {} has already been added, no need to add again.", regionSchema[regionIdentifierPropertyName])
+}
+
+// check region schema content if all the required contents are provided
+func checkSchemaItems(regionSchema map[string]string) bool {
+	if checkSchemaItem(regionSchema, regionIdentifierPropertyName) &&
+		checkSchemaItem(regionSchema, realmKeyPropertyName) &&
+		checkSchemaItem(regionSchema, realmDomainComponentPropertyName) &&
+		checkSchemaItem(regionSchema, regionKeyPropertyName) {
+		return true
+	}
+	return false
+}
+
+// check region schema item is valid, if so, convert it to lower case.
+func checkSchemaItem(regionSchema map[string]string, key string) bool {
+	if val, ok := regionSchema[key]; ok {
+		if val != "" {
+			regionSchema[key] = strings.ToLower(val)
+			return true
+		}
+		Debugf("Region metadata schema {} is provided,but content is empty.", key)
+		return false
+	}
+	Debugf("Region metadata schema {} is not provided, please update the content", key)
+	return false
+}
+
+// SetRegionFromInstanceMetadataService checks if region metadata can be provided from InstanceMetadataService.
+func SetRegionFromInstanceMetadataService(region *string) bool {
+	return false
+}

common/common_test.go

@@ -4,6 +4,9 @@
 package common
 
 import (
+	"io/ioutil"
+	"os"
+	"path"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -154,4 +157,140 @@ func TestStringToRegion(t *testing.T) {
 
 	region = StringToRegion("yul")
 	assert.Equal(t, RegionCAMontreal1, region)
+
+	regionMetadataEnvVar := `{"realmKey":"OC0","realmDomainComponent":"testRealm.com","regionKey":"RTK","regionIdentifier":"us-testregion-1"}`
+	os.Unsetenv("OCI_REGION_METADATA")
+	os.Setenv("OCI_REGION_METADATA", regionMetadataEnvVar)
+	region = StringToRegion("rtk")
+	assert.Equal(t, Region("us-testregion-1"), region)
+
+	fileContent :=
+		`[
+	{
+		"realmKey" : "",
+		"realmDomainComponent" : "oraclecloud.com",
+		"regionKey" : "ABC",
+		"regionIdentifier" : "ap-testregion-2"
+	},
+	{
+		"realmKey" : "OC6",
+		"realmDomainComponent" : "oraclensrcloud.com",
+		"regionKey" : "DEF",
+		"regionIdentifier" : "us-testregion-3"
+	}
+]`
+	tmpLocation := path.Join(getHomeFolder(), ".oci", "regions-config.json")
+	tmpPath := path.Join(getHomeFolder(), ".oci")
+
+	if _, err := os.Stat(tmpPath); err != nil && os.IsNotExist(err) {
+		if err := os.Mkdir(tmpPath, 0777); err != nil {
+			assert.FailNow(t, err.Error())
+		}
+	}
+
+	if err := ioutil.WriteFile(tmpLocation, []byte(fileContent), 0644); err != nil {
+		assert.FailNow(t, err.Error())
+	}
+	region = StringToRegion("def")
+	assert.Equal(t, Region("us-testregion-3"), region)
+
+	region = StringToRegion("us-unknownregion-1")
+	assert.Equal(t, Region("us-unknownregion-1"), region)
+}
+
+func TestSetRegionMetadataFromEnvVar(t *testing.T) {
+	// normal case
+	regionMetadataEnvVar := `{"realmKey":"OC0","realmDomainComponent":"testRealm.com","regionKey":"RTK","regionIdentifier":"us-testregion-1"}`
+	os.Unsetenv("OCI_REGION_METADATA")
+	os.Setenv("OCI_REGION_METADATA", regionMetadataEnvVar)
+	// once provide region name
+	expectedRegion := "us-testregion-1"
+	ok := SetRegionMetadataFromEnvVar(&expectedRegion)
+	assert.Equal(t, ok, true)
+	assert.Equal(t, "oc0", regionRealm[Region("us-testregion-1")])
+	assert.Equal(t, "testrealm.com", realm["oc0"])
+	// once provide region short code
+	shortCode := "rtk"
+	ok = SetRegionMetadataFromEnvVar(&shortCode)
+	assert.Equal(t, ok, true)
+	assert.Equal(t, expectedRegion, shortCode)
+	assert.Equal(t, "oc0", regionRealm[Region("us-testregion-1")])
+	assert.Equal(t, "testrealm.com", realm["oc0"])
+
+	// test corner case
+	os.Unsetenv("OCI_REGION_METADATA")
+	os.Setenv("OCI_REGION_METADATA", `"test": "test"`)
+	ok = SetRegionMetadataFromEnvVar(&expectedRegion)
+	assert.Equal(t, false, ok)
+
+	os.Unsetenv("OCI_REGION_METADATA")
+	os.Setenv("OCI_REGION_METADATA", `{"realmKey":"","realmDomainComponent":"testRealm.com","regionKey":"RTK","regionIdentifier":"us-testregion-1"}`)
+	ok = SetRegionMetadataFromEnvVar(&expectedRegion)
+	assert.Equal(t, false, ok)
+
+	os.Unsetenv("OCI_REGION_METADATA")
+	ok = SetRegionMetadataFromEnvVar(&expectedRegion)
+	assert.Equal(t, false, ok)
+}
+
+func TestSetRegionMetadataFromCfgFile(t *testing.T) {
+	// normal case
+	fileContent :=
+		`[
+	{
+		"realmKey" : "",
+		"realmDomainComponent" : "oraclecloud.com",
+		"regionKey" : "ABC",
+		"regionIdentifier" : "ap-testregion-2"
+	},
+	{
+		"realmKey" : "OC6",
+		"realmDomainComponent" : "oraclensrcloud.com",
+		"regionKey" : "DEF",
+		"regionIdentifier" : "us-testregion-3"
+	}
+]`
+	tmpLocation := path.Join(getHomeFolder(), ".oci", "regions-config.json")
+	tmpPath := path.Join(getHomeFolder(), ".oci")
+
+	if _, err := os.Stat(tmpPath); err != nil && os.IsNotExist(err) {
+		if err := os.Mkdir(tmpPath, 0777); err != nil {
+			assert.FailNow(t, err.Error())
+		}
+	}
+
+	if err := ioutil.WriteFile(tmpLocation, []byte(fileContent), 0644); err != nil {
+		assert.FailNow(t, err.Error())
+	}
+	// once provide region name
+	expectedRegion := "us-testregion-3"
+	ok := SetRegionMetadataFromCfgFile(&expectedRegion)
+	assert.Equal(t, true, ok)
+	assert.Equal(t, "", regionRealm[Region("us-testregion-2")])
+	assert.Equal(t, "oc6", regionRealm[Region("us-testregion-3")])
+	assert.Equal(t, "oraclensrcloud.com", realm["oc6"])
+	// once provide region short code
+	shortCode := "def"
+	ok = SetRegionMetadataFromCfgFile(&shortCode)
+	assert.Equal(t, true, ok)
+	assert.Equal(t, "us-testregion-3", shortCode)
+	assert.Equal(t, "", regionRealm[Region("us-testregion-2")])
+	assert.Equal(t, "oc6", regionRealm[Region("us-testregion-3")])
+	assert.Equal(t, "oraclensrcloud.com", realm["oc6"])
+
+	//corner case
+	fileContent = ""
+	if _, err := os.Stat(tmpLocation); err == nil || os.IsExist(err) {
+		os.Remove(tmpLocation)
+	}
+	ok = SetRegionMetadataFromCfgFile(&expectedRegion)
+	assert.Equal(t, false, ok)
+
+	if err := ioutil.WriteFile(tmpLocation, []byte(fileContent), 0644); err != nil {
+		assert.FailNow(t, err.Error())
+	}
+
+	ok = SetRegionMetadataFromCfgFile(&expectedRegion)
+	assert.Equal(t, false, ok)
+
 }