Difference between revisions of " Maven Notes"
Brad Bebee (Talk | contribs) (→Running NanoSparqlServer in Eclipse) |
Brad Bebee (Talk | contribs) (→Running NanoSparqlServer in Eclipse) |
||
Line 123: | Line 123: | ||
-Djetty.home=${workspace_loc:bigdata-war-html}/src/main/webapp/ | -Djetty.home=${workspace_loc:bigdata-war-html}/src/main/webapp/ | ||
-Djetty.resourceBase=${workspace_loc:bigdata-war-html}/src/main/webapp/ | -Djetty.resourceBase=${workspace_loc:bigdata-war-html}/src/main/webapp/ | ||
− | -DjettyXml=${workspace_loc:bigdata- | + | -DjettyXml=${workspace_loc:bigdata-jar}/src/main/resources/jetty.xml |
==Getting a Blazegraph Runtime== | ==Getting a Blazegraph Runtime== |
Revision as of 01:48, 26 August 2015
Here are a few notes on the ongoing effort to "Maven-ize" Blazegraph.
Contents
Overview
The main goal of the "mavenization" process is to separate “heavy-weight” tests from the standard unit tests that a developer would run during a typical development cycle. Also included are tests that require some external infrastructure to be set up and torn down(e.g. a lookup service) around the execution of the tests. The term “integration tests” is not particularly accurate and is really a catch-all for anything that we don’t want to be part of the lighter-weight unit tests. As the componentization of Bigdata proceeds, we will see some of these integration tests move back into their respective components but still be separated from the light-weight unit tests. Of course, the unit tests themselves will become part of the components they are meant to test. Maven’s separation of unit and integration tests into separate phases of the build lifecycle makes this fairly straightforward.
Architecture
For release 1.5.3, the existing project is broken into the artifacts below. blazegraph-parent is the parent artifact that will build all of the dependencies and contains common configuration information.
Module | Description |
---|---|
blazegraph-parent | Blazegraph parent artifact |
junit-ext | Blazegraph extentions for unit tests |
ctc-striterators | Blazegraph CTC Striterators |
lgpl-utils | Blazegraph LGPL Utils extensions |
dsi-utils | Blazegraph DSI Utils extensions |
rdf-properties | RDF properties common to multiple Blazegraph artifacts |
bigdata-util | Utilities common to multiple Blazegraph artifacts |
bigdata-client | Classes necessary build a Blazegraph client. |
bigdata-ganglia | Blazegraph Ganglia package |
bigdata-gas | Blazegraph Gather Apply Scatter (GAS) package |
bigdata-core | bigdata, bigdata-rdf, bigdata-sails, and bigdata-gom source code. Tests are in bigdata-core-test and bigdata-sails-test. Future work will split this into separate artifacts as required. |
bigdata-jini | Blazegraph HA and Scale-out packages requiring Apache River. Includes tests. |
bigdata-war-html | This version of the bigdata.war without lib files. |
bigdata-blueprints | Blazegraph Embedded Server package |
bigdata-core-test | Unit tests for bigdata and bigdata-gom |
bigdata-rdf-test | Unit tests for bigdata-rdf |
bigdata-sails-test | Unit tests for bigdata-sails |
bigdata-war | bigdata.war distribution |
bigdata-jar | Blazegraph executable jar for distribution. |
bigdata-runtime | Blazegraph specific artifacts without any dependencies bundled. |
Creating a Snapshot Build
Sometimes, you'll want to make a change in the latest snapshot, i.e. "1.5.3-SNAPSHOT". This doesn't require any additional configuration.
However, if you want to create a numbered snapshot. You can use the script:
./scripts/snapshot.sh
This updates the pom versions in the form RELEASE-BRANCH-YYYYMMDD such as 1.5.3-feature_branch-20150820 and builds a clean local copy. You can then copy the artifacts from bigdata-runtime or bigdata-jar with the snapshot version.
Getting Started with Eclipse
As of 1.5.3, the top level eclipse project has been removed and the .project and .classpath settings removed from the repository. These should be generated dynamically when you checkout the repository from Git.
If you are migrating from a pre-Maven version, it is highly recommended that you create a new workspace in Eclipse to do this.
From within a single artifact, run:
mvn eclipse:eclipse
Or to run for everything, from the root of the repository run:
./scripts/makeEclipse.sh
This also cleans the project directory. Then import the root directory into Eclipse and select search for sub-projects. Your M2_REPO variable must be set in Eclipse. This can either be done manually or via the Eclipse IDE.
Define and add M2_REPO classpath variable manually into Eclipse IDE. Follow below steps : Eclipse IDE, menu bar Select Window > Preferences Select Java > Build Path > Classpath Variables Click on the new button > defined a new M2_REPO variable and point it to your local Maven repository Done.
Updating Eclipse with a New Branch
After you switch branches in GIT, you should run the makeEclipse.sh command.
./scripts/makeEclipse.sh
This updates the POM versions specific to your branch. In Eclipse, you will also need to clean your existing projects. Projects->Clean->Clean all projects. in the Eclipse menu options. This forces the workspace to rebuild with the new dependencies.
Projects->Clean->Clean all projects
Running NanoSparqlServer in Eclipse
To run the NanoSparqlServer in Eclipse, you'll need to configure a Java Application Run configuration. The Program Arguments should be:
9999 namespace ${workspace_loc:bigdata-war-html}/src/main/webapp/WEB-INF/RWStore.properties
The VM Arguments should be:
-Dlog4j.configuration=${workspace_loc:bigdata-jar}/src/main/resources/log4j.properties -Djetty.home=${workspace_loc:bigdata-war-html}/src/main/webapp/ -Djetty.resourceBase=${workspace_loc:bigdata-war-html}/src/main/webapp/ -DjettyXml=${workspace_loc:bigdata-jar}/src/main/resources/jetty.xml
Getting a Blazegraph Runtime
If you'd like to get a version of the Blazegraph runtime without the dependencies, you can use the bigdata-runtime artifact.
cd bigdata-runtime mvn package
It produces a jar artifact timestamped with the format bigdata-runtime-<branchname>-<timestamp>.jar. An example is below.
bigdata-runtime-1.5.3-master-SNAPSHOT-20150813.jar
Maven Background and Help
How to create a new maven project
mvn archetype:generate -DgroupId=com.blazegraph -DartifactId=new-artifact -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
Edit new-artifact/pom.xml and add the lines:
<parent> <groupId>com.blazegraph</groupId> <artifactId>blazegraph-parent</artifactId> <version>1.5.2-SNAPSHOT</version> <relativePath>../blazegraph-parent/pom.xml</relativePath> </parent>
Add the javadoc parameters and repositories:
<reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile> <show>public</show> <maxmemory>1000m</maxmemory> <author>true</author> <version>true</version> <doctitle><![CDATA[<h1>ctc-striterators</h1>]]></doctitle> <bottom> <![CDATA[<i>Copyright © 2006-2015 SYSTAP, LLC. All Rights Reserved.</i> <script> jQuery(document).ready(function(){ jQuery('ul.sf-menu').superfish({ pathClass: 'current', cssArrows: false }); }); (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-50971023-6', 'blazegraph.com'); ga('send', 'pageview'); </script> ]]></bottom> </configuration> </plugin> </plugins> </reporting> <repositories> <repository> <id>bigdata.releases</id> <url>http://www.systap.com/maven/releases/</url> </repository> </repositories>
How to run the integration tests
The bigdata-integ module is now referenced in the bigdata parent POM. If you run a build from the parent project, you’ll build bigdata-core, generate its artifacts including the deployment tarball, and run the integration tests. Note that the unit tests are currently not being run during the build, but this should change soon.
mvn clean install
If you’ve already built bigdata-core and just want to run the integration tests, you can run this from the bigdata-integ directory:
cd bigdata-integ mvn clean integration-test (mvn clean install will also work)
How to not run the integration tests
If you don’t want to run the integration tests, it’s easy. You can:
- Run the build from the bigdata-core project rather than the parent project.
- OR from the parent project, add the –DskipITs argument on the command-line (this skips integration tests just as –DskipTests skips unit tests)
- OR from the parent project, run mvn clean package instead of mvn clean install.
Since the integration-test build phase comes after the package build phase, the integration tests won’t be executed.
Creating a new project with archetype
mvn -B archetype:generate \ -DarchetypeGroupId=org.apache.maven.archetypes \ -DgroupId=com.blazegraph.component \ -DartifactId=blazegraph-component