From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>,
Folke Gleumes <f.gleumes@proxmox.com>
Subject: Re: [pve-devel] [PATCH container v2 2/2] pct: add keep-env option
Date: Fri, 2 Feb 2024 17:53:24 +0100 [thread overview]
Message-ID: <9e65cabe-9251-4b3c-b8ad-c761df5cca0a@proxmox.com> (raw)
In-Reply-To: <20240129154318.682297-2-f.gleumes@proxmox.com>
Am 29/01/2024 um 16:43 schrieb Folke Gleumes:
> The keep-env option allows the user to define if the current environment
> should be kept when running 'pct enter/exec'. pct will now always set
> '--keep-env' or '--discard-env' when calling lxc-attach to anticipate
> the upcoming change in default behavior.
seems fine in general, but I saw a two code style nits, of which one I'd
really like to avoid, see comment in line.
>
> Signed-off-by: Folke Gleumes <f.gleumes@proxmox.com>
> ---
> This wasn't present in v1
>
> src/PVE/CLI/pct.pm | 22 ++++++++++++++++++++--
> 1 file changed, 20 insertions(+), 2 deletions(-)
>
> diff --git a/src/PVE/CLI/pct.pm b/src/PVE/CLI/pct.pm
> index 091ac8e..7ce0de0 100755
> --- a/src/PVE/CLI/pct.pm
> +++ b/src/PVE/CLI/pct.pm
> @@ -162,12 +162,21 @@ __PACKAGE__->register_method ({
> additionalProperties => 0,
> properties => {
> vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid_running }),
> + # TODO: set keep-env to default false with PVE 9
no hard feelings for thiss one, but could be a better fit if located in the
default line, which would be the one that will be changed, e.g.:
default => 1, # TODO: make keep-env opt-out here and in the code with PVE 9
or before with even more context, something like:
# FIXME: passing the environment in CT is really not ideal, it can leak secrets or cause
# programs to do behave weird, so change to opt-in in PVE 9
Having some more context about the reasoning can be good for such comments
(or at least the commit message), even if it should be relatively clear,
like here.
> + 'keep-env' => {> + type => 'boolean',
> + description => "Keep the current environment. This option will disabled by default with PVE 9. "
nit: for line continuations the next line should hold the space, that way
one can add or remove sentences more likely without touching other unrelated
lines. As example for here:
description => "Keep the current environment. This option will disabled by default with PVE 9."
." If you rely on a preserved environment, please use this option to be future-proof."
But would not have blocked applying just because of this, so mostly mentioning it
due to writing a reply anyway.
> + ."If you rely on a preserved environment, please use this option to be future-proof.",
> @@ -175,7 +184,7 @@ __PACKAGE__->register_method ({
> die "container '$vmid' not running!\n" if !PVE::LXC::check_running($vmid);
>
> clean_environment();
> - exec('lxc-attach', '-n', $vmid);
> + exec('lxc-attach', $keep_env ? '--keep-env' : '--clear-env', '-n', $vmid);
I'd prefer to avoid such "hidden" ternaries inside other statements, that makes
the code unnecessarily hard to read without much gain.
While it makes it longer, having this split over a few line seems a bit nicer, e.g.
something like (untested):
my @lxc_attach_cmd = ('lxc-attach', '-n', $vmid);
push @lxc_attach_cmd, $keep_env ? '--keep-env' : '--clear-env';
exec(@lxc_attach_cmd);
> }});
>
> __PACKAGE__->register_method ({
> @@ -187,12 +196,21 @@ __PACKAGE__->register_method ({
> additionalProperties => 0,
> properties => {
> vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid_running }),
> + # TODO: set keep-env to default false with PVE 9
> + 'keep-env' => {
> + type => 'boolean',
> + description => "Keep the current environment. This option will disabled by default with PVE 9. "
same here w.r.t. trailing space for literal string continuation
> + ."If you rely on a preserved environment, please use this option to be future-proof.",
> + optional => 1,
> + default => 1,
> + },
> 'extra-args' => get_standard_option('extra-args'),
> },
> },
> returns => { type => 'null' },
> code => sub {
> my ($param) = @_;
> + my $keep_env = $param->{'keep-env'} // 1; # TODO: toggle with pve 9
>
> my $vmid = $param->{vmid};
> PVE::LXC::Config->load_config($vmid); # test if container exists on this node
> @@ -201,7 +219,7 @@ __PACKAGE__->register_method ({
> die "missing command" if !@{$param->{'extra-args'}};
>
> clean_environment();
> - exec('lxc-attach', '-n', $vmid, '--', @{$param->{'extra-args'}});
> + exec('lxc-attach', $keep_env ? '--keep-env' : '--clear-env', '-n', $vmid, '--', @{$param->{'extra-args'}});
same here w.r.t. ternary, gets a bit unwieldy
> }});
>
> __PACKAGE__->register_method ({
next prev parent reply other threads:[~2024-02-02 16:53 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-29 15:43 [pve-devel] [PATCH container v2 1/2] fix #5194: pct: delete environment variables set by pve Folke Gleumes
2024-01-29 15:43 ` [pve-devel] [PATCH container v2 2/2] pct: add keep-env option Folke Gleumes
2024-02-02 16:53 ` Thomas Lamprecht [this message]
2024-02-09 13:17 ` [pve-devel] [PATCH container v3] " Folke Gleumes
2024-02-09 19:07 ` [pve-devel] applied: [PATCH container v2 2/2] " Thomas Lamprecht
2024-02-02 16:32 ` [pve-devel] applied: [PATCH container v2 1/2] fix #5194: pct: delete environment variables set by pve Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=9e65cabe-9251-4b3c-b8ad-c761df5cca0a@proxmox.com \
--to=t.lamprecht@proxmox.com \
--cc=f.gleumes@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox