[Git-commits] [grml/grml-scripts] cb8ed9: Add Code testing workflow
Darshaka Pathirana
noreply at github.com
Fri May 6 12:22:01 CEST 2022
Branch: refs/heads/mika/pr_11
Home: https://github.com/grml/grml-scripts
Commit: cb8ed979c962c8f81b6ffe4334ae792aad256423
https://github.com/grml/grml-scripts/commit/cb8ed979c962c8f81b6ffe4334ae792aad256423
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
A .github/workflows/tests.yml
A Makefile
Log Message:
-----------
Add Code testing workflow
Implement code testing by running shellcheck against shell scripts,
flake8, isort + black against python scripts and spellintian against
man pages.
Codecheck can be executed via 'make codecheck'.
Spellcheck can be executed via 'make spellcheck'.
The Github Workflow is heavily inspired by the workflow of
sipwise/ngcpcfg make by @mika (Thx!).
'make help' is inspired by
https://www.thapaliya.com/en/writings/well-documented-makefiles/
by @suvash (Thx!)
Commit: cf233a10facfa3c4b78b2c01edb51449d73c4a1c
https://github.com/grml/grml-scripts/commit/cf233a10facfa3c4b78b2c01edb51449d73c4a1c
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_bin/grml-exec-wrapper
Log Message:
-----------
usr_bin/grml-exec-wrapper: Fix a couple of shellcheck warnings
- SC2059: Don't use variables in the printf format string.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
Please note that SC2059 causes SC1117 (Backslash is literal in "\n".
Prefer explicit escaping: "\\n") in shellcheck 0.5.0 an below.
This check was retired due to noise in koalaman/shellcheck at d8a32da07.
Commit: c6fa5b9b1a99cfd42fd9aa2c2ce465321f7845af
https://github.com/grml/grml-scripts/commit/c6fa5b9b1a99cfd42fd9aa2c2ce465321f7845af
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M Makefile
M usr_bin/grml-lang
Log Message:
-----------
usr_bin/grml-lang: Fix a couple of shellcheck warnings
- SC2034: PN appears unused. Verify use (or export if used externally).
- SC2086: Double quote to prevent globbing and word splitting.
- Ignore SC1091: Not following: /etc/grml/language-functions was not specified as input (see shellcheck -x).
SC1117 was retired due to noise in koalaman/shellcheck at d8a32da07.
Commit: e8b2d94100ec2a5fc5612bc63dc461b74061520b
https://github.com/grml/grml-scripts/commit/e8b2d94100ec2a5fc5612bc63dc461b74061520b
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_bin/grml-lock
Log Message:
-----------
usr_bin/grml-lock: Fix a couple of shellcheck warnings
- SC2086: Double quote to prevent globbing and word splitting.
- Ignore SC1091
- SC2230: which is non-standard. Use builtin 'command -v' instead
- SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?
Commit: 4771fd182a04f38e6ca37c22c3dda04eedb4d8e1
https://github.com/grml/grml-scripts/commit/4771fd182a04f38e6ca37c22c3dda04eedb4d8e1
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_bin/grml-resolution
Log Message:
-----------
usr_bin/grml-resolution: Fix a couple of shellscript warnings
- Ignore SC2086: dialog needs $STRING to be splitted, so that the values
are listed in the menu
- SC2120: bailout references arguments, but none are ever passed
- Ignore SC2015: Note that A && B || C is not if-then-else.
C may run when A is true
Commit: e41ddb1a1f5abf996258b83ed5f1d12d0ee88da7
https://github.com/grml/grml-scripts/commit/e41ddb1a1f5abf996258b83ed5f1d12d0ee88da7
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M Makefile
Log Message:
-----------
Makefile: Do not shellcheck iimage
iimage is not developed by the Grml-Team but causes a lot of shellcheck warnings.
While at it also ignore SC1117 for all scripts because
the check has been retired in shellcheck v0.5+.
Commit: 6f0b926f0885ead82fa4e43856f85825c245241e
https://github.com/grml/grml-scripts/commit/6f0b926f0885ead82fa4e43856f85825c245241e
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_bin/iso-term
Log Message:
-----------
usr_bin/iso-term: Fix a couple of shellcheck warnings
- SC2006: Use $(..) instead of legacy `..`.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2048: Use "$@" (with quotes) to prevent whitespace problems.
- SC2086: Double quote to prevent globbing and word splitting.
While at it also put the execution of x-terminal-emulator out of the
if-then-else clause to avoid duplicate code.
Commit: 2980f79718344ea7bbb6093beb9b6bac49b5566d
https://github.com/grml/grml-scripts/commit/2980f79718344ea7bbb6093beb9b6bac49b5566d
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_bin/random-hostname
Log Message:
-----------
usr_bin/random-hostname: Fix a couple of shellcheck warnings
- Ignore SC2034: hostnames appears unused. Verify use (or export if used externally).
While at it I rewrote the way how the random hostname is retrieved:
First find the line number 3 lines after the line which starts with "# EOF"
This is the line where the list of hostnames start.
This makes the script a bit more robust and avoids the hard coded start
line calculation ("num=$(( $num - 16 ))").
Then list all lines from there by excluding all empty commented out
lines and the last line (which start with "'").
Use "sort -R" to randomly sort the list and from there take the last line.
That way the confusing "randline" variable calculation is avoided.
Commit: 659b97f184a8d652ba94fe47cd185f19f5c0b233
https://github.com/grml/grml-scripts/commit/659b97f184a8d652ba94fe47cd185f19f5c0b233
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_bin/soundtest
Log Message:
-----------
usr_bin/soundtest: Fix a couple of shellcheck warnings
- SC2046: Quote this to prevent word splitting.
- SC2230: which is non-standard. Use builtin 'command -v' instead.
Commit: 5d1287bc97c72e387c7cef4840d8c211504becd1
https://github.com/grml/grml-scripts/commit/5d1287bc97c72e387c7cef4840d8c211504becd1
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/blacklist
Log Message:
-----------
usr_sbin/blacklist: Fix couple of shellcheck warnings:
- SC2086: Double quote to prevent globbing and word splitting.
- Ignore SC1091: Not following: /etc/grml/lsb-functions was not specified as input (see shellcheck -x).
Commit: 96f6cc16f2a585d52dbc92273c90d686c4d7bb9b
https://github.com/grml/grml-scripts/commit/96f6cc16f2a585d52dbc92273c90d686c4d7bb9b
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/dirvish-setup
Log Message:
-----------
usr_sbin/dirvish-setup: Fix some shellcheck warnings
- Ignore SC1091: Not following: /etc/grml/script-functions was not specified as input (see shellcheck -x).
- Ignore SC1091: Not following: /etc/grml/lsb-functions was not specified as input (see shellcheck -x).
- SC2046: Quote this to prevent word splitting.
- SC2006: Use $(..) instead of legacy `..`.
- Ignore SC1090: Can't follow non-constant source. Use a directive to specify location.
- SC2046: Quote this to prevent word splitting.
- SC2006: Use $(..) instead of legacy `..`.
- SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
- SC2046: Quote this to prevent word splitting.
- SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
Commit: 3ace1004ef0f658043f2645c46818d92ad66c0dc
https://github.com/grml/grml-scripts/commit/3ace1004ef0f658043f2645c46818d92ad66c0dc
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/grml2ram
Log Message:
-----------
usr_sbin/grml2ram: Fix a couple of shellcheck warnings
- Ignore SC1091: Not following: /etc/grml/lsb-functions was not specified as input (see shellcheck -x).
- Ignore SC1091: Not following: /etc/grml/script-functions was not specified as input (see shellcheck -x).
- Set interpreter to /bin/bash because of SC2039: In POSIX sh, 'local' is undefined.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2061: Quote the parameter to -name so the shell won't interpret it.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2015: Note that A && B || C is not if-then-else. C may run when A is true.
Commit: b4a4893b0b69207eb9189a0be857a64173c09275
https://github.com/grml/grml-scripts/commit/b4a4893b0b69207eb9189a0be857a64173c09275
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/grml-chroot
Log Message:
-----------
usr_sbin/grml-chroot: Fix a couple of shellcheck warnings
- SC2086: Double quote to prevent globbing and word splitting.
- SC2145: Argument mixes string and array. Use * or separate argument.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2155: Declare and assign separately to avoid masking return values.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2004: $/${} is unnecessary on arithmetic variables.
- SC2230: which is non-standard. Use builtin 'command -v' instead.
- SC2236: Use -n instead of ! -z.
Commit: eb97848aaf700ab117306609bfe3fe62280953c2
https://github.com/grml/grml-scripts/commit/eb97848aaf700ab117306609bfe3fe62280953c2
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/grml-config-root
Log Message:
-----------
usr_sbin/grml-config-root: Fix a couple of shellcheck warnings
- SC2006: Use $(..) instead of legacy `..`.
- SC2230: which is non-standard. Use builtin 'command -v' instead.
- SC2086: Double quote to prevent globbing and word splitting.
Commit: 4f3413a694cd23d7c5d397d698402f5088131ae2
https://github.com/grml/grml-scripts/commit/4f3413a694cd23d7c5d397d698402f5088131ae2
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/grml-hostname
Log Message:
-----------
usr_sbin/grml-hostname: Fix a couple of shellcheck warnings
- Ignore SC1091: Not following: /etc/grml/script-functions was not specified as input (see shellcheck -x).
- SC1117: Backslash is literal in "\n". Prefer explicit escaping: "\\n".
- SC1117: Backslash is literal in "\n". Prefer explicit escaping: "\\n".
- SC2086: Double quote to prevent globbing and word splitting.
- Ignore SC1117: Backslash is literal in "\(". Prefer explicit escaping: "\\(".
- Ignore SC1117: Backslash is literal in "\s". Prefer explicit escaping: "\\s".
- Ignore SC1117: Backslash is literal in "\)". Prefer explicit escaping: "\\)".
- Ignore SC1117: Backslash is literal in "\1". Prefer explicit escaping: "\\1".
- Ignore SC1117: Backslash is literal in "\(". Prefer explicit escaping: "\\(".
- Ignore SC1117: Backslash is literal in "\s". Prefer explicit escaping: "\\s".
- Ignore SC1117: Backslash is literal in "\)". Prefer explicit escaping: "\\)".
- Ignore SC1117: Backslash is literal in "\1". Prefer explicit escaping: "\\1".
- SC2046: Quote this to prevent word splitting.
Commit: cb015ef1617ac6b6bd171ab08140b11cec9293a4
https://github.com/grml/grml-scripts/commit/cb015ef1617ac6b6bd171ab08140b11cec9293a4
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/grml-iptstate
Log Message:
-----------
usr_sbin/grml-iptstate: Fix a couple of shellcheck warnings
- Ignore SC1091: Not following: /etc/grml/script-functions was not specified as input (see shellcheck -x).
- Ignore SC1091: Not following: /etc/grml/lsb-functions was not specified as input (see shellcheck -x).
- SC2162: read without -r will mangle backslashes.
- SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
Commit: 1c3edd8d6b3415b990943b3a2525c72a53b1056f
https://github.com/grml/grml-scripts/commit/1c3edd8d6b3415b990943b3a2525c72a53b1056f
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/grml-setkeyboard
Log Message:
-----------
usr_sbin/grml-setkeyboard: Fix a couple of shellcheck warnings
- SC2086: Double quote to prevent globbing and word splitting.
- Ignore SC1091: Not following: /etc/grml/script-functions was not specified as input (see shellcheck -x).
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
- Ignore SC1091: Not following: /etc/sysconfig/keyboard was not specified as input (see shellcheck -x).
- Ignore SC1010: Use semicolon or linefeed before 'fi' (or quote to make it literal).
- Ignore SC1091: Not following: /etc/grml/language-functions was not specified as input (see shellcheck -x).
Commit: 206b3e7fea2cff2bd5881b4264190730fe096b2e
https://github.com/grml/grml-scripts/commit/206b3e7fea2cff2bd5881b4264190730fe096b2e
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/grml-setlang
Log Message:
-----------
usr_sbin/grml-setlang: Fix a couple of shellcheck warnings
- SC2086: Double quote to prevent globbing and word splitting.
- SC2034: CMDLINE appears unused. Verify use (or export if used externally).
- Ignore SC1091: Not following: /etc/grml/script-functions was not specified as input (see shellcheck -x).
- Ignore SC1091: Not following: /etc/grml/lsb-functions was not specified as input (see shellcheck -x).
- Ignore SC1117: Backslash is literal in "\#". Prefer explicit escaping: "\\#".
- Ignore SC1091: Not following: /etc/environment was not specified as input (see shellcheck -x).
- Ignore SC1091: Not following: /etc/default/locale was not specified as input (see shellcheck -x).
- Ignore SC1010: Use semicolon or linefeed before 'fi' (or quote to make it literal).
- SC2086: Double quote to prevent globbing and word splitting.
- Ignore SC1090: Can't follow non-constant source. Use a directive to specify location.
- SC2086: Double quote to prevent globbing and word splitting.
Commit: 01aaae6aef011366e62b07730a60e8e382590669
https://github.com/grml/grml-scripts/commit/01aaae6aef011366e62b07730a60e8e382590669
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/grml-setservices
Log Message:
-----------
usr_sbin/grml-setservices: Fix a couple of shellcheck warnings
- SC2086: Double quote to prevent globbing and word splitting.
- Ignore SC1091: Not following: /etc/grml/script-functions was not specified as input (see shellcheck -x).
- Ignore SC1091: Not following: /etc/grml/lsb-functions was not specified as input (see shellcheck -x).
- SC2086: Double quote to prevent globbing and word splitting.
- SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2086: Double quote to prevent globbing and word splitting.
Commit: 584376f90a575f0788beb80c02061ff008f2097e
https://github.com/grml/grml-scripts/commit/584376f90a575f0788beb80c02061ff008f2097e
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M Makefile
Log Message:
-----------
Makefile: Do not shellcheck make_chroot_jail
make_chroot_jail is not developed by the Grml-Team but causes a lot of shellcheck warnings.
Commit: 2cfbb394a8872bd5705a32859d05cfe43dcaeef7
https://github.com/grml/grml-scripts/commit/2cfbb394a8872bd5705a32859d05cfe43dcaeef7
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/noeject
Log Message:
-----------
usr_sbin/noeject: Fix a couple of shellcheck warnings
- SC2048: Use "$@" (with quotes) to prevent whitespace problems.
- SC2086: Double quote to prevent globbing and word splitting.
Commit: 41dd2c5a3e4dff8789a7f6110f70b298f1cd7d2b
https://github.com/grml/grml-scripts/commit/41dd2c5a3e4dff8789a7f6110f70b298f1cd7d2b
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_share/run-welcome
Log Message:
-----------
usr_share/run-welcome: Fix a couple of shellcheck warnings
- Ignore SC1091: Not following: /etc/grml/sh-lib was not specified as input (see shellcheck -x).
- SC2046: Quote this to prevent word splitting.
- SC2230: which is non-standard. Use builtin 'command -v' instead.
- SC2086: Double quote to prevent globbing and word splitting.
- SC2230: which is non-standard. Use builtin 'command -v' instead.
Commit: c766750061a46a42f80ce2b78a8b5b0784767d6d
https://github.com/grml/grml-scripts/commit/c766750061a46a42f80ce2b78a8b5b0784767d6d
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_sbin/noprompt
Log Message:
-----------
usr_sbin/noprompt: Fix a couple of shellcheck warnings
- SC2048: Use "$@" (with quotes) to prevent whitespace problems.
- SC2086: Double quote to prevent globbing and word splitting.
Commit: 98d1b69753568d367f9602c4102e2b984a17d497
https://github.com/grml/grml-scripts/commit/98d1b69753568d367f9602c4102e2b984a17d497
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M usr_share/run-screen
Log Message:
-----------
usr_share/run-screen: Fix a couple of shellcheck warnings
- SC2046: Quote this to prevent word splitting.
- SC2006: Use $(..) instead of legacy `..`.
Commit: 02a237b8633dca400bd1d08f87c24cea30933f92
https://github.com/grml/grml-scripts/commit/02a237b8633dca400bd1d08f87c24cea30933f92
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M .github/workflows/tests.yml
M Makefile
Log Message:
-----------
Makefile: return error if a check fails
Make target pythoncheck (and codecheck) did not fail if the last tested
file was error-free. Now we set RETURN=1 if only one check fails.
While at it also created separate targets for flake8, black and isort,
but also added --keep-going option when running 'make codecheck' so that all
targets are run.
Added @ in front of each command to hide the command which makes the
output more readable.
Spellcheck SC1117 (Backslash is literal in "\n") is no longer emitted
(with shellcheck after v0.5), thats why it is removed.
Please note, that spellintian does not return an error code if an
incorrect spelling is found, that is why this ugly hack had to be
implemented.
Commit: 95f1a389296e098bfd40ad9bbf05f795de3b6440
https://github.com/grml/grml-scripts/commit/95f1a389296e098bfd40ad9bbf05f795de3b6440
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M manpages/grml-swapon.8
Log Message:
-----------
grml-swapon.8: Fix spelling (via spellintian)
Commit: a4b7aa61ed1e89cae05d079a44e520658323e927
https://github.com/grml/grml-scripts/commit/a4b7aa61ed1e89cae05d079a44e520658323e927
Author: Darshaka Pathirana <dpat at syn-net.org>
Date: 2021-12-03 (Fri, 03 Dec 2021)
Changed paths:
M Makefile
M usr_bin/grepedit
M usr_bin/notifyd.py
Log Message:
-----------
grepedit/notifyd.py: Convert to Python 3
Run the following commands:
% 2to3-2.7 -w usr_bin/grepedit
% isort usr_bin/grepedit
% black usr_bin/grepedit
In grepedit the following print statement has been split manually:
+ print(
+ "%s:%s has changed since the grep command ran- "
+ "not modifying this line" % key
+ )
And:
% 2to3-2.7 -w usr_bin/notifyd.py
% black usr_bin/notifyd.py
% isort usr_bin/notifyd.py
In notifyd.py added some ignore statements/comments (for the examples
which were actually comments).
The following errors/warnings were fixed manually:
❯ flake8 --max-line-length 88 usr_bin/notifyd.py
usr_bin/notifyd.py:201:1: E741 ambiguous variable name 'l'
usr_bin/notifyd.py:214:5: E722 do not use bare 'except'
Variable 'l' has been renamed to 'listen' and the bare 'except' has been
changed to catch 'OSError' as described in the socket documentation:
https://docs.python.org/3/library/socket.html
grepedit + notifyd.py + osd_server.py has not been functionally tested.
Please test. (But this is not the scope of this change, as it had to be
dropped anyway as it is missing Python 3 support. If an errors occurs,
please file a bug report.)
black defaults to line length 88 and flake to 79.
Decided to go set --max-line-length 88 for flake8.
Note that osd_server.py is just a symlink to notifyd.py.
Compare: https://github.com/grml/grml-scripts/compare/cb8ed979c962%5E...a4b7aa61ed1e
More information about the Git-commits
mailing list