cardano-testnet executable: take node config file as optional input

[smelc]

Note

On top of #6138

Description

Fixes #6069

With @CarlosLopezDeLara's input, I have chosen an all or nothing behavior: either you pass the configuration file and all genesis files or you pass none of them. If we choose an à la carte behavior, it's cumbersome to implement, and anyway since the node configuration file contains the hashes of genesis files, there is at least some degree of binding between all of these files.

After feedback from Jordan, we finally only ask the user to provide the node configuration file. Then we read the eras' genesis files by looking at the paths specified in the node configuration file. This way, no additional flag needed, nor checking consistency between the flags and the node configuration file.

TBD

How to trust this PR

TBD

Checklist

• Commit sequence broadly makes sense and commits have useful messages
• CI passes.
• Self-reviewed the diff

[Jimbo4350]

How do you plan to deal with conflicts in the node configuration yaml file? I think this is the wrong approach. We don't want to be forced to reconcile configuration file differences. All we should need the is the node configuration yaml file.

[Jimbo4350]

why does runTestnet result in a Property??

[smelc]

runTestnet doesn't return a property but it does take a Conf -> H.Integration a callback, as visible here:

cardano-node/cardano-testnet/src/Testnet/Property/Run.hs

Line 41 in dad33d9

runTestnet :: CardanoTestnetOptions -> (Conf -> H.Integration a) -> IO ()

This is a bit meh and we can probably improve that: in the case where the user provides a configuration file, we would like not be tied to the hedgehog-extras/hedgehog APIs like Integration and Property. But this is something we would better do in the future, not in this PR, because it's not required for reaching a first release of cardano-testnet IMHO. And also, it will be some work, because our existing "backend", e.g. cardanoTestnet here is in the Integration monad. So it's not an easy change.

[Jimbo4350]

We can return to this. Could you create an issue to track it? The issue just needs to point out its an issue 😆

[smelc]

@Jimbo4350> created follow-up issue: #6122

[smelc]

For future reference, if we leave the call to cardano-cli debug check-node-configuration, we have the following failures with the following genesis files:

> cabal run cardano-testnet -- cardano --output-dir cl-output-dir --node-config cl-example/configuration.json --testnet-magic 44
  ✗ <interactive> failed at src/Testnet/Start/Cardano.hs:283:3
    after 1 test.
    shrink path: 1:
  
    forAll0 =
      Process exited with non-zero exit-code: 1
      ━━━━ stdout ━━━━
      Checking byron genesis file: cl-example/byron.genesis.spec.json
      
      ━━━━ stderr ━━━━
      Error reading node configuration at: cl-example/byron.genesis.spec.json: Incorrect schema for GenesisData.
       Error: expected field protocolConsts

It seems the code is requiring too much data here when deserializing the Byron genesis. This data is actually not required to start the node (i.e. if we remove the check, the testnet starts fine). So it seems overkill to require this data when starting a testnet.

[edit] Oh well, it seems the node doesn't like it either actually:

✗ <interactive> failed at src/Testnet/Start/Cardano.hs:342:5
    after 1 test.
    shrink path: 1:
  
    forAll0 =
      Cardano node process did not start: CardanoProtocolInstantiationError (CardanoProtocolInstantiationErrorByron (GenesisReadError "/home/churlin/dev/cardano-node/cl-example/byron.genesis.spec.json" (GenesisDataSchemaError (SchemaError {seExpected = "field protocolConsts", seActual = Nothing}))))
      
      cardano-node: There was an error parsing the genesis file: "/home/churlin/dev/cardano-node/cl-example/byron.genesis.spec.json" Error: GenesisDataSchemaError (SchemaError {seExpected = "field protocolConsts", seActual = Nothing})

[smelc]

Starting with the configuration.yaml file created by running the queries (e.g. the sandbox created by DISABLE_RETRIES=1 cabal test cardano-testnet-test --test-options '-p "/CliQueries/"') test fails as follows:

> cabal run cardano-testnet -- cardano --output-dir cl-output-dir --node-config nix-shell.Ai0S6G/cli-queries-test-6184168d6b9797eb/configuration.yaml --testnet-magic 44

✗ <interactive> failed at src/Testnet/Start/Cardano.hs:342:5
    after 1 test.
    shrink path: 1:
  
    forAll0 =
      Cardano node process did not start: CardanoProtocolInstantiationError (CardanoProtocolInstantiationErrorByron (CredentialsError DelegationCertificateNotFromGenesisKey))
      
      cardano-node: Byron leader credentials error: DelegationCertificateNotFromGenesisKey

I'm a bit puzzled.

[edit] Solved later on, it was related to not honoring the custom configuration file everywhere

[smelc]

All we should need the is the node configuration yaml file.

@Jimbo4350> Updated version of this PR now does that 👍