1# Copyright 2021 The Pigweed Authors 2# 3# Licensed under the Apache License, Version 2.0 (the "License"); you may not 4# use this file except in compliance with the License. You may obtain a copy of 5# the License at 6# 7# https://www.apache.org/licenses/LICENSE-2.0 8# 9# Unless required by applicable law or agreed to in writing, software 10# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12# License for the specific language governing permissions and limitations under 13# the License. 14"""Shell related checks.""" 15 16import logging 17from pw_presubmit import ( 18 Check, 19 PresubmitContext, 20 filter_paths, 21 tools, 22 PresubmitFailure, 23) 24 25_LOG = logging.getLogger(__name__) 26 27_SHELL_EXTENSIONS = ('.sh', '.bash') 28 29 30@filter_paths(endswith=_SHELL_EXTENSIONS) 31@Check 32def shellcheck(ctx: PresubmitContext) -> None: 33 """Run shell script static analiyzer on presubmit.""" 34 35 _LOG.warning( 36 "The Pigweed project discourages use of shellscripts. " 37 "https://pigweed.dev/docs/faq.html" 38 ) 39 40 result = tools.log_run(['shellcheck', *ctx.paths]) 41 if result.returncode != 0: 42 raise PresubmitFailure('Shellcheck identifed issues.') 43