Support for adding custom UserAgent ID (#181)

Author: night556

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ### Master
 
+- Support environment variable `ALIBABA_CLOUD_VENDOR`
+  > Set environment variables `ALIBABA_CLOUD_VENDOR` to add a custom UserAgent ID
 - Update API meta data, and update endpoint pattern of product cr
 - Update gosdk dependence
 - Change logic of flag `--pager`

config/hello.go

@@ -5,6 +5,8 @@ package config
 
 import (
 	"fmt"
+	"os"
+
 	"github.com/aliyun/alibaba-cloud-sdk-go/services/ecs"
 	"github.com/aliyun/aliyun-cli/cli"
 )
@@ -24,6 +26,9 @@ func GetRegions(ctx *cli.Context, profile *Profile) ([]Region, error) {
 
 	request := ecs.CreateDescribeRegionsRequest()
 	response := ecs.CreateDescribeRegionsResponse()
+	if vendorEnv, ok := os.LookupEnv("ALIBABA_CLOUD_VENDOR"); ok {
+		client.AppendUserAgent("vendor", vendorEnv)
+	}
 	client.AppendUserAgent("Aliyun-CLI", cli.GetVersion())
 	err = client.DoAction(request, response)
 
@@ -53,6 +58,9 @@ func DoHello(ctx *cli.Context, profile *Profile) {
 	}
 	request := ecs.CreateDescribeRegionsRequest()
 	response := ecs.CreateDescribeRegionsResponse()
+	if vendorEnv, ok := os.LookupEnv("ALIBABA_CLOUD_VENDOR"); ok {
+		client.AppendUserAgent("vendor", vendorEnv)
+	}
 	client.AppendUserAgent("Aliyun-CLI", cli.GetVersion())
 	err = client.DoAction(request, response)
 

config/hello_test.go

@@ -5,6 +5,8 @@ package config
 
 import (
 	"bytes"
+	"os"
+	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -30,6 +32,8 @@ func TestGetRegions(t *testing.T) {
 }
 
 func TestDoHello(t *testing.T) {
+	os.Setenv("ALIBABA_CLOUD_VENDOR", "cli_test_VendorTest")
+
 	w := new(bytes.Buffer)
 	ctx := cli.NewCommandContext(w)
 	ctx.Flags().AddByName("skip-secure-verify")
@@ -46,6 +50,7 @@ func TestDoHello(t *testing.T) {
 	assert.Equal(t, exw, w.String())
 
 	w.Reset()
+	os.Setenv("DEBUG", "sdk")
 	profile.AccessKeyId = "AccessKeyId"
 	profile.AccessKeySecret = "AccessKeySecret"
 	profile.RegionId = "cn-hangzhou"
@@ -55,4 +60,5 @@ func TestDoHello(t *testing.T) {
 
 	}()
 	DoHello(ctx, &profile)
+	assert.True(t, strings.Contains(w.String(), "vender/cli_test_VendorTest"))
 }

openapi/invoker.go

@@ -5,14 +5,16 @@ package openapi
 
 import (
 	"fmt"
+	"os"
+	"strings"
+
 	"github.com/aliyun/alibaba-cloud-sdk-go/sdk"
 	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
 	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/responses"
 	"github.com/aliyun/aliyun-cli/cli"
 	"github.com/aliyun/aliyun-cli/config"
 	"github.com/aliyun/aliyun-cli/i18n"
 	"github.com/aliyun/aliyun-cli/meta"
-	"strings"
 )
 
 //
@@ -63,7 +65,9 @@ func (a *BasicInvoker) Init(ctx *cli.Context, product *meta.Product) error {
 	if err != nil {
 		return fmt.Errorf("init client failed %s", err)
 	}
-
+	if vendorEnv, ok := os.LookupEnv("ALIBABA_CLOUD_VENDOR"); ok {
+		a.client.AppendUserAgent("vendor", vendorEnv)
+	}
 	a.client.AppendUserAgent("Aliyun-CLI", cli.GetVersion())
 	a.request = requests.NewCommonRequest()
 	a.request.Product = product.Code

openapi/invoker_test.go

@@ -1,12 +1,13 @@
 package openapi
 
 import (
-	"bufio"
+	"bytes"
+	"testing"
+
 	"github.com/aliyun/aliyun-cli/cli"
 	"github.com/aliyun/aliyun-cli/config"
 	"github.com/aliyun/aliyun-cli/meta"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 func TestBasicInvoker_Init(t *testing.T) {
@@ -20,7 +21,7 @@ func TestBasicInvoker_Init(t *testing.T) {
 	req := invooker.getRequest()
 	assert.Nil(t, req)
 
-	w := new(bufio.Writer)
+	w := new(bytes.Buffer)
 	ctx := cli.NewCommandContext(w)
 
 	regionflag := config.NewRegionFlag()