ProHoster > Blog > διαχείριση > GitLab Shell Runner. Εκκινήστε ανταγωνιστικά ελεγχόμενες υπηρεσίες με το Docker Compose
GitLab Shell Runner. Εκκινήστε ανταγωνιστικά ελεγχόμενες υπηρεσίες με το Docker Compose
Αυτό το άρθρο θα ενδιαφέρει τόσο τους δοκιμαστές όσο και τους προγραμματιστές, αλλά προορίζεται περισσότερο για αυτοματοποιητές που αντιμετωπίζουν το πρόβλημα της ρύθμισης του GitLab CI / CD για δοκιμές ενοποίησης λόγω ανεπαρκών πόρων υποδομής ή/και απουσίας πλατφόρμας ενορχήστρωσης κοντέινερ. Θα σας πω πώς να διαμορφώσετε την ανάπτυξη περιβαλλόντων δοκιμής χρησιμοποιώντας το docker compose σε έναν μόνο runner κελύφους GitLab και έτσι ώστε κατά την ανάπτυξη πολλών περιβαλλόντων, οι υπηρεσίες που εκτοξεύτηκαν να μην παρεμβαίνουν μεταξύ τους.
Στην πρακτική μου, συνέβαινε συχνά να «θεραπεύω» τις δοκιμές ολοκλήρωσης σε έργα. Και συχνά το πρώτο και πιο σημαντικό πρόβλημα είναι ο αγωγός CI, στον οποίο γίνεται δοκιμή ενοποίησης αναπτηγμένος η(οι) υπηρεσία(ες) φιλοξενείται στο περιβάλλον dev/stage. Αυτό προκάλεσε αρκετά προβλήματα:
Λόγω ελαττωμάτων σε μία ή άλλη υπηρεσία κατά τη διάρκεια της δοκιμής ενσωμάτωσης, το κύκλωμα δοκιμής μπορεί να καταστραφεί από κατεστραμμένα δεδομένα. Υπήρχαν περιπτώσεις όπου η αποστολή ενός αιτήματος με σπασμένη μορφή JSON έκλεισε την υπηρεσία, γεγονός που έκανε το περίπτερο εντελώς ανενεργό.
Η επιβράδυνση του κυκλώματος δοκιμής με την αύξηση των δεδομένων δοκιμής. Νομίζω ότι δεν έχει νόημα να περιγράψω ένα παράδειγμα με καθαρισμό / επαναφορά της βάσης δεδομένων. Στο ιατρείο μου, δεν έχω συναντήσει έργο όπου αυτή η διαδικασία θα πήγαινε ομαλά.
Ο κίνδυνος διακοπής της απόδοσης του κυκλώματος δοκιμής κατά τον έλεγχο των γενικών ρυθμίσεων του συστήματος. Για παράδειγμα, πολιτική χρήστη/ομάδας/κωδικού πρόσβασης/εφαρμογής.
Τα δεδομένα δοκιμών από τις αυτόματες δοκιμές δυσκολεύουν τη ζωή των χειροκίνητων ελεγκτών.
Κάποιος θα πει ότι οι καλές αυτόματες δοκιμές θα πρέπει να καθαρίσουν τα δεδομένα μετά από μόνα τους. Έχω επιχειρήματα κατά:
Οι δυναμικές βάσεις είναι πολύ βολικές στη χρήση.
Δεν μπορεί να αφαιρεθεί κάθε αντικείμενο από το σύστημα μέσω του API. Για παράδειγμα, μια κλήση για διαγραφή αντικειμένου δεν υλοποιείται, καθώς έρχεται σε αντίθεση με την επιχειρηματική λογική.
Κατά τη δημιουργία ενός αντικειμένου μέσω του API, μπορεί να δημιουργηθεί ένας τεράστιος όγκος μεταδεδομένων που είναι προβληματικό να αφαιρεθεί.
Εάν τα τεστ εξαρτώνται το ένα από το άλλο, τότε η διαδικασία καθαρισμού των δεδομένων μετά την εκτέλεση των δοκιμών μετατρέπεται σε πονοκέφαλο.
Πρόσθετες (και, κατά τη γνώμη μου, μη δικαιολογημένες) κλήσεις στο API.
Και το κύριο επιχείρημα: όταν τα δεδομένα δοκιμής αρχίζουν να καθαρίζονται απευθείας από τη βάση δεδομένων. Αυτό μετατρέπεται σε πραγματικό τσίρκο PK/FK! Ακούμε από τους προγραμματιστές: "Μόλις πρόσθεσα/αφαίρεσα/μετονόμασα το σήμα, γιατί πέτυχαν 100500 δοκιμές ενοποίησης;"
Κατά τη γνώμη μου, η βέλτιστη λύση είναι ένα δυναμικό περιβάλλον.
Πολλοί άνθρωποι χρησιμοποιούν docker-compose για να εκτελέσουν ένα δοκιμαστικό περιβάλλον, αλλά λίγοι άνθρωποι χρησιμοποιούν docker-compose όταν κάνουν δοκιμές ενοποίησης σε CI/CD. Και εδώ δεν λαμβάνω υπόψη τα kubernetes, τα σμήνη και άλλες πλατφόρμες ενορχήστρωσης κοντέινερ. Δεν τα έχει κάθε εταιρεία. Θα ήταν ωραίο αν το docker-compose.yml ήταν καθολικό.
Ακόμα κι αν έχουμε το δικό μας πρόγραμμα QA runner, πώς μπορούμε να βεβαιωθούμε ότι οι υπηρεσίες που εκκινούνται μέσω docker-compose δεν παρεμβαίνουν μεταξύ τους;
Πώς να συλλέξετε αρχεία καταγραφής δοκιμασμένων υπηρεσιών;
Πώς να καθαρίσετε τον δρομέα;
Έχω το δικό μου GitLab runner για τα έργα μου και αντιμετώπισα αυτά τα ζητήματα κατά την ανάπτυξη Java Client για ράγα δοκιμής. Πιο συγκεκριμένα, κατά την εκτέλεση δοκιμών ενσωμάτωσης. Εδώ θα συνεχίσουμε να επιλύουμε αυτά τα ζητήματα με παραδείγματα από αυτό το έργο.
Για έναν runner, προτείνω μια εικονική μηχανή Linux με 4 vCPU, 4 GB RAM, 50 GB HDD.
Υπάρχουν πολλές πληροφορίες για τη ρύθμιση του gitlab-runner στο Διαδίκτυο, οπότε εν συντομία:
Πηγαίνουμε στο μηχάνημα μέσω SSH
Εάν έχετε λιγότερο από 8 GB μνήμης RAM, τότε σας προτείνω κάντε swap 10 GBγια να μην έρθει ο OOM killer και να μας σκοτώσει εργασίες λόγω έλλειψης RAM. Αυτό μπορεί να συμβεί όταν εκτελούνται περισσότερες από 5 εργασίες ταυτόχρονα. Οι εργασίες θα είναι πιο αργές, αλλά σταθερές.
Παράδειγμα με το OOM killer
Αν στα αρχεία καταγραφής εργασιών βλέπετε bash: line 82: 26474 Killed, στη συνέχεια απλώς εκτελέστε στον δρομέα sudo dmesg | grep 26474
[26474] 1002 26474 1061935 123806 339 0 0 java
Out of memory: Kill process 26474 (java) score 127 or sacrifice child
Killed process 26474 (java) total-vm:4247740kB, anon-rss:495224kB, file-rss:0kB, shmem-rss:0kB
Και αν η εικόνα μοιάζει κάπως έτσι, τότε είτε προσθέστε swap είτε ρίξτε RAM.
Αυτό θα σας επιτρέψει να εκτελέσετε παράλληλες εργασίες στον ίδιο δρομέα. Διαβάστε περισσότερα εδώ.
Εάν έχετε ένα πιο ισχυρό μηχάνημα, για παράδειγμα, 8 vCPU, 16 GB RAM, τότε αυτοί οι αριθμοί μπορούν να γίνουν τουλάχιστον 2 φορές μεγαλύτεροι. Αλλά όλα εξαρτώνται από το τι ακριβώς θα κυκλοφορήσει σε αυτόν τον δρομέα και σε ποια ποσότητα.
Η κύρια εργασία είναι ένα καθολικό docker-compose.yml το οποίο οι προγραμματιστές / δοκιμαστές μπορούν να χρησιμοποιήσουν τόσο τοπικά όσο και στη διοχέτευση CI.
Πρώτα απ 'όλα, φτιάχνουμε μοναδικά ονόματα υπηρεσιών για CI. Μία από τις μοναδικές μεταβλητές στο GitLab CI είναι η μεταβλητή CI_JOB_ID. Αν διευκρινίσετε container_name με το νόημα "service-${CI_JOB_ID:-local}", τότε στην περίπτωση:
αν CI_JOB_ID δεν ορίζεται σε μεταβλητές περιβάλλοντος,
τότε το όνομα της υπηρεσίας θα είναι service-local
αν CI_JOB_ID ορίζεται σε μεταβλητές περιβάλλοντος (π.χ. 123),
τότε το όνομα της υπηρεσίας θα είναι service-123
Δεύτερον, κάνουμε ένα κοινό δίκτυο για την εκτέλεση υπηρεσιών. Αυτό μας παρέχει απομόνωση σε επίπεδο δικτύου κατά την εκτέλεση πολλαπλών δοκιμαστικών περιβαλλόντων.
Στην πραγματικότητα, αυτό είναι το πρώτο βήμα προς την επιτυχία =)
Ένα παράδειγμα του docker-compose.yml μου με σχόλια
version: "3"
# Для корректной работы web (php) и fmt нужно,
# чтобы контейнеры имели общий исполняемый контент.
# В нашем случае, это директория /var/www/testrail
volumes:
static-content:
# Изолируем окружение на сетевом уровне
networks:
default:
external:
name: testrail-network-${CI_JOB_ID:-local}
services:
db:
image: mysql:5.7.22
# Каждый container_name содержит ${CI_JOB_ID:-local}
container_name: "testrail-mysql-${CI_JOB_ID:-local}"
environment:
MYSQL_HOST: db
MYSQL_DATABASE: mydb
MYSQL_ROOT_PASSWORD: 1234
SKIP_GRANT_TABLES: 1
SKIP_NETWORKING: 1
SERVICE_TAGS: dev
SERVICE_NAME: mysql
networks:
- default
migration:
image: registry.gitlab.com/touchbit/image/testrail/migration:latest
container_name: "testrail-migration-${CI_JOB_ID:-local}"
links:
- db
depends_on:
- db
networks:
- default
fpm:
image: registry.gitlab.com/touchbit/image/testrail/fpm:latest
container_name: "testrail-fpm-${CI_JOB_ID:-local}"
volumes:
- static-content:/var/www/testrail
links:
- db
networks:
- default
web:
image: registry.gitlab.com/touchbit/image/testrail/web:latest
container_name: "testrail-web-${CI_JOB_ID:-local}"
# Если переменные TR_HTTP_PORT или TR_HTTPS_PORTS не определены,
# то сервис поднимается на 80 и 443 порту соответственно.
ports:
- ${TR_HTTP_PORT:-80}:80
- ${TR_HTTPS_PORT:-443}:443
volumes:
- static-content:/var/www/testrail
links:
- db
- fpm
networks:
- default
Integration:
stage: test
tags:
- my-shell-runner
before_script:
# Аутентифицируемся в registry
- docker login -u gitlab-ci-token -p ${CI_JOB_TOKEN} ${CI_REGISTRY}
# Генерируем псевдоуникальные TR_HTTP_PORT и TR_HTTPS_PORT
- export TR_HTTP_PORT=$(shuf -i10000-60000 -n1)
- export TR_HTTPS_PORT=$(shuf -i10000-60000 -n1)
# создаем директорию с идентификатором задачи
- mkdir ${CI_JOB_ID}
# копируем в созданную директорию наш docker-compose.yml
# чтобы контекст был разный для каждой задачи
- cp .indirect/docker-compose.yml ${CI_JOB_ID}/docker-compose.yml
script:
# поднимаем наше окружение
- make docker-up
# запускаем тесты исполняемым jar (у меня так)
- java -jar itest.jar --http-port ${TR_HTTP_PORT} --https-port ${TR_HTTPS_PORT}
# или в контейнере
- docker run --network=testrail-network-${CI_JOB_ID:-local} --rm itest
after_script:
# собираем логи
- make docker-logs
# останавливаем окружение
- make docker-kill
artifacts:
# сохраняем логи
when: always
paths:
- logs
expire_in: 30 days
Ως αποτέλεσμα της εκτέλεσης μιας τέτοιας εργασίας, ο κατάλογος αρχείων καταγραφής στα τεχνουργήματα θα περιέχει αρχεία καταγραφής υπηρεσιών και δοκιμών. Το οποίο είναι πολύ βολικό σε περίπτωση σφαλμάτων. Κάθε δοκιμή παράλληλα γράφει το δικό του αρχείο καταγραφής, αλλά θα μιλήσω για αυτό ξεχωριστά.
$ docker login -u gitlab-ci-token -p ${CI_JOB_TOKEN} ${CI_REGISTRY}
WARNING! Using --password via the CLI is insecure. Use --password-stdin.
WARNING! Your password will be stored unencrypted in /home/gitlab-runner/.docker/config.json.
Configure a credential helper to remove this warning. See
https://docs.docker.com/engine/reference/commandline/login/#credentials-store
Login Succeeded
$ export TR_HTTP_PORT=$(shuf -i10000-60000 -n1)
$ export TR_HTTPS_PORT=$(shuf -i10000-60000 -n1)
$ mkdir ${CI_JOB_ID}
$ cp .indirect/docker-compose.yml ${CI_JOB_ID}/docker-compose.yml
$ make docker-up
docker-compose -f ${CI_JOB_ID:-.indirect}/docker-compose.yml kill
docker network rm testrail-network-${CI_JOB_ID:-local} || true
Error: No such network: testrail-network-204645172
docker network create testrail-network-${CI_JOB_ID:-local}
0a59552b4464b8ab484de6ae5054f3d5752902910bacb0a7b5eca698766d0331
docker-compose -f ${CI_JOB_ID:-.indirect}/docker-compose.yml pull
Pulling web ... done
Pulling fpm ... done
Pulling migration ... done
Pulling db ... done
docker-compose -f ${CI_JOB_ID:-.indirect}/docker-compose.yml up --force-recreate --renew-anon-volumes -d
Creating volume "204645172_static-content" with default driver
Creating testrail-mysql-204645172 ...
Creating testrail-mysql-204645172 ... done
Creating testrail-migration-204645172 ... done
Creating testrail-fpm-204645172 ... done
Creating testrail-web-204645172 ... done
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
c6b76f9135ed registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" 13 seconds ago Up 1 second 0.0.0.0:51148->80/tcp, 0.0.0.0:25426->443/tcp testrail-web-204645172
01d303262d8e registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" 16 seconds ago Up 13 seconds 9000/tcp testrail-fpm-204645172
2cdab1edbf6a registry.gitlab.com/touchbit/image/testrail/migration:latest "docker-entrypoint.s…" 16 seconds ago Up 13 seconds 3306/tcp, 33060/tcp testrail-migration-204645172
826aaf7c0a29 mysql:5.7.22 "docker-entrypoint.s…" 18 seconds ago Up 16 seconds 3306/tcp testrail-mysql-204645172
6dbb3fae0322 registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" 36 seconds ago Up 22 seconds 0.0.0.0:44202->80/tcp, 0.0.0.0:20151->443/tcp testrail-web-204645084
3540f8d448ce registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" 38 seconds ago Up 35 seconds 9000/tcp testrail-fpm-204645084
70fea72aa10d mysql:5.7.22 "docker-entrypoint.s…" 40 seconds ago Up 37 seconds 3306/tcp testrail-mysql-204645084
d8aa24b2892d registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" About a minute ago Up 53 seconds 0.0.0.0:31103->80/tcp, 0.0.0.0:43872->443/tcp testrail-web-204644881
6d4ccd910fad registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" About a minute ago Up About a minute 9000/tcp testrail-fpm-204644881
685d8023a3ec mysql:5.7.22 "docker-entrypoint.s…" About a minute ago Up About a minute 3306/tcp testrail-mysql-204644881
1cdfc692003a registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" About a minute ago Up About a minute 0.0.0.0:44752->80/tcp, 0.0.0.0:23540->443/tcp testrail-web-204644793
6f26dfb2683e registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" About a minute ago Up About a minute 9000/tcp testrail-fpm-204644793
029e16b26201 mysql:5.7.22 "docker-entrypoint.s…" About a minute ago Up About a minute 3306/tcp testrail-mysql-204644793
c10443222ac6 registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" 5 hours ago Up 5 hours 0.0.0.0:57123->80/tcp, 0.0.0.0:31657->443/tcp testrail-web-204567103
04339229397e registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" 5 hours ago Up 5 hours 9000/tcp testrail-fpm-204567103
6ae0accab28d mysql:5.7.22 "docker-entrypoint.s…" 5 hours ago Up 5 hours 3306/tcp testrail-mysql-204567103
b66b60d79e43 registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" 5 hours ago Up 5 hours 0.0.0.0:56321->80/tcp, 0.0.0.0:58749->443/tcp testrail-web-204553690
033b1f46afa9 registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" 5 hours ago Up 5 hours 9000/tcp testrail-fpm-204553690
a8879c5ef941 mysql:5.7.22 "docker-entrypoint.s…" 5 hours ago Up 5 hours 3306/tcp testrail-mysql-204553690
069954ba6010 registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" 5 hours ago Up 5 hours 0.0.0.0:32869->80/tcp, 0.0.0.0:16066->443/tcp testrail-web-204553539
ed6b17d911a5 registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" 5 hours ago Up 5 hours 9000/tcp testrail-fpm-204553539
1a1eed057ea0 mysql:5.7.22 "docker-entrypoint.s…" 5 hours ago Up 5 hours 3306/tcp testrail-mysql-204553539
Όλες οι εργασίες ολοκληρώθηκαν με επιτυχία
Τα τεχνουργήματα εργασιών περιέχουν αρχεία καταγραφής υπηρεσιών και δοκιμών
Όλα φαίνονται όμορφα, αλλά υπάρχει μια απόχρωση. Ένας αγωγός μπορεί να ακυρωθεί αναγκαστικά ενώ εκτελούνται οι δοκιμές ενσωμάτωσης, οπότε τα κοντέινερ που λειτουργούν δεν θα σταματήσουν. Από καιρό σε καιρό χρειάζεται να καθαρίζετε τον δρομέα. Δυστυχώς, η εργασία για αναθεώρηση στο GitLab CE εξακολουθεί να βρίσκεται σε κατάσταση Ανοικτό
Αλλά έχουμε προσθέσει μια προγραμματισμένη εκκίνηση εργασιών και κανείς δεν μας απαγορεύει να την ξεκινήσουμε με μη αυτόματο τρόπο.
Μεταβείτε στο έργο μας -> CI/CD -> Χρονοδιαγράμματα και εκτελέστε την εργασία Clean runner
Итого:
Έχουμε έναν δρομέα κοχυλιών.
Δεν υπάρχουν συγκρούσεις μεταξύ εργασιών και περιβάλλοντος.
Έχουμε παράλληλη εκκίνηση εργασιών με δοκιμές ολοκλήρωσης.
Μπορείτε να εκτελέσετε δοκιμές ενοποίησης τόσο τοπικά όσο και σε κοντέινερ.
Τα αρχεία καταγραφής υπηρεσιών και δοκιμών συλλέγονται και επισυνάπτονται στην εργασία του αγωγού.
Είναι δυνατός ο καθαρισμός του δρομέα από παλιές εικόνες docker.
Ο χρόνος ρύθμισης είναι ~2 ώρες.
Αυτό, στην πραγματικότητα, είναι όλο. Θα χαρώ να σχολιάσω.