/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2015 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
 * http://glassfish.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.jersey.internal.inject;

import static org.junit.Assert.assertTrue;

import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

import javax.inject.Inject;

import org.glassfish.hk2.api.Immediate;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.hk2.utilities.binding.AbstractBinder;

import org.junit.Ignore;
import org.junit.Test;

/**
 * Test for the {@link Injections} class.
 *
 * @author Jord Sonneveld (jord@moz.com)
 *
 */
public class InjectionsTest {

    /**
     * Verify that services marked with the HK2 Immediate annotation are indeed
     * created "immediately" (or at least "soon").
     *
     * Because Immediate services are instantiated in a separate thread, we use
     * a {@link CountDownLatch} to wait for the service to be created.
     *
     * After the {@link ServiceLocator} is created, we specifically do not call
     * any more methods on it: the locator must instantiate the Immediate
     * service without any further prompting to the locator.
     *
     * @throws InterruptedException if awaiting on the latch is interrupted.
     */
    @Test
    @Ignore("HK2 Immediate Scope is now disabled due to a memory leak issues with ImmediateThread (see JERSEY-2979) and some "
            + "other problems which aren't publicly reported.")
    public void testHK2ImmediateAnnotation() throws InterruptedException {
        final CountDownLatch latch = new CountDownLatch(1);

        @SuppressWarnings("unused") // It is unused by design
        ServiceLocator sl = Injections.createLocator(new AbstractBinder() {
            @Override
            protected void configure() {
                bind(latch).to(CountDownLatch.class);
                bind(ImmediateMe.class).to(ImmediateMe.class).in(
                        Immediate.class);
            }
        });

        // 10 seconds is a LONG time. It should be faster than that. However, 10
        // seconds gives us a reasonable upper limit to wait in case the test
        // fails.
        assertTrue("Latch should be unlocked within 10 seconds.",
                latch.await(10, TimeUnit.SECONDS));
    }

    /**
     * Helper class for testing Immediate services.
     *
     */
    public static final class ImmediateMe {
        @Inject
        public ImmediateMe(CountDownLatch latch) {
            latch.countDown();
        }
    }

}
