Teach (build) scripts about git versioning

 - Insert various info into .VERSION file when
   `git archive` is performed.
   - Latest tag
   - Commit that archive/tag is based on
   - Author, date, signature info for that commit
 - Teach top level CMakeLists.txt how to:
   - Deal with the `git archive` modified version
     of .VERSION
   - Check if src dir is a git repo
   - Extract version info from `git describe`
   - Fall back on manually entered version string
     in .VERSION when it can't be extracted from
     git
 - Embed detailed version info in caf and cafrun
   that was extracted by git
 - Ensure install.sh and other build scripts will
   fetch the `git archive` created version info,
   or fall back onto manually entered version in .VERSION

Author: zbeekman

.VERSION

@@ -1,5 +1,13 @@
-# OpenCoarrays version file. Odd patch levels indicate inter-release
-# version, i.e., code is from SCM/git. This project uses semantic
-# versioning. For details see http://semver.org
-
+$Format:%d%n%n$
+# Fall back version, probably last release:
 1.8.11
+
+# OpenCoarrays version file. This project uses semantic
+# versioning. For details see http://semver.org
+#
+# Release archive created from commit:
+# $Format:%H %d$
+# $Format:Created on %ci by %cN, and$
+# $Format:signed by %GS using %GK.$
+# $Format:Signature status: %G?$
+$Format:%GG$

.gitattributes

@@ -31,4 +31,7 @@ prerequisites/build text
 developer-scripts export-ignore
 codecov.yml export-ignore
 *.enc export-ignore
-.github
+.github export-ignore
+
+# Perform substitutions when `git export`ing these files
+.VERSION export-subst

.travis.yml

@@ -204,7 +204,7 @@ after_script:
   - |
     set -o errexit
     if [[ "${TRAVIS_TAG}" ]]; then
-      if [[ "v${TRAVIS_TAG}" != "v$(sed -n 's/\([0-9]\{1,\}\(\.[0-9]\{1,\}\)\{1,\}\)/\1/p' .VERSION)" ]]; then
+      if [[ "v${TRAVIS_TAG}" != "v$(sed -n '/[0-9]\{1,\}\(\.[0-9]\{1,\}\)\{1,\}/{s/^\([^.]*\)\([0-9]\{1,\}\(\.[0-9]\{1,\}\)\{1,\}\)\(.*\)/\2/p;q;}' .VERSION)" ]]; then
         echo "ERROR: You are trying to tag a new release but have a version missmatch in \`.VERSION\`"
         false # throw an error
       fi

CMakeLists.txt

@@ -9,6 +9,7 @@ set_property ( CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS ${CMAKE_CONFIGURATION_TYP
 # Add option and check environment to determine if developer tests should be run
 if($ENV{OPENCOARRAYS_DEVELOPER})
   option(CAF_RUN_DEVELOPER_TESTS "Run tests intended only for developers" ON)
+  message( STATUS "OpenCoarrays developer tests turned on")
 else()
   option(CAF_RUN_DEVELOPER_TESTS "Run tests intended only for developers" OFF)
 endif()
@@ -20,9 +21,47 @@ endif()
 
 # Name project and specify source languages
 # Parse version from .VERSION file so that more info can be added and easier to get from scripts
-file( STRINGS ".VERSION" OpenCoarraysVersion
+file(STRINGS ".VERSION" first_line
+  LIMIT_COUNT 1
+  )
+
+string(REGEX MATCH "[0-9]+\\.[0-9]+\\.[0-9]+"
+  OpenCoarraysVersion "${first_line}")
+
+if((NOT (OpenCoarraysVersion MATCHES "[0-9]+\\.[0-9]+\\.[0-9]+")) AND (EXISTS "${CMAKE_SOURCE_DIR}/.git"))
+  message( STATUS "Build from git repository detected")
+  find_package(Git)
+  if(GIT_FOUND)
+    execute_process(COMMAND "${GIT_EXECUTABLE}" describe --abbrev=0
+      WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
+      RESULT_VARIABLE git_status
+      OUTPUT_VARIABLE git_output
+      OUTPUT_STRIP_TRAILING_WHITESPACE)
+    if((git_status STREQUAL "0") AND (git_output MATCHES "[0-9]+\\.[0-9]+\\.[0-9]+"))
+      set(OpenCoarraysVersion "${git_output}")
+      execute_process(COMMAND "${GIT_EXECUTABLE}" describe --always --dirty
+      WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
+      RESULT_VARIABLE git_status
+      OUTPUT_VARIABLE full_git_describe
+      OUTPUT_STRIP_TRAILING_WHITESPACE)
+    endif()
+  else()
+    message( WARNING "Could not find git executable!")
+  endif()
+endif()
+
+if(NOT (OpenCoarraysVersion MATCHES "[0-9]+\\.[0-9]+\\.[0-9]+"))
+  message( WARNING "Could not extract version from git, falling back on .VERSION, line 3.")
+  file(STRINGS ".VERSION" OpenCoarraysVersion
   REGEX "[0-9]+\\.[0-9]+\\.[0-9]+"
-)
+  )
+endif()
+
+if(NOT full_git_describe)
+  set(full_git_describe ${OpenCoarraysVersion})
+  message( STATUS "Full `git describe`: ${full_git_describe}")
+endif()
+
 project(opencoarrays VERSION "${OpenCoarraysVersion}" LANGUAGES C Fortran)
 message( STATUS "Building OpenCoarrays version: ${OpenCoarraysVersion}" )
 

install.sh

@@ -240,8 +240,11 @@ source $opencoarrays_src_dir/prerequisites/install-functions/report_results.sh
 
 if [[ "${arg_v}" == "${__flag_present}" || "${arg_V}" == "opencoarrays" ]]; then
 
-  # Print script copyright if invoked with -v, -V, or --version argument
-  opencoarrays_version=$(sed -n 's/\([0-9]\{1,\}\(\.[0-9]\{1,\}\)\{1,\}\)/\1/p' "${opencoarrays_src_dir%/}/.VERSION")
+  # Print script copyright & version if invoked with -v, -V, or
+  # --version argument git attributes handle .VERSION, making it more
+  # robust, but fallback version is still manually included. Search
+  # for the first version string we encounter and extract it using sed:
+  opencoarrays_version=$(sed -n '/[0-9]\{1,\}\(\.[0-9]\{1,\}\)\{1,\}/{s/^\([^.]*\)\([0-9]\{1,\}\(\.[0-9]\{1,\}\)\{1,\}\)\(.*\)/\2/p;q;}' "${opencoarrays_src_dir%/}/.VERSION")
   if [[ "${arg_v}" == "${__flag_present}" ]]; then
     echo "OpenCoarrays ${opencoarrays_version}"
     echo ""

prerequisites/check_version.sh

@@ -81,8 +81,11 @@ elif [[ $1 == '--list' || $1 == '-l' ]]; then
  exit 40
 
 elif [[ $1 == '-v' || $1 == '-V' || $1 == '--version' ]]; then
-  # Print script copyright if invoked with -v, -V, or --version argument
-  opencoarrays_version=$(sed -n 's/\([0-9]\{1,\}\(\.[0-9]\{1,\}\)\{1,\}\)/\1/p' ../.VERSION)
+  # Print script copyright if invoked with -v, -V, or --version
+  # argument Extract version from .VERSION file. Git automatically
+  # inserts various things when performing git archive, so ensure we
+  # extract just the first version string
+  opencoarrays_version=$(sed -n '/[0-9]\{1,\}\(\.[0-9]\{1,\}\)\{1,\}/{s/^\([^.]*\)\([0-9]\{1,\}\(\.[0-9]\{1,\}\)\{1,\}\)\(.*\)/\2/p;q;}' ../.VERSION)
   echo "opencoarrays $opencoarrays_version"
   echo ""
   echo "OpenCoarrays prerequisite version verifier"

src/mpi/CMakeLists.txt

@@ -144,7 +144,7 @@ file(READ ${CMAKE_CURRENT_SOURCE_DIR}/../extensions/caf-head CAF_HEADER)
 file(WRITE  "${compiler_wrapper}" "${CAF_HEADER}\n")
 file(APPEND "${compiler_wrapper}"  "caf_mod_dir=\"${CMAKE_INSTALL_FULL_INCLUDEDIR}/mod\"\n")
 file(APPEND "${compiler_wrapper}"  "caf_lib_dir=\"${CMAKE_INSTALL_FULL_LIBDIR}\"\n")
-file(APPEND "${compiler_wrapper}"  "caf_version=${PROJECT_VERSION}\n")
+file(APPEND "${compiler_wrapper}"  "caf_version=${full_git_describe}\n")
 if(gfortran_compiler)
   file(APPEND "${compiler_wrapper}"  "link_args='-fcoarray=lib -lcaf_mpi'\n")
 elseif(portland_group_compiler)
@@ -175,7 +175,7 @@ install(
 )
 file(READ ${CMAKE_CURRENT_SOURCE_DIR}/../extensions/cafrun-head CAFRUN_HEADER)
 file(WRITE  "${caf_launcher}" "${CAFRUN_HEADER}\n")
-file(APPEND "${caf_launcher}"  "caf_version=${PROJECT_VERSION}\n")
+file(APPEND "${caf_launcher}"  "caf_version=${full_git_describe}\n")
 file(APPEND "${caf_launcher}"  "CAFRUN=${MPIEXEC}\n")
 
 file(READ ${CMAKE_CURRENT_SOURCE_DIR}/../extensions/cafrun-foot FOOTER)