conflict-fix

Author: jxyowen

.travis.yml

@@ -1,23 +1,29 @@
 language: go
 
-sudo: false
+sudo: true
 
 go:
-  - 1.7.x
   - 1.8.x
-  - 1.9.x
-  - 1.10.x
+
+branches:
+  only:
+    - master
+    - pre-release
+
+before_install:
+  - sudo apt-get install -y jq
 
 install:
   - make deps
   - make testdeps
 
 notifications:
-    #webhooks: https://oapi.dingtalk.com/robot/send?access_token=096ed387df243a6d60835aadeccc47165f3813bc7cb81cdd0cfeadfd28e3acc1
+    webhooks: https://oapi.dingtalk.com/robot/send?access_token=096ed387df243a6d60835aadeccc47165f3813bc7cb81cdd0cfeadfd28e3acc1
     email: false
     on_success: change
     on_failure: always
 
 script:
   - make build
-  - go test -v -timeout 30m ./...
+  - sudo cp out/aliyun /usr/local/bin
+  - cd ./integration && ./test

CHANGELOG.md

@@ -1,5 +1,25 @@
 # CHANGE LOG
 
+### 3.0.1 Final Version
+
+- support `version` command
+- fix `--dryrun` flag bugs
+-
+
+### 3.0.0 GA Version
+
+- refactoring cli package design, support composite flag with fields
+- refactoring openapi package design, make it more extensible
+- support `--quiet` flag
+- support `--dryrun` flag
+- support `aliyun oss --profile xxx`
+
+### 0.81
+
+- support `--output`
+- support `--waiter`
+- use `go -ldflags` to enable single Version in Makefile
+
 ### 0.80
 
 - support auto completion for zsh/bash

Makefile

@@ -1,4 +1,4 @@
-export VERSION=0.80
+export VERSION=3.0.1
 
 all: build
 publish: build build_mac build_linux build_windows
@@ -15,14 +15,15 @@ deps:
 	go get github.com/aliyun/alibaba-cloud-sdk-go/sdk
 	go get github.com/posener/complete
 	go get github.com/aliyun/ossutil/lib
+	go get gopkg.in/yaml.v2
 
-testdeps:
+testdeps: deps
 	go get -v github.com/onsi/ginkgo/ginkgo
 	go get -v github.com/onsi/gomega
 	go install github.com/onsi/ginkgo/ginkgo
 	go get gopkg.in/check.v1
 
-metas:
+metas: deps
 	go-bindata -o resource/metas.go -pkg resource -prefix ../aliyun-openapi-meta ../aliyun-openapi-meta/**/* ../aliyun-openapi-meta/products.json
 
 clean:
@@ -38,16 +39,16 @@ install: build
 build_mac:
 	GOOS=darwin GOARCH=amd64 go build -o out/aliyun main/main.go
 	tar zcvf out/aliyun-cli-macosx-${VERSION}-amd64.tgz -C out aliyun
-	aliyun oss cp out/aliyun-cli-macosx-${VERSION}-amd64.tgz oss://aliyun-cli --force
+	aliyun oss cp out/aliyun-cli-macosx-${VERSION}-amd64.tgz oss://aliyun-cli --force --profile oss
 
 build_linux:
 	GOOS=linux GOARCH=amd64 go build -o out/aliyun main/main.go
 	tar zcvf out/aliyun-cli-linux-${VERSION}-amd64.tgz -C out aliyun
-	aliyun oss cp out/aliyun-cli-linux-${VERSION}-amd64.tgz oss://aliyun-cli --force
+	aliyun oss cp out/aliyun-cli-linux-${VERSION}-amd64.tgz oss://aliyun-cli --force --profile oss
 
 build_windows:
 	GOOS=windows GOARCH=amd64 go build -o aliyun.exe main/main.go
 	zip -r out/aliyun-cli-windows-${VERSION}-amd64.zip aliyun.exe
-	aliyun oss cp out/aliyun-cli-windows-${VERSION}-amd64.zip oss://aliyun-cli --force
+	aliyun oss cp out/aliyun-cli-windows-${VERSION}-amd64.zip oss://aliyun-cli --force --profile oss
 	rm aliyun.exe
 

README.md

@@ -1,10 +1,11 @@
 # Aliyun Command Line Interface
+[![Build Status](https://travis-ci.org/aliyun/aliyun-cli.svg?branch=master)](https://travis-ci.org/aliyun/aliyun-cli) 
 
 [中文文档](./README_zh.md)
 
 The Alibaba Cloud CLI is an open source tool, you can get the latest version from [GitHub](https://github.com/aliyun/aliyun-cli).
 
-This version is a new version built on Go. The new CLI is in the testing phase.  If you want to use the old version (built on Alibaba Cloud Python SDK), click [here](https://github.com/aliyun/aliyun-cli/tree/python_final).
+This version is a new version built on Go. If you want to use the old version (built on Alibaba Cloud Python SDK), click [here](https://github.com/aliyun/aliyun-cli/tree/python_final).
 
 ## Introduction
 
@@ -22,17 +23,11 @@ You can install Alibaba Cloud CLI either through the installer or the source cod
 
 	Download the installer, then extract the installer. You can move the extracted `aliyun` executable file to the `/usr/local/bin` directory or add it to the `$PATH`.
 
-	Download link: (0.80 Beta)
+	Download link: (3.0.1)
 
-	- [Mac](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-macosx-0.70-amd64.tgz)
-	- [Linux](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-linux-0.70-amd64.tgz)
-	- [Windows (64 bit)](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-windows-0.70-amd64.zip)
-
-    Download link: (0.70 Beta)
-
-	- [Mac](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-macosx-0.60-amd64.tgz)
-	- [Linux](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-linux-0.60-amd64.tgz)
-	- [Windows (64 bit)](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-windows-0.60-amd64.zip)
+	- [Mac](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-macosx-3.0.1-amd64.tgz)
+	- [Linux](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-linux-3.0.1-amd64.tgz)
+	- [Windows (64 bit)](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-windows-3.0.1-amd64.zip)
 
 - **Compile source code**
 

README_zh.md

@@ -1,8 +1,9 @@
 # 阿里云命令行工具 (Aliyun Command Line Interface)
+[![Build Status](https://travis-ci.org/aliyun/aliyun-cli.svg?branch=master)](https://travis-ci.org/aliyun/aliyun-cli) 
 
 阿里云命令行工具（Alibaba Cloud Command Line Interface）是开源项目，您可以从[Github](https://github.com/aliyun/aliyun-cli)上获取最新版本的CLI。
 
-该版本的CLI为Go语言重构版本，目前处于**BETA**发布中，如果您想使用原有的Python版本，请切换到[Python分支](https://github.com/aliyun/aliyun-cli/tree/python_final)。
+该版本的CLI为Go语言重构版本，如果您想使用原有的Python版本，请切换到[Python分支](https://github.com/aliyun/aliyun-cli/tree/python_final)。
 
 ## 简介
 
@@ -21,17 +22,11 @@
 
 	阿里云CLI工具下载、解压后即可使用，支持Mac, Linux, Windows平台(x64版本)。	您可以将解压的`aliyun`可执行文件移至`/usr/local/bin`目录下，或添加到`$PATH`中。
 
-	下载链接如下 (0.80 Beta)：
+	下载链接如下 (3.0.1)：
 
-	- [Mac](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-macosx-0.70-amd64.tgz)
-	- [Linux](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-linux-0.70-amd64.tgz)
-	- [Windows (64 bit)](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-windows-0.70-amd64.zip)
-
-    下载链接如下: (0.70 Beta)
-
-	- [Mac](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-macosx-0.60-amd64.tgz)
-	- [Linux](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-linux-0.60-amd64.tgz)
-	- [Windows (64 bit)](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-windows-0.60-amd64.zip)
+	- [Mac](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-macosx-3.0.1-amd64.tgz)
+	- [Linux](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-linux-3.0.1-amd64.tgz)
+	- [Windows (64 bit)](http://aliyun-cli.oss-cn-hangzhou.aliyuncs.com/aliyun-cli-windows-3.0.1-amd64.zip)
 
 - **编译源码**
 
@@ -169,4 +164,67 @@ $ aliyun newproduct --version 2018-01-01 --endpoint newproduct.aliyuncs.com --pa
 在使用`--force`参数时，必须指定以下两个参数：
 
 - `--version`: 指定API的版本，你可以在API文档中找到版本号，如ECS的版本号是`2014-05-26`。
-- `--endpoint`: 指定产品的接入地址，一般产品接入地址是`product.aliyuncs.com`，或`product.en-central-1.aliyuncs.com`，请参考各产品的API文档。
+- `--endpoint`: 指定产品的接入地址，一般产品接入地址是`product.aliyuncs.com`，或`product.en-central-1.aliyuncs.com`，请参考各产品的API文档。
+
+#### 使用`--output`参数
+
+阿里云产品的查询接口会返回json结构化数据，不方便阅读。例如：
+
+```
+$ aliyun ecs DescribeInstances
+```
+
+执行以上命令将得到以下json结果：
+
+```
+{
+  "PageNumber": 1,
+  "TotalCount": 2,
+  "PageSize": 10,
+  "RequestId": "2B76ECBD-A296-407E-BE17-7E668A609DDA",
+  "Instances": {
+    "Instance": [
+      {
+        "ImageId": "ubuntu_16_0402_64_20G_alibase_20171227.vhd",
+        "InstanceTypeFamily": "ecs.xn4",
+        "VlanId": "",
+        "InstanceId": "i-12345678912345678123",
+        "Status": "Stopped",
+        //omit some fields
+      },
+      Instance": [
+      {
+        "ImageId": "ubuntu_16_0402_64_20G_alibase_20171227.vhd",
+        "InstanceTypeFamily": "ecs.xn4",
+        "VlanId": "",
+        "InstanceId": "i-abcdefghijklmnopqrst",
+        "Status": "Running",
+        //omit some fields
+      },
+    ]
+  }
+}
+```
+
+可以使用`--output`参数提取结果中感兴趣的字段，并进行表格化输出。例如：
+
+
+```
+$ aliyun ecs DescribeInstances --output cols=InstanceId,Status
+```
+
+执行以上命令将得到以下形式的结果：
+```
+InstanceId             | Status
+----------             | ------
+i-12345678912345678123 | Stopped
+i-abcdefghijklmnopqrst | Running
+```
+
+在使用`--output`参数时，必须指定以下参数：
+
+- `--cols`: 表格的列名，需要与json数据中的字段相对应。如ECS DescribeInstances 接口返回结果中的字段`InstanceId` 以及 `Status`。
+
+可选参数：
+- `--rows`: 通过[jmespath](http://jmespath.org/)查询语句来指定表格行在json结果中的数据来源。当查询语句具有`Instances.Instance[]`的形式时，可以省略该参数。
+

cli/README.md

@@ -25,9 +25,14 @@ Because aliyun cli need process unknown flags,and the following popular library
 ### TODO
 
 - [x] Suggestions
-- [ ] Support shorthand flag, -a -b
-- [ ] Flag alias
-- [ ] Auto complete framework
+- [x] Support shorthand flag, -a -b
+- [x] Flag alias
+- [x] Auto complete framework
 - [ ] Help document generation (ref: https://github.com/spf13/cobra#generating-documentation-for-your-command)
 - [ ] Optimize --help message view
+- [ ] Support `help --waiter`
+- [x] Support Group Options
+- [x] Optimize noticeable error
+- [ ] (low)Support shorthand combination -ab
+
 

cli/command.go

@@ -121,7 +121,7 @@ func (c *Command) ExecuteComplete(ctx *Context, args []string) {
 			if f.Hidden {
 				continue
 			}
-			if !strings.HasPrefix("--"+f.Name, ctx.completion.Current) {
+			if !strings.HasPrefix("--" + f.Name, ctx.completion.Current) {
 				continue
 			}
 			fmt.Printf("--%s\n", f.Name)
@@ -178,7 +178,7 @@ func (c *Command) executeInner(ctx *Context, args []string) error {
 		}
 	}
 
-	//
+	// cmd is find by args, try run cmd.Run
 	// parse remain args
 	remainArgs, err := parser.ReadAll()
 	if err != nil {
@@ -192,7 +192,7 @@ func (c *Command) executeInner(ctx *Context, args []string) error {
 		return err
 	}
 
-	if ctx.flags.IsAssigned("help", "") {
+	if HelpFlag.IsAssigned() {
 		ctx.help = true
 	}
 	callArgs := make([]string, 0)
@@ -231,36 +231,22 @@ func (c *Command) executeInner(ctx *Context, args []string) error {
 }
 
 func (c *Command) processError(err error) {
-	//
-	// process error
-	//if e, ok := err.(PrintableError); ok {
-	//	Errorf("error: %s\n", e.GetText(i18n.GetLanguage()))
-	//} else {
 	Errorf("ERROR: %s\n", err.Error())
-	//	}
-
 	if e, ok := err.(SuggestibleError); ok {
-		ss := e.GetSuggestions()
-		if len(ss) > 0 {
-			Noticef("\ndid you mean: \n  %s \n", ss[0])
-		}
+		PrintSuggestions(i18n.GetLanguage(), e.GetSuggestions())
+		return
+	}
+	if e, ok := err.(ErrorWithTip); ok {
+		Noticef("\n%s\n", e.GetTip(i18n.GetLanguage()))
+		return
 	}
 }
 
 func (c *Command) executeHelp(ctx *Context, args []string) {
 	if c.Help != nil {
 		err := c.Help(ctx, args)
 		if err != nil {
-			Errorf("Error: %s\n", err)
-		}
-		if se, ok := err.(SuggestibleError); ok {
-			ss := se.GetSuggestions()
-			if len(ss) > 0 {
-				Noticef("\nDid you mean:\n")
-				for _, s := range ss {
-					Noticef("  %s\n", s)
-				}
-			}
+			c.processError(err)
 		}
 		return
 	}

cli/command_help.go

@@ -43,7 +43,7 @@ func (c *Command) PrintSubCommands() {
 }
 
 func (c *Command) PrintFlags(ctx *Context) {
-	if len(c.flags.Flags()) == 0 {
+	if len(c.Flags().Flags()) == 0 {
 		return
 	}
 
@@ -57,11 +57,11 @@ func (c *Command) PrintFlags(ctx *Context) {
 		if flag.Hidden {
 			continue
 		}
-		format := "--%s\t%s\n"
-		if flag.Shorthand != "" {
-			format = fmt.Sprintf("-%s, %s", flag.Shorthand, format)
+		s := "--" + flag.Name
+		if flag.Shorthand != 0 {
+			s = s + ",-" + string(flag.Shorthand)
 		}
-		fmt.Fprintf(w, "  "+format, flag.Name, flag.Usage.Text())
+		fmt.Fprintf(w, "  %s\t%s\n", s, flag.Short.Text())
 	}
 	w.Flush()
 }

cli/completion_installer.go

@@ -1,10 +1,18 @@
+/*
+ * Copyright (C) 2017-2018 Alibaba Group Holding Limited
+ */
 package cli
 
 import (
 	"fmt"
 	"github.com/aliyun/aliyun-cli/i18n"
 )
 
+var uninstallFlag = &Flag{
+	Name:  "uninstall",
+	Short: i18n.T("uninstall auto completion", "卸载自动完成"),
+}
+
 func NewAutoCompleteCommand() *Command {
 	cmd := &Command{
 		Name: "auto-completion",
@@ -20,18 +28,15 @@ func NewAutoCompleteCommand() *Command {
 			//	// i = append(i, zshInstaller{f})
 			//	fmt.Printf("zshInstaller: %s\n", f)
 			//}
-			if ctx.flags.IsAssigned("uninstall", "") {
+			if uninstallFlag.IsAssigned() {
 				uninstallCompletion("aliyun")
 			} else {
 				installCompletion("aliyun")
 			}
 			return nil
 		},
 	}
-	cmd.Flags().Add(Flag{
-		Name:  "uninstall",
-		Usage: i18n.T("uninstall auto completion", "卸载自动完成"),
-	})
+	cmd.Flags().Add(uninstallFlag)
 	return cmd
 }