haskell-beam/beam

[Suggestions Please] Thoughts on how beam could better support testing

Open

#216 opened on Apr 12, 2018

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Haskell (191 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (631 stars)
PR merge metrics
 (PR metrics pending)

Description

Lately, I've been thinking of how beam could support testing. Beam offers several guarantees that make it easy to compose queries. The Q monad can very reliably be assumed to work like the [] monad, but the [] monad is not always super intuitive. Moreover, something being easy doesn't mean we can neglect testing.

Libraries like quickcheck make it easy to test properties in Haskell. I'm wondering if something similar could be done for beam, to make sure that our queries return the right things.

The nice thing about having this is that we could unit test small queries, and once these are verified to return the right results, we should be able to feel free to combine these queries using beam combinators without worry.

Any suggestions or insight would be appreciated.

Contributor guide

Research direction
Explore existing property based testing libraries like QuickCheck and consider how to integrate with beam's Q monad to write tests for small queries. Propose a design or discuss challenges.
Tech stack
haskell
Domain
databasebackend
Issue type
Feature
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HaskellBeam
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75