Merge pull request travitch#54 from SRI-CSL/master

Linting and a fix to the travis CI configuration.

Author: ianamason

.pylintrc

@@ -4,29 +4,35 @@ sudo: required
 dist: trusty
 
 python:
+  - "3.5"
+  - "3.4"
   - "3.3"
   - "2.7"
-  - "2.6"
 
 
 # command to install dependencies
 install:
   - sudo apt-get update
-  # to install wllvm
-  - sudo apt-get install -y python-pip
   # apache prerequisites
   - sudo apt-get install  -y libapr1-dev libaprutil1-dev
   # for the clang build  
   - sudo apt-get install  -y llvm-3.5 clang-3.5
   # dragonegg prereqs. dragonegg and llvm-gcc use llvm 3.3
   - sudo apt-get install  -y llvm-3.3 llvm-gcc-4.7
-  - sudo pip install -e .
-  - export WLLVM_HOME=`pwd`
-  - export APACHE_VER=2.4.18
+  # Install wllvm
+  # Report the version of pip being used for debugging purposes.
+  # It should report the site-packages directory and the version
+  # of python it is working with.
+  - pip --version
+  - pip install -e .
 
 
 # command to run tests
 script:
+  # Run unittests
+  - python -m unittest discover test/ || exit 1
+  - export WLLVM_HOME=`pwd`
+  - export APACHE_VER=2.4.18
   # build apache with clang
   - ${WLLVM_HOME}/.travis/apache_clang.sh
   # build apache with gcc and dragonegg

.travis.yml

@@ -7,6 +7,8 @@ export PATH=/usr/lib/llvm-3.5/bin:${PATH}
 export LLVM_COMPILER=clang
 export WLLVM_OUTPUT=WARNING
 
+wllvm-sanity-checker
+
 wget https://archive.apache.org/dist/httpd/httpd-${APACHE_VER}.tar.gz
 
 tar xfz httpd-${APACHE_VER}.tar.gz

.travis/apache_clang.sh

@@ -11,6 +11,8 @@ export LLVM_DRAGONEGG_PLUGIN=/usr/lib/gcc/x86_64-linux-gnu/4.7/plugin/dragonegg.
 
 export WLLVM_OUTPUT=WARNING
 
+wllvm-sanity-checker
+
 wget https://archive.apache.org/dist/httpd/httpd-${APACHE_VER}.tar.gz
 
 

.travis/apache_dragonegg.sh

@@ -27,7 +27,7 @@ all:
 
 
 #local editable install for developing
-develop: 
+develop:
 	pip install -e .
 
 
@@ -36,7 +36,7 @@ dist: clean
 
 # If you need to push this project again,
 # INCREASE the version number in wllvm/version.py,
-# otherwise the server will give you an error. 
+# otherwise the server will give you an error.
 
 testpublish: dist
 	python setup.py register -r https://testpypi.python.org/pypi
@@ -50,7 +50,7 @@ publish: dist
 	python setup.py sdist upload -r https://pypi.python.org/pypi
 
 install:
-	pip install 
+	pip install
 
 check_clang:
 	cd test; python -m unittest -v test_base_driver test_clang_driver
@@ -74,4 +74,6 @@ lint:
 ifeq ($(PYLINT),)
 	$(error lint target requires pylint)
 endif
-	@ $(PYLINT) -E wllvm/*.py
+#	@ $(PYLINT) -E wllvm/*.py
+# for detecting more than just errors:
+	@ $(PYLINT) --rcfile=.pylintrc wllvm/*.py

Makefile

@@ -13,10 +13,10 @@
 
 # use the in house version number so we stay in synch with ourselves.
 from wllvm.version import wllvm_version
-    
+
 setup(
     name='wllvm',
-    version=wllvm_version, 
+    version=wllvm_version,
     description='Whole Program LLVM',
     long_description=long_description,
     url='https://github.com/SRI-CSL/whole-program-llvm',
@@ -25,9 +25,9 @@
 
 
     include_package_data=True,
-    
+
     packages=find_packages(),
-    
+
     entry_points = {
         'console_scripts': [
             'wllvm-as = wllvm.as:main',
@@ -39,7 +39,7 @@
     },
 
     license='MIT',
-    
+
     classifiers=[
         'Development Status :: 4 - Beta',
         'Natural Language :: English',

img/dragon100x100.png

@@ -1 +0,0 @@
-

img/dragon256x256.png

@@ -1,4 +1,8 @@
-import logging, collections, os, re, sys
+import logging
+import collections
+import os
+import re
+import sys
 
 # Internal logger
 _logger = logging.getLogger(__name__)
@@ -123,8 +127,8 @@ def __init__(self, inputList, exactMatches={}, patternMatches={}):
             # Debug
             '-g' : (0, ArgumentListFilter.compileUnaryCallback),
             '-g0' : (0, ArgumentListFilter.compileUnaryCallback),     #iam: clang not gcc
-            '-ggdb' : (0, ArgumentListFilter.compileUnaryCallback), 
-            '-ggdb3' : (0, ArgumentListFilter.compileUnaryCallback), 
+            '-ggdb' : (0, ArgumentListFilter.compileUnaryCallback),
+            '-ggdb3' : (0, ArgumentListFilter.compileUnaryCallback),
             '-gdwarf-2' : (0, ArgumentListFilter.compileUnaryCallback),
             '-gdwarf-3' : (0, ArgumentListFilter.compileUnaryCallback),
             '-gline-tables-only' : (0, ArgumentListFilter.compileUnaryCallback),
@@ -185,7 +189,7 @@ def __init__(self, inputList, exactMatches={}, patternMatches={}):
             # (the Darwin ld is a bit single minded)
             #
             # 1) compilation with -fvisibility=hidden causes trouble when we try to
-            #    attach bitcode filenames to an object file. The global symbols in object 
+            #    attach bitcode filenames to an object file. The global symbols in object
             #    files get turned into local symbols when we invoke 'ld -r'
             #
             # 2) all stripping commands (e.g., -dead_strip) remove the __LLVM segment after
@@ -195,8 +199,8 @@ def __init__(self, inputList, exactMatches={}, patternMatches={}):
             # calling ld -r.
             #
             '-Wl,-dead_strip' :  (0, ArgumentListFilter.darwinWarningLinkUnaryCallback),
-            
-           }
+
+        }
 
         #
         # Patterns for other command-line arguments:
@@ -227,15 +231,15 @@ def __init__(self, inputList, exactMatches={}, patternMatches={}):
             r'^--sysroot=.+$' :  (0, ArgumentListFilter.compileUnaryCallback),
             r'^-print-prog-name=.*$' : (0, ArgumentListFilter.compileUnaryCallback),
             r'^-print-file-name=.*$' : (0, ArgumentListFilter.compileUnaryCallback),
-            
+
         }
 
         #iam: try and keep track of the files, input object, and output
         self.inputList = inputList
         self.inputFiles = []
         self.objectFiles = []
         self.outputFilename = None
-        
+
         #iam: try and split the args into linker and compiler switches
         self.compileArgs = []
         self.linkArgs = []
@@ -256,10 +260,10 @@ def __init__(self, inputList, exactMatches={}, patternMatches={}):
         self._inputArgs = collections.deque(inputList)
 
         #iam: parse the cmd line, bailing if we discover that there will be no second phase.
-        while ( len(self._inputArgs) > 0   and
-                not (self.isAssembly or
-                     self.isAssembleOnly or
-                     self.isPreprocessOnly  ) ):
+        while (len(self._inputArgs) > 0   and
+               not (self.isAssembly or
+                    self.isAssembleOnly or
+                    self.isPreprocessOnly)):
             # Get the next argument
             currentItem = self._inputArgs.popleft()
             _logger.debug('Trying to match item ' + currentItem)
@@ -281,7 +285,7 @@ def __init__(self, inputList, exactMatches={}, patternMatches={}):
                 # If no action has been specified, this is a zero-argument
                 # flag that we should just keep.
                 if not matched:
-                    _logger.warning('Did not recognize the compiler flag "{0}"'.format(currentItem))
+                    _logger.warning('Did not recognize the compiler flag "%s"', currentItem)
                     self.compileUnaryCallback(currentItem)
 
         if DUMPING:
@@ -296,69 +300,83 @@ def _shiftArgs(self, nargs):
         return ret
 
     def abortUnaryCallback(self, flag):
-        _logger.warning('Out of context experience: "{0}"'.format(str(self.inputList)))
+        _logger.warning('Out of context experience: "%s" "%s"', str(self.inputList), flag)
         sys.exit(1)
 
     def inputFileCallback(self, infile):
-        _logger.debug('Input file: ' + infile)
+        _logger.debug('Input file: %s', infile)
         self.inputFiles.append(infile)
         if re.search('\\.(s|S)$', infile):
             self.isAssembly = True
 
     def outputFileCallback(self, flag, filename):
+        _logger.debug('outputFileCallback: %s %s', flag, filename)
         self.outputFilename = filename
 
     def objectFileCallback(self, objfile):
+        _logger.debug('objectFileCallback: %s', objfile)
         self.objectFiles.append(objfile)
 
     def preprocessOnlyCallback(self, flag):
+        _logger.debug('preprocessOnlyCallback: %s', flag)
         self.isPreprocessOnly = True
 
     def dependencyOnlyCallback(self, flag):
+        _logger.debug('dependencyOnlyCallback: %s', flag)
         self.isDependencyOnly = True
         self.compileArgs.append(flag)
 
     def assembleOnlyCallback(self, flag):
+        _logger.debug('assembleOnlyCallback: %s', flag)
         self.isAssembleOnly = True
 
     def verboseFlagCallback(self, flag):
+        _logger.debug('verboseFlagCallback: %s', flag)
         self.isVerbose = True
 
     def compileOnlyCallback(self, flag):
+        _logger.debug('compileOnlyCallback: %s', flag)
         self.isCompileOnly = True
 
     def linkUnaryCallback(self, flag):
+        _logger.debug('linkUnaryCallback: %s', flag)
         self.linkArgs.append(flag)
 
     def compileUnaryCallback(self, flag):
+        _logger.debug('compileUnaryCallback: %s', flag)
         self.compileArgs.append(flag)
 
     def darwinWarningLinkUnaryCallback(self, flag):
+        _logger.debug('darwinWarningLinkUnaryCallback: %s', flag)
         if sys.platform.startswith('darwin'):
-            _logger.warning('The flag "{0}" cannot be used with this tool'.format(flag))
+            _logger.warning('The flag "%s" cannot be used with this tool', flag)
             sys.exit(1)
         else:
             self.linkArgs.append(flag)
 
     def defaultBinaryCallback(self, flag, arg):
-        _logger.warning('Ignoring compiler arg pair: "{0} {1}"'.format(flag, arg))
+        _logger.warning('Ignoring compiler arg pair: "%s %s"', flag, arg)
 
     def dependencyBinaryCallback(self, flag, arg):
+        _logger.debug('dependencyBinaryCallback: %s %s', flag, arg)
         self.isDependencyOnly = True
         self.compileArgs.append(flag)
         self.compileArgs.append(arg)
 
     def compileBinaryCallback(self, flag, arg):
+        _logger.debug('compileBinaryCallback: %s %s', flag, arg)
         self.compileArgs.append(flag)
         self.compileArgs.append(arg)
 
 
     def linkBinaryCallback(self, flag, arg):
+        _logger.debug('linkBinaryCallback: %s %s', flag, arg)
         self.linkArgs.append(flag)
         self.linkArgs.append(arg)
 
     #flags common to both linking and compiling (coverage for example)
     def compileLinkUnaryCallback(self, flag):
+        _logger.debug('compileLinkUnaryCallback: %s', flag)
         self.compileArgs.append(flag)
         self.linkArgs.append(flag)
 
@@ -367,8 +385,8 @@ def getOutputFilename(self):
             return self.outputFilename
         elif self.isCompileOnly:
             #iam: -c but no -o, therefore the obj should end up in the cwd.
-            (path, base) = os.path.split(self.inputFiles[0])
-            (root, ext) = os.path.splitext(base)
+            (_, base) = os.path.split(self.inputFiles[0])
+            (root, _) = os.path.splitext(base)
             return '{0}.o'.format(root)
         else:
             return 'a.out'
@@ -378,8 +396,8 @@ def getOutputFilename(self):
     # bitcodeFile is (starts with a '.'), use the logging level & DUMPING flag to get a sense
     # of what is being written out.
     def getArtifactNames(self, srcFile, hidden=False):
-        (srcpath, srcbase) = os.path.split(srcFile)
-        (srcroot, srcext) = os.path.splitext(srcbase)
+        (_, srcbase) = os.path.split(srcFile)
+        (srcroot, _) = os.path.splitext(srcbase)
         if hidden:
             objbase = '.{0}.o'.format(srcroot)
         else:
@@ -392,15 +410,11 @@ def getArtifactNames(self, srcFile, hidden=False):
 
     #iam: for printing our partitioning of the args
     def dump(self):
-        _logger.debug('compileArgs: {0}'.format(self.compileArgs))
-        _logger.debug('inputFiles: {0}'.format(self.inputFiles))
-        _logger.debug('linkArgs: {0}'.format(self.linkArgs))
-        _logger.debug('objectFiles: {0}'.format(self.objectFiles))
-        _logger.debug('outputFilename: {0}'.format(self.outputFilename))
+        _logger.debug('compileArgs: %s\ninputFiles: %s\nlinkArgs: %s',
+                      self.compileArgs, self.inputFiles, self.linkArgs)
+        _logger.debug('objectFiles: %s\noutputFilename: %s',
+                      self.objectFiles, self.outputFilename)
         for srcFile in self.inputFiles:
-            _logger.debug('srcFile: {0}'.format(srcFile))
+            _logger.debug('srcFile: %s', srcFile)
             (objFile, bcFile) = self.getArtifactNames(srcFile)
-            _logger.debug('{0} ===> ({1}, {2})'.format(srcFile, objFile, bcFile))
-
-
-
+            _logger.debug('%s ===> (%s, %s)', srcFile, objFile, bcFile)