You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sm...@apache.org on 2016/12/07 15:23:10 UTC
directory-fortress-core git commit: FC-202 - docker-test to use
latest slapd install procs
Repository: directory-fortress-core
Updated Branches:
refs/heads/master 40eb3b9c9 -> 58b94f972
FC-202 - docker-test to use latest slapd install procs
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/58b94f97
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/58b94f97
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/58b94f97
Branch: refs/heads/master
Commit: 58b94f97242a10db26b0324b026be8f4dcd1a33e
Parents: 40eb3b9
Author: Shawn McKinney <sm...@apache.org>
Authored: Wed Dec 7 09:23:08 2016 -0600
Committer: Shawn McKinney <sm...@apache.org>
Committed: Wed Dec 7 09:23:08 2016 -0600
----------------------------------------------------------------------
README-QUICKSTART-DOCKER-SLAPD.md | 265 +++++++++++++++++++++++++++++++++
1 file changed, 265 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/58b94f97/README-QUICKSTART-DOCKER-SLAPD.md
----------------------------------------------------------------------
diff --git a/README-QUICKSTART-DOCKER-SLAPD.md b/README-QUICKSTART-DOCKER-SLAPD.md
new file mode 100644
index 0000000..ba11830
--- /dev/null
+++ b/README-QUICKSTART-DOCKER-SLAPD.md
@@ -0,0 +1,265 @@
+
+ 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
+
+ http://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.
+
+# OpenLDAP & Fortress QUICKSTART on DOCKER
+
+-------------------------------------------------------------------------------
+## Table of Contents
+
+ * Document Overview
+ * SECTION 1. Prerequisites
+ * SECTION 2. Apache Fortress Core Setup using OpenLDAP Docker Image
+ * SECTION 3. Apache Fortress Core Integration Test
+ * SECTION 4. Docker Commands
+___________________________________________________________________________________
+## Document Overview
+
+ * This document contains instructions to install Apache Fortress Core using OpenLDAP Docker image.
+ * It uses [openldap-for-apache-fortress-tests](src/docker/openldap-for-apache-fortress-tests/Dockerfile)
+
+-------------------------------------------------------------------------------
+## SECTION 1. Prerequisites
+
+Minimum hardware requirements:
+ * 2 Cores
+ * 4GB RAM
+
+Minimum software requirements:
+ * Centos or Debian Machine
+ * Java SDK 7++
+ * Apache Maven3++
+ * docker-engine
+
+___________________________________________________________________________________
+## SECTION 2. Apache Fortress Core Setup using OpenLDAP Docker Image
+
+1. Download the package:
+
+ a. from git:
+ ```
+ git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-core.git
+ cd directory-fortress-core
+ ```
+2. Run the docker build:
+ ```
+ docker build -t apachedirectory/openldap-for-apache-fortress-tests -f src/docker/openldap-for-apache-fortress-tests/Dockerfile .
+ ```
+
+ *note: trailing dot matters
+
+3. Run the docker container:
+ ```
+ CONTAINER_ID=$(docker run -d -P apachedirectory/openldap-for-apache-fortress-tests)
+ ```
+
+4. Run the docker container:
+ ```
+ CONTAINER_ID=$(docker run -d -P apachedirectory/openldap-for-apache-fortress-tests)
+ CONTAINER_PORT=$(docker inspect --format='{{(index (index .NetworkSettings.Ports "389/tcp") 0).HostPort}}' $CONTAINER_ID)
+ echo $CONTAINER_PORT
+ ```
+
+ *note: make note of the port as it's needed later
+ *depending on your docker setup may need to run as root or sudo priv's.
+
+5. Prepare the fortress package:
+
+ ```
+ cp build.properties.example build.properties
+ cp slapd.properties.example slapd.properties
+ ```
+
+6. Edit the *slapd.properties* file:
+
+ ```
+ vi slapd.properties
+ ```
+
+7. Update the *ldap.port* prop:
+
+ ```
+ ldap.port= port from earlier step
+ ```
+
+8. Save and exit
+
+9. Prepare your terminal for execution of maven commands.
+
+ ```
+ #!/bin/sh
+ export M2_HOME=...
+ export JAVA_HOME=...
+ export PATH=$PATH:$M2_HOME/bin
+ ```
+
+10. Run the maven install to build fortress lib and prepare its configuration (fortress.properties):
+
+ ```
+ mvn clean install
+ ```
+
+11. To start the slapd process (as root or sudo):
+
+ ```
+ mvn test -Pstart-slapd
+ ```
+
+11. To stop the slapd process (as root or sudo):
+
+ ```
+ mvn test -Pstop-slapd
+ ```
+
+___________________________________________________________________________________
+## SECTION 3. Apache Fortress Core Integration Test
+
+1. From fortress core base folder, enter the following commands:
+
+ ```
+ mvn install -Dload.file=./ldap/setup/refreshLDAPData.xml
+ mvn install -Dload.file=./ldap/setup/DelegatedAdminManagerLoad.xml
+ ```
+
+ *These will build the Directory Information Tree (DIT), create the config and data policies needed for the integration test to follow.*
+
+2. Next, enter the following command:
+
+ ```
+ mvn -Dtest=FortressJUnitTest test
+ ```
+
+ *Tests the APIs against your LDAP server.*
+
+3. Verify the tests worked:
+
+ ```
+ Tests run: 126, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 196 sec - in org.apache.directory.fortress.core.impl.FortressJUnitTest
+
+ Results :
+
+ Tests run: 126, Failures: 0, Errors: 0, Skipped: 0
+
+ [INFO]
+ [INFO] --- maven-antrun-plugin:1.8:run (default) @ fortress-core ---
+ [INFO] Executing tasks
+
+ fortress-load:
+ [INFO] Executed tasks
+ [INFO] ------------------------------------------------------------------------
+ [INFO] BUILD SUCCESS
+ [INFO] ------------------------------------------------------------------------
+ [INFO] Total time: 03:19 min
+ [INFO] Finished at: 2016-01-07T09:28:18-06:00
+ [INFO] Final Memory: 27M/532M
+ [INFO] ------------------------------------------------------------------------
+ ```
+
+4. Rerun the tests to verify teardown APIs work:
+
+ ```
+ mvn -Dtest=FortressJUnitTest test
+ ```
+
+5. Verify that worked also:
+
+ ```
+ Tests run: 158, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 207.081 sec - in org.apache.directory.fortress.core.impl.FortressJUnitTest
+
+ Results :
+
+ Tests run: 158, Failures: 0, Errors: 0, Skipped: 0
+
+ [INFO]
+ [INFO] --- maven-antrun-plugin:1.8:run (default) @ fortress-core ---
+ [INFO] Executing tasks
+
+ fortress-load:
+ [INFO] Executed tasks
+ [INFO] ------------------------------------------------------------------------
+ [INFO] BUILD SUCCESS
+ [INFO] ------------------------------------------------------------------------
+ [INFO] Total time: 03:30 min
+ [INFO] Finished at: 2016-01-07T09:33:11-06:00
+ [INFO] Final Memory: 27M/531M
+ [INFO] ------------------------------------------------------------------------
+ ```
+ Notice 141 tests ran this time vs 113 the first time.
+
+ Test Notes:
+ * If tests complete without errors Apache Fortress works with your OpenLDAP server.
+ * These tests load thousands of objects into the target ldap server.
+ * Warning messages are negative tests in action.
+
+6. Optional sections in the [README](README.md) 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 4. Docker Commands
+
+## Build image
+ ```
+ docker build -t apachedirectory/openldap-for-apache-fortress-tests -f src/docker/openldap-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/openldap-for-apache-fortress-tests -f src/docker/openldap-for-apache-fortress-tests/Dockerfile .
+ ```
+
+## Publish image to Docker Hub
+
+You need an account at <https://hub.docker.com> and join the `apachedirectory` team (ask Stefan).
+
+ ```
+ docker push apachedirectory/openldap-for-apache-fortress-tests:latest
+ ```
+
+## Run container
+
+ ```
+ CONTAINER_ID=$(docker run -d -P apachedirectory/openldap-for-apache-fortress-tests)
+ CONTAINER_PORT=$(docker inspect --format='{{(index (index .NetworkSettings.Ports "389/tcp") 0).HostPort}}' $CONTAINER_ID)
+ echo $CONTAINER_PORT
+ ```
+
+## Go into the container
+
+ ```
+ docker exec -it $CONTAINER_ID bash
+ ```
+
+## Restart container
+
+ ```
+ docker restart $CONTAINER_ID
+ ```
+
+## Stop and delete container
+
+ ```
+ docker stop $CONTAINER_ID
+ docker rm $CONTAINER_ID
+ ```
+____________________________________________________________________________________
+#### END OF README-QUICKSTART-DOCKER-SLAPD
\ No newline at end of file