Contributing to Apache Zeppelin ( Code )
NOTE : Apache Zeppelin is an Apache2 License Software. Any contributions to Zeppelin (Source code, Documents, Image, Website) means you agree with license all your contributions as Apache2 License.
Here are some tools you will need to build and test Zeppelin.
Software Configuration Management ( SCM )
Since Zeppelin uses Git for it's SCM system, you need git client installed in your development machine.
Integrated Development Environment ( IDE )
You are free to use whatever IDE you prefer, or your favorite command line editor.
To build the code, install
- Oracle Java 7
- Apache Maven
Getting the source code
First of all, you need Zeppelin source code. The official location of Zeppelin is http://git.apache.org/zeppelin.git.
Get the source code on your development machine using git.
git clone git://git.apache.org/zeppelin.git zeppelin
You may also want to develop against a specific branch. For example, for branch-0.5.6
git clone -b branch-0.5.6 git://git.apache.org/zeppelin.git zeppelin
Apache Zeppelin follows Fork & Pull as a source control workflow. If you want to not only build Zeppelin but also make any changes, then you need to fork Zeppelin github mirror repository and make a pull request.
Before making a pull request, please take a look Contribution Guidelines.
To skip test
mvn install -DskipTests
To build with specific spark / hadoop version
mvn install -Dspark.version=x.x.x -Dhadoop.version=x.x.x
For the further
Run Zeppelin server in development mode
cd zeppelin-server HADOOP_HOME=YOUR_HADOOP_HOME JAVA_HOME=YOUR_JAVA_HOME mvn exec:java -Dexec.mainClass="org.apache.zeppelin.server.ZeppelinServer" -Dexec.args=""
Note: Make sure you first run
mvn clean install -DskipTestson your zeppelin root directory, otherwise your server build will fail to find the required dependencies in the local repro.
or use daemon script
Server will be run on http://localhost:8080.
Generating Thrift Code
Some portions of the Zeppelin code are generated by Thrift. For most Zeppelin changes, you don't need to worry about this. But if you modify any of the Thrift IDL files (e.g. zeppelin-interpreter/src/main/thrift/*.thrift), then you also need to regenerate these files and submit their updated version as part of your patch.
To regenerate the code, install thrift-0.9.2 and then run the following command to generate thrift code.
cd <zeppelin_home>/zeppelin-interpreter/src/main/thrift ./genthrift.sh
Run Selenium test
Zeppelin has set of integration tests using Selenium. To run these test, first build and run Zeppelin and make sure Zeppelin is running on port 8080. Then you can run test using following command
TEST_SELENIUM=true mvn test -Dtest=[TEST_NAME] -DfailIfNoTests=false -pl 'zeppelin-interpreter,zeppelin-zengine,zeppelin-server'
For example, to run ParagraphActionIT,
TEST_SELENIUM=true mvn test -Dtest=ParagraphActionsIT -DfailIfNoTests=false -pl 'zeppelin-interpreter,zeppelin-zengine,zeppelin-server'
You'll need Firefox web browser installed in your development environment. While CI server uses Firefox 31.0 to run selenium test, it is good idea to install the same version (disable auto update to keep the version).
Where to Start
You can find issues for beginner & newbie
Contributors should join the Zeppelin mailing lists.
- email@example.com is for people who want to contribute code to Zeppelin. subscribe, unsubscribe, archives
If you have any issues, create a ticket in JIRA.