Merge pull request #5 from szkiba/feature/modules

Feature/modules

.golangci.yml

@@ -19,7 +19,6 @@ linters:
     - gochecknoglobals
     - lll
     - wrapcheck
-    - gochecknoinits
 # deprecated
     - deadcode
     - nosnakecase

README.md

@@ -165,6 +165,10 @@ In addition to the go standard library, the following third-party packages can b
   - https://github.com/sirupsen/logrus
   - https://github.com/stretchr/testify
   - https://github.com/PuerkitoBio/goquery
+  - https://github.com/tidwall/gjson
+  - https://github.com/PaesslerAG/jsonpath
+  - https://github.com/santhosh-tekuri/jsonschema/v5
+  - https://github.com/brianvoe/gofakeit/v6
 
 
 ### Checks
@@ -281,6 +285,62 @@ func Default() error {
 }
 ```
 
+### JSON
+
+The [gjson](https://github.com/tidwall/gjson) and [jsonpath](github.com/PaesslerAG/jsonpath) packages can be used to query JSON documents.
+
+**gjson**
+```go
+package main
+
+import (
+	"net/http"
+
+	"github.com/go-resty/resty/v2"
+	"github.com/stretchr/testify/require"
+	"github.com/tidwall/gjson"
+)
+
+func Default(require *require.Assertions) {
+	res, err := resty.New().R().Get("https://httpbin.test.k6.io/get")
+
+	require.NoError(err, "request success")
+	require.Equal(http.StatusOK, res.StatusCode(), "status code 200")
+
+	body := res.Body()
+
+	val := gjson.GetBytes(body, "headers.Host").Str
+
+	require.Equal("httpbin.test.k6.io", val, "headers.Host value OK")
+}
+```
+
+**jsonpath**
+```go
+package main
+
+import (
+	"net/http"
+
+	"github.com/PaesslerAG/jsonpath"
+	"github.com/go-resty/resty/v2"
+	"github.com/stretchr/testify/require"
+)
+
+func Default(require *require.Assertions) {
+	body := make(map[string]interface{})
+	res, err := resty.New().R().SetResult(&body).Get("https://httpbin.test.k6.io/get")
+
+	require.NoError(err, "request success")
+	require.Equal(http.StatusOK, res.StatusCode(), "status code 200")
+
+	val, err := jsonpath.Get("$.headers.Host", body)
+
+	require.NoError(err, "$.headers.Host no error")
+	require.Equal("httpbin.test.k6.io", val, "$.headers.Host value OK")
+}
+```
+
 ### Logging
 
 The https://github.com/sirupsen/logrus package can be used for logging in the test script.

g0/assert.go → g0/addon/assert.go

@@ -2,7 +2,7 @@
 //
 // SPDX-License-Identifier: MIT
 
-package g0
+package addon
 
 import (
 	"errors"
@@ -18,11 +18,22 @@ import (
 	"go.k6.io/k6/metrics"
 )
 
+type TestingT interface {
+	assert.TestingT
+	require.TestingT
+
+	Check(string, bool)
+}
+
 type checker struct {
 	vu   modules.VU
 	fail bool
 }
 
+func NewTestingT(vu modules.VU, fail bool) TestingT {
+	return &checker{vu: vu, fail: fail}
+}
+
 func (c *checker) Errorf(format string, args ...interface{}) {
 	state := c.vu.State()
 	if state == nil {
@@ -97,8 +108,7 @@ func (c *checker) FailNow() {
 }
 
 var (
-	_ assert.TestingT  = (*checker)(nil)
-	_ require.TestingT = (*checker)(nil)
+	_ TestingT = (*checker)(nil)
 
 	errAssertionFailed = errors.New("assertion failed")
 )

g0/addon/transport.go

@@ -0,0 +1,128 @@
+// SPDX-FileCopyrightText: 2023 Iván Szkiba
+//
+// SPDX-License-Identifier: MIT
+
+package addon
+
+import (
+	"bytes"
+	"io"
+	"net/http"
+	"strconv"
+	"strings"
+	"time"
+
+	"go.k6.io/k6/js/modules"
+	khttp "go.k6.io/k6/js/modules/k6/http"
+	"go.k6.io/k6/lib/netext/httpext"
+)
+
+type tripware struct {
+	vu modules.VU
+}
+
+var _ http.RoundTripper = (*tripware)(nil)
+
+func NewTransport(vu modules.VU) http.RoundTripper {
+	return &tripware{vu: vu}
+}
+
+const (
+	httpTimeout = 60 * time.Second
+	protoFields = 2
+)
+
+func (t *tripware) toParsedRequest(req *http.Request) (*httpext.ParsedHTTPRequest, error) {
+	state := t.vu.State()
+	if state == nil {
+		return nil, khttp.ErrHTTPForbiddenInInitContext
+	}
+
+	u := req.URL.String()
+
+	url, err := httpext.NewURL(u, u)
+	if err != nil {
+		return nil, err
+	}
+
+	preq := &httpext.ParsedHTTPRequest{ // nolint:exhaustruct
+		URL:         &url,
+		Req:         req,
+		Timeout:     httpTimeout,
+		Throw:       state.Options.Throw.Bool,
+		Redirects:   state.Options.MaxRedirects,
+		Cookies:     make(map[string]*httpext.HTTPRequestCookie),
+		TagsAndMeta: t.vu.State().Tags.GetCurrentValues(),
+	}
+
+	if state.Options.DiscardResponseBodies.Bool {
+		preq.ResponseType = httpext.ResponseTypeNone
+	} else {
+		preq.ResponseType = httpext.ResponseTypeBinary
+	}
+
+	if req.Body != nil {
+		data, err := io.ReadAll(req.Body)
+		if err != nil {
+			return nil, err
+		}
+
+		preq.Body = bytes.NewBuffer(data)
+
+		req.Body.Close()
+	}
+
+	preq.Req.Header.Set("User-Agent", state.Options.UserAgent.String)
+
+	return preq, nil
+}
+
+func (t *tripware) toResponse(req *http.Request, eresp *httpext.Response) (*http.Response, error) {
+	resp := new(http.Response)
+
+	resp.Request = req
+
+	resp.Header = http.Header{}
+
+	for k, v := range eresp.Headers {
+		resp.Header.Set(k, v)
+	}
+
+	resp.Proto = eresp.Proto
+	fields := strings.SplitN(resp.Proto, "/", protoFields)
+
+	if major, err := strconv.Atoi(fields[0]); err == nil {
+		resp.ProtoMajor = major
+	}
+
+	if len(fields) > 0 {
+		if minor, err := strconv.Atoi(fields[1]); err == nil {
+			resp.ProtoMinor = minor
+		}
+	}
+
+	if eresp.Body != nil {
+		if data, ok := eresp.Body.([]byte); ok {
+			resp.Body = io.NopCloser(bytes.NewBuffer(data))
+		}
+	}
+
+	resp.Status = eresp.StatusText
+	resp.StatusCode = eresp.Status
+
+	return resp, nil
+}
+
+func (t *tripware) RoundTrip(req *http.Request) (*http.Response, error) {
+	preq, err := t.toParsedRequest(req)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := httpext.MakeRequest(t.vu.Context(), t.vu.State(), preq)
+	if err != nil {
+		return nil, err
+	}
+
+	return t.toResponse(req, resp)
+}

g0/bootstrap.go

@@ -0,0 +1,41 @@
+// SPDX-FileCopyrightText: 2023 Iván Szkiba
+//
+// SPDX-License-Identifier: MIT
+
+package g0
+
+import (
+	"github.com/szkiba/xk6-g0/internal/builtin/gjson"
+	"github.com/szkiba/xk6-g0/internal/builtin/gofakeit"
+	"github.com/szkiba/xk6-g0/internal/builtin/goquery"
+	"github.com/szkiba/xk6-g0/internal/builtin/jsonpath"
+	"github.com/szkiba/xk6-g0/internal/builtin/jsonschema"
+	"github.com/szkiba/xk6-g0/internal/builtin/logrus"
+	"github.com/szkiba/xk6-g0/internal/builtin/resty"
+	"github.com/szkiba/xk6-g0/internal/builtin/stdlib"
+	"github.com/szkiba/xk6-g0/internal/builtin/testify"
+	"go.k6.io/k6/js/modules"
+)
+
+func registerBuiltins() {
+	registerExports(stdlib.Exports)
+	registerExports(logrus.Exports)
+	registerExports(resty.Exports)
+	registerExports(testify.Exports)
+	registerExports(goquery.Exports)
+	registerExports(gjson.Exports)
+	registerExports(jsonpath.Exports)
+	registerExports(jsonschema.Exports)
+	registerExports(gofakeit.Exports)
+}
+
+func registerExtension() {
+	modules.Register("k6/x/g0", New())
+}
+
+func Bootstrap(addons ...ExportsFunc) {
+	registerBuiltins()
+	registerExports(addons...)
+	redirectStdin()
+	registerExtension()
+}

g0/cli.go

@@ -37,7 +37,7 @@ func isRunCommand(args []string) (bool, int) {
 	return true, scriptIndex
 }
 
-func RedirectStdin() {
+func redirectStdin() {
 	isRun, scriptIndex := isRunCommand(os.Args)
 	if !isRun {
 		return

g0/context.go

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Iván Szkiba
+//
+// SPDX-License-Identifier: MIT
+
 package g0
 
 import (

g0/exports.go

@@ -8,19 +8,14 @@ import (
 	"sync"
 
 	"github.com/imdario/mergo"
-	"github.com/szkiba/xk6-g0/internal/builtin/goquery"
-	"github.com/szkiba/xk6-g0/internal/builtin/logrus"
-	"github.com/szkiba/xk6-g0/internal/builtin/resty"
-	"github.com/szkiba/xk6-g0/internal/builtin/stdlib"
-	"github.com/szkiba/xk6-g0/internal/builtin/testify"
 	"github.com/traefik/yaegi/interp"
 	"go.k6.io/k6/js/modules"
 )
 
 type ExportsFunc func(modules.VU) interp.Exports
 
-func RegisterExports(fn ExportsFunc) {
-	registry.register(fn)
+func registerExports(fn ...ExportsFunc) {
+	registry.register(fn...)
 }
 
 type exportsRegistry struct {
@@ -30,11 +25,11 @@ type exportsRegistry struct {
 
 var registry exportsRegistry
 
-func (r *exportsRegistry) register(fn ExportsFunc) {
+func (r *exportsRegistry) register(fn ...ExportsFunc) {
 	r.mu.Lock()
 	defer r.mu.Unlock()
 
-	r.exports = append(r.exports, fn)
+	r.exports = append(r.exports, fn...)
 }
 
 func (r *exportsRegistry) merge(vu modules.VU) (interp.Exports, error) { //nolint:varnamelen
@@ -51,11 +46,3 @@ func (r *exportsRegistry) merge(vu modules.VU) (interp.Exports, error) { //nolin
 
 	return symbols, nil
 }
-
-func init() {
-	RegisterExports(stdlib.Exports)
-	RegisterExports(logrus.Exports)
-	RegisterExports(resty.Exports)
-	RegisterExports(testify.Exports)
-	RegisterExports(goquery.Exports)
-}

g0/module.go

@@ -7,6 +7,7 @@ package g0
 import (
 	"os"
 
+	"github.com/szkiba/xk6-g0/g0/addon"
 	"github.com/szkiba/xk6-g0/internal/builtin/testify/assertions"
 	"github.com/szkiba/xk6-g0/internal/builtin/testify/requirements"
 	"github.com/traefik/yaegi/interp"
@@ -27,8 +28,8 @@ func (root *RootModule) NewModuleInstance(vu modules.VU) modules.Instance { // n
 	mod := &Module{                       //nolint:exhaustruct
 		vu:      vu,
 		yaegi:   yaegi,
-		assert:  assertions.New(&checker{fail: false, vu: vu}),
-		require: requirements.New(&checker{fail: true, vu: vu}),
+		assert:  assertions.New(addon.NewTestingT(vu, false)),
+		require: requirements.New(addon.NewTestingT(vu, true)),
 	}
 
 	if err := mod.init(os.Getenv(envScript)); err != nil {