haskell-servant/servant

Split ClientSpec

Open

#1129 opened on Feb 18, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Haskell (1,953 stars) (422 forks)batch import
help wantednewcomer-friendlyservant-client

Description

  • let's have common test utilities in own module
  • and split specs into separate ones

having huge ClientSpec.hs makes it more difficult to add tests, as there are no structure in place.

Contributor guide

Tech stack
None
Domain
testingdeveloper experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
basic Haskelltest framework knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue is to split the large 'ClientSpec.hs' file into separate modules: one for common test utilities and individual spec files. Look at the current file structure in the repository, particularly the test directory. Identify the content that is reused across tests and extract it into a shared module. Then split the remaining test cases into logically grouped spec files. No existing PRs or maintainer comments provide additional guidance, so the contributor can follow common Haskell project conventions for test organization.