Skip to content

Latest commit

 

History

History
159 lines (101 loc) · 5.02 KB

BUILDING.md

File metadata and controls

159 lines (101 loc) · 5.02 KB
Raw

Building dCache

Requirements

To build dCache, you need Maven 3.5.0 or newer and Java-17 for building. Running the resulting binaries on newer JDKs should be possible.

Building

dCache uses Maven as a build system and as a repository of Maven artifacts. A top level aggregator project allows all Maven modules to be built in one operation:

mvn package

Generated artifacts are to be found in the target directories inside each component.

Specific modules can be build using the -am and -pl options of Maven, e.g.:

mvn package -am -pl packages/tar

will build the packages/tar module and all modules required by packages/tar.

It is not possible to cd into a subdirectory and execute Maven on a single module only. Such an attempt would fail because internal dependencies cannot be found in any Maven repository. Instead Maven must be invoked on the top-level aggregator project with the appropriate options to compile specific modules.

All generated files can be removed through the clean phase:

mvn clean

This phase can also be combined with other phases, e.g.:

mvn clean package

Packaging dCache

RPM and DEB packages can be build by compiling the packages/fhs module with the rpm and deb profiles, respectively, i.e.:

mvn clean package -am -pl packages/fhs -P rpm

or

mvn clean package -am -pl packages/fhs -P deb

The two profiles must not be invoked in the same run.

Note that the platform native RPM and DEB build tools must be installed. For building RPMs on both CentOS and Debian platforms, installing the rpm and rpmbuild packages suffices. For building DEBs on Debian or Ubuntu platforms, the dpkg-dev, debhelper, bash-completion, sh-make, quilt, and fakeroot packages must be installed.

The package revision number can be customized by defining the build.number property, e.g.:

mvn clean package -am -pl packages/fhs -P deb -Dbuild.number=2

RPM packages of the srmclient can be created by running the package phase with the rpm profile on modules/srm-client module, i.e.:

mvn clean package -am -pl modules/srm-client -P rpm

DEB packages have not been defined for srmclient.

The generated packages can be found in the target directory of the respectively module. RPMs are in the RPMS subdirectory.

The dCache tarball package is build by packaging the packages/tar module:

mvn clean package -am -pl modules/tar

Building a docker image

Building a container image is disabled by default. This is because it requires a running docker deployment, which not all developers have installed.

You may enable building of docker images by activating the container profile for the tar packaging:

mvn clean package -am -pl packages/tar -P container

The system-test module

The packages/system-test module generates a ready-to-run single domain dCache instance suitable for testing. It is configured to use an embedded database and thus to run without postgresql. To build it simply run:

mvn clean package -am -pl packages/system-test

You will need to install OpenSsl toolkit and the patch utility for it to succeed. This entails a completely self-contained dCache instance in packages/system-test/target/dcache. It can be started using:

packages/system-test/target/bin/ctlcluster start

Next .

To use GSI and TLS protocols, you may have to copy the test CA certificates into your /etc/grid-security/certificates/ directory. Follow the instructions shown at the end of the build.

A test script is provided in packages/system-test/target/bin/test to execute various test transfers. This script is not intended for automatic testing. It requires that various grid-related tools are available on the host.

An interactive database console for the embedded database can be started using

packages/system-test/target/bin/hsqldb DATABASE

where DATABASE is the database to inspect, usually a service name, eg. space manager or pin manager. The embedded database is single process, and thus the console can only be started if dCache is not running.

Multiple versions of dCache can be tested for compatibility by installing older versions using

packages/system-test/target/bin/ctlcluster install VERSION

This will download a tarball release of that version and install it in packages/system-test/target. The ctlcluster utility can be used to control all versions at once. Using the switch subcommand, particular services can be moved between versions, e.g.

packages/system-test/target/bin/ctlcluster switch pool.name=pool_write 2.7.5

will move the pool_write pool to version 2.7.5. The utility can however not compensate for changes in configuration properties or database schemas between versions. Such incompatibilities have to be resolved manually.

Unit tests

By default, Maven executes all unit tests while building. This can be time consuming and will fail if no internet connection is available. The unit tests can be disabled by appending the -DskipTests option to any mvn command.