io.neow3j.test

Class NeoExpressTestContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<NeoExpressTestContainer>

io.neow3j.test.NeoExpressTestContainer

All Implemented Interfaces:

TestBlockchain, java.lang.AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<NeoExpressTestContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable

public class NeoExpressTestContainer
extends org.testcontainers.containers.GenericContainer<NeoExpressTestContainer>
implements TestBlockchain

Nested Class Summary

Nested classes/interfaces inherited from interface io.neow3j.test.TestBlockchain

TestBlockchain.GenesisAccount

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

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTAINER_WORKDIR
static java.lang.String	DEFAULT_NEOXP_CONFIG
static java.lang.String	NEOXP_CONFIG_DEST

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 and Description
NeoExpressTestContainer(java.lang.String... resources) Creates a new instance of a docker container running a neo-express private network.

Method Summary

Modifier and Type	Method and Description
java.lang.String	createAccount() Creates a new account on the neo-express instance.
java.lang.String	enableOracle() Enables the oracle service on the neo-express instance
java.lang.String	execCommand(java.lang.String... commandParts) Executes the given command on the neo-express instance.
java.lang.String	fastForward(int n) Fast-forwards the blockchain state by n blocks.
java.lang.String	fastForward(int seconds, int n) Mints n blocks with the last block being seconds in the future.
java.lang.String	getAccount(java.lang.String address) Gets the private key corresponding to the given address.
TestBlockchain.GenesisAccount	getGenesisAccount() Gets the genesis account this blockchain is based on.
java.lang.String	getNodeUrl() Gets the URL of the neo-express node running in the container.
java.lang.String	halt() Stops the neo-express instance.
java.lang.String	resume() Runs neo-express if it was stopped before.
void	start() Starts the blockchain, i.e., the process that includes the blockchain.
NeoExpressTestContainer	withBatchFile(java.lang.String batchFile) Adds the given batch file to the test container and executes it before the neo-express instance is started.
NeoExpressTestContainer	withCheckpoint(java.lang.String checkpointFile) Adds the given checkpoint file to the test container and executes it before the neo-express instance is started.
NeoExpressTestContainer	withConfigFile(java.lang.String configFile) Adds the given neo-express config file to the test container.
NeoExpressTestContainer	withNefAndManifestFiles(java.lang.String nefFile, java.lang.String manifestFile) Adds the given NEF and manifest files to the test container.
NeoExpressTestContainer	withSecondsPerBlock(int secondsPerBlock) Sets the given block time.

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, configure, containerIsCreated, containerIsStarted, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, failed, finished, 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, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, starting, stop, succeeded, 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 io.neow3j.test.TestBlockchain

stop

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, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Field Detail

DEFAULT_NEOXP_CONFIG

public static final java.lang.String DEFAULT_NEOXP_CONFIG

See Also:

Constant Field Values

CONTAINER_WORKDIR

public static final java.lang.String CONTAINER_WORKDIR

See Also:

Constant Field Values

NEOXP_CONFIG_DEST

public static final java.lang.String NEOXP_CONFIG_DEST

See Also:

Constant Field Values

Constructor Detail

NeoExpressTestContainer

public NeoExpressTestContainer(java.lang.String... resources)

Creates a new instance of a docker container running a neo-express private network.

Parameters:

resources - the names of the files that should be copied into the container. For each file you need to set a source and a destination (in the container) path consecutively.

Method Detail

start

public void start()

Description copied from interface: TestBlockchain

Starts the blockchain, i.e., the process that includes the blockchain.

Specified by:

start in interface TestBlockchain

Specified by:

start in interface org.testcontainers.lifecycle.Startable

Overrides:

start in class org.testcontainers.containers.GenericContainer<NeoExpressTestContainer>

withSecondsPerBlock

public NeoExpressTestContainer withSecondsPerBlock(int secondsPerBlock)

Sets the given block time.

Specified by:

withSecondsPerBlock in interface TestBlockchain

Parameters:

secondsPerBlock - the block time.

Returns:

this.

withBatchFile

public NeoExpressTestContainer withBatchFile(java.lang.String batchFile)

Adds the given batch file to the test container and executes it before the neo-express instance is started.

The batch file must be located in the resources directory.

Specified by:

withBatchFile in interface TestBlockchain

Parameters:

batchFile - the batch file name.

Returns:

this.

withCheckpoint

public NeoExpressTestContainer withCheckpoint(java.lang.String checkpointFile)

Adds the given checkpoint file to the test container and executes it before the neo-express instance is started.

The file must be located in the resources directory.

If both a batch and a checkpoint file is added, the checkpoint is first applied.

Specified by:

withCheckpoint in interface TestBlockchain

Parameters:

checkpointFile - the checkpoint file name.

Returns:

this.

withConfigFile

public NeoExpressTestContainer withConfigFile(java.lang.String configFile)

Adds the given neo-express config file to the test container. It will be used to configure the neo-express instance in the container.

The file must be located in the resources directory.

Specified by:

withConfigFile in interface TestBlockchain

Parameters:

configFile - the config file name.

Returns:

this.

withNefAndManifestFiles

public NeoExpressTestContainer withNefAndManifestFiles(java.lang.String nefFile,
                                                       java.lang.String manifestFile)

Adds the given NEF and manifest files to the test container. They can then be used with the neo-express command neoxp contract deploy.

The files must be located in the resources directory.

The copied files in the container will have the same name as the given sources.

Parameters:

nefFile - the NEF file name.

manifestFile - the manifest file name.

Returns:

this.

getNodeUrl

public java.lang.String getNodeUrl()

Gets the URL of the neo-express node running in the container.

Specified by:

getNodeUrl in interface TestBlockchain

Returns:

the neo-express node URL.

resume

public java.lang.String resume()
                        throws java.lang.Exception

Runs neo-express if it was stopped before.

Specified by:

resume in interface TestBlockchain

Returns:

the message emitted by neo-express on startup.

Throws:

java.lang.Exception - if an error occurs while trying to start neo-express.

halt

public java.lang.String halt()
                      throws java.lang.Exception

Stops the neo-express instance.

Specified by:

halt in interface TestBlockchain

Returns:

the message emitted by neo-express on stopping.

Throws:

java.lang.Exception - if an error occurs when trying to stop neo-express.

createAccount

public java.lang.String createAccount()
                               throws java.lang.Exception

Creates a new account on the neo-express instance.

Specified by:

createAccount in interface TestBlockchain

Returns:

the new account's address.

Throws:

java.lang.Exception - if an error occurs when trying to create the account.

enableOracle

public java.lang.String enableOracle()
                              throws java.lang.Exception

Enables the oracle service on the neo-express instance

Specified by:

enableOracle in interface TestBlockchain

Returns:

the hash of the oracle designate transaction.

Throws:

java.lang.Exception - if the execution failed.

fastForward

public java.lang.String fastForward(int n)
                             throws java.lang.Exception

Fast-forwards the blockchain state by n blocks. I.e., mints n empty blocks. The block timestamps are according to the current system time.

Specified by:

fastForward in interface TestBlockchain

Parameters:

n - the number of blocks to mint.

Returns:

the message emitted by neo-express on minting the blocks.

Throws:

java.lang.Exception - if the execution failed.

fastForward

public java.lang.String fastForward(int seconds,
                                    int n)
                             throws java.lang.Exception

Mints n blocks with the last block being seconds in the future.

Specified by:

fastForward in interface TestBlockchain

Parameters:

seconds - the time delta in seconds from now.

n - the number of blocks to mint.

Returns:

the message emitted by neo-express on minting the blocks.

Throws:

java.lang.Exception - if the execution failed.

execCommand

public java.lang.String execCommand(java.lang.String... commandParts)
                             throws java.lang.Exception

Executes the given command on the neo-express instance.

The command has to be provided in its separate parts, e.g., "neoxp", "contract", "run", "NeoToken", "balanceOf", "NM7Aky765FG8NhhwtxjXRx7jEL1cnw7PBP", "--account genesis"

Specified by:

execCommand in interface TestBlockchain

Parameters:

commandParts - the command separated into its parts.

Returns:

the message emitted by neo-express on minting the blocks.

Throws:

java.lang.Exception - if the execution failed.

getAccount

public java.lang.String getAccount(java.lang.String address)
                            throws java.io.IOException

Description copied from interface: TestBlockchain

Gets the private key corresponding to the given address.

This is not meant to be used for multi-sig accounts.

Specified by:

getAccount in interface TestBlockchain

Parameters:

address - the account's address.

Returns:

the private key as a hexadecimal string.

Throws:

java.io.IOException

getGenesisAccount

public TestBlockchain.GenesisAccount getGenesisAccount()
                                                throws java.io.IOException

Description copied from interface: TestBlockchain

Gets the genesis account this blockchain is based on.

This is for test blockchains that provide control over the genesis account. The genesis account owns all NEO and GAS tokens starting from the first block.

Specified by:

getGenesisAccount in interface TestBlockchain

Returns:

the genesis account.

Throws:

java.io.IOException