Skip to content

Latest commit

 

History

History
249 lines (203 loc) · 16.4 KB

README.md

File metadata and controls

249 lines (203 loc) · 16.4 KB
Raw

eXo Docker Images for CI

Docker Stars - Docker Pulls Build & publish eXo CI images

The aim of this repository is to give the configuration to build all eXo Platform components in Docker containers for Development and Continous Integration purpose.

It contains Dockerfiles, Tests and configuration for the following CI Images:

Image JDK Python GCC Build tool Tests
exoplatform/ci:base n/a 2.7 & 3 5.4 n/a goss.yaml
exoplatform/ci:base-alpine n/a 2.7 & 3 13.2 n/a goss.yaml
exoplatform/ci:base-ubuntu20 n/a 2.7 & 3 9.4 n/a goss.yaml
exoplatform/ci:base-ubuntu22 n/a 2.7 & 3 11.4 n/a goss.yaml
exoplatform/ci:base-ubuntu24 n/a 3 13.2 n/a goss.yaml
exoplatform/ci:jdk6 1.6.0_45 2.7 & 3 5.4 n/a goss.yaml
exoplatform/ci:jdk7 1.7.0_80 2.7 & 3 5.4 n/a goss.yaml
exoplatform/ci:jdk8 8.0.432 2.7 & 3 5.4 n/a goss.yaml
exoplatform/ci:jdk11 11.0.25 2.7 & 3 5.4 n/a goss.yaml
exoplatform/ci:jdk17 17.0.13 2.7 & 3 5.4 n/a goss.yaml
exoplatform/ci:jdk17-alpine 17.0.13 2.7 & 3 13.2 n/a goss.yaml
exoplatform/ci:jdk17-ubuntu20 17.0.13 2.7 & 3 9.4 n/a goss.yaml
exoplatform/ci:jdk21-ubuntu20 21.0.5 2.7 & 3 9.4 n/a goss.yaml
exoplatform/ci:jdk21-ubuntu22 21.0.5 2.7 & 3 11.4 n/a goss.yaml
exoplatform/ci:jdk8-gradle2 1.8.0_202 2.7 & 3 5.4 Gradle 2.14 goss.yaml
exoplatform/ci:jdk8-gradle2-android 1.8.0_202 2.7 & 3 5.4 Gradle 2.14 / Android 23/24 goss.yaml
exoplatform/ci:jdk8-gradle4 8.0.432 2.7 & 3 5.4 Gradle 4.1 goss.yaml
exoplatform/ci:jdk8-gradle4-android 8.0.432 2.7 & 3 5.4 Gradle 4.1 / Android 23/24/25/26/27 goss.yaml
exoplatform/ci:jdk8-gradle6 8.0.432 2.7 & 3 5.4 Gradle 6.1 goss.yaml
exoplatform/ci:jdk8-gradle6-android 8.0.432 2.7 & 3 5.4 Gradle 6.1 / Android 23/24/25/26/27 goss.yaml
exoplatform/ci:jdk17-gradle8 17.0.13 2.7 & 3 11.4 Gradle 8.7 goss.yaml
exoplatform/ci:jdk17-gradle8-android 17.0.13 2.7 & 3 11.4 Gradle 8.7 / Android 23/24/25/26/27/28/29/33 goss.yaml
exoplatform/ci:jdk6-maven30 1.6.0_45 2.7 & 3 5.4 Maven 3.0.5 goss.yaml
exoplatform/ci:jdk6-maven32 1.6.0_45 2.7 & 3 5.4 Maven 3.2.5 goss.yaml
exoplatform/ci:jdk7-maven30 1.7.0_80 2.7 & 3 5.4 Maven 3.0.5 goss.yaml
exoplatform/ci:jdk7-maven32 1.7.0_80 2.7 & 3 5.4 Maven 3.2.5 goss.yaml
exoplatform/ci:jdk8-maven30 8.0.432 2.7 & 3 5.4 Maven 3.0.5 goss.yaml
exoplatform/ci:jdk8-maven32 8.0.432 2.7 & 3 5.4 Maven 3.2.5 goss.yaml
exoplatform/ci:jdk8-maven33 8.0.432 2.7 & 3 5.4 Maven 3.3.9 goss.yaml
exoplatform/ci:jdk8-maven35 8.0.432 2.7 & 3 5.4 Maven 3.5.4 goss.yaml
exoplatform/ci:jdk11-maven32 11.0.25 2.7 & 3 5.4 Maven 3.2.5 goss.yaml
exoplatform/ci:jdk11-maven33 11.0.25 2.7 & 3 5.4 Maven 3.3.9 goss.yaml
exoplatform/ci:jdk11-maven35 11.0.25 2.7 & 3 5.4 Maven 3.5.4 goss.yaml
exoplatform/ci:jdk11-maven36 11.0.25 2.7 & 3 5.4 Maven 3.6.3 goss.yaml
exoplatform/ci:jdk11-maven38 11.0.25 2.7 & 3 5.4 Maven 3.8.8 goss.yaml
exoplatform/ci:jdk11-mavend08 11.0.25 2.7 & 3 5.4 Mavend 0.8.2 goss.yaml
exoplatform/ci:jdk17-maven36 17.0.13 2.7 & 3 5.4 Maven 3.6.3 goss.yaml
exoplatform/ci:jdk17-maven38 17.0.13 2.7 & 3 5.4 Maven 3.8.8 goss.yaml
exoplatform/ci:jdk17-mavend08 17.0.13 2.7 & 3 5.4 Mavend 0.8.2 goss.yaml
exoplatform/ci:jdk17-mavend09 17.0.13 2.7 & 3 5.4 Mavend 0.9.0 goss.yaml
exoplatform/ci:jdk17-maven39 17.0.13 2.7 & 3 5.4 Maven 3.9.9 goss.yaml
exoplatform/ci:jdk17-maven39-alpine 17.0.13 2.7 & 3 13.2 Maven 3.9.9 goss.yaml
exoplatform/ci:jdk17-maven39-ubuntu20 17.0.13 2.7 & 3 9.4 Maven 3.9.9 goss.yaml
exoplatform/ci:jdk17-maven39-ubuntu22 17.0.13 2.7 & 3 11.4 Maven 3.9.9 goss.yaml
exoplatform/ci:jdk17-maven39-ubuntu24 17.0.13 3 13.2 Maven 3.9.9 goss.yaml
exoplatform/ci:jdk17-maven40-ubuntu22 17.0.13 2.7 & 3 11.4 Maven 4.0.0-beta-5 goss.yaml
exoplatform/ci:jdk21-maven39-ubuntu20 21.0.5 2.7 & 3 9.4 Maven 3.9.9 goss.yaml
exoplatform/ci:jdk21-maven39-ubuntu22 21.0.5 2.7 & 3 11.4 Maven 3.9.9 goss.yaml
exoplatform/ci:jdk21-maven39-ubuntu24 21.0.5 3 13.2 Maven 3.9.9 goss.yaml
exoplatform/ci:jdk21-maven40-ubuntu22 21.0.5 2.7 & 3 11.4 Maven 4.0.0-beta-5 goss.yaml

Overview

This diagram show an overview of the inheritance in eXo CI Docker images:

Image of Yaktocat

How to execute tests

To run tests, you have to install dgoss

You can build and test all images by running the script:

$ ./test_all_images.sh

If you want to execute test on a specific Docker image:

$ cd maven/jdk7-maven32/tests
$ ./test_image.sh

INFO: Starting docker container
INFO: Container ID: 59897f6f
INFO: Sleeping for 0.2
INFO: Running Tests
Title: Validating the presence of eXo GLOBAL settings file
File: /usr/share/maven/conf/settings.xml: exists: matches expectation: [true]
Title: Validating the presence Maven repository folder
File: /home/ciagent/.m2/repository: exists: matches expectation: [true]
Title: Validating the absence of eXo USER settings file
File: /home/ciagent/.m2/settings.xml: exists: matches expectation: [false]
Title: Check that git is installed
Package: git: installed: matches expectation: [true]
Command: mvn --version: exit-status: matches expectation: [0]
Command: mvn --version: stdout: matches expectation: [3.2.5 1.7.0 Default locale: en_US, platform encoding: UTF-8]


Total Duration: 0.650s
Count: 6, Failed: 0, Skipped: 0
INFO: Deleting container

real    0m2.929s
user    0m0.064s
sys     0m0.288s

How to use a eXo CI Docker Image

Basic Example with JDK7 - Maven 3.0

$ cd my-project
$ docker run --name=my-project-build -it -v $(pwd):/srv/ciagent/workspace \
     -v ~/.m2/repository:/home/ciagent/.m2/repository \
     -v ~/.m2/settings.xml:/home/ciagent/.m2/settings.xml \
     exoplatform/ci:jdk7-maven30 clean package

Advanced example with JDK8 - Maven 3.2 and Release Profile

$ cd my-project
$ docker run --name=my-project-build -it -v $(pwd):/srv/ciagent/workspace \
     -v ~/.m2/repository:/home/ciagent/.m2/repository \
     -v ~/.m2/settings.xml:/home/ciagent/.m2/settings.xml \
     -v ~/.gnupg/pubring.gpg:/home/ciagent/.gnupg/pubring.gpg:ro \
     -v ~/.gnupg/secring.gpg:/home/ciagent/.gnupg/secring.gpg:ro \
     -v ~/.gnupg/gpg.conf:/home/ciagent/.gnupg/gpg.conf:ro \
     exoplatform/ci:jdk8-maven32 install -Prelease

How to use eXo Puppet Docker Image

$ cd my-project
$ docker run --name puppet-validation -it -v ${PWD}:/srv/ciagent/workspace \
      exoplatform/ci:puppet

You can specify the -u option to force the modules update via r10k Example :

$ docker run --name puppet-validation -it -v ${PWD}:/srv/ciagent/workspace \
      exoplatform/ci:puppet -u

XMLStarlet

XMLStarlet is a set of command line utilities (tools) which can be used to transform, query, validate, and edit XML documents and files using simple set of shell commands in similar way it is done for plain text files using UNIX grep, sed, awk, diff, patch, join, etc commands.

At eXo, we use it to update Maven POM XML files for FB and Translation process.

examples:

$ cd /tmp/xmlstarlet
$ wget https://raw.githubusercontent.com/exoplatform/maven-parent-pom/develop/pom.xml
$ docker run -it --rm --name=xmlstartlet  -v $(pwd):/srv/ciagent/workspace --entrypoint=/bin/bash  exoplatform/ci:jdk8-maven32

# Update POM version from X-SNAPSHOT to X-translation-SNAPSHOT
ciagent@b32b684a1d6b:/srv/ciagent/workspace$ xmlstarlet ed --inplace -N pom=http://maven.apache.org/POM/4.0.0 \
  -u '/pom:project/pom:version[contains(text(), "-SNAPSHOT")]' \
  -x "concat(substring-before(.,'-SNAPSHOT'), '-translation-SNAPSHOT')" \
  pom.xml

# Update all POMs files in a Maven reactor project
ciagent@b32b684a1d6b:/srv/ciagent/workspace$ find . -name pom.xml | xargs -t -n 1 xmlstarlet ed -P --inplace -N pom=http://maven.apache.org/POM/4.0.0 -u '/pom:project/pom:version[contains(text(), "-SNAPSHOT")]' -x "concat(substring-before(.,'-SNAPSHOT'), '-translation-SNAPSHOT')"

Developer configuration

Configure your .bash_profile

In order to quickly run build with different stack (Maven and JDK), you can configure your .bash_profile file with the following alias:

#!/bin/bash
# Run Maven commands in Containers

c-mvn(){
      mvnInContainer "exoplatform/ci:jdk21-maven39-ubuntu20" "$@"
}
jdk17mvn39 (){
      mvnInContainer "exoplatform/ci:jdk17-maven39-ubuntu20" "$@"
}
jdk17mvn38(){
      mvnInContainer "exoplatform/ci:jdk17-maven38" "$@"
}

jdk11mvn38(){
      mvnInContainer "exoplatform/ci:jdk11-maven38" "$@"
}

jdk8mvn35(){
      mvnInContainer "exoplatform/ci:jdk8-maven35" "$@"
}

jdk7mvn32(){
      mvnInContainer "exoplatform/ci:jdk7-maven32" "$@"
}

# Run Maven commands in a container
mvnInContainer(){
      local dockerImage=$1

      docker run --rm \
        -u $(id -u):$(id -g) \
        -v $(pwd):/srv/ciagent/workspace \
        -v ~/.m2/repository:/home/ciagent/.m2/repository \
        -v ~/.m2/settings.xml:/home/ciagent/.m2/settings.xml \
        -v ~/.m2/settings-security.xml:/home/ciagent/.m2/settings-security.xml \
        -v /tmp:/srv/ciagent/tmp \
        --workdir /srv/ciagent/workspace \
        ${dockerImage} "${@:2}"
}
puppet_validate(){
docker run --name puppet-validation -it -v ${PWD}:/srv/ciagent/workspace \
      exoplatform/ci:puppet $*
}

Build with the right configuration

$ source ~/.bash_profile
$ cd my-project
$ jdk8mvn32 clean package