[feat] add uuid and base32 for random lib (#48)

* add uuid and b32

* b32

* dash it

* S

* add docs

* fix typo

Author: hyorigo

cmd/starlet/go.mod

@@ -17,6 +17,7 @@ require (
 	github.com/aymanbagabas/go-osc52 v1.0.3 // indirect
 	github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e // indirect
 	github.com/gonutz/w32 v1.0.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
 	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
 	github.com/mattn/go-isatty v0.0.16 // indirect
 	github.com/mattn/go-runewidth v0.0.14 // indirect

cmd/starlet/go.sum

@@ -15,6 +15,8 @@ github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1 h1:q763qf9huN11kDQavWs
 github.com/gonutz/w32 v1.0.0 h1:3t1z6ZfkFvirjFYBx9pHeHBuKoN/VBVk9yHb/m2Ll/k=
 github.com/gonutz/w32 v1.0.0/go.mod h1:Rc/YP5K9gv0FW4p6X9qL3E7Y56lfMflEol1fLElfMW4=
 github.com/google/go-cmp v0.5.1 h1:JFrFEBb2xKufg6XkJsJr+WbKb4FQlURi5RUcBveYu9k=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
 github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
 github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ=

go.mod

@@ -4,6 +4,7 @@ go 1.18
 
 require (
 	github.com/1set/starlight v0.0.8
+	github.com/google/uuid v1.6.0
 	go.starlark.net v0.0.0-20231121155337-90ade8b19d09
 )
 

go.sum

@@ -5,6 +5,8 @@ github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e h1:fY5BOSpyZCqRo5O
 github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
 github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1 h1:q763qf9huN11kDQavWsoZXJNW3xEE4JJyHa5Q25/sd8=
 github.com/google/go-cmp v0.5.1 h1:JFrFEBb2xKufg6XkJsJr+WbKb4FQlURi5RUcBveYu9k=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 go.starlark.net v0.0.0-20231121155337-90ade8b19d09 h1:hzy3LFnSN8kuQK8h9tHl4ndF6UruMj47OqwqsS+/Ai4=
 go.starlark.net v0.0.0-20231121155337-90ade8b19d09/go.mod h1:LcLNIzVOMp4oV+uusnpk+VU+SzXaJakUuBjoCSWH5dM=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=

lib/random/README.md

@@ -51,6 +51,30 @@ print(s)
 # Output: "enfknqfbra"
 ```
 
+### `randb32(n, sep)`
+
+Generate a random base32 string containing n number of bytes with optional separator dash for every sep characters.
+
+#### Parameters
+
+| name  | type  | description                                                                                                   |
+|-------|-------|---------------------------------------------------------------------------------------------------------------|
+| `n`   | `int` | The number of bytes to generate. If n is non-positive or not supplied, a reasonable default is used.          |
+| `sep` | `int` | The number of characters to separate with a dash, if it's non-positive or not supplied, no separator is used. |
+
+#### Examples
+
+**basic**
+
+Generate a random base32 string containing 10 bytes with no separator.
+
+```python
+load("random", "randb32")
+s = randb32(10, 4)
+print(s)
+# Output: 2RXQ-H45H-WV
+```
+
 ### `randint(a,b)`
 
 Return a random integer N such that a <= N <= b.
@@ -117,6 +141,23 @@ print(n)
 # Output: 7.309677873766576
 ```
 
+### `uuid4()`
+
+Generate a random UUID (RFC 4122 version 4).
+
+#### Examples
+
+**basic**
+
+Generate a random UUID.
+
+```python
+load("random", "uuid")
+u = uuid()
+print(u)
+# Output: 6e360b7a-f677-4f6c-9c57-8b09694d66b3
+```
+
 ### `choice(seq)`
 
 Return a random element from the non-empty sequence seq.

lib/random/random.go

@@ -8,6 +8,7 @@ import (
 	"sync"
 
 	itn "github.com/1set/starlet/internal"
+	guuid "github.com/google/uuid"
 	"go.starlark.net/starlark"
 	"go.starlark.net/starlarkstruct"
 )
@@ -29,11 +30,13 @@ func LoadModule() (starlark.StringDict, error) {
 				Members: starlark.StringDict{
 					"randbytes": starlark.NewBuiltin("random.randbytes", randbytes),
 					"randstr":   starlark.NewBuiltin("random.randstr", randstr),
+					"randb32":   starlark.NewBuiltin("random.randb32", randb32),
 					"randint":   starlark.NewBuiltin("random.randint", randint),
 					"choice":    starlark.NewBuiltin("random.choice", choice),
 					"shuffle":   starlark.NewBuiltin("random.shuffle", shuffle),
 					"random":    starlark.NewBuiltin("random.random", random),
 					"uniform":   starlark.NewBuiltin("random.uniform", uniform),
+					"uuid":      starlark.NewBuiltin("random.uuid", uuid),
 				},
 			},
 		}
@@ -91,6 +94,44 @@ func randstr(thread *starlark.Thread, bn *starlark.Builtin, args starlark.Tuple,
 	return starlark.String(s), nil
 }
 
+// randb32(n, sep) returns a random base32 string of length n with optional separator dash for every sep characters.
+func randb32(thread *starlark.Thread, bn *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
+	// precondition checks
+	var n, sep starlark.Int
+	if err := starlark.UnpackArgs(bn.Name(), args, kwargs, "n?", &n, "sep?", &sep); err != nil {
+		return nil, err
+	}
+	// set default value if n is not provided correctly
+	nInt := n.BigInt()
+	if nInt.Sign() <= 0 {
+		nInt = defaultLenN
+	}
+	nSep := sep.BigInt()
+	if nSep.Sign() <= 0 {
+		nSep = big.NewInt(0)
+	}
+	// get random strings
+	const ab = `ABCDEFGHIJKLMNOPQRSTUVWXYZ234567` // standard base32 encoding chars, as defined in RFC 4648.
+	s, err := getRandStr(ab, nInt.Int64())
+	if err != nil {
+		return nil, err
+	}
+	// add separator
+	if n := int(nSep.Int64()); n > 0 && n < len(s) {
+		// add separator every n chars
+		var buf []rune
+		for i, r := range s {
+			if i > 0 && i%n == 0 {
+				buf = append(buf, '-', r)
+			} else {
+				buf = append(buf, r)
+			}
+		}
+		s = string(buf)
+	}
+	return starlark.String(s), nil
+}
+
 // randint(a, b) returns a random integer N such that a <= N <= b. Alias for randrange(a, b+1).
 func randint(thread *starlark.Thread, bn *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
 	// precondition checks
@@ -193,6 +234,12 @@ func random(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, k
 	return starlark.Float(f), nil
 }
 
+// uuid() returns a random UUID (RFC 4122 version 4).
+func uuid(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
+	u := guuid.New()
+	return starlark.String(u.String()), nil
+}
+
 // uniform(a, b) returns a random floating point number N such that a <= N <= b for a <= b and b <= N <= a for b < a. The end-point value b may or may not be included in the range depending on floating-point rounding in the equation a + (b-a) * random().
 func uniform(thread *starlark.Thread, bn *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
 	// precondition checks

lib/random/random_test.go

@@ -405,6 +405,74 @@ func TestLoadModule_Random(t *testing.T) {
 				return f >= 1 && f < 2
 			},
 		},
+		{
+			name: "uuid",
+			script: itn.HereDoc(`
+				load('random', 'uuid')
+				val = uuid()
+				print(val)
+				assert.eq(len(val), 36)
+				assert.eq(len(val.replace("-", "")), 32)
+			`),
+		},
+		{
+			name: "randb32 with 0 or 1 args",
+			script: itn.HereDoc(`
+				load('random', 'randb32')
+				x = randb32()
+				assert.eq(len(x), 10)
+
+				y = randb32(6)
+				assert.eq(len(y), 6)
+			`),
+		},
+		{
+			name: "randb32 with incorrect args",
+			script: itn.HereDoc(`
+				load('random', 'randb32')
+				x = randb32(-2)
+				assert.eq(len(x), 10)
+				y = randb32(0)
+				assert.eq(len(y), 10)
+			`),
+		},
+		{
+			name: "randb32 with invalid type",
+			script: itn.HereDoc(`
+				load('random', 'randb32')
+				randb32('1')
+			`),
+			wantErr: `random.randb32: for parameter n: got string, want int`,
+		},
+		{
+			name: "randb32 with sep",
+			script: itn.HereDoc(`
+				load('random', 'randb32')
+				x = randb32(20, 5)
+				assert.eq(len(x), 20+3)
+				assert.eq(x[5], '-')
+				assert.eq(len(x.split('-')), 4)
+
+				y = randb32(20, 0)
+				assert.eq(len(y), 20)
+
+				z = randb32(20, -1)
+				assert.eq(len(z), 20)
+
+				w = randb32(20, 20)
+				assert.eq(len(w), 20)
+
+				t = randb32(20, 21)
+				assert.eq(len(t), 20)
+
+				u = randb32(20, 22)
+
+				v = randb32(20, 1)
+				assert.eq(len(v), 20+19)
+				assert.eq(v[1], '-')
+				assert.eq(len(v.split('-')), 20)
+			`),
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {