Render to TOML (#119)

* Initial TOML rendering

* Handle key escaping

* Uncomment tests

* Allow no toml checks for now

* Test harness updates

* Make acceptance tests fail then pass.

NB temporarily removing all heterogeneous arrays to keep toml
rendering happy. Should get back in for the other formats.

Author: gmorpheme

.circleci/config.yml

@@ -118,7 +118,7 @@ jobs:
                                -e EXECUTABLE=/tmp/workspace/eu
                                -e GHCRTS=-N2
                                curvelogic/eucalypt-test-harness:${CIRCLE_SHA1}
-                               pipenv run ./eut.py -o /tmp/artifacts"
+                               bash -c 'pipenv install && pipenv run ./eut.py -o /tmp/artifacts'"
       - store_artifacts:
           path: /tmp/artifacts
 

harness/Dockerfile

@@ -1,7 +1,7 @@
 # Build Eucalypt test harness as a container. The eu executable must
 # be provided at runtime in an attached volume and env var EXECUTABLE
 # must contain the path.
-FROM ubuntu:18.04
+FROM ubuntu:19.04
 
 RUN apt-get update \
  && apt-get install -y libgmp10 python3-pip python3-dev

harness/Pipfile

@@ -5,6 +5,4 @@ name = "pypi"
 
 [packages]
 PyYAML = ">=4.2b1"
-
-[requires]
-python_version = "3.6"
+toml = ">=0.10.0"

harness/Pipfile.lock

@@ -13,6 +13,10 @@
     import yaml
 except:
     print("WARNING: yaml not available")
+try:
+    import toml
+except:
+    print("WARNING: toml not available")
 import json
 from enum import Enum
 from pathlib import (Path)
@@ -50,14 +54,21 @@ def check(self):
         if self.format == "yaml":
             with open(self.outfile) as stream:
                 try:
-                    content_passes = yaml.load(stream).get("RESULT") == "PASS"
+                    content_passes = yaml.load(stream, Loader=yaml.SafeLoader).get("RESULT") == "PASS"
                 except:
                     pass
 
         if self.format == "json":
             with open(self.outfile) as stream:
                 content_passes = json.load(stream).get("RESULT") == "PASS"
 
+        if self.format == "toml":
+            with open(self.outfile) as stream:
+                try:
+                    content_passes = toml.load(stream).get("RESULT") == "PASS"
+                except:
+                    pass
+
         return self.proc.returncode == 0 and content_passes
 
     def execute(self):
@@ -228,7 +239,7 @@ def find_simple_tests(testdir, outdir):
                                  testdir.glob("*.yaml"),
                                  testdir.glob("*.json"),
                                  testdir.glob("*.toml"))),
-                           ["yaml", "json"])]
+                           ["yaml", "json", "toml"])]
 
 def find_error_tests(testdir, outdir):
     return [ErrorTest(p, outdir) for p in sorted(testdir.glob("errors/*.eu"))]
@@ -273,4 +284,4 @@ def main():
             return 0
 
 if __name__ == '__main__':
-    main()
+    sys.exit(main())

harness/eut.py

@@ -6,6 +6,8 @@ block1: {
 
 block2: block1
 
+
+`{ export: :suppress doc: "Heterogeneous array so can't be rendered to TOML" }
 items: block2 elements
 
 block3: items block

harness/test/015_block_fns.eu

@@ -1,7 +1,10 @@
 tagged-sym: :blah // { tag: "!Ref" }
 
+`{ export: :suppress doc: "Heterogeneous array so can't be rendered to TOML" }
 tagged-list: ["-", [:a, :b, :c]] // { tag: "!Fn::Join" }
 
+homogeneous-tagged-list: [1, 2, 3, 4] // { tag: "!Periwabble" }
+
 tagged-block: { a: 1 } // { tag: "!Blah" }
 
 mblock: meta(tagged-block)

harness/test/039_tags.eu

@@ -10,4 +10,4 @@ checks: {
   ƍ: scoped.pass
 }
 
-PASS: checks values all-true? then(:PASS, :FAIL)
+RESULT: checks values all-true? then(:PASS, :FAIL)

harness/test/045_csv_import.eu

@@ -62,7 +62,7 @@ exportOption =
   optional $
   strOption
     (long "exportType" <> short 'x' <> metavar "FORMAT" <>
-     help "Format for export (e.g. yaml, json)") <|>
+     help "Format for export (e.g. yaml, json, toml, text)") <|>
   flag'
     "json"
     (long "json" <> short 'j' <> help "JSON output (equivalent to -x json)")
@@ -317,6 +317,7 @@ inferOutputFormat opts =
         ".json" -> Just "json"
         ".yaml" -> Just "yaml"
         ".yml" -> Just "yaml"
+        ".toml" -> Just "toml"
         ".eu" -> Just "eu"
         ".csv" -> Just "csv"
         _ -> Just "yaml"

src/Eucalypt/Driver/Options.hs

@@ -25,8 +25,10 @@ import Eucalypt.Core.Syn (CoreExpr)
 import Eucalypt.Driver.Options (EucalyptOptions(..))
 import qualified Eucalypt.Render.Json as Json
 import qualified Eucalypt.Render.Text as Text
+import qualified Eucalypt.Render.Toml as Toml
 import qualified Eucalypt.Render.Yaml as Yaml
 import Eucalypt.Stg.Compiler.CompileCore (compileForRender)
+import Eucalypt.Render.Error
 import Eucalypt.Reporting.Error
 import Eucalypt.Stg.Error
 import Eucalypt.Stg.Eval (step)
@@ -96,7 +98,7 @@ renderConduit ::
   => EucalyptOptions
   -> CoreExpr
   -> m BS.ByteString
-renderConduit opts expr = handle handler $ do
+renderConduit opts expr = handle wrapStg $ handle wrapRender $ do
   syn <- compile expr
   ms <- newMachine syn
   runConduitRes $ machineSource ms .| renderPipeline format
@@ -106,8 +108,10 @@ renderConduit opts expr = handle handler $ do
       if optionDebug opts
         then debugMachine
         else machine
-    handler :: MonadCatch m => StgException -> m BS.ByteString
-    handler e = throwM $ Execution e
+    wrapStg :: MonadCatch m => StgException -> m BS.ByteString
+    wrapStg e = throwM $ Execution e
+    wrapRender :: MonadCatch m => RenderError -> m BS.ByteString
+    wrapRender e = throwM $ Render e
 
 
 
@@ -137,7 +141,8 @@ machineSource ms = do
 -- | Select an appropriate render pipeline based on the requested
 -- format
 renderPipeline ::
-     (MonadResource m) => String -> ConduitT Event Void m BS.ByteString
+     (MonadThrow m, MonadResource m) => String -> ConduitT Event Void m BS.ByteString
 renderPipeline "json" = Json.pipeline
 renderPipeline "text" = Text.pipeline
+renderPipeline "toml" = Toml.pipeline
 renderPipeline _ = Yaml.pipeline

src/Eucalypt/Driver/Stg.hs

@@ -0,0 +1,37 @@
+{-|
+Module      : Eucalypt.Render.Error
+Description : Render errors
+Copyright   : (c) Greg Hawkins, 2019
+License     :
+Maintainer  : [email protected]
+Stability   : experimental
+-}
+module Eucalypt.Render.Error where
+
+import Control.Exception.Safe
+import Eucalypt.Reporting.Common
+import Eucalypt.Reporting.Classes
+import Text.PrettyPrint ((<+>))
+import qualified Text.PrettyPrint as P
+
+-- | An issue with a eucalypt document that impedes rendering to a
+-- given format
+data RenderProblem = HeterogeneousArray | NonTextualKey
+  deriving (Eq, Show, Typeable)
+
+instance Reportable RenderProblem where
+  report HeterogeneousArray = P.text "a heterogeneous array"
+  report NonTextualKey = P.text "a non-textual key"
+
+-- | An error during rendering
+data RenderError =
+  Unrenderable String
+               RenderProblem
+  deriving (Show, Eq, Typeable)
+
+instance Exception RenderError
+
+instance Reportable RenderError where
+  report (Unrenderable f prob) =
+    title "RENDER ERROR" P.$$ P.text "Could not render to" <+>
+    P.text f <+> P.text "because of" <+> (report prob <> P.text ".")