vmtest/src/main/java/org/apidesign/bck2brwsr/vmtest/VMTest.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Sun, 23 Dec 2012 17:02:34 +0100
branchlauncher
changeset 370 ed48023d1d85
parent 360 86f3ea771e24
child 372 3485327d3080
permissions -rw-r--r--
JavaScript and HTTP launchers separated
jaroslav@273
     1
/**
jaroslav@273
     2
 * Back 2 Browser Bytecode Translator
jaroslav@273
     3
 * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
jaroslav@273
     4
 *
jaroslav@273
     5
 * This program is free software: you can redistribute it and/or modify
jaroslav@273
     6
 * it under the terms of the GNU General Public License as published by
jaroslav@273
     7
 * the Free Software Foundation, version 2 of the License.
jaroslav@273
     8
 *
jaroslav@273
     9
 * This program is distributed in the hope that it will be useful,
jaroslav@273
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
jaroslav@273
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
jaroslav@273
    12
 * GNU General Public License for more details.
jaroslav@273
    13
 *
jaroslav@273
    14
 * You should have received a copy of the GNU General Public License
jaroslav@273
    15
 * along with this program. Look for COPYING file in the top folder.
jaroslav@273
    16
 * If not, see http://opensource.org/licenses/GPL-2.0.
jaroslav@273
    17
 */
jaroslav@346
    18
package org.apidesign.bck2brwsr.vmtest;
jaroslav@273
    19
jaroslav@346
    20
import java.io.File;
jaroslav@346
    21
import java.io.FileWriter;
jaroslav@346
    22
import java.io.IOException;
jaroslav@273
    23
import java.lang.reflect.Method;
jaroslav@297
    24
import java.util.Map;
jaroslav@297
    25
import java.util.WeakHashMap;
jaroslav@350
    26
import java.util.logging.Level;
jaroslav@350
    27
import java.util.logging.Logger;
jaroslav@273
    28
import javax.script.Invocable;
jaroslav@370
    29
import org.apidesign.bck2brwsr.launcher.MethodInvocation;
jaroslav@273
    30
import org.testng.Assert;
jaroslav@273
    31
import org.testng.ITest;
jaroslav@273
    32
import org.testng.annotations.Factory;
jaroslav@273
    33
import org.testng.annotations.Test;
jaroslav@273
    34
jaroslav@273
    35
/** A TestNG {@link Factory} that seeks for {@link Compare} annotations
jaroslav@273
    36
 * in provided class and builds set of tests that compare the computations
jaroslav@273
    37
 * in real as well as JavaScript virtual machines. Use as:<pre>
jaroslav@273
    38
 * {@code @}{@link Factory} public static create() {
jaroslav@346
    39
 *   return @{link VMTest}.{@link #create(YourClass.class);
jaroslav@273
    40
 * }</pre>
jaroslav@273
    41
 *
jaroslav@273
    42
 * @author Jaroslav Tulach <jtulach@netbeans.org>
jaroslav@273
    43
 */
jaroslav@346
    44
public final class VMTest implements ITest {
jaroslav@356
    45
    private static final Launcher JS = new Launcher("js");
jaroslav@356
    46
    private static final Launcher BROWSER = new Launcher();
jaroslav@356
    47
    
jaroslav@280
    48
    private final Run first, second;
jaroslav@273
    49
    private final Method m;
jaroslav@273
    50
    
jaroslav@346
    51
    private VMTest(Method m, Run first, Run second) {
jaroslav@273
    52
        this.first = first;
jaroslav@273
    53
        this.second = second;
jaroslav@273
    54
        this.m = m;
jaroslav@273
    55
    }
jaroslav@273
    56
jaroslav@346
    57
    /** Inspects <code>clazz</code> and for each {@lik Compare} method creates
jaroslav@347
    58
     * instances of tests. Each instance runs the test in different virtual
jaroslav@346
    59
     * machine and at the end they compare the results.
jaroslav@346
    60
     * 
jaroslav@346
    61
     * @param clazz the class to inspect
jaroslav@346
    62
     * @return the set of created tests
jaroslav@346
    63
     */
jaroslav@273
    64
    public static Object[] create(Class<?> clazz) {
jaroslav@273
    65
        Method[] arr = clazz.getMethods();
jaroslav@349
    66
        Object[] ret = new Object[5 * arr.length];
jaroslav@273
    67
        int cnt = 0;
jaroslav@273
    68
        for (Method m : arr) {
jaroslav@273
    69
            Compare c = m.getAnnotation(Compare.class);
jaroslav@273
    70
            if (c == null) {
jaroslav@273
    71
                continue;
jaroslav@273
    72
            }
jaroslav@349
    73
            final Run real = new Run(m, 0);
jaroslav@349
    74
            final Run js = new Run(m, 1);
jaroslav@349
    75
            final Run brwsr = new Run(m, 2);
jaroslav@273
    76
            ret[cnt++] = real;
jaroslav@273
    77
            ret[cnt++] = js;
jaroslav@349
    78
            ret[cnt++] = brwsr;
jaroslav@346
    79
            ret[cnt++] = new VMTest(m, real, js);
jaroslav@349
    80
            ret[cnt++] = new VMTest(m, real, brwsr);
jaroslav@273
    81
        }
jaroslav@273
    82
        Object[] r = new Object[cnt];
jaroslav@273
    83
        for (int i = 0; i < cnt; i++) {
jaroslav@273
    84
            r[i] = ret[i];
jaroslav@273
    85
        }
jaroslav@273
    86
        return r;
jaroslav@273
    87
    }
jaroslav@346
    88
jaroslav@346
    89
    /** Test that compares the previous results.
jaroslav@346
    90
     * @throws Throwable 
jaroslav@346
    91
     */
jaroslav@280
    92
    @Test(dependsOnGroups = "run") public void compareResults() throws Throwable {
jaroslav@280
    93
        Object v1 = first.value;
jaroslav@280
    94
        Object v2 = second.value;
jaroslav@356
    95
        if (v1 != null) {
jaroslav@356
    96
            v1 = v1.toString();
jaroslav@356
    97
        } else {
jaroslav@356
    98
            v1 = "null";
jaroslav@280
    99
        }
jaroslav@296
   100
        Assert.assertEquals(v2, v1, "Comparing results");
jaroslav@280
   101
    }
jaroslav@280
   102
    
jaroslav@346
   103
    /** Test name.
jaroslav@346
   104
     * @return name of the tested method followed by a suffix
jaroslav@346
   105
     */
jaroslav@280
   106
    @Override
jaroslav@280
   107
    public String getTestName() {
jaroslav@349
   108
        return m.getName() + "[Compare " + second.typeName() + "]";
jaroslav@280
   109
    }
jaroslav@346
   110
jaroslav@280
   111
    public static final class Run implements ITest {
jaroslav@280
   112
        private final Method m;
jaroslav@349
   113
        private final int type;
jaroslav@280
   114
        Object value;
jaroslav@297
   115
        private Invocable code;
jaroslav@297
   116
        private CharSequence codeSeq;
jaroslav@347
   117
        private static final Map<Class,Object[]> compiled = new WeakHashMap<>();
jaroslav@350
   118
        private Object inst;
jaroslav@280
   119
jaroslav@349
   120
        private Run(Method m, int type) {
jaroslav@280
   121
            this.m = m;
jaroslav@349
   122
            this.type = type;
jaroslav@350
   123
            try {
jaroslav@350
   124
                initialize();
jaroslav@350
   125
            } catch (Throwable ex) {
jaroslav@350
   126
                Logger.getLogger(VMTest.class.getName()).log(Level.SEVERE, null, ex);
jaroslav@350
   127
            }
jaroslav@280
   128
        }
jaroslav@280
   129
jaroslav@350
   130
        private void initialize() throws Throwable {
jaroslav@350
   131
            if (type == 1) {
jaroslav@356
   132
                inst = JS.addMethod(m.getDeclaringClass(), m.getName());
jaroslav@356
   133
            }
jaroslav@356
   134
            if (type == 2) {
jaroslav@356
   135
                inst = BROWSER.addMethod(m.getDeclaringClass(), m.getName());
jaroslav@350
   136
            }
jaroslav@350
   137
        }
jaroslav@280
   138
jaroslav@280
   139
        @Test(groups = "run") public void executeCode() throws Throwable {
jaroslav@349
   140
            if (type == 1) {
jaroslav@370
   141
                MethodInvocation c = (MethodInvocation) inst;
jaroslav@356
   142
                JS.exec();
jaroslav@356
   143
                value = c.toString();
jaroslav@349
   144
            } else if (type == 2) {
jaroslav@370
   145
                MethodInvocation c = (MethodInvocation) inst;
jaroslav@356
   146
                BROWSER.exec();
jaroslav@349
   147
                value = c.toString();
jaroslav@273
   148
            } else {
jaroslav@273
   149
                value = m.invoke(m.getDeclaringClass().newInstance());
jaroslav@273
   150
            }
jaroslav@273
   151
        }
jaroslav@280
   152
        @Override
jaroslav@280
   153
        public String getTestName() {
jaroslav@349
   154
            return m.getName() + "[" + typeName() + "]";
jaroslav@349
   155
        }
jaroslav@349
   156
        
jaroslav@349
   157
        final String typeName() {
jaroslav@349
   158
            switch (type) {
jaroslav@349
   159
                case 0: return "Java";
jaroslav@349
   160
                case 1: return "JavaScript";
jaroslav@349
   161
                case 2: return "Browser";
jaroslav@349
   162
                default: return "Unknown type " + type;
jaroslav@349
   163
            }
jaroslav@273
   164
        }
jaroslav@296
   165
        
jaroslav@296
   166
        private static String computeSignature(Method m) {
jaroslav@296
   167
            StringBuilder sb = new StringBuilder();
jaroslav@296
   168
            appendType(sb, m.getReturnType());
jaroslav@296
   169
            for (Class<?> c : m.getParameterTypes()) {
jaroslav@296
   170
                appendType(sb, c);
jaroslav@296
   171
            }
jaroslav@296
   172
            return sb.toString();
jaroslav@296
   173
        }
jaroslav@296
   174
        
jaroslav@296
   175
        private static void appendType(StringBuilder sb, Class<?> t) {
jaroslav@296
   176
            if (t == null) {
jaroslav@296
   177
                sb.append('V');
jaroslav@296
   178
                return;
jaroslav@296
   179
            }
jaroslav@296
   180
            if (t.isPrimitive()) {
jaroslav@296
   181
                int ch = -1;
jaroslav@296
   182
                if (t == int.class) {
jaroslav@296
   183
                    ch = 'I';
jaroslav@296
   184
                }
jaroslav@296
   185
                if (t == short.class) {
jaroslav@296
   186
                    ch = 'S';
jaroslav@296
   187
                }
jaroslav@296
   188
                if (t == byte.class) {
jaroslav@296
   189
                    ch = 'B';
jaroslav@296
   190
                }
jaroslav@296
   191
                if (t == boolean.class) {
jaroslav@296
   192
                    ch = 'Z';
jaroslav@296
   193
                }
jaroslav@296
   194
                if (t == long.class) {
jaroslav@296
   195
                    ch = 'J';
jaroslav@296
   196
                }
jaroslav@296
   197
                if (t == float.class) {
jaroslav@296
   198
                    ch = 'F';
jaroslav@296
   199
                }
jaroslav@296
   200
                if (t == double.class) {
jaroslav@296
   201
                    ch = 'D';
jaroslav@296
   202
                }
jaroslav@296
   203
                assert ch != -1 : "Unknown primitive type " + t;
jaroslav@296
   204
                sb.append((char)ch);
jaroslav@296
   205
                return;
jaroslav@296
   206
            }
jaroslav@296
   207
            if (t.isArray()) {
jaroslav@296
   208
                sb.append("_3");
jaroslav@296
   209
                appendType(sb, t.getComponentType());
jaroslav@296
   210
                return;
jaroslav@296
   211
            }
jaroslav@296
   212
            sb.append('L');
jaroslav@296
   213
            sb.append(t.getName().replace('.', '_'));
jaroslav@296
   214
            sb.append("_2");
jaroslav@296
   215
        }
jaroslav@273
   216
    }
jaroslav@346
   217
    
jaroslav@346
   218
    static StringBuilder dumpJS(CharSequence sb) throws IOException {
jaroslav@346
   219
        File f = File.createTempFile("execution", ".js");
jaroslav@347
   220
        try (FileWriter w = new FileWriter(f)) {
jaroslav@347
   221
            w.append(sb);
jaroslav@347
   222
        }
jaroslav@346
   223
        return new StringBuilder(f.getPath());
jaroslav@346
   224
    }
jaroslav@273
   225
}