API reference¶

`adc_locust.env_config` ¶

Load, validate, and interactively create the .env file that supplies Nitro API credentials and NetScaler address information.

Credentials are never hardcoded or logged. Values are read from a gitignored .env file in the current working directory (or a path given via --env-file / ADC_LOCUST_ENV_FILE), following the same pattern used by the reference Nitro SDK scripts this project is built from.

`EnvConfigError` ¶

Bases: RuntimeError

Raised when required Nitro connection settings are missing.

`NitroEnvConfig(nitro_user, nitro_pass, nitro_url, verify_tls=False)` `dataclass` ¶

Resolved Nitro API connection settings.

`default_env_path()` ¶

Return the default .env location: ADC_LOCUST_ENV_FILE or CWD/.env.

Source code in src/adc_locust/env_config.py

def default_env_path() -> Path:
    """Return the default `.env` location: `ADC_LOCUST_ENV_FILE` or CWD/.env."""
    if "ADC_LOCUST_ENV_FILE" in os.environ:
        return Path(os.environ["ADC_LOCUST_ENV_FILE"])
    return Path.cwd() / ".env"

`load_env(path=None)` ¶

Load and validate Nitro connection settings from a .env file.

Raises EnvConfigError with a human-readable explanation (including the contents to add) if the file is missing or incomplete.

Source code in src/adc_locust/env_config.py

def load_env(path: Path | None = None) -> NitroEnvConfig:
    """Load and validate Nitro connection settings from a `.env` file.

    Raises EnvConfigError with a human-readable explanation (including the
    contents to add) if the file is missing or incomplete.
    """
    env_path = path or default_env_path()
    missing = missing_variables(env_path)
    if missing:
        reason = "does not exist" if not env_path.exists() else f"is missing {', '.join(missing)}"
        raise EnvConfigError(f"{env_path} {reason}.\n\n{ENV_FILE_HELP.format(path=env_path)}")

    load_dotenv(env_path, override=True)
    values = dotenv_values(env_path)
    return NitroEnvConfig(
        nitro_user=values["NITRO_USER"],  # type: ignore[arg-type]
        nitro_pass=values["NITRO_PASS"],  # type: ignore[arg-type]
        nitro_url=values["NITRO_URL"],  # type: ignore[arg-type]
        verify_tls=_parse_bool(values.get("NITRO_VERIFY_TLS"), OPTIONAL_VARS["NITRO_VERIFY_TLS"] == "true"),
    )

`missing_variables(path)` ¶

Return the required variable names not present (or empty) in path.

Source code in src/adc_locust/env_config.py

def missing_variables(path: Path) -> list[str]:
    """Return the required variable names not present (or empty) in `path`."""
    if not path.exists():
        return list(REQUIRED_VARS)
    values = dotenv_values(path)
    return [name for name in REQUIRED_VARS if not values.get(name)]

`write_env(path, *, nitro_user, nitro_pass, nitro_url, verify_tls=False)` ¶

Create or overwrite path with the given Nitro connection settings.

Used by the interactive setup screen so a .env can be produced without leaving the Textual interface. The file is written with owner-only permissions since it holds a plaintext credential.

Source code in src/adc_locust/env_config.py

def write_env(
    path: Path,
    *,
    nitro_user: str,
    nitro_pass: str,
    nitro_url: str,
    verify_tls: bool = False,
) -> None:
    """Create or overwrite `path` with the given Nitro connection settings.

    Used by the interactive setup screen so a `.env` can be produced without
    leaving the Textual interface. The file is written with owner-only
    permissions since it holds a plaintext credential.
    """
    content = (
        "# Created by adc-locust's interactive setup screen.\n"
        "# Nitro API credentials and NetScaler address information.\n"
        f"NITRO_USER={nitro_user}\n"
        f"NITRO_PASS={nitro_pass}\n"
        f"NITRO_URL={nitro_url}\n"
        f"NITRO_VERIFY_TLS={'true' if verify_tls else 'false'}\n"
    )
    path.write_text(content, encoding="utf-8")
    with contextlib.suppress(OSError):
        path.chmod(0o600)  # Best-effort on platforms/filesystems that don't support chmod.

`adc_locust.nitro_client` ¶

Read-only Nitro API client used to discover NetScaler load-balancing and content-switching configuration available for load testing.

Built from the patterns in list-vservers-multi-service.py, check-cs-targets.py, and dot_4485/locust/common/distribution_check.py (nitro reference project). All operations here are read-only queries against the ADC — no configuration is created, modified, or deleted.

`BoundService(name, weight=None)` `dataclass` ¶

One service bound to an LB vserver.

`CSPolicyBinding(policy_name, priority, rule, target_lbvserver)` `dataclass` ¶

One Content Switching policy bound to a CS vserver.