api

Documentation

Index

• type Client
  • func NewClient(apiEndpoint string, jwtToken string) *Client
  • func (c *Client) DeleteFileFixture(fileFixtureUID string, organization string) (string, error)
  • func (c *Client) DownloadFileFixture(organization string, fileFixtureUID string, version string) ([]byte, error)
  • func (c *Client) GetFileFixture(organization string, fileUID string) ([]byte, error)
  • func (c *Client) Har(file string) (string, error)
  • func (c *Client) ListFileFixture(organization string) ([]byte, error)
  • func (c *Client) ListOrganisations() ([]byte, error)
  • func (c *Client) Login(email string, password string) (string, error)
  • func (c *Client) MoveFileFixture(organization string, fileFixtureUID string, newName string) (string, error)
  • func (c *Client) Ping() (bool, error)
  • func (c *Client) PushFileFixture(file string, organization string, params *FileFixtureParams) (string, error)
  • func (c *Client) TestRunCallLog(pathID string, preview bool) (io.ReadCloser, error)
• type FileFixtureParams

Types

type Client

type Client struct {
	HTTPClient  *http.Client
	APIEndpoint string
	JWT         string
	UserAgent   string
}

Client represents the API client

func NewClient

func NewClient(apiEndpoint string, jwtToken string) *Client

NewClient returns a new initialized API client

func (*Client) DeleteFileFixture

func (c *Client) DeleteFileFixture(fileFixtureUID string, organization string) (string, error)

DeleteFileFixture deletes a file fixture

func (*Client) DownloadFileFixture

func (c *Client) DownloadFileFixture(organization string, fileFixtureUID string, version string) ([]byte, error)

DownloadFileFixture retrieves the originally uploaded file

func (*Client) GetFileFixture

func (c *Client) GetFileFixture(organization string, fileUID string) ([]byte, error)

GetFileFixture returns a list of the organizations fixtures

func (*Client) Har

func (c *Client) Har(file string) (string, error)

Har converts the given HAR archive file into a StormForger test case definition

func (*Client) ListFileFixture

func (c *Client) ListFileFixture(organization string) ([]byte, error)

ListFileFixture returns a list of the organizations fixtures

func (*Client) ListOrganisations

func (c *Client) ListOrganisations() ([]byte, error)

ListOrganisations returns a list of organisations

func (*Client) Login

func (c *Client) Login(email string, password string) (string, error)

Login acquires a JWT access token for the given email/password

func (*Client) MoveFileFixture

func (c *Client) MoveFileFixture(organization string, fileFixtureUID string, newName string) (string, error)

MoveFileFixture renames a filefixtures

func (*Client) Ping

func (c *Client) Ping() (bool, error)

Ping performs an authenticated ping to check if the API is working and the user is properly authenticated.

FIXME would be nice to return a struct

where we see the status and in case of
success also the email address of the
authenticated user (useful) to check
if we are authenticated as the correct user

func (*Client) PushFileFixture

func (c *Client) PushFileFixture(file string, organization string, params *FileFixtureParams) (string, error)

PushFileFixture uploads (insert or update) a file fixture

func (*Client) TestRunCallLog

func (c *Client) TestRunCallLog(pathID string, preview bool) (io.ReadCloser, error)

TestRunCallLog will download the first 10k lines of the test run's call log

type FileFixtureParams

type FileFixtureParams struct {
	Name       string
	Type       string
	FieldNames string
	Delimiter  string
}

FileFixtureParams represents params BLA TODO