release 5.5.0

Author: jasonyin

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 
+## 5.5.0 - 2019-05-07
+### Added
+- Support for the Tokyo (NRT) region
+
+- Support UploadManager for uploading large objects. Sample is available on [Github](https://github.com/oracle/oci-go-sdk/tree/master/example/example_objectstorage_test.go)
+
 ## 5.4.0 - 2019-04-16
 ### Added
 - Support for tagging dynamic groups in the Identity service

Makefile

@@ -1,10 +1,10 @@
 DOC_SERVER_URL=https:\/\/docs.cloud.oracle.com
 
 GEN_TARGETS = identity core objectstorage loadbalancer database audit dns filestorage email containerengine resourcesearch keymanagement announcementsservice healthchecks waas autoscaling streaming ons monitoring resourcemanager budget ##SPECNAME##
-NON_GEN_TARGETS = common common/auth
+NON_GEN_TARGETS = common common/auth objectstorage/transfer
 TARGETS = $(NON_GEN_TARGETS) $(GEN_TARGETS)
 
-TARGETS_WITH_TESTS = common common/auth
+TARGETS_WITH_TESTS = common common/auth objectstorage/transfer
 TARGETS_BUILD = $(patsubst %,build-%, $(TARGETS))
 TARGETS_CLEAN = $(patsubst %,clean-%, $(GEN_TARGETS))
 TARGETS_LINT = $(patsubst %,lint-%, $(TARGETS))
@@ -13,6 +13,8 @@ TARGETS_RELEASE= $(patsubst %,release-%, $(TARGETS))
 GOLINT=$(GOPATH)/bin/golint
 LINT_FLAGS=-min_confidence 0.9 -set_exit_status
 
+# directories under gen targets which contains hand writen code
+EXCLUDED_CLEAN_DIRECTORIES = objectstorage/transfer*
 
 .PHONY: $(TARGETS_BUILD) $(TARGET_TEST)
 
@@ -43,13 +45,13 @@ $(TARGETS_TEST): test-%:%
 
 $(TARGETS_CLEAN): clean-%:%
 	@echo "cleaning $<"
-	@-rm -rf $<
+	@-find $< -not -path "$<" | grep -vZ ${EXCLUDED_CLEAN_DIRECTORIES} | xargs rm -rf
 
 # clean all generated code under GEN_TARGETS folder
 clean-generate:
 	for target in ${GEN_TARGETS}; do \
 		echo "cleaning $$target"; \
-		rm -rf $$target; \
+		find $$target -not -path "$$target" | grep -vZ ${EXCLUDED_CLEAN_DIRECTORIES} | xargs rm -rf; \
 	done
 
 pre-doc:

common/common.go

@@ -24,6 +24,8 @@ const (
 	RegionFRA Region = "eu-frankfurt-1"
 	//RegionLHR region LHR
 	RegionLHR Region = "uk-london-1"
+	//RegionAPTokyo1 region for tokyo
+	RegionAPTokyo1 Region = "ap-tokyo-1"
 
 	//RegionUSLangley1 region for langley
 	RegionUSLangley1 Region = "us-langley-1"
@@ -50,10 +52,10 @@ var regionRealm = map[Region]string{
 	RegionFRA:        "oc1",
 	RegionLHR:        "oc1",
 	RegionCAToronto1: "oc1",
+	RegionAPTokyo1:   "oc1",
 
-	RegionUSLangley1: "oc2",
-	RegionUSLuke1:    "oc2",
-
+	RegionUSLangley1:    "oc2",
+	RegionUSLuke1:       "oc2",
 	RegionUSGovAshburn1: "oc3",
 	RegionUSGovChicago1: "oc3",
 	RegionUSGovPhoenix1: "oc3",
@@ -108,6 +110,8 @@ func StringToRegion(stringRegion string) (r Region) {
 		r = RegionFRA
 	case "lhr", "uk-london-1":
 		r = RegionLHR
+	case "ap-tokyo-1":
+		r = RegionAPTokyo1
 	case "us-langley-1":
 		r = RegionUSLangley1
 	case "us-luke-1":

common/version.go

@@ -7,18 +7,15 @@ package example
 
 import (
 	"context"
-	"crypto/sha256"
 	"fmt"
 	"io"
-	"io/ioutil"
-	"math/rand"
 	"os"
 	"path"
-	"time"
 
 	"github.com/oracle/oci-go-sdk/common"
 	"github.com/oracle/oci-go-sdk/example/helpers"
 	"github.com/oracle/oci-go-sdk/objectstorage"
+	"github.com/oracle/oci-go-sdk/objectstorage/transfer"
 )
 
 // ExampleObjectStorage_UploadFile shows how to create a bucket and upload a file
@@ -34,7 +31,7 @@ func ExampleObjectStorage_UploadFile() {
 	defer deleteBucket(ctx, c, namespace, bname)
 
 	contentlen := 1024 * 1000
-	filepath, filesize := writeTempFileOfSize(int64(contentlen))
+	filepath, filesize := helpers.WriteTempFileOfSize(int64(contentlen))
 	filename := path.Base(filepath)
 	defer func() {
 		os.Remove(filename)
@@ -56,6 +53,111 @@ func ExampleObjectStorage_UploadFile() {
 	// delete bucket
 }
 
+func ExampleObjectStorage_UploadManager_UploadFile() {
+	c, clerr := objectstorage.NewObjectStorageClientWithConfigurationProvider(common.DefaultConfigProvider())
+	helpers.FatalIfError(clerr)
+
+	ctx := context.Background()
+	bname := "bname"
+	namespace := getNamespace(ctx, c)
+
+	createBucket(ctx, c, namespace, bname)
+	defer deleteBucket(ctx, c, namespace, bname)
+
+	contentlen := 1024 * 1000 * 300 // 300MB
+	filepath, _ := helpers.WriteTempFileOfSize(int64(contentlen))
+	filename := path.Base(filepath)
+	defer os.Remove(filename)
+
+	uploadManager := transfer.NewUploadManager()
+	objectName := "sampleFileUploadObj"
+
+	req := transfer.UploadFileRequest{
+		UploadRequest: transfer.UploadRequest{
+			NamespaceName: common.String(namespace),
+			BucketName:    common.String(bname),
+			ObjectName:    common.String(objectName),
+			//PartSize:      common.Int(10000000),
+		},
+		FilePath: filepath,
+	}
+
+	// if you want to overwrite default value, you can do it
+	// as: transfer.UploadRequest.AllowMultipartUploads = common.Bool(false) // default is true
+	// or: transfer.UploadRequest.AllowParrallelUploads = common.Bool(false) // default is true
+	resp, err := uploadManager.UploadFile(ctx, req)
+
+	if err != nil && resp.IsResumable() {
+		resp, err = uploadManager.ResumeUploadFile(ctx, *resp.MultipartUploadResponse.UploadID)
+		if err != nil {
+			fmt.Println(resp)
+		}
+	}
+
+	defer deleteObject(ctx, c, namespace, bname, objectName)
+	fmt.Println("file uploaded")
+
+	// Output:
+	// get namespace
+	// create bucket
+	// file uploaded
+	// delete object
+	// delete bucket
+}
+
+func ExampleObjectStorage_UploadManager_Stream() {
+	c, clerr := objectstorage.NewObjectStorageClientWithConfigurationProvider(common.DefaultConfigProvider())
+	helpers.FatalIfError(clerr)
+
+	ctx := context.Background()
+	bname := "bname"
+	namespace := getNamespace(ctx, c)
+
+	createBucket(ctx, c, namespace, bname)
+	defer deleteBucket(ctx, c, namespace, bname)
+
+	contentlen := 1024 * 1000 * 130 // 130MB
+	filepath, _ := helpers.WriteTempFileOfSize(int64(contentlen))
+	filename := path.Base(filepath)
+	defer func() {
+		os.Remove(filename)
+	}()
+
+	uploadManager := transfer.NewUploadManager()
+	objectName := "sampleStreamUploadObj"
+
+	file, _ := os.Open(filepath)
+	defer file.Close()
+
+	req := transfer.UploadStreamRequest{
+		UploadRequest: transfer.UploadRequest{
+			NamespaceName: common.String(namespace),
+			BucketName:    common.String(bname),
+			ObjectName:    common.String(objectName),
+		},
+		StreamReader: file, // any struct implements the io.Reader interface
+	}
+
+	// if you want to overwrite default value, you can do it
+	// as: transfer.UploadRequest.AllowMultipartUploads = common.Bool(false) // default is true
+	// or: transfer.UploadRequest.AllowParrallelUploads = common.Bool(false) // default is true
+	_, err := uploadManager.UploadStream(context.Background(), req)
+
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	defer deleteObject(ctx, c, namespace, bname, objectName)
+	fmt.Println("stream uploaded")
+
+	// Output:
+	// get namespace
+	// create bucket
+	// stream uploaded
+	// delete object
+	// delete bucket
+}
+
 func getNamespace(ctx context.Context, c objectstorage.ObjectStorageClient) string {
 	request := objectstorage.GetNamespaceRequest{}
 	r, err := c.GetNamespace(ctx, request)
@@ -115,15 +217,3 @@ func deleteBucket(ctx context.Context, c objectstorage.ObjectStorageClient, name
 	fmt.Println("delete bucket")
 	return
 }
-
-func writeTempFileOfSize(filesize int64) (fileName string, fileSize int64) {
-	hash := sha256.New()
-	f, _ := ioutil.TempFile("", "OCIGOSDKSampleFile")
-	ra := rand.New(rand.NewSource(time.Now().UnixNano()))
-	defer f.Close()
-	writer := io.MultiWriter(f, hash)
-	written, _ := io.CopyN(writer, ra, filesize)
-	fileName = f.Name()
-	fileSize = written
-	return
-}

example/example_objectstorage_test.go

@@ -115,4 +115,4 @@ func deleteStack(ctx context.Context, stackID string, client resourcemanager.Res
 	helpers.FatalIfError(err)
 
 	fmt.Println("delete stack completed")
-}
+}

example/example_resourcemanager_test.go

@@ -38,7 +38,7 @@ func ExampleRetry() {
 	}
 
 	nextDuration := func(r common.OCIOperationResponse) time.Duration {
-		// you might want wait longer for next retry when your previouse one failed
+		// you might want wait longer for next retry when your previous one failed
 		// this function will return the duration as:
 		// 1s, 2s, 4s, 8s, 16s, 32s, 64s etc...
 		return time.Duration(math.Pow(float64(2), float64(r.AttemptNumber-1))) * time.Second

example/example_retry_test.go

@@ -6,7 +6,10 @@
 package helpers
 
 import (
+	"crypto/sha256"
 	"fmt"
+	"io"
+	"io/ioutil"
 	"log"
 	"math"
 	"math/rand"
@@ -151,3 +154,16 @@ func GetRandomString(n int) string {
 	}
 	return string(b)
 }
+
+// WriteTempFileOfSize output random content to a file
+func WriteTempFileOfSize(filesize int64) (fileName string, fileSize int64) {
+	hash := sha256.New()
+	f, _ := ioutil.TempFile("", "OCIGOSDKSampleFile")
+	ra := rand.New(rand.NewSource(time.Now().UnixNano()))
+	defer f.Close()
+	writer := io.MultiWriter(f, hash)
+	written, _ := io.CopyN(writer, ra, filesize)
+	fileName = f.Name()
+	fileSize = written
+	return
+}

example/helpers/helper.go

@@ -15,7 +15,7 @@ import (
 )
 
 // AddHttpRequestHeaderRule An object that represents the action of adding a header to a request.
-// This rule applies only to HTTP or HTTP2 listeners.
+// This rule applies only to HTTP listeners.
 // **NOTES:**
 // *  If a matching header already exists in the request, the system removes all of its occurrences, and then adds the
 //    new header.

loadbalancer/add_http_request_header_rule.go

@@ -15,7 +15,7 @@ import (
 )
 
 // AddHttpResponseHeaderRule An object that represents the action of adding a header to a response.
-// This rule applies only to HTTP or HTTP2 listeners.
+// This rule applies only to HTTP listeners.
 // **NOTES:**
 // *  If a matching header already exists in the response, the system removes all of its occurrences, and then adds the
 //    new header.

loadbalancer/add_http_response_header_rule.go

@@ -14,7 +14,7 @@ import (
 	"github.com/oracle/oci-go-sdk/common"
 )
 
-// ExtendHttpRequestHeaderValueRule An object that represents the action of modifying a request header value. This rule applies only to HTTP or HTTP2 listeners.
+// ExtendHttpRequestHeaderValueRule An object that represents the action of modifying a request header value. This rule applies only to HTTP listeners.
 // This rule adds a prefix, a suffix, or both to the header value.
 // **NOTES:**
 // *  This rule requires a value for a prefix, suffix, or both.

loadbalancer/extend_http_request_header_value_rule.go

@@ -14,7 +14,7 @@ import (
 	"github.com/oracle/oci-go-sdk/common"
 )
 
-// ExtendHttpResponseHeaderValueRule An object that represents the action of modifying a response header value. This rule applies only to HTTP or HTTP2 listeners.
+// ExtendHttpResponseHeaderValueRule An object that represents the action of modifying a response header value. This rule applies only to HTTP listeners.
 // This rule adds a prefix, a suffix, or both to the header value.
 // **NOTES:**
 // *  This rule requires a value for a prefix, suffix, or both.

loadbalancer/extend_http_response_header_value_rule.go

@@ -20,7 +20,7 @@ type HealthCheckResult struct {
 	SubnetId *string `mandatory:"true" json:"subnetId"`
 
 	// The IP address of the health check status report provider. This identifier helps you differentiate same-subnet
-	// (private) load balancers that report health check status.
+	// load balancers that report health check status.
 	// Example: `10.0.0.7`
 	SourceIpAddress *string `mandatory:"true" json:"sourceIpAddress"`
 

loadbalancer/health_check_result.go

@@ -410,7 +410,8 @@ func (client LoadBalancerClient) createPathRouteSet(ctx context.Context, request
 	return response, err
 }
 
-// CreateRuleSet Creates a new rule set associated with the specified load balancer.
+// CreateRuleSet Creates a new rule set associated with the specified load balancer. For more information, see
+// Managing Rule Sets (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrulesets.htm).
 func (client LoadBalancerClient) CreateRuleSet(ctx context.Context, request CreateRuleSetRequest) (response CreateRuleSetResponse, err error) {
 	var ociResponse common.OCIResponse
 	policy := common.NoRetryPolicy()

loadbalancer/loadbalancer_client.go

@@ -14,7 +14,7 @@ import (
 	"github.com/oracle/oci-go-sdk/common"
 )
 
-// RemoveHttpRequestHeaderRule An object that represents the action of removing a header from a request. This rule applies only to HTTP or HTTP2 listeners.
+// RemoveHttpRequestHeaderRule An object that represents the action of removing a header from a request. This rule applies only to HTTP listeners.
 // If the same header appears more than once in the request, the load balancer removes all occurances of the specified header.
 // **NOTE:** The system does not distinquish between underscore and dash characters in headers. That is, it treats
 // `example_header_name` and `example-header-name` as identical. Oracle recommends that you do not rely on underscore

loadbalancer/remove_http_request_header_rule.go

@@ -14,7 +14,7 @@ import (
 	"github.com/oracle/oci-go-sdk/common"
 )
 
-// RemoveHttpResponseHeaderRule An object that represents the action of removing a header from a response. This rule applies only to HTTP or HTTP2 listeners.
+// RemoveHttpResponseHeaderRule An object that represents the action of removing a header from a response. This rule applies only to HTTP listeners.
 // If the same header appears more than once in the response, the load balancer removes all occurances of the specified header.
 // **NOTE:** The system does not distinquish between underscore and dash characters in headers. That is, it treats
 // `example_header_name` and `example-header-name` as identical. Oracle recommends that you do not rely on underscore

loadbalancer/remove_http_response_header_rule.go

@@ -15,7 +15,8 @@ import (
 )
 
 // RuleSet A named set of rules associated with a load balancer. Rules are objects that represent actions to apply to a listener,
-// such as adding, altering, or removing HTTP headers.
+// such as adding, altering, or removing HTTP headers. For more information, see
+// Managing Rule Sets (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrulesets.htm).
 type RuleSet struct {
 
 	// The name for this set of rules. It must be unique and it cannot be changed. Avoid entering