Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

APACHEDS & Apache Fortress QUICKSTART on DOCKER

Table of Contents

  • Document Overview
  • SECTION 1. Prerequisites
  • SECTION 2. APACHEDS Docker Image
  • SECTION 3. Apache Fortress Setup
  • SECTION 4. Apache Fortress Core Integration Test
  • SECTION 5. Docker Command Reference

Document Overview

SECTION 1. Prerequisites

Minimum software requirements:

  • Linux Machine with docker-engine
  • Java SDK >= 11
  • Apache Maven >= 3

SECTION 2. ApacheDS Docker Image

  1. Get the Apache Fortress Core package:

a. clone git latest:

git clone https://gitbox.apache.org/repos/asf/directory-fortress-core.git
cd directory-fortress-core

b. or clone git release:

git clone --branch [version]  https://gitbox.apache.org/repos/asf/directory-fortress-core.git
cd directory-fortress-core

c. or download source package from Apache:

wget https://www.apache.org/dist/directory/fortress/dist/[version]/fortress-core-[version]-source-release.zip
unzip fortress-core-[version]-source-release.zip
cd fortress-core-[version]
  1. Prepare the ApacheDS docker image

a. build the ApacheDS docker image (trailing dot matters):

docker build -t apachedirectory/apacheds-for-apache-fortress-tests -f src/docker/apacheds-for-apache-fortress-tests/Dockerfile .

b. or pull the latest prebuilt image from Dockerhub:

docker pull apachedirectory/apacheds-for-apache-fortress-tests
  1. Run the ApacheDS docker image:
docker run --name=apacheds -d -p 10389:10389 -P apachedirectory/apacheds-for-apache-fortress-tests
  • Here we‘re mapping the internal port for running image to what the host machine uses, w/ apacheds’ default of 10389
  • Setting name=apacheds for managing image.
  1. Verify the image started successfully:
root@localhost:/opt/fortress/directory-fortress-core# docker ps
CONTAINER ID   IMAGE                                                COMMAND                  CREATED          STATUS          PORTS                                           NAMES
7df7ab967737   apachedirectory/apacheds-for-apache-fortress-tests   "sh -c 'service ${AP…"   10 minutes ago   Up 10 minutes   0.0.0.0:10389->10389/tcp, :::10389->10389/tcp   apacheds
  1. Manage ApacheDS Image:

a. start

docker run --name=apacheds -d -p 10389:10389 -P apachedirectory/apacheds-for-apache-fortress-tests

b. stop

docker stop apacheds

c. remove

docker rm apacheds

d. view the logs

docker logs apacheds

e. inspect

docker inspect apacheds

f. connect via bash

docker exec -it apacheds bash

SECTION 3. Apache Fortress Setup

  1. Prepare your terminal for execution of maven commands.
#!/bin/bash
export M2_HOME=...
export JAVA_HOME=...
export PATH=$PATH:$M2_HOME/bin
  1. Prepare the package:
cp build.properties.example build.properties
  • Seeds the fortress properties with defaults for ApacheDS usage.
  • build.properties.example contains the default config for the apacheds docker image.
  • Learn how the fortress config subsystem works: README-CONFIG.
  1. Run the maven install to build fortress and initialize config settings:
mvn clean install

SECTION 4. Apache Fortress Core Integration Test

  1. From fortress core base folder, enter the following commands:

    a. To use the config from earlier:

mvn install -Dload.file=./ldap/setup/refreshLDAPData.xml
  1. Next, enter the following command:
mvn -Dtest=FortressJUnitTest test

More about this step:

  • Tests the APIs against your LDAP server.
  1. Verify the tests worked:
NUMBER OF ADDS: 1146
NUMBER OF BINDS: 1130
NUMBER OF DELETES: 0
NUMBER OF MODS: 4247
NUMBER OF READS: 20176
NUMBER OF SEARCHES: 7045
Tests run: 128, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 335.906 sec - in org.apache.directory.fortress.core.impl.FortressJUnitTest
Results :
Tests run: 128, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[INFO] --- maven-antrun-plugin:1.8:run (fortress-load) @ fortress-core ---
[INFO] Executing tasks
fortress-load:
[INFO] Executed tasks
[INFO] 
[INFO] --- maven-antrun-plugin:1.8:run (fortress-load-debug) @ fortress-core ---
[INFO] Executing tasks
fortress-load-debug:
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  05:58 min
[INFO] Finished at: 2022-01-02T15:23:11Z
[INFO] ------------------------------------------------------------------------
  1. Rerun the tests to verify teardown APIs work:
mvn -Dtest=FortressJUnitTest test
  1. Verify that worked also:
NUMBER OF ADDS: 993
NUMBER OF BINDS: 1130
NUMBER OF DELETES: 1355
NUMBER OF MODS: 8389
NUMBER OF READS: 27331
NUMBER OF SEARCHES: 9582
Tests run: 162, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 378.525 sec - in org.apache.directory.fortress.core.impl.FortressJUnitTest
Results :
Tests run: 162, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[INFO] --- maven-antrun-plugin:1.8:run (fortress-load) @ fortress-core ---
[INFO] Executing tasks
fortress-load:
[INFO] Executed tasks
[INFO] 
[INFO] --- maven-antrun-plugin:1.8:run (fortress-load-debug) @ fortress-core ---
[INFO] Executing tasks
fortress-load-debug:
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  06:43 min
[INFO] Finished at: 2022-01-02T15:30:15Z
[INFO] ------------------------------------------------------------------------
  • More tests ran this time vs the first time, due to teardown.

Test Notes:

  • If tests complete without errors, Apache Fortress works with ApacheDS server running in Docker image.
  • These tests load thousands of objects into the target ldap server.
  • Warning messages are negative tests in action.
  1. Optional sections in the README file:
  • SECTION 11. Instructions to run the Apache Fortress Command Line Interpreter (CLI).
  • SECTION 12. Instructions to run the Apache Fortress Command Console.
  • SECTION 13. Instructions to build and test the Apache Fortress samples.
  • SECTION 14. Instructions to performance test.

SECTION 5. Docker Command Reference

Here are some common commands needed to manage the Docker image.

Build image

docker build -t apachedirectory/apacheds-for-apache-fortress-tests -f src/docker/apacheds-for-apache-fortress-tests/Dockerfile .
  • trailing dot matters

Or just to be sure don't use cached layers:

docker build --no-cache=true -t apachedirectory/apacheds-for-apache-fortress-tests -f src/docker/apacheds-for-apache-fortress-tests/Dockerfile .

Run container

docker run --name=apacheds -d -p 10389:10389 -P apachedirectory/apacheds-for-apache-fortress-tests

Go into the container

docker exec -it apacheds bash

Restart container

docker restart apacheds

Stop and delete container

docker stop apacheds
docker rm apacheds

END OF README-QUICKSTART-DOCKER-APACHEDS