Package org.testcontainers.k6

Class K6Container

java.lang.Object
org.testcontainers.containers.GenericContainer<K6Container>
org.testcontainers.k6.K6Container
All Implemented Interfaces:
AutoCloseable, org.testcontainers.containers.Container<K6Container>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable
public class K6Container extends org.testcontainers.containers.GenericContainer<K6Container>

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

    org.testcontainers.containers.Container.ExecResult

  • Field Summary

    Fields inherited from class org.testcontainers.containers.GenericContainer

    CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

    Fields inherited from interface org.testcontainers.containers.ContainerState

    STATE_HEALTHY

  • Constructor Summary

    Constructors
    Constructor
    Description
    K6Container(String dockerImageName)
    Creates a new container instance based upon the provided image name.
    K6Container(org.testcontainers.utility.DockerImageName dockerImageName)
    Creates a new container instance based upon the provided image.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    configure()
    K6Container
    withCmdOptions(String... options)
    Specifies additional command line options to be provided to the k6 command.
    K6Container
    withScriptVar(String key, String value)
    Adds a key-value pair for access within test scripts as an environment variable.
    K6Container
    withTestScript(org.testcontainers.utility.MountableFile testScript)
    Specifies the test script to be executed within the container.

    Methods inherited from class org.testcontainers.containers.GenericContainer

    addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, canBeReused, containerIsCreated, containerIsStarted, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setContainerDef, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, stop, toString, waitingFor, waitUntilContainerStarted, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCopyToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.testcontainers.containers.Container

    addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

    Methods inherited from interface org.testcontainers.containers.ContainerState

    copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, execInContainer, execInContainer, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

    Methods inherited from interface org.testcontainers.lifecycle.Startable

    close

  • Constructor Details

    • K6Container

      public K6Container(String dockerImageName)
      Creates a new container instance based upon the provided image name.

    • K6Container

      public K6Container(org.testcontainers.utility.DockerImageName dockerImageName)
      Creates a new container instance based upon the provided image.

  • Method Details

    • withTestScript

      public K6Container withTestScript(org.testcontainers.utility.MountableFile testScript)
      Specifies the test script to be executed within the container.
      Parameters:
      testScript - file to be copied into the container
      Returns:
      the builder

    • withCmdOptions

      public K6Container withCmdOptions(String... options)
      Specifies additional command line options to be provided to the k6 command.
      Parameters:
      options - command line options
      Returns:
      the builder

    • withScriptVar

      public K6Container withScriptVar(String key, String value)
      Adds a key-value pair for access within test scripts as an environment variable.
      Parameters:
      key - unique identifier for the variable
      value - value of the variable
      Returns:
      the builder

    • configure

      protected void configure()
      Overrides:
      configure in class org.testcontainers.containers.GenericContainer<K6Container>