| /* |
| * 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 org.apache.zookeeper.util.ServiceUtils; |
| 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); |
| |
| static { |
| // Disable System.exit in tests. |
| ServiceUtils.setSystemExitProcedure(ServiceUtils.LOG_ONLY); |
| } |
| |
| private String testName; |
| |
| protected String getTestName() { |
| return testName; |
| } |
| |
| @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"); |
| // 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 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); |
| } |
| |
| } |