zookeeper-server/src/test/java/org/apache/zookeeper/ZKTestCase.java

/*
 * 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.zookeeper;

import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import java.io.File;
import java.time.Instant;
import java.util.concurrent.CompletableFuture;
import org.apache.zookeeper.metrics.MetricsUtils;
import org.apache.zookeeper.util.ServiceUtils;
import org.hamcrest.CustomMatcher;
import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.StringDescription;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.TestInfo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Base class for a non-parameterized ZK test.
 *
 * Basic utilities shared by all tests. Also logging of various events during
 * the test execution (start/stop/success/failure/etc...)
 */
public class ZKTestCase {

    protected static final File testBaseDir = new File(System.getProperty("build.test.dir", "build"));
    private static final Logger LOG = LoggerFactory.getLogger(ZKTestCase.class);
    public static final int DEFAULT_METRIC_TIMEOUT = 30;

    static {
        // Disable System.exit in tests.
        ServiceUtils.setSystemExitProcedure(ServiceUtils.LOG_ONLY);
    }

    private String testName;

    protected String getTestName() {
        return testName;
    }

    public void syncClient(ZooKeeper zk, boolean synchronous) throws KeeperException {
        if (synchronous) {
            try {
                zk.sync("/");
            } catch (InterruptedException ex) {
                throw new RuntimeException(ex);
            }
            return;
        }
        final CompletableFuture<KeeperException.Code> synced = new CompletableFuture<>();
        zk.sync("/", (rc, path, ctx) -> {
            synced.complete(KeeperException.Code.get(rc));
        }, null);
        KeeperException.Code code = synced.join();
        if (code != KeeperException.Code.OK) {
            throw KeeperException.create(code);
        }
    }

    @BeforeAll
    public static void before() {
        if (!testBaseDir.exists()) {
            assertTrue(testBaseDir.mkdirs(),
                "Cannot properly create test base directory " + testBaseDir.getAbsolutePath());
        } else if (!testBaseDir.isDirectory()) {
            assertTrue(testBaseDir.delete(),
                "Cannot properly delete file with duplicate name of test base directory " + testBaseDir.getAbsolutePath());
            assertTrue(testBaseDir.mkdirs(),
                "Cannot properly create test base directory " + testBaseDir.getAbsolutePath());
        }
    }

    @BeforeEach
    public void starting(TestInfo testInfo) {
        // By default, disable starting a JettyAdminServer in tests to avoid
        // accidentally attempting to start multiple admin servers on the
        // same port.
        System.setProperty("zookeeper.admin.enableServer", "false");

        // disable rate limiting
        System.setProperty("zookeeper.admin.rateLimiterIntervalInMS", "0");

        // ZOOKEEPER-2693 disables all 4lw by default.
        // Here we enable the 4lw which ZooKeeper tests depends.
        System.setProperty("zookeeper.4lw.commands.whitelist", "*");
        LOG.info("STARTING {}", testInfo.getTestMethod());
    }

    @AfterEach
    public void finished(TestInfo testInfo) {
        LOG.info("FINISHED {}", testInfo.getTestMethod());
    }

    public interface WaitForCondition {

        /**
         * @return true when success
         */
        boolean evaluate();

    }

    /**
     * Wait for condition to be true; otherwise fail the test if it exceed
     * timeout
     * @param msg       error message to print when fail
     * @param condition condition to evaluate
     * @param timeout   timeout in seconds
     * @throws InterruptedException
     */
    public static void waitFor(String msg, WaitForCondition condition, int timeout) throws InterruptedException {
        final Instant deadline = Instant.now().plusSeconds(timeout);
        while (Instant.now().isBefore(deadline)) {
            if (condition.evaluate()) {
                return;
            }
            Thread.sleep(100);
        }
        fail(msg);
    }

    public static <T> void waitForMetric(String metricKey, Matcher<T> matcher) throws InterruptedException {
        waitForMetric(metricKey, matcher, DEFAULT_METRIC_TIMEOUT);
    }

    public static <T> void waitForMetric(String metricKey, Matcher<T> matcher, int timeoutInSeconds) throws InterruptedException {
        String errorMessage = String.format("metric \"%s\" failed to match after %d seconds",
            metricKey, timeoutInSeconds);
        waitFor(errorMessage, () -> {
            @SuppressWarnings("unchecked")
            T actual = (T) MetricsUtils.currentServerMetrics().get(metricKey);
            if (!matcher.matches(actual)) {
                Description description = new StringDescription();
                matcher.describeMismatch(actual, description);
                LOG.info("match failed for metric {}: {}", metricKey, description);
                return false;
            }
            return true;
        }, timeoutInSeconds);
    }

    /**
     * Functionally identical to {@link org.hamcrest.Matchers#closeTo} except that it accepts all numerical types
     * instead of failing if the value is not a {@link Double}.
     */
    public static Matcher<Number> closeTo(double operand, double error) {
        return new CustomMatcher<Number>(String.format("A number within %s of %s", error, operand)) {
            @Override
            public boolean matches(Object actual) {
                return Math.abs(operand - ((Number) actual).doubleValue()) <= error;
            }
        };
    }
}