ollef/sixten

Expected error tests

Open

#111 opened on Jun 14, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (631 stars) (24 forks)batch import
Beginner-friendlyHelp wantedType: Feature

Description

We currently have the setup to test that some error occurred during compilation, but we don't test that it's the correct error (other than syntax vs type error) or that it occurs on the correct line.

It'd be nice to be able to annotate source files for testing with expected errors in comments, something like:

x = addInt 1 True -- $expect: Type error: Type mismatch

and then have the setup to verify that that error really occurs there.

Contributor guide

Tech stack
None
Domain
testing
Issue type
feature
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.
mostly clear
Prerequisites
familiarity with Haskellunderstanding of testing infrastructure in sixten
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the existing testing setup for error tests in the sixten repository. Look at how test files are structured and what infrastructure exists for compilation error testing. Examine the possibility of parsing annotations like ` $expect: ...` in source files. Consider implementing a parser for these annotations and integrating them into the test harness. Check if there are any linked issues or pull requests that discuss similar approaches.