Print out commit info

nkh-lab · May 5, 2023 · 28dc181 · 28dc181
1 parent 55efe73
commit 28dc181
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 9 deletions.
diff --git a/app-cli/src/GetRelayWorker.cpp b/app-cli/src/GetRelayWorker.cpp
@@ -19,7 +19,6 @@
 
 using namespace nkhlab::lightargparser;
 using namespace nkhlab::cpputils;
-using namespace nkhlab::usbrelaymodule::config;
 
 namespace {
 const char* kAllRelays = "";
@@ -97,7 +96,11 @@ bool GetRelayWorker::Run(int argc, char const** argv, std::string& out)
 std::string GetRelayWorker::DoVersionText()
 {
     return StringHelper::Sprintf(
-        TextUserInterface::kVersion, kProjectVerMajor, kProjectVerMinor, kProjectVerPatch);
+        TextUserInterface::kVersion,
+        config::kProjectVerMajor,
+        config::kProjectVerMinor,
+        config::kProjectVerPatch,
+        config::kGitCommitHash);
 }
 
 std::string GetRelayWorker::DoHelpText()

diff --git a/app-cli/src/SetRelayWorker.cpp b/app-cli/src/SetRelayWorker.cpp
@@ -98,7 +98,8 @@ std::string SetRelayWorker::DoVersionText()
         TextUserInterface::kVersion,
         config::kProjectVerMajor,
         config::kProjectVerMinor,
-        config::kProjectVerPatch);
+        config::kProjectVerPatch,
+        config::kGitCommitHash);
 }
 
 std::string SetRelayWorker::DoHelpText()

diff --git a/app-cli/src/TextUserInterface.cpp b/app-cli/src/TextUserInterface.cpp
@@ -18,7 +18,8 @@ namespace appcli {
 // clang-format off
 
 const char* TextUserInterface::kVersion =
-    "v%d.%d.%d\n"
+    "Version: %d.%d.%d\n"
+    "Commit: %s\n"
     "Copyright (C) 2023 https://github.com/nkh-lab\n"
     "This is free software under GPL-3.0 license.\n";
 

diff --git a/app-cli/tests/unit/GetRelayWorkerTest.cpp b/app-cli/tests/unit/GetRelayWorkerTest.cpp
@@ -91,7 +91,7 @@ TEST_F(GetRelayWorkerTest, VersionShortArg)
     EXPECT_EQ(
         out,
         StringHelper::Sprintf(
-            TextUserInterface::kVersion, kProjectVerMajor, kProjectVerMinor, kProjectVerPatch));
+            TextUserInterface::kVersion, kProjectVerMajor, kProjectVerMinor, kProjectVerPatch, kGitCommitHash));
     EXPECT_TRUE(ret);
 }
 
@@ -113,7 +113,7 @@ TEST_F(GetRelayWorkerTest, VersionLongArg)
     EXPECT_EQ(
         out,
         StringHelper::Sprintf(
-            TextUserInterface::kVersion, kProjectVerMajor, kProjectVerMinor, kProjectVerPatch));
+            TextUserInterface::kVersion, kProjectVerMajor, kProjectVerMinor, kProjectVerPatch, kGitCommitHash));
     EXPECT_TRUE(ret);
 }
 

diff --git a/app-cli/tests/unit/SetRelayWorkerTest.cpp b/app-cli/tests/unit/SetRelayWorkerTest.cpp
@@ -71,7 +71,7 @@ TEST_F(SetRelayWorkerTest, VersionShortArg)
     EXPECT_EQ(
         out,
         StringHelper::Sprintf(
-            TextUserInterface::kVersion, kProjectVerMajor, kProjectVerMinor, kProjectVerPatch));
+            TextUserInterface::kVersion, kProjectVerMajor, kProjectVerMinor, kProjectVerPatch, kGitCommitHash));
     EXPECT_TRUE(ret);
 }
 
@@ -93,7 +93,7 @@ TEST_F(SetRelayWorkerTest, VersionLongArg)
     EXPECT_EQ(
         out,
         StringHelper::Sprintf(
-            TextUserInterface::kVersion, kProjectVerMajor, kProjectVerMinor, kProjectVerPatch));
+            TextUserInterface::kVersion, kProjectVerMajor, kProjectVerMinor, kProjectVerPatch, kGitCommitHash));
     EXPECT_TRUE(ret);
 }
 

diff --git a/app-gui/src/widgets/WidgetAboutDialog.cpp b/app-gui/src/widgets/WidgetAboutDialog.cpp
@@ -29,6 +29,7 @@ constexpr char kProjectUrl[] = "https://github.com/nkh-lab/usb-relay-module";
 
 constexpr char kAboutText[] =
     "Version: %d.%d.%d\n"
+    "Commit: %s\n"
     "\n"
     "Copyright (C) 2023 https://github.com/nkh-lab\n"
     "This is free software under GPL-3.0 license.\n";
@@ -45,7 +46,11 @@ WidgetAboutDialog::WidgetAboutDialog(wxWindow* parent)
         this,
         wxID_ANY,
         StringHelper::Sprintf(
-            kAboutText, config::kProjectVerMajor, config::kProjectVerMinor, config::kProjectVerPatch));
+            kAboutText,
+            config::kProjectVerMajor,
+            config::kProjectVerMinor,
+            config::kProjectVerPatch,
+            config::kGitCommitHash));
 
     wxButton* ok_btn = new wxButton(this, wxID_OK, "OK");
 

diff --git a/config/CMakeLists.txt b/config/CMakeLists.txt
@@ -11,6 +11,13 @@
 
 set(CONFIG_LIB "libusbrelaymodule-config")
 
+execute_process(
+    COMMAND git rev-parse HEAD
+    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+    OUTPUT_VARIABLE GIT_COMMIT_HASH
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
 file(GLOB CFG_FILES "include/*.h.in")
 
 foreach(CFG_FILE IN LISTS CFG_FILES)

diff --git a/config/include/Config.h.in b/config/include/Config.h.in
@@ -19,6 +19,7 @@ namespace config {
 constexpr int kProjectVerMajor = @PROJECT_VERSION_MAJOR@;
 constexpr int kProjectVerMinor = @PROJECT_VERSION_MINOR@;
 constexpr int kProjectVerPatch = @PROJECT_VERSION_PATCH@;
+constexpr char kGitCommitHash[] = "@GIT_COMMIT_HASH@";
 // clang-format on
 
 } // namespace config