tmp/cli

turuslan · turuslan · commit 68f5c8462442 · 2022-02-12T16:18:21.000+03:00
Signed-off-by: turuslan &lt;turuslan.devbox@gmail.com&gt;
diff --git a/core/CMakeLists.txt b/core/CMakeLists.txt
@@ -6,6 +6,7 @@
 add_subdirectory(adt)
 add_subdirectory(api)
 add_subdirectory(blockchain)
+add_subdirectory(cli)
 add_subdirectory(clock)
 add_subdirectory(codec)
 add_subdirectory(common)
diff --git a/core/cli/CMakeLists.txt b/core/cli/CMakeLists.txt
@@ -0,0 +1,12 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+add_library(cli INTERFACE)
+target_link_libraries(cli INTERFACE
+    Boost::program_options
+    fmt::fmt
+    )
+
+add_subdirectory(example)
diff --git a/core/cli/cli.hpp b/core/cli/cli.hpp
@@ -0,0 +1,52 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include <boost/optional.hpp>
+#include <boost/program_options/options_description.hpp>
+#include <map>
+#include <memory>
+#include <typeindex>
+
+#define CLI_OPTS() ::fc::cli::Opts opts()
+#define CLI_RUN()                                                 \
+  static ::fc::cli::RunResult run(const ::fc::cli::ArgsMap &argm, \
+                                  const Args &args,               \
+                                  const ::fc::cli::Argv &argv)
+#define CLI_NO_RUN() constexpr static nullptr_t run{nullptr};
+
+namespace fc::cli {
+  namespace po = boost::program_options;
+  using Opts = po::options_description;
+
+  using RunResult = void;
+  struct ArgsMap {
+    std::map<std::type_index, std::shared_ptr<void>> _;
+    template <typename Args>
+    void add(Args &&v) {
+      _.emplace(typeid(Args), std::make_shared<Args>(std::forward<Args>(v)));
+    }
+    template <typename Cmd>
+    const typename Cmd::Args &of() const {
+      return *reinterpret_cast<const typename Cmd::Args *>(
+          _.at(typeid(typename Cmd::Args)).get());
+    }
+  };
+  // note: Args is defined inside command
+  using Argv = std::vector<std::string>;
+
+  struct Empty {
+    struct Args {
+      CLI_OPTS() {
+        return {};
+      }
+    };
+    CLI_NO_RUN();
+  };
+  using Group = Empty;
+
+  struct ShowHelp {};
+}  // namespace fc::cli
diff --git a/core/cli/example/CMakeLists.txt b/core/cli/example/CMakeLists.txt
@@ -0,0 +1,10 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+add_executable(cli_example main.cpp)
+target_link_libraries(cli_example
+    cli
+    rpc
+    )
diff --git a/core/cli/example/main.cpp b/core/cli/example/main.cpp
@@ -0,0 +1,11 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "cli/node/_tree.hpp"
+#include "cli/run.hpp"
+
+int main(int argc, const char *argv[]) {
+  fc::cli::run("cli_example", fc::cli::_node::_tree, argc, argv);
+}
diff --git a/core/cli/node/_tree.hpp b/core/cli/node/_tree.hpp
@@ -0,0 +1,18 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include "cli/node/net.hpp"
+#include "cli/tree.hpp"
+
+namespace fc::cli::_node {
+  const auto _tree{tree<Node>({
+      {"net",
+       tree<Group>({
+           {"listen", tree<Node_net_listen>()},
+       })},
+  })};
+}  // namespace fc::cli::_node
diff --git a/core/cli/node/net.hpp b/core/cli/node/net.hpp
@@ -0,0 +1,20 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include "cli/node/node.hpp"
+
+namespace fc::cli::_node {
+  struct Node_net_listen : Empty {
+    CLI_RUN() {
+      Node::Api api{argm};
+      const auto peer{api._->NetAddrsListen().value()};
+      for (const auto &addr : peer.addresses) {
+        fmt::print("{}\n", addr.getStringAddress());
+      }
+    }
+  };
+}  // namespace fc::cli::_node
diff --git a/core/cli/node/node.hpp b/core/cli/node/node.hpp
@@ -0,0 +1,53 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include <fmt/format.h>
+
+#include "api/rpc/client_setup.hpp"
+#include "api/rpc/info.hpp"
+#include "cli/cli.hpp"
+#include "node/node_version.hpp"
+
+namespace fc::cli::_node {
+  struct Node {
+    struct Args {
+      bool version{};
+      boost::optional<boost::filesystem::path> repo;
+
+      CLI_OPTS() {
+        Opts opts;
+        auto opt{opts.add_options()};
+        opt("version,v", po::bool_switch(&version));
+        opt("repo", po::value(&repo));
+        return opts;
+      }
+    };
+    CLI_RUN() {
+      if (args.version) {
+        fmt::print("{}\n", node::kNodeVersion);
+        return;
+      }
+      throw ShowHelp{};
+    }
+
+    struct Api {
+      std::shared_ptr<api::FullNodeApi> _;
+      IoThread thread;
+      std::shared_ptr<api::rpc::Client> wsc;
+
+      Api(const ArgsMap &argm) {
+        const auto &args{argm.of<Node>()};
+        const auto info{
+            *api::rpc::loadInfo(args.repo.value_or(""), "FULLNODE_API_INFO")};
+        _ = std::make_shared<api::FullNodeApi>();
+        wsc = std::make_shared<api::rpc::Client>(*thread.io);
+        wsc->setup(*_);
+        wsc->connect(info.first, "/rpc/v1", info.second).value();
+      }
+    };
+  };
+}  // namespace fc::cli::_node
diff --git a/core/cli/run.hpp b/core/cli/run.hpp
@@ -0,0 +1,106 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include <fmt/format.h>
+#include <fmt/ostream.h>
+#include <boost/program_options/parsers.hpp>
+#include <boost/program_options/variables_map.hpp>
+
+#include "cli/tree.hpp"
+
+namespace fc::cli {
+  inline bool isDash(const std::string &s) {
+    return !s.empty() && s[0] == '-';
+  }
+  inline bool isDashDash(const std::string &s) {
+    return s.size() == 2 && s[0] == '-' && s[1] == '-';
+  }
+  // note: returns first positional arg or end
+  inline Argv::iterator hackBoost(const Opts &opts,
+                                  Argv::iterator begin,
+                                  Argv::iterator end) {
+    po::parsed_options parsed{&opts};
+    while (true) {
+      if (begin == end) {
+        break;
+      }
+      if (!isDash(*begin)) {
+        break;
+      }
+      if (isDashDash(*begin)) {
+        ++begin;
+        break;
+      }
+      const auto it{std::find_if(begin + 1, end, isDash)};
+      const auto options{
+          po::command_line_parser{Argv{begin, it}}.options(opts).run().options};
+      if (options.empty()) {
+        break;
+      }
+      for (const auto &option : options) {
+        parsed.options.emplace_back(option);
+        if (option.string_key.empty()) {
+          break;
+        }
+        begin += option.original_tokens.size();
+      }
+    }
+    po::variables_map vm;
+    po::store(parsed, vm);
+    po::notify(vm);
+    return begin;
+  }
+
+  inline RunResult run(std::string app, const Tree &_tree, Argv argv) {
+    auto tree{&_tree};
+    std::vector<std::string> cmds;
+    cmds.emplace_back(std::move(app));
+    ArgsMap argm;
+    auto argv_it{argv.begin()};
+    while (true) {
+      auto args{tree->args()};
+      auto option{args.opts.add_options()};
+      bool help{};
+      // note: help doesn't work with required options
+      option("help,h", po::bool_switch(&help));
+      argv_it = hackBoost(args.opts, argv_it, argv.end());
+      argm._.emplace(args._);
+      if (!help) {
+        if (argv_it != argv.end()) {
+          auto sub_it{tree->sub.find(*argv_it)};
+          if (sub_it != tree->sub.end()) {
+            ++argv_it;
+            cmds.emplace_back(sub_it->first);
+            tree = &sub_it->second;
+            continue;
+          }
+        }
+        if (tree->run) {
+          try {
+            return tree->run(argm, {argv_it, argv.end()});
+          } catch (ShowHelp &) {
+          }
+        }
+      }
+      fmt::print("name:\n  {}\n", fmt::join(cmds, " "));
+      fmt::print("options:\n{}", args.opts);
+      if (!tree->sub.empty()) {
+        fmt::print("subcommands:\n");
+        for (const auto &sub : tree->sub) {
+          fmt::print("  {}\n", sub.first);
+        }
+      }
+      return;
+    }
+  }
+  inline RunResult run(std::string app,
+                       const Tree &tree,
+                       int argc,
+                       const char *argv[]) {
+    return run(std::move(app), tree, {argv + 1, argv + argc});
+  }
+}  // namespace fc::cli
diff --git a/core/cli/tree.hpp b/core/cli/tree.hpp
@@ -0,0 +1,39 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include "cli/cli.hpp"
+
+namespace fc::cli {
+  struct Tree {
+    using Sub = std::map<std::string, Tree>;
+    struct Args {
+      std::pair<std::type_index, std::shared_ptr<void>> _;
+      Opts opts;
+    };
+    std::function<Args()> args;
+    std::function<RunResult(const ArgsMap &argm, const Argv &argv)> run;
+    Sub sub;
+  };
+  template <typename Cmd>
+  Tree tree(Tree::Sub sub = {}) {
+    Tree t;
+    t.args = [] {
+      const auto ptr{std::make_shared<typename Cmd::Args>()};
+      return Tree::Args{{typeid(typename Cmd::Args), ptr}, ptr->opts()};
+    };
+    constexpr auto run{!std::is_same_v<decltype(Cmd::run), const nullptr_t>};
+    if constexpr (run) {
+      t.run = [](const ArgsMap &argm, const Argv &argv) {
+        if constexpr (run) {
+          return Cmd::run(argm, argm.of<Cmd>(), argv);
+        }
+      };
+    }
+    t.sub = std::move(sub);
+    return t;
+  }
+}  // namespace fc::cli
diff --git a/test/core/CMakeLists.txt b/test/core/CMakeLists.txt
@@ -6,6 +6,7 @@
 add_subdirectory(adt)
 add_subdirectory(api)
 add_subdirectory(blockchain)
+add_subdirectory(cli)
 add_subdirectory(clock)
 add_subdirectory(codec)
 add_subdirectory(common)
diff --git a/test/core/cli/CMakeLists.txt b/test/core/cli/CMakeLists.txt
@@ -0,0 +1,11 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+addtest(cli_test
+    test.cpp
+    )
+target_link_libraries(cli_test
+    cli
+    )
diff --git a/test/core/cli/test.cpp b/test/core/cli/test.cpp
