typelevel/cats-effect

TestKit: how to set the Clock?

Open

#3,309 opened on Dec 6, 2022

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Scala (2,230 stars) (572 forks)batch import
:mushroom: enhancementgood first issue

Description

Use case: I have am writing an implementation of IETF http message signatures. The spec has a lot of examples of signed HTTP messages signed with a validity period. To test the library I would like to set the Clock to a specific valid time and to invalid times, to check that the implementation is correct, i.e. that it fails a correct signature when the date is no longer valid.

I have spent at a few hours looking through the isses that led to the test runtime including the very nice documentation, looked at the source code, issues that led to it. But I could not find out how to do that... I may be missing something obvious...

Contributor guide

Tech stack
scala
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.
half day
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
Scalacats effect TestKit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests a way to set the Clock in cats effect TestKit for testing time sensitive logic like HTTP message signatures. The relevant source code is in the testkit module, specifically the TestContext class, which provides the test runtime. Researchers should examine the TestContext source to see if a setClock method exists or needs to be added. The issue body links to the test runtime documentation and a related PR. Checking the issue comments for maintainer feedback on feasibility and implementation details is recommended.