cloud-init profile.d files use bash-specific builtin "local"

[Merlie Allen]

/etc/profile, which is read by the Bourne-like shells (including ksh),
runs the scripts in /etc/profile.d. The scripts from the cloud-init
package Z99-cloudinit-warnings.sh and Z99-cloud-locale-test.sh
use the bash-builtin "local" which is not recognized by ksh resulting
in these errors at login:

/etc/profile[23]: .[141]: local: not found [No such file or directory]
/etc/profile[23]: .[142]: local: not found [No such file or directory]
/etc/profile[23]: .[143]: local: not found [No such file or directory]
/etc/profile[23]: .[178]: local: not found [No such file or directory]
/etc/profile[23]: .[179]: local: not found [No such file or directory]

$ grep -n local\ Z99*
Z99-cloudinit-warnings.sh:7: local warning="" idir="/var/lib/cloud/instance" n=0
Z99-cloudinit-warnings.sh:8: local warndir="$idir/warnings"
Z99-cloudinit-warnings.sh:9: local ufile="$HOME/.cloud-warnings.skip" sfile="$warndir/.skip"
Z99-cloud-locale-test.sh:14: local bad_names="" bad_lcs="" key="" val="" var="" vars="" bad_kv=""
Z99-cloud-locale-test.sh:15: local w1 w2 w3 w4 remain
Z99-cloud-locale-test.sh:56: local bad invalid="" to_gen="" sfile="/usr/share/i18n/SUPPORTED"
Z99-cloud-locale-test.sh:57: local pkgs=""
Z99-cloud-locale-test.sh:70: local pkgs=""

ProblemType: Bug
DistroRelease: Ubuntu 18.04
Package: cloud-init 18.2-27-g6ef92c98-0ubuntu1~18.04.1
ProcVersionSignature: Ubuntu 4.15.0-29.31-generic 4.15.18
Uname: Linux 4.15.0-29-generic x86_64
ApportVersion: 2.20.9-0ubuntu7.2
Architecture: amd64
CloudName: Other
Date: Tue Jul 31 20:04:30 2018
PackageArchitecture: all
ProcEnviron:
 TERM=xterm
 PATH=(custom, no user)
 XDG_RUNTIME_DIR=<set>
 LANG=en_US.UTF-8
 SHELL=/bin/ksh
SourcePackage: cloud-init
UpgradeStatus: No upgrade log present (probably fresh install)

[Scott Moser (smoser)]

Can you test if this works?

http://paste.ubuntu.com/p/wyPPhjRRzP/

[Scott Moser (smoser)]

@Merlie,
could you please test the attached merge proposal and report if it works?

[Server Team CI bot (server-team-bot)]

This bug is fixed with commit 538af8e6 to cloud-init on branch master.
To view that commit see the following URL:
https://git.launchpad.net/cloud-init/commit/?id=538af8e6

[Scott Moser (smoser)]

This bug is believed to be fixed in cloud-init in version 18.4. If this is still a problem for you, please make a comment and set the state back to New

Thank you.

[Eli the Bearded (ubuntu-34)]

$ apt list --installed 2>&1 | grep -E '^(cloud-init|ksh)/'
cloud-init/focal-updates,now 21.2-3-g899bfaa9-0ubuntu2~20.04.1 all [installed]
ksh/focal,now 2020.0.0-5 amd64 [installed]
$ echo $SHELL
/bin/ksh
$ . /etc/profile.d/Z99-cloud-locale-test.sh
-ksh: .[14]: local: local can only be used in a function
$ . /etc/profile.d/Z99-cloudinit-warnings.sh
-ksh: .[7]: local: local can only be used in a function
$

These produce warnings, although with slightly different sources named, when run by ksh via /etc/profile at login on 20.04.3 LTS.

[Scott Moser (smoser)]

@Eli,

I can recreate your problem, but it looks to me like a bug in ksh. ksh complains that 'local can only be used in a function, when as shown below it *is* being used in a function.'

My suggestion is to file a bug with ksh2020.

root@focal1:~# ksh -c 'foo() { local a=1; echo $?; }; foo'
ksh: local: local can only be used in a function
1

root@focal1:~# ksh2020 -c 'foo() { local a; echo $?; }; foo'
ksh2020: local: local can only be used in a function
1

also oddly, ksh seems to report itself in '$SHELL' as /bin/sh.

root@focal1:~# /usr/bin/ksh2020 -c 'foo() { local a=1; echo $?; }; echo $SHELL; foo'
/bin/sh
/usr/bin/ksh2020: local: local can only be used in a function
1

[Guillaume (e1msih)]

It isn't fixed for ubuntu 18.04 :

# dpkg -l cloud-init | grep cloud
ii cloud-init 22.2-0ubuntu1~18.04.3 all Init scripts for cloud instances

With an user having ksh as shell :
su: /etc/profile.d/Z99-cloud-locale-test.sh[100]: local: not found
su: /etc/profile.d/Z99-cloud-locale-test.sh[100]: local: not found
su: /etc/profile.d/Z99-cloudinit-warnings.sh[29]: local: not found
su: /etc/profile.d/Z99-cloudinit-warnings.sh[29]: local: not found
su: /etc/profile.d/Z99-cloudinit-warnings.sh[29]: local: not found

[James Falcon (falcojr)]

Tracked in Github Issues as https://github.com/canonical/cloud-init/issues/3217