[ { "path": ".coveragerc", "content": "[run]\nbranch = True\nsource = bashate\nomit = bashate/tests/*\n\n[report]\nignore_errors = True\n" }, { "path": ".gitignore", "content": "*.py[cod]\n\n# C extensions\n*.so\n\n# Packages\n*.egg\n*.egg-info\ndist\nbuild\neggs\nparts\nbin\nvar\nsdist\ndevelop-eggs\n.installed.cfg\nlib\nlib64\n\n# Installer logs\npip-log.txt\n\n# Unit test / coverage reports\n.coverage\n.tox\nnosetests.xml\n.stestr/\ncover/\n\n# Translations\n*.mo\n\n# Mr Developer\n.mr.developer.cfg\n.project\n.pydevproject\n\n# Complexity\noutput/*.html\noutput/*/index.html\n\n# Sphinx\ndoc/build\n\n# pbr generates these\nAUTHORS\nChangeLog\n\n# Editors\n*~\n.*.swp" }, { "path": ".gitreview", "content": "[gerrit]\nhost=review.opendev.org\nport=29418\nproject=openstack/bashate.git\n" }, { "path": ".mailmap", "content": "# Format is:\n# \n# " }, { "path": ".pre-commit-hooks.yaml", "content": "---\n\n# For use with pre-commit.\n# See usage instructions at https://pre-commit.com\n\n- id: bashate\n name: bashate\n description: This hook runs bashate for linting shell scripts\n entry: bashate\n language: python\n types: [shell]\n" }, { "path": ".stestr.conf", "content": "[DEFAULT]\ntest_path=./bashate/tests" }, { "path": ".zuul.d/jobs.yaml", "content": "- project:\n templates:\n - openstack-python3-jobs\n - publish-openstack-docs-pti\n - release-notes-jobs-python3\n check:\n jobs:\n - openstack-tox-pep8\n - openstack-tox-py39\n - openstack-tox-py310\n - openstack-tox-py311\n - openstack-tox-py312\n - bashate-devstack\n gate:\n jobs:\n - openstack-tox-pep8\n - openstack-tox-py39\n - openstack-tox-py310\n - openstack-tox-py311\n - openstack-tox-py312\n - bashate-devstack\n\n- job:\n name: bashate-devstack\n run: playbooks/bashate-devstack-master/run.yaml\n required-projects:\n - openstack/devstack\n" }, { "path": "CONTRIBUTING.rst", "content": "The source repository for this project can be found at:\n\n https://opendev.org/openstack/bashate\n\nPull requests submitted through GitHub are not monitored.\n\nTo start contributing to OpenStack, follow the steps in the contribution guide\nto set up and use Gerrit:\n\n https://docs.openstack.org/contributors/code-and-documentation/quick-start.html\n\nBugs should be filed on Launchpad:\n\n https://bugs.launchpad.net/bash8\n\nFor more specific information about contributing to this repository, see the\nBashate contributor guide:\n\n https://docs.openstack.org/bashate/latest/contributor/contributing.html\n" }, { "path": "HACKING.rst", "content": "bashate Style Commandments\n===============================================\n\nRead the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/\n" }, { "path": "LICENSE", "content": "\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n" }, { "path": "README.rst", "content": "===============================\nbashate\n===============================\n\nA pep8 equivalent for bash scripts\n\nThis program attempts to be an automated style checker for bash scripts\nto fill the same part of code review that pep8 does in most OpenStack\nprojects. It started from humble beginnings in the DevStack project,\nand will continue to evolve over time.\n\nThe output format aims to follow `pycodestyle (pep8) default output format\n`_.\n\n\n- Free software: Apache license\n- Documentation: https://docs.openstack.org/bashate\n- Source: https://opendev.org/openstack/bashate/\n- Bugs: https://bugs.launchpad.net/bash8\n- Release notes: https://docs.openstack.org/releasenotes/bashate/index.html\n- Contributing: https://docs.openstack.org/bashate/latest/contributor/index.html\n\nCurrently Supported Checks\n--------------------------\n\nErrors\n~~~~~~\n\nBasic white space errors, for consistent indenting\n\n- E001: check that lines do not end with trailing whitespace\n- E002: ensure that indents are only spaces, and not hard tabs\n- E003: ensure all indents are a multiple of 4 spaces\n- E004: file did not end with a newline\n- E005: file does not begin with #! or have a .sh prefix\n- E006: check for lines longer than 79 columns\n\nStructure Errors\n~~~~~~~~~~~~~~~~\n\nA set of rules that help keep things consistent in control blocks.\nThese are ignored on long lines that have a continuation, because\nunrolling that is kind of \"interesting\"\n\n- E010: *do* not on the same line as *for*\n- E011: *then* not on the same line as *if* or *elif*\n- E012: heredoc didn't end before EOF\n- E020: Function declaration not in format ``^function name {$``\n\nObsolete, deprecated or unsafe syntax\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nRules to identify obsolete, deprecated or unsafe syntax that should\nnot be used\n\n- E040: Syntax errors reported by `bash -n`\n- E041: Usage of $[ for arithmetic is deprecated for $((\n- E042: local declaration hides errors\n- E043: arithmetic compound has inconsistent return semantics\n- E044: Use [[ for =~,<,> comparisions\n" }, { "path": "bashate/__init__.py", "content": "# Licensed under the Apache License, Version 2.0 (the \"License\"); you may\n# not use this file except in compliance with the License. You may obtain\n# a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\n# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\n# License for the specific language governing permissions and limitations\n# under the License.\n\nimport pbr.version\n\n\n__version__ = pbr.version.VersionInfo(\n 'bashate').version_string_with_vcs()\n" }, { "path": "bashate/__main__.py", "content": "from bashate import main\nimport sys\n\nif __name__ == \"__main__\":\n sys.exit(main())\n" }, { "path": "bashate/bashate.py", "content": "#!/usr/bin/env python\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\n# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\n# License for the specific language governing permissions and limitations\n# under the License.\n\nimport argparse\nimport fileinput\nimport os\nimport re\nimport shlex\nimport subprocess\nimport sys\n\nimport bashate\nfrom bashate import messages\n\nMESSAGES = messages.MESSAGES\n\n\ndef is_continuation(line):\n return re.search(r'\\\\\\s*$', line)\n\n\ndef check_for_do(line, report):\n if not is_continuation(line):\n match = re.match(r'^\\s*(for|while|until)\\s', line)\n if match:\n operator = match.group(1).strip()\n if operator == \"for\":\n # \"for i in ...\" and \"for ((\" is bash, but\n # \"for (\" is likely from an embedded awk script,\n # so skip it\n if re.search(r'for \\([^\\(]', line):\n return\n if not re.search(r';\\s*do$', line):\n report.print_error((MESSAGES['E010'].msg % operator), line)\n\n\ndef check_if_then(line, report):\n if not is_continuation(line):\n if re.search(r'^\\s*(el)?if \\[', line):\n if not re.search(r';\\s*then$', line):\n report.print_error(MESSAGES['E011'].msg, line)\n\n\ndef check_no_trailing_whitespace(line, report):\n if re.search(r'[ \\t]+$', line):\n report.print_error(MESSAGES['E001'].msg, line)\n\n\ndef check_no_long_lines(line, report, max_line_length):\n if len(line.rstrip(\"\\r\\n\")) > max_line_length:\n report.print_error(MESSAGES['E006'].msg, line)\n\n\ndef check_indents(logical_line, report):\n # this is rather complex to handle argument offset indenting;\n # primarily done by emacs. If there is an argument, it will try\n # to line up the following arguments underneath it, e.g.\n # foobar_cmd bar baz \\\n # moo boo\n # Thus the offset in this case might not be a strict multiple of 4\n\n # Find the offset of the first argument of the command (if it has\n # one)\n m = re.search(r'^(?P[ \\t]+)?(?P\\S+)(?P\\s+)(?P\\S+)',\n logical_line[0])\n arg_offset = None\n if m:\n arg_offset = len(m.group('indent')) if m.group('indent') else 0\n arg_offset += len(m.group('cmd')) + len(m.group('ws'))\n\n # go through each line\n for lineno, line in enumerate(logical_line):\n m = re.search(r'^(?P[ \\t]+)', line)\n if m:\n # no tabs, only spaces\n if re.search(r'\\t', m.group('indent')):\n report.print_error(MESSAGES['E002'].msg, line)\n\n offset = len(m.group('indent'))\n\n # the first line and lines without an argument should be\n # offset by 4 spaces\n if (lineno == 0) or (arg_offset is None):\n if (offset % 4) != 0:\n report.print_error(MESSAGES['E003'].msg, line)\n else:\n # other lines are allowed to line up with the first\n # argument, or be multiple-of 4 spaces\n if offset != arg_offset and (offset % 4) != 0:\n report.print_error(MESSAGES['E003'].msg, line)\n\n\ndef check_function_decl(line, report):\n failed = False\n if line.startswith(\"function\"):\n if not re.search(r'^function [\\w-]* \\{$', line):\n failed = True\n else:\n # catch the case without \"function\", e.g.\n # things like '^foo() {'\n if re.search(r'^\\s*?\\(\\)\\s*?\\{', line):\n failed = True\n\n if failed:\n report.print_error(MESSAGES['E020'].msg, line)\n\n\ndef starts_heredoc(line):\n # note, watch out for <\\w+)([\\'\\\"]?)\", line)\n return m.group('token') if m else False\n\n\ndef end_of_heredoc(line, token):\n return token and re.search(r\"^%s\\s*$\" % token, line)\n\n\ndef check_arithmetic(line, report):\n if \"$[\" in line:\n report.print_error(MESSAGES['E041'].msg, line)\n\n\ndef check_bare_arithmetic(line, report):\n if line.lstrip().startswith(\"((\"):\n report.print_error(MESSAGES['E043'].msg, line)\n\n\ndef check_local_subshell(line, report):\n # XXX: should we increase the string checking to see if the $( is\n # anywhere with a string being set? Risk of false positives?x\n if line.lstrip().startswith('local ') and \\\n any(s in line for s in ('=$(', '=`', '=\"$(', '=\"`')):\n report.print_error(MESSAGES['E042'].msg, line)\n\n\ndef check_hashbang(line, filename, report):\n # this check only runs on the first line\n # maybe this should check for shell?\n if (not filename.endswith(\".sh\") and not line.startswith(\"#!\") and\n not os.path.basename(filename).startswith('.')):\n report.print_error(MESSAGES['E005'].msg, line)\n\n\ndef check_conditional_expression(line, report):\n # We're really starting to push the limits of what we can do without\n # a complete bash syntax parser here. For example\n # > [[ $foo =~ \" [ \" ]] && [[ $bar =~ \" ] \" ]]\n # would be valid but mess up a simple regex matcher for \"[.*]\".\n # Let alone dealing with multiple-line-spanning etc...\n #\n # So we'll KISS and just look for simple, one line,\n # > if [ $foo =~ \"bar\" ]; then\n # type statements, which are the vast majority of typo errors.\n #\n # shlex is pretty helpful in getting us something we can walk to\n # find this pattern. It does however have issues with\n # unterminated quotes on multi-line strings (e.g.)\n #\n # foo=\"bar <-- we only see this bit in \"line\"\n # baz\"\n #\n # So we're just going to ignore parser failures here and move on.\n # Possibly in the future we could pull such multi-line strings\n # into \"logical_line\" below, and pass that here and have shlex\n # break that up.\n try:\n toks = shlex.shlex(line)\n toks.wordchars = \"[]=~\"\n toks = list(toks)\n except ValueError:\n return\n\n in_single_bracket = False\n for tok in toks:\n if tok == '[':\n in_single_bracket = True\n elif tok in ('=~', '<', '>') and in_single_bracket:\n report.print_error(MESSAGES['E044'].msg, line)\n elif tok == ']':\n in_single_bracket = False\n\n\ndef check_syntax(filename, report):\n # run the file through \"bash -n\" to catch basic syntax errors and\n # other warnings\n matches = []\n\n # sample lines we want to match:\n # foo.sh: line 4: warning: \\\n # here-document at line 1 delimited by end-of-file (wanted `EOF')\n # foo.sh: line 9: syntax error: unexpected end of file\n # foo.sh: line 7: syntax error near unexpected token `}'\n #\n # i.e. consistency with \":\"'s isn't constant, so just do our\n # best...\n r = re.compile(\n '^(?P.*): line (?P[0-9]+): (?P.*)')\n # we are parsing the error message, so force it to ignore the\n # system locale so we don't get messages in another language\n bash_environment = os.environ\n bash_environment['LC_ALL'] = 'C'\n proc = subprocess.Popen(\n ['bash', '-n', filename], stdout=subprocess.PIPE,\n stderr=subprocess.PIPE, env=bash_environment,\n universal_newlines=True)\n outputs = proc.communicate()\n\n for line in outputs[1].split('\\n'):\n m = r.match(line)\n if m:\n matches.append(m)\n\n for m in matches:\n if 'syntax error' in m.group('error'):\n msg = '%s: %s' % (MESSAGES['E040'].msg, m.group('error'))\n report.print_error(msg, filename=filename,\n filelineno=int(m.group('lineno')))\n\n # Matching output from bash warning about here-documents not\n # ending.\n # FIXME: are there other warnings that might come out\n # with \"bash -n\"? A quick scan of the source code suggests\n # no, but there might be other interesting things we could\n # catch.\n if 'warning:' in m.group('error'):\n if 'delimited by end-of-file' in m.group('error'):\n start = re.match('^.*line (?P[0-9]+).*$',\n m.group('error'))\n report.print_error(\n MESSAGES['E012'].msg % int(start.group('start')),\n filename=filename,\n filelineno=int(m.group('lineno')))\n\n\nclass BashateRun(object):\n\n def __init__(self):\n self.error_count = 0\n self.error_list = None\n self.ignore_list = None\n self.warning_count = 0\n self.warning_list = None\n\n def register_ignores(self, ignores):\n if ignores:\n self.ignore_list = '^(' + '|'.join(ignores.split(',')) + ')'\n\n def register_warnings(self, warnings):\n if warnings:\n self.warning_list = '^(' + '|'.join(warnings.split(',')) + ')'\n\n def register_errors(self, errors):\n if errors:\n self.error_list = '^(' + '|'.join(errors.split(',')) + ')'\n\n def should_ignore(self, error):\n return self.ignore_list and re.search(self.ignore_list, error)\n\n def should_warn(self, error):\n # if in the errors list, overrides warning level\n if self.error_list and re.search(self.error_list, error):\n return False\n if messages.is_default_warning(error):\n return True\n return self.warning_list and re.search(self.warning_list, error)\n\n def print_error(self, error, line='',\n filename=None, filelineno=None):\n if self.should_ignore(error):\n return\n\n warn = self.should_warn(error)\n\n if not filename:\n filename = fileinput.filename()\n if not filelineno:\n filelineno = fileinput.filelineno()\n if warn:\n self.warning_count = self.warning_count + 1\n else:\n self.error_count = self.error_count + 1\n\n self.log_error(error, line, filename, filelineno, warn)\n\n def log_error(self, error, line, filename, filelineno, warn=False):\n # following pycodestyle/pep8 default output format\n # https://github.com/PyCQA/pycodestyle/blob/master/pycodestyle.py#L108\n print(\"%(filename)s:%(filelineno)s:1: %(error)s\" %\n {'filename': filename,\n 'filelineno': filelineno,\n 'error': error.replace(\":\", \"\", 1)})\n\n def check_files(self, files, verbose, max_line_length=79):\n logical_line = \"\"\n token = False\n\n # NOTE(mrodden): magic; replace with proper\n # report class when necessary\n report = self\n\n for fname in files:\n\n # reset world\n in_heredoc = False\n in_continuation = False\n\n # simple syntax checking, as files can pass style but still cause\n # syntax errors when you try to run them.\n check_syntax(fname, report)\n\n for line in fileinput.input(fname):\n if fileinput.isfirstline():\n\n check_hashbang(line, fileinput.filename(), report)\n\n if verbose:\n print(\"Running bashate on %s\" % fileinput.filename())\n\n # Don't run any tests on comment lines (but remember\n # inside a heredoc this might be part of the syntax of\n # an embedded script, just ignore that)\n if line.lstrip().startswith('#') and not in_heredoc:\n logical_line = [line]\n check_indents(logical_line, report)\n continue\n\n # Strip trailing comments. From bash:\n #\n # a word beginning with # causes that word and all\n # remaining characters on that line to be ignored.\n # ...\n # A character that, when unquoted, separates\n # words. One of the following: | & ; ( ) < > space\n # tab\n #\n # for simplicity, we strip inline comments by\n # matching just '#'.\n if not in_heredoc:\n ll_split = line.split(' #', 1)\n if len(ll_split) > 1:\n line = ll_split[0].rstrip()\n\n # see if this starts a heredoc\n if not in_heredoc:\n token = starts_heredoc(line)\n if token:\n in_heredoc = True\n logical_line = [line]\n continue\n\n # see if this starts a continuation\n if not in_continuation:\n if is_continuation(line):\n in_continuation = True\n logical_line = [line]\n continue\n\n # if we are in a heredoc or continuation, just loop\n # back and keep buffering the lines into\n # \"logical_line\" until the end of the\n # heredoc/continuation.\n if in_heredoc:\n logical_line.append(line)\n if not end_of_heredoc(line, token):\n continue\n else:\n in_heredoc = False\n # FIXME: if we want to do something with\n # heredocs in the future, then the whole thing\n # is now stored in logical_line. for now,\n # skip\n continue\n elif in_continuation:\n logical_line.append(line)\n if is_continuation(line):\n continue\n else:\n in_continuation = False\n else:\n logical_line = [line]\n\n check_indents(logical_line, report)\n\n # at this point, logical_line is an array that holds\n # the whole continuation. XXX : historically, we've\n # just handled every line in a continuation\n # separatley. Stick with what works...\n for line in logical_line:\n check_no_trailing_whitespace(line, report)\n check_no_long_lines(line, report, max_line_length)\n check_for_do(line, report)\n check_if_then(line, report)\n check_function_decl(line, report)\n check_arithmetic(line, report)\n check_local_subshell(line, report)\n check_bare_arithmetic(line, report)\n check_conditional_expression(line, report)\n\n # finished processing the file\n\n # last line should always end with a newline\n if not line.endswith('\\n'):\n report.print_error(MESSAGES['E004'].msg, line)\n\n\ndef main(args=None):\n\n if args is None:\n args = sys.argv[1:]\n\n parser = argparse.ArgumentParser(\n description='A bash script style checker')\n parser.add_argument('files', metavar='file', nargs='*',\n help='files to scan for errors')\n parser.add_argument('-i', '--ignore', help='Rules to ignore')\n parser.add_argument('-w', '--warn',\n help='Rules to always warn (rather than error)')\n parser.add_argument('-e', '--error',\n help='Rules to always error (rather than warn)')\n parser.add_argument('--max-line-length', default=79, type=int,\n help='Max line length')\n parser.add_argument('-v', '--verbose', action='store_true', default=False)\n parser.add_argument('--version', action='store_true',\n help='show bashate version number and exit',\n default=False)\n parser.add_argument('-s', '--show', action='store_true', default=False)\n opts = parser.parse_args(args)\n\n if opts.version:\n print(\"bashate: %s\" % bashate.__version__)\n sys.exit(0)\n\n if opts.show:\n messages.print_messages()\n sys.exit(0)\n\n files = opts.files\n if not files:\n parser.print_usage()\n return 1\n\n run = BashateRun()\n run.register_ignores(opts.ignore)\n run.register_warnings(opts.warn)\n run.register_errors(opts.error)\n\n try:\n run.check_files(files, opts.verbose, opts.max_line_length)\n except IOError as e:\n print(\"bashate: %s\" % e)\n return 1\n\n if run.warning_count > 0:\n print(\"%d bashate warning(s) found\" % run.warning_count)\n\n if run.error_count > 0:\n print(\"%d bashate error(s) found\" % run.error_count)\n return 1\n\n return 0\n\n\nif __name__ == \"__main__\":\n sys.exit(main())\n" }, { "path": "bashate/messages.py", "content": "# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\n# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\n# License for the specific language governing permissions and limitations\n# under the License.\n\nimport re\nimport textwrap\n\n\nclass _Message(object):\n \"\"\"An individual bashate message.\n\n This should be accessed via the MESSAGES dict keyed by msg_id,\n e.g.\n\n from bashate.messages import MESSAGES\n print(MESSAGES['E123'].msg)\n\n :param msg_id: The unique message id (E...)\n :param msg_str: The short message string, as displayed in program\n output\n :param long_msg: A longer more involved message, designed for\n documentation\n \"\"\"\n def __init__(self, msg_id, msg_str, long_msg, default):\n self.msg_id = msg_id\n self.msg_str = msg_str\n # clean-up from \"\"\" to a plain string\n if long_msg:\n self.long_msg = textwrap.dedent(long_msg)\n self.long_msg = self.long_msg.strip()\n else:\n self.long_msg = None\n self.default = default\n\n @property\n def msg(self):\n # For historical reasons, the code relies on \"id: msg\" so build\n # that up as .msg property for quick access.\n return \"%s: %s\" % (self.msg_id, self.msg_str)\n\n\n_messages = {\n 'E001': {\n 'msg': 'Trailing Whitespace',\n 'long_msg': None,\n 'default': 'E'\n },\n 'E002': {\n 'msg': 'Tab indents',\n 'long_msg':\n \"\"\"\n Spaces are preferred to tabs in source files.\n \"\"\",\n 'default': 'E'\n },\n 'E003': {\n 'msg': 'Indent not multiple of 4',\n 'long_msg':\n \"\"\"\n Four spaces should be used to offset logical blocks.\n \"\"\",\n 'default': 'E'\n },\n 'E004': {\n 'msg': 'File did not end with a newline',\n 'long_msg':\n \"\"\"\n It is conventional to have a single newline ending files.\n \"\"\",\n 'default': 'E'\n },\n 'E005': {\n 'msg': 'File does not begin with #! or have .sh prefix',\n 'long_msg':\n \"\"\"\n This can be useful for tools that use either the interpreter\n directive or the file-exension to select highlighting mode,\n syntax mode or determine MIME-type, such as file, gerrit and\n editors.\n \"\"\",\n 'default': 'W'\n },\n 'E006': {\n 'msg': 'Line too long',\n 'long_msg':\n \"\"\"\n This check mimics the widely accepted convention from PEP8 and\n many other places that lines longer than a standard terminal width\n (default=79 columns) can not only cause problems when reading/writing\n code, but also often indicates a bad smell, e.g. too many levels\n of indentation due to overly complex functions which require\n refactoring into smaller chunks.\n \"\"\",\n 'default': 'W'\n },\n 'E010': {\n 'msg': 'The \"do\" should be on same line as %s',\n 'long_msg':\n \"\"\"\n Ensure consistency of \"do\" directive being on the same line as\n it's command. For example:\n\n for i in $(seq 1 100);\n do\n echo \"hi\"\n done\n\n will trigger this error\n \"\"\",\n 'default': 'E'\n },\n 'E011': {\n 'msg': 'Then keyword is not on same line as if or elif keyword',\n 'long_msg':\n \"\"\"\n Similar to E010, this ensures consistency of if/elif statements\n \"\"\",\n 'default': 'E'\n },\n 'E012': {\n 'msg': 'here-document at line %d delimited by end-of-file',\n 'long_msg':\n \"\"\"\n This check ensures the closure of heredocs (<