commit | 383013568f81bed31261dd5c56a909417ae73174 | [log] [tgz] |
---|---|---|
author | Ray Milkey <ray@onlab.us> | Mon Jul 28 08:51:54 2014 -0700 |
committer | Ray Milkey <ray@onlab.us> | Wed Jul 30 10:17:45 2014 -0700 |
tree | 97be1be2292bc937161227f1f0b7aecf3c80f501 | |
parent | b6734601cd8fbedde2fc8e749ca8c544a34f742e [diff] |
Refactor Unit Tests handling of Metrics and web server removal - Created a new base class for Unit tests (UnitTest.java). This handles destruction of Metrics in an @After method so individual tests don't need to know about the Metrics lifecycle. - Added @After methods to REST unit test base classes to shut down the web server. - Removed dependencies on PowerMock for tests that are not using mocking Change-Id: Ib46e8675998c0520977e59b749cbba89456100ab
ONOS (Open Networking Operating System) is an experimental distributed SDN OS. Currently, it is under active development. ONOS was announced and demonstrated at ONS'13, '14.
Apache 2.0
https://wiki.onlab.us:8443/display/onosdocs/Getting+Started+with+ONOS
Cleanly build ONOS
$ cd ${ONOS_HOME}/ $ mvn clean $ mvn compile
Required packages
$ sudo apt-get install maven python-flask python-cmd2 python-pyparsing
ZooKeeper
Download and install apache-zookeeper-3.4.6: http://zookeeper.apache.org/releases.html
By default ONOS expect ZooKeeper to be installed in ~/zookeeper-3.4.6
.
This can be changed by specifing the path using ZK_HOME
environment variable.
Data directory ZooKeeper uses by default is /var/lib/zookeeper
. You will need to give current user permission to write to this directory.
This directory can be changed using specifying ZK_LIB_DIR
environment variable and running ./onos.sh setup
to generate ${ONOS_HOME}/conf/zoo.cfg
.
See Configuration for details about ./onos.sh setup
.
RAMCloud
Run setup-ramcloud.sh to download and install RAMCloud to ~/ramcloud
.
Installation path can be changed by specifing RAMCLOUD_HOME
environment variable.
$ cd ${ONOS_HOME}/ $ ./setup-ramcloud.sh
./onos.sh setup
script is used to generate ONOS related configuration files. This script read configuration from "${ONOS_CONF_DIR}/onos_node.`hostname`.conf".
Copy the file "${ONOS_HOME}/conf/onos_node.conf" to match the hostname and configure the content appropriately.
e.g., To use RAMCloud as data store change host.backend
to ramcloud
Once you're done with required configuration run following to generate configuration files.
$ cd ${ONOS_HOME}/ $ ./onos.sh setup
To start ZooKeeper, RAMCloud (if enabled in configuration) and ONOS core.
$ cd ${ONOS_HOME}/ $ ./onos.sh start single-node
To stop all the above
$ cd ${ONOS_HOME}/ $ ./onos.sh stop
If you need to use the REST APIs, follow the instruction for "Start ONOS REST API server" in next section.
You can manually start/stop individual ONOS components as follows:
Start Zookeeper
$ cd ${ONOS_HOME}/ $ ./onos.sh zk start ## Confirm Zookeeper is running: $ ./onos.sh zk status
Start RAMCloud Coordinator (only on one of the node in cluster)
$ cd ${ONOS_HOME}/ $ ./onos.sh rc-coord start ## Confirm RAMCloud Coordinator is running: $ ./onos.sh rc-coord status
Start RAMCloud Server
$ cd ${ONOS_HOME}/ $ ./onos.sh rc-server start ## Confirm RAMCloud Server is running: $ ./onos.sh rc-server status
Start ONOS
$ cd ${ONOS_HOME}/ $ ./onos.sh core start ## Confirm ONOS is running: $ ./onos.sh core status
Start ONOS REST API server
$ cd ${ONOS_HOME}/ $ ./start-rest.sh start ## Confirm the REST API server is running: $ ./start-rest.sh status
Unit tests bundled with ONOS source code, can be executed by using the following:
$ cd ${ONOS_HOME}/ $ mvn test
Some of the unit tests, which take longer time to execute are excluded from the above goal. To force running all the unit tests, use the following commands:
$ cd ${ONOS_HOME}/ $ mvn test -P all-tests
To run only a subset of the unit tests, use the following commands:
$ cd ${ONOS_HOME}/ $ mvn test -Dtest=PortNumberTest
Comma and wildcards can be used to specify multiple test cases. See maven-surefire-plugin website for details.
Maven need the Internet connection to download required dependencies and plugins, when they're used for the first time.
If you need to develop ONOS in an Internet unreachable environment you may want to run the following helper script before you go offline, so that required dependencies and plugins for frequently used maven target will be downloaded to your local environment.
$ ./prep-for-offline.sh