wavetest

Documentation

Overview

Package wavetest centralizes shared test fixtures for waveconfig.ParsedConfig and related helpers used across Go test packages in this repository.

Index

• func EnsureViteConfig(tb testing.TB, cfg waveconfig.ParsedConfig)
• func MarshalParsedConfigToRawJSON(parsedConfig waveconfig.ParsedConfig) ([]byte, error)
• func MustCWDRelativePath(path string) string
• func NewDiscardLogger() *slog.Logger
• func NewParsedConfigAtRoot(tb testing.TB, root string) waveconfig.ParsedConfig
• func NewWorkspaceTempDir(tb testing.TB, prefix string) string
• func SetCSSEntryFiles(cfg waveconfig.ParsedConfig, criticalEntry string, nonCriticalEntry string)
• func SetCoreCriticalCSSEntryFile(cfg waveconfig.ParsedConfig, criticalCSSEntryFile string)
• func SetCoreDevBuildHook(cfg waveconfig.ParsedConfig, devBuildHook string)
• func SetCoreDevBuildHookTimeoutMilliseconds(cfg waveconfig.ParsedConfig, timeoutMilliseconds int)
• func SetCoreMainAppEntry(cfg waveconfig.ParsedConfig, mainAppEntry string)
• func SetCoreNonCriticalCSSEntryFile(cfg waveconfig.ParsedConfig, nonCriticalCSSEntryFile string)
• func SetCoreProdBuildHook(cfg waveconfig.ParsedConfig, prodBuildHook string)
• func SetCoreProdBuildHookTimeoutMilliseconds(cfg waveconfig.ParsedConfig, timeoutMilliseconds int)
• func SetCorePublicPathPrefix(cfg waveconfig.ParsedConfig, publicPathPrefix string)
• func SetCoreSequentialGoBuild(cfg waveconfig.ParsedConfig, sequentialGoBuild bool)
• func SetCoreServerOnlyMode(cfg waveconfig.ParsedConfig, serverOnlyMode bool)
• func SetCoreStaticAssetDirsPrivate(cfg waveconfig.ParsedConfig, staticAssetsPrivateDirectory string)
• func SetCoreStaticAssetDirsPublic(cfg waveconfig.ParsedConfig, staticAssetsPublicDirectory string)
• func SetStaticAssetDirectories(cfg waveconfig.ParsedConfig, publicDir string, privateDir string)
• func SetViteConfigFile(cfg waveconfig.ParsedConfig, viteConfigFilePath string)
• func SetViteDefaultPort(cfg waveconfig.ParsedConfig, defaultPort int)
• func SetViteJSPackageManagerBaseCmd(cfg waveconfig.ParsedConfig, packageManagerBaseCommand string)
• func SetViteJSPackageManagerCmdDir(cfg waveconfig.ParsedConfig, packageManagerCommandDirectory string)
• func SetWatchConcurrentCallbackTimeoutMilliseconds(cfg waveconfig.ParsedConfig, timeoutMilliseconds int)
• func SetWatchConcurrentCommandTimeoutMilliseconds(cfg waveconfig.ParsedConfig, timeoutMilliseconds int)
• func SetWatchConcurrentNoWaitCallbackTimeoutMilliseconds(cfg waveconfig.ParsedConfig, timeoutMilliseconds int)
• func SetWatchConcurrentNoWaitCommandTimeoutMilliseconds(cfg waveconfig.ParsedConfig, timeoutMilliseconds int)
• func SetWatchExcludeDirs(cfg waveconfig.ParsedConfig, excludeDirs []string)
• func SetWatchExcludeFiles(cfg waveconfig.ParsedConfig, excludeFiles []string)
• func SetWatchHealthcheckEndpoint(cfg waveconfig.ParsedConfig, healthcheckEndpoint string)
• func SetWatchHookStageFailurePolicy(cfg waveconfig.ParsedConfig, hookStageFailurePolicy string)
• func SetWatchInclude(cfg waveconfig.ParsedConfig, include []wavewatch.WatchedFile)
• func SetWatchPostCallbackTimeoutMilliseconds(cfg waveconfig.ParsedConfig, timeoutMilliseconds int)
• func SetWatchPostCommandTimeoutMilliseconds(cfg waveconfig.ParsedConfig, timeoutMilliseconds int)
• func SetWatchPreCallbackTimeoutMilliseconds(cfg waveconfig.ParsedConfig, timeoutMilliseconds int)
• func SetWatchPreCommandTimeoutMilliseconds(cfg waveconfig.ParsedConfig, timeoutMilliseconds int)

Functions

func EnsureViteConfig

func EnsureViteConfig(
	tb testing.TB,
	cfg waveconfig.ParsedConfig,
)

EnsureViteConfig allocates cfg.Vite through parse/reparse when tests require a non-nil Vite section and the fixture omitted it.

func MarshalParsedConfigToRawJSON

func MarshalParsedConfigToRawJSON(
	parsedConfig waveconfig.ParsedConfig,
) ([]byte, error)

MarshalParsedConfigToRawJSON serializes one ParsedConfig into Wave config JSON shape using config-file-relative path fields.

func MustCWDRelativePath

func MustCWDRelativePath(path string) string

MustCWDRelativePath converts one absolute filesystem path into a path relative to the current working directory. Relative inputs are cleaned and returned unchanged.

func NewDiscardLogger

func NewDiscardLogger() *slog.Logger

NewDiscardLogger returns a logger that discards all output.

func NewParsedConfigAtRoot

func NewParsedConfigAtRoot(
	tb testing.TB,
	root string,
) waveconfig.ParsedConfig

NewParsedConfigAtRoot builds a default ParsedConfig rooted at root.

func NewWorkspaceTempDir

func NewWorkspaceTempDir(tb testing.TB, prefix string) string

NewWorkspaceTempDir allocates one per-test temporary directory in the operating-system temp area and registers cleanup on the test.

func SetCSSEntryFiles

func SetCSSEntryFiles(
	cfg waveconfig.ParsedConfig,
	criticalEntry string,
	nonCriticalEntry string,
)

SetCSSEntryFiles sets Core.CSSEntryFiles using explicit critical and non-critical CSS entry paths through parse/reparse.

func SetCoreCriticalCSSEntryFile

func SetCoreCriticalCSSEntryFile(
	cfg waveconfig.ParsedConfig,
	criticalCSSEntryFile string,
)

SetCoreCriticalCSSEntryFile mutates Core.CSSEntryFiles.Critical through parse/reparse.

func SetCoreDevBuildHook

func SetCoreDevBuildHook(cfg waveconfig.ParsedConfig, devBuildHook string)

SetCoreDevBuildHook mutates Core.DevBuildHook through parse/reparse.

func SetCoreDevBuildHookTimeoutMilliseconds

func SetCoreDevBuildHookTimeoutMilliseconds(
	cfg waveconfig.ParsedConfig,
	timeoutMilliseconds int,
)

SetCoreDevBuildHookTimeoutMilliseconds mutates Core.DevBuildHookTimeoutMilliseconds through parse/reparse.

func SetCoreMainAppEntry

func SetCoreMainAppEntry(cfg waveconfig.ParsedConfig, mainAppEntry string)

SetCoreMainAppEntry mutates Core.MainAppEntry through parse/reparse.

func SetCoreNonCriticalCSSEntryFile

func SetCoreNonCriticalCSSEntryFile(
	cfg waveconfig.ParsedConfig,
	nonCriticalCSSEntryFile string,
)

SetCoreNonCriticalCSSEntryFile mutates Core.CSSEntryFiles.NonCritical through parse/reparse.

func SetCoreProdBuildHook

func SetCoreProdBuildHook(cfg waveconfig.ParsedConfig, prodBuildHook string)

SetCoreProdBuildHook mutates Core.ProdBuildHook through parse/reparse.

func SetCoreProdBuildHookTimeoutMilliseconds

func SetCoreProdBuildHookTimeoutMilliseconds(
	cfg waveconfig.ParsedConfig,
	timeoutMilliseconds int,
)

SetCoreProdBuildHookTimeoutMilliseconds mutates Core.ProdBuildHookTimeoutMilliseconds through parse/reparse.

func SetCorePublicPathPrefix

func SetCorePublicPathPrefix(
	cfg waveconfig.ParsedConfig,
	publicPathPrefix string,
)

SetCorePublicPathPrefix mutates Core.PublicPathPrefix through parse/reparse.

func SetCoreSequentialGoBuild

func SetCoreSequentialGoBuild(
	cfg waveconfig.ParsedConfig,
	sequentialGoBuild bool,
)

SetCoreSequentialGoBuild mutates Core.SequentialGoBuild through parse/reparse.

func SetCoreServerOnlyMode

func SetCoreServerOnlyMode(cfg waveconfig.ParsedConfig, serverOnlyMode bool)

SetCoreServerOnlyMode mutates Core.ServerOnlyMode through parse/reparse.

func SetCoreStaticAssetDirsPrivate

func SetCoreStaticAssetDirsPrivate(
	cfg waveconfig.ParsedConfig,
	staticAssetsPrivateDirectory string,
)

SetCoreStaticAssetDirsPrivate mutates Core.StaticAssetDirs.Private through parse/reparse.

func SetCoreStaticAssetDirsPublic

func SetCoreStaticAssetDirsPublic(
	cfg waveconfig.ParsedConfig,
	staticAssetsPublicDirectory string,
)

SetCoreStaticAssetDirsPublic mutates Core.StaticAssetDirs.Public through parse/reparse.

func SetStaticAssetDirectories

func SetStaticAssetDirectories(
	cfg waveconfig.ParsedConfig,
	publicDir string,
	privateDir string,
)

SetStaticAssetDirectories sets Core.StaticAssetDirs using explicit directory paths through parse/reparse.

func SetViteConfigFile

func SetViteConfigFile(
	cfg waveconfig.ParsedConfig,
	viteConfigFilePath string,
)

SetViteConfigFile mutates Vite.ViteConfigFile through parse/reparse.

func SetViteDefaultPort

func SetViteDefaultPort(cfg waveconfig.ParsedConfig, defaultPort int)

SetViteDefaultPort mutates Vite.DefaultPort through parse/reparse.

func SetViteJSPackageManagerBaseCmd

func SetViteJSPackageManagerBaseCmd(
	cfg waveconfig.ParsedConfig,
	packageManagerBaseCommand string,
)

SetViteJSPackageManagerBaseCmd mutates Vite.JSPackageManagerBaseCmd through parse/reparse.

func SetViteJSPackageManagerCmdDir

func SetViteJSPackageManagerCmdDir(
	cfg waveconfig.ParsedConfig,
	packageManagerCommandDirectory string,
)

SetViteJSPackageManagerCmdDir mutates Vite.JSPackageManagerCmdDir through parse/reparse.

func SetWatchConcurrentCallbackTimeoutMilliseconds

func SetWatchConcurrentCallbackTimeoutMilliseconds(
	cfg waveconfig.ParsedConfig,
	timeoutMilliseconds int,
)

SetWatchConcurrentCallbackTimeoutMilliseconds mutates Watch.HookCallbackTimeouts.ConcurrentCallbackTimeoutMilliseconds through parse/reparse.

func SetWatchConcurrentCommandTimeoutMilliseconds

func SetWatchConcurrentCommandTimeoutMilliseconds(
	cfg waveconfig.ParsedConfig,
	timeoutMilliseconds int,
)

SetWatchConcurrentCommandTimeoutMilliseconds mutates Watch.HookCommandTimeouts.ConcurrentCommandTimeoutMilliseconds through parse/reparse.

func SetWatchConcurrentNoWaitCallbackTimeoutMilliseconds

func SetWatchConcurrentNoWaitCallbackTimeoutMilliseconds(
	cfg waveconfig.ParsedConfig,
	timeoutMilliseconds int,
)

SetWatchConcurrentNoWaitCallbackTimeoutMilliseconds mutates Watch.HookCallbackTimeouts.ConcurrentNoWaitCallbackTimeoutMilliseconds through parse/reparse.

func SetWatchConcurrentNoWaitCommandTimeoutMilliseconds

func SetWatchConcurrentNoWaitCommandTimeoutMilliseconds(
	cfg waveconfig.ParsedConfig,
	timeoutMilliseconds int,
)

SetWatchConcurrentNoWaitCommandTimeoutMilliseconds mutates Watch.HookCommandTimeouts.ConcurrentNoWaitCommandTimeoutMilliseconds through parse/reparse.

func SetWatchExcludeDirs

func SetWatchExcludeDirs(cfg waveconfig.ParsedConfig, excludeDirs []string)

SetWatchExcludeDirs mutates Watch.Exclude.Dirs through parse/reparse.

func SetWatchExcludeFiles

func SetWatchExcludeFiles(cfg waveconfig.ParsedConfig, excludeFiles []string)

SetWatchExcludeFiles mutates Watch.Exclude.Files through parse/reparse.

func SetWatchHealthcheckEndpoint

func SetWatchHealthcheckEndpoint(
	cfg waveconfig.ParsedConfig,
	healthcheckEndpoint string,
)

SetWatchHealthcheckEndpoint mutates Watch.HealthcheckEndpoint through parse/reparse.

func SetWatchHookStageFailurePolicy

func SetWatchHookStageFailurePolicy(
	cfg waveconfig.ParsedConfig,
	hookStageFailurePolicy string,
)

SetWatchHookStageFailurePolicy mutates Watch.HookStageFailurePolicy through parse/reparse.

func SetWatchInclude

func SetWatchInclude(
	cfg waveconfig.ParsedConfig,
	include []wavewatch.WatchedFile,
)

SetWatchInclude mutates Watch.Include through parse/reparse.

func SetWatchPostCallbackTimeoutMilliseconds

func SetWatchPostCallbackTimeoutMilliseconds(
	cfg waveconfig.ParsedConfig,
	timeoutMilliseconds int,
)

SetWatchPostCallbackTimeoutMilliseconds mutates Watch.HookCallbackTimeouts.PostCallbackTimeoutMilliseconds through parse/reparse.

func SetWatchPostCommandTimeoutMilliseconds

func SetWatchPostCommandTimeoutMilliseconds(
	cfg waveconfig.ParsedConfig,
	timeoutMilliseconds int,
)

SetWatchPostCommandTimeoutMilliseconds mutates Watch.HookCommandTimeouts.PostCommandTimeoutMilliseconds through parse/reparse.

func SetWatchPreCallbackTimeoutMilliseconds

func SetWatchPreCallbackTimeoutMilliseconds(
	cfg waveconfig.ParsedConfig,
	timeoutMilliseconds int,
)

SetWatchPreCallbackTimeoutMilliseconds mutates Watch.HookCallbackTimeouts.PreCallbackTimeoutMilliseconds through parse/reparse.

func SetWatchPreCommandTimeoutMilliseconds

func SetWatchPreCommandTimeoutMilliseconds(
	cfg waveconfig.ParsedConfig,
	timeoutMilliseconds int,
)

SetWatchPreCommandTimeoutMilliseconds mutates Watch.HookCommandTimeouts.PreCommandTimeoutMilliseconds through parse/reparse.