ipfs/kubo

Optimize sharness tests

Open

#4961 opened on Apr 22, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedkind/test

Description

Some sharness tests take way more time to complete than they have to.

Results from https://ci.ipfs.team/job/IPFS/job/go-ipfs/job/PR-4959/7/testReport/sharnessLinux/ (sort by duration) / https://github.com/ipfs/go-ipfs/pull/4959

  • - t0181-private-network / 12 - try connecting node in public network with priv networks - should timeout way sooner
  • - t0130-multinode - adds a tree of 5k files multiple times, might be a bit overkill, at least of something that isn't a benchmark
  • - t0250-files-api is huuuuge, would be good to split into some separate tests to make use of make parallelism
  • - t0260-sharding operates on quite large directories, not sure if we can do much about it
  • - t0040-add-and-cat does some stuff on large files, but majority of the time spent there seems to be spent in the ton of tests there, might be worth to split too

Contributor guide

Tech stack
shellgo
Domain
testingperformance
Issue type
performance
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
sharness testingshell scripting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue lists specific sharness tests that are slow. The contributor should look at the test files referenced (e.g., t0181 private network, t0130 multinode) and consider reducing timeouts or splitting tests as suggested. The CI results link provides baseline durations to compare. Changes should be made to the test scripts in the repository's test/sharness/ directory.