Documentation
¶
Index ¶
- func CleanApplicationContainers(appDir, composeProjectName string, logger *util.Logger) error
- func CleanServiceTestContainers(appDir, composeProjectName string, logger *util.Logger) error
- func TestApp(appContext types.AppContext, logger *util.Logger, ...) (bool, error)
- func TestService(serviceContext types.ServiceContext, logger *util.Logger, ...) (bool, error)
- type Initializer
- type Runner
- type ServiceTester
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CleanApplicationContainers ¶
CleanApplicationContainers cleans all Docker containers started by the docker-compose.yml file under appDir/tmp/
func CleanServiceTestContainers ¶
CleanServiceTestContainers cleans all Docker containers started by the docker-compose.yml files under appDir/serviceLocation/tests/tmp/
func TestApp ¶ added in v0.27.0
func TestApp(appContext types.AppContext, logger *util.Logger, mode composebuilder.BuildMode) (bool, error)
TestApp runs the tests for the entire application and return true if the tests passed and an error if any
func TestService ¶ added in v0.27.0
func TestService(serviceContext types.ServiceContext, logger *util.Logger, mode composebuilder.BuildMode) (bool, error)
TestService runs the tests for the service and return true if the tests passed and an error if any
Types ¶
type Initializer ¶
type Initializer struct {
AppConfig types.AppConfig
DockerComposeConfig types.DockerCompose
DockerComposeProjectName string
ServiceData map[string]types.ServiceData
ServiceConfigs map[string]types.ServiceConfig
AppDir string
HomeDir string
BuildMode composebuilder.BuildMode
// contains filtered or unexported fields
}
Initializer sets up the app
func NewInitializer ¶
func NewInitializer(appConfig types.AppConfig, logger *util.Logger, appDir, homeDir, dockerComposeProjectName string, mode composebuilder.BuildMode) (*Initializer, error)
NewInitializer is Initializer's constructor
func (*Initializer) BuildDockerCompose ¶ added in v0.28.1
func (i *Initializer) BuildDockerCompose() (string, error)
BuildDockerCompose builds the docker compose file, returning the docker compose dir
func (*Initializer) GetDockerConfigs ¶
func (i *Initializer) GetDockerConfigs() (types.DockerConfigs, error)
GetDockerConfigs returns the docker configs of all services and dependencies in the application
func (*Initializer) Initialize ¶
func (i *Initializer) Initialize() error
Initialize sets up the entire app and returns an error if any
type Runner ¶
type Runner struct {
AppConfig types.AppConfig
ServiceConfigs map[string]types.ServiceConfig
BuiltDependencies map[string]config.AppDevelopmentDependency
DockerComposeDir string
DockerComposeProjectName string
// contains filtered or unexported fields
}
Runner runs the overall application
func NewRunner ¶
func NewRunner(appConfig types.AppConfig, logger *util.Logger, appDir, homeDir, dockerComposeProjectName string) (*Runner, error)
NewRunner is Runner's constructor
type ServiceTester ¶
type ServiceTester struct {
DirName string
ServiceConfig types.ServiceConfig
BuiltDependencies map[string]config.AppDevelopmentDependency
AppDir string
ServiceLocation string
Initializer *Initializer
Runner *Runner
}
ServiceTester runs the tests for the given service
func NewServiceTester ¶
func NewServiceTester(serviceContext types.ServiceContext, logger *util.Logger, mode composebuilder.BuildMode) (*ServiceTester, error)
NewServiceTester is ServiceTester's constructor
func (*ServiceTester) Run ¶
func (s *ServiceTester) Run() (int, error)
Run runs the tests for the service and return true if the tests passed and an error if any
func (*ServiceTester) Shutdown ¶ added in v0.27.0
func (s *ServiceTester) Shutdown() error
Shutdown shuts down the tests
Source Files
Directories