org.opendaylight.ovsdb.utils.ovsdb.it.utils

Class DockerOvs

java.lang.Object

org.opendaylight.ovsdb.utils.ovsdb.it.utils.DockerOvs

All Implemented Interfaces:

AutoCloseable

public class DockerOvs
extends Object
implements AutoCloseable

Run OVS(s) using docker-compose for use in integration tests. For example,

 try(DockerOvs ovs = new DockerOvs()) {
      ConnectionInfo connectionInfo = SouthboundUtils.getConnectionInfo(
                               ovs.getOvsdbAddress(0), ovs.getOvsdbPort(0));
      ...
       nodeInfo.disconnect();

 } catch (Exception e) {
 ...
 

Nota bene, DockerOvs will check whether or not docker-compose command requires "sudo" to run. However, if it does require sudo, it must be configured to not prompt for a password ("NOPASSWD: ALL" is the sudoers file). DockerOvs loads its docker-compose yaml files from inside the ovsdb-it-utils bundle at the path META-INF/docker-compose-files/. Currently, a single yaml file is used, "docker-ovs-2.5.1.yml." DockerOvs does support docker-compose files that launch more than one docker image, more on this later. DockerOvs will wait for OVS to accept OVSDB connections. Any docker-compose file must have a port mapping. The following explains how system properties are used to configure DockerOvs

  private static String ENV_USAGE =
  "-Ddocker.run - explicitly configure whether or not DockerOvs should run docker-compose\n" +
  "-Dovsdbserver.ipaddress - specify IP address of ovsdb server - implies -Ddocker.run=false\n" +
  "-Dovsdbserver.port - specify the port of the ovsdb server - required with -Dovsdbserver.ipaddress\n" +
  "-Ddocker.compose.file - docker compose file in META-INF/docker-compose-files/. If not specified, default file is used\n" +
  "-Dovsdb.userspace.enabled - true when Ovs is running in user space (usually the case with docker)\n" +
  "-Dovsdb.controller.address - IP address of the controller (usually the docker0 interface with docker)\n" +
  "To auto-run Ovs and connect actively:\n" +
  " -Dovsdb.controller.address=x.x.x.x -Dovsdb.userspace.enabled=yes [-Ddocker.compose.file=ffff]\n" +
  "To auto-run Ovs and connect passively:\n" +
  " -Dovsdbserver.connection=passive -Dovsdb.controller.address=x.x.x.x -Dovsdb.userspace.enabled=yes [-Ddocker.compose.file=ffff]\n" +
  "To actively connect to a running Ovs:\n" +
  " -Dovsdbserver.ipaddress=x.x.x.x -Dovsdbserver.port=6641 -Dovsdb.controller.address=y.y.y.y\n" +
  "To passively connect to a running Ovs:\n" +
  " -Dovsdbserver.connection=passive -Ddocker.run=false\n";
 

When DockerOvs does not run docker-compose getOvsdbAddress and getOvsdbPort return the address and port specified in the system properties.

Constructor Summary

Constructors

Constructor and Description
DockerOvs() Bring up all docker images in the default docker-compose file.
DockerOvs(String yamlFileName) Bring up all docker images in the provided docker-compose file under "META-INF/docker-compose-files/".

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Shut everything down.
String[]	getExecCmdPrefix(int numOvs)
int	getNumOvsNodes() How many OVS nodes are there.
String	getOvsdbAddress(int ovsNumber) Get the IP address of the n'th OVS.
String	getOvsdbPort(int ovsNumber) Get the port of the n'th OVS.
static org.ops4j.pax.exam.Option[]	getSysPropOptions() Get the array of system properties as pax exam Option objects for use in pax exam unit tests with Configuration annotation.
void	logState(int dockerInstance) Useful for debugging.
void	runInContainer(int waitFor, int numOvs, String... cmdWords)
void	tryInContainer(int waitFor, int numOvs, String... cmdWords)
boolean	usingExternalDocker() Are we using some other OVS, not a docker we spin up?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DockerOvs

public DockerOvs()
          throws IOException,
                 InterruptedException

Bring up all docker images in the default docker-compose file.

Throws:

IOException - if something goes wrong on the IO end

InterruptedException - If this thread is interrupted

DockerOvs

public DockerOvs(String yamlFileName)
          throws IOException,
                 InterruptedException

Bring up all docker images in the provided docker-compose file under "META-INF/docker-compose-files/".

Parameters:

yamlFileName - Just the file name

Throws:

IOException - if something goes wrong on the IO end

InterruptedException - If this thread is interrupted

Method Detail

getSysPropOptions

public static org.ops4j.pax.exam.Option[] getSysPropOptions()

Get the array of system properties as pax exam Option objects for use in pax exam unit tests with Configuration annotation.

Returns:

List of Option objects

usingExternalDocker

public boolean usingExternalDocker()

Are we using some other OVS, not a docker we spin up?

Returns:

true if we are *not* running a docker image to test against

getOvsdbAddress

public String getOvsdbAddress(int ovsNumber)

Get the IP address of the n'th OVS.

Parameters:

ovsNumber - which OVS?

Returns:

IP string

getOvsdbPort

public String getOvsdbPort(int ovsNumber)

Get the port of the n'th OVS.

Parameters:

ovsNumber - which OVS?

Returns:

Port as a string

getNumOvsNodes

public int getNumOvsNodes()

How many OVS nodes are there.

Returns:

number of running OVS nodes

getExecCmdPrefix

public String[] getExecCmdPrefix(int numOvs)

runInContainer

public void runInContainer(int waitFor,
                  int numOvs,
                  String... cmdWords)
                    throws IOException,
                           InterruptedException

Throws:

IOException

InterruptedException

tryInContainer

public void tryInContainer(int waitFor,
                  int numOvs,
                  String... cmdWords)
                    throws IOException,
                           InterruptedException

Throws:

IOException

InterruptedException

close

public void close()
           throws Exception

Shut everything down.

Specified by:

close in interface AutoCloseable

Throws:

Exception - but not really

logState

public void logState(int dockerInstance)
              throws IOException,
                     InterruptedException

Useful for debugging. Dump some interesting config

Throws:

IOException - If something goes wrong with reading the process output

InterruptedException - because there's some sleeping in here