Golden test suite for snapshot codec #499

recursion-ninja · 2024-12-13T16:04:47Z

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.

recursion-ninja · 2024-12-13T16:07:06Z

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 TestTree to insert them.

jorisdral

The new Bounded and Enum instances should arguably be orphan instances in the test suite. They are not necessary for the core library to function, or necessary for the user to have

jorisdral

Looking good. There are also some comments we discussed over other channels, but I won't repeat them here

lsm-tree.cabal

test/codec-test.hs

jorisdral

Almost LGTM! I do have some minor suggestions, but after that we can probably merge

jorisdral · 2024-12-31T10:16:51Z

src/Database/LSMTree/Internal/MergingRun.hs

@@ -70,7 +70,7 @@ instance RefCounted m (MergingRun m h) where
    getRefCounter = mergeRefCounter

 data MergePolicyForLevel = LevelTiering | LevelLevelling
-  deriving stock (Show, Eq)


I think you might have missed this suggestion: #499 (review)

BTW, did we end up using these instances for the golden tests? It doesn't look like it -- if that's the case, let's remove these instances

I've added review suggestions to undo these changes

jorisdral · 2024-12-31T10:17:44Z

test/Test/Database/LSMTree/Internal/Snapshot/Codec.hs

@@ -47,6 +49,7 @@ tests = testGroup "Test.Database.LSMTree.Internal.Snapshot.Codec" [
        testAll $ \(p :: Proxy a) ->
          testGroup (show $ typeRep p) $
            prop_arbitraryAndShrinkPreserveInvariant @a deepseqInvariant
+    , goldenFileTests


The typical approach we use in this test suite is to include the tests at the top level, so in the Main module

Since I had to do some, semi-yucky I/O in the handleOutputFiles definition, I tired to encapsulate that functionality in the Test.Database.LSMTree.Internal.Snapshot.Codec.Golden module and just export the test cases. Do you have a suggested alteration?

My suggestion is to move the call to goldenFileTests to the Main module

test/Test/Database/LSMTree/Internal/Snapshot/Codec/Golden.hs

…e for serialization backwards compatibility testing.

jorisdral

LGTM. Just a few suggestions to resolve, and then we can squash and merge.

jorisdral · 2025-02-11T11:49:37Z

src/Database/LSMTree/Internal/Config.hs

+  -- @Bounded@ and @Enum@ instances are required for test-case enumeration.
+  deriving stock (Bounded, Enum, Eq, Show)


Suggested change

-- @Bounded@ and @Enum@ instances are required for test-case enumeration.

deriving stock (Bounded, Enum, Eq, Show)

deriving stock (Show, Eq)

jorisdral · 2025-02-11T11:52:51Z

src/Database/LSMTree/Internal/Config.hs

+  -- @Bounded@ and @Enum@ instances are required for test-case enumeration.
+  deriving stock (Bounded, Enum, Eq, Show)


Suggested change

-- @Bounded@ and @Enum@ instances are required for test-case enumeration.

deriving stock (Bounded, Enum, Eq, Show)

deriving stock (Eq, Show)

jorisdral · 2025-02-11T11:52:58Z

src/Database/LSMTree/Internal/Config.hs

+  -- @Bounded@ and @Enum@ instances are required for test-case enumeration.
+  deriving stock (Bounded, Enum, Eq, Show)


Suggested change

-- @Bounded@ and @Enum@ instances are required for test-case enumeration.

deriving stock (Bounded, Enum, Eq, Show)

deriving stock (Eq, Show)

jorisdral · 2025-02-11T11:53:06Z

src/Database/LSMTree/Internal/Config.hs

+  -- @Bounded@ and @Enum@ instances are required for test-case enumeration.
+  deriving stock (Bounded, Enum, Eq, Show)


Suggested change

-- @Bounded@ and @Enum@ instances are required for test-case enumeration.

deriving stock (Bounded, Enum, Eq, Show)

deriving stock (Eq, Show)

jorisdral · 2025-02-11T11:53:12Z

src/Database/LSMTree/Internal/Snapshot.hs

@@ -87,7 +87,7 @@ newtype SnapshotLabel = SnapshotLabel Text

 -- TODO: revisit if we need three table types.
 data SnapshotTableType = SnapNormalTable | SnapMonoidalTable | SnapFullTable
-  deriving stock (Show, Eq)
+  deriving stock (Bounded, Enum, Eq, Show)


Suggested change

deriving stock (Bounded, Enum, Eq, Show)

deriving stock (Eq, Show)

jorisdral · 2025-02-11T11:53:42Z

test/Test/Database/LSMTree/Internal/Snapshot/Codec.hs

@@ -47,6 +49,7 @@ tests = testGroup "Test.Database.LSMTree.Internal.Snapshot.Codec" [
        testAll $ \(p :: Proxy a) ->
          testGroup (show $ typeRep p) $
            prop_arbitraryAndShrinkPreserveInvariant @a deepseqInvariant
+    , goldenFileTests


My suggestion is to move the call to goldenFileTests to the Main module

jorisdral · 2025-02-11T13:10:32Z

test/Test/Database/LSMTree/Internal/Snapshot/Codec/Golden.hs

+testCodecSnapshotLabel :: TestTree
+testCodecSnapshotLabel =
+  let assembler (tagA, valA) =
+        let (tagB, valB) = basicSnapshotTableType
+            (tagC, valC) = basicTableConfig
+            (_tagD, valD) = basicRunNumber
+            (tagE, valE) = basicSnapLevels
+        in  (fuseAnnotations [tagA, tagB, tagC, tagE ], SnapshotMetaData valA valB valC valD valE)
+  in  testCodecBuilder "SnapshotLabels" $ assembler <$> enumerateSnapshotLabel
+
+testCodecSnapshotTableType :: TestTree
+testCodecSnapshotTableType =
+  let assembler (tagB, valB) =
+        let (tagA, valA) = basicSnapshotLabel
+            (tagC, valC) = basicTableConfig
+            (_tagD, valD) = basicRunNumber
+            (tagE, valE) = basicSnapLevels
+        in  (fuseAnnotations [tagA, tagB, tagC, tagE ], SnapshotMetaData valA valB valC valD valE)
+  in  testCodecBuilder "SnapshotTables" $ assembler <$> enumerateSnapshotTableType
+
+testCodecTableConfig :: TestTree
+testCodecTableConfig =
+  let assembler (tagC, valC) =
+        let (tagA, valA) = basicSnapshotLabel
+            (tagB, valB) = basicSnapshotTableType
+            (_tagD, valD) = basicRunNumber
+            (tagE, valE) = basicSnapLevels
+        in  (fuseAnnotations [tagA, tagB, tagC, tagE ], SnapshotMetaData valA valB valC valD valE)
+  in  testCodecBuilder "SnapshotConfig" $ assembler <$> enumerateTableConfig
+
+testCodecSnapLevels :: TestTree
+testCodecSnapLevels =
+  let assembler (tagE, valE) =
+        let (tagA, valA) = basicSnapshotLabel
+            (tagB, valB) = basicSnapshotTableType
+            (tagC, valC) = basicTableConfig
+            (_tagD, valD) = basicRunNumber
+        in  (fuseAnnotations [tagA, tagB, tagC, tagE ], SnapshotMetaData valA valB valC valD valE)
+  in  testCodecBuilder "SnapshotLevels" $ assembler <$> enumerateSnapLevels


Shouldn't _tagD be included in the name?

jorisdral · 2025-02-11T13:11:13Z

src/Database/LSMTree/Internal/MergingRun.hs

@@ -70,7 +70,7 @@ instance RefCounted m (MergingRun m h) where
    getRefCounter = mergeRefCounter

 data MergePolicyForLevel = LevelTiering | LevelLevelling
-  deriving stock (Show, Eq)


I've added review suggestions to undo these changes

recursion-ninja requested review from dcoutts, jorisdral, mheinzel and wenkokke as code owners December 13, 2024 16:04

jorisdral reviewed Dec 16, 2024

View reviewed changes

jorisdral changed the title ~~Recursion ninja/golden test suite~~ Golden test suite for snapshot codec Dec 16, 2024

jorisdral reviewed Dec 16, 2024

View reviewed changes

recursion-ninja force-pushed the recursion-ninja/golden-test-suite branch 3 times, most recently from 8b0d38e to 4c00cf4 Compare December 22, 2024 17:55

recursion-ninja force-pushed the recursion-ninja/golden-test-suite branch from 4c00cf4 to 00e7a07 Compare December 30, 2024 15:57

jorisdral reviewed Dec 31, 2024

View reviewed changes

recursion-ninja force-pushed the recursion-ninja/golden-test-suite branch from 00e7a07 to 97d4d97 Compare February 7, 2025 18:29

Grafting golden tests into the 'Snapshot/Codec' branch of the TestTre…

623031b

…e for serialization backwards compatibility testing.

recursion-ninja force-pushed the recursion-ninja/golden-test-suite branch from 97d4d97 to 623031b Compare February 10, 2025 19:19

jorisdral approved these changes Feb 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Golden test suite for snapshot codec #499

Golden test suite for snapshot codec #499

recursion-ninja commented Dec 13, 2024

recursion-ninja commented Dec 13, 2024

jorisdral left a comment

jorisdral left a comment •

edited

Loading

jorisdral left a comment

jorisdral Dec 31, 2024

jorisdral Dec 31, 2024

jorisdral Feb 11, 2025

jorisdral Dec 31, 2024

recursion-ninja Feb 7, 2025

jorisdral Feb 11, 2025

jorisdral left a comment

jorisdral Feb 11, 2025

jorisdral Feb 11, 2025

jorisdral Feb 11, 2025

jorisdral Feb 11, 2025

jorisdral Feb 11, 2025

jorisdral Feb 11, 2025

jorisdral Feb 11, 2025

jorisdral Feb 11, 2025

		-- @Bounded@ and @Enum@ instances are required for test-case enumeration.
		deriving stock (Bounded, Enum, Eq, Show)

	-- @Bounded@ and @Enum@ instances are required for test-case enumeration.
	deriving stock (Bounded, Enum, Eq, Show)
	deriving stock (Show, Eq)

	-- @Bounded@ and @Enum@ instances are required for test-case enumeration.
	deriving stock (Bounded, Enum, Eq, Show)
	deriving stock (Eq, Show)

Golden test suite for snapshot codec #499

Are you sure you want to change the base?

Golden test suite for snapshot codec #499

Conversation

recursion-ninja commented Dec 13, 2024

Description

recursion-ninja commented Dec 13, 2024

jorisdral left a comment

Choose a reason for hiding this comment

jorisdral left a comment • edited Loading

Choose a reason for hiding this comment

jorisdral left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorisdral left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorisdral left a comment •

edited

Loading