Remove Accord CQL words from the reserved keywords list

patch by David Capwell; reviewed by Caleb Rackliffe for CASSANDRA-20613

Author: dcapwell

pylib/cqlshlib/cqlhandling.py

@@ -25,10 +25,10 @@
 Hint = pylexotron.Hint
 
 cql_keywords_reserved = {'add', 'allow', 'alter', 'and', 'apply', 'asc', 'authorize', 'batch', 'begin', 'by',
-                         'columnfamily', 'create', 'commit', 'delete', 'desc', 'describe', 'drop', 'end', 'entries', 'execute', 'from',
-                         'full', 'grant', 'if', 'in', 'index', 'infinity', 'insert', 'into', 'is', 'keyspace', 'let', 'limit',
+                         'columnfamily', 'create', 'delete', 'desc', 'describe', 'drop', 'entries', 'execute', 'from',
+                         'full', 'grant', 'if', 'in', 'index', 'infinity', 'insert', 'into', 'is', 'keyspace', 'limit',
                          'materialized', 'modify', 'nan', 'norecursive', 'not', 'null', 'of', 'on', 'or', 'order',
-                         'primary', 'rename', 'revoke', 'schema', 'select', 'set', 'table', 'then', 'to', 'token', 'transaction', 'truncate',
+                         'primary', 'rename', 'revoke', 'schema', 'select', 'set', 'table', 'to', 'token', 'truncate',
                          'unlogged', 'update', 'use', 'using', 'view', 'where', 'with'}
 """
 Set of reserved keywords in CQL.

src/antlr/Parser.g

@@ -2310,5 +2310,10 @@ basic_unreserved_keyword returns [String str]
         | K_BETWEEN
         | K_CHECK
         | K_INDEXES
+        | K_COMMIT
+        | K_END
+        | K_LET
+        | K_THEN
+        | K_TRANSACTION
         ) { $str = $k.text; }
     ;

src/resources/org/apache/cassandra/cql3/reserved_keywords.txt

@@ -9,13 +9,11 @@ BATCH
 BEGIN
 BY
 COLUMNFAMILY
-COMMIT
 CREATE
 DELETE
 DESC
 DESCRIBE
 DROP
-END
 ENTRIES
 EXECUTE
 FROM
@@ -29,7 +27,6 @@ INSERT
 INTO
 IS
 KEYSPACE
-LET
 LIMIT
 MATERIALIZED
 MODIFY
@@ -48,10 +45,8 @@ SCHEMA
 SELECT
 SET
 TABLE
-THEN
 TO
 TOKEN
-TRANSACTION
 TRUNCATE
 UNLOGGED
 UPDATE

test/unit/org/apache/cassandra/cql3/ReservedKeywordsTest.java

@@ -18,10 +18,14 @@
 
 package org.apache.cassandra.cql3;
 
+import java.lang.reflect.Modifier;
+
 import org.junit.Test;
 
 import org.junit.Assert;
+
 import org.apache.cassandra.exceptions.SyntaxException;
+import org.assertj.core.api.SoftAssertions;
 
 public class ReservedKeywordsTest
 {
@@ -30,14 +34,51 @@ public void testReservedWordsForColumns()
     {
         for (String reservedWord : ReservedKeywords.reservedKeywords)
         {
-            try
-            {
-                QueryProcessor.parseStatement(String.format("ALTER TABLE ks.t ADD %s TEXT", reservedWord));
+            if (isAllowed(reservedWord))
                 Assert.fail(String.format("Reserved keyword %s should not have parsed", reservedWord));
-            }
-            catch (SyntaxException ignore)
-            {
-            }
+        }
+    }
+
+    @Test
+    public void parserAndTextFileMatch()
+    {
+        // If this test starts to fail that means that the lexer added a new keyword, and this keyword was not updated
+        // to be unreserved.
+        //
+        // To mark a keyword as unreserved, open "Parser.g" and search for
+        //    basic_unreserved_keyword returns [String str]
+        // or
+        //    unreserved_keyword returns [String str]
+        // Add your keyword there and rebuild the jar (to generate the parser).
+        //
+        // If it is desired to make this keyword reserved, then you must first go to the mailing list and request a vote
+        // on this change, if that vote passes then you can update "reserved_keywords.txt" (and pylib/cqlshlib/cqlhandling.py::cql_keywords_reserved).
+        // Never update "reserved_keywords.txt" without a vote on the mailing list!
+        SoftAssertions asserts = new SoftAssertions();
+        for (var f : Cql_Lexer.class.getDeclaredFields())
+        {
+            if (!Modifier.isStatic(f.getModifiers())) continue;
+            if (!f.getName().startsWith("K_")) continue;
+            String name = f.getName();
+            String keyword = name.replaceFirst("K_", "");
+
+            asserts.assertThat(ReservedKeywords.isReserved(keyword))
+                   .describedAs(keyword)
+                   .isEqualTo(!isAllowed(keyword));
+        }
+        asserts.assertAll();
+    }
+
+    private static boolean isAllowed(String keyword)
+    {
+        try
+        {
+            QueryProcessor.parseStatement(String.format("ALTER TABLE ks.t ADD %s TEXT", keyword));
+            return true;
+        }
+        catch (SyntaxException ignore)
+        {
+            return false;
         }
     }
 }