Back to Repositories

Validating OSGi Bundle Integration in HikariCP

This test suite validates the OSGi bundle functionality of HikariCP, ensuring proper bundle deployment and context injection in an OSGi environment. The tests verify bundle activation states and dependency management within the OSGi framework.

Test Coverage Overview

The test suite provides comprehensive coverage of OSGi-specific functionality for HikariCP:

Bundle activation state verification
Context injection validation
Bundle symbolic name checking
Java version compatibility testing

The tests specifically target OSGi integration points and bundle lifecycle management.

Implementation Analysis

The testing approach utilizes PAX Exam framework for OSGi testing, implementing conditional test execution based on Java version compatibility. The suite employs JUnit integration with PAX Exam through custom runner implementation and leverages Maven bundle configuration for dependency management.

Key patterns include conditional test execution, bundle state verification, and context injection validation.

Technical Details

Testing tools and configuration:

PAX Exam framework for OSGi testing
JUnit test runner customization
Maven bundle configuration
SLF4J for logging (1.7.36)
System property configuration for OSGi framework

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Conditional test execution based on environment
Clean separation of concerns in test configuration
Proper bundle dependency management
Systematic state verification
Clear test organization and structure

brettwooldridge/hikaricp

src/test/java/com/zaxxer/hikari/osgi/OSGiBundleTest.java

            
/*
 * Copyright (C) 2013 Brett Wooldridge
 *
 * 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.
 */
package com.zaxxer.hikari.osgi;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runner.manipulation.Filter;
import org.junit.runner.manipulation.NoTestsRemainException;
import org.junit.runner.notification.RunNotifier;
import org.junit.runners.model.InitializationError;
import org.ops4j.pax.exam.Configuration;
import org.ops4j.pax.exam.Option;
import org.ops4j.pax.exam.junit.PaxExam;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;

import javax.inject.Inject;
import java.io.File;

import static com.zaxxer.hikari.pool.TestElf.isJava11;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.ops4j.pax.exam.CoreOptions.*;

/**
 * @author lburgazzoli
 */
@RunWith(OSGiBundleTest.ConditionalPaxExam.class)
public class OSGiBundleTest
{
   @Test
   public void checkInject()
   {
      assertNotNull(context);
   }

   @Test
   public void checkBundle()
   {
      Boolean bundleFound = false;
      Boolean bundleActive = false;

      Bundle[] bundles = context.getBundles();
      for (Bundle bundle : bundles) {
         if (bundle != null) {
            if (bundle.getSymbolicName().equals("com.zaxxer.HikariCP")) {
               bundleFound = true;
               if (bundle.getState() == Bundle.ACTIVE) {
                  bundleActive = true;
               }
            }
         }
      }

      assertTrue(bundleFound);
      assertTrue(bundleActive);
   }

   @Inject
   BundleContext context;

   @Configuration
   public Option[] config()
   {
      return options(
         systemProperty("org.osgi.framework.storage.clean").value("true"),
         systemProperty("org.ops4j.pax.logging.DefaultServiceLog.level").value("WARN"),
         mavenBundle("org.slf4j", "slf4j-api", "1.7.36"),
         mavenBundle("org.slf4j", "slf4j-simple", "1.7.36").noStart(),
         new File("target/classes").exists()
            ? bundle("reference:file:target/classes")
            : bundle("reference:file:../target/classes"),
         junitBundles(),
         cleanCaches()
      );
   }

   public static class ConditionalPaxExam extends PaxExam
   {
      public ConditionalPaxExam(Class<?> klass) throws InitializationError {
         super(klass);
      }

      @Override
      public void run(RunNotifier notifier) {
         if (!isJava11()) {
            super.run(notifier);
         }
      }

      @Override
      public void filter(Filter filter) throws NoTestsRemainException {
         if (isJava11()) {
            throw new NoTestsRemainException();
         }

         super.filter(filter);
      }
   }
}