public inbox for gentoo-catalyst@lists.gentoo.org
 help / color / mirror / Atom feed
From: Felix Bier <Felix.Bier@rohde-schwarz.com>
To: "gentoo-catalyst@lists.gentoo.org" <gentoo-catalyst@lists.gentoo.org>
Subject: [gentoo-catalyst] Re: [PATCH 1/2] Ensure deep copying of config defaults
Date: Sun, 18 Oct 2020 15:12:41 +0000	[thread overview]
Message-ID: <4de1aa0c362394a606752503533b2346ffabff2e.camel@rohde-schwarz.com> (raw)
In-Reply-To: <65e99c4f47f284937ab5b4acc4b10b999b44b0cf.camel@rohde-schwarz.com>

This commit adds deep copying operations when initializing config
objects from a default config. This prevents the config from being
a shallow copy of the default, ensuring that modifications to the
config do not modify the default.

In particular, this fixes a check in write_make_conf, where the PORTDIR
variable is only written to the generated make.conf when a non-default
repo_basedir is set in /etc/catalyst/catalyst.conf. This check is never
satisfied, because confvalues is a shallow copy of confdefaults,
therefore both will always hold the same value for repo_basedir.

For self.mounts / MOUNT_DEFAULTS this problem can also be observed, the
modifications done to self.mounts are also visible in MOUNT_DEFAULTS.
I am not aware of any bugs due to this shallow copy, but I would prefer
adding a deep copy to prevent future bugs, in case a comparision
against the default mounts is ever needed.
---
 catalyst/base/stagebase.py | 3 ++-
 catalyst/main.py           | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/catalyst/base/stagebase.py b/catalyst/base/stagebase.py
index df1cb844..ac0f4f24 100644
--- a/catalyst/base/stagebase.py
+++ b/catalyst/base/stagebase.py
@@ -1,4 +1,5 @@
 
+import copy
 import os
 import platform
 import shutil
@@ -183,7 +184,7 @@ class StageBase(TargetBase, ClearBase, GenBase):
             file_locate(self.settings, ["portage_confdir"], expand=0)
 
         # Setup our mount points.
-        self.mount = MOUNT_DEFAULTS.copy()
+        self.mount = copy.deepcopy(MOUNT_DEFAULTS)
 
         self.mount['portdir']['source'] = self.snapshot
         self.mount['portdir']['target'] = self.settings['repo_basedir'] + '/' + self.settings['repo_name']
diff --git a/catalyst/main.py b/catalyst/main.py
index 543895c6..8e0bc5fb 100644
--- a/catalyst/main.py
+++ b/catalyst/main.py
@@ -1,4 +1,5 @@
 import argparse
+import copy
 import datetime
 import hashlib
 import os
@@ -20,7 +21,7 @@ from catalyst.defaults import (confdefaults, option_messages,
 from catalyst.support import CatalystError
 from catalyst.version import get_version
 
-conf_values = confdefaults
+conf_values = copy.deepcopy(confdefaults)
 
 
 def version():
-- 
2.28.0


  reply	other threads:[~2020-10-18 15:12 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-17 18:47 [gentoo-catalyst] [PATCH 1/2] Ensure deep copying of config defaults Felix Bier
2020-10-18 15:12 ` Felix Bier [this message]
2020-10-30 15:56   ` [gentoo-catalyst] " Matt Turner
2020-11-10  0:59     ` [Newsletter] " Felix Bier

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=4de1aa0c362394a606752503533b2346ffabff2e.camel@rohde-schwarz.com \
    --to=felix.bier@rohde-schwarz.com \
    --cc=gentoo-catalyst@lists.gentoo.org \
    /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