Merge pull request #217 from tencentyun/feature_jojoliang_a7d2e3b2

add object symlink

Author: agin719

cos.go

@@ -24,7 +24,7 @@ import (
 
 const (
 	// Version current go sdk version
-	Version               = "0.7.45"
+	Version               = "0.7.46"
 	UserAgent             = "cos-go-sdk-v5/" + Version
 	contentTypeXML        = "application/xml"
 	defaultServiceBaseURL = "http://service.cos.myqcloud.com"

example/object/symlink.go

@@ -0,0 +1,84 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"io/ioutil"
+	"net/url"
+	"os"
+	"strings"
+
+	"net/http"
+
+	"github.com/tencentyun/cos-go-sdk-v5"
+	"github.com/tencentyun/cos-go-sdk-v5/debug"
+)
+
+func log_status(err error) {
+	if err == nil {
+		return
+	}
+	if cos.IsNotFoundError(err) {
+		// WARN
+		fmt.Println("WARN: Resource is not existed")
+	} else if e, ok := cos.IsCOSError(err); ok {
+		fmt.Printf("ERROR: Code: %v\n", e.Code)
+		fmt.Printf("ERROR: Message: %v\n", e.Message)
+		fmt.Printf("ERROR: Resource: %v\n", e.Resource)
+		fmt.Printf("ERROR: RequestId: %v\n", e.RequestID)
+		// ERROR
+	} else {
+		fmt.Printf("ERROR: %v\n", err)
+		// ERROR
+	}
+}
+
+func main() {
+	// 存储桶名称，由bucketname-appid 组成，appid必须填入，可以在COS控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucket
+	// 替换为用户的 region，存储桶region可以在COS控制台“存储桶概览”查看 https://console.cloud.tencent.com/ ，关于地域的详情见 https://cloud.tencent.com/document/product/436/6224 。
+	u, _ := url.Parse("https://test-1259654469.cos.ap-guangzhou.myqcloud.com")
+	b := &cos.BaseURL{BucketURL: u}
+	c := cos.NewClient(b, &http.Client{
+		Transport: &cos.AuthorizationTransport{
+			// 通过环境变量获取密钥
+			// 环境变量 COS_SECRETID 表示用户的 SecretId，登录访问管理控制台查看密钥，https://console.cloud.tencent.com/cam/capi
+			SecretID: os.Getenv("COS_SECRETID"),
+			// 环境变量 COS_SECRETKEY 表示用户的 SecretKey，登录访问管理控制台查看密钥，https://console.cloud.tencent.com/cam/capi
+			SecretKey: os.Getenv("COS_SECRETKEY"),
+			// Debug 模式，把对应 请求头部、请求内容、响应头部、响应内容 输出到标准输出
+			Transport: &debug.DebugRequestTransport{
+				RequestHeader: true,
+				// Notice when put a large file and set need the request body, might happend out of memory error.
+				RequestBody:    false,
+				ResponseHeader: true,
+				ResponseBody:   false,
+			},
+		},
+	})
+
+	// Case1 上传对象
+	target := "example"
+	_, err := c.Object.Put(context.Background(), target, strings.NewReader("test"), nil)
+	log_status(err)
+
+	key := "sym"
+	opt := &cos.ObjectPutSymlinkOptions{
+		SymlinkTarget: target,
+	}
+	_, err = c.Object.PutSymlink(context.Background(), key, opt)
+	log_status(err)
+
+	res, _, err := c.Object.GetSymlink(context.Background(), key, nil)
+	log_status(err)
+	fmt.Printf("res: %v\n", res)
+
+	resp, err := c.Object.Get(context.Background(), key, nil)
+	log_status(err)
+	defer resp.Body.Close()
+
+	bs, _ := ioutil.ReadAll(resp.Body)
+	fmt.Printf("body: %v\n", string(bs))
+
+	_, err = c.Object.Delete(context.Background(), key, nil)
+	log_status(err)
+}

object.go

@@ -1706,3 +1706,39 @@ func (s *ObjectService) GetFetchTask(ctx context.Context, bucket string, taskid
 	}
 	return &res, resp, err
 }
+
+type ObjectPutSymlinkOptions struct {
+	SymlinkTarget string       `header:"x-cos-symlink-target" url:"-"`
+	XOptionHeader *http.Header `header:"-,omitempty" url:"-" xml:"-"`
+}
+
+type ObjectGetSymlinkOptions struct {
+	XOptionHeader *http.Header `header:"-,omitempty" url:"-" xml:"-"`
+}
+
+func (s *ObjectService) PutSymlink(ctx context.Context, name string, opt *ObjectPutSymlinkOptions) (*Response, error) {
+	if opt == nil || opt.SymlinkTarget == "" {
+		return nil, errors.New("SymlinkTarget is empty")
+	}
+	sendOpt := &sendOptions{
+		baseURL:   s.client.BaseURL.BucketURL,
+		uri:       "/" + encodeURIComponent(name) + "?symlink",
+		method:    http.MethodPut,
+		optHeader: opt,
+	}
+	resp, err := s.client.doRetry(ctx, sendOpt)
+	return resp, err
+}
+
+func (s *ObjectService) GetSymlink(ctx context.Context, name string, opt *ObjectGetSymlinkOptions) (string, *Response, error) {
+	sendOpt := &sendOptions{
+		baseURL: s.client.BaseURL.BucketURL,
+		uri:     "/" + encodeURIComponent(name) + "?symlink",
+		method:  http.MethodGet,
+	}
+	resp, err := s.client.doRetry(ctx, sendOpt)
+	if err != nil || resp == nil {
+		return "", resp, err
+	}
+	return resp.Header.Get("x-cos-symlink-target"), resp, err
+}

object_test.go

@@ -1646,3 +1646,50 @@ func TestObjectService_checkUploadedParts(t *testing.T) {
 		t.Fatalf("Object.checkUploadedParts should return err: %v", err)
 	}
 }
+
+func TestObjectService_PutSymlink(t *testing.T) {
+	setup()
+	defer teardown()
+
+	name := "symlink"
+	mux.HandleFunc("/"+name, func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "PUT")
+		vs := values{
+			"symlink": "",
+		}
+		testFormValues(t, r, vs)
+		testHeader(t, r, "x-cos-symlink-target", "target")
+	})
+
+	opt := &ObjectPutSymlinkOptions{
+		SymlinkTarget: "target",
+	}
+	_, err := client.Object.PutSymlink(context.Background(), name, opt)
+	if err != nil {
+		t.Fatalf("Object.PutSymlink  returned error %v", err)
+	}
+}
+
+func TestObjectService_GetSymlink(t *testing.T) {
+	setup()
+	defer teardown()
+
+	name := "symlink"
+	want := "target"
+	mux.HandleFunc("/"+name, func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		vs := values{
+			"symlink": "",
+		}
+		testFormValues(t, r, vs)
+		w.Header().Set("x-cos-symlink-target", want)
+	})
+
+	res, _, err := client.Object.GetSymlink(context.Background(), name, nil)
+	if err != nil {
+		t.Fatalf("Object.GetSymlink returned error %v", err)
+	}
+	if res != want {
+		t.Fatalf("Object.GetSymlink, target is invalid, return: %v, want: %v", res, want)
+	}
+}