[gentoo-portage-dev] [PATCH v2] Add an emaint module that can scan for failed merges and that can fix failed merges.

[Pavel Kazakov]

---
 pym/portage/emaint/main.py                    |   6 +-
 pym/portage/emaint/modules/merges/__init__.py |  19 ++++
 pym/portage/emaint/modules/merges/merges.py   | 121 ++++++++++++++++++++++++++
 3 files changed, 144 insertions(+), 2 deletions(-)
 create mode 100644 pym/portage/emaint/modules/merges/__init__.py
 create mode 100644 pym/portage/emaint/modules/merges/merges.py

diff --git a/pym/portage/emaint/main.py b/pym/portage/emaint/main.py
index a03ffd7..c1e0c0b 100644
--- a/pym/portage/emaint/main.py
+++ b/pym/portage/emaint/main.py
@@ -95,10 +95,11 @@ def module_opts(module_controller, module):
 class TaskHandler(object):
 	"""Handles the running of the tasks it is given"""
 
-	def __init__(self, show_progress_bar=True, verbose=True, callback=None):
+	def __init__(self, show_progress_bar=True, verbose=True, callback=None, module_output=None):
 		self.show_progress_bar = show_progress_bar
 		self.verbose = verbose
 		self.callback = callback
+		self.module_output = module_output
 		self.isatty = os.environ.get('TERM') != 'dumb' and sys.stdout.isatty()
 		self.progress_bar = ProgressBar(self.isatty, title="Emaint", max_desc_length=27)
 
@@ -121,6 +122,7 @@ class TaskHandler(object):
 				onProgress = None
 			kwargs = {
 				'onProgress': onProgress,
+				'module_output': self.module_output,
 				# pass in a copy of the options so a module can not pollute or change
 				# them for other tasks if there is more to do.
 				'options': options.copy()
@@ -215,5 +217,5 @@ def emaint_main(myargv):
 	# need to pass the parser options dict to the modules
 	# so they are available if needed.
 	task_opts = options.__dict__
-	taskmaster = TaskHandler(callback=print_results)
+	taskmaster = TaskHandler(callback=print_results, module_output=sys.stdout)
 	taskmaster.run_tasks(tasks, func, status, options=task_opts)
diff --git a/pym/portage/emaint/modules/merges/__init__.py b/pym/portage/emaint/modules/merges/__init__.py
new file mode 100644
index 0000000..638d3da
--- /dev/null
+++ b/pym/portage/emaint/modules/merges/__init__.py
@@ -0,0 +1,19 @@
+# Copyright 2005-2014 Gentoo Foundation
+# Distributed under the terms of the GNU General Public License v2
+
+"""Scan for failed merges and fix them."""
+
+
+module_spec = {
+	'name': 'merges',
+	'description': __doc__,
+	'provides':{
+		'merges': {
+			'name': "merges",
+			'class': "MergesHandler",
+			'description': __doc__,
+			'functions': ['check', 'fix',],
+			'func_desc': {}
+			}
+		}
+	}
diff --git a/pym/portage/emaint/modules/merges/merges.py b/pym/portage/emaint/modules/merges/merges.py
new file mode 100644
index 0000000..f03d9c4
--- /dev/null
+++ b/pym/portage/emaint/modules/merges/merges.py
@@ -0,0 +1,121 @@
+# Copyright 2005-2014 Gentoo Foundation
+# Distributed under the terms of the GNU General Public License v2
+
+import portage
+from portage import os, _unicode_encode
+from portage.const import PORTAGE_BIN_PATH, PRIVATE_PATH, VDB_PATH
+from portage.dep import isvalidatom
+
+import shutil
+import sys
+import subprocess
+
+class MergesHandler(object):
+
+	short_desc = "Remove failed merges"
+
+	@staticmethod
+	def name():
+		return "merges"
+
+
+	def __init__(self):
+		self._eroot = portage.settings['EROOT']
+		self._vardb_path = os.path.join(self._eroot, VDB_PATH)
+
+
+	def can_progressbar(self, func):
+		if func == 'fix':
+			return False
+		return True
+
+
+	def _failed_packages(self, onProgress=None):
+		for cat in os.listdir(self._vardb_path):
+			pkgs = os.listdir(os.path.join(self._vardb_path, cat))
+			maxval = len(pkgs)
+			for i, pkg in enumerate(pkgs):
+				if onProgress:
+					onProgress(maxval, i+1)
+
+				if '-MERGING-' in pkg:
+					yield os.path.join(cat, pkg)
+
+
+	def check(self, **kwargs):
+		onProgress = kwargs.get('onProgress', None)
+		failed_pkgs = set(self._failed_packages(onProgress))
+		errors = ["'%s' failed to merge." % x for x in failed_pkgs]
+		return errors
+
+
+	def fix(self, **kwargs):
+		module_output = kwargs.get('module_output', None)
+		failed_pkgs = set(self._failed_packages())
+		if not failed_pkgs:
+			return [ 'No failed merges found. ' ]
+
+		tracking_path = os.path.join(self._eroot, PRIVATE_PATH, 'failed-merges');
+		try:
+			with open(_unicode_encode(tracking_path), 'w') as tracking_file:
+				tracking_file.write('\n'.join(failed_pkgs))
+		except IOError as ex:
+			errors = [ 'Unable to save failed merges to tracking file: %s\n'
+				% str(ex) ]
+			errors.append(', '.join(failed_pkgs))
+
+			return errors
+
+		pkg_dne = []
+		pkg_atoms = set()
+		for failed_pkg in failed_pkgs:
+			# validate pkg name
+			pkg_name = '%s' % failed_pkg.replace('-MERGING-', '')
+			pkg_atom = '=%s' % pkg_name
+			if not isvalidatom(pkg_atom):
+				pkg_dne.append( "'%s' is an invalid package atom." % pkg_atom)
+			if not portage.portdb.cpv_exists(pkg_name):
+				pkg_dne.append( "'%s' does not exist in the portage tree."
+					% pkg_name)
+			pkg_atoms.add(pkg_atom)
+		if pkg_dne:
+			return pkg_dne
+
+		for failed_pkg in failed_pkgs:
+			pkg_path = os.path.join(self._vardb_path, failed_pkg)
+			# delete failed merge directory
+			shutil.rmtree(pkg_path)
+			# TODO: try removing package contents to prevent orphaned
+			# files
+
+		# TODO: rewrite code to use portage's APIs instead of a subprocess
+		env = {
+			"FEATURES" : "-collision-detect -protect-owned",
+			"PATH" : os.environ["PATH"]
+		}
+		emerge_cmd = (
+			portage._python_interpreter,
+			'-b',
+			os.path.join(PORTAGE_BIN_PATH, 'emerge'),
+			'--quiet',
+			'--oneshot',
+			'--complete-graph=y'
+		)
+		results = []
+		msg = 'Re-Emerging packages that failed to merge...\n'
+		if module_output:
+			module_output.write(msg)
+		else:
+			module_output = subprocess.PIPE
+			results.append(msg)
+		proc = subprocess.Popen(emerge_cmd + tuple(pkg_atoms), env=env,
+			stdout=module_output, stderr=sys.stderr)
+		output = proc.communicate()[0]
+		if output:
+			results.append(output)
+		if proc.returncode != os.EX_OK:
+			 finish = "Failed to emerge '%s'" % (' '.join(pkg_atoms))
+		else:
+			 finish = "Successfully emerged '%s'" % (' '.join(pkg_atoms))
+		results.append(finish)
+		return results
-- 
1.8.3.2