From 4ac7295632faa6283d247832fe1979816742af48 Mon Sep 17 00:00:00 2001 From: Michal Fratczak Date: Sat, 5 Jan 2019 20:19:49 +0100 Subject: [PATCH] websocketServer: Print git repo version on start. --- code/CMake/GetGitRevisionDescription.cmake | 170 ++++++++++++++++++ code/CMake/GetGitRevisionDescription.cmake.in | 43 +++++ code/common/git_repo_sha1.cpp.in | 2 + code/common/git_repo_sha1.h | 1 + code/websocketServer/CMakeLists.txt | 8 +- code/websocketServer/main.cpp | 3 + 6 files changed, 226 insertions(+), 1 deletion(-) create mode 100644 code/CMake/GetGitRevisionDescription.cmake create mode 100644 code/CMake/GetGitRevisionDescription.cmake.in create mode 100644 code/common/git_repo_sha1.cpp.in create mode 100644 code/common/git_repo_sha1.h diff --git a/code/CMake/GetGitRevisionDescription.cmake b/code/CMake/GetGitRevisionDescription.cmake new file mode 100644 index 0000000..d678ee1 --- /dev/null +++ b/code/CMake/GetGitRevisionDescription.cmake @@ -0,0 +1,170 @@ +# https://github.com/rpavlik/cmake-modules + +# - Returns a version string from Git +# +# These functions force a re-configure on each git commit so that you can +# trust the values of the variables in your build system. +# +# get_git_head_revision( [ ...]) +# +# Returns the refspec and sha hash of the current head revision +# +# git_describe( [ ...]) +# +# Returns the results of git describe on the source tree, and adjusting +# the output so that it tests false if an error occurs. +# +# git_get_exact_tag( [ ...]) +# +# Returns the results of git describe --exact-match on the source tree, +# and adjusting the output so that it tests false if there was no exact +# matching tag. +# +# git_local_changes() +# +# Returns either "CLEAN" or "DIRTY" with respect to uncommitted changes. +# Uses the return code of "git diff-index --quiet HEAD --". +# Does not regard untracked files. +# +# Requires CMake 2.6 or newer (uses the 'function' command) +# +# Original Author: +# 2009-2010 Ryan Pavlik +# http://academic.cleardefinition.com +# Iowa State University HCI Graduate Program/VRAC +# +# Copyright Iowa State University 2009-2010. +# Distributed under the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http://www.boost.org/LICENSE_1_0.txt) + +if(__get_git_revision_description) + return() +endif() +set(__get_git_revision_description YES) + +# We must run the following at "include" time, not at function call time, +# to find the path to this module rather than the path to a calling list file +get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH) + +function(get_git_head_revision _refspecvar _hashvar) + set(GIT_PARENT_DIR "${CMAKE_CURRENT_SOURCE_DIR}") + set(GIT_DIR "${GIT_PARENT_DIR}/.git") + while(NOT EXISTS "${GIT_DIR}") # .git dir not found, search parent directories + set(GIT_PREVIOUS_PARENT "${GIT_PARENT_DIR}") + get_filename_component(GIT_PARENT_DIR ${GIT_PARENT_DIR} PATH) + if(GIT_PARENT_DIR STREQUAL GIT_PREVIOUS_PARENT) + # We have reached the root directory, we are not in git + set(${_refspecvar} "GITDIR-NOTFOUND" PARENT_SCOPE) + set(${_hashvar} "GITDIR-NOTFOUND" PARENT_SCOPE) + return() + endif() + set(GIT_DIR "${GIT_PARENT_DIR}/.git") + endwhile() + # check if this is a submodule + if(NOT IS_DIRECTORY ${GIT_DIR}) + file(READ ${GIT_DIR} submodule) + string(REGEX REPLACE "gitdir: (.*)\n$" "\\1" GIT_DIR_RELATIVE ${submodule}) + get_filename_component(SUBMODULE_DIR ${GIT_DIR} PATH) + get_filename_component(GIT_DIR ${SUBMODULE_DIR}/${GIT_DIR_RELATIVE} ABSOLUTE) + endif() + set(GIT_DATA "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/git-data") + if(NOT EXISTS "${GIT_DATA}") + file(MAKE_DIRECTORY "${GIT_DATA}") + endif() + + if(NOT EXISTS "${GIT_DIR}/HEAD") + return() + endif() + set(HEAD_FILE "${GIT_DATA}/HEAD") + configure_file("${GIT_DIR}/HEAD" "${HEAD_FILE}" COPYONLY) + + configure_file("${_gitdescmoddir}/GetGitRevisionDescription.cmake.in" + "${GIT_DATA}/grabRef.cmake" + @ONLY) + include("${GIT_DATA}/grabRef.cmake") + + set(${_refspecvar} "${HEAD_REF}" PARENT_SCOPE) + set(${_hashvar} "${HEAD_HASH}" PARENT_SCOPE) +endfunction() + +function(git_describe _var) + if(NOT GIT_FOUND) + find_package(Git QUIET) + endif() + get_git_head_revision(refspec hash) + if(NOT GIT_FOUND) + set(${_var} "GIT-NOTFOUND" PARENT_SCOPE) + return() + endif() + if(NOT hash) + set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE) + return() + endif() + + # TODO sanitize + #if((${ARGN}" MATCHES "&&") OR + # (ARGN MATCHES "||") OR + # (ARGN MATCHES "\\;")) + # message("Please report the following error to the project!") + # message(FATAL_ERROR "Looks like someone's doing something nefarious with git_describe! Passed arguments ${ARGN}") + #endif() + + #message(STATUS "Arguments to execute_process: ${ARGN}") + + execute_process(COMMAND + "${GIT_EXECUTABLE}" + describe + ${hash} + ${ARGN} + WORKING_DIRECTORY + "${CMAKE_CURRENT_SOURCE_DIR}" + RESULT_VARIABLE + res + OUTPUT_VARIABLE + out + ERROR_QUIET + OUTPUT_STRIP_TRAILING_WHITESPACE) + if(NOT res EQUAL 0) + set(out "${out}-${res}-NOTFOUND") + endif() + + set(${_var} "${out}" PARENT_SCOPE) +endfunction() + +function(git_get_exact_tag _var) + git_describe(out --exact-match ${ARGN}) + set(${_var} "${out}" PARENT_SCOPE) +endfunction() + +function(git_local_changes _var) + if(NOT GIT_FOUND) + find_package(Git QUIET) + endif() + get_git_head_revision(refspec hash) + if(NOT GIT_FOUND) + set(${_var} "GIT-NOTFOUND" PARENT_SCOPE) + return() + endif() + if(NOT hash) + set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE) + return() + endif() + + execute_process(COMMAND + "${GIT_EXECUTABLE}" + diff-index --quiet HEAD -- + WORKING_DIRECTORY + "${CMAKE_CURRENT_SOURCE_DIR}" + RESULT_VARIABLE + res + OUTPUT_VARIABLE + out + ERROR_QUIET + OUTPUT_STRIP_TRAILING_WHITESPACE) + if(res EQUAL 0) + set(${_var} "CLEAN" PARENT_SCOPE) + else() + set(${_var} "DIRTY" PARENT_SCOPE) + endif() +endfunction() diff --git a/code/CMake/GetGitRevisionDescription.cmake.in b/code/CMake/GetGitRevisionDescription.cmake.in new file mode 100644 index 0000000..0d0ba7c --- /dev/null +++ b/code/CMake/GetGitRevisionDescription.cmake.in @@ -0,0 +1,43 @@ +# https://github.com/rpavlik/cmake-modules + +# +# Internal file for GetGitRevisionDescription.cmake +# +# Requires CMake 2.6 or newer (uses the 'function' command) +# +# Original Author: +# 2009-2010 Ryan Pavlik +# http://academic.cleardefinition.com +# Iowa State University HCI Graduate Program/VRAC +# +# Copyright Iowa State University 2009-2010. +# Distributed under the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http://www.boost.org/LICENSE_1_0.txt) + +set(HEAD_HASH) + +file(READ "@HEAD_FILE@" HEAD_CONTENTS LIMIT 1024) + +string(STRIP "${HEAD_CONTENTS}" HEAD_CONTENTS) +if(HEAD_CONTENTS MATCHES "ref") + # named branch + string(REPLACE "ref: " "" HEAD_REF "${HEAD_CONTENTS}") + if(EXISTS "@GIT_DIR@/${HEAD_REF}") + configure_file("@GIT_DIR@/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY) + else() + configure_file("@GIT_DIR@/packed-refs" "@GIT_DATA@/packed-refs" COPYONLY) + file(READ "@GIT_DATA@/packed-refs" PACKED_REFS) + if(${PACKED_REFS} MATCHES "([0-9a-z]*) ${HEAD_REF}") + set(HEAD_HASH "${CMAKE_MATCH_1}") + endif() + endif() +else() + # detached HEAD + configure_file("@GIT_DIR@/HEAD" "@GIT_DATA@/head-ref" COPYONLY) +endif() + +if(NOT HEAD_HASH) + file(READ "@GIT_DATA@/head-ref" HEAD_HASH LIMIT 1024) + string(STRIP "${HEAD_HASH}" HEAD_HASH) +endif() diff --git a/code/common/git_repo_sha1.cpp.in b/code/common/git_repo_sha1.cpp.in new file mode 100644 index 0000000..a1ac6ea --- /dev/null +++ b/code/common/git_repo_sha1.cpp.in @@ -0,0 +1,2 @@ +#define GIT_SHA1 "@GIT_SHA1@" +char g_GIT_SHA1[] = GIT_SHA1; \ No newline at end of file diff --git a/code/common/git_repo_sha1.h b/code/common/git_repo_sha1.h new file mode 100644 index 0000000..7004b4b --- /dev/null +++ b/code/common/git_repo_sha1.h @@ -0,0 +1 @@ +extern char g_GIT_SHA1[]; \ No newline at end of file diff --git a/code/websocketServer/CMakeLists.txt b/code/websocketServer/CMakeLists.txt index 79527eb..ce744c2 100755 --- a/code/websocketServer/CMakeLists.txt +++ b/code/websocketServer/CMakeLists.txt @@ -1,4 +1,7 @@ +list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/CMake/") +include(GetGitRevisionDescription) +get_git_head_revision(GIT_REFSPEC GIT_SHA1) include_directories( ${PROJECT_SOURCE_DIR} ) include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ) @@ -39,7 +42,6 @@ if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") set (PlatformSpecificLinking "pthread") endif() - set ( websocketServer_src program_options.h program_options.cpp server.h server.cpp @@ -49,6 +51,10 @@ set ( websocketServer_src main.cpp ) +# compile in git repo version +configure_file("${PROJECT_SOURCE_DIR}/common/git_repo_sha1.cpp.in" "${CMAKE_CURRENT_BINARY_DIR}/git_repo_sha1.cpp" @ONLY) +list(APPEND websocketServer_src "${CMAKE_CURRENT_BINARY_DIR}/git_repo_sha1.cpp" ${PROJECT_SOURCE_DIR}/common/git_repo_sha1.h) + add_executable ( habdecWebsocketServer ${websocketServer_src} ) target_link_libraries( habdecWebsocketServer Decoder diff --git a/code/websocketServer/main.cpp b/code/websocketServer/main.cpp index f5d8bb6..2cfdae0 100755 --- a/code/websocketServer/main.cpp +++ b/code/websocketServer/main.cpp @@ -36,6 +36,7 @@ #include "habitat/habitat_interface.h" #include "GLOBALS.h" #include "server.h" +#include "common/git_repo_sha1.h" bool G_DO_EXIT = false; @@ -309,6 +310,8 @@ int main(int argc, char** argv) // setup GLOBALS prog_opts(argc, argv); + cout<<"habdec websocketServer git repo version: "<