Crea, testa e containerizza applicazioni Java

Questa pagina spiega come utilizzare Cloud Build per creare, testare e containerizzare applicazioni basate su Java, caricare immagini container su Artifact Registry e generare la provenienza delle build.

Prima di iniziare

Utilizzare l'immagine maven o gradle

Puoi configurare Cloud Build per creare applicazioni Java utilizzando l'immagine maven o l'immagine gradle da Docker Hub.

maven

Per eseguire le attività nell'immagine maven, aggiungi un passaggio alla configurazione della build con i seguenti campi:

  • name: imposta il valore di questo campo su maven o maven:<tag>, dove il valore rappresenta la versione. Se non specifichi il tag immagine, Cloud Build utilizza per impostazione predefinita l'immagine latest.
  • entrypoint: l'impostazione di questo campo esegue l'override del punto di ingresso predefinito della immagine a cui viene fatto riferimento in name. Imposta il valore di questo campo su mvn da richiamare mvn come punto di ingresso del passaggio di build ed esegui i comandi mvn.
  • args: il campo args di un passaggio di compilazione prende un elenco di argomenti e li passa all'immagine a cui fa riferimento il campo name.

Il seguente passaggio di compilazione specifica il entrypoint per l'immagine maven taggata come 3.3-jdk-8 e stampa la versione dello strumento di compilazione:

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

gradle

Per eseguire le attività nell'immagine gradle, aggiungi un passaggio alla configurazione della build con i seguenti campi:

  • name: imposta il valore di questo campo su gradle o gradle:<tag>, dove il valore rappresenta la versione. Se non specifichi il tag immagine, Cloud Build utilizza l'immagine latest per impostazione predefinita.
  • entrypoint: l'impostazione di questo campo sostituisce il punto di contatto predefinito dell'immagine a cui si fa riferimento in name. Imposta il valore di questo campo su gradle da richiamare gradle come punto di ingresso del passaggio di build ed esegui i comandi gradle.
  • args: il campo args di un passaggio di build accetta un elenco di argomenti e e le passa all'immagine a cui fa riferimento il campo name.

Il seguente passaggio di compilazione specifica il entrypoint per l'immagine gradle taggata come 5.6.2-jdk8 e stampa la versione dello strumento di compilazione:

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

Configurazione delle build di Java

  1. Nella directory root del progetto, crea un file di configurazione di compilazione denominato cloudbuild.yaml.

  2. Esegui test: maven e gradle forniscono maven test e gradle test, che scaricano le dipendenze, creano le applicazioni ed eseguono eventuali test specificati nel codice sorgente. Il campo args di un passaggio di build richiede un di argomenti e li passa all'immagine a cui fa riferimento il campo name.

    Nel file di configurazione della build, aggiungi test al campo args per richiamare test in maven e 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. Pacchettizza l'applicazione: per pacchettizzare l'applicazione in un file JAR per l'immagine maven, specifica il comando package nel campo args. Il comando package crea un file JAR in /workspace/target/.

    Per pacchettizzare l'applicazione in un file JAR per l'immagine gradle, specifica il comando assemble nel campo args. Il comando assemble genera un file JAR in workspace/build/libs.

    Il seguente passaggio di build pacchettizza la tua applicazione 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. Containerizza l'applicazione: Cloud Build fornisce un'immagine Docker predefinita che puoi utilizzare per containerizzare l'applicazione Java. Per eseguire il containerizzazione della tua applicazione Java, nel file di configurazione della build:

    • Aggiungi un campo name e specifica l'immagine Docker predefinita in gcr.io/cloud-builders/docker.
    • Aggiungi un campo args e specifica gli argomenti build, incluso il nome di l'immagine container da creare e il percorso dell'artefatto della build.
    • Aggiungi un campo images per eseguire il push dell'immagine container compilata in Artifact Registry.
    • (Facoltativo) Aggiungi requestedVerifyOption: VERIFIED nel campo options del file di configurazione della build per abilitare Livelli della catena di fornitura per artefatti software (SLSA) della provenienza.

    Il seguente passaggio di compilazione esegue il containerizzazione dell'applicazione, esegue il push dell'immagine del container in Artifact Registry e genera informazioni sull'origine della compilazione:

    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']
    

    Dove:

    • location: la posizione regionale o multiregionale del repository.
    • project-id: l'ID del tuo progetto Google Cloud.
    • repository: il nome del repository Artifact Registry.
    • image: il nome dell'immagine del contenitore.
    • build-artifact: il nome del file JAR creato dal passaggio di compilazione.
  5. Avvia la build: quando il file di configurazione della build è pronto, avvia la build inserendo il seguente comando nel terminale:

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

    Dove:

    • config-file-path: il percorso del file di configurazione della build. In questo esempio, il file di configurazione di compilazione è denominato cloudbuild.yaml.
    • source-directory: il percorso o l'URL del codice sorgente.
    • REGION: una delle regioni di build supportate.

    Se non specifichi config-file-path e source-directory nel comando gcloud builds submit, Cloud Build presuppone che il file di configurazione e il codice sorgente si trovino nella directory di lavoro corrente.

    Al termine della build, puoi visualizzare i dettagli del repository in Artifact Registry.

    Puoi anche visualizzare i metadati di provenienza della build e convalidare la provenienza.

Esempi di codice

Ecco alcuni repository di esempio che puoi utilizzare per creare app Java, che contengono un'applicazione di esempio e un file di configurazione di compilazione per creare e testare quell'applicazione:

  • maven-example: un'app Java e un file di configurazione di compilazione di esempio per la creazione e il test l'app con mvn.
  • gradle-example: un'app Java e un file di configurazione di compilazione di esempio per compilare e testare l'app con gradle.

Passaggi successivi