Merge pull request #170 from sourceryinstitute/add-install-script-boilerplate

Boilerplate installation scripts & mv install_prerequisites

Author: Damian Rouson

.gitattributes

@@ -10,7 +10,7 @@
 *.md text
 *.txt text
 *.sh text
-install_prerequisites/build text
+prerequisites/build text
 *.cu text
 *.x64 text
 

.travis.yml

@@ -116,7 +116,7 @@ install:
     elif [[ "X$BUILD_TYPE" != "XInstallScript" ]]; then # Ubuntu on Travis-CI, NOT testing install.sh
       if ! ( [[ -x "$HOME/.local/bin/mpif90" ]] && [[ -x "$HOME/.local/bin/mpicc" ]] ); then
         # mpich install not cached
-        # could use install_prerequisites/build instead...
+        # could use prerequisites/build instead...
         wget "${MPICH_URL_HEAD}/${MPICH_URL_TAIL}"
         mv "$MPICH_URL_TAIL" "$MPICH_DIR/.."
         pushd "$MPICH_DIR/.."

CMakeLists.txt

@@ -105,7 +105,7 @@ endif()
 include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src)
 
 add_subdirectory(src)
-add_subdirectory(install_prerequisites)
+add_subdirectory(prerequisites)
 
 #-----------------------------------------------------
 # Publicize installed location to other CMake projects

INSTALL.md

@@ -203,7 +203,7 @@ the [Installation Script] section.  Or try building each prerequisite from sourc
 follows:
 
 ```
-cd install_prerequisites
+cd prerequisites
 CC=gcc FC=gfortran CXX=g++ ./build flex
 ./build gcc
 CC=gcc FC=gfortran CXX=g++ ./build mpich
@@ -235,7 +235,7 @@ where the second line builds the flex package that is required for building gcc
 [Issues]: https://github.com/sourceryinstitute/opencoarrays/issues
 [make.inc]: ./src/make.inc
 [opencoarrays]: ./src/extensions/opencoarrays.F90
-[install_prerequisites]: ./install_prerequisites
+[prerequisites]: ./prerequisites
 [MPICH]: http://www.mpich.org
 [MVAPICH]:http://mvapich.cse.ohio-state.edu
 [MacPorts]: http://www.macports.org

install.sh

@@ -91,7 +91,7 @@ if [[ "$directory_exists" == "false" ]]; then
 fi
 
 build_path=$opencoarrays_src_dir/opencoarrays-build
-build_script=$opencoarrays_src_dir/install_prerequisites/build
+build_script=$opencoarrays_src_dir/prerequisites/build
 if [[ ! -x "$build_script" ]]; then
   echo "$this_script: $build_script script does not exist or the user lacks executable permission for it."
   echo "$this_script: Please run this_script in the top-level OpenCoarrays source directory or set the"
@@ -124,7 +124,7 @@ usage()
 }
 
 # Include stack management functions
-. ./install_prerequisites/stack.sh
+. ./prerequisites/stack.sh
 stack_new dependency_pkg
 stack_new dependency_exe
 stack_new dependency_path
@@ -741,7 +741,7 @@ print_header()
   popd > /dev/null
   echo ""
   echo "*** All prerequisites will be downloaded to, built in, and installed in ***"
-  echo "$opencoarrays_src_dir/install_prerequisites"
+  echo "$opencoarrays_src_dir/prerequisites"
   printf "*** OpenCoarrays will be installed "
   if [[ "$install_path" == "$opencoarrays_src_dir/opencoarrays-installation" ]]; then
     printf "in the above location also.        ***\n"
@@ -922,7 +922,7 @@ elif [[ $1 == '-v' || $1 == '-V' || $1 == '--version' ]]; then
   echo ""
 else # Find or install prerequisites and install OpenCoarrays
 
-  cd install_prerequisites &&
+  cd prerequisites &&
   installation_record=install-opencoarrays.log &&
   . set_SUDO.sh &&
   set_SUDO_if_necessary  &&

install_prerequisites/CMakeLists.txt renamed to prerequisites/CMakeLists.txt

@@ -0,0 +1,49 @@
+# Make the build directory, configure, and build
+build_and_install()
+{
+  num_threads=${arg_j}
+  build_path="${OPENCOARRAYS_SRC_DIR}/prerequisites/builds/${package_to_build}-${version_to_build}"
+
+  info "Building ${package_to_build} ${version_to_build}" 
+  info "Build path: ${build_path}" 
+
+  set_SUDO_if_needed_to_write_to_directory "${build_path}"
+  set_SUDO_if_needed_to_write_to_directory "${install_path}"
+  mkdir -p "${build_path}"
+  info "pushd ${build_path}"
+  pushd "${build_path}"
+  if [[ "${package_to_build}" == "gcc" ]]; then
+    info 'pushd ${download_path}/${package_source_directory} '
+    pushd "${download_path}/${package_source_directory}"
+    "${PWD}"/contrib/download_prerequisites 
+    info "popd"
+    popd 
+    info "Configuring with the following command:"
+    info "${download_path}/${package_source_directory}/configure --prefix=${install_path} --enable-languages=c,c++,fortran,lto --disable-multilib --disable-werror" 
+    "${download_path}/${package_source_directory}/configure" --prefix="${install_path}" --enable-languages=c,c++,fortran,lto --disable-multilib --disable-werror
+    info "Building with the following command: 'make -j${num_threads} bootstrap'"
+    make "-j${num_threads}" bootstrap
+    if [[ ! -z "${SUDO:-}" ]]; then
+      info "You do not have write permissions to the installation path ${install_path}"
+      info "If you have administrative privileges, enter your password to install ${package_to_build}"
+    fi 
+    info "Installing with the following command: ${SUDO:-} make install"
+    ${SUDO:-} make install
+  else
+    info "Configuring ${package_to_build} ${version_to_build} with the following command:"
+    info "CC=\"${CC:-'gcc'}\" CXX=\"${CXX:-'g++'}\" \"${download_path}/${package_source_directory}\"/configure --prefix=\"${install_path}\""
+    CC="${CC:-'gcc'}" CXX="${CXX:-'g++'}" "${download_path}/${package_source_directory}"/configure --prefix="${install_path}"
+    info "Building with the following command:"
+    info "CC=\"${CC:-'gcc'}\" CXX=\"${CXX:-'g++'}\" make -j\"${num_threads}\""
+    CC="${CC:-'gcc'}" CXX="${CXX:-'g++'}" make "-j${num_threads}"
+    info "Installing ${package_to_build} in ${install_path}"
+    if [[ ! -z "${SUDO:-}" ]]; then
+      info "You do not have write permissions to the installation path ${install_path}"
+      info "If you have administrative privileges, enter your password to install ${package_to_build}"
+    fi
+    info "Installing with the following command: ${SUDO:-} make install" 
+    ${SUDO:-} make install
+  fi 
+  info "popd"
+  popd
+}

install_prerequisites/acceptable_compiler.f90 renamed to prerequisites/acceptable_compiler.f90

@@ -0,0 +1,80 @@
+source "${OPENCOARRAYS_SRC_DIR:-}/prerequisites/build-functions/ftp-url.sh"
+source "${OPENCOARRAYS_SRC_DIR:-}/prerequisites/build-functions/set_SUDO_if_needed_to_write_to_directory.sh"
+
+# Download pkg-config if the tar ball is not already in the present working directory
+download_if_necessary()
+{
+  download_path="${PWD}/downloads"
+  set_SUDO_if_needed_to_write_to_directory "${download_path}"
+  if [ -f $url_tail ] || [ -d $url_tail ]; then
+    info "Found '${url_tail}' in ${PWD}."
+    info "If it resulted from an incomplete download, building ${package_name} could fail."
+    info "Would you like to proceed anyway? (y/n)"
+    read proceed
+    if [[ "${proceed}" == "y"  ]]; then
+      info "y"
+    else
+      info "n"
+      info "Please remove $url_tail and restart the installation to to ensure a fresh download." 1>&2
+      emergency "Aborting. [exit 80]"
+    fi
+  elif ! type "${fetch}" &> /dev/null; then
+    # The download mechanism is missing
+    info "The default download mechanism for ${package_name} is ${fetch}."
+    info "Please either ensure that ${fetch} is installed and in your PATH"
+    info "or download the ${package_name} source from "
+    info "${package_url}" 
+   #called_by_install_sh=`echo "$(ps -p $PPID -o args=)" | grep install.sh`
+    info "Place the downloaded file in ${download_path} and restart this script."
+   #if [[ ! -z $called_by_install_sh ]]; then
+   #  caller="install.sh"
+   #else
+   #  caller="build"
+   #fi
+    emergency "Aborting [exit 90]"
+  else
+    # The download mechanism is in the path.
+    if [[ "${fetch}" == "svn" ]]; then
+      if [[ ${version_to_build} == '--avail' || ${version_to_build} == '-a' ]]; then
+        args="ls"
+      else
+        args="checkout"
+      fi
+    elif [[ "${fetch}" == "wget" ]]; then
+      args="--no-check-certificate"
+    elif [[ "${fetch}" == "ftp-url" ]]; then
+      args="-n"
+    elif [[ "${fetch}" == "git" ]]; then
+      args="clone"
+    fi
+    if [[ "${fetch}" == "svn" || "${fetch}" == "git" ]]; then
+      package_source_directory="${url_tail}"
+    else
+      package_source_directory="${package_name}-${version_to_build}"
+    fi
+    info "Downloading ${package_name} ${version_to_build} to the following location:"
+    info "${download_path}/${package_source_directory}"
+    info "Download command: ${fetch} ${args} ${package_url}"
+    info "Depending on the file size and network bandwidth, this could take several minutes or longer."
+    pushd "${download_path}"
+    "${fetch}" "${args}" "${package_url}" 
+    popd
+    if [[ "${version_to_build}" == '--avail' || "${version_to_build}" == '-a' ]]; then
+      # In this case, args="ls" and the list of available versions has been printed so we can move on.
+      exit 1
+    fi
+    if [[ "${fetch}" == "svn" ]]; then
+      search_path="${download_path}/${version_to_build}"
+    else
+      search_path="${download_path}/${url_tail}"
+    fi
+    if [ -f "${search_path}" ] || [ -d "${search_path}" ]; then
+      info "Download succeeded. The "${package_name}" source is in the following location:"
+      info "${search_path}"
+    else
+      info "Download failed. The "${package_name}" source is not in the following, expected location:"
+      info "${search_path}"
+      emergency "Aborting. [exit 110]"
+    fi
+  fi
+}