New noteGoldenFile function

Author: newhoggy

cardano-cli/cardano-cli.cabal

@@ -519,6 +519,7 @@ test-suite cardano-cli-golden
     Test.Golden.Shelley.Transaction.Id
     Test.Golden.Shelley.Transaction.Sign
     Test.Golden.TxView
+    Test.Golden.Util
     Test.Golden.Version
 
   ghc-options:

cardano-cli/test/cardano-cli-golden/Test/Golden/Util.hs

@@ -0,0 +1,23 @@
+module Test.Golden.Util where
+
+import Data.Text qualified as Text
+import GHC.Exts qualified as GHC
+import GHC.Stack (HasCallStack)
+import GHC.Stack qualified as GHC
+import System.FilePath (joinPath)
+
+import Hedgehog.Extras (UnitIO)
+import Hedgehog.Extras qualified as H
+
+noteGoldenFile
+  :: HasCallStack
+  => FilePath
+  -> UnitIO FilePath
+noteGoldenFile fileName =
+  GHC.withFrozenCallStack $ do
+    case GHC.toList GHC.callStack of
+      top : _ -> do
+        let dirs = Text.unpack $ Text.intercalate "/" $ Text.splitOn "." $ Text.pack $ GHC.srcLocModule (snd top)
+
+        H.note $ joinPath ["test/cardano-cli-golden/files/golden", dirs, fileName]
+      _ -> H.failMessage GHC.callStack $ "No call stack available for golden file: " <> fileName