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(fileName string, data io.Reader) (string, error)
  • func (c *Client) ListFileFixture(organization string) ([]byte, error)
  • func (c *Client) ListOrganisations() ([]byte, error)
  • func (c *Client) ListTestCases(organization string) (bool, []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(fileName string, data io.Reader, organization string, ...) (string, error)
  • func (c *Client) TestCaseCreate(organization string, testCaseName string, fileName string, data io.Reader) (bool, string, error)
  • func (c *Client) TestCaseUpdate(organization string, testCaseUID string, fileName string, data io.Reader) (bool, string, error)
  • func (c *Client) TestCaseValidate(organization string, fileName string, data io.Reader) (bool, string, error)
  • func (c *Client) TestRunAbort(testRunUID string) (bool, string, error)
  • func (c *Client) TestRunCallLog(pathID string, preview bool) (io.ReadCloser, error)
  • func (c *Client) TestRunCreate(testCaseUID string, title string, notes string) (bool, string, error)
  • func (c *Client) TestRunList(testCaseUID string) (TestRun, error)
  • func (c *Client) TestRunShow(uid string) (TestRun, error)
  • func (c *Client) TestRunWatch(uid string) (TestRun, string, error)
• type FileFixtureParams
• type TestRun
• type TestRunList

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(fileName string, data io.Reader) (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) ListTestCases

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

ListTestCases returns a list of test cases

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(fileName string, data io.Reader, organization string, params *FileFixtureParams) (string, error)

PushFileFixture uploads (insert or update) a file fixture

func (*Client) TestCaseCreate

func (c *Client) TestCaseCreate(organization string, testCaseName string, fileName string, data io.Reader) (bool, string, error)

TestCaseCreate will send a test case definition (JS) to the API to create it.

func (*Client) TestCaseUpdate

func (c *Client) TestCaseUpdate(organization string, testCaseUID string, fileName string, data io.Reader) (bool, string, error)

TestCaseUpdate will send a test case definition (JS) to the API to update an existing test case it.

func (*Client) TestCaseValidate

func (c *Client) TestCaseValidate(organization string, fileName string, data io.Reader) (bool, string, error)

TestCaseValidate will send a test case definition (JS) to the API to validate.

func (*Client) TestRunAbort

func (c *Client) TestRunAbort(testRunUID string) (bool, string, error)

TestRunAbort will send a test case definition (JS) to the API to update an existing test case it.

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

func (*Client) TestRunCreate

func (c *Client) TestRunCreate(testCaseUID string, title string, notes string) (bool, string, error)

TestRunCreate will send a test case definition (JS) to the API to update an existing test case it.

func (*Client) TestRunList

func (c *Client) TestRunList(testCaseUID string) (TestRun, error)

TestRunList will list all test runs for a given test case

func (*Client) TestRunShow

func (c *Client) TestRunShow(uid string) (TestRun, error)

TestRunShow will show some basic information on a given test run

func (*Client) TestRunWatch

func (c *Client) TestRunWatch(uid string) (TestRun, string, error)

TestRunWatch will show some basic information on a given test run

type FileFixtureParams

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

FileFixtureParams represents params BLA TODO

type TestRun

type TestRun struct {
	ID           string `jsonapi:"primary,test_runs"`
	Title        string `jsonapi:"attr,title,omitempty"`
	Notes        string `jsonapi:"attr,notes,omitempty"`
	State        string `jsonapi:"attr,state,omitempty"`
	StartedBy    string `jsonapi:"attr,started_by,omitempty"`
	StartedAt    string `jsonapi:"attr,started_at,omitempty"`
	EndedAt      string `jsonapi:"attr,ended_at,omitempty"`
	EstimatedEnd string `jsonapi:"attr,estimated_end,omitempty"`
}

TestRun represents a single TestRun

type TestRunList

type TestRunList struct {
	TestRuns []*TestRun
}

TestRunList is a list of TestRuns, used for index action