chore: support more commands && add tests

Author: exceptionplayer

build.sh

@@ -2,5 +2,3 @@
 # doc https://stackoverflow.com/questions/3861634/how-to-reduce-compiled-file-size
 go clean
 go build -ldflags "-w" 
-
-

cmd/cmd.go

@@ -8,6 +8,12 @@ import (
 	"medusar.org/zooklient/util"
 )
 
+//SupportedCmds stores all the supported commands for zookeeper
+var SupportedCmds = []ZkCmd{
+	&LsCmd{}, &GetCmd{}, &StatCmd{}, &SetCmd{},
+	&DeleteCmd{}, &CreateCmd{}, &DeleteAllCmd{},
+}
+
 //ZkCmd represents a console command of zk client
 type ZkCmd interface {
 	//Usage get the usage information of the cmd
@@ -190,3 +196,25 @@ func ParseCreate(args []string) (*CreateCmd, error) {
 	acl := cmd.Arg(2)
 	return &CreateCmd{HasS: *hasS, HasE: *hasE, HasC: *hasC, HasT: hasT, TTL: *ttl, Path: path, Data: data, ACL: acl}, nil
 }
+
+//DeleteAllCmd stores all the parameters followed by `deleteall`,
+//usage: deleteall path
+type DeleteAllCmd struct {
+	Path string
+}
+
+func (*DeleteAllCmd) Usage() string {
+	return "deleteall path"
+}
+
+func ParseDeleteAll(args []string) (*DeleteAllCmd, error) {
+	cmd := flag.NewFlagSet("deleteall", flag.ContinueOnError)
+	if err := cmd.Parse(args); err != nil {
+		return nil, err
+	}
+	path := cmd.Arg(0)
+	if path == "" {
+		return nil, fmt.Errorf("deleteall path")
+	}
+	return &DeleteAllCmd{path}, nil
+}

main.go

@@ -186,7 +186,6 @@ func execZkCmd(con *zk.Conn, cmd string, args []string) error {
 				printChildren(children, stat)
 			}
 		}
-		break
 	case "get":
 		get, err := cmdParser.ParseGet(args)
 		if err != nil {
@@ -204,7 +203,6 @@ func execZkCmd(con *zk.Conn, cmd string, args []string) error {
 		if get.WithStat {
 			printStat(stat)
 		}
-		break
 	case "stat":
 		statCmd, err := cmdParser.ParseStat(args)
 		if err != nil {
@@ -218,7 +216,6 @@ func execZkCmd(con *zk.Conn, cmd string, args []string) error {
 			return fmt.Errorf("Node does not exist: %s", statCmd.Path)
 		}
 		printStat(stat)
-		break
 	case "set":
 		set, err := cmdParser.ParseSet(args)
 		if err != nil {
@@ -231,7 +228,6 @@ func execZkCmd(con *zk.Conn, cmd string, args []string) error {
 		if set.WithStat {
 			printStat(stat)
 		}
-		break
 	case "create":
 		create, err := cmdParser.ParseCreate(args)
 		if err != nil {
@@ -286,20 +282,20 @@ func execZkCmd(con *zk.Conn, cmd string, args []string) error {
 			return err
 		}
 		fmt.Println("Created", s)
-		break
 	case "getAcl":
-		fmt.Println("Not supported yet")
-		break
+		fallthrough
 	case "setAcl":
-		fmt.Println("Not supported yet")
-		break
+		fallthrough
 	case "setquota":
+		fallthrough
 	case "listquota":
+		fallthrough
 	case "delquota":
+		fallthrough
 	case "addauth":
+		fallthrough
 	case "config":
 		fmt.Println("Not supported yet")
-		break
 	case "sync":
 		if len(args) != 1 {
 			return fmt.Errorf("sync path")
@@ -309,7 +305,6 @@ func execZkCmd(con *zk.Conn, cmd string, args []string) error {
 			return err
 		}
 		fmt.Println("Sync is OK")
-		break
 	case "delete":
 		del, err := cmdParser.ParseDelete(args)
 		if err != nil {
@@ -318,17 +313,17 @@ func execZkCmd(con *zk.Conn, cmd string, args []string) error {
 		if err := con.Delete(del.Path, del.Version); err != nil {
 			return err
 		}
-		break
 	case "deleteall":
-		fmt.Println("Not supported yet")
-		break
+		da, err := cmdParser.ParseDeleteAll(args)
+		if err != nil {
+			return err
+		}
+		return deleteRecursive(zkconn.con, da.Path)
 	case "close":
 		con.Close()
-		break
 	default:
 		printUsage()
 		fmt.Println("Command not found: Command not found", cmd)
-		break
 	}
 	return nil
 }
@@ -340,34 +335,60 @@ func saveHistory(cmd string) {
 	}
 }
 
-//TODO: print only supported cmds
 func printUsage() {
-	fmt.Println(`ZooKeeper -server host:port cmd args
-		addauth scheme auth
-		close
-		config [-c] [-w] [-s]
-		connect host:port
-		create [-s] [-e] [-c] [-t ttl] path [data] [acl]
-		delete [-v version] path
-		deleteall path
-		delquota [-n|-b] path
-		get [-s] [-w] path
-		getAcl [-s] path
-		history
-		listquota path
-		ls [-s] [-w] [-R] path
-		ls2 path [watch]
-		printwatches on|off
-		quit
-		reconfig [-s] [-v version] [[-file path] | [-members serverID=host:port1:port2;port3[,...]*]] | [-add serverId=host:port1:port2;port3[,...]]* [-remove serverId[,...]*]
-		redo cmdno
-		removewatches path [-c|-d|-a] [-l]
-		rmr path
-		set [-s] [-v version] path data
-		setAcl [-s] [-v version] [-R] path acl
-		setquota -n|-b val path
-		stat [-w] path
-		sync path`)
+	fmt.Println("ZooKeeper -server host:port cmd args")
+	fmt.Println("\t\t connect host:port")
+	fmt.Println("\t\t history")
+	fmt.Println("\t\t quit")
+	for _, c := range cmdParser.SupportedCmds {
+		fmt.Println("\t\t", c.Usage())
+	}
+}
+
+func deleteRecursive(con *zk.Conn, path string) error {
+	err := util.ValidatePath(path)
+	if err != nil {
+		return err
+	}
+
+	paths := listSubTreeBFS(con, path)
+
+	deleteReqs := make([]interface{}, 0)
+	total := len(paths)
+	for i := total - 1; i >= 0; i-- {
+		p := paths[i]
+		deleteReqs = append(deleteReqs, &zk.DeleteRequest{Path: p, Version: -1})
+	}
+
+	if _, err := con.Multi(deleteReqs...); err != nil {
+		return err
+	}
+	return nil
+}
+
+func listSubTreeBFS(con *zk.Conn, pathRoot string) []string {
+	queue := make([]string, 0)
+	tree := make([]string, 0)
+
+	queue = append(queue, pathRoot)
+	tree = append(tree, pathRoot)
+
+	for len(queue) > 0 {
+		node := queue[0]
+		queue = queue[1:]
+		children, _, err := con.Children(node)
+		if err != nil {
+			log.Println(err)
+			continue
+		}
+		for _, child := range children {
+			childPath := node + "/" + child
+			queue = append(queue, childPath)
+			tree = append(tree, childPath)
+		}
+	}
+
+	return tree
 }
 
 func visitSubTree(con *zk.Conn, path string) {

util/util.go

@@ -27,17 +27,17 @@ func ValidatePath(path string) error {
 	}
 
 	var reason string
-	lastc := '/'
+	lastr := '/'
 	chars := []rune(path)
-	for i, r := range chars {
-		lastc = r
+	for i := 1; i < len(chars); i++ {
+		r := chars[i]
 		if r == 0 {
 			reason = fmt.Sprintf("null character not allowed @%d", i)
 			break
-		} else if r == '/' && lastc == '/' {
+		} else if r == '/' && lastr == '/' {
 			reason = fmt.Sprintf("empty node name specified @%d", i)
 			break
-		} else if r == '.' && lastc == '.' {
+		} else if r == '.' && lastr == '.' {
 			if chars[i-2] == '/' && (i+1 == len(chars) || chars[i+1] == '/') {
 				reason = fmt.Sprintf("relative paths not allowed @%d", i)
 				break
@@ -47,19 +47,21 @@ func ValidatePath(path string) error {
 				reason = fmt.Sprintf("relative paths not allowed @%d", i)
 				break
 			}
-			//TODO: check if this is the right way
 		} else if r > '\u0000' && r <= '\u001f' || r >= '\u007f' && r <= '\u009F' || r >= 0xd800 && r <= 0xf8ff || r >= 0xfff0 && r <= 0xffff {
 			reason = fmt.Sprintf("invalid character @%d", i)
 			break
 		}
+
+		lastr = r
 	}
 	if reason != "" {
 		return fmt.Errorf("Invalid path string \"" + path + "\" caused by " + reason)
 	}
 	return nil
 }
 
-//ParseACL parses acl strings into zk.ACL
+//ParseACL parses acl strings into zk.ACL;
+//notation of acl: `scheme:id:perm`
 func ParseACL(acl string) []zk.ACL {
 	acls := strings.Split(acl, ",")
 	zkACLs := make([]zk.ACL, 0)
@@ -70,32 +72,27 @@ func ParseACL(acl string) []zk.ACL {
 			fmt.Println(a + " does not have the form scheme:id:perm")
 			continue
 		}
-		perms := getPerms(a[lastColon+1:])
+		perms := parsePerms(a[lastColon+1:])
 		zkACLs = append(zkACLs, zk.ACL{Scheme: a[0:firstColon], ID: a[firstColon+1 : lastColon], Perms: perms})
 	}
 	return zkACLs
 }
 
-func getPerms(s string) int32 {
+func parsePerms(s string) int32 {
 	perm := int32(0)
 	for _, r := range s {
 		char := string(r)
 		switch char {
 		case "r":
 			perm |= zk.PermRead
-			break
 		case "w":
 			perm |= zk.PermWrite
-			break
 		case "c":
 			perm |= zk.PermCreate
-			break
 		case "d":
 			perm |= zk.PermDelete
-			break
 		case "a":
 			perm |= zk.PermAdmin
-			break
 		default:
 			fmt.Println("Unknown perm type:", char)
 		}

util/util_test.go

@@ -11,7 +11,26 @@ func TestValidatePath(t *testing.T) {
 		args    args
 		wantErr bool
 	}{
-		// TODO: Add test cases.
+		{"valid", args{"/this is / a valid/path"}, false},
+		{"valid_1", args{"/name/with.period."}, false},
+		{"valid_2", args{"/test\u0020"}, false},
+		{"valid_3", args{"/test\u007e"}, false},
+		{"valid_4", args{"/test\uffef"}, false},
+		{"invalid", args{}, true},
+		{"invalid_1", args{""}, true},
+		{"invalid_2", args{"not/valid"}, true},
+		{"/ends/with/slash/", args{"/ends/with/slash/"}, true},
+		{"/double//slash", args{"/double//slash"}, true},
+		{"/single/./period", args{"/single/./period"}, true},
+		{"/double/../period", args{"/double/../period"}, true},
+		{"illegal_char", args{"/test\u0000"}, true},
+		{"illegal_char_1", args{"/test\u0001"}, true},
+		{"illegal_char_2", args{"/test\u001F"}, true},
+		{"illegal_char_3", args{"/test\u007F"}, true},
+		{"illegal_char_4", args{"/test\u009F"}, true},
+		{"illegal_char_5", args{string([]rune{'/', 't', 'e', 's', 't', 0xd800})}, true},
+		{"illegal_char_6", args{"/test\uf8ff"}, true},
+		{"illegal_char_7", args{"/test\ufff0"}, true},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {