El entorno de compilación

Obtenga información sobre el entorno de compilación especializado que los usuarios de Cloud Manager crean y prueban su código.

Detalles del entorno

Los entornos de compilación de Cloud Manager tienen los atributos siguientes.

  • El entorno de compilación está basado en Linux, derivado de Ubuntu 18.04.
  • Apache Maven 3.6.0 está instalado.
  • Las versiones de Java instaladas son Oracle JDK 8u202 y Oracle JDK 11.0.2.
  • De forma predeterminada, la variable JAVA_HOME la variable de entorno está configurada en /usr/lib/jvm/jdk1.8.0_202 que contiene el Oracle JDK 8u202. Consulte la sección Versión JDK de ejecución de Maven alternativa para obtener más información.
  • Hay algunos paquetes de sistema adicionales instalados que son necesarios.
    • bzip2
    • unzip
    • libpng
    • imagemagick
    • graphicsmagick
  • Se pueden instalar otros paquetes en el momento de la compilación, tal como se describe en la sección Instalación de paquetes de sistema adicionales.
  • Cada compilación se realiza en un entorno prístino. El contenedor de compilación no mantiene ningún estado entre ejecuciones.
  • Maven siempre se ejecuta con estos tres comandos:
    • mvn --batch-mode org.apache.maven.plugins:maven-dependency-plugin:3.1.2:resolve-plugins
    • mvn --batch-mode org.apache.maven.plugins:maven-clean-plugin:3.1.0:clean -Dmaven.clean.failOnError=false
    • mvn --batch-mode org.jacoco:jacoco-maven-plugin:prepare-agent package
  • Maven se configura a nivel de sistema con un settings.xml archivo que incluye automáticamente el repositorio de artefactos de Adobe público con un perfil denominado adobe-public.
NOTA

Aunque Cloud Manager no define una versión específica de la variable jacoco-maven-plugin, la versión utilizada debe ser al menos 0.7.5.201505241946.

SUGERENCIA

Consulte los siguientes recursos adicionales para aprender a utilizar las API de Cloud Manager:

Uso de una versión de Java específica

De forma predeterminada, los proyectos se crean mediante el proceso de compilación de Cloud Manager con el JDK de Oracle 8. Los clientes que deseen utilizar un JDK alternativo tienen dos opciones.

Cadenas de herramientas de Maven

La variable Complemento Maven Toolchain permite a los proyectos seleccionar un JDK específico (o toolchain) para utilizarlo en el contexto de complementos Maven con conocimiento de herramientas. Esto se hace en el pom.xml especificando un valor de proveedor y de versión. Una sección de muestra de la sección pom.xml es:

        <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-toolchains-plugin</artifactId>
    <version>1.1</version>
    <executions>
        <execution>
            <goals>
                <goal>toolchain</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <toolchains>
            <jdk>
                <version>11</version>
                <vendor>oracle</vendor>
            </jdk>
        </toolchains>
    </configuration>
</plugin>

Esto hará que todos los plugins Maven con conocimiento de herramientas utilicen el Oracle JDK, versión 11.

Al utilizar este método, el propio Maven sigue ejecutándose utilizando el JDK predeterminado (Oracle 8) y el JAVA_HOME no cambia. Por lo tanto, compruebe o aplique la versión de Java a través de complementos como el Complemento Apache Maven Enforcer no funciona y estos complementos no deben usarse.

Las combinaciones de proveedor/versión disponibles actualmente son:

Proveedor Versión
oracle 1,8
oracle 1,11
oracle 11
sun 1,8
sun 1,11
sun 11
NOTA

A partir de abril de 2022, Oracle JDK será el JDK predeterminado para el desarrollo y funcionamiento de aplicaciones AEM. El proceso de creación de Cloud Manager cambiará automáticamente a utilizar el JDK de Oracle, incluso si se selecciona explícitamente una opción alternativa en la cadena de herramientas de Maven. Consulte las notas de la versión de abril para obtener más información.

Versión JDK de ejecución de Maven alternativa

También es posible seleccionar Oracle 8 o Oracle 11 como JDK para toda la ejecución de Maven. A diferencia de las opciones de toolchain, esto cambia el JDK utilizado para todos los plugins a menos que también se establezca la configuración de toolchain en cuyo caso la configuración de toolchain se sigue aplicando a los plugins Maven según las cadenas de herramientas. Como resultado, comprobar y aplicar la versión de Java utilizando la variable Complemento Apache Maven Enforcer funcionará.

Para ello, cree un archivo con el nombre .cloudmanager/java-version en la rama del repositorio de git utilizada por la canalización. Este archivo puede tener el contenido 11 o 8. Se ignora cualquier otro valor. If 11 se especifica, se utiliza el Oracle 11 y la variable JAVA_HOME la variable de entorno está configurada en /usr/lib/jvm/jdk-11.0.2. If 8 se especifica, se utiliza el Oracle 8 y la variable JAVA_HOME la variable de entorno está configurada en /usr/lib/jvm/jdk1.8.0_202.

Variables de entorno

Variables de entorno estándar

En algunos casos, es posible que necesite variar el proceso de compilación en función de la información sobre el programa o la canalización.

Por ejemplo, si la minificación de JavaScript en tiempo de compilación se realiza a través de una herramienta como gulp, puede haber un deseo de utilizar un nivel de minificación diferente al crear para un entorno de desarrollo en lugar de construir para ensayo y producción.

Para admitir esto, Cloud Manager agrega variables de entorno estándar al contenedor de compilación para cada ejecución.

Nombre de la variable Descripción
CM_BUILD Siempre se configura como true
BRANCH La rama configurada para la ejecución
CM_PIPELINE_ID El identificador numérico de la canalización
CM_PIPELINE_NAME El nombre de la canalización
CM_PROGRAM_ID Identificador numérico del programa
CM_PROGRAM_NAME El nombre del programa
ARTIFACTS_VERSION Para una canalización de ensayo o producción, la versión sintética generada por Cloud Manager

Variables de canalización

En algunos casos, el proceso de compilación puede depender de variables de configuración específicas que no deberían colocarse en el repositorio de Git o deberían variar entre las ejecuciones de canalización que utilizan la misma rama.

Cloud Manager permite que estas variables se configuren mediante la API de Cloud Manager o la CLI de Cloud Manager por canalización. Las variables pueden almacenarse como texto sin formato o cifrarse en reposo. En cualquier caso, las variables están disponibles dentro del entorno de compilación como una variable de entorno a la que se puede hacer referencia desde dentro del pom.xml archivo u otras secuencias de comandos de compilación.

Para configurar una variable usando la CLI, ejecute un comando similar al siguiente.

$ aio cloudmanager:set-pipeline-variables PIPELINEID --variable MY_CUSTOM_VARIABLE test

Las variables actuales se pueden listar usando un comando similar al siguiente.

$ aio cloudmanager:list-pipeline-variables PIPELINEID

Las variables deben cumplir ciertas limitaciones.

  • Los nombres de las variables solo pueden contener caracteres alfanuméricos y el guión bajo (_).
    • Por convención, los nombres deberían estar en mayúsculas.
  • Hay un límite de 200 variables por canalización.
  • Cada nombre debe tener menos de 100 caracteres.
  • Cada valor de cadena debe tener menos de 2048 caracteres.
  • Cada valor secretString debe tener menos de y 500 caracteres.

Cuando se utiliza dentro de un Maven pom.xml , normalmente resulta útil asignar estas variables a las propiedades de Maven mediante una sintaxis similar a la siguiente.

        <profile>
            <id>cmBuild</id>
            <activation>
                <property>
                    <name>env.CM_BUILD</name>
                </property>
            </activation>
            <properties>
                <my.custom.property>${env.MY_CUSTOM_VARIABLE}</my.custom.property>
            </properties>
        </profile>

Instalación de paquetes de sistema adicionales

Para funcionar completamente, algunas compilaciones requieren que se instalen paquetes de sistema adicionales. Por ejemplo, una compilación puede invocar un script Python o Ruby y, como resultado, necesita tener instalado un intérprete de idioma adecuado. Esto se puede hacer llamando a la función exec-maven-plugin para invocar APT. Esta ejecución debe envolverse generalmente en un perfil Maven específico de Cloud Manager. Por ejemplo, para instalar Python:

        <profile>
            <id>install-python</id>
            <activation>
                <property>
                        <name>env.CM_BUILD</name>
                </property>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.codehaus.mojo</groupId>
                        <artifactId>exec-maven-plugin</artifactId>
                        <version>1.6.0</version>
                        <executions>
                            <execution>
                                <id>apt-get-update</id>
                                <phase>validate</phase>
                                <goals>
                                    <goal>exec</goal>
                                </goals>
                                <configuration>
                                    <executable>apt-get</executable>
                                    <arguments>
                                        <argument>update</argument>
                                    </arguments>
                                </configuration>
                            </execution>
                            <execution>
                                <id>install-python</id>
                                <phase>validate</phase>
                                <goals>
                                    <goal>exec</goal>
                                </goals>
                                <configuration>
                                    <executable>apt-get</executable>
                                    <arguments>
                                        <argument>install</argument>
                                        <argument>-y</argument>
                                        <argument>--no-install-recommends</argument>
                                        <argument>python</argument>
                                    </arguments>
                                </configuration>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>

Esta misma técnica se puede utilizar para instalar paquetes específicos del idioma, es decir, utilizando gem para RubyGems o pip para paquetes Python.

NOTA

La instalación de un paquete del sistema de esta manera no lo instala en el entorno de tiempo de ejecución utilizado para ejecutar Adobe Experience Manager. Si necesita instalar un paquete del sistema en el entorno de AEM, póngase en contacto con su representante de Adobe.

En esta página