[feature] #2373: kagami swarm

[0x009922]

Description

This PR introduces kagami swarm command and some related refactoring and fixes.

This command allows to generate a directory with everything needed to run docker compose up in it. It allows to specify variable number of peers and source of the images.

Examples:

• Generate docker-compose configuration in ./compose-iroha directory with 2 peers using GitHub source:

  kagami swarm --build-from-github --peers 2 --outdir ./compose-iroha

  Generated files:

  [1.1M]  ./compose-iroha
  ├── [761K]  config
  │   ├── [2.1K]  config.json
  │   ├── [ 13K]  genesis.json
  │   └── [746K]  validator.wasm
  ├── [2.1K]  docker-compose.yml
  └── [323K]  iroha-cloned
      └── ...
  

  docker-compose.yml

  version: '3.8'
  services:
    iroha0:
      build: ./iroha-cloned
      environment:
        IROHA_PUBLIC_KEY: ed0120F958FCF0FCD15BD3A3C50F5A3DA9DF97D1B49D9BD6E482A109AE8082BCC54198
        IROHA_PRIVATE_KEY: '{"digest_function":"ed25519","payload":"a9ba80952c6f1a87e1039931c5355c026f0e6d2eff3ab5ba38c4411933c5226df958fcf0fcd15bd3a3c50f5a3da9df97d1b49d9bd6e482a109ae8082bcc54198"}'
        TORII_P2P_ADDR: iroha0:1337
        TORII_API_URL: iroha0:8080
        TORII_TELEMETRY_URL: iroha0:8180
        IROHA_GENESIS_ACCOUNT_PUBLIC_KEY: ed01200D80056A4CB7E32F6E0593C8708C03340D3D1E7F1050E635DBE0A821C236E8E4
        IROHA_GENESIS_ACCOUNT_PRIVATE_KEY: '{"digest_function":"ed25519","payload":"3e51c0c06622a95a27d4936d706318fc7430c652136d5348d55db0d47835783c0d80056a4cb7e32f6e0593c8708c03340d3d1e7f1050e635dbe0a821c236e8e4"}'
        SUMERAGI_TRUSTED_PEERS: '[{"address":"iroha1:1338","public_key":"ed0120CFD105A9754B91389D726A3A3CA38CC8002562F7F9D54DB8F4AA5C6ABCFDE558"}]'
      ports:
      - 1337:1337
      - 8080:8080
      - 8180:8180
      volumes:
      - ./config:/config
      init: true
      command: iroha --submit-genesis
    iroha1:
      build: ./iroha-cloned
      environment:
        IROHA_PUBLIC_KEY: ed0120CFD105A9754B91389D726A3A3CA38CC8002562F7F9D54DB8F4AA5C6ABCFDE558
        IROHA_PRIVATE_KEY: '{"digest_function":"ed25519","payload":"28a79c99529fb3375ed8a0663a7a98ea8349aa7179c1c4dbab255e21fab9442bcfd105a9754b91389d726a3a3ca38cc8002562f7f9d54db8f4aa5c6abcfde558"}'
        TORII_P2P_ADDR: iroha1:1338
        TORII_API_URL: iroha1:8081
        TORII_TELEMETRY_URL: iroha1:8181
        IROHA_GENESIS_ACCOUNT_PUBLIC_KEY: ed01200D80056A4CB7E32F6E0593C8708C03340D3D1E7F1050E635DBE0A821C236E8E4
        IROHA_GENESIS_ACCOUNT_PRIVATE_KEY: '{"digest_function":"ed25519","payload":"3e51c0c06622a95a27d4936d706318fc7430c652136d5348d55db0d47835783c0d80056a4cb7e32f6e0593c8708c03340d3d1e7f1050e635dbe0a821c236e8e4"}'
        SUMERAGI_TRUSTED_PEERS: '[{"address":"iroha0:1337","public_key":"ed0120F958FCF0FCD15BD3A3C50F5A3DA9DF97D1B49D9BD6E482A109AE8082BCC54198"}]'
      ports:
      - 1338:1338
      - 8081:8081
      - 8181:8181
      volumes:
      - ./config:/config
      init: true

• Generated docker-compose configuration based on a locally installed Iroha, with a single peer and without default
  configuration:

  kagami swarm --build ~/Git/iroha --peers 1 --outdir ~/compose-iroha --no-default-configuration

  Generated files:

  [1.1K]  ~/compose-iroha
  ├── [  64]  config
  └── [ 980]  docker-compose.yml
  

  docker-compose.yml`

  version: '3.8'
  services:
    iroha0:
      build: ../Git/iroha
      environment:
        IROHA_PUBLIC_KEY: ed01208A880AB596D8368C3319230978E4292285791865A5E7DDE9415BD48B8F0CBC3C
        IROHA_PRIVATE_KEY: '{"digest_function":"ed25519","payload":"2689e60e1321ac59050e38113908b66dda9975c3da4659c552e10de4f1a1fbe58a880ab596d8368c3319230978e4292285791865a5e7dde9415bd48b8f0cbc3c"}'
        TORII_P2P_ADDR: iroha0:1337
        TORII_API_URL: iroha0:8080
        TORII_TELEMETRY_URL: iroha0:8180
        IROHA_GENESIS_ACCOUNT_PUBLIC_KEY: ed0120CD1EE423ECB2D0A5B26C99CE4326C9D17CE79B38863751646D661759A0E5E625
        IROHA_GENESIS_ACCOUNT_PRIVATE_KEY: '{"digest_function":"ed25519","payload":"fdc2b6f906307b37c0c67a92f7a32ea41a92088da060b710f62718dc00fbd4c0cd1ee423ecb2d0a5b26c99ce4326c9d17ce79b38863751646d661759a0e5e625"}'
        SUMERAGI_TRUSTED_PEERS: '[]'
      ports:
        - 1337:1337
        - 8080:8080
        - 8180:8180
      volumes:
        - ./config:/config
      init: true
      command: iroha --submit-genesis

Linked issue

Closes #2373

Checklist

• Unit tests
• Try with docker-compose up
• Update doc comments
• Self review
• Peers review

To Do in separate PRs

• Update Kagami README ([documentation] Auto-generate Kagami docs from clap #3509)
  • [documentation] #3509: Generate Kagami CLI help as Markdown #3510
• Support portable validator building ([BUG] Kagami fails to generate a validator when runs outside of the repo dir #3473)
• Support single-file emit (i.e. only docker-compose.yml) and generate docker-compose.dev.yml & docker-compose.dev.single.yml with it

[codecov]

Codecov Report

Merging #3475 (f08c12b) into iroha2-dev (a4d5c9f) will decrease coverage by 5.55%.
The diff coverage is 32.86%.

❗ Current head f08c12b differs from pull request most recent head 702ce69. Consider uploading reports for the commit 702ce69 to get more accurate results

@@              Coverage Diff               @@
##           iroha2-dev    #3475      +/-   ##
==============================================
- Coverage       62.33%   56.78%   -5.55%     
==============================================
  Files             169      161       -8     
  Lines           31218    32249    +1031     
==============================================
- Hits            19459    18312    -1147     
- Misses          11759    13937    +2178     

Impacted Files	Coverage Δ
cli/src/lib.rs	0.56% <0.00%> (-68.87%)	⬇️
cli/src/main.rs	0.66% <0.00%> (-0.44%)	⬇️
cli/src/samples.rs	0.00% <0.00%> (-61.85%)	⬇️
cli/src/style.rs	0.00% <0.00%> (ø)
cli/src/torii/mod.rs	0.00% <0.00%> (-27.66%)	⬇️
cli/src/torii/routing.rs	0.00% <0.00%> (-57.11%)	⬇️
cli/src/torii/utils.rs	0.00% <0.00%> (-84.85%)	⬇️
client/src/http_default.rs	0.00% <0.00%> (-38.94%)	⬇️
client/src/lib.rs	3.84% <0.00%> (-96.16%)	⬇️
client_cli/src/main.rs	0.24% <0.00%> (-0.02%)	⬇️
... and 105 more

... and 50 files with indirect coverage changes

[ilchu]

LGTM besides one stylistic point, will approve after fix.