[PATCH 1/1] package_ipk.bbclass: Add check for empty lines in DESCRIPTION

[PATCH 1/1] package_ipk.bbclass: Add check for empty lines in DESCRIPTION

[mariano.lopez]

From: Mariano Lopez <mariano.lopez@linux.intel.com>

opkg uses empty lines as separator for next package and if an ipk
file was packaged with empty lines in DESCRIPTION opkg won't be
able to handle such ipk file, this happens at execution time.

This commit will add a check for empty lines in DESCRIPTION when
generating to ipk package to avoid this issue.

[YOCTO #10677]

Signed-off-by: Mariano Lopez <mariano.lopez@linux.intel.com>
---
 meta/classes/package_ipk.bbclass | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/meta/classes/package_ipk.bbclass b/meta/classes/package_ipk.bbclass
index a76b235..a8a4ddc 100644
--- a/meta/classes/package_ipk.bbclass
+++ b/meta/classes/package_ipk.bbclass
@@ -32,6 +32,13 @@ python do_package_ipk () {
         bb.error("Variables incorrectly set, unable to package")
         return
 
+    # opkg won't allow empty lines in package's description at execution
+    # time, so is better to fail at build time instead when trying to install.
+    description = d.getVar('DESCRIPTION').encode('UTF-8', 'ignore')
+    description = description.decode('unicode_escape')
+    if ([line for line in description.splitlines() if not line.strip()]):
+        bb.fatal("opkg won't allow empty lines in DESCRIPTION")
+
     packages = d.getVar('PACKAGES')
     if not packages or packages == '':
         bb.debug(1, "No packages; nothing to do")
-- 
2.6.6

Re: [PATCH 1/1] package_ipk.bbclass: Add check for empty lines in DESCRIPTION

[Christopher Larson]

[-- Attachment #1: Type: text/plain, Size: 819 bytes --]

On Tue, Jan 24, 2017 at 1:37 AM, <mariano.lopez@linux.intel.com> wrote:

> From: Mariano Lopez <mariano.lopez@linux.intel.com>
>
> opkg uses empty lines as separator for next package and if an ipk
> file was packaged with empty lines in DESCRIPTION opkg won't be
> able to handle such ipk file, this happens at execution time.
>
> This commit will add a check for empty lines in DESCRIPTION when
> generating to ipk package to avoid this issue.
>
> [YOCTO #10677]
>
> Signed-off-by: Mariano Lopez <mariano.lopez@linux.intel.com>
>

Could it handle a line with just a space, or a period? Could you not
replace the lines with that instead, rather than aborting?
-- 
Christopher Larson
clarson at kergoth dot com
Founder - BitBake, OpenEmbedded, OpenZaurus
Senior Software Engineer, Mentor Graphics

[-- Attachment #2: Type: text/html, Size: 1434 bytes --]

Re: [PATCH 1/1] package_ipk.bbclass: Add check for empty lines in DESCRIPTION

[Richard Purdie]

On Tue, 2017-01-24 at 11:52 -0700, Christopher Larson wrote:
> 
> On Tue, Jan 24, 2017 at 1:37 AM, <mariano.lopez@linux.intel.com>
> wrote:
> > From: Mariano Lopez <mariano.lopez@linux.intel.com>
> > 
> > opkg uses empty lines as separator for next package and if an ipk
> > file was packaged with empty lines in DESCRIPTION opkg won't be
> > able to handle such ipk file, this happens at execution time.
> > 
> > This commit will add a check for empty lines in DESCRIPTION when
> > generating to ipk package to avoid this issue.
> > 
> > [YOCTO #10677]
> > 
> > Signed-off-by: Mariano Lopez <mariano.lopez@linux.intel.com>
> > 
> Could it handle a line with just a space, or a period? Could you not
> replace the lines with that instead, rather than aborting?

FWIW package_deb uses ".".

Also, please use bb.fatal() calls with caution, I just removed several
from that class. In this case its perhaps ok but often the correct
thing to do is raise an exception of some kind. This means bitbake will
generate a usable traceback rather than simply printing the fatal
message. In this case the message is probably fine but there were
several cases where a traceback was a much better idea as the fatal
message wasn't enough to debug with.

Cheers,

Richard

Re: [PATCH 1/1] package_ipk.bbclass: Add check for empty lines in DESCRIPTION

[Mariano Lopez]

On 25/01/17 05:56, Richard Purdie wrote:
> On Tue, 2017-01-24 at 11:52 -0700, Christopher Larson wrote:
>> On Tue, Jan 24, 2017 at 1:37 AM, <mariano.lopez@linux.intel.com>
>> wrote:
>>> From: Mariano Lopez <mariano.lopez@linux.intel.com>
>>>
>>> opkg uses empty lines as separator for next package and if an ipk
>>> file was packaged with empty lines in DESCRIPTION opkg won't be
>>> able to handle such ipk file, this happens at execution time.
>>>
>>> This commit will add a check for empty lines in DESCRIPTION when
>>> generating to ipk package to avoid this issue.
>>>
>>> [YOCTO #10677]
>>>
>>> Signed-off-by: Mariano Lopez <mariano.lopez@linux.intel.com>
>>>
>> Could it handle a line with just a space, or a period? Could you not
>> replace the lines with that instead, rather than aborting?
> FWIW package_deb uses ".".

Also opkg will strip() the lines, so an empty space is not a option here.

>
> Also, please use bb.fatal() calls with caution, I just removed several
> from that class. In this case its perhaps ok but often the correct
> thing to do is raise an exception of some kind. This means bitbake will
> generate a usable traceback rather than simply printing the fatal
> message. In this case the message is probably fine but there were
> several cases where a traceback was a much better idea as the fatal
> message wasn't enough to debug with.

Fair enough, I will consider this advice when using bb.fatal()

Regards,
Mariano