This page describes how to build ODF.
You need git, Maven, and Python (2.7 (not 3!)) available on the command line. If you run these commands and you see similar output you should be all set:
$ mvn -v Apache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-10T17:41:47+01:00) ... $ python -V Python 2.7.10 $ git --version git version 2.7.4
HADOOP_HOME
environment variable must be set to a location where the Hadoop winutils.exe file is available in a the bin folder. For example, if the environment variable is set to HADOOP_HOME=c:\hadoop
, the file needs to be available at c:\hadoop\bin\winutils.exe
.To build, clone the repository and perform a maven build in the toplevel directory. These commands should do the trick:
git clone https://github.com/Analytics/open-discovery-framework.git cd open-discovery-framework mvn clean install
Add the -Dreduced-build
option to build and test only the core components and services of ODF:
mvn clean install -Dreduced-build
To build without running tests run maven with the following options (The second one prevents the test Atlas instance from being started and stopped):
mvn clean install -DskipTests -Duse.running.atlas
Use the -Dreduced-tests
option to run only a reduced set of tests:
mvn clean install -Dreduced-tests
This will skip all integration tests (i.e. all tests that involve Atlas) and also some of the long running tests. The option may be combined with the -Dreduced-build
option introduced above.
You can build a test environment that contains Atlas and Kafka, and Jetty by running these commands:
cd odf-test-env mvn package
This will create a zip file with the standalone test environment under odf-test-env/target/odf-test-env-0.1.0-SNAPSHOT-bin.zip
. See the contents of this zip file or the documentation section on the test environment for details.
Congrats! You have just built ODF. This should be enough to get you going. See below for additional information on different aspects of the build.
To build with Eclipse you must have the maven m2e plugin and EGit installed (e.g., search for “m2e maven integration for eclipse” and “egit”, respectively, on the Eclipse marketplace).
If you want to build via Run configurations be aware that this will not work with the embedded maven provided by the m2e plugin. Instead you will have to do this:
Open Windows -> Preferences -> Maven -> Installations
Add a new installation pointing to your external Maven installation
For each run configuration you use, select the new installation in the Maven runtime dropdown (you might also have to set JAVA_HOME in the environment tab).