ipfs/ipfs-desktop

Improve Test Suite

Open

#1,121 opened on Sep 13, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (912 forks)batch import
P2effort/daysexp/intermediatehelp wantedkind/maintenance

Repository metrics

Stars
 (5,632 stars)
PR merge metrics
 (Avg merge 8d 12h) (6 merged PRs in 30d)

Description

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 direction
Start by writing unit tests for individual files, focusing on mocking dependencies. Then attempt to add E2E tests for menubar interaction, global shortcuts, adding IPFS to PATH, and protocol handlers using Spectron or alternative methods.
Tech stack
javascript
Domain
desktop
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaScriptJestSpectron
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60