1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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  public class SeleneseToJavaBuilder {
46  
47      public static void main(String[] args) throws Exception {
48          InitUtil.initWithSpring();
49  
50          if (args.length == 1) {
51              new SeleneseToJavaBuilder(args[0]);
52          }
53          else {
54              throw new IllegalArgumentException();
55          }
56      }
57  
58      public SeleneseToJavaBuilder(String basedir) throws Exception {
59          DirectoryScanner ds = new DirectoryScanner();
60  
61          ds.setBasedir(basedir);
62          ds.setIncludes(new String[] {"**\\*.html"});
63  
64          ds.scan();
65  
66          String[] files = ds.getIncludedFiles();
67  
68          for (int i = 0; i < files.length; i++) {
69  
70              // I would have preferred to use XlateHtmlSeleneseToJava, but it
71              // is horribly out of sync with Selenium IDE and generates incorrect
72              // code.
73  
74              /*File file = new File(basedir + "/" + files[i]);
75  
76              String input = StringUtil.replace(file.toString(), "\\", "/");
77  
78              XlateHtmlSeleneseToJava.main(
79                  new String[] {
80                      "test", "-silent", input
81                  }
82              );*/
83  
84              translate(basedir, files[i]);
85          }
86      }
87  
88      protected String fixParam(String param) {
89          StringBuilder sb = new StringBuilder();
90  
91          char[] array = param.toCharArray();
92  
93          for (int i = 0; i < array.length; ++i) {
94              char c = array[i];
95  
96              if (c == CharPool.BACK_SLASH) {
97                  sb.append("\\\\");
98              }
99              else if (c == CharPool.QUOTE) {
100                 sb.append("\\\"");
101             }
102             else if (Character.isWhitespace(c)) {
103                 sb.append(c);
104             }
105             else if ((c < 0x0020) || (c > 0x007e)) {
106                 sb.append("\\u");
107                 sb.append(UnicodeFormatter.charToHex(c));
108             }
109             else {
110                 sb.append(c);
111             }
112         }
113 
114         return StringUtil.replace(
115             sb.toString(), _FIX_PARAM_OLD_SUBS, _FIX_PARAM_NEW_SUBS);
116     }
117 
118     protected String[] getParams(String step) throws Exception {
119         String[] params = new String[3];
120 
121         int x = 0;
122         int y = 0;
123 
124         for (int i = 0; i < 3; i++) {
125             x = step.indexOf("<td>", x) + 4;
126             y = step.indexOf("\n", x);
127             y = step.lastIndexOf("</td>", y);
128 
129             params[i] = step.substring(x, y);
130         }
131 
132         return params;
133     }
134 
135     protected void translate(String basedir, String file) throws Exception {
136         file = StringUtil.replace(
137             file, StringPool.BACK_SLASH, StringPool.SLASH);
138 
139         int x = file.lastIndexOf(StringPool.SLASH);
140         int y = file.indexOf(StringPool.PERIOD);
141 
142         String testPackagePath = StringUtil.replace(
143             file.substring(0, x), StringPool.SLASH, StringPool.PERIOD);
144         String testName = file.substring(x + 1, y);
145         String testMethodName =
146             "test" + testName.substring(0, testName.length() - 4);
147         String testFileName = basedir + "/" + file.substring(0, y) + ".java";
148 
149         StringBuilder sb = new StringBuilder();
150 
151         sb.append("package " + testPackagePath + ";\n\n");
152 
153         sb.append("import com.liferay.portal.kernel.util.FileUtil;\n");
154         sb.append("import com.liferay.portal.kernel.util.StringPool;\n");
155         sb.append("import com.liferay.portalweb.portal.BaseTestCase;\n\n");
156         sb.append(
157             "import com.liferay.portalweb.portal.util.RuntimeVariables;\n\n");
158 
159         sb.append("public class " + testName + " extends BaseTestCase {");
160 
161         sb.append("public void " + testMethodName + "() throws Exception {");
162 
163         String xml = FileUtil.read(basedir + "/" + file);
164 
165         if ((xml.indexOf("<title>" + testName + "</title>") == -1) ||
166             (xml.indexOf("colspan=\"3\">" + testName + "</td>") == -1)) {
167 
168             System.out.println(testName + " has an invalid test name");
169         }
170 
171         if (xml.indexOf("&quot;") != -1) {
172             xml = StringUtil.replace(xml, "&quot;", "\"");
173 
174             FileUtil.write(basedir + "/" + file, xml);
175         }
176 
177         x = xml.indexOf("<tbody>");
178         y = xml.indexOf("</tbody>");
179 
180         xml = xml.substring(x, y + 8);
181 
182         Map<String, String> labels = new HashMap<String, String>();
183 
184         int labelCount = 1;
185 
186         x = 0;
187         y = 0;
188 
189         while (true) {
190             x = xml.indexOf("<tr>", x);
191             y = xml.indexOf("\n</tr>", x);
192 
193             if ((x == -1) || (y == -1)) {
194                 break;
195             }
196 
197             x += 6;
198             y++;
199 
200             String step = xml.substring(x, y);
201 
202             String[] params = getParams(step);
203 
204             String param1 = params[0];
205             String param2 = fixParam(params[1]);
206 
207             if (param1.equals("label")) {
208                 String label = labels.get(param2);
209 
210                 if (label == null) {
211                     labelCount++;
212 
213                     label = labels.put(param2, String.valueOf(labelCount));
214                 }
215             }
216         }
217 
218         if (labels.size() > 0) {
219             sb.append("int label = 1;");
220 
221             sb.append("while (label >= 1) {");
222             sb.append("switch (label) {");
223             sb.append("case 1:");
224         }
225 
226         x = 0;
227         y = 0;
228 
229         while (true) {
230             x = xml.indexOf("<tr>", x);
231             y = xml.indexOf("\n</tr>", x);
232 
233             if ((x == -1) || (y == -1)) {
234                 break;
235             }
236 
237             x += 6;
238             y++;
239 
240             String step = xml.substring(x, y);
241 
242             String[] params = getParams(step);
243 
244             String param1 = params[0];
245             String param2 = fixParam(params[1]);
246             String param3 = fixParam(params[2]);
247 
248             if (param1.equals("addSelection") || param1.equals("clickAt") ||
249                 param1.equals("keyPress") || param1.equals("select") ||
250                 param1.equals("type") || param1.equals("typeKeys") ||
251                 param1.equals("waitForPopUp")) {
252 
253                 sb.append("selenium.");
254                 sb.append(param1);
255                 sb.append("(\"");
256                 sb.append(param2);
257                 sb.append("\", RuntimeVariables.replace(\"");
258                 sb.append(param3);
259                 sb.append("\"));");
260             }
261             else if (param1.equals("assertAlert") ||
262                      param1.equals("assertNotAlert")) {
263 
264                 if (param1.equals("assertAlert")) {
265                     sb.append("assertEquals");
266                 }
267                 else if (param1.equals("assertNotAlert")) {
268                     sb.append("assertNotEquals");
269                 }
270 
271                 sb.append("(\"");
272                 sb.append(param2);
273                 sb.append("\", selenium.getAlert());");
274             }
275             else if (param1.equals("assertChecked") ||
276                      param1.equals("assertNotChecked")) {
277 
278                 if (param1.equals("assertChecked")) {
279                     sb.append("assertTrue");
280                 }
281                 else if (param1.equals("assertNotChecked")) {
282                     sb.append("assertFalse");
283                 }
284 
285                 sb.append("(selenium.isChecked(\"");
286                 sb.append(param2);
287                 sb.append("\"));");
288             }
289             else if (param1.equals("assertConfirmation")) {
290                 param2 = StringUtil.replace(param2, "?", "[\\\\s\\\\S]");
291 
292                 sb.append("assertTrue(selenium.getConfirmation().matches(\"^");
293                 sb.append(param2);
294                 sb.append("$\"));");
295             }
296             else if (param1.equals("assertLocation") ||
297                      param1.equals("assertNotLocation")) {
298 
299                 if (param1.equals("assertLocation")) {
300                     sb.append("assertEquals");
301                 }
302                 else if (param1.equals("assertNotLocation")) {
303                     sb.append("assertNotEquals");
304                 }
305 
306                 sb.append("(\"");
307                 sb.append(param2);
308                 sb.append("\", selenium.getLocation());");
309             }
310             else if (param1.equals("assertElementNotPresent") ||
311                      param1.equals("assertElementPresent")) {
312 
313                 if (param1.equals("assertElementNotPresent")) {
314                     sb.append("assertFalse");
315                 }
316                 else if (param1.equals("assertElementPresent")) {
317                     sb.append("assertTrue");
318                 }
319 
320                 sb.append("(selenium.isElementPresent(\"");
321                 sb.append(param2);
322                 sb.append("\"));");
323             }
324             else if (param1.equals("assertNotPartialText") ||
325                      param1.equals("assertPartialText")) {
326 
327                 if (param1.equals("assertNotPartialText")) {
328                     sb.append("assertFalse");
329                 }
330                 else if (param1.equals("assertPartialText")) {
331                     sb.append("assertTrue");
332                 }
333 
334                 sb.append("(selenium.isPartialText(\"");
335                 sb.append(param2);
336                 sb.append("\", ");
337 
338                 if (param3.startsWith("${")) {
339                     sb.append("RuntimeVariables.getValue(\"");
340 
341                     String text = param3.substring(2, param3.length() - 1);
342 
343                     sb.append(text);
344                     sb.append("\")");
345                 }
346                 else {
347                     sb.append("\"");
348                     sb.append(param3);
349                     sb.append("\"");
350                 }
351 
352                 sb.append("));");
353             }
354             else if (param1.equals("assertNotText") ||
355                      param1.equals("assertText")) {
356 
357                 if (param1.equals("assertNotText")) {
358                     sb.append("assertNotEquals");
359                 }
360                 else if (param1.equals("assertText")) {
361                     sb.append("assertEquals");
362                 }
363 
364                 sb.append("(RuntimeVariables.replace(\"");
365                 sb.append(param3);
366                 sb.append("\"), selenium.getText(\"");
367                 sb.append(param2);
368                 sb.append("\"));");
369             }
370             else if (param1.equals("assertNotValue") ||
371                      param1.equals("assertValue")) {
372 
373                 if (param1.equals("assertNotValue")) {
374                     sb.append("assertNotEquals");
375                 }
376                 else if (param1.equals("assertValue")) {
377                     sb.append("assertEquals");
378                 }
379 
380                 sb.append("(\"");
381                 sb.append(param3);
382                 sb.append("\", selenium.getValue(\"");
383                 sb.append(param2);
384                 sb.append("\"));");
385             }
386             else if (param1.equals("assertNotVisible") ||
387                      param1.equals("assertVisible")) {
388 
389                 if (param1.equals("assertNotVisible")) {
390                     sb.append("assertFalse");
391                 }
392                 else if (param1.equals("assertVisible")) {
393                     sb.append("assertTrue");
394                 }
395 
396                 sb.append("(");
397                 sb.append("selenium.isVisible(\"");
398                 sb.append(param2);
399                 sb.append("\"));");
400             }
401             else if (param1.equals("assertSelectOptions")) {
402                 String[] expectedArray = StringUtil.split(param3);
403 
404                 sb.append("String[] actualArray = ");
405                 sb.append("selenium.getSelectOptions(\"");
406                 sb.append(param2);
407                 sb.append("\");");
408 
409                 sb.append("assertEquals(");
410                 sb.append(expectedArray.length);
411                 sb.append(", actualArray.length);");
412 
413                 for (int i = 0; i < expectedArray.length; i++) {
414                     sb.append("assertEquals(\"");
415                     sb.append(expectedArray[i]);
416                     sb.append("\", actualArray[");
417                     sb.append(i);
418                     sb.append("]);");
419                 }
420             }
421             else if (param1.equals("assertTextNotPresent") ||
422                      param1.equals("assertTextPresent")) {
423 
424                 if (param1.equals("assertTextNotPresent")) {
425                     sb.append("assertFalse");
426                 }
427                 else if (param1.equals("assertTextPresent")) {
428                     sb.append("assertTrue");
429                 }
430 
431                 sb.append("(selenium.isTextPresent(\"");
432                 sb.append(param2);
433                 sb.append("\"));");
434             }
435             else if (param1.equals("captureEntirePageScreenshot")) {
436                 int pos = param2.lastIndexOf("\\");
437 
438                 String dirName = param2.substring(0, pos + 1);
439 
440                 sb.append("FileUtil.mkdirs(RuntimeVariables.replace(\"");
441                 sb.append(dirName);
442                 sb.append("\"));");
443                 sb.append("selenium.captureEntirePageScreenshot(");
444                 sb.append("RuntimeVariables.replace(\"");
445                 sb.append(param2);
446                 sb.append("\"), \"\");");
447             }
448             else if (param1.equals("check") || param1.equals("click") ||
449                      param1.equals("doubleClick") ||
450                      param1.equals("mouseDown") || param1.equals("mouseOver") ||
451                      param1.equals("mouseUp") || param1.equals("open") ||
452                      param1.equals("uncheck") || param1.equals("selectFrame") ||
453                      param1.equals("selectWindow")) {
454 
455                 sb.append("selenium.");
456                 sb.append(param1);
457                 sb.append("(\"");
458                 sb.append(param2);
459                 sb.append("\");");
460             }
461             else if (param1.equals("clickAndWait")) {
462                 sb.append("selenium.click(RuntimeVariables.replace(\"");
463                 sb.append(param2);
464                 sb.append("\"));");
465                 sb.append("selenium.waitForPageToLoad(\"30000\");");
466             }
467             else if (param1.equals("clickAtAndWait") ||
468                      param1.equals("keyPressAndWait") ||
469                      param1.equals("selectAndWait")) {
470 
471                 sb.append("selenium.");
472 
473                 String text = param1.substring(0, param1.length() - 7);
474 
475                 sb.append(text);
476                 sb.append("(\"");
477                 sb.append(param2);
478                 sb.append("\", RuntimeVariables.replace(\"");
479                 sb.append(param3);
480                 sb.append("\"));");
481                 sb.append("selenium.waitForPageToLoad(\"30000\");");
482             }
483             else if (param1.equals("close") || param1.equals("refresh")) {
484                 sb.append("selenium.");
485                 sb.append(param1);
486                 sb.append("();");
487             }
488             else if (param1.equals("dragAndDropToObject")) {
489                 sb.append("selenium.");
490                 sb.append("dragAndDropToObject(\"");
491                 sb.append(param2);
492                 sb.append("\", \"");
493                 sb.append(param3);
494                 sb.append("\");");
495             }
496             else if (param1.equals("echo")) {
497                 sb.append("System.out.println(\"");
498                 sb.append(param2);
499                 sb.append("\");");
500             }
501             else if (param1.equals("gotoIf")) {
502                 String conditional = StringUtil.replace(
503                     param2, new String[] {"${", "}"}, new String[] {"", ""});
504 
505                 sb.append("if (");
506                 sb.append(conditional);
507                 sb.append(") {");
508                 sb.append("label =");
509                 sb.append(labels.get(param3));
510                 sb.append(";");
511                 sb.append("continue;");
512                 sb.append("}");
513             }
514             else if (param1.equals("label")) {
515                 String label = labels.get(param2);
516 
517                 sb.append("case ");
518                 sb.append(label);
519                 sb.append(":");
520             }
521             else if (param1.equals("pause")) {
522                 sb.append("Thread.sleep(");
523                 sb.append(param2);
524                 sb.append(");");
525             }
526             else if (param1.equals("refreshAndWait")) {
527                 sb.append("selenium.refresh();");
528                 sb.append("selenium.waitForPageToLoad(\"30000\");");
529             }
530             else if (param1.equals("store")) {
531                 sb.append("boolean ");
532                 sb.append(param3);
533                 sb.append(" = ");
534 
535                 if (param2.startsWith("eval(")) {
536                     String eval = param2.substring(5, param2.length() - 1);
537 
538                     eval = StringUtil.replace(eval, "'", "\"");
539 
540                     sb.append(eval);
541                 }
542 
543                 sb.append(";");
544             }
545             else if (param1.equals("storeIncrementedText")) {
546                 sb.append("String ");
547                 sb.append(param3);
548                 sb.append(" = selenium.getIncrementedText(\"");
549                 sb.append(param2);
550                 sb.append("\");");
551 
552                 sb.append("RuntimeVariables.setValue(\"");
553                 sb.append(param3);
554                 sb.append("\", ");
555                 sb.append(param3);
556                 sb.append(");");
557             }
558             else if (param1.equals("storeText")) {
559                 sb.append("String ");
560                 sb.append(param3);
561                 sb.append(" = selenium.getText(\"");
562                 sb.append(param2);
563                 sb.append("\");");
564 
565                 sb.append("RuntimeVariables.setValue(\"");
566                 sb.append(param3);
567                 sb.append("\", ");
568                 sb.append(param3);
569                 sb.append(");");
570             }
571             else if (param1.equals("verifyElementNotPresent") ||
572                      param1.equals("verifyElementPresent")) {
573 
574                 if (param1.equals("verifyElementNotPresent")) {
575                     sb.append("verifyFalse");
576                 }
577                 else if (param1.equals("verifyElementPresent")) {
578                     sb.append("verifyTrue");
579                 }
580 
581                 sb.append("(selenium.isElementPresent(\"");
582                 sb.append(param2);
583                 sb.append("\"));");
584             }
585             else if (param1.equals("verifyTextNotPresent") ||
586                      param1.equals("verifyTextPresent")) {
587 
588                 if (param1.equals("verifyTextNotPresent")) {
589                     sb.append("verifyFalse");
590                 }
591                 else if (param1.equals("verifyTextPresent")) {
592                     sb.append("verifyTrue");
593                 }
594 
595                 sb.append("(selenium.isTextPresent(\"");
596                 sb.append(param2);
597                 sb.append("\"));");
598             }
599             else if (param1.equals("verifyTitle")) {
600                 sb.append("verifyEquals(\"");
601                 sb.append(param2);
602                 sb.append("\", selenium.getTitle());");
603             }
604             else if (param1.equals("waitForElementNotPresent") ||
605                      param1.equals("waitForElementPresent") ||
606                      param1.equals("waitForNotPartialText") ||
607                      param1.equals("waitForPartialText") ||
608                      param1.equals("waitForTextNotPresent") ||
609                      param1.equals("waitForTextPresent")) {
610 
611                 sb.append("for (int second = 0;; second++) {");
612                 sb.append("if (second >= 60) {");
613                 sb.append("fail(\"timeout\");");
614                 sb.append("}");
615 
616                 sb.append("try {");
617                 sb.append("if (");
618 
619                 if (param1.equals("waitForElementNotPresent") ||
620                     param1.equals("waitForNotPartialText") ||
621                     param1.equals("waitForTextNotPresent")) {
622 
623                     sb.append("!");
624                 }
625 
626                 sb.append("selenium.");
627 
628                 if (param1.equals("waitForElementNotPresent") ||
629                     param1.equals("waitForElementPresent")) {
630 
631                     sb.append("isElementPresent");
632                     sb.append("(\"");
633                     sb.append(param2);
634                     sb.append("\")");
635                 }
636                 else if (param1.equals("waitForTextNotPresent") ||
637                          param1.equals("waitForTextPresent")) {
638 
639                     sb.append("isTextPresent");
640                     sb.append("(\"");
641                     sb.append(param2);
642                     sb.append("\")");
643                 }
644                 else if (param1.equals("waitForNotPartialText") ||
645                          param1.equals("waitForPartialText")) {
646 
647                     sb.append("isPartialText(\"");
648                     sb.append(param2);
649                     sb.append("\", ");
650 
651                     if (param3.startsWith("${")) {
652                         sb.append("RuntimeVariables.getValue(\"");
653 
654                         String text = param3.substring(2, param3.length() - 1);
655 
656                         sb.append(text);
657                         sb.append("\")");
658                     }
659                     else {
660                         sb.append("\"");
661                         sb.append(param3);
662                         sb.append("\"");
663                     }
664 
665                     sb.append(")");
666                 }
667 
668                 sb.append(") {");
669                 sb.append("break;");
670                 sb.append("}");
671                 sb.append("}");
672                 sb.append("catch (Exception e) {");
673                 sb.append("}");
674 
675                 sb.append("Thread.sleep(1000);");
676                 sb.append("}");
677             }
678             else if (param1.equals("waitForNotVisible") ||
679                      param1.equals("waitForVisible")) {
680 
681                 sb.append("for (int second = 0;; second++) {");
682                 sb.append("if (second >= 60) {");
683                 sb.append("fail(\"timeout\");");
684                 sb.append("}");
685 
686                 sb.append("try {");
687                 sb.append("if (");
688 
689                 if (param1.equals("waitForNotVisible")) {
690                     sb.append("!");
691                 }
692 
693                 sb.append("selenium.isVisible");
694                 sb.append("(\"");
695                 sb.append(param2);
696                 sb.append("\")) {");
697                 sb.append("break;");
698                 sb.append("}");
699                 sb.append("}");
700                 sb.append("catch (Exception e) {");
701                 sb.append("}");
702 
703                 sb.append("Thread.sleep(1000);");
704                 sb.append("}");
705             }
706             else if (param1.equals("waitForTable")) {
707                 sb.append("for (int second = 0;; second++) {");
708                 sb.append("if (second >= 60) {");
709                 sb.append("fail(\"timeout\");");
710                 sb.append("}");
711 
712                 sb.append("try {");
713                 sb.append("if (StringPool.BLANK.equals(selenium.getTable(\"");
714                 sb.append(param2);
715                 sb.append("\"))) {");
716                 sb.append("break;");
717                 sb.append("}");
718                 sb.append("}");
719                 sb.append("catch (Exception e) {");
720                 sb.append("}");
721 
722                 sb.append("Thread.sleep(1000);");
723                 sb.append("}");
724             }
725             else {
726                 System.out.println(param1 + " was not translated");
727             }
728         }
729 
730         if (labels.size() > 0) {
731             sb.append("case 100:");
732             sb.append("label = -1;");
733             sb.append("}");
734             sb.append("}");
735         }
736 
737         sb.append("}");
738         sb.append("}");
739 
740         String content = sb.toString();
741 
742         ServiceBuilder.writeFile(new File(testFileName), content);
743     }
744 
745     private static final String[] _FIX_PARAM_OLD_SUBS = new String[] {
746         "\\\\n", "<br />"
747     };
748 
749     private static final String[] _FIX_PARAM_NEW_SUBS = new String[] {
750         "\\n", "\\n"
751     };
752 
753 }