Version all the things

hydra-cluster/hydra-cluster.cabal

@@ -241,7 +241,6 @@ test-suite tests
     , plutus-ledger-api
     , process
     , QuickCheck
-    , regex-tdfa
     , say
     , stm
     , strict-containers

hydra-cluster/test/Test/EndToEndSpec.hs

@@ -97,11 +97,9 @@ import System.Directory (createDirectoryIfMissing, removeDirectoryRecursive)
 import System.FilePath ((</>))
 import System.IO (hGetLine)
 import System.IO.Error (isEOFError)
-import System.Process (CreateProcess (..), StdStream (..), proc, readCreateProcess, withCreateProcess)
+import System.Process (CreateProcess (..), StdStream (..), proc, withCreateProcess)
 import System.Timeout (timeout)
 import Test.QuickCheck (generate, suchThat)
-import Text.Regex.TDFA ((=~))
-import Text.Regex.TDFA.Text ()
 import qualified Prelude
 
 allNodeIds :: [Int]
@@ -129,7 +127,7 @@ spec = around showLogsOnFailure $ do
           withCardanoNodeDevnet (contramap FromCardanoNode tracer) tmpDir $ \node ->
             publishHydraScriptsAs node Faucet
               >>= canCloseWithLongContestationPeriod tracer tmpDir node
-      it "can submmit a timed tx" $ \tracer -> do
+      it "can submit a timed tx" $ \tracer -> do
         withClusterTempDir "timed-tx" $ \tmpDir -> do
           withCardanoNodeDevnet (contramap FromCardanoNode tracer) tmpDir $ \node ->
             publishHydraScriptsAs node Faucet
@@ -398,11 +396,6 @@ spec = around showLogsOnFailure $ do
                     metrics `shouldSatisfy` ("hydra_head_events" `BS.isInfixOf`)
 
     describe "hydra-node executable" $ do
-      it "display proper semantic version given it is passed --version argument" $ \_ ->
-        failAfter 5 $ do
-          version <- readCreateProcess (proc "hydra-node" ["--version"]) ""
-          version `shouldSatisfy` (=~ ("[0-9]+\\.[0-9]+\\.[0-9]+(-[a-zA-Z0-9]+)?" :: String))
-
       it "logs its command line arguments" $ \tracer -> do
         withClusterTempDir "logs-options" $ \dir -> do
           withCardanoNodeDevnet (contramap FromCardanoNode tracer) dir $ \RunningNode{nodeSocket} -> do

hydra-node/hydra-node.cabal

@@ -352,6 +352,7 @@ test-suite tests
     , QuickCheck
     , quickcheck-dynamic                                                >=3.0.3
     , quickcheck-instances
+    , regex-tdfa
     , req
     , silently
     , text

hydra-node/src/Hydra/Options.hs

@@ -4,6 +4,7 @@
 module Hydra.Options (
   module Hydra.Options,
   ParserResult (..),
+  renderFailure,
 ) where
 
 import Hydra.Prelude
@@ -63,6 +64,7 @@ import Options.Applicative (
   option,
   progDesc,
   progDescDoc,
+  renderFailure,
   short,
   showDefault,
   strOption,

hydra-node/test/Hydra/OptionsSpec.hs

@@ -22,11 +22,13 @@ import Hydra.Options (
   defaultLedgerConfig,
   maximumNumberOfParties,
   parseHydraCommandFromArgs,
+  renderFailure,
   toArgs,
   validateRunOptions,
  )
 import Test.Aeson.GenericSpecs (roundtripAndGoldenSpecs)
 import Test.QuickCheck (Property, chooseEnum, counterexample, forAll, property, vectorOf, (===))
+import Text.Regex.TDFA ((=~))
 
 spec :: Spec
 spec = parallel $
@@ -71,7 +73,7 @@ spec = parallel $
         `shouldParse` Run defaultRunOptions{port = 0}
       shouldNotParse ["--port", "-42"]
 
-    -- TODO(SN): Move thes examples rather into a 'instance Read Host' test and
+    -- TODO(SN): Move these examples rather into a 'instance Read Host' test and
     -- only check for correct format / wiring here using a single test case This
     -- became evident when realizing that the 'hydra-tui' is also relying on this
     -- Read instance for parsing, but in a different command line flag.
@@ -96,9 +98,13 @@ spec = parallel $
       setFlags ["--monitoring-port", "65535"]
         `shouldParse` Run defaultRunOptions{monitoringPort = Just 65535}
 
-    it "parses --version flag as a parse error" $
-      shouldNotParse ["--version"]
-
+    it "flag --version returns version with base version from cabal" $ do
+      case parseHydraCommandFromArgs ["--version"] of
+        Failure theFailure ->
+          let (v, _ExitCode) = renderFailure theFailure "test"
+           in v
+                `shouldSatisfy` (=~ ("[0-9]+\\.[0-9]+\\.[0-9]+(:?-[a-zA-Z0-9]+)" :: String))
+        _ -> failure "expected a version but did get something else"
     it "parses --hydra-verification-key option as a filepath" $ do
       setFlags ["--hydra-verification-key", "./alice.vk"]
         `shouldParse` Run defaultRunOptions{hydraVerificationKeys = ["./alice.vk"]}

hydra-tui/hydra-tui.cabal

@@ -97,6 +97,7 @@ library
     , optparse-applicative
     , QuickCheck
     , text
+    , th-env
     , time
     , vty
     , websockets
@@ -136,6 +137,7 @@ test-suite tests
     , hydra-tui
     , io-classes
     , optparse-applicative
+    , regex-tdfa
     , temporary
     , unix
     , vty

hydra-tui/src/Hydra/TUI/Options.hs

@@ -1,19 +1,20 @@
+{-# LANGUAGE TemplateHaskell #-}
+
 module Hydra.TUI.Options where
 
-import Hydra.Prelude (
-  Applicative ((<*>)),
-  FilePath,
-  Semigroup ((<>)),
-  (<$>),
- )
+import Hydra.Prelude
 
+import Data.Version (Version (Version), showVersion)
 import Hydra.Cardano.Api (NetworkId)
 import Hydra.Network (Host (Host))
 import Hydra.Options (networkIdParser)
+import Hydra.Version (gitRevision)
+import Language.Haskell.TH.Env (envQ)
 import Options.Applicative (
   Parser,
   auto,
   help,
+  infoOption,
   long,
   metavar,
   option,
@@ -22,21 +23,39 @@ import Options.Applicative (
   strOption,
   value,
  )
+import Paths_hydra_tui (version)
 
 data Options = Options
   { hydraNodeHost :: Host
   , cardanoNodeSocket :: FilePath
   , cardanoNetworkId :: NetworkId
   , cardanoSigningKey :: FilePath
   }
+  deriving stock (Eq, Show)
 
 parseOptions :: Parser Options
 parseOptions =
-  Options
-    <$> parseNodeHost
-    <*> parseCardanoNodeSocket
-    <*> networkIdParser
-    <*> parseCardanoSigningKey
+  ( Options
+      <$> parseNodeHost
+      <*> parseCardanoNodeSocket
+      <*> networkIdParser
+      <*> parseCardanoSigningKey
+  )
+    <**> versionInfo
+ where
+  versionInfo :: Parser (Options -> Options)
+  versionInfo =
+    infoOption
+      (showVersion ourVersion)
+      (long "version" <> help "Show version")
+
+  ourVersion =
+    version & \(Version semver _) -> Version semver revision
+
+  revision =
+    maybeToList $
+      ($$(envQ "GIT_REVISION") :: Maybe String)
+        <|> gitRevision
 
 parseCardanoNodeSocket :: Parser FilePath
 parseCardanoNodeSocket =
@@ -55,7 +74,7 @@ parseNodeHost =
     ( long "connect"
         <> short 'c'
         <> help "Hydra-node to connect to in the form of <host>:<port>"
-        <> value (Host "0.0.0.0" 4001)
+        <> value (Host "127.0.0.1" 4001)
         <> showDefault
     )
 

hydra-tui/test/Hydra/TUI/OptionsSpec.hs

@@ -5,30 +5,48 @@ import Test.Hydra.Prelude
 
 import Hydra.Cardano.Api (NetworkId (..), NetworkMagic (..))
 import Hydra.Network (Host (Host))
-import Hydra.Options (networkIdParser)
 import Hydra.TUI.Options (
-  parseCardanoNodeSocket,
-  parseCardanoSigningKey,
-  parseNodeHost,
+  Options (..),
+  parseOptions,
  )
 import Options.Applicative (
   Parser,
-  ParserResult (Success),
+  ParserResult (Failure, Success),
   defaultPrefs,
   execParserPure,
   info,
+  renderFailure,
  )
+import Text.Regex.TDFA ((=~))
 
 spec :: Spec
 spec = parallel $ do
+  it "no arguments yield default options" $ do
+    shouldParseWith parseOptions [] defaultOptions
   it "parses --connect option" $ do
-    shouldParseWith parseNodeHost ["--connect", "127.0.0.1:4002"] (Host "127.0.0.1" 4002)
+    shouldParseWith parseOptions ["--connect", "127.0.0.2:4002"] defaultOptions{hydraNodeHost = Host "127.0.0.2" 4002}
   it "parses --testnet-magic option" $ do
-    shouldParseWith networkIdParser ["--testnet-magic", "123"] (Testnet $ NetworkMagic 123)
+    shouldParseWith parseOptions ["--testnet-magic", "123"] defaultOptions{cardanoNetworkId = Testnet $ NetworkMagic 123}
   it "parses --cardano-signing-key option" $ do
-    shouldParseWith parseCardanoSigningKey ["--cardano-signing-key", "foo.sk"] "foo.sk"
+    shouldParseWith parseOptions ["--cardano-signing-key", "foo.sk"] defaultOptions{cardanoSigningKey = "foo.sk"}
   it "parses --node-socket option" $ do
-    shouldParseWith parseCardanoNodeSocket ["--node-socket", "something.socket"] "something.socket"
+    shouldParseWith parseOptions ["--node-socket", "something.socket"] defaultOptions{cardanoNodeSocket = "something.socket"}
+  it "parses --version option" $ do
+    case execParserPure defaultPrefs (info parseOptions mempty) ["--version"] of
+      Failure theFailure ->
+        let (version, _exitCode) = renderFailure theFailure "test"
+         in version
+              `shouldSatisfy` (=~ ("[0-9]+\\.[0-9]+\\.[0-9]+(:?-[a-zA-Z0-9]+)" :: String))
+      _ -> failure "expected a version but did get something else"
+
+defaultOptions :: Options
+defaultOptions =
+  Options
+    { hydraNodeHost = Host "127.0.0.1" 4001
+    , cardanoNetworkId = Testnet $ NetworkMagic 42
+    , cardanoNodeSocket = "node.socket"
+    , cardanoSigningKey = "me.sk"
+    }
 
 shouldParseWith :: (Show a, Eq a) => Parser a -> [String] -> a -> Expectation
 shouldParseWith parser args result =

nix/hydra/project.nix

@@ -56,12 +56,18 @@ let
       }
       # Inject the git revision into hydra-node --version
       # (see hydra-node/src/Hydra/Options.hs)
-      {
-        packages.hydra-node.preBuild = ''
-          echo ======= PATCHING --version to ${gitRev} =======
-          export GIT_REVISION=${gitRev}
-        '';
-      }
+      (
+        let
+          patchGitRevision = ''
+            echo ======= PATCHING --version to ${gitRev} =======
+            export GIT_REVISION=${gitRev}
+          '';
+        in
+        {
+          packages.hydra-node.preBuild = patchGitRevision;
+          packages.hydra-tui.preBuild = patchGitRevision;
+        }
+      )
       # Avoid plutus-tx errors in haddock (see also cabal.project)
       {
         packages.hydra-plutus.setupHaddockFlags = [ "--ghc-options='-fplugin-opt PlutusTx.Plugin:defer-errors'" ];