From ec3262549b2e0c86988b3593464c71f176a66128 Mon Sep 17 00:00:00 2001 From: Robert Speicher Date: Mon, 20 Feb 2017 10:39:51 -0500 Subject: Document Timecop usage for time-sensitive tests --- doc/development/testing.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'doc/development') diff --git a/doc/development/testing.md b/doc/development/testing.md index 761847b2bab..b3c19e396d0 100644 --- a/doc/development/testing.md +++ b/doc/development/testing.md @@ -95,6 +95,25 @@ so we need to set some guidelines for their use going forward: [lets-not]: https://robots.thoughtbot.com/lets-not +### Time-sensitive tests + +[Timecop](https://github.com/travisjeffery/timecop) is available in our +Ruby-based tests for verifying things that are time-sensitive. Any test that +exercises or verifies something time-sensitive should make use of Timecop to +prevent transient test failures. + +Example: + +```ruby +it 'is overdue' do + issue = build(:issue, due_date: Date.tomorrow) + + Timecop.freeze(3.days.from_now) do + expect(issue).to be_overdue + end +end +``` + ### Test speed GitLab has a massive test suite that, without parallelization, can take more -- cgit v1.2.3