Skip to content

Show env var auth status in cloud auth status#119

Merged
sdairs merged 18 commits into
monorepo-structurefrom
issue-109-auth-status-env-vars
May 5, 2026
Merged

Show env var auth status in cloud auth status#119
sdairs merged 18 commits into
monorepo-structurefrom
issue-109-auth-status-env-vars

Conversation

@sdairs
Copy link
Copy Markdown
Collaborator

@sdairs sdairs commented Apr 16, 2026

Summary

  • Adds an "Env vars" row to cloud auth status that checks for CLICKHOUSE_CLOUD_API_KEY and CLICKHOUSE_CLOUD_API_SECRET environment variables
  • Shows "Active" when both are set, "Incomplete (missing ...)" when only one is set, or "Not configured" when neither is set
  • Works in both table and --json output

Closes #109

Test plan

  • cargo build — clean
  • cargo test -p clickhousectl — 204 tests pass
  • cargo clippy — no warnings
  • Verified table output with no env vars (Not configured)
  • Verified table output with both env vars (Active, read/write)
  • Verified table output with only one env var (Incomplete)
  • Verified --json output includes the env vars row

🤖 Generated with Claude Code

Check for CLICKHOUSE_CLOUD_API_KEY and CLICKHOUSE_CLOUD_API_SECRET
environment variables and display their status (Active, Incomplete,
or Not configured) in the auth status table.

Closes #109

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@sdairs sdairs requested a review from iskakaushik as a code owner April 16, 2026 14:49
Closes #48. Credentials can come from CLI flags, `.clickhouse/credentials.json`,
env vars, or OAuth tokens, and it was hard to tell which one actually won
precedence when debugging. `--debug` now prints the resolved source and API
URL to stderr, so it works equally well with and without `--json`.

`cloud auth status` also gains an `Active` column that marks the winning
source, reusing the same resolution logic.
sdairs and others added 16 commits April 16, 2026 23:06
Plumbs all 13 ClickHouse Cloud managed Postgres operations into the CLI
under `clickhousectl cloud postgres ...` — CRUD, lifecycle (restart/
promote/switchover), CA certs, runtime config (get/replace/patch with
--set key=value overrides), password reset, read replica creation, and
PITR restore. Lives in its own src/cloud/postgres.rs module with 33 new
unit + parse tests and the full write-classification coverage.

Closes #116

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Mirrors the ClickHouse service lifecycle test (create, wait-running, list,
certs, config get, PATCH tags, password reset, restart, delete) against the
Postgres endpoints, wired into the scheduled Cloud Integration workflow.

Password step treats a successful 200 as the pass condition: per the OpenAPI
spec, PostgresServicePasswordResource.password is only populated when the
request omits `password`, so the supplied-password path returns empty by
design.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Tables now render using only ASCII `|` and `-` instead of the
non-standard rounded box-drawing characters, so output is readable in
minimal terminals and log aggregators and pasteable into issues/PRs.

Closes #126
Closes #133. Uses the is-ai-agent crate to detect when the CLI is invoked under a known agent (Claude Code, Cursor, Gemini CLI, Codex, Goose, Devin, etc.) and appends an agent=<id> query param to outbound requests to ClickHouse-owned hosts (builds.clickhouse.com, packages.clickhouse.com, api.clickhouse.cloud). GitHub and other third-party hosts are not annotated. The cloud library gains a generic Client::with_extra_query_params builder so the CLI can attach the tag to every request.
Three of the four credential branches in CloudClient::new differed only in which (key, secret) pair they pulled and which AuthSource label to attach. Introduce ResolvedAuth + resolve_auth() to walk the precedence ladder once, then build the lib client and tag it with the agent param at a single site. resolve_active_auth_source becomes a thin wrapper that preserves its lenient half-set CLI-flag behavior for cloud auth status.
The helper is only called from cloud auth status, which never has --api-key/--api-secret to pass (the subcommand doesn't accept them). The half-set lenient branch and its test were protecting a contract no production caller exercises. Inlining the only sensible call removes the dead parameters and the dead branch, leaving a one-line wrapper that documents its actual purpose: peek at credential precedence without erroring on the empty case (which auth status needs to render no-creds-configured correctly).
The local AgentId -> kebab-case match arm was duplicating a mapping the crate already maintains for its AGENT= env var parser. is-ai-agent 0.2.1 exposes AgentId::as_str returning the canonical kebab-case id (claude-code, gemini-cli, etc.) — the inverse of the parser. Switch to it. Replaces our 12-arm match plus exhaustive variant test with a single delegation and a contract test against the upstream lookup. New agents added upstream automatically flow through without code changes here.
…arams

Rather than thread an agent search param through every clickhouse.com request (with a URL-domain gate, two helpers, and a generic extra-query-params feature on the cloud library), fold the signal into the User-Agent header that every outbound request already carries: clickhousectl/0.1.18 (agent=claude-code). RFC 7231 allows parenthesised comments in User-Agent, and this matches conventional shapes (Mozilla/5.0 etc). Detection still uses is-ai-agent. The change deletes the agent_signal module, the cloud library extra_query_params API + tests, the URL-host parser, and the per-call-site wrappers in version_manager — net -146 lines vs the previous implementation. Every reqwest::Client::builder() in the codebase already calls user_agent::user_agent(), so the new attribution flows through with zero per-call-site wiring.
It's now a one-line implementation detail of an analytics signal — not user-facing functionality, not configurable, not surprising for a future reader to understand from the user_agent.rs source. Doesn't earn a documentation entry.
Pull in upstream security fixes flagged by Dependabot. Both are transitive dependencies; lockfile-only update, no API or behaviour changes. Build and full workspace tests pass.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Tag clickhouse.com requests with detected AI agent
Add --debug flag to report winning cloud credential source
@sdairs sdairs had a problem deploying to cloud-integration May 5, 2026 17:06 — with GitHub Actions Failure
@sdairs sdairs merged commit 0371888 into monorepo-structure May 5, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants