org.glassfish.fighterfish.test.util.GlassFishTracker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of test.util Show documentation

This is a small junit extension developed in FighterFish project to make the task of writing test cases using maven/glassfish/junit much easier. It in turn leverages pax-exam test framework.

The newest version!

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2011 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */


package org.glassfish.fighterfish.test.util;

import org.glassfish.embeddable.GlassFish;
import org.glassfish.embeddable.GlassFishException;
import org.osgi.framework.BundleContext;
import org.osgi.util.tracker.ServiceTracker;

/**
 * When GlassFish bundles are deployed, the server does a lot of background operation, so this class help test cases
 * track availability of GlassFish. It provides a convenient mechanism for tests to wait for GlassFish server
 * to start.
 *
 * @author [email protected]
 */
public class GlassFishTracker {

    public static GlassFish waitForGfToStart(BundleContext context, long timeout) throws InterruptedException, GlassFishException {
        ServiceTracker st = new ServiceTracker(context, GlassFish.class.getName(), null);
        st.open();
        GlassFish gf;
        long currentTime = System.currentTimeMillis();
        try {
            gf = (GlassFish) st.waitForService(timeout);
        } finally {
            st.close();
        }
        if (gf == null) {
            throw new TimeoutException("GlassFish service is still not available after " + timeout + " ms.");
        }
        long endTime = currentTime + timeout;
        while (gf.getStatus() != GlassFish.Status.STARTED && System.currentTimeMillis() < endTime) {
            Thread.sleep(100);
        }
        if (gf.getStatus() != GlassFish.Status.STARTED) {
            throw new TimeoutException("GlassFish has not started after " + timeout + " ms.");
        }
        return gf;
    }
}