bitbake: BBHandler/ast: Improve addtask handling

The recent addtask improvement to handle comments complicated the regex significantly
and there are already a number of corner cases in that code which aren't handled well.

Instead of trying to complicate the regex further, switch to code logic instead. This
means the following cases are now handled:

* addtask with multiple task names
* addtask with multiple before constraints
* addtask with multiple after constraints

The testcase is updated to match the improvements.

(Bitbake rev: 417016b83c21fca7616b2ee768d5d08e1edd1e06)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Richard Purdie
2024-08-12 15:53:06 +01:00
parent 36f98fc1f2
commit 5226f46342
3 changed files with 37 additions and 43 deletions

View File

@@ -240,14 +240,16 @@ class ExportFuncsNode(AstNode):
data.setVar(func, sentinel + " " + calledfunc + "\n", parsing=True) data.setVar(func, sentinel + " " + calledfunc + "\n", parsing=True)
class AddTaskNode(AstNode): class AddTaskNode(AstNode):
def __init__(self, filename, lineno, func, before, after): def __init__(self, filename, lineno, tasks, before, after):
AstNode.__init__(self, filename, lineno) AstNode.__init__(self, filename, lineno)
self.func = func self.tasks = tasks
self.before = before self.before = before
self.after = after self.after = after
def eval(self, data): def eval(self, data):
bb.build.addtask(self.func, self.before, self.after, data) tasks = self.tasks.split()
for task in tasks:
bb.build.addtask(task, self.before, self.after, data)
class DelTaskNode(AstNode): class DelTaskNode(AstNode):
def __init__(self, filename, lineno, tasks): def __init__(self, filename, lineno, tasks):
@@ -348,21 +350,11 @@ def handlePythonMethod(statements, filename, lineno, funcname, modulename, body)
def handleExportFuncs(statements, filename, lineno, m, classname): def handleExportFuncs(statements, filename, lineno, m, classname):
statements.append(ExportFuncsNode(filename, lineno, m.group(1), classname)) statements.append(ExportFuncsNode(filename, lineno, m.group(1), classname))
def handleAddTask(statements, filename, lineno, m): def handleAddTask(statements, filename, lineno, tasks, before, after):
func = m.group("func") statements.append(AddTaskNode(filename, lineno, tasks, before, after))
before = m.group("before")
after = m.group("after")
if func is None:
return
statements.append(AddTaskNode(filename, lineno, func, before, after)) def handleDelTask(statements, filename, lineno, tasks):
statements.append(DelTaskNode(filename, lineno, tasks))
def handleDelTask(statements, filename, lineno, m):
func = m.group(1)
if func is None:
return
statements.append(DelTaskNode(filename, lineno, func))
def handleBBHandlers(statements, filename, lineno, m): def handleBBHandlers(statements, filename, lineno, m):
statements.append(BBHandlerNode(filename, lineno, m.group(1))) statements.append(BBHandlerNode(filename, lineno, m.group(1)))

View File

@@ -23,7 +23,7 @@ __func_start_regexp__ = re.compile(r"(((?P<py>python(?=(\s|\()))|(?P<fr>faker
__inherit_regexp__ = re.compile(r"inherit\s+(.+)" ) __inherit_regexp__ = re.compile(r"inherit\s+(.+)" )
__inherit_def_regexp__ = re.compile(r"inherit_defer\s+(.+)" ) __inherit_def_regexp__ = re.compile(r"inherit_defer\s+(.+)" )
__export_func_regexp__ = re.compile(r"EXPORT_FUNCTIONS\s+(.+)" ) __export_func_regexp__ = re.compile(r"EXPORT_FUNCTIONS\s+(.+)" )
__addtask_regexp__ = re.compile(r"addtask\s+(?P<func>\w+)\s*((before\s*(?P<before>(([^#\n]*(?=after))|([^#\n]*))))|(after\s*(?P<after>(([^#\n]*(?=before))|([^#\n]*)))))*(?P<comment>#.*|.*?)") __addtask_regexp__ = re.compile(r"addtask\s+([^#\n]+)(?P<comment>#.*|.*?)")
__deltask_regexp__ = re.compile(r"deltask\s+([^#\n]+)(?P<comment>#.*|.*?)") __deltask_regexp__ = re.compile(r"deltask\s+([^#\n]+)(?P<comment>#.*|.*?)")
__addhandler_regexp__ = re.compile(r"addhandler\s+(.+)" ) __addhandler_regexp__ = re.compile(r"addhandler\s+(.+)" )
__def_regexp__ = re.compile(r"def\s+(\w+).*:" ) __def_regexp__ = re.compile(r"def\s+(\w+).*:" )
@@ -239,29 +239,38 @@ def feeder(lineno, s, fn, root, statements, eof=False):
m = __addtask_regexp__.match(s) m = __addtask_regexp__.match(s)
if m: if m:
if len(m.group().split()) == 2: after = ""
# Check and warn for "addtask task1 task2" before = ""
m2 = re.match(r"addtask\s+(?P<func>\w+)(?P<ignores>.*)", s)
if m2 and m2.group('ignores'):
logger.warning('addtask ignored: "%s"' % m2.group('ignores'))
# Check and warn for "addtask task1 before task2 before task3", the # This code splits on 'before' and 'after' instead of on whitespace so we can defer
# similar to "after" # evaluation to as late as possible.
tasks = m.group(1).split(" before ")[0].split(" after ")[0]
for exp in m.group(1).split(" before "):
exp2 = exp.split(" after ")
if len(exp2) > 1:
after = after + " ".join(exp2[1:])
for exp in m.group(1).split(" after "):
exp2 = exp.split(" before ")
if len(exp2) > 1:
before = before + " ".join(exp2[1:])
# Check and warn for having task with a keyword as part of task name
taskexpression = s.split() taskexpression = s.split()
for word in ('before', 'after'):
if taskexpression.count(word) > 1:
logger.warning("addtask contained multiple '%s' keywords, only one is supported" % word)
# Check and warn for having task with exprssion as part of task name
for te in taskexpression: for te in taskexpression:
if any( ( "%s_" % keyword ) in te for keyword in bb.data_smart.__setvar_keyword__ ): if any( ( "%s_" % keyword ) in te for keyword in bb.data_smart.__setvar_keyword__ ):
raise ParseError("Task name '%s' contains a keyword which is not recommended/supported.\nPlease rename the task not to include the keyword.\n%s" % (te, ("\n".join(map(str, bb.data_smart.__setvar_keyword__)))), fn) raise ParseError("Task name '%s' contains a keyword which is not recommended/supported.\nPlease rename the task not to include the keyword.\n%s" % (te, ("\n".join(map(str, bb.data_smart.__setvar_keyword__)))), fn)
ast.handleAddTask(statements, fn, lineno, m)
if tasks is not None:
ast.handleAddTask(statements, fn, lineno, tasks, before, after)
return return
m = __deltask_regexp__.match(s) m = __deltask_regexp__.match(s)
if m: if m:
ast.handleDelTask(statements, fn, lineno, m) task = m.group(1)
if task is not None:
ast.handleDelTask(statements, fn, lineno, task)
return return
m = __addhandler_regexp__.match(s) m = __addhandler_regexp__.match(s)

View File

@@ -177,7 +177,7 @@ python () {
addtask_deltask = """ addtask_deltask = """
addtask do_patch after do_foo after do_unpack before do_configure before do_compile addtask do_patch after do_foo after do_unpack before do_configure before do_compile
addtask do_fetch do_patch addtask do_fetch2 do_patch2
addtask do_myplaintask addtask do_myplaintask
addtask do_myplaintask2 addtask do_myplaintask2
@@ -194,18 +194,11 @@ deltask do_fetch ${MYVAR} ${EMPTYVAR}
deltask ${EMPTYVAR} deltask ${EMPTYVAR}
""" """
def test_parse_addtask_deltask(self): def test_parse_addtask_deltask(self):
import sys
with self.assertLogs() as logs: f = self.parsehelper(self.addtask_deltask)
f = self.parsehelper(self.addtask_deltask) d = bb.parse.handle(f.name, self.d)['']
d = bb.parse.handle(f.name, self.d)['']
output = "".join(logs.output) self.assertEqual(['do_fetch2', 'do_patch2', 'do_myplaintask', 'do_mytask', 'do_mytask2'], d.getVar("__BBTASKS"))
self.assertTrue("addtask contained multiple 'before' keywords" in output)
self.assertTrue("addtask contained multiple 'after' keywords" in output)
self.assertTrue('addtask ignored: " do_patch"' in output)
self.assertEqual(['do_myplaintask', 'do_mytask', 'do_mytask2'], d.getVar("__BBTASKS"))
#self.assertTrue('dependent task do_foo for do_patch does not exist' in output)
broken_multiline_comment = """ broken_multiline_comment = """
# First line of comment \\ # First line of comment \\