Remove internal bash8
We use the one installed from pypi in the tox venv, so dump the original. Fix up run_tests.sh. Change-Id: I6b0aa1da9bfa4d742a7210e6ff800d72492a2178
This commit is contained in:
Dean Troyer
parent
18cf4f1004
commit
50e9b9e25b
@ -43,7 +43,7 @@ fi
|
||||
|
||||
echo "Running bash8..."
|
||||
|
||||
./tools/bash8.py -v $FILES
|
||||
tox -ebashate
|
||||
pass_fail $? 0 bash8
|
||||
|
||||
|
||||
|
||||
215
tools/bash8.py
215
tools/bash8.py
@ -1,215 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
#
|
||||
# Licensed 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.
|
||||
|
||||
# bash8 - a pep8 equivalent for bash scripts
|
||||
#
|
||||
# this program attempts to be an automated style checker for bash scripts
|
||||
# to fill the same part of code review that pep8 does in most OpenStack
|
||||
# projects. It starts from humble beginnings, and will evolve over time.
|
||||
#
|
||||
# Currently Supported checks
|
||||
#
|
||||
# Errors
|
||||
# Basic white space errors, for consistent indenting
|
||||
# - E001: check that lines do not end with trailing whitespace
|
||||
# - E002: ensure that indents are only spaces, and not hard tabs
|
||||
# - E003: ensure all indents are a multiple of 4 spaces
|
||||
# - E004: file did not end with a newline
|
||||
#
|
||||
# Structure errors
|
||||
#
|
||||
# A set of rules that help keep things consistent in control blocks.
|
||||
# These are ignored on long lines that have a continuation, because
|
||||
# unrolling that is kind of "interesting"
|
||||
#
|
||||
# - E010: *do* not on the same line as *for*
|
||||
# - E011: *then* not on the same line as *if*
|
||||
# - E012: heredoc didn't end before EOF
|
||||
|
||||
import argparse
|
||||
import fileinput
|
||||
import re
|
||||
import sys
|
||||
|
||||
ERRORS = 0
|
||||
IGNORE = None
|
||||
|
||||
|
||||
def register_ignores(ignores):
|
||||
global IGNORE
|
||||
if ignores:
|
||||
IGNORE = '^(' + '|'.join(ignores.split(',')) + ')'
|
||||
|
||||
|
||||
def should_ignore(error):
|
||||
return IGNORE and re.search(IGNORE, error)
|
||||
|
||||
|
||||
def print_error(error, line,
|
||||
filename=None, filelineno=None):
|
||||
if not filename:
|
||||
filename = fileinput.filename()
|
||||
if not filelineno:
|
||||
filelineno = fileinput.filelineno()
|
||||
global ERRORS
|
||||
ERRORS = ERRORS + 1
|
||||
print("%s: '%s'" % (error, line.rstrip('\n')))
|
||||
print(" - %s: L%s" % (filename, filelineno))
|
||||
|
||||
|
||||
def not_continuation(line):
|
||||
return not re.search('\\\\$', line)
|
||||
|
||||
|
||||
def check_for_do(line):
|
||||
if not_continuation(line):
|
||||
match = re.match('^\s*(for|while|until)\s', line)
|
||||
if match:
|
||||
operator = match.group(1).strip()
|
||||
if not re.search(';\s*do(\b|$)', line):
|
||||
print_error('E010: Do not on same line as %s' % operator,
|
||||
line)
|
||||
|
||||
|
||||
def check_if_then(line):
|
||||
if not_continuation(line):
|
||||
if re.search('^\s*if \[', line):
|
||||
if not re.search(';\s*then(\b|$)', line):
|
||||
print_error('E011: Then non on same line as if', line)
|
||||
|
||||
|
||||
def check_no_trailing_whitespace(line):
|
||||
if re.search('[ \t]+$', line):
|
||||
print_error('E001: Trailing Whitespace', line)
|
||||
|
||||
|
||||
def check_indents(line):
|
||||
m = re.search('^(?P<indent>[ \t]+)', line)
|
||||
if m:
|
||||
if re.search('\t', m.group('indent')):
|
||||
print_error('E002: Tab indents', line)
|
||||
if (len(m.group('indent')) % 4) != 0:
|
||||
print_error('E003: Indent not multiple of 4', line)
|
||||
|
||||
def check_function_decl(line):
|
||||
failed = False
|
||||
if line.startswith("function"):
|
||||
if not re.search('^function [\w-]* \{$', line):
|
||||
failed = True
|
||||
else:
|
||||
# catch the case without "function", e.g.
|
||||
# things like '^foo() {'
|
||||
if re.search('^\s*?\(\)\s*?\{', line):
|
||||
failed = True
|
||||
|
||||
if failed:
|
||||
print_error('E020: Function declaration not in format '
|
||||
' "^function name {$"', line)
|
||||
|
||||
|
||||
def starts_multiline(line):
|
||||
m = re.search("[^<]<<\s*(?P<token>\w+)", line)
|
||||
if m:
|
||||
return m.group('token')
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def end_of_multiline(line, token):
|
||||
if token:
|
||||
return re.search("^%s\s*$" % token, line) is not None
|
||||
return False
|
||||
|
||||
|
||||
def check_files(files, verbose):
|
||||
in_multiline = False
|
||||
multiline_start = 0
|
||||
multiline_line = ""
|
||||
logical_line = ""
|
||||
token = False
|
||||
prev_file = None
|
||||
prev_line = ""
|
||||
prev_lineno = 0
|
||||
|
||||
for line in fileinput.input(files):
|
||||
if fileinput.isfirstline():
|
||||
# if in_multiline when the new file starts then we didn't
|
||||
# find the end of a heredoc in the last file.
|
||||
if in_multiline:
|
||||
print_error('E012: heredoc did not end before EOF',
|
||||
multiline_line,
|
||||
filename=prev_file, filelineno=multiline_start)
|
||||
in_multiline = False
|
||||
|
||||
# last line of a previous file should always end with a
|
||||
# newline
|
||||
if prev_file and not prev_line.endswith('\n'):
|
||||
print_error('E004: file did not end with a newline',
|
||||
prev_line,
|
||||
filename=prev_file, filelineno=prev_lineno)
|
||||
|
||||
prev_file = fileinput.filename()
|
||||
|
||||
if verbose:
|
||||
print "Running bash8 on %s" % fileinput.filename()
|
||||
|
||||
# NOTE(sdague): multiline processing of heredocs is interesting
|
||||
if not in_multiline:
|
||||
logical_line = line
|
||||
token = starts_multiline(line)
|
||||
if token:
|
||||
in_multiline = True
|
||||
multiline_start = fileinput.filelineno()
|
||||
multiline_line = line
|
||||
continue
|
||||
else:
|
||||
logical_line = logical_line + line
|
||||
if not end_of_multiline(line, token):
|
||||
continue
|
||||
else:
|
||||
in_multiline = False
|
||||
|
||||
check_no_trailing_whitespace(logical_line)
|
||||
check_indents(logical_line)
|
||||
check_for_do(logical_line)
|
||||
check_if_then(logical_line)
|
||||
check_function_decl(logical_line)
|
||||
|
||||
prev_line = logical_line
|
||||
prev_lineno = fileinput.filelineno()
|
||||
|
||||
def get_options():
|
||||
parser = argparse.ArgumentParser(
|
||||
description='A bash script style checker')
|
||||
parser.add_argument('files', metavar='file', nargs='+',
|
||||
help='files to scan for errors')
|
||||
parser.add_argument('-i', '--ignore', help='Rules to ignore')
|
||||
parser.add_argument('-v', '--verbose', action='store_true', default=False)
|
||||
return parser.parse_args()
|
||||
|
||||
|
||||
def main():
|
||||
opts = get_options()
|
||||
register_ignores(opts.ignore)
|
||||
check_files(opts.files, opts.verbose)
|
||||
|
||||
if ERRORS > 0:
|
||||
print("%d bash8 error(s) found" % ERRORS)
|
||||
return 1
|
||||
else:
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
Loading…
Reference in New Issue
Block a user