src/test/regress/checkinc.py

#!/usr/bin/env python
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#

import sys, os, re, subprocess
try:
    import sysconfig
    multiarch_triplet = sysconfig.get_config_var('MULTIARCH')
except ImportError:
    try:
        import distutils.sysconfig
        multiarch_triplet = distutils.sysconfig.get_config_var('MULTIARCH')
    except ImportError:
        multiarch_triplet = ''

bindir = ''
if os.path.exists('../../bin/pg_config'):
    bindir = '../../bin/pg_config/'

p1 = subprocess.Popen(bindir + 'pg_config --includedir', stdout=subprocess.PIPE, shell=True)
p2 = subprocess.Popen(bindir + 'pg_config --pkgincludedir', stdout=subprocess.PIPE, shell=True)
inc    = p1.communicate()[0].strip();
pkginc = p2.communicate()[0].strip();

print "Greenplum INCLUDEDIR:    %s" % inc
print "Greenplum PKGINCLUDEDIR: %s" % pkginc
print "Checking includes..."

include = re.compile('\s*#include\s*["<](\S*)[">]')

# Hard code standard includes that are okay but we can't check via standard methods.
# Mostly port specific includes.
#
# This list should only contain system header files, or port-specific header files.
#
# Do NOT add anything from include/cdb/ to this list, as that would defeat the purpose
# of this script.
fileset = {
    'abi_mutex.h':       [],
    'alpha/builtins.h':  [],
    'crtdefs.h':         [],
    'cygwin/version.h':  [],
    'curl/curl.h':       [],
    'direct.h':          [],
    'err.h':             [],
    'float.h':           [],
    'getopt.h':          [],
    'gssapi.h':	       	 [],
    'gssapi/gssapi.h':	 [],
    'ia64/sys/inline.h': [],
    'io.h':              [],
    'ioctl.h':           [],
    'intrin.h':          [],
    'kernel/OS.h':       [],
    'kernel/image.h':    [],
    'libintl.h':         [],
    'libc.h':            [],
    'mutex.h':           [],
    'ntsecapi.h':        [],
    'openssl/ssl.h':     [],
    'openssl/err.h':     [],
    'pipe.h':            [],
    'process.h':         [],
    'pthread-win32.h':   [],
    'security.h':      	 [],
    'solaris.h':         [],
    'SupportDefs.h':     [],
    'ssl.h':             [],
    'stdarg.h':          [],
    'stddef.h':          [],
    'stdint.h':          [],
    'sys/isa_defs.h':    [],
    'sys/machine.h':     [],
    'sys/sdt.h':         [],
    'sys/utime.h':       [],
    'sys/atomic_op.h':   [],
    'sys/tas.h':         [],
    'unix.h':            [],
    'windows.h':         [],
    'winsock.h':         [],
    'winsock2.h':        [],
    'ws2tcpip.h':        [],
    'hdfs/hdfs.h': 	 [],
    'quicklz1.h':	 [],
    'quicklz3.h':	 [],
    'json-c/json.h':     [],
    'emmintrin.h':       [],
    'cdb/cdbhash.h':     [],
    'cdb/cdbgang.h':     [],
}


# Find all the files in the shipped include directories
inc_dirs = [os.path.join(pkginc, 'server'), os.path.join(pkginc, 'internal')]
for inc_dir in inc_dirs:
    for (root, dirs, files) in os.walk(inc_dir, topdown=False):
        # For every file make a list of #includes
        for f in files:
            froot = os.path.join(root,f)
            fname = froot.replace(inc_dir+'/','')
            file = open(froot, 'r')
            fileset[fname] = []
            for line in file:
                m = include.match(line)
                if m:
                    fileset[fname].append(m.group(1))


# For all files, check to see if the list of includes is in the list
missing = False
keys = fileset.keys()
keys.sort()
for f in keys:
    for i in filter(lambda(x): None == fileset.get(x), fileset[f]):
        # There are a couple reasons an included file might not be listed:

        # 1. It might be a standard include
        if os.path.exists(os.path.join(inc,i)):
            continue

        # 2.1 It might be a generic system include
        if os.path.exists(os.path.join('/usr/include',i)):
            continue

        # 2.2 It might be a multiarch system include
        if multiarch_triplet and \
          os.path.exists(os.path.join('/usr/include',multiarch_triplet,i)):
            continue

        # 3. It might not have been well qualified
        (d,s) = os.path.split(f)
        if fileset.get(os.path.join(d,i)):
            continue

        # But if it's not one of those then it's probably a file that we have
        # omitted
        missing = True
        print '  %-30s includes missing file "%s" ' % (f, i)

if missing:
    print "Include files... FAILED"
    sys.exit(1)
else:
    print "Include files are ok" 
    sys.exit(0)