-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add "VncRecordingContainer" - Network-based, attachable re-implementation of VncRecordingSidekickContainer
- Loading branch information
Showing
9 changed files
with
233 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
137 changes: 137 additions & 0 deletions
137
core/src/main/java/org/testcontainers/containers/VncRecordingContainer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
package org.testcontainers.containers; | ||
|
||
import com.github.dockerjava.api.model.Frame; | ||
import lombok.Getter; | ||
import lombok.NonNull; | ||
import lombok.SneakyThrows; | ||
import lombok.ToString; | ||
import org.apache.commons.codec.binary.Base64; | ||
import org.apache.commons.compress.archivers.tar.TarArchiveInputStream; | ||
import org.rnorth.ducttape.TimeoutException; | ||
import org.rnorth.ducttape.unreliables.Unreliables; | ||
import org.testcontainers.containers.output.FrameConsumerResultCallback; | ||
import org.testcontainers.utility.TestcontainersConfiguration; | ||
|
||
import java.io.Closeable; | ||
import java.io.File; | ||
import java.io.InputStream; | ||
import java.nio.file.Files; | ||
import java.nio.file.StandardCopyOption; | ||
import java.util.concurrent.CountDownLatch; | ||
import java.util.concurrent.TimeUnit; | ||
|
||
/** | ||
* 'Sidekick container' with the sole purpose of recording the VNC screen output from another container. | ||
* | ||
*/ | ||
@Getter | ||
@ToString | ||
public class VncRecordingContainer extends GenericContainer<VncRecordingContainer> { | ||
|
||
private static final String RECORDING_FILE_NAME = "/screen.flv"; | ||
|
||
public static final String DEFAULT_VNC_PASSWORD = "secret"; | ||
|
||
public static final int DEFAULT_VNC_PORT = 5900; | ||
|
||
private final String targetNetworkAlias; | ||
|
||
private String vncPassword = DEFAULT_VNC_PASSWORD; | ||
|
||
private int vncPort = 5900; | ||
|
||
private int frameRate = 30; | ||
|
||
public VncRecordingContainer(@NonNull GenericContainer<?> targetContainer) { | ||
this( | ||
targetContainer.getNetwork(), | ||
targetContainer.getNetworkAliases().stream() | ||
.findFirst() | ||
.orElseThrow(() -> new IllegalStateException("Target container must have a network alias")) | ||
); | ||
} | ||
|
||
/** | ||
* 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 { | ||
super(TestcontainersConfiguration.getInstance().getVncRecordedContainerImage()); | ||
|
||
this.targetNetworkAlias = targetNetworkAlias; | ||
withNetwork(network); | ||
|
||
waitingFor(new AbstractWaitStrategy() { | ||
|
||
@Override | ||
protected void waitUntilReady() { | ||
try { | ||
Unreliables.retryUntilTrue((int) startupTimeout.toMillis(), TimeUnit.MILLISECONDS, () -> { | ||
CountDownLatch latch = new CountDownLatch(1); | ||
|
||
FrameConsumerResultCallback callback = new FrameConsumerResultCallback() { | ||
@Override | ||
public void onNext(Frame frame) { | ||
if (frame != null && new String(frame.getPayload()).contains("Connected")) { | ||
latch.countDown(); | ||
} | ||
} | ||
}; | ||
|
||
try ( | ||
Closeable __ = dockerClient.logContainerCmd(containerId) | ||
.withFollowStream(true) | ||
.withSince(0) | ||
.withStdErr(true) | ||
.exec(callback) | ||
) { | ||
return latch.await(1, TimeUnit.SECONDS); | ||
} | ||
}); | ||
} catch (TimeoutException e) { | ||
throw new ContainerLaunchException("Timed out waiting for log output", e); | ||
} | ||
} | ||
}); | ||
} | ||
|
||
public VncRecordingContainer withVncPassword(@NonNull String vncPassword) { | ||
this.vncPassword = vncPassword; | ||
return this; | ||
} | ||
|
||
public VncRecordingContainer withVncPort(int vncPort) { | ||
this.vncPort = vncPort; | ||
return this; | ||
} | ||
|
||
public VncRecordingContainer withFrameRate(int frameRate) { | ||
this.frameRate = frameRate; | ||
return this; | ||
} | ||
|
||
@Override | ||
protected void configure() { | ||
withCreateContainerCmdModifier(it -> it.withEntrypoint("/bin/sh")); | ||
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 | ||
); | ||
} | ||
|
||
@SneakyThrows | ||
public InputStream streamRecording() { | ||
TarArchiveInputStream archiveInputStream = new TarArchiveInputStream( | ||
dockerClient.copyArchiveFromContainerCmd(containerId, RECORDING_FILE_NAME).exec() | ||
); | ||
archiveInputStream.getNextEntry(); | ||
return archiveInputStream; | ||
} | ||
|
||
@SneakyThrows | ||
public void saveRecordingToFile(File file) { | ||
try(InputStream inputStream = streamRecording()) { | ||
Files.copy(inputStream, file.toPath(), StandardCopyOption.REPLACE_EXISTING); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.