From 4ecfc39e1e94581001a66f3280d58ae9e29d0acf Mon Sep 17 00:00:00 2001
From: "Adam J. Stewart" <ajstewart426@gmail.com>
Date: Thu, 23 Mar 2017 14:35:11 -0500
Subject: [PATCH] Add Expect package (#3517)

* Add Expect package

* Ignore patches during flake8 tests for package.py files

* Remove controversial changes
---
 lib/spack/spack/cmd/flake8.py                 |  3 +-
 ...cl_private_header_os_x_mountain_lion.patch | 23 ++++++
 .../repos/builtin/packages/expect/package.py  | 79 +++++++++++++++++++
 .../repos/builtin/packages/tcl/package.py     |  7 ++
 .../repos/builtin/packages/tk/package.py      |  6 +-
 5 files changed, 113 insertions(+), 5 deletions(-)
 create mode 100644 var/spack/repos/builtin/packages/expect/expect_detect_tcl_private_header_os_x_mountain_lion.patch
 create mode 100644 var/spack/repos/builtin/packages/expect/package.py

diff --git a/lib/spack/spack/cmd/flake8.py b/lib/spack/spack/cmd/flake8.py
index 5ee68a80df..d5ed9adf18 100644
--- a/lib/spack/spack/cmd/flake8.py
+++ b/lib/spack/spack/cmd/flake8.py
@@ -59,7 +59,8 @@
               r'^\s*version\(.*\)',
               r'^\s*variant\(.*\)',
               r'^\s*depends_on\(.*\)',
-              r'^\s*extends\(.*\)'],
+              r'^\s*extends\(.*\)',
+              r'^\s*patch\(.*\)'],
         # Exempt '@when' decorated functions from redefinition errors.
         811: [r'^\s*\@when\(.*\)'],
     },
diff --git a/var/spack/repos/builtin/packages/expect/expect_detect_tcl_private_header_os_x_mountain_lion.patch b/var/spack/repos/builtin/packages/expect/expect_detect_tcl_private_header_os_x_mountain_lion.patch
new file mode 100644
index 0000000000..31720eb743
--- /dev/null
+++ b/var/spack/repos/builtin/packages/expect/expect_detect_tcl_private_header_os_x_mountain_lion.patch
@@ -0,0 +1,23 @@
+Fix Tcl private header detection on macOS
+
+https://sourceforge.net/p/expect/patches/17/
+
+diff -Naur expect5.45.orig/tclconfig/tcl.m4 expect5.45/tclconfig/tcl.m4
+--- expect5.45.orig/tclconfig/tcl.m4	2010-11-09 11:42:10.000000000 -0800
++++ expect5.45/tclconfig/tcl.m4	2013-09-23 00:10:00.000000000 -0700
+@@ -3389,9 +3389,12 @@
+             # the framework's Headers and PrivateHeaders directories
+             case ${TCL_DEFS} in
+ 	    	*TCL_FRAMEWORK*)
+-		    if test -d "${TCL_BIN_DIR}/Headers" -a \
+-			    -d "${TCL_BIN_DIR}/PrivateHeaders"; then
+-			TCL_INCLUDES="-I\"${TCL_BIN_DIR}/Headers\" -I\"${TCL_BIN_DIR}/PrivateHeaders\" ${TCL_INCLUDES}"
++		    if test -d "${TCL_BIN_DIR}/Headers"; then
++			if test -d "${TCL_BIN_DIR}/PrivateHeaders"; then
++			    TCL_INCLUDES="-I\"${TCL_BIN_DIR}/Headers\" -I\"${TCL_BIN_DIR}/PrivateHeaders\" ${TCL_INCLUDES}"
++			elif test -d "${TCL_BIN_DIR}/Headers/tcl-private"; then
++			    TCL_INCLUDES="-I\"${TCL_BIN_DIR}/Headers\" -I\"${TCL_BIN_DIR}/Headers/tcl-private\" ${TCL_INCLUDES}"
++			fi
+ 		    else
+ 			TCL_INCLUDES="${TCL_INCLUDES} ${TCL_INCLUDE_SPEC} `echo "${TCL_INCLUDE_SPEC}" | sed -e 's/Headers/PrivateHeaders/'`"
+ 		    fi
diff --git a/var/spack/repos/builtin/packages/expect/package.py b/var/spack/repos/builtin/packages/expect/package.py
new file mode 100644
index 0000000000..a8ea99a8ae
--- /dev/null
+++ b/var/spack/repos/builtin/packages/expect/package.py
@@ -0,0 +1,79 @@
+##############################################################################
+# Copyright (c) 2013-2016, Lawrence Livermore National Security, LLC.
+# Produced at the Lawrence Livermore National Laboratory.
+#
+# This file is part of Spack.
+# Created by Todd Gamblin, tgamblin@llnl.gov, All rights reserved.
+# LLNL-CODE-647188
+#
+# For details, see https://github.com/llnl/spack
+# Please also see the LICENSE file for our notice and the LGPL.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License (as
+# published by the Free Software Foundation) version 2.1, February 1999.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY OF
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the terms and
+# conditions of the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+##############################################################################
+from spack import *
+import glob
+import os
+
+
+class Expect(AutotoolsPackage):
+    """Expect is a tool for automating interactive applications such as
+    telnet, ftp, passwd, fsck, rlogin, tip, etc."""
+
+    homepage = "http://expect.sourceforge.net/"
+    url      = "https://sourceforge.net/projects/expect/files/Expect/5.45/expect5.45.tar.gz/download"
+
+    version('5.45', '44e1a4f4c877e9ddc5a542dfa7ecc92b')
+
+    depends_on('tcl')
+
+    depends_on('automake', type='build')
+    depends_on('autoconf', type='build')
+    depends_on('libtool',  type='build')
+    depends_on('m4',       type='build')
+
+    force_autoreconf = True
+
+    patch('expect_detect_tcl_private_header_os_x_mountain_lion.patch', when='@5.45')
+
+    def configure_args(self):
+        spec = self.spec
+
+        args = [
+            # Without this, expect binary and library are not installed
+            '--exec-prefix={0}'.format(self.prefix),
+            '--enable-threads',
+            '--enable-shared',
+            '--enable-64bit',
+            '--with-tcl={0}'.format(spec['tcl'].prefix.lib),
+            '--with-tclinclude={0}'.format(spec['tcl'].prefix.include),
+        ]
+
+        return args
+
+    @run_after('install')
+    def symlink_library(self):
+        """Expect installs libraries into:
+
+        lib/expect5.45/libexpect5.45.so
+
+        Create a symlink so that the library can be found in lib."""
+
+        target = join_path(self.prefix.lib, 'expect*', 'libexpect*')
+        target = glob.glob(target)[0]
+
+        link_name = os.path.basename(target)
+        link_name = join_path(self.prefix.lib, link_name)
+
+        symlink(target, link_name)
diff --git a/var/spack/repos/builtin/packages/tcl/package.py b/var/spack/repos/builtin/packages/tcl/package.py
index 22b300408a..79d4bc7544 100644
--- a/var/spack/repos/builtin/packages/tcl/package.py
+++ b/var/spack/repos/builtin/packages/tcl/package.py
@@ -55,6 +55,13 @@ def setup_environment(self, spack_env, run_env):
         run_env.set('TCL_LIBRARY', join_path(self.prefix.lib, 'tcl{0}'.format(
             self.spec.version.up_to(2))))
 
+    def install(self, spec, prefix):
+        with working_dir(self.build_directory):
+            make('install')
+
+            # Some applications like Expect require private Tcl headers.
+            make('install-private-headers')
+
     @run_after('install')
     def symlink_tclsh(self):
         with working_dir(self.prefix.bin):
diff --git a/var/spack/repos/builtin/packages/tk/package.py b/var/spack/repos/builtin/packages/tk/package.py
index 48fc32ebb9..4d9651315a 100644
--- a/var/spack/repos/builtin/packages/tk/package.py
+++ b/var/spack/repos/builtin/packages/tk/package.py
@@ -38,10 +38,8 @@ class Tk(AutotoolsPackage):
     version('8.6.5', '11dbbd425c3e0201f20d6a51482ce6c4')
     version('8.6.3', '85ca4dbf4dcc19777fd456f6ee5d0221')
 
-    variant('X', default=False, description='Enable X11 support')
-
-    depends_on("tcl")
-    depends_on("libx11", when='+X')
+    depends_on('tcl')
+    depends_on('libx11')
 
     configure_directory = 'unix'