All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH v2][RFC] distrodata.py: Test to track recipes without HOMEPAGE or DESCRIPTION
@ 2021-03-08 21:12 Dorinda
  2021-03-12  2:11 ` [OE-core] " Randy MacLeod
  0 siblings, 1 reply; 4+ messages in thread
From: Dorinda @ 2021-03-08 21:12 UTC (permalink / raw)
  To: openembedded-core; +Cc: Dorinda Bassey

From: Dorinda Bassey <dorindabassey@gmail.com>

This test is to keep track of recipes that do not have a HOMEPAGE or DESCRIPTION,
with exceptions to recipes whose SRC_URI are not linked to external sources.

[YOCTO #13471]

Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com>
---
v2:
-Changed PN to BPN
-Used set() instead of lists
-Changed condition for checking recipes with missing DESCRIPTION

 meta/lib/oeqa/selftest/cases/distrodata.py | 36 ++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/meta/lib/oeqa/selftest/cases/distrodata.py b/meta/lib/oeqa/selftest/cases/distrodata.py
index e1cfc3b621..633bf25dc7 100644
--- a/meta/lib/oeqa/selftest/cases/distrodata.py
+++ b/meta/lib/oeqa/selftest/cases/distrodata.py
@@ -40,6 +40,42 @@ but their recipes claim otherwise by setting UPSTREAM_VERSION_UNKNOWN. Please re
 """ + "\n".join(regressed_successes)
         self.assertTrue(len(regressed_failures) == 0 and len(regressed_successes) == 0, msg)
 
+    def test_missing_homepg(self):
+        """
+        Summary:     Test for oe-core recipes that don't have a HOMEPAGE or DESCRIPTION
+        Expected:    All oe-core recipes should have a DESCRIPTION entry
+        Expected:    All oe-core recipes should have a HOMEPAGE entry except for recipes that are not fetched from external sources.
+        Product:     oe-core
+        """
+        with bb.tinfoil.Tinfoil() as tinfoil:
+            tinfoil.prepare(config_only=False)
+            no_description = set()
+            no_homepage = set()
+            for fn in tinfoil.all_recipe_files(variants=False):
+                if not '/meta/recipes-' in fn:
+                    # We are only interested in OE-Core
+                    continue
+                rd = tinfoil.parse_recipe_file(fn, appends=False)
+                pn = rd.getVar('BPN')
+                srcfile = rd.getVar('SRC_URI').split()
+                #Since DESCRIPTION defaults to SUMMARY if not set, we are only interested in recipes without DESCRIPTION or SUMMARY
+                if not (rd.getVar('SUMMARY') or rd.getVar('DESCRIPTION')):
+                    no_description.add((pn, fn))
+                if not rd.getVar('HOMEPAGE'):
+                    if srcfile and srcfile[0].startswith('file') or not rd.getVar('SRC_URI'):
+                        # We are only interested in recipes SRC_URI fetched from external sources
+                        continue
+                    no_homepage.add((pn, fn))
+        if no_homepage:
+            self.fail("""
+The following recipes do not have a HOMEPAGE. Please add an entry for HOMEPAGE in the recipe.
+""" + "\n".join(['%s (%s)' % i for i in no_homepage]))
+
+        if no_description:
+            self.fail("""
+The following recipes do not have a DESCRIPTION. Please add an entry for DESCRIPTION in the recipe.
+""" + "\n".join(['%s (%s)' % i for i in no_description]))
+
     def test_maintainers(self):
         """
         Summary:     Test that oe-core recipes have a maintainer and entries in maintainers list have a recipe
-- 
2.17.1


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [OE-core] [PATCH v2][RFC] distrodata.py: Test to track recipes without HOMEPAGE or DESCRIPTION
  2021-03-08 21:12 [PATCH v2][RFC] distrodata.py: Test to track recipes without HOMEPAGE or DESCRIPTION Dorinda
@ 2021-03-12  2:11 ` Randy MacLeod
  2021-03-12 20:44   ` Dorinda
  0 siblings, 1 reply; 4+ messages in thread
From: Randy MacLeod @ 2021-03-12  2:11 UTC (permalink / raw)
  To: Dorinda, openembedded-core

On 2021-03-08 4:12 p.m., Dorinda wrote:
> This test is to keep track of recipes that do not have a HOMEPAGE or DESCRIPTION,
> with exceptions to recipes whose SRC_URI are not linked to external sources.
> 
> [YOCTO #13471]
> 
> Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com>
> ---
> v2:
> -Changed PN to BPN
> -Used set() instead of lists
> -Changed condition for checking recipes with missing DESCRIPTION
> 
>   meta/lib/oeqa/selftest/cases/distrodata.py | 36 ++++++++++++++++++++++
>   1 file changed, 36 insertions(+)
> 
> diff --git a/meta/lib/oeqa/selftest/cases/distrodata.py b/meta/lib/oeqa/selftest/cases/distrodata.py
> index e1cfc3b621..633bf25dc7 100644
> --- a/meta/lib/oeqa/selftest/cases/distrodata.py
> +++ b/meta/lib/oeqa/selftest/cases/distrodata.py
> @@ -40,6 +40,42 @@ but their recipes claim otherwise by setting UPSTREAM_VERSION_UNKNOWN. Please re
>   """ + "\n".join(regressed_successes)
>           self.assertTrue(len(regressed_failures) == 0 and len(regressed_successes) == 0, msg)
>   
> +    def test_missing_homepg(self):
> +        """
> +        Summary:     Test for oe-core recipes that don't have a HOMEPAGE or DESCRIPTION
> +        Expected:    All oe-core recipes should have a DESCRIPTION entry
> +        Expected:    All oe-core recipes should have a HOMEPAGE entry except for recipes that are not fetched from external sources.
> +        Product:     oe-core
> +        """
> +        with bb.tinfoil.Tinfoil() as tinfoil:
> +            tinfoil.prepare(config_only=False)
> +            no_description = set()
> +            no_homepage = set()

Since the other tests in this file such as:
     def test_maintainers(self):
uses lists rather than set()s:
             with_maintainer_list = []
             no_maintainer_list = []

             missing_recipes = []
             recipes = []

Maybe pick one data structure to be consistent.

If you decide that set() is better then make a separate commit to
change that. Apparently sets are faster for some operations:
    https://stackoverflow.com/questions/2831212/python-sets-vs-lists
it would be nice if you checked and documented what you find in the
commit log since these tests do take a few minutes on a lowly laptop.

The rest looks good to me. Drop the RFC if you send a v3.

Thanks!
../Randy


> +            for fn in tinfoil.all_recipe_files(variants=False):
> +                if not '/meta/recipes-' in fn:
> +                    # We are only interested in OE-Core
> +                    continue
> +                rd = tinfoil.parse_recipe_file(fn, appends=False)
> +                pn = rd.getVar('BPN')
> +                srcfile = rd.getVar('SRC_URI').split()
> +                #Since DESCRIPTION defaults to SUMMARY if not set, we are only interested in recipes without DESCRIPTION or SUMMARY
> +                if not (rd.getVar('SUMMARY') or rd.getVar('DESCRIPTION')):
> +                    no_description.add((pn, fn))
> +                if not rd.getVar('HOMEPAGE'):
> +                    if srcfile and srcfile[0].startswith('file') or not rd.getVar('SRC_URI'):
> +                        # We are only interested in recipes SRC_URI fetched from external sources
> +                        continue
> +                    no_homepage.add((pn, fn))
> +        if no_homepage:
> +            self.fail("""
> +The following recipes do not have a HOMEPAGE. Please add an entry for HOMEPAGE in the recipe.
> +""" + "\n".join(['%s (%s)' % i for i in no_homepage]))
> +
> +        if no_description:
> +            self.fail("""
> +The following recipes do not have a DESCRIPTION. Please add an entry for DESCRIPTION in the recipe.
> +""" + "\n".join(['%s (%s)' % i for i in no_description]))
> +
>       def test_maintainers(self):
>           """
>           Summary:     Test that oe-core recipes have a maintainer and entries in maintainers list have a recipe
> 
> 
> 
> 
> 


-- 
# Randy MacLeod
# Wind River Linux

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [OE-core] [PATCH v2][RFC] distrodata.py: Test to track recipes without HOMEPAGE or DESCRIPTION
  2021-03-12  2:11 ` [OE-core] " Randy MacLeod
@ 2021-03-12 20:44   ` Dorinda
  2021-03-13 22:01     ` Randy MacLeod
  0 siblings, 1 reply; 4+ messages in thread
From: Dorinda @ 2021-03-12 20:44 UTC (permalink / raw)
  To: Randy MacLeod; +Cc: openembedded-core

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

Alright, I get you.
Will send a v3 RFC.

Thanks,
Dorinda.

On Fri, Mar 12, 2021 at 3:11 AM Randy MacLeod <randy.macleod@windriver.com>
wrote:

> On 2021-03-08 4:12 p.m., Dorinda wrote:
> > This test is to keep track of recipes that do not have a HOMEPAGE or
> DESCRIPTION,
> > with exceptions to recipes whose SRC_URI are not linked to external
> sources.
> >
> > [YOCTO #13471]
> >
> > Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com>
> > ---
> > v2:
> > -Changed PN to BPN
> > -Used set() instead of lists
> > -Changed condition for checking recipes with missing DESCRIPTION
> >
> >   meta/lib/oeqa/selftest/cases/distrodata.py | 36 ++++++++++++++++++++++
> >   1 file changed, 36 insertions(+)
> >
> > diff --git a/meta/lib/oeqa/selftest/cases/distrodata.py
> b/meta/lib/oeqa/selftest/cases/distrodata.py
> > index e1cfc3b621..633bf25dc7 100644
> > --- a/meta/lib/oeqa/selftest/cases/distrodata.py
> > +++ b/meta/lib/oeqa/selftest/cases/distrodata.py
> > @@ -40,6 +40,42 @@ but their recipes claim otherwise by setting
> UPSTREAM_VERSION_UNKNOWN. Please re
> >   """ + "\n".join(regressed_successes)
> >           self.assertTrue(len(regressed_failures) == 0 and
> len(regressed_successes) == 0, msg)
> >
> > +    def test_missing_homepg(self):
> > +        """
> > +        Summary:     Test for oe-core recipes that don't have a
> HOMEPAGE or DESCRIPTION
> > +        Expected:    All oe-core recipes should have a DESCRIPTION entry
> > +        Expected:    All oe-core recipes should have a HOMEPAGE entry
> except for recipes that are not fetched from external sources.
> > +        Product:     oe-core
> > +        """
> > +        with bb.tinfoil.Tinfoil() as tinfoil:
> > +            tinfoil.prepare(config_only=False)
> > +            no_description = set()
> > +            no_homepage = set()
>
> Since the other tests in this file such as:
>      def test_maintainers(self):
> uses lists rather than set()s:
>              with_maintainer_list = []
>              no_maintainer_list = []
>
>              missing_recipes = []
>              recipes = []
>
> Maybe pick one data structure to be consistent.
>
> If you decide that set() is better then make a separate commit to
> change that. Apparently sets are faster for some operations:
>     https://stackoverflow.com/questions/2831212/python-sets-vs-lists
> it would be nice if you checked and documented what you find in the
> commit log since these tests do take a few minutes on a lowly laptop.
>
> The rest looks good to me. Drop the RFC if you send a v3.
>
> Thanks!
> ../Randy
>
>
> > +            for fn in tinfoil.all_recipe_files(variants=False):
> > +                if not '/meta/recipes-' in fn:
> > +                    # We are only interested in OE-Core
> > +                    continue
> > +                rd = tinfoil.parse_recipe_file(fn, appends=False)
> > +                pn = rd.getVar('BPN')
> > +                srcfile = rd.getVar('SRC_URI').split()
> > +                #Since DESCRIPTION defaults to SUMMARY if not set, we
> are only interested in recipes without DESCRIPTION or SUMMARY
> > +                if not (rd.getVar('SUMMARY') or
> rd.getVar('DESCRIPTION')):
> > +                    no_description.add((pn, fn))
> > +                if not rd.getVar('HOMEPAGE'):
> > +                    if srcfile and srcfile[0].startswith('file') or not
> rd.getVar('SRC_URI'):
> > +                        # We are only interested in recipes SRC_URI
> fetched from external sources
> > +                        continue
> > +                    no_homepage.add((pn, fn))
> > +        if no_homepage:
> > +            self.fail("""
> > +The following recipes do not have a HOMEPAGE. Please add an entry for
> HOMEPAGE in the recipe.
> > +""" + "\n".join(['%s (%s)' % i for i in no_homepage]))
> > +
> > +        if no_description:
> > +            self.fail("""
> > +The following recipes do not have a DESCRIPTION. Please add an entry
> for DESCRIPTION in the recipe.
> > +""" + "\n".join(['%s (%s)' % i for i in no_description]))
> > +
> >       def test_maintainers(self):
> >           """
> >           Summary:     Test that oe-core recipes have a maintainer and
> entries in maintainers list have a recipe
> >
> >
> >
> > 
> >
>
>
> --
> # Randy MacLeod
> # Wind River Linux
>

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [OE-core] [PATCH v2][RFC] distrodata.py: Test to track recipes without HOMEPAGE or DESCRIPTION
  2021-03-12 20:44   ` Dorinda
@ 2021-03-13 22:01     ` Randy MacLeod
  0 siblings, 0 replies; 4+ messages in thread
From: Randy MacLeod @ 2021-03-13 22:01 UTC (permalink / raw)
  To: dorinda bassey; +Cc: openembedded-core

On 2021-03-12 3:44 p.m., dorinda bassey wrote:
> Alright, I get you.
> Will send a v3 RFC.

I think it'll be ready to merge so drop the RFC!
../Randy

> 
> Thanks,
> Dorinda.
> 
> On Fri, Mar 12, 2021 at 3:11 AM Randy MacLeod 
> <randy.macleod@windriver.com <mailto:randy.macleod@windriver.com>> wrote:
> 
>     On 2021-03-08 4:12 p.m., Dorinda wrote:
>      > This test is to keep track of recipes that do not have a HOMEPAGE
>     or DESCRIPTION,
>      > with exceptions to recipes whose SRC_URI are not linked to
>     external sources.
>      >
>      > [YOCTO #13471]
>      >
>      > Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com
>     <mailto:dorindabassey@gmail.com>>
>      > ---
>      > v2:
>      > -Changed PN to BPN
>      > -Used set() instead of lists
>      > -Changed condition for checking recipes with missing DESCRIPTION
>      >
>      >   meta/lib/oeqa/selftest/cases/distrodata.py | 36
>     ++++++++++++++++++++++
>      >   1 file changed, 36 insertions(+)
>      >
>      > diff --git a/meta/lib/oeqa/selftest/cases/distrodata.py
>     b/meta/lib/oeqa/selftest/cases/distrodata.py
>      > index e1cfc3b621..633bf25dc7 100644
>      > --- a/meta/lib/oeqa/selftest/cases/distrodata.py
>      > +++ b/meta/lib/oeqa/selftest/cases/distrodata.py
>      > @@ -40,6 +40,42 @@ but their recipes claim otherwise by setting
>     UPSTREAM_VERSION_UNKNOWN. Please re
>      >   """ + "\n".join(regressed_successes)
>      >           self.assertTrue(len(regressed_failures) == 0 and
>     len(regressed_successes) == 0, msg)
>      >
>      > +    def test_missing_homepg(self):
>      > +        """
>      > +        Summary:     Test for oe-core recipes that don't have a
>     HOMEPAGE or DESCRIPTION
>      > +        Expected:    All oe-core recipes should have a
>     DESCRIPTION entry
>      > +        Expected:    All oe-core recipes should have a HOMEPAGE
>     entry except for recipes that are not fetched from external sources.
>      > +        Product:     oe-core
>      > +        """
>      > +        with bb.tinfoil.Tinfoil() as tinfoil:
>      > +            tinfoil.prepare(config_only=False)
>      > +            no_description = set()
>      > +            no_homepage = set()
> 
>     Since the other tests in this file such as:
>           def test_maintainers(self):
>     uses lists rather than set()s:
>                   with_maintainer_list = []
>                   no_maintainer_list = []
> 
>                   missing_recipes = []
>                   recipes = []
> 
>     Maybe pick one data structure to be consistent.
> 
>     If you decide that set() is better then make a separate commit to
>     change that. Apparently sets are faster for some operations:
>     https://stackoverflow.com/questions/2831212/python-sets-vs-lists
>     <https://stackoverflow.com/questions/2831212/python-sets-vs-lists>
>     it would be nice if you checked and documented what you find in the
>     commit log since these tests do take a few minutes on a lowly laptop.
> 
>     The rest looks good to me. Drop the RFC if you send a v3.
> 
>     Thanks!
>     ../Randy
> 
> 
>      > +            for fn in tinfoil.all_recipe_files(variants=False):
>      > +                if not '/meta/recipes-' in fn:
>      > +                    # We are only interested in OE-Core
>      > +                    continue
>      > +                rd = tinfoil.parse_recipe_file(fn, appends=False)
>      > +                pn = rd.getVar('BPN')
>      > +                srcfile = rd.getVar('SRC_URI').split()
>      > +                #Since DESCRIPTION defaults to SUMMARY if not
>     set, we are only interested in recipes without DESCRIPTION or SUMMARY
>      > +                if not (rd.getVar('SUMMARY') or
>     rd.getVar('DESCRIPTION')):
>      > +                    no_description.add((pn, fn))
>      > +                if not rd.getVar('HOMEPAGE'):
>      > +                    if srcfile and srcfile[0].startswith('file')
>     or not rd.getVar('SRC_URI'):
>      > +                        # We are only interested in recipes
>     SRC_URI fetched from external sources
>      > +                        continue
>      > +                    no_homepage.add((pn, fn))
>      > +        if no_homepage:
>      > +            self.fail("""
>      > +The following recipes do not have a HOMEPAGE. Please add an
>     entry for HOMEPAGE in the recipe.
>      > +""" + "\n".join(['%s (%s)' % i for i in no_homepage]))
>      > +
>      > +        if no_description:
>      > +            self.fail("""
>      > +The following recipes do not have a DESCRIPTION. Please add an
>     entry for DESCRIPTION in the recipe.
>      > +""" + "\n".join(['%s (%s)' % i for i in no_description]))
>      > +
>      >       def test_maintainers(self):
>      >           """
>      >           Summary:     Test that oe-core recipes have a
>     maintainer and entries in maintainers list have a recipe
>      >
>      >
>      >
>      > 
>      >
> 
> 
>     -- 
>     # Randy MacLeod
>     # Wind River Linux
> 


-- 
# Randy MacLeod
# Wind River Linux

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2021-03-13 22:01 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-08 21:12 [PATCH v2][RFC] distrodata.py: Test to track recipes without HOMEPAGE or DESCRIPTION Dorinda
2021-03-12  2:11 ` [OE-core] " Randy MacLeod
2021-03-12 20:44   ` Dorinda
2021-03-13 22:01     ` Randy MacLeod

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.