BlockingTest.java

/*
 * Copyright (c) 2008-2013, Matthias Mann
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Matthias Mann nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package nginx.clojure;

import java.io.IOException;
import java.io.InputStream;
import java.util.HashSet;
import java.util.Locale;
import java.util.concurrent.locks.Lock;

import junit.framework.TestCase;
import nginx.clojure.asm.ClassReader;
import nginx.clojure.asm.ClassWriter;
import nginx.clojure.logger.TinyLogService;
import nginx.clojure.wave.AlreadyInstrumented;
import nginx.clojure.wave.InstrumentClass;
import nginx.clojure.wave.MethodDatabase;
import nginx.clojure.wave.MethodDatabaseUtil;

import org.junit.Test;

/**
 * Test to checking blocking call detection
 * 
 * @author Matthias Mann
 */
@AlreadyInstrumented
public class BlockingTest extends TestCase {

    @Test
    public void testSuspend() throws IOException {
        final String className = BlockingTest.class.getName().replace('.', '/');
        final HashSet<String> msgs = new HashSet<String>();
        msgs.add("Method "+className+"#t_wait()V contains potentially blocking call to java/lang/Object#wait()V");
        msgs.add("Method "+className+"#t_sleep1()V contains potentially blocking call to java/lang/Thread#sleep(J)V");
        msgs.add("Method "+className+"#t_sleep2()V contains potentially blocking call to java/lang/Thread#sleep(JI)V");
        msgs.add("Method "+className+"#t_join1(Ljava/lang/Thread;)V contains potentially blocking call to java/lang/Thread#join()V");
        msgs.add("Method "+className+"#t_join2(Ljava/lang/Thread;)V contains potentially blocking call to java/lang/Thread#join(J)V");
        msgs.add("Method "+className+"#t_join3(Ljava/lang/Thread;)V contains potentially blocking call to java/lang/Thread#join(JI)V");
        msgs.add("Method "+className+"#t_lock1(Ljava/util/concurrent/locks/Lock;)V contains potentially blocking call to java/util/concurrent/locks/Lock#lock()V");
        msgs.add("Method "+className+"#t_lock2(Ljava/util/concurrent/locks/Lock;)V contains potentially blocking call to java/util/concurrent/locks/Lock#lockInterruptibly()V");
        
        MethodDatabase db = new MethodDatabase(BlockingTest.class.getClassLoader());
        MethodDatabaseUtil.load(db, "nginx/clojure/wave/coroutine-method-db.txt");
        db.setAllowBlocking(true);
        db.setLog(new TinyLogService() {
        	@Override
        	public void warn(String message, Object ...args) {
        		message = String.format(Locale.ENGLISH, message, args);
                assertTrue("Unexpected message: " + message, msgs.remove(message));
        	}
        });
        
        InputStream in = BlockingTest.class.getResourceAsStream("BlockingTest.class");
        try {
            ClassReader r = new ClassReader(in);
            ClassWriter cw = new ClassWriter(0);
            InstrumentClass ic = new InstrumentClass(r.getClassName(), MethodDatabaseUtil.buildClassEntryFamily(db, r), cw, db, true);
            r.accept(ic, ClassReader.SKIP_FRAMES);
        } finally {
            in.close();
        }
        
        assertTrue("Expected messages not generated: "+msgs.toString(), msgs.isEmpty());
    }
    
    public void t_wait() throws SuspendExecution, InterruptedException {
        synchronized (this) {
            wait();
        }
    }
    
    public void t_notify() throws SuspendExecution {
        synchronized (this) {
            notify();
        }
    }

    public void t_sleep1() throws SuspendExecution, InterruptedException {
        Thread.sleep(1000);
    }

    public void t_sleep2() throws SuspendExecution, InterruptedException {
        Thread.sleep(1000, 100);
    }

    public void t_join1(Thread t) throws SuspendExecution, InterruptedException {
        t.join();
    }

    public void t_join2(Thread t) throws SuspendExecution, InterruptedException {
        t.join(1000);
    }

    public void t_join3(Thread t) throws SuspendExecution, InterruptedException {
        t.join(1, 100);
    }

    public void t_lock1(Lock lock) throws SuspendExecution {
        lock.lock();
    }
    
    public void t_lock2(Lock lock) throws SuspendExecution, InterruptedException {
        lock.lockInterruptibly();
    }
    
    public void t_lock3() throws SuspendExecution {
        lock();
    }

    public void lock() {
        System.out.println("Just a method which have similar signature");
    }
}