Uh oh!
There was an error while loading. Please reload this page.
[VPEX][8] Rename local-env to environments setup-local and move to correct package - #5959
Merged
Conversation
The command is renamed from `local-env python sync` to `environments setup-local` and relocated under the existing (generated) `environments` command group, per the updated spec: that group spans both server-side environment-resource APIs and local provisioning, so a local-install verb belongs there. - Move cmd/localenv → cmd/environments, exposing Commands() (mirrors how cmd/apps extends the generated apps group). - Attach it to the generated group via a new, non-generated cmd/workspace/environments/overrides.go that appends to cmdOverrides; drop the standalone cli.AddCommand(localenv.New()) from cmd/cmd.go. - P0 is Python-only with no language selector, so the `python` subgroup is removed and the verb is bare `setup-local` (a language axis would be additive). Command stays Hidden until the constraints repo is public. - Update the command-name constants (CommandGroup/CommandVerb/CommandName) and derive the pyproject managed-block markers from CommandName so the name lives in one place. - Flag names are unchanged in this PR (--cluster/--serverless/--job/--check/ --constraint-source); the spec's flag renames are a separate follow-up. - Regenerate acceptance goldens and help output. Co-authored-by: Isaac
Audit follow-up for the local-env → environments setup-local rename: - pipeline.go: the --debug log line was prefixed with the literal old name 'local-env:'; derive the prefix from CommandName so it tracks the command name (now 'environments setup-local:'). - sync.go: fix two stale doc comments (the runPipeline doc and the Hidden-flag rationale referencing the removed 'local-env group'). - Rename newSyncCommand → newSetupLocalCommand so the constructor matches the verb. - overrides.go: reword comment to 'local-provisioning commands'. No user-facing behavior change; goldens unaffected (the debug prefix is not captured by acceptance output). Co-authored-by: Isaac
Collaborator
Integration test reportCommit: 1a5d74e
8 interesting tests: 4 SKIP, 2 RECOVERED, 2 flaky
Top 10 slowest tests (at least 2 minutes):
|
anton-107
approved these changes
Jul 17, 2026
This was referenced Jul 17, 2026
environments setup-local and move to correct packageenvironments setup-local and move to correct packagerugpanov
commented
Jul 20, 2026
ContributorAuthor
Got approval from Harry Doan. |
eng-dev-ecosystem-bot
commented
Jul 20, 2026
Collaborator
Integration test reportCommit: dd867ac
29 interesting tests: 18 FAIL, 5 RECOVERED, 3 flaky, 2 SKIP, 1 KNOWN
Top 50 slowest tests (at least 2 minutes):
|
pietern pushed a commit
that referenced
this pull request
Jul 20, 2026
Stacked on #5960 (flag renames), which is stacked on #5959 (command rename). ## What Adds `--cluster-name` as a compute target for `environments setup-local`, per the `[P0] CLI Changes` spec. It resolves the cluster **name** to an **ID** via the Clusters API, then resolves identically to `--cluster-id` (`source=cluster`, env key from the resolved cluster's `spark_version`). ## Changes - `ComputeClient` gains `GetClusterByName`; `sdkCompute` implements it via the SDK's `Clusters.GetByClusterName`, which errors on an **unknown** or **ambiguous** name (two clusters sharing it) — both surfaced as an actionable `E_RESOLVE`. - `--cluster-name` joins the mutually-exclusive target group (`--cluster-id`/`--cluster-name`/`--serverless-version`/`--job-id`) and the bundle-fallback guard. - New `ResolveTarget` precedence branch after `--cluster-id`. ## Testing - Unit tests: success (name→ID→env key), ambiguity → `E_RESOLVE`, and `--cluster-id`/`--cluster-name` mutual exclusivity. - Acceptance: `cluster-name-check` (happy path, stubbed `clusters/list`) and `cluster-name-ambiguous` (`E_RESOLVE`); help golden updated. - `go build ./...`, lint (0 issues), deadcode clean, unit + acceptance green. This pull request and its description were written by Isaac.
yansonggao-db pushed a commit
to yansonggao-db/cli
that referenced
this pull request
Jul 21, 2026
…icks#5965) Stacked on databricks#5964 → databricks#5963 → databricks#5962 → databricks#5961 → databricks#5960 → databricks#5959. ## What `--serverless-version` is now documented to take a **bare number** (e.g. `5`) rather than `v5`. - Input `5` is the documented form; `v5`/`V5` are still accepted (tolerant). - Both map to the same env key `serverless/serverless-vN`, so the **environments-repo layout is unchanged** (still `serverless/serverless-v5/…`). ## Changes - Flag help: `e.g. v4` → `e.g. 5`; the `E_ENV_UNSUPPORTED` hint suggests `--serverless-version 5`. - `defaultServerlessVersion` stored in bare form (`"5"`); still resolves to `serverless-v5` via `NormalizeServerless`. - Acceptance scripts pass the bare form; env-key goldens unchanged (`serverless-vN`). - Unit tests cover bare + v-prefixed input and the default constant. ## Testing `go build ./...`, lint (0 issues), deadcode clean, unit + acceptance green. This pull request and its description were written by Isaac.
tanishgupta-db pushed a commit
to tanishgupta-db/cli
that referenced
this pull request
Jul 21, 2026
… …) (databricks#5960) Stacked on databricks#5959 (the command rename). ## What Renames the `environments setup-local` flags to match the `[P0] CLI Changes` spec: | Old | New | |-----|-----| | `--cluster` | `--cluster-id` | | `--serverless` | `--serverless-version` | | `--job` | `--job-id` | | `--check` | `--dry-run` | | `--constraint-source` | `--constraint-source-url` (still hidden) | ## Changes - Flag definitions, `GetString`/`GetBool` reads, and the mutually-exclusive group in `cmd/environments/sync.go`. - User-facing flag names in `ValidateTargetFlags`, `noTargetMessage`, the `E_ENV_UNSUPPORTED` hint (`constraints.go`), and the job-ambiguity errors (`compute.go`). - Internal `--check` doc comments updated to `--dry-run` for accuracy. - Acceptance scripts + goldens regenerated. No behavior change beyond the flag spellings; the command stays `Hidden`. ## Testing `go build ./...`, lint (0 issues), deadcode clean, `libs/localenv` + `cmd/environments` unit tests, `acceptance/localenv` + `acceptance/help` regenerated and green. This pull request and its description were written by Isaac.
tanishgupta-db pushed a commit
to tanishgupta-db/cli
that referenced
this pull request
Jul 21, 2026
Stacked on databricks#5960 (flag renames), which is stacked on databricks#5959 (command rename). ## What Adds `--cluster-name` as a compute target for `environments setup-local`, per the `[P0] CLI Changes` spec. It resolves the cluster **name** to an **ID** via the Clusters API, then resolves identically to `--cluster-id` (`source=cluster`, env key from the resolved cluster's `spark_version`). ## Changes - `ComputeClient` gains `GetClusterByName`; `sdkCompute` implements it via the SDK's `Clusters.GetByClusterName`, which errors on an **unknown** or **ambiguous** name (two clusters sharing it) — both surfaced as an actionable `E_RESOLVE`. - `--cluster-name` joins the mutually-exclusive target group (`--cluster-id`/`--cluster-name`/`--serverless-version`/`--job-id`) and the bundle-fallback guard. - New `ResolveTarget` precedence branch after `--cluster-id`. ## Testing - Unit tests: success (name→ID→env key), ambiguity → `E_RESOLVE`, and `--cluster-id`/`--cluster-name` mutual exclusivity. - Acceptance: `cluster-name-check` (happy path, stubbed `clusters/list`) and `cluster-name-ambiguous` (`E_RESOLVE`); help golden updated. - `go build ./...`, lint (0 issues), deadcode clean, unit + acceptance green. This pull request and its description were written by Isaac.
tanishgupta-db pushed a commit
to tanishgupta-db/cli
that referenced
this pull request
Jul 21, 2026
Stacked on databricks#5961 (`--cluster-name`) → databricks#5960 → databricks#5959. ## What Per the `[P0] CLI Changes` spec, the serverless stand-in used when the source does not pin a version is now **`serverless-v5`** (was `v4`). Applies only to the fallback cases: - a serverless `--job-id` whose environment records no version, and - a bundle that records `serverless` without a version. Explicitly passing `--serverless-version <vN>` is unaffected. ## Changes - Introduce `defaultServerlessVersion = "v5"` in `envkey.go`, used at both fallback sites in `target.go` so the default lives in one place. - Update the two unit tests that assert the default. No acceptance goldens change: all serverless acceptance tests pass `--serverless-version v4` explicitly, so none exercise the default path. ## Note VS Code resolves the real serverless version itself and passes `--serverless-version` explicitly (spec §63), so this fallback is only hit when the version is genuinely unknown — but v5 is now the correct stand-in per spec. This pull request and its description were written by Isaac.
tanishgupta-db pushed a commit
to tanishgupta-db/cli
that referenced
this pull request
Jul 21, 2026
Stacked on databricks#5962 (serverless-v5) → databricks#5961 → databricks#5960 → databricks#5959. ## What Per the `[P0] CLI Changes` spec, a bad-flags usage error is now surfaced as **`E_USAGE`** at the **preflight** phase, through the phase/JSON contract — instead of a bare Cobra mutual-exclusion error printed before `RunE` (which produces no command JSON object). ## Why The VS Code extension branches on the JSON `error.code`. Previously, passing two target flags triggered Cobra's `MarkFlagsMutuallyExclusive` *before* `RunE`, so `--output json` emitted nothing structured. Now the conflict is caught inside the pipeline and reported like any other phase failure. ## Changes - Add the `E_USAGE` error code. - Validate target flags at the top of the pipeline's preflight → `E_USAGE`, `diskMutated=false`. - Drop `cmd.MarkFlagsMutuallyExclusive` and the redundant early-return in `runPipeline` so the conflict flows into the pipeline. - `flag-conflict` golden updated (now shows the phase table + preflight error); new `flag-conflict-json` asserts `error{code:"E_USAGE", failurePhase:"preflight"}`; pipeline unit test for the path. ## Testing `go build ./...`, lint (0 issues), deadcode clean, unit + acceptance green. This pull request and its description were written by Isaac.
tanishgupta-db pushed a commit
to tanishgupta-db/cli
that referenced
this pull request
Jul 21, 2026
…ricks#5964) Stacked on databricks#5963 (E_USAGE) → databricks#5962 → databricks#5961 → databricks#5960 → databricks#5959. ## What Reconciles the error codes with the `[P0] CLI Changes` spec table (spec item databricks#10). **No behavior change** — the code already emits the correct set. The spec's table was stale: - omitted `E_NOT_WRITABLE` (preflight) and `E_PYTHON_INSTALL` (provision), and - wrongly listed `E_UV_MISSING` as "reserved / not emitted" when the CLI does emit it at preflight. ## Changes - Annotate each `ErrorCode` constant with the phase that emits it, and document the two spec codes the CLI deliberately never emits: `E_PYTHON_POLICY` (no signal source yet) and `E_AUTH` (handled earlier by `MustWorkspaceClient`). This makes the constant block the authoritative reference the spec mirrors. - Fix a `TargetInfo` doc comment that still said "four precedence sources" — with `--cluster-name` there are now five flag sources (the JSON `source` value is still one of cluster/serverless/job/bundle). ## Note The spec doc's error-code table itself (in the VPEX ERD, a Google Doc) has been updated separately to match — that's outside this repo. ## Testing `go build ./...`, lint (0 issues), deadcode clean, unit + acceptance green (comment-only code change). This pull request and its description were written by Isaac.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Renames the local-environment command from
databricks local-env python synctodatabricks environments setup-localand moves it into the existingenvironmentscommand group, per the updated[P0] CLI Changesspec.The
environmentsgroup intentionally spans both server-side environment-resourceAPIs and local provisioning, so a local-install verb belongs there rather than in a
standalone top-level group.
Why here (package placement)
cmd/workspace/environments/environments.gois generated (DO NOT EDIT), so thecommand is attached the same way
cmd/appsextends the generatedappsgroup:cmd/environments/(hand-written, moved fromcmd/localenv/) exposes aCommands()function returning thesetup-localverb.cmd/workspace/environments/overrides.go(new, non-generated) has aninit()that appends to the generated group's
cmdOverrideshook, attaching the command.cli.AddCommand(localenv.New())is dropped fromcmd/cmd.go.Changes
local-env python sync→environments setup-local. Thepythonsubgroup is removed — P0 is Python-only with no language selector (a language axis
like
setup-local pythonwould be additive later; nothing is reserved now).CommandGroup/CommandVerb/CommandNameupdated inlibs/localenv/result.go; JSONcommandfield is now"environments setup-local".pyproject.tomlmanaged-block markers now derive fromCommandName(they previously hard-coded the old name and are written into userfiles), so the command name lives in exactly one place.
Hiddenuntil the environment constraintsrepository is public — unchanged behavior from before the rename.
Out of scope (deliberate)
--cluster→--cluster-id,--serverless→--serverless-version,--job→--job-id,--check→--dry-run,--constraint-source→--constraint-source-url) — the spec renames these too, but they are a separatefollow-up to keep this PR to the command rename + package move.
libs/localenvpackage name andacceptance/localenv/directory name are leftas-is (internal, not user-visible; renaming is cosmetic churn).
Interaction with the stack
#5835 (
[VPEX][8/8], held in draft until the constraints repo is public) unhides anddocuments this command under its old name. Whichever lands second must reconcile:
the changelog fragment and the
Hiddenflag should reflectenvironments setup-local.Testing
go build ./..., lint (0 issues),deadcodecleanlibs/localenv+cmd/environmentsunit tests passacceptance/localenv+acceptance/helpregenerated and greendatabricks environments setup-localis runnable, appears under theenvironmentsgroup when unhidden, and stays out of help whileHiddenThis pull request and its description were written by Isaac.