Fix Nix CI for Windows

Author: jasagredo

nix/haskell.nix

@@ -38,8 +38,13 @@ let
       ({ pkgs, lib, ... }: lib.mkIf pkgs.stdenv.hostPlatform.isWindows {
         # https://github.com/input-output-hk/haskell.nix/issues/2332
         packages.basement.configureFlags = [ "--hsc2hs-option=--cflag=-Wno-int-conversion" ];
+        # We can't cross-compile the ruby gem `cddlc` so we decided to skip this
+        # test on Windows in Hydra.
+        packages.ouroboros-consensus-cardano.components.tests.cardano-test.preCheck = ''
+          export DISABLE_CDDLC=1
+        '';
       })
-      ({ pkgs, ... }: {
+      ({ pkgs, ... }: lib.mkIf (!pkgs.stdenv.hostPlatform.isWindows) {
         # Tools for CBOR/CDDL tests:
         packages.ouroboros-consensus-cardano.components.tests.cardano-test = {
           build-tools =

ouroboros-consensus-cardano/test/cardano-test/Test/Consensus/Cardano/GenCDDLs.hs

@@ -25,6 +25,7 @@ import qualified Test.Cardano.Ledger.Conway.Binary.Cddl as Conway
 import qualified Test.Cardano.Ledger.Mary.Binary.Cddl as Mary
 import qualified Test.Cardano.Ledger.Shelley.Binary.Cddl as Shelley
 import Test.Tasty
+import Test.Util.Serialisation.CDDL (isCDDLCDisabled)
 
 newtype CDDLSpec = CDDLSpec {cddlSpec :: BS.ByteString} deriving Show
 
@@ -34,32 +35,35 @@ newtype CDDLSpec = CDDLSpec {cddlSpec :: BS.ByteString} deriving Show
 -- each CDDL so that we know always what is available.
 withCDDLs :: TestTree -> TestTree
 withCDDLs f =
-  withResource
-    ( do
-        probeTools
-        setupCDDLCEnv
-
-        ntnBlock <- cddlc "cddl/node-to-node/blockfetch/block.cddl"
-        ntnBlock' <- fixupBlockCDDL ntnBlock
-        BS.writeFile "ntnblock.cddl" . cddlSpec $ ntnBlock'
-
-        ntnHeader <- cddlc "cddl/node-to-node/chainsync/header.cddl"
-        BS.writeFile "ntnheader.cddl" . cddlSpec $ ntnHeader
-
-        ntnTx <- cddlc "cddl/node-to-node/txsubmission2/tx.cddl"
-        ntnTx' <- fixupBlockCDDL ntnTx
-        BS.writeFile "ntntx.cddl" . cddlSpec $ ntnTx'
-
-        ntnTxId <- cddlc "cddl/node-to-node/txsubmission2/txId.cddl"
-        BS.writeFile "ntntxid.cddl" . cddlSpec $ ntnTxId
-    )
-    ( \() -> do
-        D.removeFile "ntnblock.cddl"
-        D.removeFile "ntnheader.cddl"
-        D.removeFile "ntntx.cddl"
-        D.removeFile "ntntxid.cddl"
-    )
-    (\_ -> f)
+  if isCDDLCDisabled
+    then f
+    else
+      withResource
+        ( do
+            probeTools
+            setupCDDLCEnv
+
+            ntnBlock <- cddlc "cddl/node-to-node/blockfetch/block.cddl"
+            ntnBlock' <- fixupBlockCDDL ntnBlock
+            BS.writeFile "ntnblock.cddl" . cddlSpec $ ntnBlock'
+
+            ntnHeader <- cddlc "cddl/node-to-node/chainsync/header.cddl"
+            BS.writeFile "ntnheader.cddl" . cddlSpec $ ntnHeader
+
+            ntnTx <- cddlc "cddl/node-to-node/txsubmission2/tx.cddl"
+            ntnTx' <- fixupBlockCDDL ntnTx
+            BS.writeFile "ntntx.cddl" . cddlSpec $ ntnTx'
+
+            ntnTxId <- cddlc "cddl/node-to-node/txsubmission2/txId.cddl"
+            BS.writeFile "ntntxid.cddl" . cddlSpec $ ntnTxId
+        )
+        ( \() -> do
+            D.removeFile "ntnblock.cddl"
+            D.removeFile "ntnheader.cddl"
+            D.removeFile "ntntx.cddl"
+            D.removeFile "ntntxid.cddl"
+        )
+        (\_ -> f)
 
 -- | The Ledger CDDL specs are not _exactly_ correct. Here we do some dirty
 -- sed-replace to make them able to validate blocks. See cardano-ledger#5054.

ouroboros-consensus/src/unstable-consensus-testlib/Test/Util/Serialisation/CDDL.hs

@@ -1,23 +1,39 @@
 {-# LANGUAGE LambdaCase #-}
 
-module Test.Util.Serialisation.CDDL (cddlTestCase, cddlTest, CDDLsForNodeToNode (..)) where
+module Test.Util.Serialisation.CDDL
+  ( cddlTestCase
+  , cddlTest
+  , isCDDLCDisabled
+  , CDDLsForNodeToNode (..)
+  ) where
 
 import qualified Data.ByteString as BS
+import Data.Maybe (isJust)
 import qualified Data.Text as T
+import qualified System.Environment as E
 import System.Exit
 import System.IO
 import System.IO.Temp
+import System.IO.Unsafe (unsafePerformIO)
 import System.Process
 import Test.Tasty
 import Test.Tasty.HUnit
 
+-- | Windows on Hydra cannot cross-compile CDDLC so we decided to skip the tests
+-- there.
+isCDDLCDisabled :: Bool
+isCDDLCDisabled = isJust $ unsafePerformIO (E.lookupEnv "DISABLE_CDDLC")
+
 -- | A Tasty test case running the @cuddle@
 cddlTestCase :: IO BS.ByteString -> FilePath -> T.Text -> TestTree
 cddlTestCase cborM cddl rule =
   testCase "CDDL compliance" $
-    cddlTest cborM cddl rule >>= \case
-      Left err -> assertFailure err
-      Right _ -> pure ()
+    if isCDDLCDisabled
+      then assertBool "Skipped" True
+      else
+        cddlTest cborM cddl rule >>= \case
+          Left err -> assertFailure err
+          Right _ -> pure ()
 
 -- | Test the CDDL conformance of the given bytestring
 cddlTest ::