Was ist Rauchprüfung? Erstellen Sie Verifikationstests, die anhand von Beispielen erläutert werden

Das kommt mir vielleicht bekannt vor: Jemand hat Code in die Produktion verschoben, und jetzt ist eine wichtige Funktion defekt. Wie können Sie dies in Zukunft verhindern?

über GIPHY

In diesem Tutorial erfahren Sie mehr über Rauchtests und wie sie helfen, Fehler zu erkennen. Anschließend testen Sie eine Webanwendung nach einem Zeitplan und senden Warnungen, wenn die Tests fehlschlagen. Lass uns anfangen!

  1. Was ist eine Rauchprüfung?
  2. Warum sollte es dich interessieren?
  3. Richten Sie Ihr Projekt ein
  4. Erstellen Sie einen Rauchtest
  5. Überprüfen Sie den Testcode
  6. Führen Sie Ihren Test lokal aus
  7. Führen Sie Tests in GitHub-Aktionen aus
  8. Richten Sie Warnungen mit Slack ein
  9. Fazit

1. Was ist eine Rauchprüfung?

Der Begriff "Rauchtest" stammt ursprünglich aus der Reparatur von Hardware. Ein Gerät wurde eingeschaltet und bestand den Rauchtest nicht, wenn es in Brand geriet. Rauchprüfung wird manchmal als "Build Verification Testing" bezeichnet.

Bei Anwendung auf Webanwendungen bestätigen Rauchtests, dass die wichtigste Funktionalität funktioniert. Zum Beispiel können Rauchtests auf Netflix das Anmelden und Abspielen eines Videos umfassen.

Rauchprüfungen decken konstruktionsbedingt nicht jede Permutation und jeden Randfall ab. Sie überprüfen stattdessen, ob Ihre Anwendung nicht so kaputt ist, dass zusätzliche Tests Zeitverschwendung wären.

2. Warum sollte es dich interessieren?

Rauchtests bieten einen hohen Wert im Verhältnis zu dem Aufwand, der erforderlich ist, um sie zu erstellen. Laut Microsoft sind Rauchtests nach Codeüberprüfungen "die kostengünstigste Methode zur Identifizierung und Behebung von Softwarefehlern".

über GIPHY

Nur wenige Tests kritischer Funktionen wie Anmelden können die Qualität erheblich verbessern. Wenn Sie testen, was Benutzer am häufigsten tun, wird sichergestellt, dass die Hauptanwendungsfälle Ihrer Anwendung unterstützt werden.

Rauchtests geben Ihrem Team auch das Vertrauen, neuen Code zu versenden. Änderungen an Ihrer Codebasis haben häufig unbeabsichtigte und unbekannte Folgen. Rauchtests bieten zusätzliche Sicherheit, dass Ihre Anwendung nicht kaputt geht, wenn Sie diese fantastische neue Funktion veröffentlichen.

Wenn Sie in der Produktion Rauchtests durchführen, können Sie auch Fehler erkennen, die bei früheren Tests übersehen wurden. Selbst kleine Unterschiede zwischen Umgebungen wie Staging und Produktion können Probleme verursachen. Rauchtests können diese Probleme identifizieren, bevor ein Kunde dies tut.

Kurz gesagt, Rauchtests bieten Ihnen einen weiteren Schutz vor einer schlechten Benutzererfahrung. Eine reibungslos laufende Anwendung hilft Ihrem Team, Ihrem Unternehmen und Ihren Kunden, erfolgreicher zu sein.

3. Richten Sie Ihr Projekt ein

Nachdem wir nun gelernt haben, was Rauchprüfung ist, bauen wir eine Rauchprüfpipeline!

über GIPHY

In diesem Tutorial wird davon ausgegangen, dass Sie die Befehlszeile verstehen, Node.js npminstalliert haben und die Grundlagen von JavaScript und Git kennen.

Sie können Ihre Tests in einem vorhandenen Projekt einrichten oder ein neues erstellen. Führen Sie zum Erstellen eines neuen Projekts Folgendes in der Befehlszeile aus.

mkdir smoke_tests cd smoke_tests

Wenn Sie dies noch nicht getan haben, initialisieren Sie Ihr Projekt, damit Sie Node.js-Pakete installieren können.

npm init -y

Lassen Sie uns nun die Werkzeuge installieren, die wir zum Erstellen unserer Rauchtests benötigen. In diesem Tutorial werden Playwright- und Jest-Tests in einer Webanwendung erstellt. Playwright ist eine von Microsoft entwickelte Bibliothek zur Automatisierung von Chromium-, Firefox- und WebKit-Browsern. Jest ist ein Framework zum Erstellen und Ausführen von JavaScript-Tests.

Um unsere Tests schnell zu erstellen und auszuführen, verwenden wir die Open-Source-QA-Wolf-Bibliothek, die ich pflege. QA Wolf konvertiert Ihre Browseraktionen in Playwright / Jest-Testcode. Es führt Ihre Tests auch in einem CI-Anbieter wie GitHub Actions aus.

Wenn Sie ein anderes Testframework verwenden möchten, können Sie diesem Lernprogramm weiterhin folgen, um Ihre Tests in CI auszuführen und Warnungen einzurichten.

Führen Sie Folgendes in Ihrem Projektverzeichnis aus, um Ihr Projekt für Rauchtests einzurichten.

npm init qawolf

Sie werden aufgefordert, das Verzeichnis anzugeben, in dem Ihre Tests gespeichert werden. Drücken Sie die Eingabetaste, um das Standardverzeichnis zu verwenden .qawolf, oder geben Sie einen anderen Namen ein.

? rootDir: Directory to create tests in (.qawolf)

In der Befehlszeile wird dann ein Hinweis angezeigt, der angibt, ob Ihre Tests TypeScript verwenden. Unser Beispielprojekt hat keine "tsconfig.json" -Datei, daher verwenden unsere Tests kein TypeScript.

TypeScript ✖️ tsconfig.json not found

Der letzte Schritt ist die Auswahl Ihres CI-Anbieters. In diesem Tutorial werden GitHub-Aktionen verwendet. Sie können jedoch auch einen anderen Anbieter auswählen, wenn Sie möchten. Wählen Sie Ihren CI-Anbieter in der Befehlszeile aus und drücken Sie die Eingabetaste.

? Choose CI Provider (Use arrow keys) Azure DevOps Bitbucket Pipelines CircleCI ❯ GitHub Actions GitLab CI/CD Jenkins Skip CI setup 

Die für Rauchtests benötigten Pakete (Playwright, Jest und QA Wolf) werden dann installiert.

In Ihrem Projekt werden auch zwei Dateien erstellt. Die erste ist eine Workflowdatei, mit der Sie Ihre Tests in CI ausführen können. Da wir GitHub-Aktionen ausgewählt haben, wird diese Datei unter ".github / workflows / qawolf.yml" gespeichert. Wir werden diese Datei später diskutieren.

Es gibt auch eine Konfigurationsdatei, die unter "qawolf.config.js" erstellt wurde. Wir müssen diese Datei nicht bearbeiten, aber Sie können hier mehr darüber erfahren.

Überprüfen Sie nach Abschluss der Installation der Abhängigkeiten, ob die Installation erfolgreich war.

npx qawolf howl

4. Erstellen Sie einen Rauchtest

Nachdem unser Projekt eingerichtet ist, erstellen wir unseren ersten Rauchtest. In diesem Tutorial erstellen wir einen Rauchtest für TodoMVC, eine einfach durchzuführende Anwendung. Insbesondere werden wir testen, ob wir können

  1. ein Aufgabenelement erstellen,
  2. vervollständige es und
  3. klar abgeschlossene Aufgaben.

Um unseren Test zu erstellen, verwenden wir den npx qawolf createBefehl. Dieser Befehl verwendet die URL Ihrer Anwendung und einen optionalen Testnamen. Wenn Sie diesen Befehl ausführen, wird ein Chromium-Browser geöffnet, in dem Ihre Aktionen in Playwright / Jest-Code konvertiert werden.

Führen Sie in der Befehlszeile Folgendes aus. Sie können optional durch //todomvc.com/examples/reacteine andere URL und myFirstTesteinen anderen Namen ersetzen .

npx qawolf create //todomvc.com/examples/react myFirstTest

Öffnen Sie Ihren Code-Editor und suchen Sie Ihre Testdatei (in unserem Beispiel ".qawolf / myFirstTest.test.js"). Hier wird Ihr Testcode erstellt, wenn Sie den Browser verwenden.

Führen Sie die folgenden Aktionen aus, nachdem der Chromium-Browser für TodoMVC geöffnet wurde.

  1. Klicken Sie auf die ToDo-Eingabe, um sie zu fokussieren
  2. Geben Sie "create test!"
  3. Drücken Sie Enter
  4. Klicken Sie hier, um die Aufgabe abzuschließen
  5. Klicken Sie auf "Abgeschlossen löschen", um abgeschlossene Aufgaben zu löschen
  6. Markieren Sie in der Befehlszeile ? Save and Exitund drücken Sie die Eingabetaste, um Ihren Test zu speichern

Das folgende Video bietet ein Beispiel.

5. Überprüfen Sie den Testcode

Schauen wir uns nun unseren Testcode an. Öffnen Sie in Ihrem Code-Editor Ihre Testdatei (in unserem Beispiel ".qawolf / myFirstTest.test.js").

Zu Beginn unseres Tests importieren wir qawolf. Wir importieren auch Elemente selectorsaus ".qawolf / selectors / myFirstTest.json", auf die wir gleich noch eingehen werden.

const qawolf = require("qawolf"); const selectors = require("./selectors/myFirstTest.json");

The test then launches a Playwright browser, which in our case is a Chromium browser. It creates a new Playwright browserContext, which is an incognito browser session. QA Wolf is given access to the context so it can detect your actions. Finally, a new Playwright page is created, opening a new tab in the browser.

let browser; let page; beforeAll(async () => { browser = await qawolf.launch(); const context = await browser.newContext(); await qawolf.register(context); page = await context.newPage(); });

The test itself is contained in a Jest test block with the name you specified. The test first navigates to the TodoMVC URL. It then goes through the actions you took: create a todo item, complete it, and clear completed todos. Each action uses one of Playwright's page methods, like click and type.

test('myFirstTest', async () => { await page.goto("//todomvc.com/examples/react"); await page.click(selectors["0_what_needs_to_b_input"]); await page.type(selectors["1_what_needs_to_b_input"], "create test!"); await page.press(selectors["2_what_needs_to_b_input"], "Enter"); await page.click(selectors["3_input"]); await page.click(selectors["4_button"]); });

The first argument passed to each page method is an HTML selector. This selector tells Playwright what element to interact with, like the todo input or "Clear completed" button. These selectors are imported from the  ".qawolf/selectors/myFirstTest.json" file, which looks like the following.

{ "0_what_needs_to_b_input": "html= ", // ... } 

Every attribute of the element you interacted with, as well as those of its two ancestors, is stored in this file. When you run your test, it will do its best to find a good enough match to the specified HTML. By not relying on a single attribute, your tests are more robust to changes in your front end code.

Playwright page methods also support other types of selectors, such as CSS selectors or text selectors. For example, you can replace selectors["4_button"] in the last step with the CSS selector '.clear-completed'.

test('myFirstTest', async () => { // ... // change this await page.click(selectors["4_button"]); // to this (CSS selector) await page.click('.clear-completed'); });

You can optionally configure QA Wolf to use test attributes like data-qa in the generated code whenever possible. See this guide to learn more.

After the test finishes running, QA Wolf stops recording any videos of the browser if applicable. The browser is also closed.

afterAll(async () => { await qawolf.stopVideos(); await browser.close(); });

Putting it all together, the complete test code looks like this.

const qawolf = require("qawolf"); const selectors = require("./selectors/myFirstTest.json"); let browser; let page; beforeAll(async () => { browser = await qawolf.launch(); const context = await browser.newContext(); await qawolf.register(context); page = await context.newPage(); }); afterAll(async () => { await qawolf.stopVideos(); await browser.close(); }); test("myFirstTest", async () => { await page.goto("//todomvc.com/examples/react"); await page.click(selectors["0_what_needs_to_b_input"]); await page.type(selectors["1_what_needs_to_b_input"], "create test!"); await page.press(selectors["2_what_needs_to_b_input"], "Enter"); await page.click(selectors["3_input"]); await page.click(selectors["4_button"]); });

If the test cannot complete the workflow, it will fail. You are welcome to edit your test code, such as by adding assertions. We won't go into that in this tutorial, but here is a guide if you'd like to learn more.

Now that we understand our test code, let's run our test!

6. Run your test locally

Let's run our test locally to make sure it works. In the command line, run the following to run your test(s) with Jest.

npx qawolf test

You should see a Chromium browser open and run the test. Your test will run as fast as possible, so don't be surprised if it runs quickly.

The video below provides an example.

7. Run tests in GitHub Actions

In this tutorial we'll run our tests on a schedule, such as every hour. Running tests on a schedule ensures that your application is working on an ongoing basis. It can also expose periodic issues, or "flakes", that only appear sometimes.

In this tutorial we use GitHub Actions to run our tests. GitHub Actions is a tool to automate software workflows, such as deploying a web service or testing an application.

Review workflow file

When we set up our project, a YAML file called ".github/workflows/qawolf.yml" was created. We'll first briefly go through the different parts of this file. We will then update it so our tests run on a schedule.

The first line of the workflow file names our workflow. This is the name that will show up in GitHub Actions, and you can change it if you like.

name: qawolf

The on key then specifies what event should trigger our tests to run. By default, your tests will run whenever someone pushes to any branch. We will soon edit this to also run our tests on a schedule.

on: push: # test every branch # edit below if you only want certain branches tested branches: "*" # schedule: # # test on schedule using cron syntax # - cron: "0 * * * *" # every hour

The rest of the file defines what GitHub Actions should do when it runs. GitHub Actions will run whatever jobs are listed under the jobs key. In our case we have just one job that runs our tests.

Specifically, our test job installs dependencies, checks out our code, and runs our test command npx qawolf test. After the test(s) run, debug artifacts like console logs and videos are saved.

jobs: test: runs-on: ubuntu-18.04 steps: - name: Install dependencies run: | sudo apt update # chromium dependencies sudo apt-get install libgbm1 # webkit dependencies sudo apt-get install libwoff1 libopus0 libwebp6 libwebpdemux2 libenchant1c2a libgudev-1.0-0 libsecret-1-0 libhyphen0 libgdk-pixbuf2.0-0 libegl1 libgles2 libevent-2.1-6 libnotify4 libvpx5 libxslt1.1 - uses: actions/[email protected] - uses: actions/[email protected] - uses: actions/[email protected] with: path: ~/.npm key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- - run: npm install # - name: Start local server # run: npm run start & npx wait-on //localhost:3000 - run: npx qawolf test --headless env: # configure tests with environment variables QAW_ARTIFACT_PATH: ${{ github.workspace }}/artifacts # you can also use GitHub secrets for environment variables # //help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets # LOGIN_PASSWORD: ${{ secrets.PASSWORD }} - name: Upload Artifacts if: always() uses: actions/[email protected] with: name: qawolf path: ${{ github.workspace }}/artifacts

Run tests in GitHub Actions

Now that we understand our workflow file a bit better, let's run it in GitHub Actions. If you have not already, create a Git repository for your project. Make sure to ignore node_modules/ in your ".gitignore" file.

git init git add . git commit -m "Initial commit"

Make sure you have created a repository for your project on GitHub. Then push your code to GitHub.

git remote add origin YOUR_REPOSITORY_URL git push -u origin master

See this GitHub repository for an example.

Now go to your GitHub repository and click on the "Actions" tab, which is next to the "Pull Requests" tab.

You will see that your tests are running. This is because our workflow file told GitHub to run our tests whenever anyone pushed to any branch. Click on the workflow run to view details. Note that the name will vary depending on your commit message.

After your test runs, you should see a green check mark indicating that the workflow was successful. You should also see a link to download artifacts (video and logs) under "Artifacts". Click on this link to download test artifacts.

The artifacts are organized with one folder per test. In our example, we only have one test called "myFirstTest.test.js". Open this folder to see browser logs in the file "logs_0_${timestamp}.txt" and a video "video_0_${timestamp}.mp4". The 0 in the file names refers to the page index. If your test involved more than one page, there would be corresponding logs and videos for each additional page.

Now let's update our workflow file to also run our tests on a schedule. In the ".github/workflows/qawolf.yml" file, comment in lines 7-9.

name: qawolf on: push: # test every branch # edit below if you only want certain branches tested branches: "*" schedule: # test on schedule using cron syntax - cron: "0 * * * *" # every hour

These lines tell GitHub to run your tests on a schedule specified using cron syntax. The default value is "0 * * * *", which means run every hour on the hour. Update this value if you would like to use a different time interval.

We will change one more thing about our workflow file. GitHub Actions has a storage limit for artifacts, so we don't want to upload them every time. Instead we will only upload logs and videos when the tests fail. Update line 51 from if: always() to if: failure().

# ... - name: Upload Artifacts if: failure() uses: actions/[email protected] with: name: qawolf path: ${{ github.workspace }}/artifacts 

Commit your changes and push them to GitHub.

git add . git commit -m "Run tests on a schedule" git push

Now your smoke tests will run every hour on GitHub Actions!

8. Set up alerts with Slack

The last piece of our pipeline is an alerting system that lets us know when our tests fail. In this tutorial we use Slack because it has a free plan. You can also use a service like PagerDuty, which will have a similar setup process.

via GIPHY

If you do not already have a Slack account and workspace, create them now.

Create Slack webhook

We will now create a Slack webhook, which is a URL that allows us to send Slack messages programmatically. We will make a POST request to this URL when our tests fail.

First we need to create a Slack app, which will be responsible for sending our alert messages. Get started by visiting the Slack API website. In the top right hand corner is a green button to "Create New App".

Click on this button and you will be prompted to name your Slack app and choose a workspace. In our example, we call our app "smoke-tests". After you have filled out the form, click the green "Create App" button.

You should be redirected to your app's page in Slack. Make sure you are on the "Basic Information" page under "Settings". Under "Add features and functionality", there is a link for "Incoming Webhooks". Click on this link.

On the Incoming Webhooks page, click on the toggle to turn on incoming webhooks.

You will then be able to see the "Add New Webhook to Workspace" button at the bottom of the page. Click this button to add a new webhook. We will use this webhook to send a Slack message when our tests fail.

You will then be prompted to choose the channel where your messages will be posted. In our example, we select the "alerts" channel. After choosing your channel, click the green "Allow" button.

You will be redirected to the webhooks page. Under "Webhook URLs for Your Workspace", you now should see your webhook URL.

To test your webhook, copy the code under "Sample curl request to post to a channel". It will look something like the following.

curl -X POST -H 'Content-type: application/json' --data '{"text":"Hello, World!"}' //hooks.slack.com/services/SECRET

Paste this in the command line and press Enter. You will see the message "Hello, World!" posted to the channel you specified.

Send alert when tests fail

Now that we have our Slack webhook, we need to update our GitHub Actions workflow file. We will add a step that makes a POST request to our webhook when the tests fail.

Rather than paste our webhook URL into our workflow file directly, we will add it to our repository secrets. Secrets are encrypted environment variables that store sensitive information. Keeping our webhook URL secret prevents others from seeing it and potentially using it for evil. ?

Add a new secret under your repository settings. Call your secret SLACK_WEBHOOK_URL, and set its value to your Slack webhook URL. The video below provides an example.

Now let's update our workflow file. At the bottom of the ".github/workflows/qawolf.yml" file, add the following lines. These lines tell GitHub to make a POST request to your Slack webhook when your tests fail. We changed the value passed to "text" from "Hello, World!" to "Smoke tests failed!", but you can use whatever message you like.

Note that we do not use the value of our Slack webhook URL directly, but instead replace it with ${{ secrets.SLACK_WEBHOOK_URL }}.

# ... - name: Upload Artifacts if: failure() uses: actions/[email protected] with: name: qawolf path: ${{ github.workspace }}/artifacts # add the following lines - name: Post Slack Message if: failure() run: | curl -X POST -H 'Content-type: application/json' --data '{"text":"Smoke tests failed!"}' ${{ secrets.SLACK_WEBHOOK_URL }}

If you would like to test that your webhook works, throw an error in your test file ".qawolf/myFirstTest.test.js". Then push your changes to GitHub.

test("myFirstTest", async () => { await page.goto("//todomvc.com/examples/react"); await page.click(selectors["0_what_needs_to_b_input"]); await page.type(selectors["1_what_needs_to_b_input"], "create test!"); await page.press(selectors["2_what_needs_to_b_input"], "Enter"); await page.click(selectors["3_input"]); await page.click(selectors["4_button"]); // add this line throw new Error("demogorgon!"); });

Your test will fail, and a message will be posted in Slack. You will also be able to download artifacts.

After you are done testing your webhook, make sure to remove the error from your test code.

9. Conclusion

If you made it this far, congratulations! ?

via GIPHY

In this tutorial we learned about smoke tests and built a smoke testing pipeline. Now you can be your team's smoke testing hero! ?

If your team needs help with QA, or if you just want to chat, please drop me a line at [email protected] ?