Golden test suite for snapshot codec #499
Conversation
recursion-ninja
requested review from
dcoutts,
jorisdral,
mheinzel and
wenkokke
as code owners
|
So a big question I have is should this be a stand alone test suite (as it currently is) or should I graft it into the "monolithic" LST Tree test suite. I think the later might be more appropriate, and would appreciate a pointer as to where a good place in the |
jorisdral
changed the title
lsm-tree.cabal
Outdated
| test-suite codec-test | ||
| import: language, warnings, wno-x-partial | ||
| type: exitcode-stdio-1.0 | ||
| hs-source-dirs: test | ||
| main-is: codec-test.hs | ||
| build-depends: | ||
| , base >=4.14 && <4.22 | ||
| , fs-api ^>=0.3 | ||
| , lsm-tree | ||
| , tasty | ||
| , tasty-golden | ||
| , vector |
There was a problem hiding this comment.
I'd suggest to put the tests into Test.Database.LSMTree.Internal.Snapshot.Codec.Golden, and the golden files in to test/golden/snapshot-codec or something similar
There was a problem hiding this comment.
Great insight. I'm refactored the golden test cases' location on disk and within the TestTree.
test/codec-test.hs
Outdated
| {-# LANGUAGE CPP #-} | ||
| {-# LANGUAGE DerivingStrategies #-} | ||
| {-# LANGUAGE GeneralisedNewtypeDeriving #-} | ||
| {-# LANGUAGE OverloadedStrings #-} | ||
| {-# LANGUAGE RankNTypes #-} | ||
| {-# LANGUAGE ScopedTypeVariables #-} |
There was a problem hiding this comment.
I think some of these language pragmas are unnecessary because they are already included in the common language cabal stanza, which the test suite imports
test/codec-test.hs
Outdated
| -- File comparison test-cases against authoritative "golden" files | ||
| testCaseChecksum :: TestTree | ||
| testCaseChecksum = Au.goldenVsFile "checksum" checksumAuPath checksumHsPath noWorkAction | ||
| testCaseSnapshot :: TestTree | ||
| testCaseSnapshot = Au.goldenVsFile "snapshot" snapshotAuPath snapshotHsPath noWorkAction | ||
|
|
||
| -- Be sure to use Tasty's @withResource@ constructor to ensure that the | ||
| -- codec serialization occurs only /once/ and is memoized for the /two/ | ||
| -- golden tests (snapshot & checksum). | ||
| in Tasty.withResource outputAction tidyUpAction $ \tok -> tok `seq` testGroup name | ||
| [ testCaseSnapshot | ||
| , testCaseChecksum | ||
| ] |
There was a problem hiding this comment.
If we leave out the checksums, we can get rid of the withResource trickery
There was a problem hiding this comment.
Yep, that simplification is included in the refactoring.
recursion-ninja
force-pushed
the
recursion-ninja/golden-test-suite
branch
2 times, most recently
from
351d4b2 to
8b0d38e
Compare
…e for serialization backwards compatibility testing.
recursion-ninja
force-pushed
the
recursion-ninja/golden-test-suite
branch
from
8b0d38e to
4c00cf4
Compare
Description
Add the golden test cases to ensure that metadata serialization does not accidentally change. This will help ensure we maintain backwards compatibility. Changes in backwards compatibility should case test case failures.