vmtest/src/main/java/org/apidesign/bck2brwsr/vmtest/VMTest.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Thu, 20 Dec 2012 11:03:34 +0100
branchlauncher
changeset 356 e078953818d2
parent 350 12debda84e3c
child 360 86f3ea771e24
permissions -rw-r--r--
Using the Console for invoking VMTests in Rhino. All tests are passing now.
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@346
    23
import java.io.InputStream;
jaroslav@273
    24
import java.lang.reflect.Method;
jaroslav@346
    25
import java.net.URL;
jaroslav@346
    26
import java.util.Enumeration;
jaroslav@297
    27
import java.util.Map;
jaroslav@297
    28
import java.util.WeakHashMap;
jaroslav@350
    29
import java.util.logging.Level;
jaroslav@350
    30
import java.util.logging.Logger;
jaroslav@273
    31
import javax.script.Invocable;
jaroslav@349
    32
import org.apidesign.bck2brwsr.launcher.Bck2BrwsrLauncher;
jaroslav@273
    33
import org.testng.Assert;
jaroslav@273
    34
import org.testng.ITest;
jaroslav@273
    35
import org.testng.annotations.Factory;
jaroslav@273
    36
import org.testng.annotations.Test;
jaroslav@273
    37
jaroslav@273
    38
/** A TestNG {@link Factory} that seeks for {@link Compare} annotations
jaroslav@273
    39
 * in provided class and builds set of tests that compare the computations
jaroslav@273
    40
 * in real as well as JavaScript virtual machines. Use as:<pre>
jaroslav@273
    41
 * {@code @}{@link Factory} public static create() {
jaroslav@346
    42
 *   return @{link VMTest}.{@link #create(YourClass.class);
jaroslav@273
    43
 * }</pre>
jaroslav@273
    44
 *
jaroslav@273
    45
 * @author Jaroslav Tulach <jtulach@netbeans.org>
jaroslav@273
    46
 */
jaroslav@346
    47
public final class VMTest implements ITest {
jaroslav@356
    48
    private static final Launcher JS = new Launcher("js");
jaroslav@356
    49
    private static final Launcher BROWSER = new Launcher();
jaroslav@356
    50
    
jaroslav@280
    51
    private final Run first, second;
jaroslav@273
    52
    private final Method m;
jaroslav@273
    53
    
jaroslav@346
    54
    private VMTest(Method m, Run first, Run second) {
jaroslav@273
    55
        this.first = first;
jaroslav@273
    56
        this.second = second;
jaroslav@273
    57
        this.m = m;
jaroslav@273
    58
    }
jaroslav@273
    59
jaroslav@346
    60
    /** Inspects <code>clazz</code> and for each {@lik Compare} method creates
jaroslav@347
    61
     * instances of tests. Each instance runs the test in different virtual
jaroslav@346
    62
     * machine and at the end they compare the results.
jaroslav@346
    63
     * 
jaroslav@346
    64
     * @param clazz the class to inspect
jaroslav@346
    65
     * @return the set of created tests
jaroslav@346
    66
     */
jaroslav@273
    67
    public static Object[] create(Class<?> clazz) {
jaroslav@273
    68
        Method[] arr = clazz.getMethods();
jaroslav@349
    69
        Object[] ret = new Object[5 * arr.length];
jaroslav@273
    70
        int cnt = 0;
jaroslav@273
    71
        for (Method m : arr) {
jaroslav@273
    72
            Compare c = m.getAnnotation(Compare.class);
jaroslav@273
    73
            if (c == null) {
jaroslav@273
    74
                continue;
jaroslav@273
    75
            }
jaroslav@349
    76
            final Run real = new Run(m, 0);
jaroslav@349
    77
            final Run js = new Run(m, 1);
jaroslav@349
    78
            final Run brwsr = new Run(m, 2);
jaroslav@273
    79
            ret[cnt++] = real;
jaroslav@273
    80
            ret[cnt++] = js;
jaroslav@349
    81
            ret[cnt++] = brwsr;
jaroslav@346
    82
            ret[cnt++] = new VMTest(m, real, js);
jaroslav@349
    83
            ret[cnt++] = new VMTest(m, real, brwsr);
jaroslav@273
    84
        }
jaroslav@273
    85
        Object[] r = new Object[cnt];
jaroslav@273
    86
        for (int i = 0; i < cnt; i++) {
jaroslav@273
    87
            r[i] = ret[i];
jaroslav@273
    88
        }
jaroslav@273
    89
        return r;
jaroslav@273
    90
    }
jaroslav@346
    91
jaroslav@346
    92
    /** Test that compares the previous results.
jaroslav@346
    93
     * @throws Throwable 
jaroslav@346
    94
     */
jaroslav@280
    95
    @Test(dependsOnGroups = "run") public void compareResults() throws Throwable {
jaroslav@280
    96
        Object v1 = first.value;
jaroslav@280
    97
        Object v2 = second.value;
jaroslav@356
    98
        if (v1 != null) {
jaroslav@356
    99
            v1 = v1.toString();
jaroslav@356
   100
        } else {
jaroslav@356
   101
            v1 = "null";
jaroslav@280
   102
        }
jaroslav@296
   103
        Assert.assertEquals(v2, v1, "Comparing results");
jaroslav@280
   104
    }
jaroslav@280
   105
    
jaroslav@346
   106
    /** Test name.
jaroslav@346
   107
     * @return name of the tested method followed by a suffix
jaroslav@346
   108
     */
jaroslav@280
   109
    @Override
jaroslav@280
   110
    public String getTestName() {
jaroslav@349
   111
        return m.getName() + "[Compare " + second.typeName() + "]";
jaroslav@280
   112
    }
jaroslav@346
   113
jaroslav@346
   114
    /** Helper method that inspects the classpath and loads given resource
jaroslav@346
   115
     * (usually a class file). Used while running tests in Rhino.
jaroslav@346
   116
     * 
jaroslav@346
   117
     * @param name resource name to find
jaroslav@346
   118
     * @return the array of bytes in the given resource
jaroslav@346
   119
     * @throws IOException I/O in case something goes wrong
jaroslav@346
   120
     */
jaroslav@346
   121
    public static byte[] read(String name) throws IOException {
jaroslav@346
   122
        URL u = null;
jaroslav@346
   123
        Enumeration<URL> en = VMTest.class.getClassLoader().getResources(name);
jaroslav@346
   124
        while (en.hasMoreElements()) {
jaroslav@346
   125
            u = en.nextElement();
jaroslav@346
   126
        }
jaroslav@346
   127
        if (u == null) {
jaroslav@346
   128
            throw new IOException("Can't find " + name);
jaroslav@346
   129
        }
jaroslav@346
   130
        try (InputStream is = u.openStream()) {
jaroslav@346
   131
            byte[] arr;
jaroslav@346
   132
            arr = new byte[is.available()];
jaroslav@346
   133
            int offset = 0;
jaroslav@346
   134
            while (offset < arr.length) {
jaroslav@346
   135
                int len = is.read(arr, offset, arr.length - offset);
jaroslav@346
   136
                if (len == -1) {
jaroslav@346
   137
                    throw new IOException("Can't read " + name);
jaroslav@346
   138
                }
jaroslav@346
   139
                offset += len;
jaroslav@346
   140
            }
jaroslav@346
   141
            return arr;
jaroslav@346
   142
        }
jaroslav@346
   143
    }
jaroslav@346
   144
   
jaroslav@280
   145
    public static final class Run implements ITest {
jaroslav@280
   146
        private final Method m;
jaroslav@349
   147
        private final int type;
jaroslav@280
   148
        Object value;
jaroslav@297
   149
        private Invocable code;
jaroslav@297
   150
        private CharSequence codeSeq;
jaroslav@347
   151
        private static final Map<Class,Object[]> compiled = new WeakHashMap<>();
jaroslav@350
   152
        private Object inst;
jaroslav@280
   153
jaroslav@349
   154
        private Run(Method m, int type) {
jaroslav@280
   155
            this.m = m;
jaroslav@349
   156
            this.type = type;
jaroslav@350
   157
            try {
jaroslav@350
   158
                initialize();
jaroslav@350
   159
            } catch (Throwable ex) {
jaroslav@350
   160
                Logger.getLogger(VMTest.class.getName()).log(Level.SEVERE, null, ex);
jaroslav@350
   161
            }
jaroslav@280
   162
        }
jaroslav@280
   163
jaroslav@350
   164
        private void initialize() throws Throwable {
jaroslav@350
   165
            if (type == 1) {
jaroslav@356
   166
                inst = JS.addMethod(m.getDeclaringClass(), m.getName());
jaroslav@356
   167
            }
jaroslav@356
   168
            if (type == 2) {
jaroslav@356
   169
                inst = BROWSER.addMethod(m.getDeclaringClass(), m.getName());
jaroslav@350
   170
            }
jaroslav@350
   171
        }
jaroslav@280
   172
jaroslav@280
   173
        @Test(groups = "run") public void executeCode() throws Throwable {
jaroslav@349
   174
            if (type == 1) {
jaroslav@356
   175
                Bck2BrwsrLauncher.MethodInvocation c = (Bck2BrwsrLauncher.MethodInvocation) inst;
jaroslav@356
   176
                JS.exec();
jaroslav@356
   177
                value = c.toString();
jaroslav@349
   178
            } else if (type == 2) {
jaroslav@350
   179
                Bck2BrwsrLauncher.MethodInvocation c = (Bck2BrwsrLauncher.MethodInvocation) inst;
jaroslav@356
   180
                BROWSER.exec();
jaroslav@349
   181
                value = c.toString();
jaroslav@273
   182
            } else {
jaroslav@273
   183
                value = m.invoke(m.getDeclaringClass().newInstance());
jaroslav@273
   184
            }
jaroslav@273
   185
        }
jaroslav@280
   186
        @Override
jaroslav@280
   187
        public String getTestName() {
jaroslav@349
   188
            return m.getName() + "[" + typeName() + "]";
jaroslav@349
   189
        }
jaroslav@349
   190
        
jaroslav@349
   191
        final String typeName() {
jaroslav@349
   192
            switch (type) {
jaroslav@349
   193
                case 0: return "Java";
jaroslav@349
   194
                case 1: return "JavaScript";
jaroslav@349
   195
                case 2: return "Browser";
jaroslav@349
   196
                default: return "Unknown type " + type;
jaroslav@349
   197
            }
jaroslav@273
   198
        }
jaroslav@296
   199
        
jaroslav@296
   200
        private static String computeSignature(Method m) {
jaroslav@296
   201
            StringBuilder sb = new StringBuilder();
jaroslav@296
   202
            appendType(sb, m.getReturnType());
jaroslav@296
   203
            for (Class<?> c : m.getParameterTypes()) {
jaroslav@296
   204
                appendType(sb, c);
jaroslav@296
   205
            }
jaroslav@296
   206
            return sb.toString();
jaroslav@296
   207
        }
jaroslav@296
   208
        
jaroslav@296
   209
        private static void appendType(StringBuilder sb, Class<?> t) {
jaroslav@296
   210
            if (t == null) {
jaroslav@296
   211
                sb.append('V');
jaroslav@296
   212
                return;
jaroslav@296
   213
            }
jaroslav@296
   214
            if (t.isPrimitive()) {
jaroslav@296
   215
                int ch = -1;
jaroslav@296
   216
                if (t == int.class) {
jaroslav@296
   217
                    ch = 'I';
jaroslav@296
   218
                }
jaroslav@296
   219
                if (t == short.class) {
jaroslav@296
   220
                    ch = 'S';
jaroslav@296
   221
                }
jaroslav@296
   222
                if (t == byte.class) {
jaroslav@296
   223
                    ch = 'B';
jaroslav@296
   224
                }
jaroslav@296
   225
                if (t == boolean.class) {
jaroslav@296
   226
                    ch = 'Z';
jaroslav@296
   227
                }
jaroslav@296
   228
                if (t == long.class) {
jaroslav@296
   229
                    ch = 'J';
jaroslav@296
   230
                }
jaroslav@296
   231
                if (t == float.class) {
jaroslav@296
   232
                    ch = 'F';
jaroslav@296
   233
                }
jaroslav@296
   234
                if (t == double.class) {
jaroslav@296
   235
                    ch = 'D';
jaroslav@296
   236
                }
jaroslav@296
   237
                assert ch != -1 : "Unknown primitive type " + t;
jaroslav@296
   238
                sb.append((char)ch);
jaroslav@296
   239
                return;
jaroslav@296
   240
            }
jaroslav@296
   241
            if (t.isArray()) {
jaroslav@296
   242
                sb.append("_3");
jaroslav@296
   243
                appendType(sb, t.getComponentType());
jaroslav@296
   244
                return;
jaroslav@296
   245
            }
jaroslav@296
   246
            sb.append('L');
jaroslav@296
   247
            sb.append(t.getName().replace('.', '_'));
jaroslav@296
   248
            sb.append("_2");
jaroslav@296
   249
        }
jaroslav@273
   250
    }
jaroslav@346
   251
    
jaroslav@346
   252
    static StringBuilder dumpJS(CharSequence sb) throws IOException {
jaroslav@346
   253
        File f = File.createTempFile("execution", ".js");
jaroslav@347
   254
        try (FileWriter w = new FileWriter(f)) {
jaroslav@347
   255
            w.append(sb);
jaroslav@347
   256
        }
jaroslav@346
   257
        return new StringBuilder(f.getPath());
jaroslav@346
   258
    }
jaroslav@273
   259
}