mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
test: Generate golden files for all (visible) CLI commands (#5479)
This commit is contained in:
Mathias Fredriksson
@@ -0,0 +1,129 @@
|
||||
Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard.
|
||||
|
||||
Usage:
|
||||
coder scaletest create-workspaces [flags]
|
||||
|
||||
Flags:
|
||||
--cleanup-concurrency int Number of concurrent cleanup jobs to run. 0 means
|
||||
unlimited.
|
||||
Consumes $CODER_LOADTEST_CLEANUP_CONCURRENCY
|
||||
(default 1)
|
||||
--cleanup-job-timeout duration Timeout per job. Jobs may take longer to complete
|
||||
under higher concurrency limits.
|
||||
Consumes $CODER_LOADTEST_CLEANUP_JOB_TIMEOUT
|
||||
(default 5m0s)
|
||||
--cleanup-timeout duration Timeout for the entire cleanup run. 0 means
|
||||
unlimited.
|
||||
Consumes $CODER_LOADTEST_CLEANUP_TIMEOUT (default
|
||||
30m0s)
|
||||
--concurrency int Number of concurrent jobs to run. 0 means
|
||||
unlimited.
|
||||
Consumes $CODER_LOADTEST_CONCURRENCY (default 1)
|
||||
--connect-hold duration How long to hold the WireGuard connection open
|
||||
for.
|
||||
Consumes $CODER_LOADTEST_CONNECT_HOLD (default 30s)
|
||||
--connect-interval duration How long to wait between making requests to the
|
||||
--connect-url once the connection is established.
|
||||
Consumes $CODER_LOADTEST_CONNECT_INTERVAL (default 1s)
|
||||
--connect-mode string Mode to use for connecting to the workspace. Can
|
||||
be 'derp' or 'direct'.
|
||||
Consumes $CODER_LOADTEST_CONNECT_MODE (default "derp")
|
||||
--connect-timeout duration Timeout for each request to the --connect-url.
|
||||
Consumes $CODER_LOADTEST_CONNECT_TIMEOUT (default 5s)
|
||||
--connect-url string URL to connect to inside the the workspace over
|
||||
WireGuard. If not specified, no connections will
|
||||
be made over WireGuard.
|
||||
Consumes $CODER_LOADTEST_CONNECT_URL
|
||||
-c, --count int Required: Number of workspaces to create.
|
||||
Consumes $CODER_LOADTEST_COUNT (default 1)
|
||||
-h, --help help for create-workspaces
|
||||
--job-timeout duration Timeout per job. Jobs may take longer to complete
|
||||
under higher concurrency limits.
|
||||
Consumes $CODER_LOADTEST_JOB_TIMEOUT (default 5m0s)
|
||||
--no-cleanup coder scaletest cleanup Do not clean up resources after the test
|
||||
completes. You can cleanup manually using coder
|
||||
scaletest cleanup.
|
||||
Consumes $CODER_LOADTEST_NO_CLEANUP
|
||||
--no-plan Skip the dry-run step to plan the workspace
|
||||
creation. This step ensures that the given
|
||||
parameters are valid for the given template.
|
||||
Consumes $CODER_LOADTEST_NO_PLAN
|
||||
--no-wait-for-agents Do not wait for agents to start before marking
|
||||
the test as succeeded. This can be useful if you
|
||||
are running the test against a template that does
|
||||
not start the agent quickly.
|
||||
Consumes $CODER_LOADTEST_NO_WAIT_FOR_AGENTS
|
||||
--output stringArray Output format specs in the format
|
||||
"<format>[:<path>]". Not specifying a path will
|
||||
default to stdout. Available formats: text, json.
|
||||
Consumes $CODER_SCALETEST_OUTPUTS (default [text])
|
||||
--parameter stringArray Parameters to use for each workspace. Can be
|
||||
specified multiple times. Overrides any existing
|
||||
parameters with the same name from
|
||||
--parameters-file. Format: key=value.
|
||||
Consumes $CODER_LOADTEST_PARAMETERS
|
||||
--parameters-file string Path to a YAML file containing the parameters to
|
||||
use for each workspace.
|
||||
Consumes $CODER_LOADTEST_PARAMETERS_FILE
|
||||
--run-command string Command to run inside each workspace using
|
||||
reconnecting-pty (i.e. web terminal protocol). If
|
||||
not specified, no command will be run.
|
||||
Consumes $CODER_LOADTEST_RUN_COMMAND
|
||||
--run-expect-output string Expect the command to output the given string (on
|
||||
a single line). If the command does not output
|
||||
the given string, it will be marked as failed.
|
||||
Consumes $CODER_LOADTEST_RUN_EXPECT_OUTPUT
|
||||
--run-expect-timeout Expect the command to timeout. If the command
|
||||
does not finish within the given --run-timeout,
|
||||
it will be marked as succeeded. If the command
|
||||
finishes before the timeout, it will be marked as
|
||||
failed.
|
||||
Consumes $CODER_LOADTEST_RUN_EXPECT_TIMEOUT
|
||||
--run-log-output Log the output of the command to the test logs.
|
||||
This should be left off unless you expect small
|
||||
amounts of output. Large amounts of output will
|
||||
cause high memory usage.
|
||||
Consumes $CODER_LOADTEST_RUN_LOG_OUTPUT
|
||||
--run-timeout duration Timeout for the command to complete.
|
||||
Consumes $CODER_LOADTEST_RUN_TIMEOUT (default 5s)
|
||||
-t, --template string Required: Name or ID of the template to use for
|
||||
workspaces.
|
||||
Consumes $CODER_LOADTEST_TEMPLATE
|
||||
--timeout duration Timeout for the entire test run. 0 means
|
||||
unlimited.
|
||||
Consumes $CODER_LOADTEST_TIMEOUT (default 30m0s)
|
||||
--trace Whether application tracing data is collected. It
|
||||
exports to a backend configured by environment
|
||||
variables. See:
|
||||
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
|
||||
Consumes $CODER_LOADTEST_TRACE
|
||||
--trace-coder Whether opentelemetry traces are sent to Coder.
|
||||
We recommend keeping this disabled unless we
|
||||
advise you to enable it.
|
||||
Consumes $CODER_LOADTEST_TRACE_CODER
|
||||
--trace-honeycomb-api-key string Enables trace exporting to Honeycomb.io using the
|
||||
provided API key.
|
||||
Consumes $CODER_LOADTEST_TRACE_HONEYCOMB_API_KEY
|
||||
--trace-propagate Enables trace propagation to the Coder backend,
|
||||
which will be used to correlate server-side spans
|
||||
with client-side spans. Only enable this if the
|
||||
server is configured with the exact same tracing
|
||||
configuration as the client.
|
||||
Consumes $CODER_LOADTEST_TRACE_PROPAGATE
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "/tmp/coder-cli-test-config")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
Reference in New Issue
Block a user