avh4/elm-format

Reorganize test suite

Open

#429 opened on Nov 24, 2017

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Haskell (1,329 stars) (148 forks)batch import
help wantedmaintenance

Description

(help wanted: I'd love to have help with this, but if you're interested, please coordinate with me about it, since it will affect a lot of parts of codebase)

Goals:

  • portable (prefer haskell over shell scripts)
  • easy to add new tests
  • easy to find all tests that relate to a particular syntax
  • fast (both quick to run, and quick to recompile while developing)
  • easy to see what the failure is when a test fails

New tests should:

  • allow input Elm code specified as text
  • allow expected output (formatted) Elm code specified as text
  • (future) allow expected AST to be specified as JSON text
  • be written in Haskell (not depend on bash scripts)

New tests probably should:

  • allow examples to be specified for individual AST node types (instead of having all tests specify fully-valid Elm source files)
  • allow example input/output to be specified in text files instead of being inline in haskell files
  • (future) somehow be associated to the syntax/format documentation

maybe should:

  • organize formatting code for each AST type next to the corresponding parser

Lessons learned:

  • testing parser by having tests that verify haskell AST output is too hard to maintain

Contributor guide

Tech stack
None
Domain
testing
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
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
Haskellelm format codebasetest suite structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
15
Research direction
This issue proposes reorganizing the test suite of elm format. The maintainer requests coordination before starting. The issue is from 2017 and has an assignee but no comments or PRs. To proceed, one should review the current test structure at https://github.com/avh4/elm format, understand the existing Haskell based tests, and propose a plan aligning with the listed goals.
Reorganize test suite · avh4/elm-format#429 | Good First Issue