View Javadoc

    1   /*
    2    $Id: TestCaseRenderEngine.java,v 1.5 2004/04/01 06:21:55 cpoirier Exp $
    3
    4    Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
    5
    6    Redistribution and use of this software and associated documentation
    7    ("Software"), with or without modification, are permitted provided
    8    that the following conditions are met:
    9
    10   1. Redistributions of source code must retain copyright
    11      statements and notices.  Redistributions must also contain a
    12      copy of this document.
    13
    14   2. Redistributions in binary form must reproduce the
    15      above copyright notice, this list of conditions and the
    16      following disclaimer in the documentation and/or other
    17      materials provided with the distribution.
    18
    19   3. The name "groovy" must not be used to endorse or promote
    20      products derived from this Software without prior written
    21      permission of The Codehaus.  For written permission,
    22      please contact info@codehaus.org.
    23
    24   4. Products derived from this Software may not be called "groovy"
    25      nor may "groovy" appear in their names without prior written
    26      permission of The Codehaus. "groovy" is a registered
    27      trademark of The Codehaus.
    28
    29   5. Due credit should be given to The Codehaus -
    30      http://groovy.codehaus.org/
    31
    32   THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
    33   ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
    34   NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
    35   FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
    36   THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
    37   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    38   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    39   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    40   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    41   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    42   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    43   OF THE POSSIBILITY OF SUCH DAMAGE.
    44
    45   */
    46  package org.codehaus.groovy.wiki;
    47
    48  import java.io.IOException;
    49  import java.io.Writer;
    50  import java.util.regex.Pattern;
    51
    52  import org.radeox.api.engine.RenderEngine;
    53  import org.radeox.api.engine.context.RenderContext;
    54
    55  /***
    56   * @author James Strachan
    57   * @version $Revision: 1.5 $
    58   */
    59  public class TestCaseRenderEngine implements RenderEngine {
    60      Pattern groovyCodePattern = Pattern.compile("//{code:groovy//}");
    61      Pattern groovyShellPattern = Pattern.compile("//{code:groovysh//}");
    62      Pattern codePattern = Pattern.compile("//{code//}");
    63
    64      public TestCaseRenderEngine() {
    65      }
    66
    67      public String getName() {
    68          return "TestCase";
    69      }
    70
    71      public String render(String content, RenderContext context) {
    72          String name = (String) context.get("name");
    73          if (name == null) {
    74              name = "UknownName.wiki";
    75          }
    76          int idx = name.lastIndexOf('.');
    77          if (idx > 0) {
    78              name = name.substring(0, idx);
    79          }
    80          name = name + "Test";
    81
    82          // lets replace {code:groovy} with a unit test case method name
    83          StringBuffer buf = new StringBuffer();
    84
    85          String[] parts = groovyCodePattern.split(content);
    86
    87          buf.append( "package wiki\nclass " + name + " extends GroovyTestCase {\n\n");
    88          buf.append("/*\n");
    89          buf.append(processShellScripts(parts[0]));
    90
    91          for (int count = 1; count < parts.length; count++ ) {
    92              buf.append("*/ \n\n  void testCase" + count + "() {\n");
    93
    94              buf.append(processShellScripts(removeCloseCode(parts[count])));
    95          }
    96
    97          buf.append("\n*/\n\n");
    98          buf.append("void testDummy() {\n// this is a dummy test case\n}\n\n}\n");
    99
    100         return buf.toString();
    101     }
    102
    103     /***
    104      * Splits the comment block extracting any scripts that need to be tested
    105      * @param text
    106      * @return
    107      */
    108     protected String processShellScripts(String text) {
    109         StringBuffer buf = new StringBuffer();
    110
    111         String[] parts = groovyShellPattern.split(text);
    112
    113         buf.append(parts[0]);
    114
    115         for (int count = 1; count < parts.length; count++ ) {
    116             buf.append("*/ \n\n  void testScript" + count + "() {\n");
    117             buf.append("    assertScript( <<<SCRIPT_EOF" + count + "\n");
    118
    119             String code = parts[count].replaceFirst("//{code//}", "\nSCRIPT_EOF" + count + " )\n}    \n\n /*");
    120
    121             // lets escape ${foo} expressions
    122             StringBuffer temp = new StringBuffer(code);
    123             for (int idx = 0; true; idx++) {
    124                 idx = temp.indexOf("$", idx);
    125                 if (idx >= 0) {
    126                     String next = temp.substring(++idx, idx+1);
    127                     if (next.equals("{")) {
    128
    129                         //
    130                         // It's a hack, but we aren't escaping all \, so
    131                         // we just let \${ stand...
    132
    133                         if( idx-2 >= 0 && !temp.substring(idx-2,idx-1).equals("//") )
    134                         {
    135                             temp.insert(idx-1, "//");
    136                             idx++;
    137                         }
    138                     }
    139                 }
    140                 else {
    141                     break;
    142                 }
    143             }
    144
    145             buf.append(temp.toString());
    146         }
    147         return buf.toString();
    148     }
    149
    150     protected String removeCloseCode(String text) {
    151         return text.replaceFirst("//{code//}", "\n}\n\n /*");
    152     }
    153
    154     public void render(Writer out, String content, RenderContext context) throws IOException {
    155         out.write(render(content, context));
    156     }
    157 }