org.apache.jackrabbit.mk.test.MicroKernelFixture Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oak-it-mk Show documentation
There is a newer version: 1.2.20
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.jackrabbit.mk.test;

import org.apache.jackrabbit.mk.api.MicroKernel;

/**
 * Interface through which different {@link MicroKernel} implementations
 * make themselves available for use by this integration test suite.
 */
public interface MicroKernelFixture {

    /**
     * Checks whether this fixture is currently available. For example
     * a database-based fixture would only be available when the underlying
     * database service is running.
     *
     * @return true iff the fixture is available
     */
    boolean isAvailable();

    /**
     * Creates a new {@link MicroKernel} cluster with as many nodes as the
     * given array has elements. References to the cluster nodes are stored
     * in the given array. The initial state of the cluster consists of just
     * an empty root node and a shared journal with only a single root
     * revision. The caller of this method should have exclusive access to
     * the created cluster. The caller is also responsible for calling
     * {@link #tearDownCluster(MicroKernel[])} when the test cluster is
     * no longer needed.
     *
     * @param cluster array to which references to all nodes of the
     *                created cluster should be stored
     * @throws Exception if the cluster could not be set up
     */
    void setUpCluster(MicroKernel[] cluster) throws Exception;

    /**
     * Ensures that all content changes seen by one of the given cluster
     * nodes are seen also by all the other given nodes. Used to help
     * testing features like eventual consistency where the standard
     * {@link MicroKernel} API doesn't make strong enough guarantees to
     * enable writing a test case without a potentially unbounded wait for
     * changes to propagate across the cluster.
     *
     * @param nodes cluster nodes to be synchronized
     */
    void syncMicroKernelCluster(MicroKernel... nodes);

    /**
     * Releases resources associated with the given {@link MicroKernel}
     * cluster. The caller of {@link #setUpCluster(MicroKernel[])} shall
     * call this method once the cluster is no longer needed.
     *
     * @param cluster array containing references to all nodes of the cluster
     */
    void tearDownCluster(MicroKernel[] cluster);

}