ipfs/ipfs-desktop

Improve Test Suite

Open

#1.121 geöffnet am 13. Sept. 2019

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (912 Forks)batch import
P2effort/daysexp/intermediatehelp wantedkind/maintenance

Repository-Metriken

Stars
 (5.632 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T 12h) (6 gemergte PRs in 30 T)

Beschreibung

Right now, we have quite a few unit tests and some end-to-end tests for the launching process. We should aim to improve this and get a better coverage of the code.

Unit Tests

We are aiming for one unit test file per file. The biggest issue with unit tests is the amount of mocking we need to do to make sure we don't have side-effects.

E2E

We are using Spectron for our end-to-end tests and it can sometimes be limiting since we have a menubar application and Spectron does not allow to test menus.

Some interesting E2E tests that we should aim to make (if possible):

  • Test menubar interaction.
  • Test global shortcuts functionality.
  • Test adding ipfs to PATH.
  • Test Protocol Handlers (macOS and Windows only).

Contributor Guide

Research-Richtung
Beginnen Sie mit dem Schreiben von Unit Tests für einzelne Dateien, wobei Sie sich auf das Mocken von Abhängigkeiten konzentrieren. Versuchen Sie dann, E2E Tests für Menüleisteninteraktion, globale Tastenkürzel, Hinzufügen von IPFS zu PATH und Protokoll Handler mit Spectron oder alternativen Methoden hinzuzufügen.
Tech Stack
javascript
Domain
desktop
Issue Type
Test
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
JavaScriptJestSpectron
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60