Deserialise; failing test

Author: j-mueller

.github/workflows/ci-compiled-scripts.yaml

@@ -21,6 +21,10 @@ jobs:
 
       - name: Install system dependencies
         uses: input-output-hk/actions/base@latest
+          
+      - name: Install nix
+        uses: cachix/install-nix-action@v27
+
 
       - uses: haskell-actions/setup@v2
         id: cabal-setup
@@ -39,14 +43,13 @@ jobs:
       - name: build & test
         run: |
           cabal update
-          cabal build -j all --enable-tests
-          cabal test all
+          cabal build -j all
       - name: check compiled scripts are consistent
         # git diff --quiet implies --exit-code
         run: |
           cabal run export-smart-tokens ./generated/scripts/unapplied
           cabal run export-smart-tokens ./generated/scripts/preview 08a8d0bb8717839931b0a594f7c28b0a3b7c78f6e9172e977e250eab7637d879.0 '"addr_test1qq986m3uel86pl674mkzneqtycyg7csrdgdxj6uf7v7kd857kquweuh5kmrj28zs8czrwkl692jm67vna2rf7xtafhpqk3hecm"'
           cabal run export-smart-tokens ./generated/scripts/mainnet b1977c1eb33590ca1311384ab68cd36209832213ad4483feb8a1b7cb64828946.0 '"addr_test1qq986m3uel86pl674mkzneqtycyg7csrdgdxj6uf7v7kd857kquweuh5kmrj28zs8czrwkl692jm67vna2rf7xtafhpqk3hecm"'
           cabal run write-openapi-schema -- generated/openapi/schema.json
-          nix develop --command bash -c "aiken build src/aiken-example/aiken --out ./generated/aiken/aiken-scripts.json"
+          nix develop --command bash -c "aiken build src/aiken-example/aiken --out ./src/aiken-example/haskell/data/aiken-scripts.json"
           git diff --quiet

src/aiken-example/haskell/aiken-example.cabal

@@ -13,6 +13,8 @@ bug-reports:   https://github.com/input-output-hk/wsc-poc
 description:
   Please see the README on GitHub at <https://github.com/input-output-hk/wst-poc>
 
+data-files:    data/aiken-scripts.json
+
 common lang
   default-language:   Haskell2010
   default-extensions:
@@ -47,6 +49,9 @@ common lang
     -Wincomplete-uni-patterns -Wincomplete-record-updates
     -Wredundant-constraints -Widentities
 
+  other-modules:      Paths_aiken_example
+  autogen-modules:    Paths_aiken_example
+
 library
   import:          lang
   exposed-modules: Wst.Aiken.Blueprint
@@ -66,5 +71,9 @@ test-suite wst-aiken-test
   main-is:        Spec.hs
   other-modules:  Wst.Aiken.Test
   build-depends:
-    , base   >=4.14.0
+    , aiken-example
+    , base           >=4.14.0
+    , cardano-api
+    , containers
     , tasty
+    , tasty-hunit

generated/aiken/aiken-scripts.json renamed to src/aiken-example/haskell/data/aiken-scripts.json

@@ -25,6 +25,7 @@ import Data.ByteString.Lazy qualified as BSL
 import Data.Map (Map)
 import Data.Map qualified as Map
 import Data.Proxy (Proxy (..))
+import Data.String (IsString (..))
 import Data.Text (Text)
 import Data.Text qualified as T
 import Data.Text.Encoding qualified as TE
@@ -41,32 +42,39 @@ instance ToJSON BlueprintScriptVersion where
         C.PlutusScriptV3 -> toJSON @String "v3"
 
 instance FromJSON BlueprintScriptVersion where
-    parseJSON = fmap (fmap BlueprintScriptVersion) $ Aeson.withText "BlueprintScriptVersion" $ \x -> case T.unpack x of
-        "v1" -> pure (C.AnyPlutusScriptVersion C.PlutusScriptV1)
-        "v2" -> pure (C.AnyPlutusScriptVersion C.PlutusScriptV2)
-        "v3" -> pure (C.AnyPlutusScriptVersion C.PlutusScriptV3)
-        v -> fail $ "Unexpected plutus script version: " <> v
+  parseJSON = fmap (fmap BlueprintScriptVersion) $ Aeson.withText "BlueprintScriptVersion" $ \x -> case T.unpack x of
+    "v1" -> pure (C.AnyPlutusScriptVersion C.PlutusScriptV1)
+    "v2" -> pure (C.AnyPlutusScriptVersion C.PlutusScriptV2)
+    "v3" -> pure (C.AnyPlutusScriptVersion C.PlutusScriptV3)
+    v -> fail $ "Unexpected plutus script version: " <> v
 
 data Blueprint = Blueprint
     { preamble :: Preamble
-    , validators :: [BlueprintValidator]
+    , validators :: Map BlueprintKey ScriptInAnyLang
     }
     deriving stock (Eq, Show, Generic)
-    deriving anyclass (FromJSON)
+
+instance FromJSON Blueprint where
+  parseJSON = withObject "Blueprint" $ \obj ->
+    let mkb p v = Blueprint p <$> deserialise p v in
+    (mkb
+      <$> obj .: "preamble"
+      <*> obj .: "validators")
+    >>= either fail pure
 
 data BlueprintValidator = BlueprintValidator
-    { title :: BlueprintKey
-    , compiledCode :: Text
-    , hash :: Text
-    }
-    deriving stock (Eq, Show, Generic)
-    deriving anyclass (ToJSON, FromJSON)
+  { title :: BlueprintKey
+  , compiledCode :: Text
+  , hash :: Text
+  }
+  deriving stock (Eq, Show, Generic)
+  deriving anyclass (ToJSON, FromJSON)
 
 data Preamble = Preamble
-    { description :: Text
-    , plutusVersion :: BlueprintScriptVersion
-    }
-    deriving stock (Eq, Show, Generic)
+  { description :: Text
+  , plutusVersion :: BlueprintScriptVersion
+  }
+  deriving stock (Eq, Show, Generic)
 
 instance FromJSON Preamble where
     parseJSON = withObject "Preamble" $ \obj ->
@@ -75,13 +83,13 @@ instance FromJSON Preamble where
             <*> obj .: "plutusVersion"
 
 newtype BlueprintKey = BlueprintKey {unBlueprintKey :: Text}
-    deriving newtype (Eq, Ord, Show, ToJSON, FromJSON)
+  deriving newtype (Eq, Ord, Show, ToJSON, FromJSON, IsString)
 
 loadFromFile :: FilePath -> IO (Either String Blueprint)
 loadFromFile fp = Aeson.eitherDecode . BSL.fromStrict <$> BS.readFile fp
 
-deserialise :: Blueprint -> Either String (Map BlueprintKey ScriptInAnyLang)
-deserialise Blueprint{preamble = Preamble{plutusVersion = BlueprintScriptVersion v}, validators} =
+deserialise :: Preamble -> [BlueprintValidator] -> Either String (Map BlueprintKey ScriptInAnyLang)
+deserialise Preamble{plutusVersion = BlueprintScriptVersion v} validators =
     Map.fromList <$> traverse (deserialiseScript v) validators
 
 deserialiseScript :: AnyPlutusScriptVersion -> BlueprintValidator -> Either String (BlueprintKey, ScriptInAnyLang)

src/aiken-example/haskell/lib/Wst/Aiken/Blueprint.hs

@@ -1,10 +1,41 @@
+{-# LANGUAGE NamedFieldPuns    #-}
+{-# LANGUAGE OverloadedStrings #-}
 module Wst.Aiken.Test(
   tests
 ) where
 
+import Cardano.Api qualified as C
+import Data.Functor (void)
+import Data.Map qualified as Map
+import Data.Maybe (isJust)
+import Paths_aiken_example qualified as Pkg
 import Test.Tasty (TestTree, testGroup)
+import Test.Tasty.HUnit (Assertion, assertBool, assertEqual, testCase)
+import Wst.Aiken.Blueprint (Blueprint (..))
+import Wst.Aiken.Blueprint qualified as Blueprint
 
 tests :: TestTree
 tests = testGroup "unit tests"
-  [
+  [ testCase "load blueprint" loadBlueprint
+  , testCase "deserialise script" deserialiseScript
   ]
+
+loadBlueprint :: Assertion
+loadBlueprint = do
+  void loadExample
+
+deserialiseScript :: Assertion
+deserialiseScript = do
+  Blueprint{validators} <- loadExample
+  maybe (fail "Expected script named 'placeholder.placeholder.mint'") pure (Map.lookup "placeholder.placeholder.mint" validators)
+    >>= \case
+      (C.ScriptInAnyLang (C.PlutusScriptLanguage C.PlutusScriptV3) script) -> do
+        let hsh = C.hashScript script
+        assertEqual "Script hash" "cc068514c844ed3f6c6d0f131b20cda83dbd50f340242b5740d0f81f" hsh
+      _ -> fail "Unexpected script language"
+
+loadExample :: IO Blueprint
+loadExample = do
+  Pkg.getDataFileName "data/aiken-scripts.json"
+    >>= Blueprint.loadFromFile
+    >>= either fail pure