context

package

v0.0.0-...-1add9d3 Latest Latest Go to latest Published: Apr 26, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/testcontainers/testcontainers-go

Documentation ¶

Index ¶

type Context
- func GetRootContext() (Context, error)
- func New(dir string) Context
type TestcontainersModule
type TestcontainersModuleVar

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Context ¶

type Context struct {
	RootDir string
}

func GetRootContext ¶

func GetRootContext() (Context, error)

func New ¶

func New(dir string) Context

func (Context) DocsDir ¶

func (ctx Context) DocsDir() string

func (Context) GetExamples ¶

func (ctx Context) GetExamples() ([]string, error)

func (Context) GetExamplesDocs ¶

func (ctx Context) GetExamplesDocs() ([]string, error)

func (Context) GetModules ¶

func (ctx Context) GetModules() ([]string, error)

func (Context) GetModulesDocs ¶

func (ctx Context) GetModulesDocs() ([]string, error)

func (Context) GithubDir ¶

func (ctx Context) GithubDir() string

func (Context) GithubWorkflowsDir ¶

func (ctx Context) GithubWorkflowsDir() string

func (Context) GoModFile ¶

func (ctx Context) GoModFile() string

func (Context) MkdocsConfigFile ¶

func (ctx Context) MkdocsConfigFile() string

func (Context) SonarProjectFile ¶

func (ctx Context) SonarProjectFile() string

func (Context) VSCodeWorkspaceFile ¶

func (ctx Context) VSCodeWorkspaceFile() string

type TestcontainersModule ¶

type TestcontainersModule struct {
	Image     string // fully qualified name of the Docker image
	IsModule  bool   // if true, the module will be generated as a Go module, otherwise an example
	Name      string
	TitleName string // title of the name: m.g. "mongodb" -> "MongoDB"
	TCVersion string // Testcontainers for Go version
}

func (*TestcontainersModule) ContainerName ¶

func (m *TestcontainersModule) ContainerName() string

ContainerName returns the name of the container, which is the lower-cased title of the example If the title is set, it will be used instead of the name

func (*TestcontainersModule) Entrypoint ¶

func (m *TestcontainersModule) Entrypoint() string

Entrypoint returns the name of the entrypoint function, which is the lower-cased title of the example If the example is a module, the entrypoint will be "RunContainer"

func (*TestcontainersModule) Lower ¶

func (m *TestcontainersModule) Lower() string

func (*TestcontainersModule) ParentDir ¶

func (m *TestcontainersModule) ParentDir() string

func (*TestcontainersModule) Title ¶

func (m *TestcontainersModule) Title() string

func (*TestcontainersModule) Type ¶

func (m *TestcontainersModule) Type() string

func (*TestcontainersModule) Validate ¶

func (m *TestcontainersModule) Validate() error

type TestcontainersModuleVar ¶

type TestcontainersModuleVar struct {
	Name      string
	NameTitle string
	Image     string
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL