From 870082c246d6f54d2edcc0a6889022c18cb1e248 Mon Sep 17 00:00:00 2001
From: Rory Hunter <roryhunter2@gmail.com>
Date: Mon, 3 Feb 2020 11:20:02 +0000
Subject: [PATCH] Forbid equality checks against 'true'

Add a Checkstyle rule to forbid equality checks against a literal 'true'
value, since this is redundant. Follow up to #51723.
---
 buildSrc/src/main/resources/checkstyle.xml    | 28 ++++++++++++++++++-
 .../xpack/sql/jdbc/JdbcResultSetMetaData.java |  4 +--
 2 files changed, 29 insertions(+), 3 deletions(-)

diff --git a/buildSrc/src/main/resources/checkstyle.xml b/buildSrc/src/main/resources/checkstyle.xml
index c603edc353d5f..7a59ee5e0fa8b 100644
--- a/buildSrc/src/main/resources/checkstyle.xml
+++ b/buildSrc/src/main/resources/checkstyle.xml
@@ -18,7 +18,7 @@
     <property name="message" value="Empty javadoc comments are forbidden"/>
   </module>
 
-  <!-- 
+  <!--
     We include snippets that are wrapped in `// tag` and `// end` into the
     docs, stripping the leading spaces. If the context is wider than 76
     characters then it'll need to scroll. This fails the build if it sees
@@ -103,5 +103,31 @@
       <property name="ignoreComments" value="true" />
     </module>
     <!-- end Orwellian suppression of Serializable -->
+
+    <!-- Forbid equality comparisons with `true` -->
+    <module name="DescendantToken">
+      <property name="tokens" value="EQUAL"/>
+      <property name="limitedTokens" value="LITERAL_TRUE"/>
+      <property name="maximumNumber" value="0"/>
+      <property name="maximumDepth" value="1"/>
+      <message key="descendant.token.max" value="Do not check for equality with 'true', since it is implied"/>
+    </module>
+
+    <!-- Forbid using '!' for logical negations in favour of checking
+         against 'false' explicitly. -->
+    <!-- This is disabled for now because there are many, many violations,
+         hence the rule is reporting at the "warning" severity. -->
+
+    <!--
+    <module name="DescendantToken">
+      <property name="severity" value="warning"/>
+      <property name="tokens" value="EXPR"/>
+      <property name="limitedTokens" value="LNOT"/>
+      <property name="maximumNumber" value="0"/>
+      <property name="maximumDepth" value="1"/>
+      <message key="descendant.token.max" value="Do not negate boolean expressions with '!', but check explicitly with '== false' as it is more explicit"/>
+    </module>
+    -->
+
   </module>
 </module>
diff --git a/x-pack/plugin/sql/jdbc/src/main/java/org/elasticsearch/xpack/sql/jdbc/JdbcResultSetMetaData.java b/x-pack/plugin/sql/jdbc/src/main/java/org/elasticsearch/xpack/sql/jdbc/JdbcResultSetMetaData.java
index d860c6daaa1ab..75e03a240bc96 100644
--- a/x-pack/plugin/sql/jdbc/src/main/java/org/elasticsearch/xpack/sql/jdbc/JdbcResultSetMetaData.java
+++ b/x-pack/plugin/sql/jdbc/src/main/java/org/elasticsearch/xpack/sql/jdbc/JdbcResultSetMetaData.java
@@ -72,7 +72,7 @@ public int getColumnDisplaySize(int column) throws SQLException {
     @Override
     public String getColumnLabel(int column) throws SQLException {
         JdbcColumnInfo info = column(column);
-        return true == EMPTY.equals(info.label) ? info.name : info.label;
+        return EMPTY.equals(info.label) ? info.name : info.label;
     }
 
     @Override
@@ -158,4 +158,4 @@ private JdbcColumnInfo column(int column) throws SQLException {
     public String toString() {
         return format(Locale.ROOT, "%s(%s)", getClass().getSimpleName(), columns);
     }
-}
\ No newline at end of file
+}