IBPCommons

Overview

The IBPCommons library contains the features common to projects developed by Digitalabs for GCP. It is used by BreedingManager, DatasetImporter, Fieldbook, GermplasmStudyBrowser, IBPWebService and IBPWorkbench.

Prerequisites

IBPCommons is dependent on Middleware. To build the Middleware project, run the following command in the IBPMiddleware directory:

    mvn clean install

To build using a specific configuration, run the following:

    mvn clean install -DenvConfig=dev-config-dir  

To Build

To build IBPCommons, run the following command in the IBPCommons directory:

    mvn clean install

To build using a specific configuration, run the following:

    mvn clean install -DenvConfig=dev-config-dir  

To build using Eclipse, right-click on the IBPCommons project, select Run As --> Maven build..., then input any of the following:

    clean install

    clean install -DenvConfig=dev-config-dir  

To Run Tests

To run JUnit tests using the command line, issue the following commands in the IBPCommons directory:

1. To run all tests:

   mvn clean test

2. To run a specific test class:

   mvn clean test -Dtest=TestClassName

3. To run a specific test function:

   mvn clean test -Dtest=TestClassName#testFunctionName

You need to specify the IBDB database to connect to in the testDatabaseConfig.properties file.

All JUnit test suites require the rice database, except for GenotypicDataManager that uses the groundnut crop in testing.

Similar to building IBPCommons, add the -DenvConfig parameter to use a specific configuration.

To run JUnit tests using Eclipse, right-click on the specific JUnit test suite in the IBPCommons project, select Run As --> JUnit test.

To Use

To add IBPCommons as a dependency to your project using Apache Maven, add the following to your list of dependencies:

    groupId: org.generationcp
    artifactId: ibpcommons
    version: 1.3.0

Take note of the version. Use of the latest version is recommended.

Checking out the IBPCommons Project

The project is stored in the GIT repository hosted at github.com. The URL for the repository is:

    https://github.com/digitalabs/IBPCommons   

An anonymous account may be used to checkout the project.

No username and password is required. You can also browse the content of the repository using the same URL.