Git info store object

CMakeLists.txt

@@ -1124,7 +1124,7 @@ endif()
 # The mixxx executable
 add_executable(mixxx WIN32 src/main.cpp)
 set_target_properties(mixxx-lib PROPERTIES CXX_CLANG_TIDY "${CLANG_TIDY}")
-target_link_libraries(mixxx PRIVATE mixxx-lib)
+target_link_libraries(mixxx PRIVATE mixxx-lib mixxx-gitinfostore)
 
 #
 # Installation and Packaging
@@ -1500,7 +1500,7 @@ add_executable(mixxx-test
   src/test/wwidgetstack_test.cpp
 )
 set_target_properties(mixxx-test PROPERTIES AUTOMOC ON)
-target_link_libraries(mixxx-test PRIVATE mixxx-lib gtest gmock)
+target_link_libraries(mixxx-test PRIVATE mixxx-lib mixxx-gitinfostore gtest gmock)
 
 #
 # Benchmark tests
@@ -1607,16 +1607,27 @@ get_target_property(MIXXX_BUILD_FLAGS mixxx-lib COMPILE_OPTIONS)
 # uses CMAKE_PROJECT_VERSION MIXXX_VERSION_PRERELEASE MIXXX_BUILD_FLAGS
 configure_file(src/version.h.in src/version.h @ONLY)
 
+if(GIT_COMMIT_DATE AND NOT GIT_COMMIT_DATE MATCHES "^[0-9]*-[0-9]*-[0-9]*T[0-9]*\\:[0-9]*\\:[0-9]*[+-][0-9]*\\:[0-9]*$")
+  message(FATAL_ERROR "GIT_COMMIT_DATE requires strict ISO 8601 format %Y-%m-%dT%H:%M:%SZ")
+endif()
+
 add_custom_target(mixxx-gitinfo
   COMMAND ${CMAKE_COMMAND}
+    -DGIT_DESCRIBE="${GIT_DESCRIBE}"
+    -DGIT_COMMIT_DATE="${GIT_COMMIT_DATE}"
     -DINPUT_FILE="${CMAKE_CURRENT_SOURCE_DIR}/src/gitinfo.h.in"
     -DOUTPUT_FILE="${CMAKE_CURRENT_BINARY_DIR}/src/gitinfo.h"
     -P "${CMAKE_CURRENT_SOURCE_DIR}/cmake/scripts/gitinfo.cmake"
   COMMENT "Update git version information in gitinfo.h"
   BYPRODUCTS "${CMAKE_CURRENT_BINARY_DIR}/src/gitinfo.h"
   WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
 )
-add_dependencies(mixxx-lib mixxx-gitinfo)
+
+add_library(mixxx-gitinfostore STATIC EXCLUDE_FROM_ALL
+    src/util/gitinfostore.cpp
+)
+target_include_directories(mixxx-gitinfostore PUBLIC src ${CMAKE_BINARY_DIR}/src)
+add_dependencies(mixxx-gitinfostore mixxx-gitinfo)
 
 # Windows-only resource file
 if(WIN32)
@@ -1639,8 +1650,8 @@ if(WIN32)
 
   # uses MIXXX_YEAR MIXXX_FILEVERSION MIXXX_PRODUCTVERSION MIXXX_VERSION MIXXX_DEBUG MIXXX_PRERELEASE
   configure_file(
-    "${CMAKE_CURRENT_SOURCE_DIR}/src/mixxx.rc.include.template"
-    "${CMAKE_CURRENT_BINARY_DIR}/src/mixxx.rc.include"
+    "src/mixxx.rc.include.in"
+    "src/mixxx.rc.include"
     @ONLY
   )
   add_dependencies(mixxx mixxx-gitinfo)
@@ -2646,6 +2657,9 @@ set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README")
 set(CPACK_STRIP_FILES ON)
 set(CPACK_CREATE_DESKTOP_LINKS "mixxx")
 set(CPACK_MIXXX_VERSION "${MIXXX_VERSION}")
+# Save GIT values just in case they have been set manual via cmake
+set(CPACK_GIT_DESCRIBE "${GIT_DESCRIBE}")
+set(CPACK_GIT_COMMIT_DATE ${GIT_COMMIT_DATE})
 
 # Detailed version information, git info and package file name are set from
 # CPackConfig.cmake, not here.

cmake/modules/GitInfo.cmake

@@ -1,65 +1,78 @@
 # Get the current commit ref
-execute_process(
-  COMMAND git describe --tags --always --dirty=-modified
-  WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
-  OUTPUT_VARIABLE GIT_DESCRIBE
-  OUTPUT_STRIP_TRAILING_WHITESPACE
-  ERROR_QUIET
-)
 if(NOT GIT_DESCRIBE)
-  message(NOTICE "Git describe: unknown")
-else()
-  message(NOTICE "Git describe: ${GIT_DESCRIBE}")
-  string(REGEX MATCH "-modified$" GIT_DIRTY "${GIT_DESCRIBE}")
-  if (GIT_DIRTY)
-    message("Git worktree modified: yes")
-    set(GIT_DIRTY 1)
+  execute_process(
+    COMMAND git describe --tags --always --dirty=-modified
+    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+    OUTPUT_VARIABLE GIT_DESCRIBE
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    ERROR_QUIET
+  )
+  if(NOT GIT_DESCRIBE)
+    message(NOTICE "Git describe is unknown, you may set it via GIT_DESCRIBE")
   else()
-    message(NOTICE "Git worktree modified: no")
-    set(GIT_DIRTY 0)
-  endif()
-endif()
+    message(NOTICE "Git describe: ${GIT_DESCRIBE}")
+    string(REGEX MATCH "-modified$" GIT_DIRTY "${GIT_DESCRIBE}")
+    if (GIT_DIRTY)
+      message("Git worktree modified: yes")
+      set(GIT_DIRTY 1)
+    else()
+      message(NOTICE "Git worktree modified: no")
+      set(GIT_DIRTY 0)
+    endif()
+
+    # Get the current working branch
+    execute_process(
+      COMMAND git rev-parse --abbrev-ref HEAD
+      WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+      OUTPUT_VARIABLE GIT_BRANCH
+      OUTPUT_STRIP_TRAILING_WHITESPACE
+      ERROR_QUIET
+    )
+    if(NOT GIT_BRANCH)
+      message(NOTICE "Git branch: unknown")
+    else()
+      message(NOTICE "Git branch: ${GIT_BRANCH}")
+    endif()
 
-# Get the current working branch
-execute_process(
-  COMMAND git rev-parse --abbrev-ref HEAD
-  WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
-  OUTPUT_VARIABLE GIT_BRANCH
-  OUTPUT_STRIP_TRAILING_WHITESPACE
-  ERROR_QUIET
-)
-if(NOT GIT_BRANCH)
-  message(NOTICE "Git branch: unknown")
+    # Get the number of commits on the working branch
+    execute_process(
+      COMMAND git rev-list --count --first-parent HEAD
+      WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+      OUTPUT_VARIABLE GIT_COMMIT_COUNT
+      OUTPUT_STRIP_TRAILING_WHITESPACE
+      ERROR_QUIET
+    )
+    if(NOT GIT_COMMIT_COUNT)
+      message(NOTICE "Git commit count: unknown")
+    else()
+      message(NOTICE "Git commit count: ${GIT_COMMIT_COUNT}")
+    endif()
+  endif()
 else()
-  message(NOTICE "Git branch: ${GIT_BRANCH}")
+  message(NOTICE "Git describe: ${GIT_DESCRIBE}")
+  if(NOT GIT_COMMIT_DATE)
+    message(NOTICE "Git commit date unknown, using current time for GIT_COMMIT_DATE")
+    # use current date in case of tar ball builds
+    string(TIMESTAMP GIT_COMMIT_DATE "%Y-%m-%dT%H:%M:%SZ" UTC)
+  endif()
 endif()
 
 # Get the current commit date
-execute_process(
-  COMMAND git show --quiet --format=%cI --date=short
-  WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
-  OUTPUT_VARIABLE GIT_COMMIT_DATE
-  OUTPUT_STRIP_TRAILING_WHITESPACE
-  ERROR_QUIET
-)
 if(NOT GIT_COMMIT_DATE)
-  message(NOTICE "Git commit date: unknown")
-else()
-  message(NOTICE "Git commit date: ${GIT_COMMIT_DATE}")
-  string(REGEX MATCH "^[0-9][0-9][0-9][0-9]" GIT_COMMIT_YEAR "${GIT_COMMIT_DATE}")
-  message(NOTICE "Git commit year: ${GIT_COMMIT_YEAR}")
+  execute_process(
+    COMMAND git show --quiet --format=%cI --date=short
+    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+    OUTPUT_VARIABLE GIT_COMMIT_DATE
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    ERROR_QUIET
+  )
 endif()
 
-# Get the number of commits on the working branch
-execute_process(
-  COMMAND git rev-list --count --first-parent HEAD
-  WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
-  OUTPUT_VARIABLE GIT_COMMIT_COUNT
-  OUTPUT_STRIP_TRAILING_WHITESPACE
-  ERROR_QUIET
-)
-if(NOT GIT_COMMIT_COUNT)
-  message(NOTICE "Git commit count: unknown")
+if(NOT GIT_COMMIT_DATE)
+  message(NOTICE "Git commit date unknown, using current time for GIT_COMMIT_DATE")
+  # use current date in case of tar ball builds
+  string(TIMESTAMP GIT_COMMIT_DATE "%Y-%m-%dT%H:%M:%SZ" UTC)
 else()
-  message(NOTICE "Git commit count: ${GIT_COMMIT_COUNT}")
+  message(NOTICE "Git commit date: ${GIT_COMMIT_DATE}")
 endif()
+string(REGEX MATCH "^[0-9][0-9][0-9][0-9]" GIT_COMMIT_YEAR "${GIT_COMMIT_DATE}")

packaging/CPackConfig.cmake

@@ -1,5 +1,7 @@
 # unlike CMakeLists.txt this file is include at cpack time, once per generator after CPack has set CPACK_GENERATOR
 # to the actual generator being used. It allows per-generator setting of CPACK_* variables at cpack time.
+set(GIT_DESCRIBE "${CPACK_GIT_DESCRIBE}")
+set(GIT_COMMIT_DATE ${CPACK_GIT_COMMIT_DATE})
 set(CMAKE_CURRENT_SOURCE_DIR "${CPACK_SOURCE_DIR}")
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules")
 include(GitInfo)
@@ -11,12 +13,6 @@ else()
 endif()
 set(CPACK_PACKAGE_FILE_NAME "mixxx-${PACKAGE_VERSION}")
 set(CPACK_SOURCE_PACKAGE_FILE_NAME "${CPACK_PACKAGE_FILE_NAME}-source")
-set(CPACK_DEBIAN_GIT_BRANCH ${GIT_BRANCH})
-set(CPACK_DEBIAN_GIT_COMMIT_COUNT ${GIT_COMMIT_COUNT})
-set(CPACK_DEBIAN_GIT_COMMIT_DATE ${GIT_COMMIT_DATE})
-set(CPACK_DEBIAN_GIT_COMMIT_YEAR ${GIT_COMMIT_YEAR})
-set(CPACK_DEBIAN_GIT_DESCRIBE "${GIT_DESCRIBE}")
-set(CPACK_DEBIAN_GIT_DIRTY ${GIT_DIRTY})
 
 # The upstream version must not contain hyphen
 # . for nomal versioning + for advance and ~ for decline the version

packaging/CPackDebUploadPPA.cmake

@@ -55,21 +55,8 @@ execute_process(
   WORKING_DIRECTORY ${CPACK_TOPLEVEL_DIRECTORY}
 )
 
-set(CMAKE_PROJECT_VERSION_MAJOR "@CMAKE_PROJECT_VERSION_MAJOR@")
-set(CMAKE_PROJECT_VERSION_MINOR "@CMAKE_PROJECT_VERSION_MINOR@")
-set(CMAKE_PROJECT_VERSION_PATCH "@CMAKE_PROJECT_VERSION_PATCH@")
-set(MIXXX_VERSION_PRERELEASE "@MIXXX_VERSION_PRERELEASE@")
-set(MIXXX_BUILD_FLAGS "@MIXXX_BUILD_FLAGS@")
-configure_file(
-    ${CPACK_TOPLEVEL_DIRECTORY}/${CPACK_PACKAGE_FILE_NAME}/src/version.h.in
-    ${CPACK_TOPLEVEL_DIRECTORY}/${CPACK_PACKAGE_FILE_NAME}/src/version.h.in
-    @ONLY)
-set(GIT_BRANCH ${CPACK_DEBIAN_GIT_BRANCH})
-set(GIT_DESCRIBE ${CPACK_DEBIAN_GIT_DESCRIBE})
-set(GIT_COMMIT_DATE ${CPACK_DEBIAN_GIT_COMMIT_DATE})
-set(GIT_COMMIT_YEAR ${CPACK_DEBIAN_GIT_COMMIT_YEAR})
-set(GIT_COMMIT_COUNT ${CPACK_DEBIAN_GIT_COMMIT_COUNT})
-set(GIT_DIRTY ${CPACK_DEBIAN_GIT_DIRTY})
+# Save Git info from original working tree to allow building without git
+# uses GIT_BRANCH GIT_DESCRIBE GIT_COMMIT_DATE GIT_COMMIT_YEAR GIT_COMMIT_COUNT GIT_DIRTY
 configure_file(
     ${CPACK_TOPLEVEL_DIRECTORY}/${CPACK_PACKAGE_FILE_NAME}/src/gitinfo.h.in
     ${CPACK_TOPLEVEL_DIRECTORY}/${CPACK_PACKAGE_FILE_NAME}/src/gitinfo.h.in

src/dialog/dlgaboutdlg.ui

@@ -91,7 +91,7 @@
         <item row="1" column="0">
          <widget class="QLabel" name="label_2">
           <property name="text">
-           <string>Git Commit Date:</string>
+           <string>Date:</string>
           </property>
          </widget>
         </item>
@@ -136,6 +136,9 @@
           <property name="text">
            <string>Unknown</string>
           </property>
+          <property name="textInteractionFlags">
+           <set>Qt::TextSelectableByKeyboard|Qt::TextSelectableByMouse</set>
+          </property>
          </widget>
         </item>
        </layout>

src/gitinfo.h.in

@@ -4,8 +4,8 @@
 // files that include this will be recompile very often. Therefore, this should
 // only be included from versionstore.cpp.
 
-#ifndef VERSION_STORE
-    #error "Include only from versionstore.cpp and mixxx.rc.include to avoid unnecessary recompile on every commit."
+#ifndef GIT_INFO
+    #error "Include only from gitinfostore.cpp and mixxx.rc.include to avoid unnecessary recompile on every commit."
 #endif
 
 #define GIT_BRANCH "@GIT_BRANCH@"

src/mixxx.rc.include.template → src/mixxx.rc.include.in

@@ -1,4 +1,4 @@
-#define VERSION_STORE
+#define GIT_INFO
 #include "gitinfo.h"
 
 #ifdef GIT_COMMIT_YEAR

src/util/gitinfostore.cpp

@@ -0,0 +1,37 @@
+#include "util/gitinfostore.h"
+
+#define GIT_INFO
+#include "gitinfo.h"
+
+//static
+const char* GitInfoStore::branch() {
+    return GIT_BRANCH;
+};
+
+//static
+const char* GitInfoStore::describe() {
+    return GIT_DESCRIBE;
+};
+
+//static
+const char* GitInfoStore::date() {
+    return GIT_COMMIT_DATE;
+};
+
+//static
+int GitInfoStore::commitCount() {
+#ifdef GIT_COMMIT_COUNT
+    return GIT_COMMIT_COUNT;
+#else
+    return 0;
+#endif
+};
+
+//static
+bool GitInfoStore::dirty() {
+#ifdef GIT_DIRTY
+    return true;
+#else
+    return false;
+#endif
+};

src/util/gitinfostore.h

@@ -0,0 +1,10 @@
+#pragma once
+
+class GitInfoStore {
+  public:
+    static const char* branch();
+    static const char* describe();
+    static const char* date();
+    static int commitCount();
+    static bool dirty();
+};

src/util/versionstore.cpp

@@ -28,19 +28,15 @@
 #include <taglib/taglib.h>
 #include <vorbis/codec.h>
 
+#include "util/gitinfostore.h"
 #include "version.h"
-#define VERSION_STORE
-#include "gitinfo.h"
 
 namespace {
 
 const QVersionNumber kMixxxVersionNumber = QVersionNumber(
         MIXXX_VERSION_MAJOR, MIXXX_VERSION_MINOR, MIXXX_VERSION_PATCH);
 const QString kMixxxVersionSuffix = QString(MIXXX_VERSION_SUFFIX);
 const QString kMixxx = QStringLiteral("Mixxx");
-const QString kGitBranch = QString(GIT_BRANCH);
-const QString kGitDescribe = QString(GIT_DESCRIBE);
-const QDateTime kGitCommitDate = QDateTime::fromString(GIT_COMMIT_DATE, Qt::ISODate);
 const QString kBuildFlags = QString(MIXXX_BUILD_FLAGS);
 
 } // namespace
@@ -65,7 +61,7 @@ QString VersionStore::versionSuffix() {
 }
 
 QDateTime VersionStore::date() {
-    return kGitCommitDate;
+    return QDateTime::fromString(GitInfoStore::date(), Qt::ISODate);
 }
 
 // static
@@ -114,24 +110,24 @@ QString VersionStore::platform() {
 
 // static
 QString VersionStore::gitBranch() {
-    return kGitBranch;
+    return GitInfoStore::branch();
 }
 
 // static
 QString VersionStore::gitDescribe() {
-    return kGitDescribe;
+    return GitInfoStore::describe();
 }
 
 // static
 QString VersionStore::gitVersion() {
-    QString gitVersion = VersionStore::gitDescribe();
+    QString gitVersion = GitInfoStore::describe();
     if (gitVersion.isEmpty()) {
         gitVersion = QStringLiteral("unknown");
     }
 
     QString gitBranch = VersionStore::gitBranch();
-    if (!gitBranch.isEmpty()) {
-        gitVersion.append(QStringLiteral(" (") + gitBranch + QStringLiteral(" branch)"));
+    if (!gitBranch.isEmpty() && !gitVersion.startsWith(gitBranch)) {
+        gitVersion.append(QStringLiteral(" (") + gitBranch + QChar(')'));
     }
 
     return gitVersion;