Catching neo4j related exceptions while executing explain query in ins… (#21)

* Catching neo4j related exeptions while executing explain query in inspection
* Removed explicit data source setup

Author: Metaur

testing/integration-neo4j/src/test/java/com/neueda/jetbrains/plugin/graphdb/test/integration/neo4j/tests/cypher/inspection/CypherExplainWarningInspectionTest.java

@@ -52,4 +52,9 @@ public void testDataSourceFile_UserCreatedDSLikeFile() {
         addFileAndCheck(GraphConstants.BOUND_DATA_SOURCE_PREFIX + "ds-uuid-with-23-symbols.cypher",
                 "MATCH (a:Turbo)-->() RETURN *;");
     }
+
+    public void testDataSourceFile_DBIsUnavailable() {
+        //no highlight and no exception
+        addUnavailableDataSourceFileAndCheck("MATCH (a:Turbo)-->() RETURN *;");
+    }
 }

testing/integration-neo4j/src/test/java/com/neueda/jetbrains/plugin/graphdb/test/integration/neo4j/tests/cypher/util/BaseInspectionTest.java

@@ -6,16 +6,13 @@
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.util.NameUtil;
 import com.neueda.jetbrains.plugin.graphdb.test.integration.neo4j.util.base.BaseIntegrationTest;
 
-import java.util.Optional;
 import java.util.Set;
 
 public abstract class BaseInspectionTest extends BaseIntegrationTest {
-    private String dsApiUUID;
 
     @Override
     public void setUp() throws Exception {
         super.setUp();
-        this.dsApiUUID = dataSource().neo4j31().getUUID();
         myFixture.enableInspections(provideInspectionClasses());
     }
 
@@ -27,11 +24,12 @@ protected void addFileAndCheck(String filePath, String fileContent) {
     }
 
     protected void addDataSourceFileAndCheck(String fileContent) {
-        String fileName = Optional.of(dsApiUUID)
-                .flatMap(uuid -> component().dataSources().getDataSourceContainer().findDataSource(uuid))
-                .map(NameUtil::createDataSourceFileName)
-                .orElseThrow(IllegalStateException::new);
+        String fileName = NameUtil.createDataSourceFileName(dataSource().neo4j31());
+        addFileAndCheck(fileName, fileContent);
+    }
 
+    protected void addUnavailableDataSourceFileAndCheck(String fileContent) {
+        String fileName = NameUtil.createDataSourceFileName(dataSource().unavailable());
         addFileAndCheck(fileName, fileContent);
     }
 

testing/integration-neo4j/src/test/java/com/neueda/jetbrains/plugin/graphdb/test/integration/neo4j/util/base/BaseIntegrationTest.java

@@ -1,7 +1,5 @@
 package com.neueda.jetbrains.plugin.graphdb.test.integration.neo4j.util.base;
 
-import java.util.*;
-
 import com.intellij.openapi.components.ServiceManager;
 import com.intellij.testFramework.fixtures.LightCodeInsightFixtureTestCase;
 import com.neueda.jetbrains.plugin.graphdb.database.neo4j.bolt.Neo4jBoltConfiguration;
@@ -14,10 +12,16 @@
 import com.neueda.jetbrains.plugin.graphdb.test.integration.neo4j.util.server.Neo4j30ServerLoader;
 import com.neueda.jetbrains.plugin.graphdb.test.integration.neo4j.util.server.Neo4j31ServerLoader;
 
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
 public abstract class BaseIntegrationTest extends LightCodeInsightFixtureTestCase {
 
     private static final String NEO4J30 = "neo4j30";
     private static final String NEO4J31 = "neo4j31";
+    private static final String UNAVAILABLE_DS = "unavailable";
 
     private Components components;
     private DataSources dataSources;
@@ -48,21 +52,25 @@ public DataSources dataSource() {
         return dataSources;
     }
 
-    private DataSourceApi createDataSource(String name, Neo4jServer neo4jServer) {
+    private DataSourceApi createDataSource(String name, String host, String port, String user, String password) {
         Map<String, String> configuration = new HashMap<>();
-        configuration.put(Neo4jBoltConfiguration.HOST, neo4jServer.getBoltHost());
-        configuration.put(Neo4jBoltConfiguration.PORT, neo4jServer.getBoltPort());
-        configuration.put(Neo4jBoltConfiguration.USER, null);
-        configuration.put(Neo4jBoltConfiguration.PASSWORD, null);
+        configuration.put(Neo4jBoltConfiguration.HOST, host);
+        configuration.put(Neo4jBoltConfiguration.PORT, port);
+        configuration.put(Neo4jBoltConfiguration.USER, user);
+        configuration.put(Neo4jBoltConfiguration.PASSWORD, password);
 
         return component().dataSources().getDataSourceContainer().createDataSource(
-                   null,
-                   DataSourceType.NEO4J_BOLT,
-                   name,
-                   configuration
+                null,
+                DataSourceType.NEO4J_BOLT,
+                name,
+                configuration
         );
     }
 
+    private DataSourceApi createDataSource(String name, Neo4jServer neo4jServer) {
+        return createDataSource(name, neo4jServer.getBoltHost(), neo4jServer.getBoltPort(), null, null);
+    }
+
     public final class Services {
         public CypherMetadataProviderService cypherMetadataProvider() {
             return ServiceManager.getService(getProject(), CypherMetadataProviderService.class);
@@ -86,6 +94,7 @@ public DataSourcesComponentMetadata dataSourcesMetadata() {
     public final class DataSources {
         private DataSourceApi neo4j30DataSource;
         private DataSourceApi neo4j31DataSource;
+        private DataSourceApi unavalableDataSource;
 
         public DataSourceApi neo4j30() {
             if (neo4j30DataSource == null) {
@@ -116,5 +125,21 @@ public DataSourceApi neo4j31() {
             }
             return neo4j31DataSource;
         }
+
+        public DataSourceApi unavailable() {
+            if (unavalableDataSource == null) {
+                unavalableDataSource = component().dataSources()
+                        .getDataSourceContainer()
+                        .getDataSource(UNAVAILABLE_DS)
+                        .orElseGet(() -> {
+                            DataSourceApi dataSource = createDataSource(UNAVAILABLE_DS, "unexisting.domain.dev",
+                                    "7474", null, null);
+                            component().dataSources().getDataSourceContainer().addDataSource(dataSource);
+                            component().dataSources().refreshAllMetadata();
+                            return dataSource;
+                        });
+            }
+            return unavalableDataSource;
+        }
     }
 }

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/inspection/CypherExplainWarningInspection.java

@@ -14,7 +14,7 @@
 import com.neueda.jetbrains.plugin.graphdb.language.cypher.psi.CypherTypes;
 import com.neueda.jetbrains.plugin.graphdb.platform.GraphConstants;
 import org.jetbrains.annotations.NotNull;
-import org.neo4j.driver.v1.exceptions.ClientException;
+import org.neo4j.driver.v1.exceptions.Neo4jException;
 
 import java.util.Objects;
 import java.util.Optional;
@@ -78,7 +78,7 @@ private void checkStatement(@NotNull PsiElement statement, @NotNull ProblemsHold
     private GraphQueryResult executeExplainQuery(GraphDatabaseApi api, String query) {
         try {
             return api.execute("EXPLAIN " + query);
-        } catch (ClientException ex) {
+        } catch (Neo4jException ex) {
             return null;
         }
     }