Weryfikacja treści dokumentów PDF w testach automatycznych

Weryfikacja treści dokumentów PDF odgrywa kluczową rolę w zapewnianiu jakości w wielu aplikacjach, które generują lub przetwarzają pliki PDF. W dzisiejszym artykule odkryjemy, jak efektywnie parsować i weryfikować treść dokumentów, a także jak zarządzać plikami po zakończeniu testów. Metody te pozwalają stworzyć solidny i niezawodny proces testowania, który przekłada się na dostarczanie wiarygodnych produktów użytkownikom końcowym.

Dokumenty PDF są powszechnie wykorzystywane do prezentowania informacji w sposób spójny i niezależny od platformy. Czyni je to idealnym formatem do różnorodnych zastosowań, od raportów finansowych po dokumentację techniczną. Dlatego ważna jest możliwość automatycznego sprawdzania, czy generowane pliki PDF spełniają określone kryteria jakościowe i zawierają wszystkie niezbędne informacje.

Biblioteki do weryfikacji treści PDF

W celu weryfikacji treści dokumentów PDF skorzystamy z dwóch popularnych bibliotek: fs i pdf-parse.

fs (File System) to wbudowany w Node.js moduł, który umożliwia operacje na systemie plików, jak ich odczytywanie, zapisywanie i usuwanie.
pdf-parse to biblioteka umożliwiająca parsowanie plików PDF oraz ekstrakcję ich zawartości w formie tekstu.

Konfiguracja projektu

Zanim zaczniemy, musimy zainstalować niezbędne pakiety. W tym celu należy wykonać następujące polecenie:

npm install playwright fs pdf-parse

Struktura projektu może wyglądać następująco:

project
|-- tests
|   |-- pdf.spec.js
|-- utils
|   |-- pdfParser.js
|   |-- cleanupAction.js
|-- playwright.config.js

Implementacja metody parsowania PDF

Aby zweryfikować treść dokumentu PDF, musimy go najpierw odczytać i przeanalizować. Proces ten można zautomatyzować przy użyciu różnych narzędzi programistycznych. Poniżej przedstawiamy przykładową implementację funkcji pdfParser, która służy do odczytywania i parsowania plików PDF za pomocą biblioteki pdf-parse w języku JavaScript.

import fs from "fs";
import PdfParse from "pdf-parse";

function pdfParser(filePath) {
  const pdfContent = fs.readFileSync(filePath);
  const pdfData = PdfParse(pdfContent);
  return pdfData;
}

export { pdfParser };

Funkcja pdfParser działa w kilku krokach. Najpierw odczytuje zawartość pliku PDF z podanej ścieżki za pomocą metody fs.readFileSync. Następnie, używając biblioteki pdf-parse, przetwarza zawartość tego pliku. Wynikiem jest obiekt pdfData, który zawiera tekst oraz inne dane wyodrębnione z pliku PDF. Dzięki temu możemy łatwo uzyskać dostęp do tekstu zawartego w dokumencie i zweryfikować jego zgodność z oczekiwaniami.

Przykładowy test weryfikujący treść PDF

Za pomocą Playwright możemy napisać test, który pobiera dokument PDF z serwera, a następnie weryfikuje jego treść. Poniżej przedstawiamy przykładowy test, który ilustruje ten proces:

import { test, expect } from '@playwright/test';
import { pdfParser } from '../utils/pdfParser';

test('should verify PDF content', async ({ page }) => {
  await page.goto('https://example.com/download-pdf');
  const [download] = await Promise.all([
    page.waitForEvent('download'),
    page.click('text=Download PDF'),
  ]);

  const filePath = await download.path();
  const pdfData = await pdfParser(filePath);

  expect(pdfData.text).toContain('Oczekiwany tekst w pliku PDF');
});

W powyższym teście wykonujemy następujące kroki:

Przejście do strony pobierania: Przechodzimy do strony, z której możemy pobrać plik PDF, używając metody page.goto.
Pobranie pliku PDF: Klikamy przycisk pobierania i czekamy na zakończenie pobierania pliku za pomocą page.waitForEvent oraz page.click.
Parsowanie pliku PDF: Korzystamy z funkcji pdfParser, aby odczytać zawartość pobranego pliku PDF.
Weryfikacja treści: Sprawdzamy, czy treść PDF zawiera oczekiwany tekst za pomocą metody expect.

Zarządzanie pobranymi dokumentami PDF

Po zakończeniu testów warto zadbać o porządek i usunąć pobrane pliki, aby uniknąć zaśmiecania przestrzeni dyskowej. W tym celu stworzymy funkcję cleanupAction, która usuwa wszystkie pliki PDF z określonego katalogu.

Implementacja metody usuwania plików PDF

Poniżej przedstawiamy przykładową implementację funkcji cleanupAction:.

import fs from "fs";
import path from "path";

function cleanupAction(directory) {
  const files = fs.readdirSync(directory);

  files.forEach((file) => {
    const filePath = path.join(directory, file);
    if (fs.existsSync(filePath) && filePath.endsWith(".pdf")) {
      fs.unlinkSync(filePath);
      console.log(`Usunięto plik pdf: ${filePath}`);
    }
  });
}

export { cleanupAction };

Funkcja cleanupAction przeszukuje podany katalog za pomocą fs.readdirSync. Następnie, znajduje wszystkie pliki PDF i usuwa je przy użyciu fs.unlinkSync. Dla każdego usuniętego pliku logowana jest informacja o jego usunięciu.

Wykorzystanie hooka afterAll()

W celu automatycznego usuwania plików po zakończeniu testów dodamy hook afterAll() do naszego pliku testowego. Hook ten jest wywoływany po zakończeniu wszystkich testów w danym pliku. Oznacza to, że możemy go użyć do wykonywania czynności sprzątających, takich jak usuwanie tymczasowych plików, które zostały pobrane w trakcie testów.

Hooki w Playwright to specjalne funkcje, pozwalające na definiowanie czynności, które mają być wykonane w określonych momentach cyklu życia testów. Hook afterAll() jest szczególnie przydatny w sytuacjach, gdy chcemy wykonać pewne operacje po zakończeniu wszystkich testów. Przykładowo, możemy użyć go do czyszczenia zasobów, zamykania połączeń, czy usuwania tymczasowych plików, jak w naszym przypadku plików PDF.

Oto jak można użyć hooka afterAll() w naszym pliku testowym:

import { cleanupAction } from '../utils/cleanupAction';

test.afterAll(() => {
  const downloadDirectory = './downloads';
  cleanupAction(downloadDirectory);
});

W tym przykładzie, po zakończeniu wszystkich testów w pliku, zostanie wywołana funkcja cleanupAction, która usunie pliki PDF z katalogu ./downloads. Dzięki temu nie musimy się martwić o ręczne czyszczenie katalogu po każdym teście.

Dlaczego warto skorzystać z hooka afterAll()?

Korzystanie z hooka afterAll() w kontKorzystanie z hooka afterAll() w kontekście usuwania pobranych plików PDF ma kilka zalet:

Automatyzacja: Automatyczne usuwanie plików po zakończeniu testów eliminuje konieczność ręcznego czyszczenia katalogów, co jest bardziej efektywne i mniej podatne na błędy ludzkie.
Porządek: Utrzymanie porządku w środowisku testowym jest kluczowe, szczególnie w przypadku dużych projektów. Usuwanie niepotrzebnych plików zapobiega zaśmiecaniu przestrzeni dyskowej.
Cykliczność: Hook afterAll() zapewnia, że czyszczenie zasobów jest wykonywane konsekwentnie po każdym cyklu testów, co zwiększa niezawodność i powtarzalność testów.
Optymalizacja zasobów: Usuwanie plików po testach zwalnia przestrzeń dyskową, co jest istotne zwłaszcza przy ograniczonych zasobach serwera testowego.

Dzięki zastosowaniu hooka afterAll(), funkcja cleanupAction zostanie wywołana po zakończeniu testów, co zapewni, że pobrane pliki PDF zostaną usunięte.

Podsumowanie

Automatyzacja weryfikacji treści generowanych dokumentów PDF oraz zarządzanie nimi po zakończeniu testów jest kluczowym elementem zapewniania jakości aplikacji. Korzystając z narzędzia Playwright oraz bibliotek fs i pdf-parse, możemy efektywnie i dokładnie weryfikować treść dokumentów PDF. Przedstawione metody parsowania i weryfikacji treści, a także zarządzania plikami po zakończeniu testów, pozwalają na stworzenie kompleksowego i niezawodnego procesu testowania.

Podczas weryfikacji treści dokumentów PDF warto zwrócić uwagę na kilka kluczowych aspektów. Przede wszystkim powinniśmy upewnić się, że dokumenty zawierają wszystkie oczekiwane informacje i są zgodne z wymaganiami. Warto również sprawdzić formatowanie tekstu i układ dokumentów. Błędy w tych obszarach mogą prowadzić do nieprawidłowych interpretacji danych lub trudności w odczytywaniu ich przez użytkowników.

Równie ważne jest zarządzanie plikami po zakończeniu testów, ponieważ pozwala utrzymać porządek w środowisku testowym. Usuwanie pobranych plików zapobiega zaśmiecaniu przestrzeni dyskowej i ułatwia zarządzanie zasobami. Warto rozważyć automatyzację tego procesu, aby zapewnić, że jest on wykonywany konsekwentnie i bez błędów.

Automatyzacja weryfikacji treści dokumentów PDF i zarządzanie nimi to nie tylko sposób na zwiększenie efektywności testowania, ale także na zapewnienie wyższej jakości i niezawodności aplikacji. Dzięki odpowiednim narzędziom i technikom możemy znacząco poprawić proces testowania, minimalizując ryzyko błędów i zapewniając, że nasze aplikacje spełniają standardy jakości. Implementacja tych rozwiązań przynosi korzyści zarówno dla zespołów developerskich, jak i dla użytkowników końcowych, którzy mogą korzystać z bardziej dopracowanych i wiarygodnych produktów.