test/lint/lint-shell.sh to Python and updates the docs accordingly. In order for the linter to run, it requires git and the shellcheck linter to be installed on the system. The script will fail gracefully with a help message if shellcheck is not installed.
81+ shellcheck_cmd.extend(guix_files)
82+ shellcheck_cmd.extend(files)
83+
84+ # run the `shellcheck` command
85+ try:
86+ subprocess.check_output(shellcheck_cmd, stderr=subprocess.STDOUT)
check=True
Thanks for the review. :)
I believe this might introduce slightly different behavior with output from the old script.
With the old script there would be no output if the shellcheck tests pass, but while using subprocess.run(shellcheck_cmd, check=True), I see the following if the tests pass:
0$ ./test/lint/lint-shell.py
1ShellCheck - shell script analysis tool
2version: 0.8.0
3license: GNU General Public License, version 3
4website: https://www.shellcheck.net
The exit codes still work the same, but are there downstream impacts with this standard output change?
subprocess.run is to add stdout = subprocess.DEVNULL argument.
check_shellcheck_install() function. I piped the output from that command to subprocess.DEVNULL. Thanks for the suggestion, @Eunoia1729.
0@@ -0,0 +1,92 @@
1+#!/usr/bin/env python3
2+#
3+# Copyright (c) 2018-2021 The Bitcoin Core developers
0# Copyright (c) 2018-2022 The Bitcoin Core developers
15+ 'SC2162', # read without -r will mangle backslashes.
16+]
17+
18+def check_shellcheck_install():
19+ try:
20+ subprocess.check_output(['shellcheck', '--version'])
subprocess.run with check = True can be used here
I noticed that terminal colors are being removed by the Python script. I did spend a little time trying to figure out how to pass along terminal colors, but wasn’t successful. Let me know if I need to spend more time figuring that out.
As an example, here’s what it looks like with the bash script:
Here’s what the same output looks like with the Python script:
I tried using the encoding parameter (setting it to encoding='utf-8', but that didn’t work.
81+ shellcheck_cmd.extend(guix_files)
82+ shellcheck_cmd.extend(files)
83+
84+ # run the `shellcheck` command
85+ try:
86+ subprocess.run(shellcheck_cmd, capture_output=True, check=True, universal_newlines=True)
0 subprocess.check_output(shellcheck_cmd, universal_newlines=True)
How is this different from check_output? Also, capture_output is python 3.7, while our minimum is 3.6.
I think I need a little help squashing my commits in this pull request. Because in commit e38fc1c816a1e83b943cad2ffc953be5b2cd1fb6 I merged in from master, I’m now getting some merge conflicts while I squash.
Here’s what I’m doing:
HEAD, my first commit is 59 commits ago: git rev-list 24ac00b042a3f0343be95d283d90eb5d6579b629..HEAD | wc -lgit rebase -i HEAD~59 and change all the picks (except the first one) to squash.:wq (vim) and git begins rebasing.About halfway thru I get a bunch of merge conflicts. Any help is appreciated. Thanks.
untested:
0git checkout your_branch
1git fetch origin bd616bc16a3a7f70f60ca5034b5a91e5ac89ac9d # fetch current master
2git merge bd616bc16a3a7f70f60ca5034b5a91e5ac89ac9d # merge current master
3git reset --soft bd616bc16a3a7f70f60ca5034b5a91e5ac89ac9d # pretend all changes happened on current master
4git commit -m "your commit message" # commit the changes
5git push origin your_branch -f # Force push
Maybe we should mention those steps as well in the doc?
Maybe we should mention those steps as well in the doc?
We could. Though only as a last-ditch option if you’ve ended up with a mess of merge commits. git rebase -i is way more flexible and something people need to be comfortable with to contribute to this project.
git rebase. I do admit to be a bit of a novice at that git command. Thank you for the help.
6+
7+"""
8+Check for shellcheck warnings in shell scripts.
9+"""
10+
11+import subprocess, re, sys
81+ shellcheck_cmd.extend(guix_files)
82+ shellcheck_cmd.extend(files)
83+
84+ # run the `shellcheck` command
85+ try:
86+ subprocess.check_output(shellcheck_cmd, universal_newlines=True)
encoding="utf8" to subprocess.check_output to satisfy lint check
86+ # run the `shellcheck` command
87+ try:
88+ subprocess.check_output(shellcheck_cmd, universal_newlines=True, encoding='utf8')
89+ except subprocess.CalledProcessError as e:
90+ print(e.output)
91+ sys.exit(1)
0 subprocess.check_call(shellcheck_cmd)
1 except subprocess.CalledProcessError as e:
2 sys.exit(1)
Shouldn’t this be check_call? This would also fix the terminal color issue, maybe?
84+ shellcheck_cmd.extend(files)
85+
86+ # run the `shellcheck` command
87+ try:
88+ subprocess.check_call(shellcheck_cmd)
89+ except subprocess.CalledProcessError as e: