-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
CannedCypherExecutionTest.java
131 lines (118 loc) · 5.54 KB
/
CannedCypherExecutionTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
* Copyright (c) 2002-2016 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.browser;
import java.io.IOException;
import java.net.URL;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.jsoup.Jsoup;
import org.jsoup.nodes.Element;
import org.jsoup.select.Elements;
import org.junit.Test;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.QueryExecutionException;
import org.neo4j.graphdb.Transaction;
import org.neo4j.io.fs.FileUtils;
import org.neo4j.kernel.impl.util.Charsets;
import org.neo4j.test.TestGraphDatabaseFactory;
import static java.lang.String.format;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
/**
* The browser code includes a number of canned example cypher statements. It's important that these statements continue
* to work as the database and the examples continue to evolve. This test provides the most basic coverage: it asserts
* that the statements can be executed without throwing an exception. There is no attempt to assert that the statements
* have an expected behaviour or return correct results. However, this test should be good enough to catch the majority
* of accidental syntax errors in the browser code. It may also provide early warning that examples need to be updated
* when cypher syntax moves on.
*/
public class CannedCypherExecutionTest
{
@Test
public void shouldBeAbleToExecuteAllTheCannedCypherQueriesContainedInStaticHtmlFiles() throws Exception
{
URL resourceLoc = getClass().getClassLoader().getResource( "browser" );
assertNotNull( resourceLoc );
final GraphDatabaseService database = new TestGraphDatabaseFactory().newImpermanentDatabase();
final AtomicInteger cypherStatementCount = new AtomicInteger( 0 );
Files.walkFileTree( Paths.get( resourceLoc.toURI() ), new SimpleFileVisitor<Path>()
{
@Override
public FileVisitResult visitFile( Path file, BasicFileAttributes attributes ) throws IOException
{
if ( file.getFileName().toString().endsWith( ".html" ) )
{
String content = FileUtils.readTextFile( file.toFile(), Charsets.UTF_8 );
Elements cypherElements = Jsoup.parse( content ).select( "pre.runnable" );
for ( Element cypherElement : cypherElements )
{
String statement = replaceAngularExpressions( cypherElement.text() );
if ( !statement.startsWith( ":" ) )
{
try ( Transaction transaction = database.beginTx() )
{
database.execute( statement );
transaction.success();
}
catch ( QueryExecutionException e )
{
throw new AssertionError( format( "Failed to execute query [%s] in file [%s]",
statement, file ), e );
}
cypherStatementCount.incrementAndGet();
}
}
}
return FileVisitResult.CONTINUE;
}
} );
assertTrue( "Static files should contain at least one valid cypher statement",
cypherStatementCount.intValue() > 0 );
System.out.printf( "Successfully executed %s cypher statements extracted from HTML files.%n",
cypherStatementCount );
}
private String replaceAngularExpressions( String statement )
{
Pattern angularExpressionPattern = Pattern.compile( "\\{\\{(.*?)}}" );
Matcher matcher = angularExpressionPattern.matcher( statement );
StringBuffer buffer = new StringBuffer( );
while( matcher.find() )
{
String expression = matcher.group( 1 );
matcher.appendReplacement( buffer, chooseSuitableExpressionValue( expression ) );
}
matcher.appendTail( buffer );
return buffer.toString();
}
private String chooseSuitableExpressionValue( String expression )
{
// Generally we can safely return any old string, but in rare situations, a number might be
// required. The rare situation is had-coded below. Unfortunately, if the canned cypher queries use more
// parameters that need to be integers, this code will have to be updated.
return "relationshipDepth".equals( expression ) ? "1" : "string";
}
}