Skip to content
GitLab
Commit 082f04b5 authored by Grégory Mantelet's avatar Grégory Mantelet
Browse files

[ADQL] Fix the "try-fix" feature with regular identifiers. 

Fixes #121
parent 4ed8ef74
Expand all Hide whitespace changes
Inline Side-by-side
src/adql/parser/ADQLParser.java
View file @ 082f04b5
This diff is collapsed.
src/adql/parser/ADQLParserTokenManager.java
View file @ 082f04b5
This diff is collapsed.
src/adql/parser/adqlGrammar.jj
View file @ 082f04b5
......@@ -31,7 +31,7 @@
* printed else it will be the message "Correct syntax".
*
* Author: Grégory Mantelet (CDS;ARI)
* Version: 1.5-1 (07/2019)
* Version: 1.5-2 (10/2020)
*/
/* ########### */
......@@ -119,7 +119,7 @@ import adql.translator.TranslationException;
* @see ADQLQueryFactory
*
* @author Grégory Mantelet (CDS;ARI)
* @version 1.5-1 (07/2019)
* @version 1.5-2 (10/2020)
*/
public class ADQLParser {
......@@ -1221,7 +1221,7 @@ TOKEN : {
TOKEN : {
< REGULAR_IDENTIFIER_CANDIDATE: ((<Letter>)+ (<DIGIT> | <Letter>)* | (<DIGIT>)+ <Letter> (<DIGIT> | <Letter>)*) >
| < #Letter: ["a"-"z","A"-"Z","_","?","!","$","@","^","#","`","~","[","]","{","}"] >
| < #Letter: ["a"-"z","A"-"Z","_","?","$","@","^","#","`","~","[","]","{","}"] >
}
/* ########## */
......
test/adql/parser/TestADQLParser.java
View file @ 082f04b5
......@@ -19,25 +19,25 @@ import adql.query.operand.StringConstant;
public class TestADQLParser {
@BeforeClass
public static void setUpBeforeClass() throws Exception{
public static void setUpBeforeClass() throws Exception {
}
@AfterClass
public static void tearDownAfterClass() throws Exception{
public static void tearDownAfterClass() throws Exception {
}
@Before
public void setUp() throws Exception{
public void setUp() throws Exception {
}
@After
public void tearDown() throws Exception{
public void tearDown() throws Exception {
}
@Test
public void testColumnReference(){
public void testColumnReference() {
ADQLParser parser = new ADQLParser();
try{
try {
// ORDER BY
parser.parseQuery("SELECT * FROM cat ORDER BY oid;");
parser.parseQuery("SELECT * FROM cat ORDER BY oid ASC;");
......@@ -50,75 +50,75 @@ public class TestADQLParser {
parser.parseQuery("SELECT * FROM cat GROUP BY cat.oid;");
// JOIN ... USING(...)
parser.parseQuery("SELECT * FROM cat JOIN cat2 USING(oid);");
}catch(Exception e){
} catch(Exception e) {
e.printStackTrace(System.err);
fail("These ADQL queries are strictly correct! No error should have occured. (see stdout for more details)");
}
try{
try {
// ORDER BY
parser.parseQuery("SELECT * FROM cat ORDER BY cat.oid;");
fail("A qualified column name is forbidden in ORDER BY! This test should have failed.");
}catch(Exception e){
} catch(Exception e) {
assertEquals(ParseException.class, e.getClass());
assertEquals(" Encountered \".\". Was expecting one of: <EOF> \",\" \";\" \"ASC\" \"DESC\" ", e.getMessage());
}
// Query reported as in error before the bug correction:
try{
try {
parser.parseQuery("SELECT TOP 10 browndwarfs.cat.jmag FROM browndwarfs.cat ORDER BY browndwarfs.cat.jmag");
fail("A qualified column name is forbidden in ORDER BY! This test should have failed.");
}catch(Exception e){
} catch(Exception e) {
assertEquals(ParseException.class, e.getClass());
assertEquals(" Encountered \".\". Was expecting one of: <EOF> \",\" \";\" \"ASC\" \"DESC\" ", e.getMessage());
}
try{
try {
// GROUP BY with a SELECT item index
parser.parseQuery("SELECT * FROM cat GROUP BY 1;");
fail("A SELECT item index is forbidden in GROUP BY! This test should have failed.");
}catch(Exception e){
} catch(Exception e) {
assertEquals(ParseException.class, e.getClass());
assertEquals(" Encountered \"1\". Was expecting one of: \"\\\"\" <REGULAR_IDENTIFIER_CANDIDATE> ", e.getMessage());
}
try{
try {
// JOIN ... USING(...)
parser.parseQuery("SELECT * FROM cat JOIN cat2 USING(cat.oid);");
fail("A qualified column name is forbidden in USING(...)! This test should have failed.");
}catch(Exception e){
} catch(Exception e) {
assertEquals(ParseException.class, e.getClass());
assertEquals(" Encountered \".\". Was expecting one of: \")\" \",\" ", e.getMessage());
}
try{
try {
// JOIN ... USING(...)
parser.parseQuery("SELECT * FROM cat JOIN cat2 USING(1);");
fail("A column index is forbidden in USING(...)! This test should have failed.");
}catch(Exception e){
} catch(Exception e) {
assertEquals(ParseException.class, e.getClass());
assertEquals(" Encountered \"1\". Was expecting one of: \"\\\"\" <REGULAR_IDENTIFIER_CANDIDATE> ", e.getMessage());
}
}
@Test
public void testDelimitedIdentifiersWithDot(){
public void testDelimitedIdentifiersWithDot() {
ADQLParser parser = new ADQLParser();
try{
try {
ADQLQuery query = parser.parseQuery("SELECT * FROM \"B/avo.rad/catalog\";");
assertEquals("B/avo.rad/catalog", query.getFrom().getTables().get(0).getTableName());
}catch(Exception e){
} catch(Exception e) {
e.printStackTrace(System.err);
fail("The ADQL query is strictly correct! No error should have occured. (see stdout for more details)");
}
}
@Test
public void testJoinTree(){
public void testJoinTree() {
ADQLParser parser = new ADQLParser();
try{
try {
String[] queries = new String[]{ "SELECT * FROM aTable A JOIN aSecondTable B ON A.id = B.id JOIN aThirdTable C ON B.id = C.id;", "SELECT * FROM aTable A NATURAL JOIN aSecondTable B NATURAL JOIN aThirdTable C;" };
for(String q : queries){
for(String q : queries) {
ADQLQuery query = parser.parseQuery(q);
assertTrue(query.getFrom() instanceof ADQLJoin);
......@@ -134,68 +134,68 @@ public class TestADQLParser {
assertTrue(join.getRightTable() instanceof ADQLTable);
assertEquals("aSecondTable", ((ADQLTable)join.getRightTable()).getTableName());
}
}catch(Exception e){
} catch(Exception e) {
e.printStackTrace(System.err);
fail("The ADQL query is strictly correct! No error should have occured. (see stdout for more details)");
}
}
@Test
public void test(){
public void test() {
ADQLParser parser = new ADQLParser();
try{
try {
ADQLQuery query = parser.parseQuery("SELECT 'truc''machin' 'bidule' --- why not a comment now ^^\n'FIN' FROM foo;");
assertNotNull(query);
assertEquals("truc'machinbiduleFIN", ((StringConstant)(query.getSelect().get(0).getOperand())).getValue());
assertEquals("'truc''machinbiduleFIN'", query.getSelect().get(0).getOperand().toADQL());
}catch(Exception ex){
} catch(Exception ex) {
fail("String litteral concatenation is perfectly legal according to the ADQL standard.");
}
// With a comment ending the query
try{
try {
ADQLQuery query = parser.parseQuery("SELECT TOP 1 * FROM ivoa.ObsCore -- comment");
assertNotNull(query);
}catch(Exception ex){
} catch(Exception ex) {
ex.printStackTrace();
fail("String litteral concatenation is perfectly legal according to the ADQL standard.");
}
}
@Test
public void testIncorrectCharacter(){
public void testIncorrectCharacter() {
/* An identifier must be written only with digits, an underscore or
* regular latin characters: */
try{
try {
(new ADQLParser()).parseQuery("select gr\u00e9gory FROM aTable");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().startsWith("Incorrect character encountered at l.1, c.10: "));
assertTrue(t.getMessage().endsWith("Possible cause: a non-ASCI/UTF-8 character (solution: remove/replace it)."));
}
/* Un-finished double/single quoted string: */
try{
try {
(new ADQLParser()).parseQuery("select \"stuff FROM aTable");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().startsWith("Incorrect character encountered at l.1, c.26: <EOF>"));
assertTrue(t.getMessage().endsWith("Possible cause: a string between single or double quotes which is never closed (solution: well...just close it!)."));
}
// But in a string, delimited identifier or a comment, it is fine:
try{
try {
(new ADQLParser()).parseQuery("select 'gr\u00e9gory' FROM aTable");
(new ADQLParser()).parseQuery("select \"gr\u00e9gory\" FROM aTable");
(new ADQLParser()).parseQuery("select * FROM aTable -- a comment by Gr\u00e9gory");
}catch(Throwable t){
} catch(Throwable t) {
fail("This error should never occurs because all these queries have an accentuated character but at a correct place.");
}
}
@Test
public void testMultipleSpacesInOrderAndGroupBy(){
try{
public void testMultipleSpacesInOrderAndGroupBy() {
try {
ADQLParser parser = new ADQLParser();
// Single space:
......@@ -214,14 +214,14 @@ public class TestADQLParser {
parser.parseQuery("select * from aTable GROUP\tBY aCol");
parser.parseQuery("select * from aTable GROUP\nBY aCol");
parser.parseQuery("select * from aTable GROUP \t\nBY aCol");
}catch(Throwable t){
} catch(Throwable t) {
t.printStackTrace();
fail("Having multiple space characters between the ORDER/GROUP and the BY keywords should not generate any parsing error.");
}
}
@Test
public void testADQLReservedWord(){
public void testADQLReservedWord() {
ADQLParser parser = new ADQLParser();
final String hintAbs = "\n(HINT: \"abs\" is a reserved ADQL word. To use it as a column/table/schema name/alias, write it between double quotes.)";
......@@ -231,113 +231,113 @@ public class TestADQLParser {
/* TEST AS A COLUMN/TABLE/SCHEMA NAME... */
// ...with a numeric function name (but no param):
try{
try {
parser.parseQuery("select abs from aTable");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith(hintAbs));
}
// ...with a geometric function name (but no param):
try{
try {
parser.parseQuery("select point from aTable");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith(hintPoint));
}
// ...with an ADQL function name (but no param):
try{
try {
parser.parseQuery("select exists from aTable");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith(hintExists));
}
// ...with an ADQL syntax item:
try{
try {
parser.parseQuery("select LIKE from aTable");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith(hintLike));
}
/* TEST AS AN ALIAS... */
// ...with a numeric function name (but no param):
try{
try {
parser.parseQuery("select aCol AS abs from aTable");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith(hintAbs));
}
// ...with a geometric function name (but no param):
try{
try {
parser.parseQuery("select aCol AS point from aTable");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith(hintPoint));
}
// ...with an ADQL function name (but no param):
try{
try {
parser.parseQuery("select aCol AS exists from aTable");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith(hintExists));
}
// ...with an ADQL syntax item:
try{
try {
parser.parseQuery("select aCol AS LIKE from aTable");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith(hintLike));
}
/* TEST AT THE END OF THE QUERY (AND IN A WHERE) */
try{
try {
parser.parseQuery("select aCol from aTable WHERE toto = abs");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith(hintAbs));
}
}
@Test
public void testSQLReservedWord(){
public void testSQLReservedWord() {
ADQLParser parser = new ADQLParser();
try{
try {
parser.parseQuery("SELECT rows FROM aTable");
fail("\"ROWS\" is an SQL reserved word. This query should not pass.");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith("\n(HINT: \"rows\" is not supported in ADQL, but is however a reserved word. To use it as a column/table/schema name/alias, write it between double quotes.)"));
}
try{
try {
parser.parseQuery("SELECT CASE WHEN aCol = 2 THEN 'two' ELSE 'smth else' END as str FROM aTable");
fail("ADQL does not support the CASE syntax. This query should not pass.");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertTrue(t.getMessage().endsWith("\n(HINT: \"CASE\" is not supported in ADQL, but is however a reserved word. To use it as a column/table/schema name/alias, write it between double quotes.)"));
}
}
@Test
public void testUDFName(){
public void testUDFName() {
ADQLParser parser = new ADQLParser();
// CASE: Valid UDF name => OK
try{
try {
parser.parseQuery("SELECT foo(p1,p2) FROM aTable");
}catch(Throwable t){
} catch(Throwable t) {
t.printStackTrace();
fail("Unexpected parsing error! This query should have passed. (see console for more details)");
}
// CASE: Invalid UDF name => ParseException
final String[] functionsToTest = new String[]{ "_foo", "2do", "do!" };
for(String fct : functionsToTest){
try{
final String[] functionsToTest = new String[]{ "_foo", "2do", "do?" };
for(String fct : functionsToTest) {
try {
parser.parseQuery("SELECT " + fct + "(p1,p2) FROM aTable");
fail("A UDF name like \"" + fct + "\" is not allowed by the ADQL grammar. This query should not pass.");
}catch(Throwable t){
} catch(Throwable t) {
assertEquals(ParseException.class, t.getClass());
assertEquals("Invalid (User Defined) Function name: \"" + fct + "\"!", t.getMessage());
}
......@@ -345,10 +345,10 @@ public class TestADQLParser {
}
@Test
public void testTryQuickFix(){
public void testTryQuickFix() {
ADQLParser parser = new ADQLParser();
try{
try {
/* CASE: Nothing to fix => exactly the same as provided */
// raw ASCII query with perfectly regular ADQL identifiers:
assertEquals("SELECT foo, bar FROM aTable", parser.tryQuickFix("SELECT foo, bar FROM aTable"));
......@@ -376,7 +376,7 @@ public class TestADQLParser {
/* CASE: a nice combination of everything (with comments at beginning, middle and end) */
assertEquals("-- begin comment" + System.getProperty("line.separator") + "SELECT id, \"_raj2000\", \"distance\", (\"date\")," + System.getProperty("line.separator") + " \"min\",min(mag), \"_dej2000\" -- in-between commment" + System.getProperty("line.separator") + "FROM \"public\".mytable -- end comment", parser.tryQuickFix("-- begin comment\r\nSELECT id, \uFE4Draj2000, distance, (date),\r\tmin,min(mag), \"_dej2000\" -- in-between commment\nFROM public.mytable -- end comment"));
}catch(Throwable t){
} catch(Throwable t) {
t.printStackTrace();
fail("Unexpected parsing error! This query should have passed. (see console for more details)");
}
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment