Créer, tester et conteneuriser des applications Java

Cette page explique comment utiliser Cloud Build pour compiler, tester et conteneuriser des applications Java, importer vos images de conteneurs dans Artifact Registry et générer la provenance de compilation.

Avant de commencer

Utiliser l'image maven ou gradle

Vous pouvez configurer Cloud Build pour qu'il compile les applications Java à l'aide de l'image maven ou de l'image gradle de Docker Hub.

Pour exécuter vos tâches dans l'image maven ou gradle, spécifiez l'URL et la version avec tag de l'image dans le champ name de votre fichier de configuration de compilation. Si vous ne spécifiez pas le tag d'image, Cloud Build utilise par défaut l'image latest. Cloud Build démarre l'image spécifiée dans le champ name en utilisant le point d'entrée par défaut de l'image. Pour remplacer le point d'entrée par défaut et appeler plutôt maven ou gradle, spécifiez mvn ou gradle dans le champ entrypoint.

Le fichier de configuration de compilation ci-dessous spécifie le point d'entrée entrypoint de l'image maven ou gradle et affiche la version de l'outil de compilation :

maven 

  steps:
  - name: maven:3.3-jdk-8
    entrypoint: mvn
    args: ['--version']

gradle 

  steps:
  - name: gradle:5.6.2-jdk8
    entrypoint: gradle
    args: ['--version']

Configurer les compilations Java

  1. Dans le répertoire racine de votre projet, créez un fichier de configuration de compilation nommé cloudbuild.yaml.

  2. Exécuter des tests : maven et gradle fournissent respectivement les commandes maven test et gradle test, qui téléchargent les dépendances, compilent les applications et exécutent tous les tests spécifiés dans votre code source. Le champ args d'une étape de compilation prend une liste d'arguments et la transmet à l'image à laquelle le champ name fait référence.

    Dans votre fichier de configuration de compilation, ajoutez l'élément test au champ args pour appeler l'option test dans maven et gradle :

    maven 

     steps:
 - name: maven:3.3-jdk-8
   entrypoint: mvn
   args: ['test']

    gradle 

     steps:
 - name: gradle:5.6.2-jdk8
   entrypoint: gradle
   args: ['test']

  3. Empaqueter l'application : pour empaqueter votre application dans un fichier JAR pour votre image maven, spécifiez la commande package dans le champ args. La commande package génère un fichier JAR dans /workspace/target/.

    Pour empaqueter votre application dans un fichier JAR pour votre image gradle, spécifiez la commande assemble dans le champ args. La commande assemble génère un fichier JAR dans workspace/build/libs.

    L'étape de compilation suivante permet d'empaqueter votre application Java :

    maven 

     steps:
 - name: maven:3.3-jdk-8
   entrypoint: mvn
   args: ['package','-Dmaven.test.skip=true']

    gradle 

    steps:
- name: gradle:5.6.2-jdk8
  entrypoint: gradle
  args: ['assemble']

  4. Conteneuriser l'application: Cloud Build fournit une image Docker prédéfinie que vous pouvez utiliser pour conteneuriser votre application Java. Pour mettre votre application Java en conteneur, modifiez votre fichier de configuration de compilation comme suit :

    • Ajoutez un champ name et spécifiez l'image Docker prédéfinie à l'emplacement gcr.io/cloud-builders/docker.
    • Ajoutez un champ args et spécifiez les arguments build, y compris le nom de l'image de conteneur à compiler et le chemin d'accès à votre artefact de compilation.
    • Ajoutez un champ images pour transférer l'image de conteneur créée vers Artifact Registry et générer des informations de provenance de la compilation. Si vous n'utilisez pas le champ images, Cloud Build n'enregistrera pas d'informations de provenance. Par exemple, si vous utilisez une étape de compilation docker push pour importer des images dans Artifact Registry, votre build ne sera associé à aucune information de provenance.

    L'étape de compilation suivante conteneurise votre application, transfère votre image de conteneur vers Artifact Registry et génère des informations sur la provenance de la compilation.

    maven 

    steps:
- name: gcr.io/cloud-builders/docker
  args: ['build', '-t', 'location-docker.pkg.dev/project-id/repository/image', '--build-arg=JAR_FILE=target/build-artifact', '.']
images: ['location-docker.pkg.dev/project-id/repository/image']

    gradle 

    steps:
- name: gcr.io/cloud-builders/docker
  args: ['build', '-t', 'location-docker.pkg.dev/project-id/repository/image', '--build-arg=JAR_FILE=build/libs/build-artifact', '.']
images: ['location-docker.pkg.dev/project-id/repository/image']

    Où :

    • location: emplacement régional ou multirégional de votre dépôt.
    • project-id: ID de votre projet Google Cloud.
    • repository: nom de votre dépôt Artifact Registry.
    • image : nom de votre image de conteneur
    • build-artifact : nom du fichier JAR créé à l'étape de compilation

  5. Facultatif: Activer la provenance pour les builds régionaux

    Si vous utilisez une compilation régionale, ajoutez le champ requestedVerifyOption dans le options de votre fichier de configuration de compilation. Définissez la valeur sur VERIFIED pour permettre la génération des métadonnées de provenance. Si vous n'ajoutez pas requestedVerifyOption: VERIFIED, Cloud Build ne génère la provenance que pour les builds mondiaux.

    options:
  requestedVerifyOption: VERIFIED

  6. Démarrer la compilation : lorsque votre fichier de configuration de compilation est prêt, lancez votre compilation en saisissant la commande suivante dans votre terminal :

    gcloud builds submit --region=REGION --config config-file-path source-directory

    Où :

    • config-file-path: chemin d'accès à votre fichier de configuration de compilation. Dans cet exemple, le fichier de configuration de compilation s'appelle cloudbuild.yaml.
    • source-directory : chemin ou URL de votre code source
    • REGION: l'une des régions de compilation compatibles.

    Si vous ne spécifiez pas les éléments config-file-path et source-directory dans la commande gcloud builds submit, Cloud Build considère que le fichier de configuration et le code source se trouvent dans le répertoire de travail actuel.

    Une fois la compilation terminée, vous pouvez afficher les détails du dépôt dans Artifact Registry.

    Vous pouvez également afficher les métadonnées de provenance de la compilation et valider la provenance pour protéger votre chaîne d'approvisionnement logicielle.

Exemples de code

Voici quelques exemples de dépôts que vous pouvez utiliser pour créer des applications Java, chacun contenant un exemple d'application et un fichier de configuration de compilation permettant de compiler et tester cette application :

  • maven-example : une application Java et un exemple de fichier de configuration de compilation permettant de compiler et tester l'application avec mvn.
  • gradle-example : une application Java et un exemple de fichier de configuration de compilation permettant de créer et tester l'application avec gradle.

Étapes suivantes