Kompilacje macierzowe dla wielu środowisk

Witamy przy omawianiu zaawansowanej funkcji GitHub Actions: kompilacji macierzowych! Wyobraźmy sobie, że trzeba przetestować kod w wielu różnych środowiskach, na przykład w różnych systemach operacyjnych lub z różnymi wersjami języka programowania.

Zamiast tworzyć osobny przepływ pracy dla każdej kombinacji, kompilacje macierzowe pozwalają zdefiniować zestaw zmiennych, a GitHub Actions automatycznie uruchomi zadania dla każdej możliwej kombinacji tych zmiennych.

Kompilacje macierzowe są niezwykle przydatne do:

• Testowania wieloplatformowego: sprawdzania, czy aplikacja działa w systemach Windows, macOS i Linux.
• Zapewnienia zgodności z wieloma wersjami: testowania z różnymi wersjami Node.js, Pythona lub bazy danych.
• Równoległego wykonywania: uruchamiania wszystkich tych testów jednocześnie, co pozwala znacznie zaoszczędzić czas.

Pozwalają one skutecznie uzyskać szersze pokrycie testami.

Macierz definiuje się w sekcji strategy zadania. W sekcji strategy.matrix należy podać co najmniej jedną zmienną, a każdej z nich przypisać tablicę wartości.

GitHub Actions tworzy następnie zadanie dla każdej kombinacji. Przyjrzyjmy się, jak to wygląda:

We wcześniejszym fragmencie zdefiniowano zmienną node-version z trzema wartościami: 14, 16 i 18.

Ta pojedyncza definicja zadania uruchomi trzy osobne zadania, każde w środowisku ubuntu-latest, ale z inną wersją Node.js. Dzięki temu można upewnić się, że projekt działa z każdą z tych wersji.

Nie trzeba ograniczać się do jednej zmiennej! W macierzy można połączyć wiele zmiennych. Można na przykład przetestować różne systemy operacyjne z różnymi wersjami Node.js.

Wystarczy dodać kolejne pary klucz-wartość w sekcji strategy.matrix. Łączna liczba zadań będzie iloczynem liczby wartości przypisanych do poszczególnych zmiennych.

Oto sposób skonfigurowania macierzy do testowania zarówno w systemie Ubuntu, jak i Windows, z użyciem wersji Node.js 16 i 18.

Zostaną utworzone 2 (systemy operacyjne) * 2 (wersje Node.js) = 4 osobne zadania.

Czasami potrzebne są konkretne kombinacje, których nie obejmuje domyślny iloczyn kartezjański, albo dodatkowe zmienne dla wybranych kompilacji. Aby dodać nowe elementy macierzy, należy użyć include.

Można na przykład uruchomić dodatkowy test tylko w systemie Ubuntu z Node.js 14 albo przekazać konkretną zmienną środowiskową do określonej kombinacji systemu operacyjnego i wersji.

Co zrobić, jeśli wiadomo, że dana kombinacja zakończy się niepowodzeniem albo nie ma znaczenia dla projektu? Słowo kluczowe exclude pozwala usunąć określone konfiguracje z macierzy.

Pomaga to unikać niepotrzebnych uruchomień zadań i skupić się na odpowiednich przypadkach testowych.

W krokach zadania można uzyskać dostęp do bieżących wartości zmiennych macierzy za pomocą składni ${{ matrix.variable_name }}. Jest to niezbędne do konfigurowania narzędzi lub uruchamiania poleceń właściwych dla każdej kombinacji macierzy.

Na przykład ${{ matrix.os }} dynamicznie ustawia system operacyjny uruchomienia, a ${{ matrix.node-version }} konfiguruje akcję instalującą Node.js.

Kompilacje macierzowe są przydatne do:

• Tworzenia bibliotek: testowania z wieloma wersjami zależności.
• Projektów wielojęzycznych: budowania i testowania komponentów napisanych w różnych językach lub za pomocą różnych kompilatorów.
• Zapewnienia zgodności z przeglądarkami: testowania aplikacji internetowych w różnych przeglądarkach, jeśli używane narzędzie to obsługuje.

Upraszczają złożone scenariusze testowania, zamieniając je w przejrzyste i łatwe w utrzymaniu przepływy pracy.

Rozważmy przepływ pracy GitHub Actions, który korzysta ze strategii macierzowej. Macierz jest zdefiniowana następująco:

strategy:
  matrix:
    os: [ubuntu-latest, macos-latest]
    python-version: [3.8, 3.9]
    exclude:
      - os: macos-latest
        python-version: 3.8

Ile zadań zostanie utworzonych przez tę konfigurację macierzy?

Świetnie! Poznali Państwo kompilacje macierzowe w GitHub Actions.

• Pozwalają one uruchamiać zadania dla wielu kombinacji zmiennych, takich jak system operacyjny czy wersje języka.
• Są definiowane za pomocą strategy.matrix w ramach zadania.
• include dodaje określone kombinacje, a exclude je usuwa.
• Do zmiennych można uzyskać dostęp za pomocą ${{ matrix.variable_name }}.

Kompilacje macierzowe są niezbędne do wydajnego i kompleksowego testowania w różnorodnych środowiskach. Zachęcamy do dalszych ćwiczeń, aby dobrze je opanować!