Add scripts to check code for errors and style
diff --git a/TestON/bin/.pylint b/TestON/bin/.pylint
new file mode 100644
index 0000000..469a744
--- /dev/null
+++ b/TestON/bin/.pylint
@@ -0,0 +1,300 @@
+# lint Python modules using external checkers.
+#
+# This is the main checker controlling the other ones and the reports
+# generation. It is itself both a raw checker and an astng checker in order
+# to:
+# * handle message activation / deactivation at the module level
+# * handle some basic but necessary stats'data (number of classes, methods...)
+#
+[MASTER]
+
+# Specify a configuration file.
+#rcfile=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Profiled execution.
+profile=no
+
+# Add <file or directory> to the black list. It should be a base name, not a
+# path. You may set this option multiple times.
+ignore=CVS
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+
+[MESSAGES CONTROL]
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time.
+#enable=
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once).
+disable=pointless-except, invalid-name, super-init-not-called, fixme, star-args,
+ too-many-instance-attributes, too-few-public-methods, too-many-arguments,
+ too-many-locals, too-many-public-methods, duplicate-code, bad-whitespace,
+ locally-disabled
+
+[REPORTS]
+
+# Set the output format. Available formats are text, parseable, colorized, msvs
+# (visual studio) and html
+output-format=colorized
+msg-template='{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}'
+
+# Include message's id in output
+include-ids=yes
+
+# Put messages in a separate file for each module / package specified on the
+# command line instead of printing them on stdout. Reports (if any) will be
+# written in a file name "pylint_global.[txt|html]".
+files-output=no
+
+# Tells wether to display a full report or only the messages
+reports=no
+
+# Python expression which should return a note less than 10 (10 is the highes
+# note). You have access to the variables errors warning, statement which
+# respectivly contain the number of errors / warnings messages and the total
+# number of statements analyzed. This is used by the global evaluation repor
+# (R0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Add a comment according to your evaluation note. This is used by the global
+# evaluation report (R0004).
+comment=no
+
+# Enable the report(s) with the given id(s).
+#enable-report=
+
+# Disable the report(s) with the given id(s).
+#disable-report=
+
+
+# checks for :
+# * doc strings
+# * modules / classes / functions / methods / arguments / variables name
+# * number of arguments, local variables, branchs, returns and statements in
+# functions, methods
+# * required module attributes
+# * dangerous default values as arguments
+# * redefinition of function / method / class
+# * uses of the global statemen
+#
+[BASIC]
+
+# Required attributes for module, separated by a comma
+required-attributes=
+
+# Regular expression which should only match functions or classes name which do
+# not require a docstring
+no-docstring-rgx=__.*__
+
+# Regular expression which should only match correct module names
+module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
+
+# Regular expression which should only match correct module level names
+const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
+
+# Regular expression which should only match correct class names
+class-rgx=[A-Z_][a-zA-Z0-9]+$
+
+# Regular expression which should only match correct function names
+function-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct method names
+method-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct instance attribute names
+attr-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct argument names
+argument-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct variable names
+variable-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct list comprehension /
+# generator expression variable names
+inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=i,j,k,ex,Run,_
+
+# Bad variable names which should always be refused, separated by a comma
+bad-names=foo,bar,baz,toto,tutu,tata
+
+# List of builtins function names that should not be used, separated by a comma
+bad-functions=map,filter,apply,inpu
+
+
+# try to find bugs in the code using type inference
+#
+[TYPECHECK]
+
+# Tells wether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# List of classes names for which member attributes should not be checked
+# (useful for classes with attributes dynamicaly set).
+ignored-classes=SQLObjec
+
+# When zope mode is activated, add a predefined set of Zope acquired attributes
+# to generated-members.
+zope=no
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E0201 when accessed.
+generated-members=REQUEST,acl_users,aq_paren
+
+
+# checks for
+# * unused variables / imports
+# * undefined variables
+# * redefinition of variable from builtins or from an outer scope
+# * use of variable before assigmen
+#
+[VARIABLES]
+
+# Tells wether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching names used for dummy variables (i.e. not used).
+dummy-variables-rgx=_|dummy
+
+# List of additional names supposed to be defined in builtins. Remember tha
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+
+# checks for :
+# * methods without self as first argumen
+# * overridden methods signature
+# * access only to existant members via self
+# * attributes not defined in the __init__ method
+# * supported interfaces implementation
+# * unreachable code
+#
+[CLASSES]
+
+# List of interface methods to ignore, separated by a comma. This is used for
+# instance to not check methods defines in Zope's Interface base class.
+ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,__new__,setUp,build
+
+
+# checks for sign of poor/misdesign:
+# * number of methods, attributes, local variables...
+# * size, complexity of functions, methods
+#
+[DESIGN]
+
+# Maximum number of arguments for function / method
+max-args=5
+
+# Maximum number of locals for function / method body
+max-locals=15
+
+# Maximum number of return / yield for function / method body
+max-returns=6
+
+# Maximum number of branch for function / method body
+max-branchs=12
+
+# Maximum number of statements in function / method body
+max-statements=50
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+
+# checks for
+# * external modules dependencies
+# * relative / wildcard imports
+# * cyclic imports
+# * uses of deprecated modules
+#
+[IMPORTS]
+
+# Deprecated modules which should not be used, separated by a comma
+deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report R0402 must not be disabled)
+import-graph=
+
+# Create a graph of external dependencies in the given file (report R0402 mus
+# not be disabled)
+ext-import-graph=
+
+# Create a graph of internal dependencies in the given file (report R0402 mus
+# not be disabled)
+int-import-graph=
+
+
+# checks for :
+# * unauthorized constructions
+# * strict indentation
+# * line length
+# * use of <> instead of !=
+#
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=80
+
+# Maximum number of lines in a module
+max-module-lines=1500
+
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
+# tab).
+indent-string=' '
+
+
+# checks for:
+# * warning notes in the code like FIXME, XXX
+# * PEP 263: source code with non ascii character but no encoding declaration
+#
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,XXX,TODO
+
+
+# checks for similarities and duplicated code. This computation may be
+# memory / CPU intensive, so you should disable it if you experiments some
+# problems.
+#
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
diff --git a/TestON/bin/codecheck b/TestON/bin/codecheck
new file mode 100755
index 0000000..1193df8
--- /dev/null
+++ b/TestON/bin/codecheck
@@ -0,0 +1,50 @@
+#!/bin/bash
+
+#These are from the Mininet coding style
+P8IGN=E251,E201,E302,E202,E126,E127,E203,E226,W391
+
+# help text function
+help ()
+{
+ echo "Usage: codecheck [FILE]... [OPTION]..."
+ echo "Simple script that runs some python code check tools on a file or folder"
+ echo "Note that for now, options must come after the file/folder path"
+ echo -e "\nOptions include:"
+ echo -e " --fix\tRun the automatic style scripts on a file and save the output to FILE.fixed"
+ echo -e " --reason\tShow a short snippit for each PEP8 violation"
+ echo -e " --help\tDisplays this help text and exits"
+}
+
+
+if [ -z "$1" ] || [[ "$1" =~ --* ]]; then
+ help
+elif [ "$2" = "--fix" ]; then
+ file=$1.fixed
+ echo "Fixing PEP8 errors. WARNING: This may be harmful to your code."
+ echo "For safety, the new code is written to $file"
+ #autopep8 -a -a $1
+ autopep8 -a -a $1 --ignore=E501 | $(dirname "${BASH_SOURCE}")/unpep8 > $file
+ autopep8 --in-place -a -a $file --ignore=$P8IGN
+elif [ -z "$2" ] || [ "$2" = "--reason" ]; then
+ echo "Running pyflakes..."
+ #Pyflakes is a source checker. It doesn't run the code so it is safer than other programs
+ #ignoring some errors due to TestON
+ pyflakes $1 | grep -v "undefined name 'main'" | grep -v "undefined name 'utilities'"
+ echo "Running pylint..."
+ #Pylint is a static code checker
+ #ignoring some errors due to TestON
+ pylint -E --rcfile=$(dirname "${BASH_SOURCE}")/.pylint $1 | grep -v "Undefined variable 'main'" | grep -v "Undefined variable 'utilities'"
+
+ echo "Running PEP8..."
+ #PEP8 is a the most common python coding style standard
+ if [ -z "$2"]; then
+ pep8 --repeat --show-source --ignore=$P8IGN $1
+ else
+ pep8 --repeat --show-source --show-pep8 --ignore=$P8IGN $1
+ fi
+else
+ help
+fi
+
+
+
diff --git a/TestON/bin/unpep8 b/TestON/bin/unpep8
new file mode 100755
index 0000000..090865a
--- /dev/null
+++ b/TestON/bin/unpep8
@@ -0,0 +1,198 @@
+#!/usr/bin/python
+
+"""
+Translate from PEP8 Python style to Mininet (i.e. Arista-like)
+Python style
+
+usage: unpep8 < old.py > new.py
+
+- Reinstates CapWords for methods and instance variables
+- Gets rid of triple single quotes
+- Eliminates triple quotes on single lines
+- Inserts extra spaces to improve readability
+- Fixes Doxygen (or doxypy) ugliness
+
+Does the following translations:
+
+ClassName.method_name(foo = bar) -> ClassName.methodName( foo=bar )
+
+Triple-single-quotes -> triple-double-quotes
+
+@param foo description -> foo: description
+@return description -> returns: description
+@author me -> author: me
+@todo(me) -> TODO(me)
+
+Bugs/Limitations:
+
+- Hack to restore strings is ugly
+- Multiline strings get mangled
+- Comments are mangled (which is arguably the "right thing" to do, except
+ that, for example, the left hand sides of the above would get translated!)
+- Doesn't eliminate unnecessary backslashes
+- Has no opinion on tab size
+- complicated indented docstrings get flattened
+- We don't (yet) have a filter to generate Doxygen/Doxypy
+- Currently leaves indents on blank comment lines
+- May lead to namespace collisions (e.g. some_thing and someThing)
+
+Bob Lantz, rlantz@cs.stanford.edu
+1/24/2010
+"""
+
+import re, sys
+
+def fixUnderscoreTriplet( match ):
+ "Translate a matched triplet of the form a_b to aB."
+ triplet = match.group()
+ return triplet[ :-2 ] + triplet[ -1 ].capitalize()
+
+def reinstateCapWords( text ):
+ underscoreTriplet = re.compile( r'[A-Za-z0-9]_[A-Za-z0-9]' )
+ return underscoreTriplet.sub( fixUnderscoreTriplet, text )
+
+def replaceTripleApostrophes( text ):
+ "Replace triple apostrophes with triple quotes."
+ return text.replace( "'''", '"""')
+
+def simplifyTripleQuotes( text ):
+ "Fix single-line doc strings."
+ r = re.compile( r'"""([^\"\n]+)"""' )
+ return r.sub( r'"\1"', text )
+
+def insertExtraSpaces( text ):
+ "Insert extra spaces inside of parentheses and brackets/curly braces."
+ lparen = re.compile( r'\((?![\s\)])' )
+ text = lparen.sub( r'( ', text )
+ rparen = re.compile( r'([^\s\(])(?=\))' )
+ text = rparen.sub( r'\1 ', text)
+ # brackets
+ lbrack = re.compile( r'\[(?![\s\]])' )
+ text = lbrack.sub( r'[ ', text )
+ rbrack = re.compile( r'([^\s\[])(?=\])' )
+ text = rbrack.sub( r'\1 ', text)
+ # curly braces
+ lcurly = re.compile( r'\{(?![\s\}])' )
+ text = lcurly.sub( r'{ ', text )
+ rcurly = re.compile( r'([^\s\{])(?=\})' )
+ text = rcurly.sub( r'\1 ', text)
+ return text
+
+def fixDoxygen( text ):
+ """Translate @param foo to foo:, @return bar to returns: bar, and
+ @author me to author: me"""
+ param = re.compile( r'@param (\w+)' )
+ text = param.sub( r'\1:', text )
+ returns = re.compile( r'@return' )
+ text = returns.sub( r'returns:', text )
+ author = re.compile( r'@author' )
+ text = author.sub( r'author:', text)
+ # @todo -> TODO
+ text = text.replace( '@todo', 'TODO' )
+ return text
+
+def removeCommentFirstBlankLine( text ):
+ "Remove annoying blank lines after first line in comments."
+ line = re.compile( r'("""[^\n]*\n)\s*\n', re.MULTILINE )
+ return line.sub( r'\1', text )
+
+def fixArgs( match, kwarg = re.compile( r'(\w+) = ' ) ):
+ "Replace foo = bar with foo=bar."
+ return kwarg.sub( r'\1=', match.group() )
+
+def fixKeywords( text ):
+ "Change keyword argumentsfrom foo = bar to foo=bar."
+ args = re.compile( r'\(([^\)]+)\)', re.MULTILINE )
+ return args.sub( fixArgs, text )
+
+# Unfortunately, Python doesn't natively support balanced or recursive
+# regular expressions. We could use PyParsing, but that opens another can
+# of worms. For now, we just have a cheap hack to restore strings,
+# so we don't end up accidentally mangling things like messages, search strings,
+# and regular expressions.
+
+def lineIter( text ):
+ "Simple iterator over lines in text."
+ for line in text.splitlines(): yield line
+
+def stringIter( strList ):
+ "Yield strings in strList."
+ for s in strList: yield s
+
+def restoreRegex( regex, old, new ):
+ "Find regexes in old and restore them into new."
+ oldStrs = regex.findall( old )
+ # Sanity check - count should be the same!
+ newStrs = regex.findall( new )
+ assert len( oldStrs ) == len( newStrs )
+ # Replace newStrs with oldStrs
+ siter = stringIter( oldStrs )
+ reps = lambda dummy: siter.next()
+ return regex.sub( reps, new )
+
+# This is a cheap hack, and it may not work 100%, since
+# it doesn't handle multiline strings.
+# However, it should be mostly harmless...
+
+def restoreStrings( oldText, newText ):
+ "Restore strings from oldText into newText, returning result."
+ oldLines, newLines = lineIter( oldText ), lineIter( newText )
+ quoteStrings = re.compile( r'("[^"]*")' )
+ tickStrings = re.compile( r"('[^']*')" )
+ result = ''
+ # It would be nice if we could blast the whole file, but for
+ # now it seems to work line-by-line
+ for newLine in newLines:
+ oldLine = oldLines.next()
+ newLine = restoreRegex( quoteStrings, oldLine, newLine )
+ newLine = restoreRegex( tickStrings, oldLine, newLine )
+ result += newLine + '\n'
+ return result
+
+# This might be slightly controversial, since it uses
+# three spaces to line up multiline comments. However,
+# I much prefer it. Limitations: if you have deeper
+# indents in comments, they will be eliminated. ;-(
+
+def fixComment( match,
+ indentExp=re.compile( r'\n([ ]*)(?=[^/s])', re.MULTILINE ),
+ trailingQuotes=re.compile( r'\s+"""' ) ):
+ "Re-indent comment, and join trailing quotes."
+ originalIndent = match.group( 1 )
+ comment = match.group( 2 )
+ indent = '\n' + originalIndent
+ # Exception: leave unindented things unindented!
+ if len( originalIndent ) is not 0: indent += ' '
+ comment = indentExp.sub( indent, comment )
+ return originalIndent + trailingQuotes.sub( '"""', comment )
+
+def fixCommentIndents( text ):
+ "Fix multiline comment indentation."
+ comments = re.compile( r'^([ ]*)("""[^"]*""")$', re.MULTILINE )
+ return comments.sub( fixComment, text )
+
+def removeBogusLinefeeds( text ):
+ "Remove extra linefeeds at the end of single-line comments."
+ bogusLfs = re.compile( r'"([^"\n]*)\n"', re.MULTILINE )
+ return bogusLfs.sub( '"\1"', text)
+
+def convertFromPep8( program ):
+ oldProgram = program
+ # Program text transforms
+ # program = reinstateCapWords( program ) # Turning off for now
+ program = fixKeywords( program )
+ program = insertExtraSpaces( program )
+ # Undo string damage
+ program = restoreStrings( oldProgram, program )
+ # Docstring transforms
+ program = replaceTripleApostrophes( program )
+ program = simplifyTripleQuotes( program )
+ program = fixDoxygen( program )
+ # program = fixCommentIndents( program ) # Turning off as it breaks tests in TestON
+ program = removeBogusLinefeeds( program )
+ # Destructive transforms (these can delete lines)
+ program = removeCommentFirstBlankLine( program )
+ return program
+
+if __name__ == '__main__':
+ print convertFromPep8( sys.stdin.read() )