Difference between revisions of " Maven Notes"

Revision as of 13:06, 17 September 2015

Here are a few notes on the ongoing effort to "Maven-ize" Blazegraph.

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.6.0, 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.

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 or When New Artifacts are Added

After you switch branches in GIT or if you have build failures after an update or Pull Request that added new artifacts, you should run the makeEclipse.sh command.

./scripts/makeEclipse.sh

This script uses the value of your ECLIPSE_WORKSPACE variable if present. You may also manually pass it parameters to maven, such as:

./scripts/makeEclipse.sh -Declipse.workspace=/path/to/your/workspace

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

Importing New Modules

You can then import new modules into your existing workspace, if you desire to have them open and referenced from the workspace rather than your local maven repository.

Eclipse->File->Import->General->Existing Projects Into Workspace

Select the directory with the repository as the root directory. And check search for nest projects. Any projects that are present, but not yet imported will be available to check. Existing projects will be greyed out and not available to select. Select any you wish to import and proceed.

Referencing Blazegraph Artifacts with Other Projects in the Workspace

In many cases, it is desirable to have all of the source artifacts open in a single workspace with other projects. In this case, once you have imported the blazegraph maven artifacts into a workspace to have other non-Blazegraph artifacts reference the workspace versions (rather than the maven repository snapshots), pass the eclipse.workspace parameter to the Maven Eclipse plugin.

mvn eclipse:eclipse -Declipse.workspace=/path/to/your/workspace

This will resolve any maven dependencies present in the workspace rather than to the maven repository. Note that the files for the projects do not have to be present at the workspace location. Maven will use the Eclipse workspace metadata to resolve the actual locations on the filesystem.

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

CI Build Failures Due to Dependencies

When a Pull Request is issued from GitHub, it should build the branch and trigger a deployment of a snapshot. Occasionally, there is a dependency version issue across repositories and artifacts. When this happens, you can deploy manually by issuing:

./scripts/mavenDeploy.sh

from the root of the repository.

Common Problems

I just pushed a new artifact and the build is broken in CI or for others.

The new artifact may not be deployed. Try forcing a deployment MavenNotes#CI_Build_Failures_Due_to_Dependencies.

It may also be that the deployment is failing due to unit test failures. While it is best to fix the unit tests, you may also force a deployment by using the -Dmaven.skip.tests=true.

mvn deploy -Dmaven.skip.tests=true

I just updated a project and it's broken in Eclipse.

There may have been a new artifact or dependency added. See MavenNotes#Updating_Eclipse_with_a_New_Branch_or_When_New_Artifacts_are_Added.

I just don't like maven.

You're not alone.

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

You can also create a snapshot version. See MavenNotes#Creating_a_Snapshot_Build.

Maven Background and Help

How to create a new maven project

See Maven in 5 minutes

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