-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
DiagnosticsReporterTest.java
224 lines (189 loc) · 7.59 KB
/
DiagnosticsReporterTest.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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/*
* Copyright (c) 2002-2018 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.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.diagnostics;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.PrintStream;
import java.net.URI;
import java.nio.file.FileSystem;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.neo4j.io.fs.DefaultFileSystemAbstraction;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.test.extension.DefaultFileSystemExtension;
import org.neo4j.test.extension.Inject;
import org.neo4j.test.extension.TestDirectoryExtension;
import org.neo4j.test.rule.TestDirectory;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.mock;
import static org.neo4j.diagnostics.DiagnosticsReportSources.newDiagnosticsFile;
@ExtendWith( {DefaultFileSystemExtension.class, TestDirectoryExtension.class} )
class DiagnosticsReporterTest
{
@Inject
private TestDirectory testDirectory;
@Inject
private DefaultFileSystemAbstraction fileSystem;
@Test
void dumpFiles() throws Exception
{
DiagnosticsReporter reporter = setupDiagnosticsReporter();
Path destination = testDirectory.file( "logs.zip" ).toPath();
reporter.dump( Collections.singleton( "logs" ), destination, mock( DiagnosticsReporterProgress.class), true );
// Verify content
verifyContent( destination );
}
@Test
void shouldContinueAfterError() throws Exception
{
DiagnosticsReporter reporter = new DiagnosticsReporter( );
MyProvider myProvider = new MyProvider( fileSystem );
reporter.registerOfflineProvider( myProvider );
myProvider.addFile( "logs/a.txt", createNewFileWithContent( "a.txt", "file a") );
Path destination = testDirectory.file( "logs.zip" ).toPath();
Set<String> classifiers = new HashSet<>();
classifiers.add( "logs" );
classifiers.add( "fail" );
try ( ByteArrayOutputStream baos = new ByteArrayOutputStream() )
{
PrintStream out = new PrintStream( baos );
NonInteractiveProgress progress = new NonInteractiveProgress( out, false );
reporter.dump( classifiers, destination, progress, true );
assertThat( baos.toString(), is(String.format(
"1/2 fail.txt%n" +
".................... 20%%%n" +
"..........%n" +
"Error: Step failed%n" +
"2/2 logs/a.txt%n" +
".................... 20%%%n" +
".................... 40%%%n" +
".................... 60%%%n" +
".................... 80%%%n" +
".................... 100%%%n%n" ) ) );
}
// Verify content
URI uri = URI.create("jar:file:" + destination.toAbsolutePath().toUri().getRawPath() );
try ( FileSystem fs = FileSystems.newFileSystem( uri, Collections.emptyMap() ) )
{
List<String> fileA = Files.readAllLines( fs.getPath( "logs/a.txt" ) );
assertEquals( 1, fileA.size() );
assertEquals( "file a", fileA.get( 0 ) );
}
}
@Test
void supportPathsWithSpaces() throws IOException
{
DiagnosticsReporter reporter = setupDiagnosticsReporter();
Path destination = testDirectory.file( "log files.zip" ).toPath();
reporter.dump( Collections.singleton( "logs" ), destination, mock( DiagnosticsReporterProgress.class), true );
verifyContent( destination );
}
private File createNewFileWithContent( String name, String content ) throws IOException
{
Path file = testDirectory.file( name ).toPath();
Files.write( file, content.getBytes() );
return file.toFile();
}
private DiagnosticsReporter setupDiagnosticsReporter() throws IOException
{
DiagnosticsReporter reporter = new DiagnosticsReporter( );
MyProvider myProvider = new MyProvider( fileSystem );
reporter.registerOfflineProvider( myProvider );
myProvider.addFile( "logs/a.txt", createNewFileWithContent( "a.txt", "file a") );
myProvider.addFile( "logs/b.txt", createNewFileWithContent( "b.txt", "file b") );
return reporter;
}
private static void verifyContent( Path destination ) throws IOException
{
URI uri = URI.create("jar:file:" + destination.toAbsolutePath().toUri().getRawPath() );
try ( FileSystem fs = FileSystems.newFileSystem( uri, Collections.emptyMap() ) )
{
List<String> fileA = Files.readAllLines( fs.getPath( "logs/a.txt" ) );
assertEquals( 1, fileA.size() );
assertEquals( "file a", fileA.get( 0 ) );
List<String> fileB = Files.readAllLines( fs.getPath( "logs/b.txt" ) );
assertEquals( 1, fileB.size() );
assertEquals( "file b", fileB.get( 0 ) );
}
}
private static class MyProvider extends DiagnosticsOfflineReportProvider
{
private final FileSystemAbstraction fs;
private final List<DiagnosticsReportSource> logFiles = new ArrayList<>();
MyProvider( FileSystemAbstraction fs )
{
super( "my-provider", "logs" );
this.fs = fs;
}
void addFile( String destination, File file )
{
logFiles.add( newDiagnosticsFile( destination, fs, file ) );
}
@Override
public void init( FileSystemAbstraction fs, Config config, File storeDirectory )
{
}
@Override
public List<DiagnosticsReportSource> provideSources( Set<String> classifiers )
{
List<DiagnosticsReportSource> sources = new ArrayList<>();
if ( classifiers.contains( "fail" ) )
{
sources.add( new FailingSource() );
}
if ( classifiers.contains( "logs" ) )
{
sources.addAll( logFiles );
}
return sources;
}
}
private static class FailingSource implements DiagnosticsReportSource
{
@Override
public String destinationPath()
{
return "fail.txt";
}
@Override
public void addToArchive( Path archiveDestination, DiagnosticsReporterProgress progress )
{
progress.percentChanged( 30 );
throw new RuntimeException( "You had it coming..." );
}
@Override
public long estimatedSize( DiagnosticsReporterProgress progress )
{
return 0;
}
}
}