Differential D114

mash directive: add docstrings
ClosedPublic
Actions

Authored by mkrizek on May 30 2014, 9:02 AM.

Tags

None

Subscribers

Details

Reviewers

lbrabec
kparal
tflink

Maniphest Tasks

T189: MashDirective has some missing docstrings

Commits

rLTRN050891fc940e: mash directive: add docstrings

Summary

Fixes T189

Test Plan

None

Diff Detail

Repository

rLTRN libtaskotron

Lint

Lint Skipped

Unit

Unit Tests Skipped

mkrizek retitled this revision from to mash directive: add docstrings.May 30 2014, 9:02 AM

mkrizek updated this object.

mkrizek edited the test plan for this revision. (Show Details)

mkrizek added reviewers: tflink, kparal, lbrabec.

mkrizek added a task: T189: MashDirective has some missing docstrings.

Herald added a subscriber: tflink. · View Herald TranscriptMay 30 2014, 9:02 AM

Seems to be ok.

This revision is now accepted and ready to land.May 30 2014, 9:09 AM

libtaskotron/directives/mash_directive.py
33–34	Can you please also specify what the directive actually does? Something like: This will create a YUM repository in `rpmdir` from all RPM packages inside the same directory. It will call `mash` tool to perform this task.
36–39	Can you please also somehow specify what this directive returns as a return value? We already touched this topic in D104. I think we should have that information in all our directives.

This revision now requires changes to proceed.May 30 2014, 12:18 PM

Add description of what the directive does

Can you please also somehow specify what this directive returns as a return value?

At this point, it doesn't return anything (well, it returns None).

At this point, it doesn't return anything (well, it returns None).

Great, please document.

libtaskotron/directives/mash_directive.py
33–34	Just a nitpicking, you might want to consider better doc rendering using: ``rpmdir`` and ``mash``

Address issue in the review

kparal accepted this revision.May 30 2014, 2:42 PM

This revision is now accepted and ready to land.May 30 2014, 2:42 PM

Closed by commit rLTRN050891fc940e (authored by @mkrizek).

Revision Contents

			Path	Packages
M			libtaskotron/directives/mash_directive.py (49 lines)

Diff 338

libtaskotron/directives/mash_directive.py

		1		# Copyright 2014, Red Hat, Inc.
		2		#
		3		# This program is free software; you can redistribute it and/or modify
		4		# it under the terms of the GNU General Public License as published by
		5		# the Free Software Foundation; either version 2 of the License, or
		6		# (at your option) any later version.
		7		#
		8		# This program is distributed in the hope that it will be useful,
		9		# but WITHOUT ANY WARRANTY; without even the implied warranty of
		10		# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		11		# GNU General Public License for more details.
		12		#
		13		# You should have received a copy of the GNU General Public License along
		14		# with this program; if not, write to the Free Software Foundation, Inc.,
		15		# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
		16		#
		17		# Authors:
		18		# Martin Krizek <mkrizek@redhat.com>
		19
1	import subprocess as sub	20		import subprocess as sub
2	import mash	21		import mash
3	import mash.config	22		import mash.config
4	import StringIO	23		import StringIO
5	from ConfigParser import RawConfigParser	24		from ConfigParser import RawConfigParser
6		25
7	from libtaskotron.directives import BaseDirective	26		from libtaskotron.directives import BaseDirective
8	from libtaskotron.logger import log	27		from libtaskotron.logger import log
9	from libtaskotron.exceptions import TaskotronDirectiveError	28		from libtaskotron.exceptions import TaskotronDirectiveError
10		29
11	directive_class = 'MashDirective'	30		directive_class = 'MashDirective'
12		31
13	class MashDirective(BaseDirective):	32		class MashDirective(BaseDirective):
		33		"""This will create a YUM repository in ``rpmdir`` from all RPM packages
		34		inside the same directory. It will call ``mash`` tool to perform this task.
			kparalUnsubmitted Not Done Can you please also specify what the directive actually does? Something like: This will create a YUM repository in `rpmdir` from all RPM packages inside the same directory. It will call `mash` tool to perform this task.
			kparalUnsubmitted Not Done Just a nitpicking, you might want to consider better doc rendering using: ``rpmdir`` and ``mash``
		35
		36		The directive returns None.
		37
		38		For the mash directive, we're expecting a yaml declaration of the form:
		39
			kparalUnsubmitted Not Done Can you please also somehow specify what this directive returns as a return value? We already touched this topic in D104. I think we should have that information in all our directives.
		40		mash:
		41		rpmdir=/path/to/some/dir
		42		dodelta=[True, False]
		43		arch=["i386", "x86_64", "armhfp", "noarch"]
		44		"""
		45
14	def do_mash(self, rpmdir, dodelta, arch):	46		def do_mash(self, rpmdir, dodelta, arch):
		47		"""Set up a mash object with an ad-hoc config
		48
		49		:param str rpmdir: directory containing rpms to mash
		50		:param bool dodelta: create drpms during mash
		51		:param str arch: arch of the rpms
		52		:returns: return code of doMultilib, 0 if it went fine, 1 othwerise
		53		"""
		54
15	# copied over from the old depcheck	55		# copied over from the old depcheck
16	distname = 'depcheck'	56		distname = 'depcheck'
17		57
18	mash_conf_items = ["[%s]" % distname,	58		mash_conf_items = ["[%s]" % distname,
19	#"output_subdir = %s" % distname,	59		#"output_subdir = %s" % distname,
20	"rpm_path = %s" % rpmdir,	60		"rpm_path = %s" % rpmdir,
21	"strict_keys = False",	61		"strict_keys = False",
22	"multilib = True",	62		"multilib = True",
Show All 30 Lines
53		93
54	log.info('running mash multilib on %s', rpmdir)	94		log.info('running mash multilib on %s', rpmdir)
55	rc = themash.doMultilib()	95		rc = themash.doMultilib()
56	conf.distros.pop()	96		conf.distros.pop()
57		97
58	return rc	98		return rc
59		99
60	def process(self, input_data, env_data):	100		def process(self, input_data, env_data):
61	"""For the mash directive, we're expecting a yaml declaration of
62	the form:
63
64	mash:
65	rpmdir=/path/to/some/dir
66	dodelta=[True, False]
67	arch=["i386", "x86_64", "armhfp", "noarch"]
68	"""
69
70	if 'rpmdir' not in input_data or 'arch' not in input_data:	101		if 'rpmdir' not in input_data or 'arch' not in input_data:
71	detected_args = ', '.join(input_data.keys())	102		detected_args = ', '.join(input_data.keys())
72	raise TaskotronDirectiveError(	103		raise TaskotronDirectiveError(
73	"The mash directive requires 'rpmdir' and 'arch' "	104		"The mash directive requires 'rpmdir' and 'arch' "
74	"arguments. Detected arguments: %s" % detected_args)	105		"arguments. Detected arguments: %s" % detected_args)
75		106
76	if 'dodelta' not in input_data:	107		if 'dodelta' not in input_data:
77	dodelta = False	108		dodelta = False
78	else:	109		else:
79	dodelta = input_data['dodelta']	110		dodelta = input_data['dodelta']
80		111
81	rpmdir = input_data['rpmdir']	112		rpmdir = input_data['rpmdir']
82	arch = input_data['arch']	113		arch = input_data['arch']
83		114
84	self.do_mash(rpmdir, dodelta, arch)	115		self.do_mash(rpmdir, dodelta, arch)