Skip to content

Configuration Reference

EchoSphere reads environment configuration from an es.ini file. This file defines one or more environments and a default.

File Structure

[default]
env = env.snowflake.dev  # Name of the default environment (could also be env.postgres.dev)

[env.snowflake.dev]
platform = snowflake
user = ...
password = ...
account = ...
warehouse = ...
role = ...
database = ...
schema = ...

[env.snowflake.prod]
platform = snowflake
user = ...
password = ...
account = ...
warehouse = ...
role = ...
database = ...
schema = ...

[env.postgres.dev]
platform = postgres
host = ...
port = 5432
database = ...
schema = public
user = ...
password = ...
sslmode = ...  # optional

Sections

  • [default]
  • env: the environment name to use when no --environment is provided.
  • [env..]
  • platform: snowflake, postgres, databricks, or sqlite.
  • For Snowflake: user, password, account, warehouse, role, database, schema.
  • For Postgres: host, port, database, schema, user, password, sslmode (optional).
  • For Databricks: server_hostname, http_path, access_token, optional catalog, optional schema.
  • For SQLite: database (path to local sqlite database file).

Selecting the Environment

  • CLI option: es run --environment env.snowflake.dev
  • Environment variable: ES_ENV_NAME=env.snowflake.dev es run

If neither is provided, EchoSphere uses the environment defined in [default].

Test Discovery

  • EchoSphere discovers tests with the .es.sql suffix.
  • By default, discovery path is ./es_suite.
  • Supported locations are:
  • es_suite/*.es.sql
  • es_suite/<subsuite>/*.es.sql

Runtime Options

  • Parallel execution is enabled by default to speed up test runs.
  • Export options:
  • --junitxml PATH — write JUnit XML report
  • --export-failures PATH — write failing rows to Excel (.xlsx)

Best Practices for Configuration

  • Avoid hardcoding secrets in es.ini. Use your secret store or CI secrets to template values at runtime.
  • Use separate environments for dev/staging/prod with least privilege.
  • Keep database and schema values environment-specific for flexibility.