Skip to content

fix: add name as an identification field (WORKBENCH-4488) - #21

Open
lduan11 wants to merge 11 commits into
mainfrom
f-4488
Open

lduan11 wants to merge 11 commits into
mainfrom
f-4488

Conversation

@lduan11

@lduan11 lduan11 commented Nov 3, 2026 •

Copy link
Copy Markdown

Summary

get, describe, and bulk delete/update commands now accept names as well as IDs and controller IDs for workbenches, volumes, snapshots, images, image-builds, jobs, and job-submissions. Precedence is ID, then controller ID, then name. Matching is exact and case-sensitive. Help text says "ids or names" only for the commands and types that support it.

Code Changes

  • For image-builds, images, jobs, snapshots, volumes, and workbenches, now support the resource "name" for identification.
  • For job-submissions, now support the associated "job_name" for identification.
  • util.go:
    • selectByIDThenName - allows IDs to take precedence over names. Resolves for each argument separately.
    • resolveIDs - since we can now select by names, resolve them into database ids before updating/deleting the resource. Delete and bulk update resolve args to IDs with a GET before the POST. Tests updated accordingly to mock additional GET endpoints.
  • For state updates, removed a redundant GET in setWorkbenchDesiredState since there is now a GET first in every bulk update.

Doc Changes:

  • Type descriptions: cancel, delete, describe, logs, rebuild, start, stop, and update descriptions now mention names. Usage text for these commands is updated to match.
  • New get and describe variants to differentiate between resources that support name identification vs. resources that don't.

@lduan11
lduan11 force-pushed the f-4488 branch 2 times, most recently from dfab365 to f7ed3e4 Compare November 3, 2026 22:10
@lduan11
lduan11 marked this pull request as draft November 3, 2026 22:16
@lduan11
lduan11 force-pushed the f-4488 branch 4 times, most recently from 96a7358 to 555a84b Compare November 4, 2026 17:14
@github-actions

github-actions Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Go test coverage by package

# Package name                                                    | Coverage
+ github.com/sassoftware/wbctl/cmd/wbctl                          | 100.00% (12/12 lines)
+ github.com/sassoftware/wbctl/internal/auth                      | 100.00% (709/709 lines)
+ github.com/sassoftware/wbctl/internal/auth0admin                | 100.00% (5/5 lines)
+ github.com/sassoftware/wbctl/internal/cmd                       | 100.00% (92/92 lines)
+ github.com/sassoftware/wbctl/internal/cmd/api                   | 100.00% (107/107 lines)
+ github.com/sassoftware/wbctl/internal/cmd/auth                  | 100.00% (29/29 lines)
+ github.com/sassoftware/wbctl/internal/cmd/cancel                | 100.00% (90/90 lines)
+ github.com/sassoftware/wbctl/internal/cmd/create                | 100.00% (37/37 lines)
+ github.com/sassoftware/wbctl/internal/cmd/create/image          | 100.00% (208/208 lines)
+ github.com/sassoftware/wbctl/internal/cmd/create/job            | 100.00% (265/265 lines)
+ github.com/sassoftware/wbctl/internal/cmd/create/job_submission | 100.00% (130/130 lines)
+ github.com/sassoftware/wbctl/internal/cmd/create/snapshot       | 100.00% (192/192 lines)
+ github.com/sassoftware/wbctl/internal/cmd/create/workbench      | 100.00% (219/219 lines)
+ github.com/sassoftware/wbctl/internal/cmd/create/workspace      | 100.00% (335/335 lines)
+ github.com/sassoftware/wbctl/internal/cmd/delete                | 100.00% (151/151 lines)
+ github.com/sassoftware/wbctl/internal/cmd/describe              | 100.00% (240/240 lines)
+ github.com/sassoftware/wbctl/internal/cmd/edit                  | 100.00% (223/223 lines)
+ github.com/sassoftware/wbctl/internal/cmd/flags                 | 100.00% (342/342 lines)
+ github.com/sassoftware/wbctl/internal/cmd/get                   | 100.00% (310/310 lines)
+ github.com/sassoftware/wbctl/internal/cmd/log                   | 100.00% (119/119 lines)
+ github.com/sassoftware/wbctl/internal/cmd/login                 | 100.00% (51/51 lines)
+ github.com/sassoftware/wbctl/internal/cmd/logout                | 100.00% (26/26 lines)
+ github.com/sassoftware/wbctl/internal/cmd/profile               | 100.00% (14/14 lines)
+ github.com/sassoftware/wbctl/internal/cmd/profile/config        | 100.00% (70/70 lines)
+ github.com/sassoftware/wbctl/internal/cmd/profile/init          | 100.00% (87/87 lines)
+ github.com/sassoftware/wbctl/internal/cmd/profile/list          | 100.00% (29/29 lines)
+ github.com/sassoftware/wbctl/internal/cmd/profile/show          | 100.00% (62/62 lines)
+ github.com/sassoftware/wbctl/internal/cmd/rebuild               | 100.00% (86/86 lines)
+ github.com/sassoftware/wbctl/internal/cmd/settings              | 100.00% (70/70 lines)
+ github.com/sassoftware/wbctl/internal/cmd/state                 | 100.00% (113/113 lines)
+ github.com/sassoftware/wbctl/internal/cmd/version               | 100.00% (37/37 lines)
+ github.com/sassoftware/wbctl/internal/cmd/whoami                | 100.00% (67/67 lines)
+ github.com/sassoftware/wbctl/internal/configutil                | 100.00% (15/15 lines)
+ github.com/sassoftware/wbctl/internal/debugutil                 | 100.00% (5/5 lines)
+ github.com/sassoftware/wbctl/internal/httputil                  | 100.00% (30/30 lines)
+ github.com/sassoftware/wbctl/internal/i18n                      | 100.00% (31/31 lines)
+ github.com/sassoftware/wbctl/internal/jsonutil                  | 100.00% (11/11 lines)
+ github.com/sassoftware/wbctl/internal/logutil                   | 100.00% (37/37 lines)
+ github.com/sassoftware/wbctl/internal/maputil                   | 100.00% (32/32 lines)
+ github.com/sassoftware/wbctl/internal/osutil                    | 100.00% (20/20 lines)
+ github.com/sassoftware/wbctl/internal/postgrest                 | 100.00% (5/5 lines)
+ github.com/sassoftware/wbctl/internal/printutil                 | 100.00% (496/496 lines)
+ github.com/sassoftware/wbctl/internal/services/auth0admin       | 100.00% (36/36 lines)
+ github.com/sassoftware/wbctl/internal/services/workbench        | 100.00% (1552/1552 lines)
+ github.com/sassoftware/wbctl/internal/sliceutil                 | 100.00% (14/14 lines)
+ github.com/sassoftware/wbctl/internal/stubs                     | 100.00% (515/515 lines)
+ github.com/sassoftware/wbctl/internal/timeutil                  | 100.00% (8/8 lines)
+ github.com/sassoftware/wbctl/internal/types                     | 100.00% (87/87 lines)
+ github.com/sassoftware/wbctl/internal/ui                        | 100.00% (106/106 lines)
+ github.com/sassoftware/wbctl/internal/wbctljson                 | 100.00% (286/286 lines)

@lduan11 lduan11 closed this Nov 4, 2026
@lduan11 lduan11 reopened this Nov 4, 2026
@lduan11
lduan11 force-pushed the f-4488 branch 2 times, most recently from d229d63 to a82c97d Compare November 4, 2026 20:02
@lduan11
lduan11 marked this pull request as ready for review November 4, 2026 20:48
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.

1 participant