org.osgi.test.common.annotation.InjectBundleContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.osgi.test.junit4 Show documentation

OSGi Testing JUnit 4 Support

The newest version!

/*******************************************************************************
 * Copyright (c) Contributors to the Eclipse Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 *******************************************************************************/

package org.osgi.test.common.annotation;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import org.osgi.framework.BundleContext;

/**
 * Inject {@link BundleContext} into test classes and methods.
 * 
 * The {@link BundleContext} implementation provided by this rule will
 * automatically clean up all service registrations, bundle, service and
 * framework listeners, as well as installed bundles left behind.
 * 

 * Example:
 *
 * 
 * // For JUnit5
 * @ExtendWith(BundleContextExtension.class)
 * class MyTests {
 * 	// For JUnit4
 * 	@Rule
 * 	BundleContextRule bcr = new BundleContextRule();
 *
 * 	@InjectBundleContext
 * 	BundleContext bundleContext;
 *
 * 	@Test
 * 	public void test() {
 * 		// use bundleContext
 * 	}
 * }
 * 
 */
@Inherited
@Target({
	FIELD, PARAMETER
})
@Retention(RUNTIME)
@Documented
public @interface InjectBundleContext {}