Skip to content
This repository was archived by the owner on Mar 16, 2026. It is now read-only.

Latest commit

 

History

History
76 lines (53 loc) · 2.45 KB

test.md

File metadata and controls

76 lines (53 loc) · 2.45 KB
title test
hide_title true
hide_table_of_contents false
keywords
stackql
stackql-deploy
infrastructure-as-code
configuration-as-data
tags
stackql
stackql-deploy
infrastructure-as-code
configuration-as-data
description Documentation for the test command in StackQL Deploy
image /img/stackql-cover.png

test

Command used to confirm the desired state of resources in a specified stack in a given environment.


Syntax

stackql-deploy test STACK_DIR STACK_ENV [FLAGS]


Arguments

Argument Description Example
STACK_DIR The directory containing the stack configuration files my-stack
STACK_ENV The target environment for testing the stack dev

:::info

STACK_DIR can be an absolute or relative path.

STACK_ENV is a user-defined environment symbol (e.g., dev, sit, prd) used to test your stack in different environments.

:::

Optional Flags

Flag Description Example
--log-level Set the logging level. Default is INFO --log-level DEBUG
--env-file Specify an environment variables file. Default is .env --env-file .env
-e --env Set additional environment variables (can be used multiple times) --env DB_USER=admin
--dry-run Perform a dry run of the operation. No changes will be made
--show-queries Display the queries executed in the output logs
--download-dir Custom download directory for StackQL /etc/stackql
--custom-registry Custom StackQL provider registry URL https://myreg

:::tip

Exported variables specified as protected in the respective resource definition in the stackql_manifest.yml file are obfuscated in the logs by default.

:::


Examples

Confirm desired state for a stack in a target environment

Run tests for the stack defined in the azure-stack directory in the sit environment, setting additional environment variables:

stackql-deploy test azure-stack sit \
-e AZURE_SUBSCRIPTION_ID=631d1c6d-0000-0000-0000-688bfe4e1468