[Notes] [Git][BuildStream/buildstream][jonathan/junction-no-tmpdir] Remove cleanup functionality from loader

[Jonathan Maw <gitlab mg gitlab com>]

Title: GitLab

Jonathan Maw pushed to branch jonathan/junction-no-tmpdir at BuildStream / buildstream

Commits:

• 42c9ca04
  by Jonathan Maw at 2019-02-11T10:28:09Z

  Remove cleanup functionality from loader
  
  Since junction check-outs are now persistent, there is no need to clean
  up temporary directories once finished.
  Now, junction checkouts are stored within the top-level project dir and
  will be cleaned-up when that directory is removed.
  
  This involves changes in:
  * loader.py: Remove cleanup logic and passing-around of tmpdir.
  * _project.py: Remove passing around tmpdir and calling loader's
                 cleanup.
  

2 changed files:

• buildstream/_loader/loader.py
• buildstream/_project.py

Changes:

buildstream/_loader/loader.py

---

...	...	@@ -20,8 +20,6 @@
20	20	import os
21	21	from functools import cmp_to_key
22	22	from collections.abc import Mapping
23		-import tempfile
24		-import shutil
25	23
26	24	from .._exceptions import LoadError, LoadErrorReason
27	25	from .. import Consistency
...	...	@@ -49,12 +47,10 @@ from .._message import Message, MessageType
49	47	# context (Context): The Context object
50	48	# project (Project): The toplevel Project object
51	49	# parent (Loader): A parent Loader object, in the case this is a junctioned Loader
52		-# tempdir (str): A directory to cleanup with the Loader, given to the loader by a parent
53		-# loader in the case that this loader is a subproject loader.
54	50	#
55	51	class Loader():
56	52
57		- def __init__(self, context, project, *, parent=None, tempdir=None):
	53	+ def __init__(self, context, project, *, parent=None):
58	54
59	55	# Ensure we have an absolute path for the base directory
60	56	basedir = project.element_path
...	...	@@ -73,7 +69,6 @@ class Loader():
73	69	self._options = project.options # Project options (OptionPool)
74	70	self._basedir = basedir # Base project directory
75	71	self._first_pass_options = project.first_pass_config.options # Project options (OptionPool)
76		- self._tempdir = tempdir # A directory to cleanup
77	72	self._parent = parent # The parent loader
78	73
79	74	self._meta_elements = {} # Dict of resolved meta elements by name
...	...	@@ -159,30 +154,6 @@ class Loader():
159	154
160	155	return ret
161	156
162		- # cleanup():
163		- #
164		- # Remove temporary checkout directories of subprojects
165		- #
166		- def cleanup(self):
167		- if self._parent and not self._tempdir:
168		- # already done
169		- return
170		-
171		- # recurse
172		- for loader in self._loaders.values():
173		- # value may be None with nested junctions without overrides
174		- if loader is not None:
175		- loader.cleanup()
176		-
177		- if not self._parent:
178		- # basedir of top-level loader is never a temporary directory
179		- return
180		-
181		- # safe guard to not accidentally delete directories outside builddir
182		- if self._tempdir.startswith(self._context.builddir + os.sep):
183		- if os.path.exists(self._tempdir):
184		- shutil.rmtree(self._tempdir)
185		-
186	157	###########################################
187	158	# Private Methods #
188	159	###########################################
...	...	@@ -544,11 +515,9 @@ class Loader():
544	515	if workspace:
545	516	# If a workspace is open, load it from there instead
546	517	basedir = workspace.get_absolute_path()
547		- tempdir = None
548	518	elif len(sources) == 1 and sources[0]._get_local_path():
549	519	# Optimization for junctions with a single local source
550	520	basedir = sources[0]._get_local_path()
551		- tempdir = None
552	521	else:
553	522	# Stage sources
554	523	element._update_state()
...	...	@@ -557,14 +526,13 @@ class Loader():
557	526	if not os.path.exists(basedir):
558	527	os.makedirs(basedir, exist_ok=True)
559	528	element._stage_sources_at(basedir, mount_workspaces=False)
560		- tempdir = None
561	529
562	530	# Load the project
563	531	project_dir = os.path.join(basedir, element.path)
564	532	try:
565	533	from .._project import Project
566	534	project = Project(project_dir, self._context, junction=element,
567		- parent_loader=self, tempdir=tempdir)
	535	+ parent_loader=self)
568	536	except LoadError as e:
569	537	if e.reason == LoadErrorReason.MISSING_PROJECT_CONF:
570	538	raise LoadError(reason=LoadErrorReason.INVALID_JUNCTION,

buildstream/_project.py

---

...	...	@@ -91,7 +91,7 @@ class ProjectConfig:
91	91	class Project():
92	92
93	93	def __init__(self, directory, context, *, junction=None, cli_options=None,
94		- default_mirror=None, parent_loader=None, tempdir=None):
	94	+ default_mirror=None, parent_loader=None):
95	95
96	96	# The project name
97	97	self.name = None
...	...	@@ -147,7 +147,7 @@ class Project():
147	147	self._project_includes = None
148	148
149	149	profile_start(Topics.LOAD_PROJECT, self.directory.replace(os.sep, '-'))
150		- self._load(parent_loader=parent_loader, tempdir=tempdir)
	150	+ self._load(parent_loader=parent_loader)
151	151	profile_end(Topics.LOAD_PROJECT, self.directory.replace(os.sep, '-'))
152	152
153	153	self._partially_loaded = True
...	...	@@ -389,8 +389,6 @@ class Project():
389	389	# Cleans up resources used loading elements
390	390	#
391	391	def cleanup(self):
392		- self.loader.cleanup()
393		-
394	392	# Reset the element loader state
395	393	Element._reset_load_state()
396	394
...	...	@@ -439,7 +437,7 @@ class Project():
439	437	#
440	438	# Raises: LoadError if there was a problem with the project.conf
441	439	#
442		- def _load(self, parent_loader=None, tempdir=None):
	440	+ def _load(self, parent_loader=None):
443	441
444	442	# Load builtin default
445	443	projectfile = os.path.join(self.directory, _PROJECT_CONF_FILE)
...	...	@@ -505,8 +503,7 @@ class Project():
505	503	self._fatal_warnings = _yaml.node_get(pre_config_node, list, 'fatal-warnings', default_value=[])
506	504
507	505	self.loader = Loader(self._context, self,
508		- parent=parent_loader,
509		- tempdir=tempdir)
	506	+ parent=parent_loader)
510	507
511	508	self._project_includes = Includes(self.loader, copy_tree=False)
512	509

—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. If you'd like to receive fewer emails, you can adjust your notification settings.