Test URL functionality for governance drep metadata-hash

IntersectMBO · Oct 7, 2024 · 3eca05c · 3eca05c
1 parent c1adca8
commit 3eca05c
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 2 deletions.
diff --git a/cardano-cli/cardano-cli.cabal b/cardano-cli/cardano-cli.cabal
@@ -335,6 +335,7 @@ test-suite cardano-cli-test
     Test.Cli.AddCostModels
     Test.Cli.CreateCardano
     Test.Cli.CreateTestnetData
+    Test.Cli.DRepMetadata
     Test.Cli.FilePermissions
     Test.Cli.Governance.DRep
     Test.Cli.Governance.Hash

diff --git a/cardano-cli/test/cardano-cli-golden/Test/Golden/Governance/DRep.hs b/cardano-cli/test/cardano-cli-golden/Test/Golden/Governance/DRep.hs
@@ -16,8 +16,11 @@ import           Numeric (showOct)
 import           System.Posix.Files (fileMode, getFileStatus)
 #endif
 
-import           Test.Cardano.CLI.Util (FileSem, bracketSem, execCardanoCLI, newFileSem,
-                   noteInputFile, noteTempFile, propertyOnce)
+import           GHC.IO.Exception (ExitCode (ExitFailure))
+import           Test.Cardano.CLI.Hash (exampleAnchorDataHash, exampleAnchorDataIpfsHash,
+                   exampleAnchorDataPathGolden, serveFilesWhile, tamperBase16Hash)
+import           Test.Cardano.CLI.Util (FileSem, bracketSem, execCardanoCLI, execDetailCardanoCLI,
+                   newFileSem, noteInputFile, noteTempFile, propertyOnce)
 
 import           Hedgehog
 import qualified Hedgehog as H
@@ -330,3 +333,36 @@ hprop_golden_verification_key_drep =
       ]
 
     H.diffFileVsGoldenFile vkeyFileOut goldenFile
+
+-- Execute me with:
+-- @cabal test cardano-cli-test --test-options '-p "/drep metadata hash url wrong hash fails/"'@
+hprop_golden_drep_metadata_hash_url_wrong_hash_fails :: Property
+hprop_golden_drep_metadata_hash_url_wrong_hash_fails =
+  propertyOnce $ do
+    -- We modify the hash slightly so that the hash check fails
+    alteredHash <- H.evalMaybe $ tamperBase16Hash exampleAnchorDataHash
+    let relativeUrl = [exampleAnchorDataIpfsHash]
+
+    -- Create temporary HTTP server with files required by the call to `cardano-cli`
+    (exitCode, _, result) <-
+      serveFilesWhile
+        [ (relativeUrl, exampleAnchorDataPathGolden)
+        ]
+        ( \port -> do
+            execDetailCardanoCLI
+              [ "conway"
+              , "governance"
+              , "drep"
+              , "metadata-hash"
+              , "--drep-metadata-url"
+              , "http://127.0.0.1:" ++ show port ++ "/" ++ exampleAnchorDataIpfsHash
+              , "--expected-hash"
+              , alteredHash
+              ]
+        )
+
+    exitCode === ExitFailure 1
+
+    H.diffVsGoldenFile
+      result
+      "test/cardano-cli-golden/files/golden/governance/drep/drep_metadata_hash_url_wrong_hash_fails.out"
diff --git a/...rdano-cli-golden/files/golden/governance/drep/drep_metadata_hash_url_wrong_hash_fails.out b/...rdano-cli-golden/files/golden/governance/drep/drep_metadata_hash_url_wrong_hash_fails.out
@@ -0,0 +1,3 @@
+Command failed: governance drep metadata-hash  Error: Hashes do not match!
+Expected: "ee38a4f5b8b9d8372386cc923bad19d1a0662298cf355bbe947e5eedf127fa9c"
+  Actual: "de38a4f5b8b9d8372386cc923bad19d1a0662298cf355bbe947e5eedf127fa9c"
diff --git a/cardano-cli/test/cardano-cli-test/Test/Cli/DRepMetadata.hs b/cardano-cli/test/cardano-cli-test/Test/Cli/DRepMetadata.hs
@@ -0,0 +1,60 @@
+{-# LANGUAGE FlexibleContexts #-}
+
+module Test.Cli.DRepMetadata where
+
+import           Cardano.Api (MonadIO)
+
+import           Control.Monad (void)
+import           Control.Monad.Catch (MonadCatch)
+import           Control.Monad.Trans.Control (MonadBaseControl)
+
+import           Test.Cardano.CLI.Hash (exampleAnchorDataHash, exampleAnchorDataIpfsHash,
+                   exampleAnchorDataPathTest, serveFilesWhile, tamperBase16Hash)
+import           Test.Cardano.CLI.Util (execCardanoCLIWithEnvVars, expectFailure, propertyOnce)
+
+import           Hedgehog (Property)
+import qualified Hedgehog as H
+import           Hedgehog.Internal.Property (MonadTest)
+
+-- Execute me with:
+-- @cabal test cardano-cli-test --test-options '-p "/drep metadata hash url wrong hash fails/"'@
+hprop_drep_metadata_hash_url_wrong_hash_fails :: Property
+hprop_drep_metadata_hash_url_wrong_hash_fails =
+  propertyOnce . expectFailure $ do
+    -- We modify the hash slightly so that the hash check fails
+    alteredHash <- H.evalMaybe $ tamperBase16Hash exampleAnchorDataHash
+    -- We run the test with the modified hash
+    baseDrepMetadataHashUrl alteredHash
+
+-- Execute me with:
+-- @cabal test cardano-cli-test --test-options '-p "/drep metadata hash url correct hash/"'@
+hprop_drep_metadata_hash_url_correct_hash :: Property
+hprop_drep_metadata_hash_url_correct_hash =
+  propertyOnce $ baseDrepMetadataHashUrl exampleAnchorDataHash
+
+baseDrepMetadataHashUrl
+  :: (MonadBaseControl IO m, MonadTest m, MonadIO m, MonadCatch m)
+  => String
+  -> m ()
+baseDrepMetadataHashUrl hash = do
+  let relativeUrl = ["ipfs", exampleAnchorDataIpfsHash]
+
+  -- Create temporary HTTP server with files required by the call to `cardano-cli`
+  -- In this case, the server emulates an IPFS gateway
+  serveFilesWhile
+    [ (relativeUrl, exampleAnchorDataPathTest)
+    ]
+    ( \port -> do
+        void $
+          execCardanoCLIWithEnvVars
+            [("IPFS_GATEWAY_URI", "http://localhost:" ++ show port ++ "/")]
+            [ "conway"
+            , "governance"
+            , "drep"
+            , "metadata-hash"
+            , "--drep-metadata-url"
+            , "ipfs://" ++ exampleAnchorDataIpfsHash
+            , "--expected-hash"
+            , hash
+            ]
+    )