test

package
v1.0.0-beta.13 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 7, 2023 License: Apache-2.0 Imports: 13 Imported by: 2

Documentation

Overview

Package test provides methods and message types of the test v1 API.

Index

Constants

View Source 
const (
	// EyeColorsUnknown is [insert doc].
	EyeColorsUnknown = EyeColors("unknown")
	// EyeColorsAmber is [insert doc].
	EyeColorsAmber = EyeColors("amber")
	// EyeColorsBlue is [insert doc].
	EyeColorsBlue = EyeColors("blue")
	// EyeColorsBrown is [insert doc].
	EyeColorsBrown = EyeColors("brown")
	// EyeColorsGray is [insert doc].
	EyeColorsGray = EyeColors("gray")
	// EyeColorsGreen is [insert doc].
	EyeColorsGreen = EyeColors("green")
	// EyeColorsHazel is [insert doc].
	EyeColorsHazel = EyeColors("hazel")
	// EyeColorsRed is [insert doc].
	EyeColorsRed = EyeColors("red")
	// EyeColorsViolet is [insert doc].
	EyeColorsViolet = EyeColors("violet")
)
View Source 
const (
	// HumanStatusUnknown is [insert doc].
	HumanStatusUnknown = HumanStatus("unknown")
	// HumanStatusStopped is [insert doc].
	HumanStatusStopped = HumanStatus("stopped")
	// HumanStatusRunning is [insert doc].
	HumanStatusRunning = HumanStatus("running")
)
View Source 
const (
	// ListHumansRequestOrderByCreatedAtAsc is [insert doc].
	ListHumansRequestOrderByCreatedAtAsc = ListHumansRequestOrderBy("created_at_asc")
	// ListHumansRequestOrderByCreatedAtDesc is [insert doc].
	ListHumansRequestOrderByCreatedAtDesc = ListHumansRequestOrderBy("created_at_desc")
	// ListHumansRequestOrderByUpdatedAtAsc is [insert doc].
	ListHumansRequestOrderByUpdatedAtAsc = ListHumansRequestOrderBy("updated_at_asc")
	// ListHumansRequestOrderByUpdatedAtDesc is [insert doc].
	ListHumansRequestOrderByUpdatedAtDesc = ListHumansRequestOrderBy("updated_at_desc")
	// ListHumansRequestOrderByHeightAsc is [insert doc].
	ListHumansRequestOrderByHeightAsc = ListHumansRequestOrderBy("height_asc")
	// ListHumansRequestOrderByHeightDesc is [insert doc].
	ListHumansRequestOrderByHeightDesc = ListHumansRequestOrderBy("height_desc")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

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

API: no Auth Service for end-to-end testing

Test is a fake service that aim to manage fake humans. It is used for internal and public end-to-end tests.

This service don't use the Scaleway authentication service but a fake one. It allows to use this test service publicly without requiring a Scaleway account.

First, you need to register a user with `scw test human register` to get an access-key. Then, you can use other test commands by setting the SCW_SECRET_KEY env variable.

func NewAPI 

func NewAPI(client *scw.Client) *API

NewAPI returns a API object from a Scaleway client.

func (*API) CreateHuman 

func (s *API) CreateHuman(req *CreateHumanRequest, opts ...scw.RequestOption) (*Human, error)

CreateHuman: create a new human

func (*API) DeleteHuman 

func (s *API) DeleteHuman(req *DeleteHumanRequest, opts ...scw.RequestOption) (*Human, error)

DeleteHuman: delete an existing human

Delete the human associated with the given id.

func (*API) GetHuman 

func (s *API) GetHuman(req *GetHumanRequest, opts ...scw.RequestOption) (*Human, error)

GetHuman: get human details

Get the human details associated with the given id.

func (*API) ListHumans 

func (s *API) ListHumans(req *ListHumansRequest, opts ...scw.RequestOption) (*ListHumansResponse, error)

ListHumans: list all your humans

func (*API) Register 

func (s *API) Register(req *RegisterRequest, opts ...scw.RequestOption) (*RegisterResponse, error)

Register: register a user

Register a human and return a access-key and a secret-key that must be used in all other commands.

Hint: you can use other test commands by setting the SCW_SECRET_KEY env variable.

func (*API) RunHuman 

func (s *API) RunHuman(req *RunHumanRequest, opts ...scw.RequestOption) (*Human, error)

RunHuman: start a 1h running for the given human

Start a one hour running for the given human.

func (*API) SmokeHuman deprecated 

func (s *API) SmokeHuman(req *SmokeHumanRequest, opts ...scw.RequestOption) (*Human, error)

Deprecated: SmokeHuman: make a human smoke

Make a human smoke.

func (*API) UpdateHuman 

func (s *API) UpdateHuman(req *UpdateHumanRequest, opts ...scw.RequestOption) (*Human, error)

UpdateHuman: update an existing human

Update the human associated with the given id.

type CreateHumanRequest 

type CreateHumanRequest struct {
	Height float64 `json:"height"`

	ShoeSize float32 `json:"shoe_size"`

	AltitudeInMeter int32 `json:"altitude_in_meter"`

	AltitudeInMillimeter int64 `json:"altitude_in_millimeter"`

	FingersCount uint32 `json:"fingers_count"`

	HairCount uint64 `json:"hair_count"`

	IsHappy bool `json:"is_happy"`
	// EyesColor:
	//
	// Default value: unknown
	EyesColor EyeColors `json:"eyes_color"`
	// Deprecated
	// Precisely one of OrganizationID, ProjectID must be set.
	OrganizationID *string `json:"organization_id,omitempty"`

	Name string `json:"name"`

	// Precisely one of OrganizationID, ProjectID must be set.
	ProjectID *string `json:"project_id,omitempty"`
}

type DeleteHumanRequest 

type DeleteHumanRequest struct {
	// HumanID: UUID of the human you want to delete
	HumanID string `json:"-"`
}

type EyeColors 

type EyeColors string

func (EyeColors) MarshalJSON 

func (enum EyeColors) MarshalJSON() ([]byte, error)

func (EyeColors) String 

func (enum EyeColors) String() string

func (*EyeColors) UnmarshalJSON 

func (enum *EyeColors) UnmarshalJSON(data []byte) error

type GetHumanRequest 

type GetHumanRequest struct {
	// HumanID: UUID of the human you want to get
	HumanID string `json:"-"`
}

type Human 

type Human struct {
	ID string `json:"id"`

	OrganizationID string `json:"organization_id"`

	CreatedAt *time.Time `json:"created_at"`

	UpdatedAt *time.Time `json:"updated_at"`

	Height float64 `json:"height"`

	ShoeSize float32 `json:"shoe_size"`

	AltitudeInMeter int32 `json:"altitude_in_meter"`

	AltitudeInMillimeter int64 `json:"altitude_in_millimeter"`

	FingersCount uint32 `json:"fingers_count"`

	HairCount uint64 `json:"hair_count"`

	IsHappy bool `json:"is_happy"`
	// EyesColor:
	//
	// Default value: unknown
	EyesColor EyeColors `json:"eyes_color"`
	// Status:
	//
	// Default value: unknown
	Status HumanStatus `json:"status"`

	Name string `json:"name"`

	ProjectID string `json:"project_id"`
}

type HumanStatus 

type HumanStatus string

func (HumanStatus) MarshalJSON 

func (enum HumanStatus) MarshalJSON() ([]byte, error)

func (HumanStatus) String 

func (enum HumanStatus) String() string

func (*HumanStatus) UnmarshalJSON 

func (enum *HumanStatus) UnmarshalJSON(data []byte) error

type ListHumansRequest 

type ListHumansRequest struct {
	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
	// OrderBy:
	//
	// Default value: created_at_asc
	OrderBy ListHumansRequestOrderBy `json:"-"`

	OrganizationID *string `json:"-"`

	ProjectID *string `json:"-"`
}

type ListHumansRequestOrderBy 

type ListHumansRequestOrderBy string

func (ListHumansRequestOrderBy) MarshalJSON 

func (enum ListHumansRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListHumansRequestOrderBy) String 

func (enum ListHumansRequestOrderBy) String() string

func (*ListHumansRequestOrderBy) UnmarshalJSON 

func (enum *ListHumansRequestOrderBy) UnmarshalJSON(data []byte) error

type ListHumansResponse 

type ListHumansResponse struct {
	TotalCount uint32 `json:"total_count"`

	Humans []*Human `json:"humans"`
}

func (*ListHumansResponse) UnsafeAppend 

func (r *ListHumansResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListHumansResponse) UnsafeGetTotalCount 

func (r *ListHumansResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type RegisterRequest 

type RegisterRequest struct {
	Username string `json:"username"`
}

type RegisterResponse 

type RegisterResponse struct {
	SecretKey string `json:"secret_key"`

	AccessKey string `json:"access_key"`
}

type RunHumanRequest 

type RunHumanRequest struct {
	// HumanID: UUID of the human you want to make run
	HumanID string `json:"-"`
}

type SmokeHumanRequest 

type SmokeHumanRequest struct {
	// Deprecated: HumanID: UUID of the human you want to make smoking
	HumanID *string `json:"-"`
}

type UpdateHumanRequest 

type UpdateHumanRequest struct {
	// HumanID: UUID of the human you want to update
	HumanID string `json:"-"`

	Height *float64 `json:"height"`

	ShoeSize *float32 `json:"shoe_size"`

	AltitudeInMeter *int32 `json:"altitude_in_meter"`

	AltitudeInMillimeter *int64 `json:"altitude_in_millimeter"`

	FingersCount *uint32 `json:"fingers_count"`

	HairCount *uint64 `json:"hair_count"`

	IsHappy *bool `json:"is_happy"`
	// EyesColor:
	//
	// Default value: unknown
	EyesColor EyeColors `json:"eyes_color"`

	Name *string `json:"name"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.