Version 7.2.0 incorrectly separates Bundle-NativeCode clauses with commas instead of semicolons

[nroduit]

Description

Version 7.2.0 introduces a breaking change in how Bundle-NativeCode manifest entries are formatted. The new version incorrectly separates native code clauses with commas and duplicates the platform attributes for each library, causing native library loading failures.

Expected Behavior (7.1.0)

The Bundle-NativeCode header should list all native libraries separated by semicolons, with the platform attributes (processor, osname) specified once at the end:

Bundle-NativeCode: natives/linux-amd64/libgluegen_rt. so; natives/linux
 -amd64/libjocl.so; natives/linux-amd64/libnativewindow_awt.so; native
 s/linux-amd64/libnewt_drm. so; natives/linux-amd64/libnativewindow_x11
 .so; natives/linux-amd64/libnativewindow_drm. so; natives/linux-amd64/
 libnewt_head.so; natives/linux-amd64/libjogl_mobile.so; natives/linux
 -amd64/libjogl_desktop.so; processor=x86-64; osname=Linux

Actual Behavior (7.2.0)

Version 7.2.0 separates each library with commas and duplicates the platform attributes for every entry:

Bundle-NativeCode: natives/linux-amd64/libgluegen_rt. so;osname=Linux;p
 rocessor=x86-64,natives/linux-amd64/libjocl.so;osname=Linux;processor
 =x86-64,natives/linux-amd64/libnativewindow_awt.so;osname=Linux;proce
 ssor=x86-64,natives/linux-amd64/libnewt_drm.so;osname=Linux;processor
 =x86-64,natives/linux-amd64/libnativewindow_x11.so;osname=Linux;proce
 ssor=x86-64,natives/linux-amd64/libnativewindow_drm.so;osname=Linux;p
 rocessor=x86-64,natives/linux-amd64/libnewt_head.so;osname=Linux;proc
 essor=x86-64,natives/linux-amd64/libjogl_mobile.so;osname=Linux;proce
 ssor=x86-64,natives/linux-amd64/libjogl_desktop.so;osname=Linux;proce
 ssor=x86-64

Source Input

Bundle-NativeCode: natives/linux-amd64/libgluegen_rt.so; \
      natives/linux-amd64/libjocl.so; \
      natives/linux-amd64/libnativewindow_awt.so; \
      natives/linux-amd64/libnewt_drm.so; \
      natives/linux-amd64/libnativewindow_x11.so; \
      natives/linux-amd64/libnativewindow_drm.so; \
      natives/linux-amd64/libnewt_head.so; \
      natives/linux-amd64/libjogl_mobile. so; \
      natives/linux-amd64/libjogl_desktop.so; \
      processor=x86-64; osname=Linux

Reference

According to the OSGi specification for Bundle-NativeCode (see this blog post), commas are used to separate alternative clauses (different native libraries for different platforms), while semicolons separate paths and attributes within the same clause.

[chrisrueger]

Thanks for the report. I had a quick look at prs which mentioned headers. Could you check if you see something which look responsible?

#6868

#6798

#6502

#6501

[chrisrueger]

@gnodet do you think #6798 might be related?

[peterkir]

After some investigation I agree... I think the culprit is the biz.aQute.bndlib/src/aQute/bnd/osgi/Jar.java method reorderClause. Will you investigate or should I take it?

[chrisrueger]

It seems Bundle-NativeCode is somehow a special structurally different header and thus is seems that

Parameters header = OSGiHeader.parseHeader(s);
...
return header.toString();

is not a sufficient model.

Following functions might be related and worth having a look at:

• biz.aQute.bnd.reporter.helpers.HeadersHelper.convertBundleNativeCode(Parameters)
• biz.aQute.bnd.reporter.manifest.dto.NativeCodeDTO.NativeCodeDTO()
• biz.aQute.bnd.reporter.helpers.HeadersHelperTest.testBundleNativeCode()

Also in the test biz.aQute.bnd.reporter.helpers.HeadersHelperTest.perform(String, String, Object) there is special treatment for BUNDLE_NATIVECODE:

if (Constants.BUNDLE_NATIVECODE.equals(headerName)) {
	actual = f.apply(manifestHelper.getHeader(headerName, true));
} else {
	actual = f.apply(manifestHelper.getHeader(headerName, false));
}

which indicates we might need special treatment for Jar.reorderClause() too.

The question is, if the solution is to just skip this reOrderClause() for Bundle-NativeCode or if it needs more.