[PATCH] create-spdx.bbclass: Search all license directories for licenses

[PATCH] create-spdx.bbclass: Search all license directories for licenses

[Peter Kjellerstedt]

Before, even if the code was seemingly written to search through all
licenses in ${COMMON_LICENSE_DIR} and ${LICENSE_PATH}, it would
actually bail out after only searching ${COMMON_LICENSE_DIR} due to
the exception handling.

Also refrain from using f-strings.

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
---
 meta/classes/create-spdx.bbclass | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/meta/classes/create-spdx.bbclass b/meta/classes/create-spdx.bbclass
index db85677d4c..3c73c21c04 100644
--- a/meta/classes/create-spdx.bbclass
+++ b/meta/classes/create-spdx.bbclass
@@ -67,6 +67,7 @@ def convert_license_to_spdx(lic, document, d, existing={}):
         extracted_info = oe.spdx.SPDXExtractedLicensingInfo()
         extracted_info.name = name
         extracted_info.licenseId = ident
+        extracted_info.extractedText = None
 
         if name == "PD":
             # Special-case this.
@@ -78,10 +79,12 @@ def convert_license_to_spdx(lic, document, d, existing={}):
                     with (Path(directory) / name).open(errors="replace") as f:
                         extracted_info.extractedText = f.read()
                         break
-                except Exception as e:
-                    # Error out, as the license was in available_licenses so
-                    # should be on disk somewhere.
-                    bb.error(f"Cannot find text for license {name}: {e}")
+                except FileNotFoundError:
+                    pass
+            if extracted_info.extractedText is None:
+                # Error out, as the license was in available_licenses so should
+                # be on disk somewhere.
+                bb.error("Cannot find text for license %s" % name)
         else:
             # If it's not SPDX, or PD, or in available licenses, then NO_GENERIC_LICENSE must be set
             filename = d.getVarFlag('NO_GENERIC_LICENSE', name)
@@ -90,7 +93,7 @@ def convert_license_to_spdx(lic, document, d, existing={}):
                 with open(filename, errors="replace") as f:
                     extracted_info.extractedText = f.read()
             else:
-                bb.error(f"Cannot find any text for license {name}")
+                bb.error("Cannot find any text for license %s" % name)
 
         extracted[name] = extracted_info
         document.hasExtractedLicensingInfos.append(extracted_info)

Re: [OE-core] [PATCH] create-spdx.bbclass: Search all license directories for licenses

[Konrad Weihmann]

On 14.09.21 20:11, Peter Kjellerstedt wrote:
> Before, even if the code was seemingly written to search through all
> licenses in ${COMMON_LICENSE_DIR} and ${LICENSE_PATH}, it would
> actually bail out after only searching ${COMMON_LICENSE_DIR} due to
> the exception handling.
> 
> Also refrain from using f-strings.

Just out of interest: why that? - I think with the recent bump to python 
3.6 as the minimum required version, there isn't any technical reason to 
avoid usage of f-strings in the class code

> 
> Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
> ---
>   meta/classes/create-spdx.bbclass | 13 ++++++++-----
>   1 file changed, 8 insertions(+), 5 deletions(-)
> 
> diff --git a/meta/classes/create-spdx.bbclass b/meta/classes/create-spdx.bbclass
> index db85677d4c..3c73c21c04 100644
> --- a/meta/classes/create-spdx.bbclass
> +++ b/meta/classes/create-spdx.bbclass
> @@ -67,6 +67,7 @@ def convert_license_to_spdx(lic, document, d, existing={}):
>           extracted_info = oe.spdx.SPDXExtractedLicensingInfo()
>           extracted_info.name = name
>           extracted_info.licenseId = ident
> +        extracted_info.extractedText = None
>   
>           if name == "PD":
>               # Special-case this.
> @@ -78,10 +79,12 @@ def convert_license_to_spdx(lic, document, d, existing={}):
>                       with (Path(directory) / name).open(errors="replace") as f:
>                           extracted_info.extractedText = f.read()
>                           break
> -                except Exception as e:
> -                    # Error out, as the license was in available_licenses so
> -                    # should be on disk somewhere.
> -                    bb.error(f"Cannot find text for license {name}: {e}")
> +                except FileNotFoundError:
> +                    pass
> +            if extracted_info.extractedText is None:
> +                # Error out, as the license was in available_licenses so should
> +                # be on disk somewhere.
> +                bb.error("Cannot find text for license %s" % name)
>           else:
>               # If it's not SPDX, or PD, or in available licenses, then NO_GENERIC_LICENSE must be set
>               filename = d.getVarFlag('NO_GENERIC_LICENSE', name)
> @@ -90,7 +93,7 @@ def convert_license_to_spdx(lic, document, d, existing={}):
>                   with open(filename, errors="replace") as f:
>                       extracted_info.extractedText = f.read()
>               else:
> -                bb.error(f"Cannot find any text for license {name}")
> +                bb.error("Cannot find any text for license %s" % name)
>   
>           extracted[name] = extracted_info
>           document.hasExtractedLicensingInfos.append(extracted_info)
> 
> 
> 
> 
> 

Re: [OE-core] [PATCH] create-spdx.bbclass: Search all license directories for licenses

[Peter Kjellerstedt]

> -----Original Message-----
> From: Konrad Weihmann <kweihmann@outlook.com>
> Sent: den 14 september 2021 20:25
> To: Peter Kjellerstedt <peter.kjellerstedt@axis.com>; openembedded-
> core@lists.openembedded.org
> Subject: Re: [OE-core] [PATCH] create-spdx.bbclass: Search all license
> directories for licenses
> 
> On 14.09.21 20:11, Peter Kjellerstedt wrote:
> > Before, even if the code was seemingly written to search through all
> > licenses in ${COMMON_LICENSE_DIR} and ${LICENSE_PATH}, it would
> > actually bail out after only searching ${COMMON_LICENSE_DIR} due to
> > the exception handling.
> >
> > Also refrain from using f-strings.
> 
> Just out of interest: why that? - I think with the recent bump to python
> 3.6 as the minimum required version, there isn't any technical reason to
> avoid usage of f-strings in the class code

Well, it was mainly due to the discussions we have had about starting 
to use f-strings in OE-Core where RP has been reluctant to endorse it 
based on that it may cause problems when backporting code to Dunfell 
and Hardknott that still have older version of Python as minimum 
versions.

That said, create-spdx.bbclass is not likely to be backported to any 
older version of OE-Core so maybe it is ok to leave the use of 
f-strings as they were.

//Peter

> > Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
> > ---
> >   meta/classes/create-spdx.bbclass | 13 ++++++++-----
> >   1 file changed, 8 insertions(+), 5 deletions(-)
> >
> > diff --git a/meta/classes/create-spdx.bbclass b/meta/classes/create-spdx.bbclass
> > index db85677d4c..3c73c21c04 100644
> > --- a/meta/classes/create-spdx.bbclass
> > +++ b/meta/classes/create-spdx.bbclass
> > @@ -67,6 +67,7 @@ def convert_license_to_spdx(lic, document, d, existing={}):
> >           extracted_info = oe.spdx.SPDXExtractedLicensingInfo()
> >           extracted_info.name = name
> >           extracted_info.licenseId = ident
> > +        extracted_info.extractedText = None
> >
> >           if name == "PD":
> >               # Special-case this.
> > @@ -78,10 +79,12 @@ def convert_license_to_spdx(lic, document, d, existing={}):
> >                       with (Path(directory) / name).open(errors="replace") as f:
> >                           extracted_info.extractedText = f.read()
> >                           break
> > -                except Exception as e:
> > -                    # Error out, as the license was in available_licenses so
> > -                    # should be on disk somewhere.
> > -                    bb.error(f"Cannot find text for license {name}: {e}")
> > +                except FileNotFoundError:
> > +                    pass
> > +            if extracted_info.extractedText is None:
> > +                # Error out, as the license was in available_licenses so should
> > +                # be on disk somewhere.
> > +                bb.error("Cannot find text for license %s" % name)
> >           else:
> >               # If it's not SPDX, or PD, or in available licenses, then NO_GENERIC_LICENSE must be set
> >               filename = d.getVarFlag('NO_GENERIC_LICENSE', name)
> > @@ -90,7 +93,7 @@ def convert_license_to_spdx(lic, document, d, existing={}):
> >                   with open(filename, errors="replace") as f:
> >                       extracted_info.extractedText = f.read()
> >               else:
> > -                bb.error(f"Cannot find any text for license {name}")
> > +                bb.error("Cannot find any text for license %s" % name)
> >
> >           extracted[name] = extracted_info
> >           document.hasExtractedLicensingInfos.append(extracted_info)

Re: [OE-core] [PATCH] create-spdx.bbclass: Search all license directories for licenses

[Joshua Watt]

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

On 9/14/21 1:11 PM, Peter Kjellerstedt wrote:
> Before, even if the code was seemingly written to search through all
> licenses in ${COMMON_LICENSE_DIR} and ${LICENSE_PATH}, it would
> actually bail out after only searching ${COMMON_LICENSE_DIR} due to
> the exception handling.
>
> Also refrain from using f-strings.
>
> Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
> ---
>   meta/classes/create-spdx.bbclass | 13 ++++++++-----
>   1 file changed, 8 insertions(+), 5 deletions(-)
>
> diff --git a/meta/classes/create-spdx.bbclass b/meta/classes/create-spdx.bbclass
> index db85677d4c..3c73c21c04 100644
> --- a/meta/classes/create-spdx.bbclass
> +++ b/meta/classes/create-spdx.bbclass
> @@ -67,6 +67,7 @@ def convert_license_to_spdx(lic, document, d, existing={}):
>           extracted_info = oe.spdx.SPDXExtractedLicensingInfo()
>           extracted_info.name = name
>           extracted_info.licenseId = ident
> +        extracted_info.extractedText = None
>   
>           if name == "PD":
>               # Special-case this.
> @@ -78,10 +79,12 @@ def convert_license_to_spdx(lic, document, d, existing={}):
>                       with (Path(directory) / name).open(errors="replace") as f:
>                           extracted_info.extractedText = f.read()
>                           break
> -                except Exception as e:
> -                    # Error out, as the license was in available_licenses so
> -                    # should be on disk somewhere.
> -                    bb.error(f"Cannot find text for license {name}: {e}")
> +                except FileNotFoundError:
> +                    pass
> +            if extracted_info.extractedText is None:
> +                # Error out, as the license was in available_licenses so should
> +                # be on disk somewhere.
> +                bb.error("Cannot find text for license %s" % name)
>           else:
>               # If it's not SPDX, or PD, or in available licenses, then NO_GENERIC_LICENSE must be set
>               filename = d.getVarFlag('NO_GENERIC_LICENSE', name)
> @@ -90,7 +93,7 @@ def convert_license_to_spdx(lic, document, d, existing={}):
>                   with open(filename, errors="replace") as f:
>                       extracted_info.extractedText = f.read()
>               else:
> -                bb.error(f"Cannot find any text for license {name}")
> +                bb.error("Cannot find any text for license %s" % name)
>   
>           extracted[name] = extracted_info
>           document.hasExtractedLicensingInfos.append(extracted_info)

LGTM

Reviewed-By: Joshua Watt <JPEWhacker@gmail.com>

>
> 
>

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