Add parser linting support

Author: jnmugerwa

parser/pom.xml

@@ -14,6 +14,11 @@
         <maven.compiler.target>1.6</maven.compiler.target>
     </properties>
     <dependencies>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <version>11.0.2</version>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

parser/src/main/java/com/facebook/coresql/lint/LintingVisitor.java

@@ -0,0 +1,51 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.facebook.coresql.lint;
+
+import com.facebook.coresql.parser.AstNode;
+import com.facebook.coresql.parser.SqlParserDefaultVisitor;
+import com.facebook.coresql.warning.WarningCode;
+import com.facebook.coresql.warning.WarningCollector;
+
+public abstract class LintingVisitor
+        extends SqlParserDefaultVisitor
+{
+    private final WarningCollector warningCollector;
+
+    public LintingVisitor(WarningCollector collector)
+    {
+        this.warningCollector = collector;
+    }
+
+    public void addWarningToCollector(WarningCode code, String warningMessage, AstNode node)
+    {
+        warningCollector.add(code, warningMessage, node);
+    }
+
+    /**
+     * Entry point to recursive visiting routine. We recurse, add any warnings to the current collector, then return.
+     *
+     * @param node The root of the AST we're validating
+     */
+    public void lint(AstNode node)
+    {
+        node.jjtAccept(this, null);
+    }
+
+    public WarningCollector getWarningCollector()
+    {
+        return warningCollector;
+    }
+}

parser/src/main/java/com/facebook/coresql/lint/MixedAndOr.java

@@ -0,0 +1,60 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.facebook.coresql.lint;
+
+import com.facebook.coresql.parser.AndExpression;
+import com.facebook.coresql.parser.OrExpression;
+import com.facebook.coresql.warning.WarningCollector;
+
+import static com.facebook.coresql.parser.SqlParserTreeConstants.JJTANDEXPRESSION;
+import static com.facebook.coresql.parser.SqlParserTreeConstants.JJTOREXPRESSION;
+import static com.facebook.coresql.warning.StandardWarningCode.MIXING_AND_OR_WITHOUT_PARENTHESES;
+
+/**
+ * A visitor that validates an AST built from an SQL string. Right now, it validates
+ * a single clause: don't mix AND and OR without parentheses.
+ */
+public class MixedAndOr
+        extends LintingVisitor
+{
+    private static final String WARNING_MESSAGE = "Mixing AND and OR without parentheses.";
+
+    public MixedAndOr(WarningCollector collector)
+    {
+        super(collector);
+    }
+
+    @Override
+    public void visit(OrExpression node, Void data)
+    {
+        if (node.jjtGetParent().getId() == JJTANDEXPRESSION) {
+            super.addWarningToCollector(MIXING_AND_OR_WITHOUT_PARENTHESES.getWarningCode(),
+                    WARNING_MESSAGE,
+                    node);
+        }
+        defaultVisit(node, data);
+    }
+
+    @Override
+    public void visit(AndExpression node, Void data)
+    {
+        if (node.jjtGetParent().getId() == JJTOREXPRESSION) {
+            super.addWarningToCollector(MIXING_AND_OR_WITHOUT_PARENTHESES.getWarningCode(),
+                    WARNING_MESSAGE,
+                    node);
+        }
+        defaultVisit(node, data);
+    }
+}

parser/src/main/java/com/facebook/coresql/parser/AstNode.java

@@ -75,15 +75,15 @@ public final AstNode GetFirstChildOfKind(int kind)
         return null;
     }
 
-    public String GetCoordinates()
+    public Location getLocation()
     {
-        return beginToken.beginLine + ":" + beginToken.beginColumn + "-" + endToken.endLine + ":" + endToken.endColumn;
+        return new Location(beginToken.beginLine, beginToken.beginColumn, endToken.endLine, endToken.endColumn);
     }
 
     @Override
     public String toString(String prefix)
     {
-        return super.toString(prefix) + " (" + GetCoordinates() + ")" +
+        return super.toString(prefix) + " (" + getLocation().toString() + ")" +
                 (NumChildren() == 0 ? " (" + beginToken.image + ")" : "");
     }
 }

parser/src/main/java/com/facebook/coresql/parser/Location.java

@@ -0,0 +1,39 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.facebook.coresql.parser;
+
+import static java.lang.String.format;
+
+public class Location
+{
+    private final int beginLine;
+    private final int beginColumn;
+    private final int endLine;
+    private final int endColumn;
+
+    public Location(int beginLine, int beginColumn, int endLine, int endColumn)
+    {
+        this.beginLine = beginLine;
+        this.beginColumn = beginColumn;
+        this.endLine = endLine;
+        this.endColumn = endColumn;
+    }
+
+    @Override
+    public String toString()
+    {
+        return format("%d:%d-%d:%d", beginLine, beginColumn, endLine, endColumn);
+    }
+}

parser/src/main/java/com/facebook/coresql/warning/CoreSqlWarning.java

@@ -0,0 +1,49 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.facebook.coresql.warning;
+
+import com.facebook.coresql.parser.Location;
+
+import static java.lang.String.format;
+import static java.util.Objects.requireNonNull;
+
+public final class CoreSqlWarning
+{
+    private final WarningCode warningCode;
+    private final String message;
+    private final Location location;
+
+    public CoreSqlWarning(WarningCode warningCode, String message,
+            int beginLine,
+            int beginColumn,
+            int endLine,
+            int endColumn)
+    {
+        this.warningCode = requireNonNull(warningCode, "Warning code is null");
+        this.message = requireNonNull(message, "Warning message is null");
+        this.location = new Location(beginLine, beginColumn, endLine, endColumn);
+    }
+
+    public WarningCode getWarningCode()
+    {
+        return warningCode;
+    }
+
+    @Override
+    public String toString()
+    {
+        return format("Warning@%s message: %s [%s]", location, message, warningCode);
+    }
+}

parser/src/main/java/com/facebook/coresql/warning/DefaultWarningCollector.java

@@ -0,0 +1,69 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.facebook.coresql.warning;
+
+import com.facebook.coresql.parser.AstNode;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.LinkedListMultimap;
+import com.google.common.collect.Multimap;
+
+import java.util.List;
+
+import static java.util.Objects.requireNonNull;
+
+public class DefaultWarningCollector
+        implements WarningCollector
+{
+    private final Multimap<WarningCode, CoreSqlWarning> warnings = LinkedListMultimap.create();
+    private final WarningCollectorConfig config;
+
+    public DefaultWarningCollector(WarningCollectorConfig config)
+    {
+        this.config = requireNonNull(config, "config is null");
+    }
+
+    @Override
+    public void add(WarningCode code, String warningMessage, AstNode node)
+    {
+        requireNonNull(code, "warning code is null");
+        requireNonNull(warningMessage, "warning message is null");
+        requireNonNull(node, "node is null");
+        addWarningIfNumWarningsLessThanConfig(new CoreSqlWarning(code,
+                warningMessage,
+                node.beginToken.beginLine,
+                node.beginToken.beginColumn,
+                node.beginToken.endLine,
+                node.beginToken.endColumn));
+    }
+
+    @Override
+    public List<CoreSqlWarning> getAllWarnings()
+    {
+        return ImmutableList.copyOf(warnings.values());
+    }
+
+    @Override
+    public void clearWarnings()
+    {
+        warnings.clear();
+    }
+
+    private void addWarningIfNumWarningsLessThanConfig(CoreSqlWarning coreSqlWarning)
+    {
+        if (warnings.size() < config.getMaxWarnings()) {
+            warnings.put(coreSqlWarning.getWarningCode(), coreSqlWarning);
+        }
+    }
+}

parser/src/main/java/com/facebook/coresql/warning/StandardWarningCode.java

@@ -0,0 +1,32 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.facebook.coresql.warning;
+
+public enum StandardWarningCode
+{
+    MIXING_AND_OR_WITHOUT_PARENTHESES(0x0000_0001);
+
+    private final WarningCode warningCode;
+
+    StandardWarningCode(int code)
+    {
+        warningCode = new WarningCode(code, name());
+    }
+
+    public WarningCode getWarningCode()
+    {
+        return warningCode;
+    }
+}