Używanie docker-compose z CI - jak radzić sobie z kodami zakończenia i zdemonizowanymi kontenerami połączonymi?

W tej chwili nasi agenci Jenkinsa generują plik docker-compose.yml dla każdego z naszych projektów Rails, a następnie uruchamiają docker-compose. Docker-compose.yml ma główny kontener "sieciowy", który zawiera rbenv i wszystkie inne nasze zależności Railsowe. Jest powiązany z kontenerem DB, który zawiera testową bazę danych Postgres.

Problem pojawia się, gdy musimy faktycznie przeprowadzić testy i wygenerować kody wyjścia. Nasz serwer CI zostanie wdrożony tylko wtedy, gdy skrypt testowy zwróci exit 0, ale docker-compose zawsze zwraca 0, nawet jeśli jedno z poleceń kontenera zawiedzie.

Innym problemem jest to, że kontener bazy danych działa w nieskończoność, nawet po zakończeniu testów w kontenerze internetowym, więc docker-compose upnigdy nie zwraca.

Czy istnieje sposób, w jaki możemy użyć docker-compose do tego procesu? Musielibyśmy mieć możliwość uruchomienia kontenerów, ale kończą pracę po zakończeniu kontenera internetowego i zwracają jego kod zakończenia. W tej chwili utknęliśmy ręcznie przy użyciu dockera, aby uruchomić kontener DB i uruchomić kontener sieciowy z opcją --link.

Od wersji 1.12.0możesz skorzystać z --exit-code-fromopcji.

Z dokumentacji :

- kod-wyjścia-z usługi

Zwróć kod zakończenia wybranego kontenera usługi. Implikuje - abort-on-container-exit.

docker-compose runto prosty sposób na uzyskanie żądanych statusów zakończenia. Na przykład:

$ 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

Alternatywnie masz możliwość sprawdzenia martwych pojemników. Możesz użyć -fflagi, aby uzyskać tylko status wyjścia.

$ 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

Jeśli chodzi o kontener db, który nigdy nie powraca, jeśli używasz docker-compose up, będziesz musiał sigkill ten kontener; prawdopodobnie nie tego chcesz. Zamiast tego możesz użyć docker-compose up -ddo uruchomienia kontenerów zdemonizowanych i ręcznie zabić kontenery po zakończeniu testu. docker-compose run powinien uruchamiać połączone kontenery dla ciebie, ale słyszałem w SO gadkę o błędzie, który uniemożliwia to teraz działanie zgodnie z przeznaczeniem.

Opierając się na odpowiedzi Kojiro:

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

1. pobierz identyfikatory kontenerów
2. pobierz kod zakończenia ostatnich uruchomień dla każdego identyfikatora kontenera
3. tylko kody stanu, które nie zaczynają się od „0”
4. policzyć liczbę kodów stanu innych niż 0
5. wyciąć spację

Zwraca liczbę zwróconych kodów zakończenia innych niż 0. Byłoby 0, gdyby wszystko zakończyło się kodem 0.

Jeśli chcesz docker-compose runręcznie rozpocząć testy, dodanie --rmflagi, co dziwne, powoduje, że komponowanie dokładnie odzwierciedla stan wyjścia polecenia.

Oto mój przykład:

$ 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.

Użyj, docker waitaby uzyskać kod wyjścia:

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

footo „nazwa projektu”. W powyższym przykładzie wyraźnie to określiłem, ale jeśli go nie podasz, jest to nazwa katalogu. barto nazwa nadana testowanemu systemowi w pliku docker-compose.yml.

Zauważ, że docker logs -frobi to również właściwą rzecz, wychodząc, gdy kontener się zatrzyma. Więc możesz umieścić

$ docker logs -f foo_bar_1

między docker-compose upa do docker wait, abyś mógł oglądać przebieg testów.

--exit-code-from SERVICEi --abort-on-container-exitnie działa w scenariuszach, w których trzeba uruchomić wszystkie kontenery do końca, ale kończy się niepowodzeniem, jeśli jeden z nich został wcześniej zakończony. Przykładem może być jednoczesne uruchomienie 2 zestawów testowych w różnych kontenerach.

Dzięki sugestii @ Spedhil możesz zawrzeć docker-composeskrypt, który zawiedzie, jeśli zrobią to jakiekolwiek kontenery.

#!/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:]')

Następnie na serwerze CI po prostu zmień docker-compose upna ./docker-compose.sh up.

docker-rails pozwala określić, który kod błędu kontenera jest zwracany do procesu głównego, dzięki czemu serwer CI może określić wynik. Jest to świetne rozwiązanie dla CI i rozwoju dla szyn z dockerem.

Na przykład

exit_code: web

w twoim docker-rails.ymlzwróci webkod zakończenia kontenera w wyniku polecenia docker-rails ci test. docker-rails.ymlto tylko meta otoka wokół standardu, docker-compose.ymlktóra daje możliwość dziedziczenia / ponownego użycia tej samej podstawowej konfiguracji dla różnych środowisk, tj. programowanie vs test vs parallel_tests.

W przypadku, gdy możesz uruchomić więcej usług docker-compose o tej samej nazwie na jednym silniku docker, a nie znasz dokładnej nazwy:

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

echo %? - zwraca kod wyjścia z usługi test-chrome

Korzyści:

• czekanie na zakończenie usługi
• używa nazwy usługi, a nie nazwy kontenera

Możesz zobaczyć status wyjścia za pomocą:

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