Fix #35: --nowait / --silent-progress on createsiteusers by jacalata · Pull Request #455 · tableau/tabcmd

jacalata · 2026-08-07T07:18:37Z

Closes #35.

Motivation

tabcmd Classic accepts --nowait and --silent-progress on
createsiteusers; tabcmd 2 was missing both. Wiring them meaningfully
requires more than argparse: Classic sends the CSV as a single
bulk-import job and polls the server-side JobItem, while tabcmd 2 was
walking the CSV row by row and calling users.add per user. With no
server-side job to poll, --nowait had nothing to skip. This PR
switches createsiteusers to server.users.bulk_add + a single
JobItem and wires both flags.

Behavior change

For users:

Default: bulk_add, wait for the JobItem via
server.jobs.wait_for_job, print a summary from status_notes
(CountOfUsersAddedToSite, CountOfUsersSkipped,
CountOfUsersProcessed) plus per-row error notes. Same shape as
Classic's default output.
--nowait: bulk_add then return immediately. Job ID is printed
before return so callers can query it later.
--silent-progress: still waits for the job but suppresses the
status header, queued-job line, and per-row summary.
--complete / --no-complete: approximated via client-side
pre-flight validation (validate_file_for_import(strict=...)).
Classic used a ClientXML with_transaction param the REST endpoint
doesn't expose, so under --complete (default) malformed rows abort
before submission; under --no-complete we validate leniently.
Server-side row failures mid-import still surface via
job.status_notes.
--continue-if-exists: no-op on this command (bulk_add is
inherently tolerant of duplicate users -- they get counted under
CountOfUsersSkipped). Kept on the parser for consistency with
sibling create commands; logged at DEBUG.

Flag spelling: Classic uses --nowait (one word). The existing
set_no_wait_option helper defined --no-wait but had zero callers,
so rewrote to --nowait with no compatibility alias.

Older-TSC safety: if the pinned tableauserverclient predates
JobItem.status_notes we can't produce a truthful summary. Exit with
an error message pointing at the pinned TSC version rather than silently
print zeros that look like success.

Draft: depends on TSC release

Depends on tableauserverclient >= (next release), which ships
JobItem.status_notes from tableau/server-client-python#1852 (merged).
Draft while awaiting a tagged TSC release + tabcmd's TSC pin bump.

Test plan

3 parser tests: --nowait, --silent-progress, both together
5 behavior tests: default calls bulk_add+wait_for_job;
--nowait skips wait_for_job; --silent-progress still waits;
both flags coexist; older-TSC without status_notes exits with error
Full unit-test suite: 346 passed, 2 skipped
Live-fire against Tableau Cloud (post-TSC-release)

🤖 Generated with Claude Code

…elease) tabcmd Classic accepts --nowait and --silent-progress on createsiteusers; tabcmd 2 was missing both flags. Adding them meaningfully requires more than argparse: Classic sends the CSV as a single bulk-import job and polls the server-side JobItem, while tabcmd 2 has been walking the CSV row by row and calling users.add per user. With no server-side job to poll, --nowait had nothing to skip. This PR switches createsiteusers to server.users.bulk_add + a single JobItem, and wires the two flags. Behavior changes: - Default: submit bulk_add, wait for the JobItem to complete via server.jobs.wait_for_job, print a summary derived from the completed job's status_notes (CountOfUsersAddedToSite / CountOfUsersSkipped / CountOfUsersProcessed) plus any per-row error notes. Same shape as Classic's default output. - --nowait: submit bulk_add and return immediately. Job ID is printed before return so callers can query it via a separate call. - --silent-progress: still waits for the job, but suppresses the status header, the queued-job line, and the per-row summary. Framework logging (errors, debug) is unaffected. - --complete / --no-complete: Classic used a ClientXML with_transaction param that the REST endpoint doesn't expose, so we approximate with client-side pre-flight validation: - --complete (default): validate_file_for_import(strict=True), any malformed row aborts the whole import before submission. - --no-complete: validate leniently, submit whatever parses. Doesn't cover server-side row failures mid-import; those fall through to job.status_notes on the completed job. Flag spelling: Classic uses --nowait (one word). The existing set_no_wait_option helper defined --no-wait but had zero callers, so switched the spelling to Classic's without a compatibility alias. Depends on TSC >= (next release), which will ship JobItem.status_notes (tableau/server-client-python#1852, merged). Draft while awaiting a tagged TSC release + tabcmd's TSC pin bump. Fixes #35.

github-actions · 2026-08-07T07:19:24Z

Coverage Report

File	Stmts	Miss	Cover	Missing
tabcmd
__main__.py	12	12	12	0%
_version.py	11	11	11	0%
tabcmd.py	15	15	15	0%
version.py	9	5	5	44%
tabcmd/commands
commands.py	10	10	10	0%
constants.py	77	18	18	77%
server.py	135	18	18	87%
tabcmd/commands/auth
session.py	394	50	50	87%
tabcmd/commands/datasources_and_workbooks
datasources_and_workbooks_command.py	157	18	18	89%
datasources_workbooks_views_url_parser.py	142	5	5	96%
delete_command.py	60	16	16	73%
export_command.py	120	25	25	79%
get_url_command.py	127	47	47	63%
publish_command.py	123	28	28	77%
runschedule_command.py	21	7	7	67%
tabcmd/commands/extracts
create_extracts_command.py	42	8	8	81%
decrypt_extracts_command.py	27	2	2	93%
delete_extracts_command.py	37	6	6	84%
encrypt_extracts_command.py	27	2	2	93%
extracts.py	20	2	2	90%
reencrypt_extracts_command.py	27	2	2	93%
refresh_extracts_command.py	48	10	10	79%
tabcmd/commands/group
create_group_command.py	29	5	5	83%
delete_group_command.py	27	2	2	93%
tabcmd/commands/project
create_project_command.py	46	8	8	83%
delete_project_command.py	35	4	4	89%
publish_samples_command.py	30	4	4	87%
tabcmd/commands/site
create_site_command.py	34	5	5	85%
delete_site_command.py	27	2	2	93%
edit_site_command.py	38	2	2	95%
list_command.py	77	12	12	84%
list_sites_command.py	29	2	2	93%
tabcmd/commands/user
add_users_command.py	29	5	5	83%
create_site_users.py	84	19	19	77%
create_users_command.py	59	9	9	85%
delete_site_users_command.py	43	5	5	88%
user_data.py	222	31	31	86%
tabcmd/execution
_version.py	2	2	2	0%
global_options.py	125	4	4	97%
localize.py	66	11	11	83%
logger_config.py	60	6	6	90%
tabcmd_controller.py	42	7	7	83%
TOTAL	2899	462	84%

TSC top-level doesn't re-export JobFailedException; import directly from tableauserverclient.server.endpoint.exceptions. Fixes the mypy attr-defined error in CI.

The status_notes fallback previously used getattr(..., None) or [] which meant an older TSC would print added=0, skipped=0, processed=len(input) with no indication anything was wrong. Detect the attribute missing and exit with a message pointing at the pinned TSC version. --continue-if-exists is a global flag used across the create-* commands to downgrade 409 conflicts to INFO. bulk_add is inherently tolerant of duplicate users (they get counted under CountOfUsersSkipped) so the flag is a no-op here. Keep the flag on the parser for consistency, log the no-op at DEBUG, and cover with a test so a future refactor doesn't accidentally rely on it. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

test_continue_if_exists_is_a_noop_documented_in_debug just re-ran the default happy path with the flag set. bulk_add is called and wait_for_job is called either way, so this asserts nothing that the base test doesn't. The behavioral comment lives on the code path in create_site_users.py already. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

jacalata and others added 4 commits August 7, 2026 13:30

fix: import JobFailedException from its module

826be50

TSC top-level doesn't re-export JobFailedException; import directly from tableauserverclient.server.endpoint.exceptions. Fixes the mypy attr-defined error in CI.

style: apply black 22 to new test files

d49f3dc

jacalata mentioned this pull request Aug 10, 2026

Test coverage gap: run_command logic in the recent parity sweep is untested #457

Open

Navigation Menu

Uh oh!

Fix #35: --nowait / --silent-progress on createsiteusers - #455

Fix #35: --nowait / --silent-progress on createsiteusers#455
jacalata wants to merge 5 commits into
developmentfrom
jac/35-createsiteusers-nowait

jacalata commented Aug 7, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 7, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

jacalata commented Aug 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Behavior change

Draft: depends on TSC release

Test plan

Uh oh!

github-actions Bot commented Aug 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jacalata commented Aug 7, 2026 •

edited

Loading

github-actions Bot commented Aug 7, 2026 •

edited

Loading