Documentation
¶
Overview ¶
Package fixtures provides declarative test data creation via fixture files.
Index ¶
- Constants
- Variables
- func EventList() string
- func EventNames() []string
- func FixtureContents(eventName string) (string, error)
- func Trigger(ctx context.Context, event string, stripeAccount string, baseURL string, ...) ([]string, error)
- type Fixture
- func BuildFromFixtureFile(fs afero.Fs, apiKey, stripeAccount, apiBaseURL, jsonFile string, ...) (*Fixture, error)
- func BuildFromFixtureString(fs afero.Fs, apiKey, stripeAccount, apiBaseURL, raw string) (*Fixture, error)
- func NewFixtureFromFile(fs afero.Fs, apiKey, stripeAccount, baseURL, file string, ...) (*Fixture, error)
- func NewFixtureFromRawString(fs afero.Fs, apiKey, stripeAccount, baseURL, raw string) (*Fixture, error)
- func (fxt *Fixture) Add(additions []string) error
- func (fxt *Fixture) Edit(path string, filedata []byte) ([]byte, error)
- func (fxt *Fixture) Execute(ctx context.Context, apiVersion string) ([]string, error)
- func (fxt *Fixture) GetFixtureFileContent() string
- func (fxt *Fixture) Override(overrides []string) error
- func (fxt *Fixture) Remove(removals []string) error
- func (fxt *Fixture) UpdateEnv() error
- type FixtureData
- type FixtureRequest
- type MetaFixture
Constants ¶
const SupportedVersions = 0
SupportedVersions is the version number of the fixture template the CLI supports
Variables ¶
var Edit = func(path string, filedata []byte) ([]byte, error) { filename := getFixtureFilenameWithWildcard(path) editor, err := git.NewTemporaryFileEditor(filename, filedata) if err != nil { return nil, err } return editor.EditContent() }
Edit is separated into a var so we can mock this in fixtures_test
Functions ¶
func EventList ¶
func EventList() string
EventList prints out a padded list of supported trigger events for printing the help file
func FixtureContents ¶ added in v1.40.3
FixtureContents returns the JSON content of the embedded fixture for the given event name. The JSON is re-serialized from the parsed FixtureData struct, matching the format produced by GetFixtureFileContent.
Types ¶
type Fixture ¶
type Fixture struct {
Fs afero.Fs
APIKey string
StripeAccount string
Skip []string
Overrides map[string]interface{}
Additions map[string]interface{}
Removals map[string]interface{}
BaseURL string
Responses map[string]gjson.Result
FixtureData FixtureData
}
Fixture contains a mapping of an individual fixtures responses for querying
func BuildFromFixtureFile ¶ added in v1.7.5
func BuildFromFixtureFile(fs afero.Fs, apiKey, stripeAccount, apiBaseURL, jsonFile string, skip, override, add, remove []string, edit bool) (*Fixture, error)
BuildFromFixtureFile creates a new fixture struct for a file
func BuildFromFixtureString ¶ added in v1.7.5
func BuildFromFixtureString(fs afero.Fs, apiKey, stripeAccount, apiBaseURL, raw string) (*Fixture, error)
BuildFromFixtureString creates a new fixture from a string
func NewFixtureFromFile ¶ added in v1.7.5
func NewFixtureFromFile(fs afero.Fs, apiKey, stripeAccount, baseURL, file string, skip, override, add, remove []string, edit bool) (*Fixture, error)
NewFixtureFromFile creates a to later run steps for populating test data
func NewFixtureFromRawString ¶ added in v1.7.5
func NewFixtureFromRawString(fs afero.Fs, apiKey, stripeAccount, baseURL, raw string) (*Fixture, error)
NewFixtureFromRawString creates fixtures from user inputted string
func (*Fixture) Add ¶ added in v1.7.2
Add safely only adds any missing fields that do not already exist. If the field is already on the fixture, it does not get copied over. For that, `Override` should be used
func (*Fixture) Edit ¶ added in v1.13.9
Edit opens the fixture in the git's default IDE to edit directly
func (*Fixture) Execute ¶
Execute takes the parsed fixture file and runs through all the requests defined to populate the user's account
func (*Fixture) GetFixtureFileContent ¶ added in v1.7.5
GetFixtureFileContent returns the file content of the given fixture file name
func (*Fixture) Override ¶ added in v1.7.2
Override forcefully overrides fields with existing data on a fixture
type FixtureData ¶ added in v1.13.0
type FixtureData struct {
Meta MetaFixture `json:"_meta"`
Requests []FixtureRequest `json:"fixtures"`
Env map[string]string `json:"env"`
}
FixtureData contains the whole fixture file
type FixtureRequest ¶ added in v1.13.0
type FixtureRequest struct {
Name string `json:"name"`
ExpectedErrorType string `json:"expected_error_type"`
Path string `json:"path"`
Method string `json:"method"`
Params map[string]interface{} `json:"params"`
IdempotencyKey string `json:"idempotency_key,omitempty"`
Context string `json:"context,omitempty"`
APIBase string `json:"api_base,omitempty"`
Headers map[string]string `json:"headers,omitempty"`
}
FixtureRequest is the individual request payload
type MetaFixture ¶ added in v1.13.0
type MetaFixture struct {
Version int `json:"template_version"`
ExcludeMetadata bool `json:"exclude_metadata"`
Aliases []string `json:"aliases,omitempty"`
}
MetaFixture contains fixture metadata
Source Files