utils

Jul 19, 2026

Changes in this version

+ func Eventually(check func() error) error

+ func EventuallyWithTimeout(timeout time.Duration, interval time.Duration, check func() error) error

+ func WaitMillis(milliseconds int)

May 31, 2026

Changes in this version

+ const BrandName

+ const CurrentAttemptField

+ const DefaultPostgresPort

+ const DirectoryField

+ const EmailServiceNotEnabledErrorMessage

+ const FolderToFindField

+ const HostField

+ const InitialDirField

+ const LicenseTokenSigningPublicKeyOpenSSH

+ const LocalTestingPublicKeyOpenSSH

+ const MaximumAttemptsFields

+ const OfficialBrandAppName

+ const OfficialDatabaseAppName

+ const OfficialMaintainer

+ const PortField

+ const PostgresAdminDatabase

+ const PostgresApplicationDatabase

+ const PostgresApplicationTemplate

+ const SizeInBytesField

+ var LicenseTokenSigningPublicKeyOpenSSHBytes = []byte(LicenseTokenSigningPublicKeyOpenSSH)

+ var LocalTestingPublicKeyOpenSSHBytes = []byte(LocalTestingPublicKeyOpenSSH)

+ var Logger = deepstack.NewDeepStackLogger(deepstack.NewRawConsoleHandler(slog.LevelInfo))

+ var OperationFailedError = "Operation failed"

+ func AssertDeepStackErrorFromRequest(t *testing.T, err error, expectedResponseBodyErrorMessage string)

+ func AssertInvalidInputError(t *testing.T, err error)

+ func BuildArtifacts(tr *taskrunner.TaskRunner, moduleRoot string)

+ func BuildWholeGoProject(Tr *taskrunner.TaskRunner, directory string)

+ func Close(r Closable)

+ func CollectBuildTags(dir string) ([]string, error)

+ func DecodeAuthorizedEd25519PublicKey(authorizedKey []byte) (ed25519.PublicKey, error)

+ func DecodeEd25519PrivateKeyOpenSSH(privateKeyOpenSSH []byte) (ed25519.PrivateKey, error)

+ func ExtractError(err error) string

+ func FindDir(dirName string) (string, error)

+ func FormatRelativeDuration(now, target time.Time) string

+ func GetLocalTestingPrivateKeyBytes() []byte

+ func GetLocalTestingPrivateKeyOpenSSH() string

+ func GetLocalTestingPublicKeyFingerprintSHA256() string

+ func GetLocalTestingPublicKeyRaw() []byte

+ func IsGeneratedArtifactFile(fileName string) bool

+ func IsSystemApp(appName string) bool

+ func MapOf(elements ...string) map[string]any

+ func NewDockerRuntimeCleanupCommand(tr *taskrunner.TaskRunner) *cobra.Command

+ func NewFileHandler(level slog.Level) *slog.JSONHandler

+ func ReadLicenseKeyFromUserConfig() (string, error)

+ func RecoverHttpPanics(next http.Handler) http.Handler

+ func RemoveDir(path string)

+ func RemoveGeneratedArtifacts(rootDir string)

+ func RenderDefaultPage(htmlContent string) string

+ func RunAndLogIfError(fn func() error)

+ func SendJsonResponse(w http.ResponseWriter, data any)

+ func SetCookieHeaders(req *http.Request, c *ComponentClient)

+ func ShowHelpCommand(cmd *cobra.Command)

+ func UnpackResponse[T any](object any) (*T, error)

+ func WriteResponseError(w http.ResponseWriter, expectedErrors map[string]any, err error, ...)

+ func WriteResponseErrorAlways(w http.ResponseWriter, err error, context ...any)

+ type ArtifactDiscovery struct

+ MockeryDirs []string

+ WireDirs []string

+ func DiscoverArtifacts(moduleRoot string) (ArtifactDiscovery, error)

+ type AuthHelper interface

+ DoesMatchSaltedHash func(clearText, saltedHash string) bool

+ GenerateCookie func() (*http.Cookie, error)

+ GenerateSecret func() (string, error)

+ GetSHA256Hash func(plainText string) string

+ GetTimeInSevenDays func() time.Time

+ SaltAndHash func(clearText string) (string, error)

+ type AuthHelperImpl struct

+ func (a *AuthHelperImpl) DoesMatchSaltedHash(clearText, saltedHash string) bool

+ func (a *AuthHelperImpl) GenerateCookie() (*http.Cookie, error)

+ func (a *AuthHelperImpl) GenerateSecret() (string, error)

+ func (a *AuthHelperImpl) GetSHA256Hash(plainText string) string

+ func (a *AuthHelperImpl) GetTimeInSevenDays() time.Time

+ func (a *AuthHelperImpl) SaltAndHash(clearText string) (string, error)

+ type BytesSigner interface

+ SignBytes func(privateKey ed25519.PrivateKey, payloadBytes []byte) []byte

+ VerifyBytes func(publicKey ed25519.PublicKey, payloadBytes []byte, signature []byte) bool

+ type BytesSignerImpl struct

+ func (c *BytesSignerImpl) SignBytes(privateKey ed25519.PrivateKey, payloadBytes []byte) []byte

+ func (c *BytesSignerImpl) VerifyBytes(publicKey ed25519.PublicKey, payloadBytes []byte, signature []byte) bool

+ type Closable interface

+ Close func() error

+ type ComponentClient struct

+ Cookie *http.Cookie

+ Origin string

+ RootUrl string

+ SetCookieHeader bool

+ VerifyCertificate bool

+ func (c *ComponentClient) DoRequest(path string, payload any) ([]byte, error)

+ func (c *ComponentClient) DoRequestWithFullResponse(path string, payload any) (*http.Response, error)

+ type ComposeSyntaxChecker interface

+ CheckDockerComposeSyntax func(composeFileBytes []byte) error

+ type DatabaseConnector interface

+ Connect func() error

+ GetDB func() *sql.DB

+ type DatabaseSnapshotRepository interface

+ CreateDatabaseSnapshot func() error

+ DeleteDatabaseSnapshotIfExists func() error

+ ResetDatabaseToSnapshot func() error

+ SnapshotExists func() (bool, error)

+ type DatabaseSnapshotRepositoryImpl struct

+ AdminDatabaseName string

+ ApplicationDatabaseName string

+ DatabaseConnector DatabaseConnector

+ DatabaseHost string

+ DatabasePort string

+ DatabaseUtils DatabaseUtils

+ TemplateDatabaseName string

+ func NewDatabaseSnapshotRepository(databaseHost string, databaseConnector DatabaseConnector, ...) *DatabaseSnapshotRepositoryImpl

+ func (d *DatabaseSnapshotRepositoryImpl) CreateDatabaseSnapshot() error

+ func (d *DatabaseSnapshotRepositoryImpl) DeleteDatabaseSnapshotIfExists() error

+ func (d *DatabaseSnapshotRepositoryImpl) ResetDatabaseToSnapshot() error

+ func (d *DatabaseSnapshotRepositoryImpl) SnapshotExists() (bool, error)

+ type DatabaseUtils interface

+ EnsureDatabaseExists func(host, port, databaseName string) error

+ RunMigrations func(migrationsDir, host, port, databaseName string) error

+ WaitForPostgresDb func(host, port, databaseName string) (*sql.DB, error)

+ type DatabaseUtilsImpl struct

+ func (d *DatabaseUtilsImpl) EnsureDatabaseExists(host, port, databaseName string) error

+ func (d *DatabaseUtilsImpl) RunMigrations(migrationsDir, host, port, databaseName string) error

+ func (d *DatabaseUtilsImpl) WaitForPostgresDb(host, port, databaseName string) (*sql.DB, error)

+ type DockerCliWrapper interface

+ DeleteImage func(image string) error

+ ImageExists func(image string) (bool, error)

+ IsContainerRunning func(containerName string) (bool, error)

+ type DockerCliWrapperImpl struct

+ func (d *DockerCliWrapperImpl) DeleteImage(image string) error

+ func (d *DockerCliWrapperImpl) ImageExists(image string) (bool, error)

+ func (d *DockerCliWrapperImpl) IsContainerRunning(containerName string) (bool, error)

+ type EmailClient interface

+ CheckEmailServerConnection func(emailConfig *EmailConfig) error

+ SendEmail func(emailConfig *EmailConfig, to, subject, body string) error

+ type EmailClientImpl struct

+ func (e *EmailClientImpl) CheckEmailServerConnection(emailConfig *EmailConfig) error

+ func (e *EmailClientImpl) SendEmail(emailConfig *EmailConfig, to, subject, body string) error

+ type EmailClientMock struct

+ func (e EmailClientMock) CheckEmailServerConnection(emailConfig *EmailConfig) error

+ func (e EmailClientMock) SendEmail(emailConfig *EmailConfig, to, subject, body string) error

+ type EmailConfig struct

+ EmailAccountPassword string

+ EmailAccountUsername string

+ FromEmailAddress string

+ IsEnabled bool

+ SMTPHost string

+ SMTPPort string

+ type FileSystemOperator interface

+ CheckDockerComposeSyntax func(composeFileBytes []byte) error

+ ListFiles func(dir string) ([]SimpleFile, error)

+ ReadYamlFile func(dir string) (map[string]any, error)

+ func NewFileSystemOperator(osWrapper OsWrapper) FileSystemOperator

+ type FileSystemOperatorImpl struct

+ OsWrapper OsWrapper

+ func (f *FileSystemOperatorImpl) CheckDockerComposeSyntax(composeFileBytes []byte) error

+ func (f *FileSystemOperatorImpl) ListFiles(dir string) ([]SimpleFile, error)

+ func (f *FileSystemOperatorImpl) ReadYamlFile(path string) (map[string]any, error)

+ type GoTestCommand struct

+ func GoTest(directory string) *GoTestCommand

+ func (c *GoTestCommand) Env(key, value string) *GoTestCommand

+ func (c *GoTestCommand) Filter(runFilter string) *GoTestCommand

+ func (c *GoTestCommand) Run(tr *taskrunner.TaskRunner)

+ func (c *GoTestCommand) Tag(buildTag string) *GoTestCommand

+ type OsWrapper interface

+ AllocateLocalhostPort func() (string, error)

+ DoesFileExist func(path string) (bool, error)

+ GetTempDir func() (string, error)

+ MkdirAll func(path string, perm os.FileMode) error

+ Now func() time.Time

+ PromptUser func(prompt string) (string, error)

+ ReadDir func(path string) ([]os.DirEntry, error)

+ ReadFile func(path string) ([]byte, error)

+ Remove func(path string) error

+ RemoveAll func(path string) error

+ Sleep func(duration time.Duration)

+ WriteFile func(path string, data []byte, perm os.FileMode) error

+ type OsWrapperImpl struct

+ func (o *OsWrapperImpl) AllocateLocalhostPort() (string, error)

+ func (o *OsWrapperImpl) DoesFileExist(path string) (bool, error)

+ func (o *OsWrapperImpl) GetTempDir() (string, error)

+ func (o *OsWrapperImpl) MkdirAll(path string, perm os.FileMode) error

+ func (o *OsWrapperImpl) Now() time.Time

+ func (o *OsWrapperImpl) PromptUser(prompt string) (string, error)

+ func (o *OsWrapperImpl) ReadDir(path string) ([]os.DirEntry, error)

+ func (o *OsWrapperImpl) ReadFile(path string) ([]byte, error)

+ func (o *OsWrapperImpl) Remove(path string) error

+ func (o *OsWrapperImpl) RemoveAll(path string) error

+ func (o *OsWrapperImpl) Sleep(duration time.Duration)

+ func (o *OsWrapperImpl) WriteFile(path string, data []byte, perm os.FileMode) error

+ type SimpleFile struct

+ IsDir bool

+ Name string