Compare the resolved configuration and flag discrepancies

Author: jasagredo

cardano-node/app/cardano-node.hs

@@ -4,21 +4,32 @@
 {-# LANGUAGE RankNTypes #-}
 {-# LANGUAGE TemplateHaskell #-}
 
+import qualified Cardano.Configuration as Cfg
+import qualified Cardano.Configuration.CliArgs as CliArgs
+import qualified Cardano.Configuration.Commands as Cmds
 import qualified Cardano.Crypto.Init as Crypto
 import           Cardano.Git.Rev (gitRev)
-import           Cardano.Node.Configuration.POM (PartialNodeConfiguration (..))
+import           Cardano.Node.Configuration.CardanoConfigAdapter
+                   (cardanoConfigToNodeConfiguration)
+import           Cardano.Node.Configuration.CardanoConfigCompare
+                   (compareConfigurations)
+import           Cardano.Node.Configuration.POM (NodeConfiguration (..),
+                   PartialNodeConfiguration (..), defaultPartialNodeConfiguration,
+                   makeNodeConfiguration, parseNodeConfigurationFP)
 import           Cardano.Node.Handlers.TopLevel
 import           Cardano.Node.Parsers (nodeCLIParser)
 import           Cardano.Node.Run (runNode)
 import           Cardano.Node.Tracing.Documentation (TraceDocumentationCmd (..),
                    parseTraceDocumentationCmd, runTraceDocumentationCmd)
+import           Cardano.Node.Types (ConfigYamlFilePath (..))
 
-import           Data.Monoid (Last (getLast))
+import           Data.Monoid (Last (..))
 import qualified Data.Text as Text
 import qualified Data.Text.IO as Text
 import           Data.Version (showVersion)
 import           Options.Applicative
 import qualified Options.Applicative as Opt
+import           System.Exit (exitFailure)
 import           System.Info (arch, compilerName, compilerVersion, os)
 import           System.IO (hPutStrLn, stderr)
 
@@ -37,6 +48,7 @@ main = do
         runNode args
       TraceDocumentation tdc -> runTraceDocumentationCmd tdc
       VersionCmd  -> runVersionCommand
+      ConfigCmd act -> act
 
     where
       p = Opt.prefs Opt.showHelpOnEmpty
@@ -56,6 +68,7 @@ main = do
         Opt.info (fmap RunCmd nodeCLIParser
                   <|> fmap TraceDocumentation parseTraceDocumentationCmd
                   <|> parseVersionCmd
+                  <|> fmap ConfigCmd configSubcommands
                   <**> helper)
 
           ( Opt.fullDesc <>
@@ -66,6 +79,7 @@ main = do
 data Command = RunCmd PartialNodeConfiguration
              | TraceDocumentation TraceDocumentationCmd
              | VersionCmd
+             | ConfigCmd (IO ())
 
 -- Yes! A --version flag or version command. Either guess is right!
 parseVersionCmd :: Parser Command
@@ -105,3 +119,84 @@ command' c descr p =
     [ command c (info (p <**> helper) $ mconcat [ progDesc descr ])
     , metavar c
     ]
+
+-- cardano-config subcommands --------------------------------------------------
+
+-- | The @migrate@, @schema@ and @resolve@ subcommands, spliced from the shared
+-- @cardano-config:commands@ sublibrary. @migrate@ and @schema@ are
+-- cardano-config's own commands, unchanged; @resolve@ is a node-specific variant
+-- (see 'resolveDualCommand') that additionally cross-checks the node's own parser
+-- against cardano-config's.
+configSubcommands :: Parser (IO ())
+configSubcommands =
+  Opt.hsubparser
+    ( Opt.commandGroup "Configuration commands:"
+        <> Cmds.migrateCommand
+        <> Cmds.schemaCommand
+        <> resolveDualCommand
+    )
+
+-- | A node-specific @resolve@: resolve the configuration with cardano-config
+-- (printing the result as YAML, exactly like cardano-config's own @resolve@),
+-- then re-resolve the same configuration with the node's own POM parser and
+-- report any discrepancies between the two. Exits non-zero when they disagree,
+-- so it doubles as a CI parity check while the node still has two parsers.
+resolveDualCommand :: Mod CommandFields (IO ())
+resolveDualCommand =
+  command "resolve"
+    ( info
+        (runDualResolve <$> Cmds.resolveOptionsParser)
+        ( progDesc
+            ( "Resolve a cardano-node configuration (defaults + file + CLI) with both the "
+                <> "node and cardano-config parsers, print the result as YAML, and report any "
+                <> "discrepancies between the two parsers (exit non-zero if they disagree)."
+            )
+        )
+    )
+
+runDualResolve :: Cmds.ResolveOptions -> IO ()
+runDualResolve resolveOpts@(Cmds.ResolveOptions cli _geneses) = do
+  -- Print the resolved configuration using cardano-config's own renderer (which
+  -- honours --with-geneses); this also terminates via 'die' if resolution fails.
+  Cmds.runResolveCommand resolveOpts
+  -- Cross-check: resolve the same inputs with the node's POM parser and diff.
+  discrepancies <- resolveDiscrepancies cli
+  case discrepancies of
+    [] ->
+      putStrLn "resolve: the node and cardano-config parsers agree on the resolved configuration."
+    ds -> do
+      hPutStrLn stderr $
+        "resolve: " <> show (length ds)
+          <> " discrepancy(ies) between the node and cardano-config parsers:"
+      mapM_ (hPutStrLn stderr . ("  - " <>)) ds
+      exitFailure
+
+-- | Resolve the configuration file (+ CLI) both ways and return the divergences.
+-- The node (POM) side takes its CLI-supplied, file-absent fields (topology /
+-- database / protocol files / socket) from the shared cardano-config resolution,
+-- so the diff reflects how the two parsers read the configuration FILE (plus the
+-- documented adapter gaps) rather than an independent — and necessarily
+-- asymmetric — CLI reverse-mapping.
+resolveDiscrepancies :: Cfg.CliArgs -> IO [String]
+resolveDiscrepancies cli = do
+  (fileCfg, _warns) <- Cfg.parseConfigurationFiles configFp
+  case Cfg.resolveConfiguration cli fileCfg of
+    Left err -> pure ["cardano-config failed to resolve the configuration: " <> show err]
+    Right (cfgNc, _) ->
+      case cardanoConfigToNodeConfiguration cfgNc of
+        Left adaptErr -> pure ["cardano-config configuration could not be adapted: " <> adaptErr]
+        Right adaptedNc -> do
+          filePartial <- parseNodeConfigurationFP (Just (ConfigYamlFilePath configFp))
+          let withCli =
+                (defaultPartialNodeConfiguration <> filePartial)
+                  { pncConfigFile    = Last (Just (ConfigYamlFilePath configFp))
+                  , pncTopologyFile  = Last (Just (ncTopologyFile adaptedNc))
+                  , pncDatabaseFile  = Last (Just (ncDatabaseFile adaptedNc))
+                  , pncProtocolFiles = Last (Just (ncProtocolFiles adaptedNc))
+                  , pncSocketConfig  = Last (Just (ncSocketConfig adaptedNc))
+                  }
+          case makeNodeConfiguration withCli of
+            Left err -> pure ["node parser (makeNodeConfiguration) failed: " <> err]
+            Right pomNc -> pure (compareConfigurations pomNc adaptedNc)
+ where
+  configFp = CliArgs.configFilePath cli

cardano-node/cardano-node.cabal

@@ -60,6 +60,7 @@ library
   hs-source-dirs:       src
 
   exposed-modules:      Cardano.Node.Configuration.CardanoConfigAdapter
+                        Cardano.Node.Configuration.CardanoConfigCompare
                         Cardano.Node.Configuration.NodeAddress
                         Cardano.Node.Configuration.POM
                         Cardano.Node.Configuration.LedgerDB
@@ -191,6 +192,7 @@ library
                       , trace-resources ^>= 0.2.4
                       , transformers
                       , transformers-except
+                      , tree-diff
                       , typed-protocols:{typed-protocols, stateful} >= 1.2
                       , yaml
 
@@ -210,6 +212,8 @@ executable cardano-node
   autogen-modules:      Paths_cardano_node
 
   build-depends:        base
+                      , cardano-config
+                      , cardano-config:commands
                       , cardano-crypto-class
                       , cardano-git-rev
                       , cardano-node
@@ -244,6 +248,18 @@ test-suite db-synthesizer-test
                       , tasty
                       , tasty-hunit
 
+test-suite cardano-config-compare-test
+  import:               project-config
+  hs-source-dirs:       test/cardano-config-compare
+  main-is:              Main.hs
+  type:                 exitcode-stdio-1.0
+
+  build-depends:        base
+                      , cardano-config
+                      , cardano-node
+                      , tasty
+                      , tasty-hunit
+
 test-suite cardano-node-test
   import:               project-config
                       , maybe-unix