Implement diffVsGoldenFileExcludeTrace

Author: Jimbo4350

cardano-cli/src/Cardano/CLI/EraBased/Genesis/Run.hs

@@ -56,6 +56,7 @@ import Cardano.CLI.EraIndependent.Node.Run
   , runNodeKeyGenVrfCmd
   )
 import Cardano.CLI.IO.Lazy qualified as Lazy
+import Cardano.CLI.Read
 import Cardano.CLI.Type.Common
 import Cardano.CLI.Type.Error.GenesisCmdError
 import Cardano.CLI.Type.Error.NodeCmdError

cardano-cli/src/Cardano/CLI/EraBased/Governance/Vote/Run.hs

@@ -5,6 +5,7 @@
 {-# LANGUAGE NamedFieldPuns #-}
 {-# LANGUAGE RankNTypes #-}
 {-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE TypeApplications #-}
 {-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}
 
 {-# HLINT ignore "Redundant id" #-}
@@ -119,5 +120,4 @@ runGovernanceVoteViewCmd
                 )
               $ unVotingProcedures voteProcedures
 
-      fromExceptTCli $
-        writeLazyByteStringOutput mOutFile output
+      fromEitherIOCli @(FileError ()) $ writeLazyByteStringOutput mOutFile output

cardano-cli/src/Cardano/CLI/Legacy/Governance/Run.hs

@@ -23,13 +23,13 @@ import Cardano.CLI.EraBased.Governance.GenesisKeyDelegationCertificate.Run
 import Cardano.CLI.EraBased.Governance.Run
 import Cardano.CLI.Legacy.Governance.Command
 import Cardano.CLI.Orphan ()
+import Cardano.CLI.Read
 import Cardano.CLI.Type.Common
 import Cardano.CLI.Type.Error.GovernanceCmdError
 
 import Control.Monad
 import Data.Aeson (eitherDecode)
 import Data.ByteString.Lazy qualified as LB
-import Data.Text (Text)
 
 runLegacyGovernanceCmds :: LegacyGovernanceCmds -> CIO e ()
 runLegacyGovernanceCmds = \case

cardano-cli/src/Cardano/CLI/Orphan.hs

@@ -25,7 +25,6 @@ import Cardano.Ledger.Conway.Governance qualified as L
 import Cardano.Ledger.State qualified as L
 
 import Data.Aeson
-import Data.Text qualified as Text
 
 instance ToJSON L.DefaultVote where
   toJSON defaultVote =
@@ -69,6 +68,8 @@ instance Convert Era ConwayEraOnwards where
   convert = \case
     Exp.ConwayEra -> ConwayEraOnwardsConway
 
+-- TODO: Convert readVerificationKeySource to use CIO. We can then
+-- remove this instance
 instance
   Error
     ( Either
@@ -83,7 +84,7 @@ instance
     Right e -> prettyError e
 
 instance Error GovernancePollError where
-  prettyError = pshow . Text.unpack . renderGovernancePollError
+  prettyError = pretty . renderGovernancePollError
 
 instance Error String where
-  prettyError = pshow
+  prettyError = pretty

cardano-cli/test/cardano-cli-golden/Test/Golden/Governance/Committee.hs

@@ -390,6 +390,6 @@ hprop_golden_governance_committee_checks_wrong_hash_fails =
 
     exitCode === ExitFailure 1
 
-    H.diffVsGoldenFile
+    diffVsGoldenFileExcludeTrace
       result
       "test/cardano-cli-golden/files/golden/governance/committee/governance_committee_checks_wrong_hash_fails.out"

cardano-cli/test/cardano-cli-golden/Test/Golden/Governance/DRep.hs

@@ -20,7 +20,7 @@ import           System.Posix.Files (fileMode, getFileStatus)
 import           GHC.IO.Exception (ExitCode (ExitFailure))
 import           Test.Cardano.CLI.Hash (exampleAnchorDataHash, exampleAnchorDataIpfsHash,
                    exampleAnchorDataPathGolden, serveFilesWhile, tamperBase16Hash)
-import           Test.Cardano.CLI.Util (execCardanoCLI, execDetailCardanoCLI,
+import           Test.Cardano.CLI.Util (diffVsGoldenFileExcludeTrace, execCardanoCLI, execDetailCardanoCLI,
                    noteInputFile, noteTempFile, propertyOnce)
 
 import           Hedgehog
@@ -502,6 +502,6 @@ hprop_golden_drep_metadata_hash_url_wrong_hash_fails =
 
     exitCode === ExitFailure 1
 
-    H.diffVsGoldenFile
+    diffVsGoldenFileExcludeTrace
       result
       "test/cardano-cli-golden/files/golden/governance/drep/drep_metadata_hash_url_wrong_hash_fails.out"

cardano-cli/test/cardano-cli-golden/Test/Golden/Governance/Vote.hs

@@ -15,7 +15,8 @@ import Test.Cardano.CLI.Hash
   , tamperBase16Hash
   )
 import Test.Cardano.CLI.Util
-  ( execCardanoCLI
+  ( diffVsGoldenFileExcludeTrace
+  , execCardanoCLI
   , execDetailConfigCardanoCLI
   , noteInputFile
   , propertyOnce
@@ -241,4 +242,4 @@ hprop_golden_governance_vote_create_hash_fails =
 
     exitCode === ExitFailure 1
 
-    H.diffVsGoldenFile result voteGold
+    diffVsGoldenFileExcludeTrace result voteGold

cardano-cli/test/cardano-cli-golden/files/golden/governance/committee/governance_committee_checks_wrong_hash_fails.out

@@ -0,0 +1,5 @@
+Command failed: governance committee create-cold-key-resignation-certificate
+Error: Command failed: governance committee create-cold-key-resignation-certificate
+Error: Hashes do not match!
+Expected: "ee38a4f5b8b9d8372386cc923bad19d1a0662298cf355bbe947e5eedf127fa9c"
+  Actual: "de38a4f5b8b9d8372386cc923bad19d1a0662298cf355bbe947e5eedf127fa9c"

cardano-cli/test/cardano-cli-golden/files/golden/governance/drep/drep_metadata_hash_url_wrong_hash_fails.out

@@ -0,0 +1,5 @@
+Command failed: governance drep metadata-hash
+Error: Command failed: governance drep metadata-hash
+Error: Hashes do not match!
+Expected: "ee38a4f5b8b9d8372386cc923bad19d1a0662298cf355bbe947e5eedf127fa9c"
+  Actual: "de38a4f5b8b9d8372386cc923bad19d1a0662298cf355bbe947e5eedf127fa9c"

cardano-cli/test/cardano-cli-golden/files/golden/governance/vote/governance_vote_create_hash_fails.out

@@ -0,0 +1,5 @@
+Command failed: governance vote create
+Error: Command failed: governance vote create
+Error: Hashes do not match!
+Expected: "ee38a4f5b8b9d8372386cc923bad19d1a0662298cf355bbe947e5eedf127fa9c"
+  Actual: "de38a4f5b8b9d8372386cc923bad19d1a0662298cf355bbe947e5eedf127fa9c"

cardano-cli/test/cardano-cli-test-lib/Test/Cardano/CLI/Util.hs

@@ -9,6 +9,7 @@ module Test.Cardano.CLI.Util
   ( assertDirectoryMissing
   , checkTxCddlFormat
   , checkTextEnvelopeFormat
+  , diffVsGoldenFileExcludeTrace
   , equivalence
   , execCardanoCLI
   , execCardanoCLIWithEnvVars
@@ -42,6 +43,7 @@ import Data.Function ((&))
 import Data.List qualified as List
 import Data.Monoid (Last (..))
 import Data.Text (Text)
+import Data.Text qualified as Text
 import GHC.IO.Exception (ExitCode (..))
 import GHC.Stack (CallStack, HasCallStack)
 import GHC.Stack qualified as GHC
@@ -57,6 +59,7 @@ import Hedgehog qualified as H
 import Hedgehog.Extras (ExecConfig)
 import Hedgehog.Extras qualified as H
 import Hedgehog.Extras.Test (ExecConfig (..))
+import Hedgehog.Extras.Test.Golden qualified as H
 import Hedgehog.Internal.Property (Diff, MonadTest, Property (..), liftTest, mkTest)
 import Hedgehog.Internal.Property qualified as H
 import Hedgehog.Internal.Show (ValueDiff (ValueSame), mkValue, showPretty, valueDiff)
@@ -362,3 +365,14 @@ watchdogProp :: HasCallStack => H.Property -> H.Property
 watchdogProp prop@Property{propertyTest} = prop{propertyTest = H.runWithWatchdog_ cfg propertyTest}
  where
   cfg = H.WatchdogConfig{H.watchdogTimeout = 20}
+
+diffVsGoldenFileExcludeTrace :: (MonadIO m, MonadTest m, HasCallStack) => String -> FilePath -> m ()
+diffVsGoldenFileExcludeTrace inputString refFile = GHC.withFrozenCallStack $ do
+  case List.uncons $ Text.splitOn "CallStack" $ Text.pack inputString of
+    Just (stackTraceRemoved, _) -> H.diffVsGoldenFile (Text.unpack stackTraceRemoved) refFile
+    Nothing ->
+      H.failWith Nothing $
+        List.unlines
+          [ "Input string was empty"
+          , "Reference file: " <> refFile
+          ]