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