forked from anujgandharv/easytest
-
Notifications
You must be signed in to change notification settings - Fork 15
/
CSVDataLoader.java
238 lines (215 loc) · 9.8 KB
/
CSVDataLoader.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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
package org.easetech.easytest.loader;
import com.csvreader.CsvReader;
import com.csvreader.CsvWriter;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.easetech.easytest.util.ResourceLoader;
import org.junit.Assert;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An implementation of {@link Loader} for the CSV based files. This Loader is responsible for reading a list of CSV
* based files and converting them into a data structure which is understandable by the EasyTest framework. It expects
* the format of the CSV file to be like this :<br>
* <code>
* <B>testGetItems,LibraryId,itemType,searchText</B>
* <br>
* ,4,journal,batman
* ,2,ebook,spiderman
* <br>
* where <B>testGetItems</B> represents the name of the test method for which the test data is being defined,<br>
* <B>LibraryId,itemType,searchText</B> represents the test data fields for the test method, and</br>
* <B>,4,journal,batman (and ,2,ebook,spiderman)</B> represents the actual test data to be passed to the test method.
* Each row in the CSV file represents a single set of test data.<br>
*
* Note the leading "," in the test data row. it is mandatory to use and tells the
* framework that testGetItems is just a method name and does not have any value.<br>
*
* A CSV cannot have a blank line in between test data whether it is for a single test or for multiple tests.
* The framework is capable of handling multiple test datas for multiple test methods in a single CSV file.
* Although a user can choose to define the test data in multiple files as well.
*
* @author Anuj Kumar
*
*/
public class CSVDataLoader implements Loader {
/**
* An instance of logger associated with the test framework.
*/
protected static final Logger LOG = LoggerFactory.getLogger(CSVDataLoader.class);
/** Separator between columns in a CSV file */
private static final char COMMA_SEPARATOR = ',';
/**
*
* Construct a new CSVDataLoader
*/
public CSVDataLoader() {
super();
}
/**
* Construct a new CSVDataLoader and also load the data.
*
* @param csvInputStreams the input stream to load the data from
* @throws IOException if an IO Exception occurs
*/
public CSVDataLoader(final List<InputStream> csvInputStreams) throws IOException {
Map<String, List<Map<String, Object>>> data = null;
Map<String, List<Map<String, Object>>> finalData = new HashMap<String, List<Map<String, Object>>>();
for (InputStream stream : csvInputStreams) {
data = loadFromSpreadsheet(stream);
finalData.putAll(data);
}
}
/**
* Construct a new CSVDataLoader and also load the data.
*
* @param dataFiles the list of input stream string files to load the data from
* @return a Map of method name and the list of associated test data with that method name
* @throws IOException if an IO Exception occurs
*/
private Map<String, List<Map<String, Object>>> loadCSVData(final List<String> dataFiles) throws IOException {
Map<String, List<Map<String, Object>>> data = null;
Map<String, List<Map<String, Object>>> finalData = new HashMap<String, List<Map<String, Object>>>();
for (String filePath : dataFiles) {
try {
ResourceLoader resource = new ResourceLoader(filePath);
data = loadFromSpreadsheet(resource.getInputStream());
} catch (FileNotFoundException e) {
LOG.error("The specified file was not found. The path is : {}", filePath);
LOG.error("Continuing with the loading of next file.");
continue;
} catch (IOException e) {
LOG.error("IO Exception occured while trying to read the data from the file : {}", filePath);
LOG.error("Continuing with the loading of next file.");
continue;
}
finalData.putAll(data);
}
return finalData;
}
/**
* Load data from SpreadSheet
*
* @param csvFile the csv file to load the data from
* @return a map of data
* @throws IOException if an IO exception occurs
*/
private static Map<String, List<Map<String, Object>>> loadFromSpreadsheet(final InputStream csvFile)
throws IOException {
Map<String, List<Map<String, Object>>> data = new HashMap<String, List<Map<String, Object>>>();
CsvReader csvReader = new CsvReader(new InputStreamReader(csvFile), COMMA_SEPARATOR);
Boolean isKeyRow = true;
List<Map<String, Object>> dataValues = null;
Map<Integer, String> tempData = new HashMap<Integer, String>();
data = new HashMap<String, List<Map<String, Object>>>();
while (csvReader.readRecord()) {
Map<String, Object> actualData = new HashMap<String, Object>();
String[] splitValues = csvReader.getValues();
if (splitValues.length > 0 && "".equals(splitValues[0])) {
isKeyRow = false;
} else {
isKeyRow = true;
}
if (isKeyRow) {
dataValues = new ArrayList<Map<String, Object>>();
for (int i = 0; i < splitValues.length; i++) {
tempData.put(i, splitValues[i]);
}
data.put(tempData.get(0), dataValues);
} else {
for (int i = 1; i < splitValues.length; i++) {
actualData.put(tempData.get(i), splitValues[i]);
}
}
if (!isKeyRow) {
dataValues.add(actualData);
}
}
return data;
}
/**
* Load the data from the specified list of filePaths
*
* @param filePaths the list of File paths
* @return the data
*/
@Override
public Map<String, List<Map<String, Object>>> loadData(String[] filePaths) {
Map<String, List<Map<String, Object>>> result = new HashMap<String, List<Map<String, Object>>>();
try {
result = loadCSVData(Arrays.asList(filePaths));
} catch (IOException e) {
Assert.fail("An I/O exception occured while reading the files from the path :" + filePaths.toString());
}
return result;
}
@Override
public void writeData(String[] filePaths, String methodName, Map<String, List<Map<String, Object>>> actualData) {
Boolean isKeyRow = true;
List<String[]> writableData = new ArrayList<String[]>();
try {
ResourceLoader resource = new ResourceLoader(filePaths[0]);
CsvReader csvReader = new CsvReader(new InputStreamReader(resource.getInputStream()), COMMA_SEPARATOR);
// use FileWriter constructor that specifies open for overriding
String currentMethodName = "";
int dataRowIndex = 0;
while (csvReader.readRecord()) {
String[] splitValues = csvReader.getValues();
String[] newSplitValues = Arrays.copyOf(splitValues, splitValues.length);
if (splitValues.length > 0 && "".equals(splitValues[0])) {
isKeyRow = false;
} else {
isKeyRow = true;
currentMethodName = splitValues[0];
if (!currentMethodName.equals(methodName)) {
writableData.add(splitValues);
continue;
}
}
if (isKeyRow) {
dataRowIndex = 0;
List<Map<String, Object>> currentMethodData = actualData.get(currentMethodName);
if (currentMethodData != null && !currentMethodData.isEmpty()) {
if (currentMethodData.get(0).keySet().contains(Loader.ACTUAL_RESULT)) {
int length = splitValues.length;
newSplitValues = Arrays.copyOf(splitValues, length + 1);
newSplitValues[length] = Loader.ACTUAL_RESULT;
}
}
writableData.add(newSplitValues);
} else {
if (!currentMethodName.equals(methodName)) {
writableData.add(splitValues);
continue;
}
List<Map<String, Object>> currentMethodData = actualData.get(currentMethodName);
Map<String, Object> currentRowData = currentMethodData.get(dataRowIndex++);
Collection<Object> values = currentRowData.values();
List<String> listValues = new ArrayList<String>();
listValues.add(EMPTY_STRING);
for (Object value : values) {
listValues.add(value.toString());
}
String[] newValues = listValues.toArray(new String[listValues.size()]);
writableData.add(newValues);
}
}
CsvWriter csvWriter = new CsvWriter(resource.getFileWriter(false), COMMA_SEPARATOR);
// finally we have the values in order to be written to the CSV file.
for (String[] data : writableData) {
csvWriter.writeRecord(data);
}
csvWriter.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}