golden_runner library

Classes

BuildContextAssessment
The result of BuildContextGuard.assess.
BuildContextGuard
Decides whether golden_runner should apply a default .dockerignore for a build.
CleanCommand
Command that finds and deletes golden failure directories (and maybe loose files).
CleanRequest
CleanResult
Command
ContainerFailureDiagnostics
Recognizes known container-failure signatures in flutter test output and turns them into a plain-language explanation.
Docker
A Dart client that talks to Docker on the host machine.
DockerGoldenContainer
Client to build a Docker Image and then run it in a Docker Container.
FakeDocker
FvmVersionResolver
Resolves the Flutter version an FVM-configured project is pinned to.
GoldensCommand
Base class for a Golden command, such as test or update goldens.
GoldensCommandEnvironment
GrCheckpoints
Prints high-level, always-visible progress checkpoints with per-step timing.
GrLog
Loggers for Golden Runner (GR).
Level
Levels to control logging output. Logging can be enabled to include all levels above certain Level. Levels are ordered using an integer value Level.value. The predefined Level constants below are sorted as follows (in descending order): Level.SHOUT, Level.SEVERE, Level.WARNING, Level.INFO, Level.CONFIG, Level.FINE, Level.FINER, Level.FINEST, and Level.ALL.
NativeAssetDetector
Detects whether a project needs a C/C++ toolchain (clang) installed in the container to build its tests.
PathDependencyResolver
Finds local path: dependencies that live OUTSIDE the project tree copied into the Docker container, so they can be mounted in.
RunDockerContainerRequest
StreamingMatcher
Detects whether needle appears anywhere across a stream of text chunks, using only O(needle length) memory - so a container's entire (potentially huge) output can be scanned without buffering all of it.
TestGoldensCommand
Command that runs Flutter Golden tests, comparing new test output to existing Golden files.
UpdateGoldensCommand
Command that updates Flutter Golden images.

Enums

BuildContextIgnoreDecision
Whether golden_runner should apply its default .dockerignore for a build.
DockerVerbosity

Functions

consumeSilently(Process process, {void onStdout(String)?, void onStderr(String)?, void onScan(String)?}) Future<int>
Consumes a process's output for silent mode.
createGoldenTesterDockerfile({String? flutterVersion, String? ubuntuVersion, bool includeCToolchain = true}) String
Builds golden_runner's built-in ("virtual") Dockerfile.
hasArgumentFlag(List<String> arguments, List<String> names) bool
Returns true if any of names is present in arguments, WITHOUT removing them (so they can still be forwarded, e.g. to flutter test).
parseArgumentFlag(List<String> arguments, String name) bool
Returns true if the boolean flag name is present in arguments, removing every occurrence of it from the list.
parseArgumentOption(List<String> arguments, String name) String?
parseCleanCommandArguments(List<String> arguments) CleanRequest

Typedefs

ExitCode = int