add version display based on git describe command to command line, logs and API (#540)

Alexey-N-Chernyshov · web-flow · commit 66937087a5eb · 2021-11-30T13:30:57.000+03:00
Signed-off-by: Alexey Chernyshov &lt;alexey.n.chernyshov@gmail.com&gt;
diff --git a/core/api/full_node/CMakeLists.txt b/core/api/full_node/CMakeLists.txt
@@ -18,6 +18,7 @@ target_link_libraries(api
     message
     miner_types
     msg_waiter
+    node_version
     state_tree
     mpool
     sync
diff --git a/core/api/full_node/make.cpp b/core/api/full_node/make.cpp
@@ -19,6 +19,7 @@
 #include "crypto/secp256k1/impl/secp256k1_provider_impl.hpp"
 #include "drand/beaconizer.hpp"
 #include "markets/retrieval/protocols/retrieval_protocol.hpp"
+#include "node/node_version.hpp"
 #include "node/pubsub_gate.hpp"
 #include "primitives/tipset/chain.hpp"
 #include "proofs/impl/proof_engine_impl.hpp"
@@ -65,6 +66,7 @@ namespace fc::api {
   using libp2p::peer::PeerId;
   using markets::retrieval::DealProposalParams;
   using markets::retrieval::QueryResponse;
+  using node::kNodeVersion;
   using primitives::kChainEpochUndefined;
   using primitives::block::MsgMeta;
   using primitives::sector::getPreferredSealProofTypeFromWindowPoStType;
@@ -1217,7 +1219,7 @@ namespace fc::api {
     };
     api->Version = []() {
       return VersionResult{
-          "fuhon", makeApiVersion(2, 1, 0), kEpochDurationSeconds};
+          kNodeVersion, makeApiVersion(2, 1, 0), kEpochDurationSeconds};
     };
     api->WalletBalance = [=](auto &address) -> outcome::result<TokenAmount> {
       OUTCOME_TRY(context, tipsetContext({}));
diff --git a/core/api/full_node/node_api_v1_wrapper.cpp b/core/api/full_node/node_api_v1_wrapper.cpp
@@ -5,16 +5,17 @@
 
 #include "api/full_node/node_api_v1_wrapper.hpp"
 
-#include <functional>
 #include "const.hpp"
+#include "node/node_version.hpp"
 
 namespace fc::api {
+  using node::kNodeVersion;
 
   std::shared_ptr<FullNodeApiV1Wrapper> makeFullNodeApiV1Wrapper() {
     auto api = std::make_shared<FullNodeApiV1Wrapper>();
     api->Version = []() {
       return VersionResult{
-          "fuhon", makeApiVersion(1, 4, 0), kEpochDurationSeconds};
+          kNodeVersion, makeApiVersion(1, 4, 0), kEpochDurationSeconds};
     };
     return api;
   }
diff --git a/core/api/storage_miner/CMakeLists.txt b/core/api/storage_miner/CMakeLists.txt
@@ -10,4 +10,5 @@ target_link_libraries(storage_miner_api
     p2p::p2p
     remote_worker
     jwt
+    miner_version
     )
diff --git a/core/api/storage_miner/storage_api.cpp b/core/api/storage_miner/storage_api.cpp
@@ -6,9 +6,11 @@
 #include "api/storage_miner/storage_api.hpp"
 
 #include "api/storage_miner/return_api.hpp"
+#include "miner/miner_version.hpp"
 #include "sector_storage/impl/remote_worker.hpp"
 
 namespace fc::api {
+  using miner::kMinerVersion;
   using sector_storage::RemoteWorker;
 
   std::shared_ptr<StorageMinerApi> makeStorageApi(
@@ -143,7 +145,7 @@ namespace fc::api {
     };
 
     api->Version = [] {
-      return api::VersionResult{"fuhon-miner", kMinerApiVersion, 0};
+      return api::VersionResult{kMinerVersion, kMinerApiVersion, 0};
     };
 
     return api;
diff --git a/core/common/CMakeLists.txt b/core/common/CMakeLists.txt
@@ -3,6 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
+add_subdirectory(git_commit_version)
 add_subdirectory(libp2p)
 add_subdirectory(smoothing)
 add_subdirectory(uri_parser)
diff --git a/core/common/git_commit_version/CMakeLists.txt b/core/common/git_commit_version/CMakeLists.txt
@@ -0,0 +1,16 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+add_custom_target(git_commit_version_generated
+    COMMAND ./git_commit_version.sh
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+    BYPRODUCTS ${CMAKE_CURRENT_SOURCE_DIR}/git_commit_version.cpp
+    )
+add_library(git_commit_version
+    git_commit_version.cpp
+    )
+add_dependencies(git_commit_version
+    git_commit_version_generated
+    )
diff --git a/core/common/git_commit_version/git_commit_version.cpp.in b/core/common/git_commit_version/git_commit_version.cpp.in
@@ -0,0 +1,13 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "common/git_commit_version/git_commit_version.hpp"
+
+namespace fc::common::git_commit_version {
+  const std::string &getGitPrettyVersion() {
+    static const std::string version{"@GIT_REPO_PRETTY_VERSION@"};
+    return version;
+  }
+}  // namespace fc::common::git_commit_version
diff --git a/core/common/git_commit_version/git_commit_version.hpp b/core/common/git_commit_version/git_commit_version.hpp
@@ -0,0 +1,16 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include <string>
+
+namespace fc::common::git_commit_version {
+
+  /**
+   * Returns string containing git most recent tag and commit hash.
+   */
+  const std::string &getGitPrettyVersion();
+}  // namespace fc::common::git_commit_version
diff --git a/core/common/git_commit_version/git_commit_version.sh b/core/common/git_commit_version/git_commit_version.sh
@@ -0,0 +1,13 @@
+#!/bin/sh
+set -e
+
+GIT_REPO_PRETTY_VERSION=$(git describe --tags --always --dirty) || GIT_REPO_PRETTY_VERSION="git-unknown"
+FILE=$(sed -e "s/@GIT_REPO_PRETTY_VERSION@/$GIT_REPO_PRETTY_VERSION/g" git_commit_version.cpp.in)
+OLD_FILE=$(cat git_commit_version.cpp) || OLD_FILE=""
+HASH=$(echo "$FILE" | shasum)
+OLD_HASH=$(echo "$OLD_FILE" | shasum)
+
+if [ "$HASH" != "$OLD_HASH" ]; then
+  echo "git_commit_version.sh: update"
+  echo "$FILE" > git_commit_version.cpp
+fi
diff --git a/core/miner/CMakeLists.txt b/core/miner/CMakeLists.txt
@@ -27,3 +27,9 @@ target_link_libraries(mining
     tipset
     miner_types
     )
+
+add_library(miner_version INTERFACE
+    )
+target_link_libraries(miner_version INTERFACE
+    git_commit_version
+    )
diff --git a/core/miner/main/CMakeLists.txt b/core/miner/main/CMakeLists.txt
@@ -14,6 +14,7 @@ target_link_libraries(fuhon-miner
     manager
     miner
     mining
+    miner_version
     proof_param_provider
     p2p::p2p
     rpc
diff --git a/core/miner/main/main.cpp b/core/miner/main/main.cpp
@@ -33,6 +33,7 @@
 #include "markets/storage/provider/impl/provider_impl.hpp"
 #include "miner/impl/miner_impl.hpp"
 #include "miner/main/type.hpp"
+#include "miner/miner_version.hpp"
 #include "miner/mining.hpp"
 #include "miner/windowpost.hpp"
 #include "primitives/address/config.hpp"
@@ -62,6 +63,7 @@ namespace fc {
   using libp2p::multi::Multiaddress;
   using libp2p::peer::PeerId;
   using markets::storage::chain_events::ChainEventsImpl;
+  using miner::kMinerVersion;
   using primitives::StoredCounter;
   using primitives::address::Address;
   using primitives::jwt::kAllPermission;
@@ -138,6 +140,7 @@ namespace fc {
     po::options_description desc("Fuhon miner options");
     auto option{desc.add_options()};
     option("help,h", "print usage message");
+    option("version,v", "show miner version information");
     option("miner-repo", po::value(&config.repo_path)->required());
     option("repo", po::value(&raw.node_repo));
     option("miner-api", po::value(&config.api_port)->default_value(2345));
@@ -161,6 +164,10 @@ namespace fc {
       std::cerr << desc << std::endl;
       exit(EXIT_SUCCESS);
     }
+    if (vm.count("version") != 0) {
+      std::cerr << kMinerVersion << std::endl;
+      exit(EXIT_SUCCESS);
+    }
     po::notify(vm);
     boost::filesystem::create_directories(config.repo_path);
     std::ifstream config_file{config.join("config.cfg")};
@@ -324,6 +331,8 @@ namespace fc {
   }
 
   outcome::result<void> main(Config &config) {
+    log()->debug("Starting ", miner::kMinerVersion);
+
     auto clock{std::make_shared<clock::UTCClockImpl>()};
 
     OUTCOME_TRY(leveldb, storage::LevelDB::create(config.join("leveldb")));
diff --git a/core/miner/miner_version.hpp b/core/miner/miner_version.hpp
@@ -0,0 +1,14 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include "common/git_commit_version/git_commit_version.hpp"
+
+namespace fc::miner {
+  using common::git_commit_version::getGitPrettyVersion;
+
+  const std::string kMinerVersion = "Fuhon Miner " + getGitPrettyVersion();
+}  // namespace fc::miner
diff --git a/core/node/CMakeLists.txt b/core/node/CMakeLists.txt
@@ -3,6 +3,8 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
+add_subdirectory(main)
+
 add_library(sync
     identify.cpp
     say_hello.cpp
@@ -26,4 +28,8 @@ target_link_libraries(sync
     p2p::p2p_kademlia
     )
 
-add_subdirectory(main)
+add_library(node_version INTERFACE
+    )
+target_link_libraries(node_version INTERFACE
+    git_commit_version
+    )
diff --git a/core/node/main/CMakeLists.txt b/core/node/main/CMakeLists.txt
@@ -27,6 +27,7 @@ target_link_libraries(node_builder
     interpreter
     keystore
     mpool
+    node_version
     paych_maker
     paych_vouchers
     p2p::p2p_basic_host
diff --git a/core/node/main/config.cpp b/core/node/main/config.cpp
@@ -11,6 +11,7 @@
 #include <iostream>
 
 #include "config/profile_config.hpp"
+#include "node/node_version.hpp"
 #include "primitives/address/config.hpp"
 
 namespace fc::common {
@@ -78,6 +79,7 @@ namespace fc::node {
     po::options_description desc("Fuhon node options");
     auto option{desc.add_options()};
     option("help,h", "print usage message");
+    option("version,v", "show node version information");
     option("repo", po::value(&config.repo_path)->required());
     option("config", po::value(&raw.copy_config), "copy config from file");
     option("genesis", po::value(&raw.copy_genesis), "copy genesis from file");
@@ -124,6 +126,10 @@ namespace fc::node {
       std::cerr << desc << std::endl;
       exit(EXIT_SUCCESS);
     }
+    if (vm.count("version") != 0) {
+      std::cerr << kNodeVersion << std::endl;
+      exit(EXIT_SUCCESS);
+    }
     po::notify(vm);
     boost::filesystem::create_directories(config.repo_path);
     std::ofstream{config.join(".pid")} << getpid();
diff --git a/core/node/main/main.cpp b/core/node/main/main.cpp
@@ -26,6 +26,7 @@
 #include "node/identify.hpp"
 #include "node/main/builder.hpp"
 #include "node/main/metrics.hpp"
+#include "node/node_version.hpp"
 #include "node/peer_discovery.hpp"
 #include "node/pubsub_gate.hpp"
 #include "node/pubsub_workaround.hpp"
@@ -240,6 +241,8 @@ namespace fc {
   }
 
   void main(node::Config &config) {
+    log()->debug("Starting ", node::kNodeVersion);
+
     const auto start_time{Metrics::Clock::now()};
 
     vm::actor::cgo::configParams();
diff --git a/core/node/node_version.hpp b/core/node/node_version.hpp
@@ -0,0 +1,14 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include "common/git_commit_version/git_commit_version.hpp"
+
+namespace fc::node {
+  using common::git_commit_version::getGitPrettyVersion;
+
+  const std::string kNodeVersion = "Fuhon Node " + getGitPrettyVersion();
+}  // namespace fc::node

Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,5 @@ target_link_libraries(storage_miner_api`
`10`	`10`	`p2p::p2p`
`11`	`11`	`remote_worker`
`12`	`12`	`jwt`
	`13`	`+ miner_version`
`13`	`14`	`)`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`# SPDX-License-Identifier: Apache-2.0`
`4`	`4`	`#`
`5`	`5`
	`6`	`+add_subdirectory(git_commit_version)`
`6`	`7`	`add_subdirectory(libp2p)`
`7`	`8`	`add_subdirectory(smoothing)`
`8`	`9`	`add_subdirectory(uri_parser)`