Conversation
tabcmd Classic accepts "Local" as an auth type on the CLI and CSV column 7. tabcmd 2 kept "Local" in the accepted list but TSC's UserItem.Auth enum has no Local value, so when the user reached server.users.add() the wire representation raised ValueError. Map Classic's "Local" -> TSC.UserItem.Auth.ServerDefault in Userdata.to_tsc_user() so CSVs authored for Classic import cleanly. Case-insensitive to match Classic behavior. Fixes #434.
A silent remap is surprising: an operator who typed Local (or imported a Classic CSV that uses it) previously got a user with ServerDefault auth and no signal that anything changed. Emit a WARNING that names the user and states both the input and remapped auth so the operator can spot unexpected remaps in a large batch. Adds a matching assertion in the existing test. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The CLI override bypasses remapping, warning visibility and compiled localization need fixes, and a test assertion must be stabilized.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
Open (3)
What changed in this PR
Maps case-insensitive Local authentication values to TSC’s ServerDefault and logs a warning.
Changes:
- Adds auth remapping and warning behavior.
- Adds English localization text.
- Adds unit tests for remapping and pass-through behavior.
| File | Summary |
|---|---|
tests/commands/test_user_utils.py |
Adds remapping tests; the warning assertion depends on the stale localization key (nit, 2 votes). |
tabcmd/locales/en/tabcmd_messages_en.properties |
Adds warning text; compiled localization artifacts remain outdated (moderate, 3 votes). |
tabcmd/commands/user/user_data.py |
Implements CSV remapping, but CLI overrides bypass it (critical, 3 votes); warning output also misses the configured command logger (moderate, 1 vote). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+51
to
+55
| auth = self.auth | ||
| if isinstance(auth, str) and auth.lower() == "local": | ||
| logging.getLogger(__name__).warning( | ||
| _("tabcmd.user.warning.local_auth_remapped").format(self.name) | ||
| ) |
| tabcmd.status.waiting_for_refresh_job=Waiting for refresh job to begin | ||
| tabcmd.user.error.site_role_required=Site role is required | ||
| tabcmd.user.help.auth_type=Assigns the authentication type for all users in the CSV file. Possible values: | ||
| tabcmd.user.warning.local_auth_remapped=User "{0}": auth_setting "Local" is not a Tableau Server auth type; mapped to ServerDefault. The site's default auth method will be used. |
Comment on lines
+164
to
+166
| # In tests the gettext catalog isn't loaded, so `_()` returns the raw key; | ||
| # we just assert the localize key made it to the log record. | ||
| assert any("local_auth_remapped" in msg for msg in logs.output), logs.output |
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #434.
Motivation
tabcmd Classic accepts
Localas an auth type on the CLI and in CSVcolumn 7, but TSC's
UserItem.Authenum has noLocalvalue, sopassing it through crashed on
server.users.add. Anyone importing aClassic-authored CSV containing
Localin column 7 hit a hard failure.Behavior change
For users:
Userdata.to_tsc_user()mapsLocal(case-insensitive)to
TSC.UserItem.Auth.ServerDefaultand logs a WARNING naming theaffected user so the operator sees the remap happened. A silent remap
would be surprising -- if the site's actual default auth isn't the
same as Classic's Local, created users would have a different auth
method than intended.
Test plan
tests/commands/test_user_utils.py— 3 new tests cover exact-caseLocal, lowercaselocal, and non-Localpass-throughtest_user_utils.pysuite: 18 passed🤖 Generated with Claude Code
Source
Classic tabcmd's
--auth-typehelp text (app-tabcmd/build/resources/main/com/tableausoftware/tabcmd/tabcmd_messages_en.properties:77) says "For Tableau Server, TYPE may be Local (default) or SAML" — but the Java source (app-tabcmd/src/.../commands/CreateSiteUsers.java:38-42) only acceptsTableauId → DEFAULT,SAML → SAML,OpenID → OIDC. Classic will actually rejectLocalat CLI parse time. This PR handles what users expect based on the Classic docs (and what Cloud CSVs carrying per-rowLocalin the auth column produce), by mapping the incomingLocaltoServerDefaultand logging the remap. Not literal Classic parity — the Classic code never acceptedLocal— but matches Classic's documented behavior and Cloud CSV backward-compat.