1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.tools;
24  
25  import com.liferay.portal.kernel.util.CharPool;
26  import com.liferay.portal.kernel.util.FileUtil;
27  import com.liferay.portal.kernel.util.StringPool;
28  import com.liferay.portal.kernel.util.StringUtil;
29  import com.liferay.portal.kernel.util.UnicodeFormatter;
30  import com.liferay.portal.tools.servicebuilder.ServiceBuilder;
31  import com.liferay.portal.util.InitUtil;
32  
33  import java.io.File;
34  
35  import java.util.HashMap;
36  import java.util.Map;
37  
38  import org.apache.tools.ant.DirectoryScanner;
39  
40  /**
41   * <a href="SeleneseToJavaBuilder.java.html"><b><i>View Source</i></b></a>
42   *
43   * @author Brian Wing Shun Chan
44   *
45   */
46  public class SeleneseToJavaBuilder {
47  
48      public static void main(String[] args) throws Exception {
49          InitUtil.initWithSpring();
50  
51          if (args.length == 1) {
52              new SeleneseToJavaBuilder(args[0]);
53          }
54          else {
55              throw new IllegalArgumentException();
56          }
57      }
58  
59      public SeleneseToJavaBuilder(String basedir) throws Exception {
60          DirectoryScanner ds = new DirectoryScanner();
61  
62          ds.setBasedir(basedir);
63          ds.setIncludes(new String[] {"**\\*.html"});
64  
65          ds.scan();
66  
67          String[] files = ds.getIncludedFiles();
68  
69          for (int i = 0; i < files.length; i++) {
70  
71              // I would have preferred to use XlateHtmlSeleneseToJava, but it
72              // is horribly out of sync with Selenium IDE and generates incorrect
73              // code.
74  
75              /*File file = new File(basedir + "/" + files[i]);
76  
77              String input = StringUtil.replace(file.toString(), "\\", "/");
78  
79              XlateHtmlSeleneseToJava.main(
80                  new String[] {
81                      "test", "-silent", input
82                  }
83              );*/
84  
85              translate(basedir, files[i]);
86          }
87      }
88  
89      protected String fixParam(String param) {
90          StringBuilder sb = new StringBuilder();
91  
92          char[] array = param.toCharArray();
93  
94          for (int i = 0; i < array.length; ++i) {
95              char c = array[i];
96  
97              if (c == CharPool.BACK_SLASH) {
98                  sb.append("\\\\");
99              }
100             else if (c == CharPool.QUOTE) {
101                 sb.append("\\\"");
102             }
103             else if (Character.isWhitespace(c)) {
104                 sb.append(c);
105             }
106             else if ((c < 0x0020) || (c > 0x007e)) {
107                 sb.append("\\u");
108                 sb.append(UnicodeFormatter.charToHex(c));
109             }
110             else {
111                 sb.append(c);
112             }
113         }
114 
115         return StringUtil.replace(
116             sb.toString(), _FIX_PARAM_OLD_SUBS, _FIX_PARAM_NEW_SUBS);
117     }
118 
119     protected String[] getParams(String step) throws Exception {
120         String[] params = new String[3];
121 
122         int x = 0;
123         int y = 0;
124 
125         for (int i = 0; i < 3; i++) {
126             x = step.indexOf("<td>", x) + 4;
127             y = step.indexOf("\n", x);
128             y = step.lastIndexOf("</td>", y);
129 
130             params[i] = step.substring(x, y);
131         }
132 
133         return params;
134     }
135 
136     protected void translate(String basedir, String file) throws Exception {
137         file = StringUtil.replace(
138             file, StringPool.BACK_SLASH, StringPool.SLASH);
139 
140         int x = file.lastIndexOf(StringPool.SLASH);
141         int y = file.indexOf(StringPool.PERIOD);
142 
143         String testPackagePath = StringUtil.replace(
144             file.substring(0, x), StringPool.SLASH, StringPool.PERIOD);
145         String testName = file.substring(x + 1, y);
146         String testMethodName =
147             "test" + testName.substring(0, testName.length() - 4);
148         String testFileName = basedir + "/" + file.substring(0, y) + ".java";
149 
150         StringBuilder sb = new StringBuilder();
151 
152         sb.append("package " + testPackagePath + ";\n\n");
153 
154         sb.append("import com.liferay.portal.kernel.util.FileUtil;\n");
155         sb.append("import com.liferay.portal.kernel.util.StringPool;\n");
156         sb.append("import com.liferay.portalweb.portal.BaseTestCase;\n\n");
157         sb.append(
158             "import com.liferay.portalweb.portal.util.RuntimeVariables;\n\n");
159 
160         sb.append("public class " + testName + " extends BaseTestCase {");
161 
162         sb.append("public void " + testMethodName + "() throws Exception {");
163 
164         String xml = FileUtil.read(basedir + "/" + file);
165 
166         if ((xml.indexOf("<title>" + testName + "</title>") == -1) ||
167             (xml.indexOf("colspan=\"3\">" + testName + "</td>") == -1)) {
168 
169             System.out.println(testName + " has an invalid test name");
170         }
171 
172         if (xml.indexOf("&quot;") != -1) {
173             xml = StringUtil.replace(xml, "&quot;", "\"");
174 
175             FileUtil.write(basedir + "/" + file, xml);
176         }
177 
178         x = xml.indexOf("<tbody>");
179         y = xml.indexOf("</tbody>");
180 
181         xml = xml.substring(x, y + 8);
182 
183         Map<String, String> labels = new HashMap<String, String>();
184 
185         int labelCount = 1;
186 
187         x = 0;
188         y = 0;
189 
190         while (true) {
191             x = xml.indexOf("<tr>", x);
192             y = xml.indexOf("\n</tr>", x);
193 
194             if ((x == -1) || (y == -1)) {
195                 break;
196             }
197 
198             x += 6;
199             y++;
200 
201             String step = xml.substring(x, y);
202 
203             String[] params = getParams(step);
204 
205             String param1 = params[0];
206             String param2 = fixParam(params[1]);
207             String param3 = fixParam(params[2]);
208 
209             if (param1.equals("label")) {
210                 String label = labels.get(param2);
211 
212                 if (label == null) {
213                     labelCount++;
214 
215                     label = labels.put(param2, String.valueOf(labelCount));
216                 }
217             }
218         }
219 
220         if (labels.size() > 0) {
221             sb.append("int label = 1;");
222 
223             sb.append("while (label >= 1) {");
224             sb.append("switch (label) {");
225             sb.append("case 1:");
226         }
227 
228         x = 0;
229         y = 0;
230 
231         while (true) {
232             x = xml.indexOf("<tr>", x);
233             y = xml.indexOf("\n</tr>", x);
234 
235             if ((x == -1) || (y == -1)) {
236                 break;
237             }
238 
239             x += 6;
240             y++;
241 
242             String step = xml.substring(x, y);
243 
244             String[] params = getParams(step);
245 
246             String param1 = params[0];
247             String param2 = fixParam(params[1]);
248             String param3 = fixParam(params[2]);
249 
250             if (param1.equals("addSelection") || param1.equals("select") ||
251                 param1.equals("type") || param1.equals("typeKeys") ||
252                 param1.equals("waitForPopUp")) {
253 
254                 sb.append("selenium.");
255                 sb.append(param1);
256                 sb.append("(\"");
257                 sb.append(param2);
258                 sb.append("\", RuntimeVariables.replace(\"");
259                 sb.append(param3);
260                 sb.append("\"));");
261             }
262             else if (param1.equals("assertChecked")) {
263                 sb.append("assertTrue(selenium.isChecked(\"");
264                 sb.append(param2);
265                 sb.append("\"));");
266             }
267             else if (param1.equals("assertConfirmation")) {
268                 param2 = StringUtil.replace(param2, "?", "[\\\\s\\\\S]");
269 
270                 sb.append("assertTrue(selenium.getConfirmation().matches(\"^");
271                 sb.append(param2);
272                 sb.append("$\"));");
273             }
274             else if (param1.equals("assertElementNotPresent") ||
275                      param1.equals("assertElementPresent")) {
276 
277                 if (param1.equals("assertElementNotPresent")) {
278                     sb.append("assertFalse");
279                 }
280                 else if (param1.equals("assertElementPresent")) {
281                     sb.append("assertTrue");
282                 }
283 
284                 sb.append("(selenium.isElementPresent(\"");
285                 sb.append(param2);
286                 sb.append("\"));");
287             }
288             else if (param1.equals("assertNotText") ||
289                      param1.equals("assertText")) {
290 
291                 if (param1.equals("assertNotText")) {
292                     sb.append("assertNotEquals");
293                 }
294                 else if (param1.equals("assertText")) {
295                     sb.append("assertEquals");
296                 }
297 
298                 sb.append("(\"");
299                 sb.append(param3);
300                 sb.append("\", selenium.getText(\"");
301                 sb.append(param2);
302                 sb.append("\"));");
303             }
304             else if (param1.equals("assertSelectOptions")) {
305                 String[] expectedArray = StringUtil.split(param3);
306 
307                 sb.append("String[] actualArray = ");
308                 sb.append("selenium.getSelectOptions(\"");
309                 sb.append(param2);
310                 sb.append("\");");
311 
312                 sb.append("assertEquals(");
313                 sb.append(expectedArray.length);
314                 sb.append(", actualArray.length);");
315 
316                 for (int i = 0; i < expectedArray.length; i++) {
317                     sb.append("assertEquals(\"");
318                     sb.append(expectedArray[i]);
319                     sb.append("\", actualArray[");
320                     sb.append(i);
321                     sb.append("]);");
322                 }
323             }
324             else if (param1.equals("assertTextNotPresent") ||
325                      param1.equals("assertTextPresent")) {
326 
327                 if (param1.equals("assertTextNotPresent")) {
328                     sb.append("assertFalse");
329                 }
330                 else if (param1.equals("assertTextPresent")) {
331                     sb.append("assertTrue");
332                 }
333 
334                 sb.append("(selenium.isTextPresent(\"");
335                 sb.append(param2);
336                 sb.append("\"));");
337             }
338             else if (param1.equals("captureEntirePageScreenshot")) {
339                 int pos = param2.lastIndexOf("\\");
340 
341                 String dirName = param2.substring(0, pos + 1);
342 
343                 sb.append("FileUtil.mkdirs(RuntimeVariables.replace(\"");
344                 sb.append(dirName);
345                 sb.append("\"));");
346                 sb.append("selenium.captureEntirePageScreenshot(");
347                 sb.append("RuntimeVariables.replace(\"");
348                 sb.append(param2);
349                 sb.append("\"), \"\");");
350             }
351             else if (param1.equals("click") || param1.equals("mouseDown") ||
352                      param1.equals("mouseUp") || param1.equals("open") ||
353                      param1.equals("selectFrame") ||
354                      param1.equals("selectWindow")) {
355 
356                 sb.append("selenium.");
357                 sb.append(param1);
358                 sb.append("(\"");
359                 sb.append(param2);
360                 sb.append("\");");
361             }
362             else if (param1.equals("clickAndWait")) {
363                 sb.append("selenium.click(RuntimeVariables.replace(\"");
364                 sb.append(param2);
365                 sb.append("\"));");
366                 sb.append("selenium.waitForPageToLoad(\"30000\");");
367             }
368             else if (param1.equals("close")) {
369                 sb.append("selenium.");
370                 sb.append(param1);
371                 sb.append("();");
372             }
373             else if (param1.equals("gotoIf")) {
374                 String conditional = StringUtil.replace(
375                     param2, new String[] {"${", "}"}, new String[] {"", ""});
376 
377                 sb.append("if (");
378                 sb.append(conditional);
379                 sb.append(") {");
380                 sb.append("label =");
381                 sb.append(labels.get(param3));
382                 sb.append(";");
383                 sb.append("continue;");
384                 sb.append("}");
385             }
386             else if (param1.equals("label")) {
387                 String label = labels.get(param2);
388 
389                 sb.append("case ");
390                 sb.append(label);
391                 sb.append(":");
392             }
393             else if (param1.equals("pause")) {
394                 sb.append("Thread.sleep(");
395                 sb.append(param2);
396                 sb.append(");");
397             }
398             else if (param1.equals("selectAndWait")) {
399                 sb.append("selenium.select(\"");
400                 sb.append(param2);
401                 sb.append("\", \"");
402                 sb.append(param3);
403                 sb.append("\");");
404                 sb.append("selenium.waitForPageToLoad(\"30000\");");
405             }
406             else if (param1.equals("store")) {
407                 sb.append("boolean ");
408                 sb.append(param3);
409                 sb.append(" = ");
410 
411                 if (param2.startsWith("eval(")) {
412                     String eval = param2.substring(5, param2.length() - 1);
413 
414                     eval = StringUtil.replace(eval, "'", "\"");
415 
416                     sb.append(eval);
417                 }
418 
419                 sb.append(";");
420             }
421             else if (param1.equals("storeText")) {
422                 sb.append("String ");
423                 sb.append(param3);
424                 sb.append(" = selenium.getText(\"");
425                 sb.append(param2);
426                 sb.append("\");");
427 
428                 sb.append("RuntimeVariables.setValue(\"");
429                 sb.append(param3);
430                 sb.append("\", ");
431                 sb.append(param3);
432                 sb.append(");");
433             }
434             else if (param1.equals("verifyElementNotPresent") ||
435                      param1.equals("verifyElementPresent")) {
436 
437                 if (param1.equals("verifyElementNotPresent")) {
438                     sb.append("verifyFalse");
439                 }
440                 else if (param1.equals("verifyElementPresent")) {
441                     sb.append("verifyTrue");
442                 }
443 
444                 sb.append("(selenium.isElementPresent(\"");
445                 sb.append(param2);
446                 sb.append("\"));");
447             }
448             else if (param1.equals("verifyTextNotPresent") ||
449                      param1.equals("verifyTextPresent")) {
450 
451                 if (param1.equals("verifyTextNotPresent")) {
452                     sb.append("verifyFalse");
453                 }
454                 else if (param1.equals("verifyTextPresent")) {
455                     sb.append("verifyTrue");
456                 }
457 
458                 sb.append("(selenium.isTextPresent(\"");
459                 sb.append(param2);
460                 sb.append("\"));");
461             }
462             else if (param1.equals("verifyTitle")) {
463                 sb.append("verifyEquals(\"");
464                 sb.append(param2);
465                 sb.append("\", selenium.getTitle());");
466             }
467             else if (param1.equals("waitForElementNotPresent") ||
468                      param1.equals("waitForElementPresent") ||
469                      param1.equals("waitForTextNotPresent") ||
470                      param1.equals("waitForTextPresent")) {
471 
472                 sb.append("for (int second = 0;; second++) {");
473                 sb.append("if (second >= 60) {");
474                 sb.append("fail(\"timeout\");");
475                 sb.append("}");
476 
477                 sb.append("try {");
478                 sb.append("if (");
479 
480                 if (param1.equals("waitForElementNotPresent") ||
481                     param1.equals("waitForTextNotPresent")) {
482 
483                     sb.append("!");
484                 }
485 
486                 sb.append("selenium.");
487 
488                 if (param1.equals("waitForElementNotPresent") ||
489                     param1.equals("waitForElementPresent")) {
490 
491                     sb.append("isElementPresent");
492                 }
493                 else if (param1.equals("waitForTextNotPresent") ||
494                          param1.equals("waitForTextPresent")) {
495 
496                     sb.append("isTextPresent");
497                 }
498 
499                 sb.append("(\"");
500                 sb.append(param2);
501                 sb.append("\")) {");
502                 sb.append("break;");
503                 sb.append("}");
504                 sb.append("}");
505                 sb.append("catch (Exception e) {");
506                 sb.append("}");
507 
508                 sb.append("Thread.sleep(1000);");
509                 sb.append("}");
510             }
511             else if (param1.equals("waitForTable")) {
512                 sb.append("for (int second = 0;; second++) {");
513                 sb.append("if (second >= 60) {");
514                 sb.append("fail(\"timeout\");");
515                 sb.append("}");
516 
517                 sb.append("try {");
518                 sb.append("if (StringPool.BLANK.equals(selenium.getTable(\"");
519                 sb.append(param2);
520                 sb.append("\"))) {");
521                 sb.append("break;");
522                 sb.append("}");
523                 sb.append("}");
524                 sb.append("catch (Exception e) {");
525                 sb.append("}");
526 
527                 sb.append("Thread.sleep(1000);");
528                 sb.append("}");
529             }
530             else {
531                 System.out.println(param1 + " was not translated");
532             }
533         }
534 
535         if (labels.size() > 0) {
536             sb.append("case 100:");
537             sb.append("label = -1;");
538             sb.append("}");
539             sb.append("}");
540         }
541 
542         sb.append("}");
543         sb.append("}");
544 
545         String content = sb.toString();
546 
547         ServiceBuilder.writeFile(new File(testFileName), content);
548     }
549 
550     private static final String[] _FIX_PARAM_OLD_SUBS = new String[] {
551         "\\\\n", "<br />"
552     };
553 
554     private static final String[] _FIX_PARAM_NEW_SUBS = new String[] {
555         "\\n", "\\n"
556     };
557 
558 }