Test/perf-testing

benchmarks/Main.hs

@@ -0,0 +1,19 @@
+{-# LANGUAGE StandaloneDeriving, DeriveAnyClass, DeriveGeneric #-}
+module Main where
+
+import Gauge (defaultMain, bench, nf)
+import Text.Gigaparsec (Parsec, Result(..), parse, atomic, (<|>))
+import Text.Gigaparsec.Char (string)
+import Control.DeepSeq
+import GHC.Generics
+
+p :: Parsec String
+p = atomic (string "hello wold") <|> atomic (string "hi") <|> string "hello world"
+
+deriving instance Generic (Result a)
+deriving instance NFData a => NFData (Result a)
+
+main :: IO ()
+main = defaultMain [
+    bench "consumption" $ nf (parse p) "hello world"
+  ]

gigaparsec.cabal

@@ -148,9 +148,29 @@ test-suite gigaparsec-test
         containers >= 0.6 && < 0.7,
         tasty >=1.1 && <1.6,
         --tasty-expected-failure,
-        tasty-hunit >=0.9 && <0.11
+        tasty-hunit >=0.9 && <0.11,
         --TODO: property based testing will be useful when we optimise combinators
         --      to test against their base implementations
         --tasty-quickcheck
         --TODO: performance testing with tasty-bench?
+        --tasty-bench
         -- we'd need to keep the basefile files somewhere, cache in CI or keep in repo?
+
+benchmark perf-test
+    import:           warnings, extensions, base
+
+    type:             exitcode-stdio-1.0
+
+    default-extensions: OverloadedStrings, TypeOperators, BlockArguments, GADTs
+
+    -- Base language which the package is written in.
+    default-language: Haskell2010
+
+    hs-source-dirs:  benchmarks
+    build-depends:
+        gigaparsec,
+        --containers >= 0.6 && < 0.7,
+        gauge >= 0.1 && < 0.3,
+        deepseq >= 1.4 && < 1.6
+
+    main-is:          Main.hs