-
Notifications
You must be signed in to change notification settings - Fork 294
/
TestBase.java
292 lines (254 loc) · 11.6 KB
/
TestBase.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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
/*
* Copyright (c) 2012, salesforce.com, inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided
* that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the
* following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* Neither the name of salesforce.com, inc. nor the names of its contributors may be used to endorse or
* promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.salesforce.dataloader;
import java.io.*;
import java.net.*;
import java.util.Properties;
import junit.framework.TestCase;
import org.apache.log4j.Logger;
import com.salesforce.dataloader.client.ClientBase;
import com.salesforce.dataloader.config.Config;
import com.salesforce.dataloader.config.Messages;
import com.salesforce.dataloader.controller.Controller;
import com.salesforce.dataloader.exception.ControllerInitializationException;
import com.salesforce.dataloader.exception.PasswordExpiredException;
import com.sforce.soap.partner.*;
import com.sforce.soap.partner.fault.ApiFault;
import com.sforce.ws.ConnectionException;
import com.sforce.ws.ConnectorConfig;
/**
* This class represents the base class for all data loader JUnit tests. TODO: ProcessScheduler test? TODO: Encryption
* test
*
* @author Lexi Viripaeff
* @author Alex Warshavsky
* @since 8.0
*/
abstract public class TestBase extends TestCase {
protected static final Properties TEST_PROPS;
static {
TEST_PROPS = new Properties();
loadTestProperties();
}
private static void loadTestProperties() {
final URL url = TestBase.class.getClassLoader().getResource("test.properties");
if (url == null) throw new IllegalStateException("Failed to locate test.properties. Is it in the classpath?");
try {
final InputStream propStream = url.openStream();
try {
TEST_PROPS.load(propStream);
} finally {
propStream.close();
}
} catch (IOException e) {
throw new RuntimeException("Failed to load test properties from resource: " + url, e);
}
}
private static final String API_CLIENT_NAME = "DataLoaderBatch/" + Controller.APP_VERSION;
private static final String TEST_FILES_DIR = TEST_PROPS.getProperty("testfiles.dir");
private static final String TEST_CONF_DIR = TEST_FILES_DIR + File.separator + "conf";
private static final String TEST_DATA_DIR = TEST_FILES_DIR + File.separator + "data";
private static final String TEST_STATUS_DIR = TEST_FILES_DIR + File.separator + "status";
protected static final String DEFAULT_ACCOUNT_EXT_ID_FIELD = "Oracle_Id__c";
protected static final String DEFAULT_CONTACT_EXT_ID_FIELD = "NumberId__c";
protected static final String ACCOUNT_NUMBER_PREFIX = "ACCT";
protected static final String ACCOUNT_WHERE_CLAUSE = "AccountNumber__c like '" + ACCOUNT_NUMBER_PREFIX + "%'";
protected static final String CONTACT_TITLE_PREFIX = "CONTTL";
protected static final String CONTACT_WHERE_CLAUSE = "Title like '" + CONTACT_TITLE_PREFIX + "%'";
protected static final int SAVE_RECORD_LIMIT = 200;
// logger
private static Logger logger = Logger.getLogger(TestBase.class);
protected String baseName; // / base name of the test (without the "test")
private Controller controller;
String oldThreadName;
PartnerConnection binding;
protected TestBase(String name) {
super(name);
}
@Override
protected void setUp() throws Exception {
// reset binding
this.binding = null;
setupTestName();
setupController();
}
private void setupTestName() {
// get the test name and lowercase the 1st letter of the name for file for readability
String baseNameOrig = getName().substring(4);
this.baseName = baseNameOrig.substring(0, 1).toLowerCase() + baseNameOrig.substring(1);
// name the current thread. useful for test logging
this.oldThreadName = Thread.currentThread().getName();
Thread.currentThread().setName(getName());
}
protected void setupController() {
// configure the Controller to point to our testing config
if (!System.getProperties().contains(Controller.CONFIG_DIR_PROP))
System.setProperty(Controller.CONFIG_DIR_PROP, getTestConfDir());
if (controller == null) {
try {
controller = Controller.getInstance(getName(), true);
} catch (ControllerInitializationException e) {
fail("While initializing controller instance", e);
}
}
}
@Override
protected void tearDown() throws Exception {
// restore original thread name
if(this.oldThreadName != null && this.oldThreadName.length() > 0) {
try {
Thread.currentThread().setName(this.oldThreadName);
} catch (Exception e) {
// ignore, just leave the default thread name intact
}
}
}
protected Controller getController() {
return controller;
}
/**
* @return PartnerConnection - binding to use to call the salesforce API
*/
protected PartnerConnection getBinding() {
if(binding != null) {
return binding;
}
ConnectorConfig bindingConfig = getWSCConfig();
logger.info("Getting binding for URL: " + bindingConfig.getAuthEndpoint());
binding = newConnection(bindingConfig, 0);
return binding;
}
protected ConnectorConfig getWSCConfig() {
ConnectorConfig bindingConfig = new ConnectorConfig();
bindingConfig.setUsername(getController().getConfig().getString(Config.USERNAME));
bindingConfig.setPassword(getController().getConfig().getString(Config.PASSWORD));
String configEndpoint = getController().getConfig().getString(Config.ENDPOINT);
if (!configEndpoint.equals("")) { //$NON-NLS-1$
String serverPath;
try {
serverPath = new URI(Connector.END_POINT).getPath();
bindingConfig.setAuthEndpoint(configEndpoint + serverPath);
bindingConfig.setServiceEndpoint(configEndpoint + serverPath);
bindingConfig.setRestEndpoint(configEndpoint + ClientBase.REST_ENDPOINT);
bindingConfig.setManualLogin(true);
// set long timeout for tests with larger data sets
bindingConfig.setReadTimeout(5 * 60 * 1000);
if (getController().getConfig().getBoolean(Config.DEBUG_MESSAGES)) {
bindingConfig.setTraceMessage(true);
bindingConfig.setPrettyPrintXml(true);
String filename = getController().getConfig().getString(Config.DEBUG_MESSAGES_FILE);
if (filename.length() > 0) {
try {
bindingConfig.setTraceFile(filename);
} catch (FileNotFoundException e) {
logger.warn(Messages.getFormattedString("Client.errorMsgDebugFilename", filename));
}
}
}
} catch (URISyntaxException e) {
fail("Error parsing endpoint URL: " + Connector.END_POINT + ", error: " + e.getMessage());
}
}
return bindingConfig;
}
/**
* @param bindingConfig
* @return PartnerConnection
* @throws ConnectionException
*/
private PartnerConnection newConnection(ConnectorConfig bindingConfig, int retries) {
try {
PartnerConnection newBinding = Connector.newConnection(bindingConfig);
newBinding.setCallOptions(API_CLIENT_NAME, null);
logger.info("Logging in as " + bindingConfig.getUsername() + "/" + bindingConfig.getPassword() + " to URL: " + bindingConfig.getAuthEndpoint());
if (bindingConfig.isManualLogin()) {
LoginResult loginResult = newBinding.login(bindingConfig.getUsername(), bindingConfig.getPassword());
// if password has expired, throw an exception
if (loginResult.getPasswordExpired()) {
throw new PasswordExpiredException(Messages.getString("Client.errorExpiredPassword")); //$NON-NLS-1$
}
// update session id and service endpoint based on response
newBinding.setSessionHeader(loginResult.getSessionId());
bindingConfig.setServiceEndpoint(loginResult.getServerUrl());
}
return newBinding;
} catch (ConnectionException e) {
// in case of exception try to get a connection again
if (retries < 3) {
retries++;
return newConnection(bindingConfig, retries);
}
fail("Error getting web service proxy binding", e);
}
// make eclipse happy
return null;
}
protected File getTestFile(String path) {
return new File(TEST_FILES_DIR, path);
}
protected String getResourcePath(String path) {
return getTestFile(path).getAbsolutePath();
}
protected String getTestConfDir() {
return TEST_CONF_DIR;
}
protected String getTestFilesDir() {
return TEST_FILES_DIR;
}
protected String getTestDataDir() {
return TEST_DATA_DIR;
}
protected String getTestStatusDir() {
return TEST_STATUS_DIR;
}
/**
* @param e
*/
protected PartnerConnection checkBinding(int retries, ApiFault e) {
logger.info("Retry#" + retries + " getting a binding after an error. Code: " + e.getExceptionCode().toString()
+ ", detail: " + e.getExceptionMessage());
if(retries < 3) { // && (e.getExceptionCode() == ExceptionCode.INVALID_SESSION_ID || e.getExceptionMessage().indexOf("Invalid Session ID") != -1)) {
return getBinding();
} else {
return null;
}
}
protected void fail(String m, Throwable t) {
final StringWriter failMessage = new StringWriter();
final PrintWriter pw = new PrintWriter(failMessage);
pw.println(m);
pw.print("Message: ");
pw.println(t.getMessage());
pw.println("Stack trace:");
t.printStackTrace(pw);
fail(String.valueOf(failMessage));
}
protected void fail(Throwable t) {
final StringWriter stackTrace = new StringWriter();
t.printStackTrace(new PrintWriter(stackTrace));
fail("Unexpected exception of type " + t.getClass().getCanonicalName(), t);
}
}