This section covers development and test environment setup and configuration.
We don't enforce the use of a specific IDE, but rather, a set of guidelines that can be configured in an IDE.
The formatting followed by the project are:
- Indentation using four spaces
- No trailing whitespaces, including in empty lines
- Spaces after keywords such as
while, and casts
The whitespace formatting, among other code styling, is enforced via Checkstyle, which is run against the code during each Maven build. The build will fail if formatting violations are found.
Prior to contributing code to ONOS, all developers should set-up their IDE to appropriately tag the code with the Apache 2 license header text. The bare text is checked in under tools/dev/header.txt, and the orginal can be found at:
Example: Copyright setup on IntelliJ
First make sure that you have the Copyright plugin enabled. Then, under Preferences, select Copyright section and create a new Copyright profile, call it something like Apache 2, and prime it with the text above, without any decorations. Then configure your copyright formatting options as shown:
Testing a distributed platform like ONOS can become a cumbersome task. ONOS, being an SDN controller authored in Java, can run on a variety of platforms. However, in the interest of focus, the project engages primarily in testing on Ubuntu server distributions, specifically Ubuntu Server 14.04* LTS 64-bit, using the Oracle Java 8 JRE.
Additionally, in order to simplify testing and to make it more repeatable, a number of assets have been developed to make the developer’s and tester’s lives easier. These are located under the ONOS_ROOT/tools/test/.
An ONOS developer's environment may include the following:
- Development/build machine
- One or more test deployment VMs
- A Mininet VM
The notion of a test cell refers to a specific controller cluster environment designated for testing. This can mean a set of bare-metal servers, or a set of virtual machines running on developer’s laptop. Cell definition files are bash snippets that export a few environment variables into the developer’s (or tester’s) shell. These variables are then used by a number of the ONOS test and utility scripts. This allows the scripts and test scenarios to be independent to a specific test bench setup.
Cell definitions are loaded into the shell environment with the
cell utility. This utility takes the name of a cell definition file as the argument. For example:
Now, utilities such as
onos will fall back to using the value set in
OCI (192.168.56.101 for above) if not given any parameters.
The utility script
cells can be used to view all available cell definitions. Without parameters,
cell will list the values associated with the current cell in use
Cell Definition Files
A cell definition file defines values for a set of environment variables understood by the ONOS scripts. A cell definition file may look like the following:
- OC1, 2, and 3 : IP addresses of the VMs hosting ONOS instances
- OCN : IP address of the VM used to emulate a network with Mininet
- ONOS_NIC : The address block used amongst ONOS instances for inter-controller (clustering) and OpenFlow communication
- ONOS_FEATURES : a comma-separated list of bundle names, loaded at startup by an ONOS instance within this cell
These files are located in ONOS_ROOT/tools/test/cells/. Custom cell definition files may be added to this directory and loaded as needed with