Utilizzo di docker-compose con CI: come gestire i codici di uscita e i container collegati daemonizzati?

In questo momento i nostri agenti Jenkins generano un docker-compose.yml per ciascuno dei nostri progetti Rails e quindi eseguono docker-compose up. Il docker-compose.yml ha un contenitore "web" principale che contiene rbenv e tutte le nostre altre dipendenze di Rails. È collegato a un contenitore DB che contiene il DB Postgres di prova.

Il problema nasce quando dobbiamo eseguire effettivamente i test e generare codici di uscita. Il nostro server CI verrà distribuito solo se lo script di test restituisce exit 0, ma docker-compose restituisce sempre 0, anche se uno dei comandi del contenitore non riesce.

L'altro problema è che il contenitore DB viene eseguito indefinitamente, anche dopo che il contenitore Web ha terminato di eseguire i test, quindi docker-compose upnon ritorna mai.

C'è un modo in cui possiamo usare docker-compose per questo processo? Dovremmo essere in grado di eseguire i contenitori, ma uscire dopo che il contenitore web è completo e restituire il suo codice di uscita. In questo momento siamo bloccati manualmente utilizzando docker per far girare il contenitore DB ed eseguire il contenitore web con l'opzione --link.

Dalla versione 1.12.0, puoi usare l' --exit-code-fromopzione.

Dalla documentazione :

--exit-code-from SERVICE

Restituisce il codice di uscita del contenitore di servizi selezionato. Implica --abort-on-container-exit.

docker-compose runè il modo semplice per ottenere gli stati di uscita desiderati. Per esempio:

$ cat docker-compose.yml 
roit:
    image: busybox
    command: 'true'
naw:
    image: busybox
    command: 'false'
$ docker-compose run --rm roit; echo $?
Removing test_roit_run_1...
0
$ docker-compose run --rm naw; echo $?
Removing test_naw_run_1...
1

In alternativa, hai la possibilità di ispezionare i contenitori morti. Puoi usare il -fflag per ottenere solo lo stato di uscita.

$ docker-compose up
Creating test_naw_1...
Creating test_roit_1...
Attaching to test_roit_1
test_roit_1 exited with code 0
Gracefully stopping... (press Ctrl+C again to force)
$ docker-compose ps -q | xargs docker inspect -f '{{ .Name }} exited with status {{ .State.ExitCode }}'
/test_naw_1 exited with status 1
/test_roit_1 exited with status 0

Per quanto riguarda il contenitore db che non ritorna mai, se usi docker-compose upallora dovrai sigkill quel contenitore; probabilmente non è quello che vuoi. Invece, puoi usare docker-compose up -dper eseguire i tuoi contenitori daemonizzati e uccidere manualmente i contenitori quando il tuo test è completo. docker-compose run dovrebbe eseguire i contenitori collegati per te, ma ho sentito parlare di SO su un bug che impedisce che funzioni come previsto in questo momento.

Basandosi sulla risposta di kojiro:

docker-compose ps -q | xargs docker inspect -f '{{ .State.ExitCode }}' | grep -v '^0' | wc -l | tr -d ' '

1. ottenere ID contenitore
2. ottenere il codice di uscita delle ultime esecuzioni per ogni ID contenitore
3. solo codici di stato che non iniziano con "0"
4. contare il numero di codici di stato diversi da 0
5. ritaglia lo spazio bianco

Restituisce quanti codici di uscita diversi da 0 sono stati restituiti. Sarebbe 0 se tutto uscisse con il codice 0.

Se sei disposto a utilizzare docker-compose runper avviare manualmente i tuoi test, l'aggiunta del --rmflag, stranamente, fa sì che Compose rifletta accuratamente lo stato di uscita del tuo comando.

Ecco il mio esempio:

$ docker-compose -v
docker-compose version 1.7.0, build 0d7bf73

$ (docker-compose run bash false) || echo 'Test failed!'  # False negative.

$ (docker-compose run --rm bash false) || echo 'Test failed!'  # True positive.
Test failed!

$ (docker-compose run --rm bash true) || echo 'Test failed!'  # True negative.

Utilizzare docker waitper ottenere il codice di uscita:

$ docker-compose -p foo up -d
$ ret=$(docker wait foo_bar_1)

fooè il "nome del progetto". Nell'esempio sopra, l'ho specificato esplicitamente, ma se non lo fornisci, è il nome della directory. barè il nome che dai al sistema in prova nel tuo docker-compose.yml.

Nota che docker logs -ffa anche la cosa giusta, uscire quando il contenitore si ferma. Quindi puoi mettere

$ docker logs -f foo_bar_1

tra il docker-compose upe il docker waitcosì puoi vedere i tuoi test eseguiti.

--exit-code-from SERVICEe --abort-on-container-exitnon funzionano in scenari in cui è necessario eseguire tutti i contenitori fino al completamento, ma fallire se uno di essi è stato chiuso in anticipo. Un esempio potrebbe essere se si eseguono 2 tute di prova contemporaneamente in contenitori diversi.

Con il suggerimento di @ spesohil, puoi inserire docker-composeuno script che fallirà se qualche contenitore lo fa.

#!/bin/bash
set -e

# Wrap docker-compose and return a non-zero exit code if any containers failed.

docker-compose "$@"

exit $(docker-compose -f docker-compose.ci.build.yml ps -q | tr -d '[:space:]' |
  xargs docker inspect -f '{{ .State.ExitCode }}' | grep -v 0 | wc -l | tr -d '[:space:]')

Quindi sul tuo server CI docker-compose uppassa semplicemente a ./docker-compose.sh up.

docker-rails consente di specificare quale codice di errore del contenitore viene restituito al processo principale, in modo che il server CI possa determinare il risultato. È un'ottima soluzione per CI e sviluppo per rotaie con docker.

Per esempio

exit_code: web

nel tuo docker-rails.ymlrestituirà il webcodice di uscita dei contenitori come risultato del comando docker-rails ci test. docker-rails.ymlè solo un meta wrapper attorno allo standard docker-compose.ymlche ti dà il potenziale per ereditare / riutilizzare la stessa configurazione di base per ambienti diversi, ad esempio sviluppo vs test vs parallel_tests.

Nel caso in cui potresti eseguire più servizi di composizione mobile con lo stesso nome su un motore di finestra mobile e non conosci il nome esatto:

docker-compose up -d
(exit "${$(docker-compose logs -f test-chrome)##* }")

echo %? - restituisce il codice di uscita dal servizio test-chrome

Benefici:

• aspetta che esca il servizio
• utilizza il nome del servizio, non il nome del contenitore

Puoi vedere lo stato di uscita con:

echo $(docker-compose ps | grep "servicename" | awk '{print $4}')