cognito

README

xk6-cognito

An example module for https://k6.io/ to get a cognito access token using USER_SRP_AUTH flow.

See:

• to create k6 extension: https://github.com/grafana/xk6-sql/blob/master/sql.go , https://k6.io/blog/extending-k6-with-xk6/#building-the-extension-with-xk6
• to get a cognito access token: https://github.com/alexrudd/cognito-srp

Install

Pre-built binaries

go install go.k6.io/xk6/cmd/xk6@latest
xk6 build master --with github.com/AjayvirS/xk6-cognito

./k6 run --vus 1 --duration 2s /scripts/examples/loadTest.js

Build from source

git clone https://github.com/AjayvirS/xk6-cognito.git && cd xk6-cognito
docker run --rm -v $(pwd):/scripts -it --entrypoint sh golang:1.17-alpine

cd /scripts/
go install go.k6.io/xk6/cmd/xk6@latest
xk6 build v0.32.0  --with github.com/tmieulet/xk6-cognito="/scripts"

Example

In examples, change all values with exToChange then run mkdir -p /scripts/target && xk6 run --vus 1 --duration 2s /scripts/examples/loadTest.js

Documentation

Index

• type AuthOptionalParams
• type Client
  • func (c *Client) Auth(username string, password string, poolId string, clientId string, ...) (keyValue, error)
• type Cognito
  • func (r *Cognito) Connect(region string) (*Client, error)

Types

type AuthOptionalParams

type AuthOptionalParams struct {
	// contains filtered or unexported fields
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is the Cognito client wrapper.

func (*Client) Auth

func (c *Client) Auth(username string, password string, poolId string, clientId string, params AuthOptionalParams) (keyValue, error)

type Cognito

type Cognito struct{}

Cognito is the k6 extension for a Cognito client.

func (*Cognito) Connect

func (r *Cognito) Connect(region string) (*Client, error)