|
| 1 | +/* |
| 2 | + * Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | + * contributor license agreements. See the NOTICE file distributed with |
| 4 | + * this work for additional information regarding copyright ownership. |
| 5 | + * The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | + * (the "License"); you may not use this file except in compliance with |
| 7 | + * the License. You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | +package org.apache.jackrabbit.oak.plugins.document.rdb; |
| 18 | + |
| 19 | +import org.apache.jackrabbit.guava.common.base.Strings; |
| 20 | +import org.apache.jackrabbit.oak.plugins.document.RdbUtils; |
| 21 | +import org.junit.Assume; |
| 22 | +import org.junit.rules.ExternalResource; |
| 23 | +import org.junit.runner.Description; |
| 24 | +import org.junit.runners.model.MultipleFailureException; |
| 25 | +import org.junit.runners.model.Statement; |
| 26 | +import org.slf4j.Logger; |
| 27 | +import org.slf4j.LoggerFactory; |
| 28 | +import org.testcontainers.DockerClientFactory; |
| 29 | +import org.testcontainers.containers.GenericContainer; |
| 30 | +import org.testcontainers.images.RemoteDockerImage; |
| 31 | +import org.testcontainers.utility.DockerImageName; |
| 32 | + |
| 33 | +import java.time.Duration; |
| 34 | +import java.time.Instant; |
| 35 | +import java.util.ArrayList; |
| 36 | +import java.util.List; |
| 37 | +import java.util.concurrent.TimeUnit; |
| 38 | +import java.util.concurrent.TimeoutException; |
| 39 | +import java.util.concurrent.atomic.AtomicReference; |
| 40 | +import java.util.regex.Matcher; |
| 41 | +import java.util.regex.Pattern; |
| 42 | + |
| 43 | + |
| 44 | +/** |
| 45 | + * A MongoDB {@link GenericContainer}. |
| 46 | + */ |
| 47 | +public class RdbDockerRule extends ExternalResource { |
| 48 | + |
| 49 | + private static final Logger LOG = LoggerFactory.getLogger(RdbDockerRule.class); |
| 50 | + |
| 51 | + private static final AtomicReference<Exception> STARTUP_EXCEPTION = new AtomicReference<>(); |
| 52 | + private static final boolean RDB_AVAILABLE; |
| 53 | + private GenericContainer<?> rdbContainer; |
| 54 | + |
| 55 | + private static DockerImageName IMAGE = null; |
| 56 | + private static int exposedPort = getPortFromJdbcURL(RdbUtils.URL); |
| 57 | + |
| 58 | + static { |
| 59 | + if (!Strings.isNullOrEmpty(RdbUtils.IMAGE)) { |
| 60 | + IMAGE = DockerImageName.parse(RdbUtils.IMAGE); |
| 61 | + } |
| 62 | + boolean dockerAvailable = false; |
| 63 | + boolean imageAvailable = false; |
| 64 | + try { |
| 65 | + dockerAvailable = checkDockerAvailability(); |
| 66 | + if (dockerAvailable) { |
| 67 | + imageAvailable = checkImageAvailability(); |
| 68 | + } else { |
| 69 | + LOG.info("docker not available"); |
| 70 | + } |
| 71 | + } catch (Throwable t) { |
| 72 | + LOG.error("not able to pull specified docker image: {}, error: ", RdbUtils.IMAGE, t); |
| 73 | + } |
| 74 | + RDB_AVAILABLE = dockerAvailable && imageAvailable; |
| 75 | + } |
| 76 | + |
| 77 | + @Override |
| 78 | + protected void before() throws Throwable { |
| 79 | + if (!RDB_AVAILABLE || rdbContainer != null && rdbContainer.isRunning()) { |
| 80 | + return; |
| 81 | + } |
| 82 | + rdbContainer = new GenericContainer<>(IMAGE) |
| 83 | + .withExposedPorts(exposedPort) |
| 84 | + .withStartupTimeout(Duration.ofMinutes(5)); |
| 85 | + |
| 86 | + try { |
| 87 | + long startTime = Instant.now().toEpochMilli(); |
| 88 | + rdbContainer.start(); |
| 89 | + LOG.info("RDB container started in: " + (Instant.now().toEpochMilli() - startTime) + " ms"); |
| 90 | + } catch (Exception e) { |
| 91 | + LOG.error("error while starting RDB container, error: ", e); |
| 92 | + STARTUP_EXCEPTION.set(e); |
| 93 | + throw e; |
| 94 | + } |
| 95 | + } |
| 96 | + |
| 97 | + @Override |
| 98 | + public Statement apply(Statement base, Description description) { |
| 99 | + return new Statement() { |
| 100 | + @Override |
| 101 | + public void evaluate() throws Throwable { |
| 102 | + try { |
| 103 | + before(); |
| 104 | + } catch (Throwable e) { |
| 105 | + Assume.assumeNoException(STARTUP_EXCEPTION.get()); |
| 106 | + throw e; |
| 107 | + } |
| 108 | + |
| 109 | + List<Throwable> errors = new ArrayList<>(); |
| 110 | + try { |
| 111 | + base.evaluate(); |
| 112 | + } catch (Throwable t) { |
| 113 | + errors.add(t); |
| 114 | + } |
| 115 | + MultipleFailureException.assertEmpty(errors); |
| 116 | + } |
| 117 | + }; |
| 118 | + } |
| 119 | + |
| 120 | + private static boolean checkImageAvailability() throws TimeoutException { |
| 121 | + if (Strings.isNullOrEmpty(RdbUtils.IMAGE)) { |
| 122 | + return false; |
| 123 | + } |
| 124 | + RemoteDockerImage remoteDockerImage = new RemoteDockerImage(IMAGE); |
| 125 | + remoteDockerImage.get(1, TimeUnit.MINUTES); |
| 126 | + return true; |
| 127 | + } |
| 128 | + |
| 129 | + private static boolean checkDockerAvailability() { |
| 130 | + return DockerClientFactory.instance().isDockerAvailable(); |
| 131 | + } |
| 132 | + |
| 133 | + public static boolean isDockerImageAvailable() { |
| 134 | + return RDB_AVAILABLE; |
| 135 | + } |
| 136 | + |
| 137 | + public int getExposedPort() { |
| 138 | + return exposedPort; |
| 139 | + } |
| 140 | + |
| 141 | + public String getHost() { |
| 142 | + return rdbContainer.getHost(); |
| 143 | + } |
| 144 | + |
| 145 | + public int getMappedPort() { |
| 146 | + return rdbContainer.getMappedPort(exposedPort); |
| 147 | + } |
| 148 | + |
| 149 | + public static int getPortFromJdbcURL(String jdbcURL) { |
| 150 | + String normalizedJdbcUri = jdbcURL.replaceFirst("@//", "//").replaceFirst("@", "//"); |
| 151 | + Pattern pattern = Pattern.compile("//[^:/]+(:(\\d+))?"); |
| 152 | + Matcher matcher = pattern.matcher(normalizedJdbcUri); |
| 153 | + if (matcher.find()) { |
| 154 | + if (matcher.groupCount() > 1) { |
| 155 | + try { |
| 156 | + return Integer.parseInt(matcher.group(2)); |
| 157 | + } catch (NumberFormatException ignored) { |
| 158 | + //should not happen |
| 159 | + } |
| 160 | + } |
| 161 | + } |
| 162 | + return -1; |
| 163 | + } |
| 164 | + |
| 165 | +} |
0 commit comments