From aeb21095e5ede841e459cc185ab498c91b647e99 Mon Sep 17 00:00:00 2001
From: Codebells <1347103071@qq.com>
Date: Sun, 8 Dec 2024 14:15:52 +0800
Subject: [PATCH] add tcl for src/module example

Signed-off-by: Codebells <1347103071@qq.com>
---
 runtest-moduleapi                           |   1 +
 tests/support/util.tcl                      |  44 ++++++++
 tests/unit/moduleapi/src_module_example.tcl | 107 ++++++++++++++++++++
 3 files changed, 152 insertions(+)
 create mode 100644 tests/unit/moduleapi/src_module_example.tcl

diff --git a/runtest-moduleapi b/runtest-moduleapi
index 460ee59460..fe45eba3d3 100755
--- a/runtest-moduleapi
+++ b/runtest-moduleapi
@@ -14,4 +14,5 @@ then
 fi
 
 $MAKE -C tests/modules && \
+$MAKE -C src/modules && \
 $TCLSH tests/test_helper.tcl --moduleapi "${@}"
diff --git a/tests/support/util.tcl b/tests/support/util.tcl
index e53cda3071..61f74d0ca7 100644
--- a/tests/support/util.tcl
+++ b/tests/support/util.tcl
@@ -1201,3 +1201,47 @@ proc bp {{s {}}} {
         puts $res
     }
 }
+
+proc check_single_command_specs {r info} {
+    foreach command_info $info {
+        if {[llength [lindex $command_info 9]] > 0} {
+            check_single_command_specs $r [lindex $command_info 9]
+            continue
+        }
+        set command_name [lindex $command_info 0]
+        set argc [lindex $command_info 1]
+        set cmd_parts [split $command_name "|"]
+        set cmd_length [llength $cmd_parts]
+        set arg_count [expr {$argc < 0 ? -$argc - $cmd_length + 10 : $argc - $cmd_length}]
+
+        if {$arg_count > 0} {
+            # generate param format with `command getkeys $command_name {$arg_count - 1} key1 key2 ...`
+            # example: zmpop arity is -4, so command will be  `command getkeys zmpop 2 key1 key2`
+            set args [list {*}$cmd_parts [expr {$arg_count - 1}]]
+            for {set i 1} {$i <= $arg_count - 1} {incr i} {
+                lappend args key$i
+            }
+
+            set catch_result [catch {$r command getkeys {*}$args} result]
+
+            if {$catch_result != 0} {
+                if {[string match -nocase {*Invalid arguments specified for command*} $result]} {
+                    # The command with special parameters needs to be tested separately, like xread.
+                } elseif {[string match -nocase {*The command has no key arguments*} $result]} {
+                    # The command check no key arguments can't be tested by `command getkeys`.
+                } else {
+                    fail "Check command $cmd_parts failed with ERROR: $result"
+                }
+            }
+        }
+        # No need to check because this cmd has no param
+    }
+}
+
+proc check_commands_specs r {
+    set commands [$r command]
+    foreach cmd_info $commands {
+        set command [lindex $cmd_info 0]
+        check_single_command_specs $r [list $cmd_info]
+    }
+}
diff --git a/tests/unit/moduleapi/src_module_example.tcl b/tests/unit/moduleapi/src_module_example.tcl
new file mode 100644
index 0000000000..6241c79abe
--- /dev/null
+++ b/tests/unit/moduleapi/src_module_example.tcl
@@ -0,0 +1,107 @@
+source tests/support/cli.tcl
+
+set helloblockmodule [file normalize src/modules/helloblock.so]
+set hellodictmodule [file normalize src/modules/hellodict.so]
+set hellotimermodule [file normalize src/modules/hellotimer.so]
+set hellotypemodule [file normalize src/modules/hellotype.so]
+set helloworldmodule [file normalize src/modules/helloworld.so]
+
+start_server {tags {"modules"}} {
+    r module load $hellodictmodule
+    r module load $helloblockmodule
+    r module load $hellotypemodule
+    r module load $hellotimermodule
+    r module load $helloworldmodule
+    r select 0
+
+    test {test module command specs} {
+        check_commands_specs r
+    }
+    test {test hellodict} {
+        foreach i {a b c d e f g h i j k l m n o p q r s t u v w x y z} {
+            r hellodict.set $i $i
+            assert_match [r hellodict.get $i] $i
+        }
+        assert_equal [llength [r hellodict.keyrange a b 2]] 2
+        assert_equal [llength [r hellodict.keyrange a z 2]] 2
+    }
+
+    test {test helloblock} {
+        assert_match [r hello.block 1 2] "Request timedout"
+        assert {[r hello.block 1 2000] > 0}
+        r set foo bar
+        assert {[llength [r hello.keys]] > 0}
+        r flushall
+        assert_equal [llength [r hello.keys]] 0
+    }
+
+    test {test hellotype} {
+        set cnt 1
+        while {$cnt <= 10000} {
+            r hellotype.insert hello $cnt
+            incr cnt
+        }
+        assert_equal [llength [r hellotype.range hello 1 100]] 100
+        assert_equal [llength [r hellotype.range hello 1 1000]] 1000
+        assert_equal [llength [r hellotype.brange hello 1 20000 1]] 10000
+    }
+
+    test {test helloworld} {
+        assert_equal [r hello.simple] 0
+        assert_equal [r hello.push.native lkey 1] 1
+        assert_equal [r hello.push.call lkey 2] 2
+        assert_equal [r hello.push.call2 lkey 3] 3
+        assert_equal [r hello.list.sum.len lkey] 3
+        assert_equal [r hello.list.splice lkey lkey2 1] 2
+        assert_equal [r hello.list.sum.len lkey] 2
+        assert_equal [r hello.list.sum.len lkey2] 1
+        assert_equal [r hello.list.splice.auto lkey lkey2 1] 1
+        assert_equal [r hello.list.sum.len lkey] 1
+        assert_equal [r hello.list.sum.len lkey2] 2
+        assert_equal [llength [r hello.rand.array 10]] 10
+
+        r hello.repl1
+        r hello.repl1
+        assert_equal [r get foo] 2
+        assert_equal [r get bar] 2
+
+        assert_equal [r hello.push.native lsum 1] 1
+        assert_equal [r hello.push.call lsum 2] 2
+        assert_equal [r hello.push.call2 lsum 3] 3
+        assert_equal [r hello.repl2 lsum] 9
+
+        r set a b
+        r hello.toggle.case a
+        assert_equal [r get a] B
+        r hello.toggle.case a
+        assert_equal [r get a] b
+
+        r set tk bb EX 100
+        assert {[r ttl tk] < 101}
+        r hello.more.expire tk 1000000000
+        assert {[r ttl tk] > 100}
+
+        r zadd myzset 1 a 2 b 3 c 4 d
+        set res [r hello.zsumrange myzset 1 3]
+        assert_equal [lindex $res 0] 6
+        assert_equal [lindex $res 0] [lindex $res 1]
+
+        r zadd myzset 0 e 0 f 0 g 0 h
+        set lexres [r hello.lexrange myzset "\[b" "\[f" 0 0]
+        assert_equal [llength $lexres] 2
+
+        r hset hkey a a
+        r hello.hcopy hkey a b
+        assert_match [r hget hkey a] [r hget hkey b]
+
+        assert_match [r hello.leftpad td 4 0] "00td"
+    }
+
+    test {unload modules} {
+        r FLUSHALL
+        assert_equal {OK} [r module unload hellodict]
+        assert_equal {OK} [r module unload helloblock]
+        assert_equal {OK} [r module unload hellotimer]
+        assert_equal {OK} [r module unload helloworld]
+    }
+}
\ No newline at end of file