Add CDDL tools to CI

Author: jasagredo

.github/workflows/ci.yml

@@ -55,12 +55,6 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    - name: Clone Blueprints
-      uses: actions/checkout@v4
-      with:
-        repository: 'cardano-scaling/cardano-blueprint'
-        path: 'blueprints'
-
     - name: Check CDDLs up-to-date with Blueprints
       continue-on-error: true
       run: |
@@ -149,6 +143,13 @@ jobs:
     - name: Build projects [build]
       run: cabal build all -j
 
+    - name: Install cddl tools
+      run: |
+        export GEM_HOME="$HOME/.gem"
+        gem install cddlc
+        echo "PATH=$HOME/.gem/bin:$PATH" >> $GITHUB_ENV
+        cabal install cuddle-0.5.0.0
+
     - name: Test
       if: matrix.test-set == 'all'
       run: cabal test all -j --test-show-details=streaming

nix/shell.nix

@@ -16,6 +16,7 @@ hsPkgs.shellFor {
     pkgs.ghcid
     pkgs.xrefcheck
     pkgs.fourmolu
+    pkgs.cuddle
 
     # release management
     pkgs.scriv

nix/tools.nix

@@ -38,6 +38,15 @@ in
 
   fourmolu = tool "fourmolu" "0.18.0.0" { };
 
+  cuddle = tool "cuddle" "git" {
+    src = final.fetchFromGitHub {
+      owner = "input-output-hk";
+      repo = "cuddle";
+      rev = "cuddle-0.5.0.0";
+      hash = "sha256-06a9N1IAh0kKW/xPu1qiLK22HpXyARnipA1YJxY4jOQ=";
+    };
+  };
+
   haskellBuildUtils = prev.haskellBuildUtils.override {
     inherit (final.hsPkgs.args) compiler-nix-name;
     index-state = tool-index-state;

scripts/cbor/unwrap24serialised.hs

@@ -0,0 +1,26 @@
+{- cabal:
+  build-depends: cborg, bytestring, base
+-}
+
+-- | A simple script that unwraps a CBOR term serialized as
+-- CBOR-in-CBOR. It gets input from stdin and emits on stdout.
+--
+-- > cat pre.cbor | cabal run ./scripts/unwrap24serialised.hs > post.cbor
+module Main where
+
+import Prelude hiding (interact)
+import Data.ByteString
+import Codec.CBOR.Term
+import Codec.CBOR.Write
+import Codec.CBOR.Read
+import Data.ByteString.Lazy (fromStrict, toStrict)
+
+main = interact $
+    toStrict
+  . toLazyByteString
+  . encodeTerm
+  . (\(Right (_, t)) -> t)
+  . deserialiseFromBytes decodeTerm
+  . (\(Right (_, TTagged _ (TBytes t))) -> fromStrict t)
+  . deserialiseFromBytes decodeTerm
+  . fromStrict

scripts/ci/diff-cddls.sh

@@ -1,10 +1,12 @@
 #!/bin/bash
 
+git clone [email protected]:cardano-scaling/cardano-blueprint
+
 check_diff () {
-    diff "ouroboros-consensus-cardano/cddl/node-to-node/$1" "blueprints/src/network/node-to-node/$1"
+    diff "ouroboros-consensus-cardano/cddl/node-to-node/$1" "cardano-blueprint/src/network/node-to-node/$1"
     if [ $? -ne 0 ]
     then
-        echo "::warning ouroboros-consensus-cardano/cddl/node-to-node/$1 differs from blueprints/src/network/node-to-node/$1"
+        echo "::warning ouroboros-consensus-cardano/cddl/node-to-node/$1 differs from cardano-blueprint/src/network/node-to-node/$1"
     else
         echo "$1 OK"
     fi