Skip to content

CASSANDRA-20021 Add cqlsh autocompletion for the identity mapping feature #4408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
+46 −4
Closed

CASSANDRA-20021 Add cqlsh autocompletion for the identity mapping feature #4408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3819c51
add identity mapping grammars in cql3handling for ADD DROP autocomplete
Oct 2, 2025
8007fc3
change USER to IDENTITY for identityMapping autocompletes
Oct 2, 2025
0930359
consolidate identity tests into test_cqlsh_completion.py
Oct 6, 2025
55959b9
add NOT EXISTS completion test to test_cqlsh_completion.py
Oct 6, 2025
5a78cfd
Delete pylib/cqlshlib/test/test_identity_mappings_completion.py
shalnisundram Oct 6, 2025
ee5eeb5
add more ADD, DROP tests, correct identies in test_cqlsh_completion.py
Oct 7, 2025
c434d9a
include ADD keyword in test_complete_in_insert() choices set in test_…
Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions pylib/cqlshlib/cql3handling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,7 @@ def dequote_value(cqlword):
| <createFunctionStatement>
| <createAggregateStatement>
| <createTriggerStatement>
| <addIdentityStatement>
| <dropKeyspaceStatement>
| <dropColumnFamilyStatement>
| <dropIndexStatement>
Expand All @@ -294,6 +295,7 @@ def dequote_value(cqlword):
| <dropFunctionStatement>
| <dropAggregateStatement>
| <dropTriggerStatement>
| <dropIdentityStatement>
| <alterTableStatement>
| <alterKeyspaceStatement>
| <alterUserTypeStatement>
Expand Down Expand Up @@ -1749,6 +1751,7 @@ def rolename_completer(ctxt, cass):
"ON" cf=<columnFamilyName>
;
'''

explain_completion('createTriggerStatement', 'class', '\'fully qualified class name\'')


Expand All @@ -1765,6 +1768,13 @@ def drop_trigger_completer(ctxt, cass):
return list(map(maybe_escape_name, names))


syntax_rules += r'''
<addIdentityStatement> ::= "ADD" "IDENTITY" ("IF" "NOT" "EXISTS")? <stringLiteral> "TO" "ROLE" <rolename>
;
<dropIdentityStatement> ::= "DROP" "IDENTITY" ("IF" "EXISTS")? <stringLiteral>
;
'''

# END SYNTAX/COMPLETION RULE DEFINITIONS

CqlRuleSet.append_rules(syntax_rules)
40 changes: 36 additions & 4 deletions pylib/cqlshlib/test/test_cqlsh_completion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ class TestCqlshCompletion(CqlshCompletionCase):
cqlver = '3.1.6'

def test_complete_on_empty_string(self):
self.trycompletions('', choices=('?', 'ALTER', 'BEGIN', 'CAPTURE', 'CONSISTENCY',
self.trycompletions('', choices=('?', 'ADD', 'ALTER', 'BEGIN', 'CAPTURE', 'CONSISTENCY',
'COPY', 'CREATE', 'DEBUG', 'DELETE', 'DESC', 'DESCRIBE',
'DROP', 'GRANT', 'HELP', 'INSERT', 'LIST', 'LOGIN', 'PAGING', 'REVOKE',
'SELECT', 'SHOW', 'SOURCE', 'TRACING', 'ELAPSED', 'EXPAND', 'SERIAL', 'TRUNCATE',
Expand Down Expand Up @@ -288,7 +288,7 @@ def test_complete_in_insert(self):
self.trycompletions(
("INSERT INTO twenty_rows_composite_table (a, b, c) "
"VALUES ( 'eggs', 'sausage', 'spam');"),
choices=['?', 'ALTER', 'BEGIN', 'CAPTURE', 'CONSISTENCY', 'COPY',
choices=['?', 'ADD', 'ALTER', 'BEGIN', 'CAPTURE', 'CONSISTENCY', 'COPY',
'CREATE', 'DEBUG', 'DELETE', 'DESC', 'DESCRIBE', 'DROP',
'ELAPSED', 'EXPAND', 'GRANT', 'HELP', 'INSERT', 'LIST', 'LOGIN', 'PAGING',
'REVOKE', 'SELECT', 'SHOW', 'SOURCE', 'SERIAL', 'TRACING',
Expand Down Expand Up @@ -613,7 +613,7 @@ def test_complete_in_string_literals(self):
def test_complete_in_drop(self):
self.trycompletions('DR', immediate='OP ')
self.trycompletions('DROP ',
choices=['AGGREGATE', 'COLUMNFAMILY', 'FUNCTION',
choices=['AGGREGATE', 'COLUMNFAMILY', 'FUNCTION', 'IDENTITY',
'INDEX', 'KEYSPACE', 'ROLE', 'TABLE',
'TRIGGER', 'TYPE', 'USER', 'MATERIALIZED'])

Expand Down Expand Up @@ -1053,7 +1053,7 @@ def test_complete_in_create_index(self):
self.trycompletions('CREATE INDEX example ', immediate='ON ')

def test_complete_in_drop_index(self):
self.trycompletions('DROP I', immediate='NDEX ')
self.trycompletions('DROP IN', immediate='DEX ')

def test_complete_in_alter_keyspace(self):
self.trycompletions('ALTER KEY', 'SPACE ')
Expand Down Expand Up @@ -1212,6 +1212,38 @@ def test_complete_in_create_user(self):
def test_complete_in_drop_role(self):
self.trycompletions('DROP ROLE ', choices=['<identifier>', 'IF', '<quotedName>'])

# IDENTITY checks
def test_complete_in_add_identity(self):
self.trycompletions('A', choices=['ADD', 'ALTER'])
self.trycompletions('AD', immediate='D IDENTITY ')
self.trycompletions('ADD ID', immediate='ENTITY ')
self.trycompletions('ADD IDENTITY IF ', immediate='NOT EXISTS ')
self.trycompletions('ADD IDENTITY IF NOT ', immediate='EXISTS ')
self.trycompletions('ADD IDENTITY ',
choices=['<pgStringLiteral>', '<quotedStringLiteral>', 'IF'])
self.trycompletions("ADD IDENTITY 'testIdentifier' TO R", immediate='OLE ')
self.trycompletions("ADD IDENTITY 'testIdentifier' ", immediate='TO ROLE ')
self.trycompletions("ADD IDENTITY 'testIdentifier' TO ROLE ",
choices=['<identifier>', '<quotedName>'], other_choices_ok=True)
self.trycompletions("ADD IDENTITY 'testIdentifier' TO ROLE cassandra ",
choices=[';'])
self.trycompletions("ADD IDENTITY IF NOT EXISTS 'stestIdentifier' TO ROLE cassandra ",
choices=[';'])

def test_complete_in_drop_identity(self):
self.trycompletions('D', choices=['DESCRIBE', 'DEBUG', 'DESC', 'DROP', 'DELETE'])
self.trycompletions('DR', immediate='OP ')
self.trycompletions('DRO', immediate='P ')
self.trycompletions('DROP ID', immediate='ENTITY ')
self.trycompletions('DROP', choices=' ')
self.trycompletions('DROP IDENTITY ',
choices=['<pgStringLiteral>', '<quotedStringLiteral>', 'IF'])
self.trycompletions('DROP IDENTITY IF ', immediate='EXISTS ')
self.trycompletions('DROP IDENTITY IF EXISTS ',
choices=['<pgStringLiteral>', '<quotedStringLiteral>'])
self.trycompletions("DROP IDENTITY 'testIdentifier' ", choices=[';'])
self.trycompletions("DROP IDENTITY IF EXISTS 'testIdentifier' ", choices=[';'])

def test_complete_in_list(self):
self.trycompletions('LIST ',
choices=['ALL', 'AUTHORIZE', 'DESCRIBE', 'EXECUTE', 'ROLES', 'USERS', 'ALTER',
Expand Down