Skip to content

Added support for creating tarantool container from sdk #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ubuntu-master.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,5 @@ jobs:
env:
TARANTOOL_SERVER_USER: root
TARANTOOL_SERVER_GROUP: root
URI: ${{ secrets.URI }}
run: mvn -B verify --file pom.xml
7 changes: 6 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.6.2</version>
<version>5.7.0</version>
<scope>test</scope>
</dependency>
<dependency>
Expand All @@ -91,6 +91,11 @@
<version>1.2.3</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.github.docker-java</groupId>
<artifactId>docker-java</artifactId>
<version>3.2.13</version>
</dependency>
</dependencies>

<build>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ public TarantoolContainer(String dockerImageName) {
clientHelper = new TarantoolContainerClientHelper(this);
}

public TarantoolContainer(TarantoolImageParams tarantoolImageParams) {
super(TarantoolContainerImageHelper.getImage(tarantoolImageParams));
clientHelper = new TarantoolContainerClientHelper(this);
}

public TarantoolContainer(Future<String> image) {
super(image);
clientHelper = new TarantoolContainerClientHelper(this);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
package org.testcontainers.containers;

import com.github.dockerjava.api.DockerClient;
import com.github.dockerjava.api.command.BuildImageResultCallback;
import com.github.dockerjava.api.model.Image;
import com.github.dockerjava.core.DockerClientBuilder;
import org.apache.commons.lang3.StringUtils;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;

/**
* Class for working with docker directly
*
* @author Oleg Kuznetsov
*/
class TarantoolContainerImageHelper {

private static final DockerClient dockerClient = DockerClientBuilder.getInstance().build();

private TarantoolContainerImageHelper() {
}

/**
* Checks image for existing by name and build if it not exist
*
* @param imageParams parameters for building tarantool image
* @return image name
*/
static String getImage(TarantoolImageParams imageParams) {
final String sdkVersion = imageParams.getSdkVersion();

if (StringUtils.isEmpty(sdkVersion)) {
throw new IllegalArgumentException("SDK version is null or empty!");
}

if (!hasImage(sdkVersion)) {
buildImage(imageParams);
}

return sdkVersion;
}

/**
* Builds image from parameters
*
* @param imageParams parameters for building tarantool image
*/
private static void buildImage(TarantoolImageParams imageParams) {
final String sdkVersion = imageParams.getSdkVersion();
final String uri = System.getenv("URI");

if (StringUtils.isEmpty(uri)) {
throw new IllegalStateException("URI environment variable must be specified!");
}

dockerClient.buildImageCmd(imageParams.getDockerfile())
.withTags(new HashSet<>(Collections.singletonList(sdkVersion)))
.withBuildArg("SDK_VERSION", sdkVersion)
.withBuildArg("URI", uri)
.exec(new BuildImageResultCallback())
.awaitImageId();
}

/**
* Checks image for existing by name
*
* @param imageName image name for searching
* @return true if image exist and false if not
*/
private static boolean hasImage(String imageName) {
final List<Image> images = dockerClient.listImagesCmd().exec();
return images.stream()
.map(Image::getRepoTags)
.map(Arrays::asList)
.flatMap(Collection::stream)
.anyMatch(tag -> tag.equals(imageName + ":latest"));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
package org.testcontainers.containers;

import java.io.File;
import java.net.URISyntaxException;

/**
* Tarantool image parameters holder
*
* @author Oleg Kuznetsov
*/
public class TarantoolImageParams {

private final String sdkVersion;
private final File dockerfile;

/**
* Basic constructor for tarantool image parameters
*
* @param sdkVersion version of tarantool sdk which will be downloaded from specified in env variables URI,
* for example: tarantool-enterprise-bundle-2.8.3-21-g7d35cd2be-r470
*/
public TarantoolImageParams(String sdkVersion) {
this.sdkVersion = sdkVersion;
try {
this.dockerfile = new File(TarantoolImageParams.class.getClassLoader()
.getResource("sdk/Dockerfile").toURI());
} catch (URISyntaxException e) {
throw new IllegalStateException("Can't access to Dockerfile for testcontainers");
}
}

/**
* Custom constructor for tarantool image parameters
*
* @param sdkVersion version of tarantool sdk which will be downloaded from specified in env variables URI,
* for example: tarantool-enterprise-bundle-2.8.3-21-g7d35cd2be-r470
* @param dockerfile dockerfile for building custom tarantool image
*/
public TarantoolImageParams(String sdkVersion, File dockerfile) {
this.sdkVersion = sdkVersion;
this.dockerfile = dockerfile;
}

/**
* Getter for sdk version
*
* @return sdk version
*/
public String getSdkVersion() {
return sdkVersion;
}

/**
* Getter for dockerfile
*
* @return dockerfile
*/
public File getDockerfile() {
return dockerfile;
}
}
25 changes: 25 additions & 0 deletions src/main/resources/sdk/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
FROM centos:7

ARG TARANTOOL_WORKDIR="/app"
ARG TARANTOOL_RUNDIR="/tmp/run"
ARG TARANTOOL_DATADIR="/tmp/data"
ARG SDK_TGT_DIR="/sdk"
ARG URI=""
ARG SDK_VERSION=""
ARG SDK_TGZ=$SDK_VERSION.tar.gz

ENV URI=$URI
ENV SDK_VERSION=$SDK_VERSION
ENV SDK_TGT_DIR=$SDK_TGT_DIR
ENV TARANTOOL_WORKDIR=$TARANTOOL_WORKDIR
ENV TARANTOOL_RUNDIR=$TARANTOOL_RUNDIR
ENV TARANTOOL_DATADIR=$TARANTOOL_DATADIR

RUN curl https://curl.se/ca/cacert.pem -o /etc/pki/tls/certs/ca-bundle.crt && \
yum -y install wget && \
wget $URI/$SDK_TGZ && \
mkdir ./tmp_sdk && tar -xf $SDK_TGZ -C ./tmp_sdk && \
mv ./tmp_sdk/tarantool-enterprise $SDK_TGT_DIR && rm $SDK_TGZ && \
cp $SDK_TGT_DIR/tarantool /usr/bin/tarantool

WORKDIR $TARANTOOL_WORKDIR
4 changes: 2 additions & 2 deletions src/main/resources/server.lua
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ box.cfg {
log_level = 6,
}
-- API user will be able to login with this password
box.schema.user.create('api_user', { password = 'secret' })
box.schema.user.create('api_user', { password = 'secret', if_not_exists = true })
-- API user will be able to create spaces, add or remove data, execute functions
box.schema.user.grant('api_user', 'read,write,execute', 'universe')
box.schema.user.grant('api_user', 'read,write,execute', 'universe', nil, { if_not_exists = true })
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import org.junit.jupiter.api.Test;
import org.slf4j.LoggerFactory;
import org.testcontainers.containers.output.Slf4jLogConsumer;
import org.testcontainers.containers.wait.strategy.Wait;
import org.testcontainers.utility.MountableFile;

import java.time.Duration;
Expand Down Expand Up @@ -36,7 +35,7 @@ public void test_ClusterContainer_StartsSuccessfully_ifFilesAreCopiedUnderRoot()

container.start();
CartridgeContainerTestUtils.executeProfileReplaceSmokeTest(container);
if(container.isRunning())
if (container.isRunning())
container.stop();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public class TarantoolCartridgeStaticContainerTest {
LoggerFactory.getLogger(TarantoolCartridgeStaticContainerTest.class)));

@Test
public void test_StaticClusterContainer_StartsSuccessfully_ifDirectoryBinndingIsUsed() throws Exception {
public void test_StaticClusterContainer_StartsSuccessfully_ifDirectoryBindingIsUsed() throws Exception {
CartridgeContainerTestUtils.executeProfileReplaceSmokeTest(container);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package org.testcontainers.containers;


import io.tarantool.driver.TarantoolVersion;
import io.tarantool.driver.api.TarantoolClient;
import io.tarantool.driver.api.TarantoolClientFactory;
import io.tarantool.driver.api.TarantoolResult;
import io.tarantool.driver.api.tuple.TarantoolTuple;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

import java.io.File;
import java.net.URISyntaxException;
import java.util.List;

/**
* @author Oleg Kuznetsov
*/
public class TarantoolSdkContainerTest {

@Test
void test_should_createTarantoolContainerFromSdk() {
try (final TarantoolContainer tarantoolContainer = new TarantoolContainer(
new TarantoolImageParams("tarantool-enterprise-bundle-2.8.3-21-g7d35cd2be-r470")
)) {
tarantoolContainer.start();

final TarantoolClient<TarantoolTuple, TarantoolResult<TarantoolTuple>> client =
TarantoolClientFactory.createClient()
.withCredentials("api_user", "secret")
.withAddress(tarantoolContainer.getHost(), tarantoolContainer.getMappedPort(3301))
.build();

final List<?> result = client.eval("return 'test'").join();
final TarantoolVersion version = client.getVersion();

Assertions.assertEquals("test", result.get(0));
Assertions.assertTrue(version.toString().startsWith("Tarantool 2.8.3 (Binary)"));
}
}

@Test
void test_should_createTarantoolContainerFromSdk_ifDockerfileSpecified() throws URISyntaxException {
final File dockerfile = new File(
TarantoolSdkContainerTest.class.getClassLoader().getResource("testsdk/Dockerfile").toURI()
);

try (final TarantoolContainer tarantoolContainer = new TarantoolContainer(
new TarantoolImageParams("testsdk", dockerfile))
.withDirectoryBinding("testsdk")) {

tarantoolContainer.start();

final TarantoolClient<TarantoolTuple, TarantoolResult<TarantoolTuple>> client =
TarantoolClientFactory.createClient()
.withCredentials("api_user", "secret")
.withAddress(tarantoolContainer.getHost(), tarantoolContainer.getMappedPort(3301))
.build();

final List<?> result = client.eval("return 'test'").join();
final TarantoolVersion version = client.getVersion();

Assertions.assertEquals("test", result.get(0));
Assertions.assertTrue(version.toString().startsWith("Tarantool 2.7.3 (Binary)"));
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
public class TarantoolStaticContainerTest {

@Container
private static TarantoolContainer container = new TarantoolContainer();
private static final TarantoolContainer container = new TarantoolContainer();

@Test
public void testExecuteCommand() throws Exception {
Expand Down
24 changes: 24 additions & 0 deletions src/test/resources/testsdk/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
FROM centos:7

ARG TARANTOOL_WORKDIR="/app"
ARG TARANTOOL_RUNDIR="/tmp/run"
ARG TARANTOOL_DATADIR="/tmp/data"
ARG SDK_TGT_DIR="/sdk"
ARG URI=""
ARG SDK_TGZ="tarantool-enterprise-bundle-2.7.3-0-gdddf926c3-r443.tar.gz"

ENV URI=$URI
ENV SDK_VERSION="tarantool-enterprise-bundle-2.7.3-0-gdddf926c3-r443"
ENV SDK_TGT_DIR=$SDK_TGT_DIR
ENV TARANTOOL_WORKDIR=$TARANTOOL_WORKDIR
ENV TARANTOOL_RUNDIR=$TARANTOOL_RUNDIR
ENV TARANTOOL_DATADIR=$TARANTOOL_DATADIR

RUN curl https://curl.se/ca/cacert.pem -o /etc/pki/tls/certs/ca-bundle.crt && \
yum -y install wget && \
wget $URI/$SDK_TGZ && \
mkdir ./tmp_sdk && tar -xf $SDK_TGZ -C ./tmp_sdk && \
mv ./tmp_sdk/tarantool-enterprise $SDK_TGT_DIR && rm $SDK_TGZ && \
cp $SDK_TGT_DIR/tarantool /usr/bin/tarantool

WORKDIR $TARANTOOL_WORKDIR
10 changes: 10 additions & 0 deletions src/test/resources/testsdk/server.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
box.cfg {
listen = 3301,
memtx_memory = 128 * 1024 * 1024, -- 128 Mb
-- log = 'file:/tmp/tarantool.log',
log_level = 6,
}
-- API user will be able to login with this password
box.schema.user.create('api_user', { password = 'secret', if_not_exists = true })
-- API user will be able to create spaces, add or remove data, execute functions
box.schema.user.grant('api_user', 'read,write,execute', 'universe', nil, { if_not_exists = true })