Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add "VncRecordingContainer" #526

Merged
merged 10 commits into from
Dec 19, 2017
Merged

Add "VncRecordingContainer" #526

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7f599e8
Add "VncRecordingContainer" - Network-based, attachable re-implementa…
bsideup Dec 17, 2017
0020cba
fix leftover, add issue # to CHANGELOG.md
bsideup Dec 18, 2017
0f09dbe
"docker network attach"-style VncRecordingContainer implementation
bsideup Dec 18, 2017
fd409b9
use SHARED network to limit the number of Networks created by VncReco…
bsideup Dec 18, 2017
176eafe
cleanup the imports
bsideup Dec 18, 2017
067f2d2
fix typo
bsideup Dec 18, 2017
d283f0e
restore the timeout
bsideup Dec 19, 2017
bd5eb9b
revert "connect"-like implementation for now
bsideup Dec 19, 2017
1add62a
fix networkAliases
bsideup Dec 19, 2017
f0c6336
make Codacy happy
bsideup Dec 19, 2017
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
2 changes: 0 additions & 2 deletions core/src/main/java/org/testcontainers/containers/Network.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@

public interface Network extends AutoCloseable, TestRule {

Network SHARED = newNetwork();

String getId();

static Network newNetwork() {
Expand Down
50 changes: 35 additions & 15 deletions core/src/main/java/org/testcontainers/containers/VncRecordingContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package org.testcontainers.containers;

import com.github.dockerjava.api.model.ContainerNetwork;
import com.github.dockerjava.api.model.Frame;
import lombok.Getter;
import lombok.NonNull;
Expand All @@ -10,6 +11,7 @@
import org.rnorth.ducttape.TimeoutException;
import org.rnorth.ducttape.unreliables.Unreliables;
import org.testcontainers.containers.output.FrameConsumerResultCallback;
import org.testcontainers.utility.Base58;
import org.testcontainers.utility.TestcontainersConfiguration;

import java.io.Closeable;
Expand All @@ -19,6 +21,7 @@
import java.nio.file.StandardCopyOption;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.function.Supplier;

/**
* 'Sidekick container' with the sole purpose of recording the VNC screen output from another container.
Expand All @@ -34,7 +37,7 @@ public class VncRecordingContainer extends GenericContainer<VncRecordingContaine

public static final int DEFAULT_VNC_PORT = 5900;

private final String targetNetworkAlias;
private final Supplier<String> targetContainerIdSupplier;

private String vncPassword = DEFAULT_VNC_PASSWORD;

Expand All @@ -43,22 +46,12 @@ public class VncRecordingContainer extends GenericContainer<VncRecordingContaine
private int frameRate = 30;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought it's nice to have it configurable :) Some people do crazy stuff during their tests :D


public VncRecordingContainer(@NonNull GenericContainer<?> targetContainer) {
this(
targetContainer.getNetwork(),
targetContainer.getNetworkAliases().stream()
.findFirst()
.orElseThrow(() -> new IllegalStateException("Target container must have a network alias"))
);
this(targetContainer::getContainerId);
}

/**
* Create a sidekick container and attach it to another container. The VNC output of that container will be recorded.
*/
public VncRecordingContainer(@NonNull Network network, @NonNull String targetNetworkAlias) throws IllegalStateException {
public VncRecordingContainer(@NonNull Supplier<String> targetContainerIdSupplier) {
super(TestcontainersConfiguration.getInstance().getVncRecordedContainerImage());

this.targetNetworkAlias = targetNetworkAlias;
withNetwork(network);
this.targetContainerIdSupplier = targetContainerIdSupplier;

waitingFor(new AbstractWaitStrategy() {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our standard LogWaitStrategy didn't work here and also requires a Regexp while here contains is more than enough. Also, in debug mode vncrec.py produces a lot of output, makes sense to do as little as possible here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could/should ship a log wait strategy that is based on contains anyway. It seems to me that LogWaitStrategy is used for contains semantics more often than for a full blown regex.

Not saying we have to do that now, but keen for your thoughts.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point not needing a Regex, but why didn't LogWaitStrategy work?


Expand Down Expand Up @@ -112,13 +105,40 @@ public VncRecordingContainer withFrameRate(int frameRate) {
@Override
protected void configure() {
withCreateContainerCmdModifier(it -> it.withEntrypoint("/bin/sh"));

if (getNetwork() == null) {
withNetwork(Network.newNetwork());
}

String alias = "vnchost-" + Base58.randomString(8);
dockerClient.connectToNetworkCmd()
.withContainerId(targetContainerIdSupplier.get())
.withNetworkId(getNetwork().getId())
.withContainerNetwork(new ContainerNetwork().withAliases(alias))
.exec();

setCommand(
"-c",
"echo '" + Base64.encodeBase64String(vncPassword.getBytes()) + "' | base64 -d > /vnc_password && " +
"flvrec.py -o " + RECORDING_FILE_NAME + " -d -r " + frameRate + " -P /vnc_password " + targetNetworkAlias + " " + vncPort
"flvrec.py -o " + RECORDING_FILE_NAME + " -d -r " + frameRate + " -P /vnc_password " + alias + " " + vncPort
);
}

@Override
public void stop() {
try {
dockerClient.disconnectFromNetworkCmd()
.withContainerId(targetContainerIdSupplier.get())
.withNetworkId(getNetwork().getId())
.withForce(true)
.exec();
} catch (Exception e) {
logger().warn("Failed to disconnect container with id '{}' from network '{}'", targetContainerIdSupplier.get(), getNetwork().getId(), e);
}

super.stop();
}

@SneakyThrows
public InputStream streamRecord() {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the whole point is having "volume-less" recorder because:

  1. for some reason, on Mac, files were incomplete (read - empty) once a recording is flushed to the FS ( See VNC recorder for selenium container creates empty video files #466 )
  2. allows Docker to be on another host. Not-so-critical for the integration testing, but I've received some feedback about CI setups for functional/e2e testing, people really run their Docker hosts "somewhere else"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 is definitely an awesome reason to do this 👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a wording thing, but please could this be streamRecording? The same for saveRecordToFile (->saveRecordingToFile)

TarArchiveInputStream archiveInputStream = new TarArchiveInputStream(
Expand Down
19 changes: 5 additions & 14 deletions modules/selenium/src/main/java/org/testcontainers/containers/BrowserWebDriverContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
import org.testcontainers.containers.wait.LogMessageWaitStrategy;
import org.testcontainers.containers.wait.WaitAllStrategy;
import org.testcontainers.containers.wait.WaitStrategy;
import org.testcontainers.utility.Base58;

import java.io.File;
import java.net.MalformedURLException;
Expand Down Expand Up @@ -102,14 +101,6 @@ protected void configure() {
}

if (recordingMode != VncRecordingMode.SKIP) {
if (getNetwork() == null) {
withNetwork(Network.SHARED);
}

if (getNetworkAliases().isEmpty()) {
withNetworkAliases("vnchost-" + Base58.randomString(8));
}

vncRecordingContainer = new VncRecordingContainer(this)
.withVncPassword(DEFAULT_PASSWORD)
.withVncPort(VNC_PORT);
Expand Down Expand Up @@ -177,15 +168,15 @@ public int getPort() {

@Override
protected void containerIsStarted(InspectContainerResponse containerInfo) {
if (vncRecordingContainer != null) {
LOGGER.debug("Starting VNC recording");
vncRecordingContainer.start();
}

driver = Unreliables.retryUntilSuccess(30, TimeUnit.SECONDS,
Timeouts.getWithTimeout(1, TimeUnit.SECONDS,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not directly related to this PR, but sometimes it fails to init, and this code waits for 10s while 1s is enough

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

() ->
() -> new RemoteWebDriver(getSeleniumAddress(), desiredCapabilities)));

if (vncRecordingContainer != null) {
LOGGER.debug("Starting VNC recording");
vncRecordingContainer.start();
}
}

/**
Expand Down
4 changes: 4 additions & 0 deletions modules/selenium/src/test/java/org/testcontainers/junit/BaseWebDriverContainerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import java.util.concurrent.TimeUnit;

import static org.rnorth.visibleassertions.VisibleAssertions.assertEquals;
import static org.rnorth.visibleassertions.VisibleAssertions.assertTrue;

/**
*
Expand Down Expand Up @@ -37,6 +38,9 @@ private static RemoteWebDriver setupDriverFromRule(BrowserWebDriverContainer rul
protected static void doSimpleExplore(BrowserWebDriverContainer rule) {
RemoteWebDriver driver = setupDriverFromRule(rule);
driver.get("http://en.wikipedia.org/wiki/Randomness");

// Oh! The irony!
assertTrue("Randomness' description has the word 'pattern'", driver.findElementByPartialLinkText("pattern").isDisplayed());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leading to Wiki authors breaking our tests 🤣

}

}