fix tests and docs

kutluhanmetin · Sep 4, 2023 · 1a47e22 · 1a47e22
1 parent b32809f
commit 1a47e22
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 14 deletions.
diff --git a/base/commands/alias/alias_it_test.go b/base/commands/alias/alias_it_test.go
@@ -7,9 +7,9 @@ import (
 	"fmt"
 	"testing"
 
-	_ "github.com/hazelcast/hazelcast-commandline-client/base"
 	_ "github.com/hazelcast/hazelcast-commandline-client/base/commands"
 	"github.com/hazelcast/hazelcast-commandline-client/base/commands/alias"
+	_ "github.com/hazelcast/hazelcast-commandline-client/base/commands/map"
 	"github.com/hazelcast/hazelcast-commandline-client/internal/it"
 )
 
@@ -30,15 +30,16 @@ func TestAlias(t *testing.T) {
 }
 
 func Execute_InteractiveTest(t *testing.T) {
-	ctx := context.TODO()
 	tcx := it.TestContext{T: t}
 	tcx.Tester(func(tcx it.TestContext) {
-		alias.Aliases.Store("mapAlias", "map set 1 1")
+		ctx := context.Background()
+		alias.Aliases.Store("mapAlias", fmt.Sprintf("\\map set key1 value1 -n myMap"))
 		tcx.WithShell(ctx, func(tcx it.TestContext) {
 			tcx.WithReset(func() {
 				tcx.WriteStdinString("@mapAlias\n")
-				tcx.WriteStdinString("\\map get 1\n")
-				tcx.AssertStdoutContains("1")
+				tcx.WriteStdinString("\\map get key1 -n myMap\n")
+				tcx.AssertStdoutContains("key1")
+				tcx.AssertStdoutContains("value1")
 			})
 		})
 	})
@@ -79,9 +80,9 @@ func Add_InteractiveTest(t *testing.T) {
 	tcx.Tester(func(tcx it.TestContext) {
 		tcx.WithShell(ctx, func(tcx it.TestContext) {
 			tcx.WithReset(func() {
-				tcx.WriteStdinString(fmt.Sprintf("\\alias add mapAlias %s\n", `map set 1 1`))
+				tcx.WriteStdinString(fmt.Sprintf("\\alias add mapAlias %s\n", `map set key1 value1`))
 				tcx.WriteStdinString("\\alias list\n")
-				tcx.AssertStdoutContains("map set 1 1")
+				tcx.AssertStdoutContains("map set key1 value1")
 			})
 		})
 	})
@@ -91,12 +92,12 @@ func Remove_InteractiveTest(t *testing.T) {
 	ctx := context.TODO()
 	tcx := it.TestContext{T: t}
 	tcx.Tester(func(tcx it.TestContext) {
-		alias.Aliases.Store("mapAlias", "map set 1 1")
+		alias.Aliases.Store("mapAlias", "map set key1 value1")
 		tcx.WithShell(ctx, func(tcx it.TestContext) {
 			tcx.WithReset(func() {
 				tcx.WriteStdinString("\\alias remove mapAlias\n")
 				tcx.WriteStdinString("\\alias list\n")
-				tcx.AssertStdoutNotContains("map set 1 1")
+				tcx.AssertStdoutNotContains("map set key1 value1")
 			})
 		})
 	})
@@ -106,12 +107,12 @@ func List_InteractiveTest(t *testing.T) {
 	ctx := context.TODO()
 	tcx := it.TestContext{T: t}
 	tcx.Tester(func(tcx it.TestContext) {
-		alias.Aliases.Store("mapAlias", "map set 1 1")
+		alias.Aliases.Store("mapAlias", "map set key1 value1")
 		tcx.WithShell(ctx, func(tcx it.TestContext) {
 			tcx.WithReset(func() {
 				tcx.WriteStdinString("\\alias list\n")
 				tcx.AssertStdoutContains("mapAlias")
-				tcx.AssertStdoutContains("map set 1 1")
+				tcx.AssertStdoutContains("map set key1 value1")
 			})
 		})
 	})

diff --git a/base/commands/script_it_test.go b/base/commands/script_it_test.go
@@ -55,7 +55,7 @@ func scriptWithAlias_InteractiveTest(t *testing.T) {
 	tcx.Tester(func(tcx it.TestContext) {
 		tcx.WithShell(ctx, func(tcx it.TestContext) {
 			tcx.WithReset(func() {
-				tcx.WriteStdinString(fmt.Sprintf("\\alias add mapAlias %s\n", `"map set key1 value1 -n myMap"`))
+				tcx.WriteStdinString(fmt.Sprintf("\\alias add mapAlias %s\n", "\\map set key1 value1 -n myMap"))
 				tcx.WriteStdinString(fmt.Sprintf("\\script testdata/test-script-with-alias.clc\n"))
 				tcx.WriteStdinString(fmt.Sprintf("\\map get key1 -n myMap\n"))
 				tcx.AssertStdoutContains("value1")

diff --git a/docs/modules/ROOT/pages/user-defined-aliases.adoc b/docs/modules/ROOT/pages/user-defined-aliases.adoc
@@ -41,7 +41,7 @@ Parameters:
 
 |`command`
 |Required
-|Alias command given in double quotes. Eg. `"map set key1 value1 -n myMap"`
+|Alias command given in double quotes. Eg. `"\\map set key1 value1 -n myMap"`
 |
 
 |
@@ -51,9 +51,11 @@ Example:
 
 [source,bash]
 ----
-clc alias add myAlias "map set key1 value1 -n myMap"
+clc alias add myAlias "\\map set key1 value1 -n myMap"
 ----
 
+WARNING: Aliases must be defined in double quotes ("<alias>"). If your command starts with `\`, don't forget to use `\\` to escape the `"` character.
+
 == clc alias remove
 
 Remove an alias with the given name.