]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core-contrib.git/commitdiff
scripts: rename yocto-compat-layer to remove "compatible" nomenclature
authorPaul Eggleton <paul.eggleton@linux.intel.com>
Tue, 19 Sep 2017 03:57:07 +0000 (15:57 +1200)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Thu, 21 Sep 2017 10:34:08 +0000 (11:34 +0100)
"Yocto Project Compatible" [1] is a programme which requires you meet
specific criteria including going through an application process - it is
not sufficient simply to run the script we have created here and have it
produce no warnings/errors. To avoid people being confused by the fact
that this script uses the term "compatible" or variations thereof,
substitute usage of that word with "check" instead. The functionality of
the script is unchanged.

[1] https://www.yoctoproject.org/ecosystem/yocto-project-branding-program

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
scripts/lib/checklayer/__init__.py [moved from scripts/lib/compatlayer/__init__.py with 99% similarity]
scripts/lib/checklayer/case.py [moved from scripts/lib/compatlayer/case.py with 77% similarity]
scripts/lib/checklayer/cases/__init__.py [moved from scripts/lib/compatlayer/cases/__init__.py with 100% similarity]
scripts/lib/checklayer/cases/bsp.py [moved from scripts/lib/compatlayer/cases/bsp.py with 96% similarity]
scripts/lib/checklayer/cases/common.py [moved from scripts/lib/compatlayer/cases/common.py with 91% similarity]
scripts/lib/checklayer/cases/distro.py [moved from scripts/lib/compatlayer/cases/distro.py with 77% similarity]
scripts/lib/checklayer/context.py [moved from scripts/lib/compatlayer/context.py with 77% similarity]
scripts/yocto-check-layer [moved from scripts/yocto-compat-layer.py with 91% similarity]
scripts/yocto-check-layer-wrapper [moved from scripts/yocto-compat-layer-wrapper with 73% similarity]

similarity index 99%
rename from scripts/lib/compatlayer/__init__.py
rename to scripts/lib/checklayer/__init__.py
index 7197e850e443678fddb4fcfda65c73ea78d031da..6c2b86a79a16ab7645c80d944898f6ac9d930c83 100644 (file)
@@ -1,4 +1,4 @@
-# Yocto Project compatibility layer tool
+# Yocto Project layer check tool
 #
 # Copyright (C) 2017 Intel Corporation
 # Released under the MIT license (see COPYING.MIT)
similarity index 77%
rename from scripts/lib/compatlayer/case.py
rename to scripts/lib/checklayer/case.py
index 54ce78aa600181167a55c36df98bc238c8163e1b..9dd00412e522dd3ff2a0bc82872c210cc53b2c47 100644 (file)
@@ -3,5 +3,5 @@
 
 from oeqa.core.case import OETestCase
 
-class OECompatLayerTestCase(OETestCase):
+class OECheckLayerTestCase(OETestCase):
     pass
similarity index 96%
rename from scripts/lib/compatlayer/cases/bsp.py
rename to scripts/lib/checklayer/cases/bsp.py
index 43efae406f419d7325b38fe85f8d0f1d0c81caa3..b6b611be731443558db0ab65f5ee608255c408fd 100644 (file)
@@ -3,14 +3,14 @@
 
 import unittest
 
-from compatlayer import LayerType, get_signatures, check_command, get_depgraph
-from compatlayer.case import OECompatLayerTestCase
+from checklayer import LayerType, get_signatures, check_command, get_depgraph
+from checklayer.case import OECheckLayerTestCase
 
-class BSPCompatLayer(OECompatLayerTestCase):
+class BSPCheckLayer(OECheckLayerTestCase):
     @classmethod
     def setUpClass(self):
         if self.tc.layer['type'] != LayerType.BSP:
-            raise unittest.SkipTest("BSPCompatLayer: Layer %s isn't BSP one." %\
+            raise unittest.SkipTest("BSPCheckLayer: Layer %s isn't BSP one." %\
                 self.tc.layer['name'])
 
     def test_bsp_defines_machines(self):
@@ -62,7 +62,7 @@ class BSPCompatLayer(OECompatLayerTestCase):
         This criteria can only be tested by testing different machines in combination,
         i.e. one main layer, potentially several additional BSP layers and an explicit
         choice of machines:
-        yocto-compat-layer --additional-layers .../meta-intel --machines intel-corei7-64 imx6slevk -- .../meta-freescale
+        yocto-check-layer --additional-layers .../meta-intel --machines intel-corei7-64 imx6slevk -- .../meta-freescale
         '''
 
         if not self.td['machines']:
similarity index 91%
rename from scripts/lib/compatlayer/cases/common.py
rename to scripts/lib/checklayer/cases/common.py
index 55e8ba4c51e7601bf78f43b6a7dc94c3f1e99661..a13c1088f07da69683b9f3a3efc1aac7cfe0d276 100644 (file)
@@ -4,10 +4,10 @@
 import glob
 import os
 import unittest
-from compatlayer import get_signatures, LayerType, check_command, get_depgraph, compare_signatures
-from compatlayer.case import OECompatLayerTestCase
+from checklayer import get_signatures, LayerType, check_command, get_depgraph, compare_signatures
+from checklayer.case import OECheckLayerTestCase
 
-class CommonCompatLayer(OECompatLayerTestCase):
+class CommonCheckLayer(OECheckLayerTestCase):
     def test_readme(self):
         # The top-level README file may have a suffix (like README.rst or README.txt).
         readme_files = glob.glob(os.path.join(self.tc.layer['path'], 'README*'))
similarity index 77%
rename from scripts/lib/compatlayer/cases/distro.py
rename to scripts/lib/checklayer/cases/distro.py
index 523acc1e7884e76da84e172ec6a562e8c1401fac..df1b3035eb347cd76c7df551ee938c14b70ee6a8 100644 (file)
@@ -3,14 +3,14 @@
 
 import unittest
 
-from compatlayer import LayerType
-from compatlayer.case import OECompatLayerTestCase
+from checklayer import LayerType
+from checklayer.case import OECheckLayerTestCase
 
-class DistroCompatLayer(OECompatLayerTestCase):
+class DistroCheckLayer(OECheckLayerTestCase):
     @classmethod
     def setUpClass(self):
         if self.tc.layer['type'] != LayerType.DISTRO:
-            raise unittest.SkipTest("DistroCompatLayer: Layer %s isn't Distro one." %\
+            raise unittest.SkipTest("DistroCheckLayer: Layer %s isn't Distro one." %\
                 self.tc.layer['name'])
 
     def test_distro_defines_distros(self):
similarity index 77%
rename from scripts/lib/compatlayer/context.py
rename to scripts/lib/checklayer/context.py
index 7811d4ac20cd9a1a2a73ea7b04c2bcbfcf9c060c..1bec2c4103188c56f6274f4416d0b4652314276a 100644 (file)
@@ -8,8 +8,8 @@ import re
 
 from oeqa.core.context import OETestContext
 
-class CompatLayerTestContext(OETestContext):
+class CheckLayerTestContext(OETestContext):
     def __init__(self, td=None, logger=None, layer=None, test_software_layer_signatures=True):
-        super(CompatLayerTestContext, self).__init__(td, logger)
+        super(CheckLayerTestContext, self).__init__(td, logger)
         self.layer = layer
         self.test_software_layer_signatures = test_software_layer_signatures
similarity index 91%
rename from scripts/yocto-compat-layer.py
rename to scripts/yocto-check-layer
index 9a541c66e57f131137949101d1b7f5dacc40a81a..5a4fd752ca9ba8e3b57de54a0f9e76e9518473f5 100755 (executable)
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-# Yocto Project compatibility layer tool
+# Yocto Project layer checking tool
 #
 # Copyright (C) 2017 Intel Corporation
 # Released under the MIT license (see COPYING.MIT)
@@ -22,29 +22,29 @@ import scriptpath
 scriptpath.add_oe_lib_path()
 scriptpath.add_bitbake_lib_path()
 
-from compatlayer import LayerType, detect_layers, add_layer, add_layer_dependencies, get_signatures
+from checklayer import LayerType, detect_layers, add_layer, add_layer_dependencies, get_signatures
 from oeqa.utils.commands import get_bb_vars
 
-PROGNAME = 'yocto-compat-layer'
+PROGNAME = 'yocto-check-layer'
 CASES_PATHS = [os.path.join(os.path.abspath(os.path.dirname(__file__)),
-                'lib', 'compatlayer', 'cases')]
+                'lib', 'checklayer', 'cases')]
 logger = scriptutils.logger_create(PROGNAME, stream=sys.stdout)
 
-def test_layer_compatibility(td, layer, test_software_layer_signatures):
-    from compatlayer.context import CompatLayerTestContext
+def test_layer(td, layer, test_software_layer_signatures):
+    from checklayer.context import CheckLayerTestContext
     logger.info("Starting to analyze: %s" % layer['name'])
     logger.info("----------------------------------------------------------------------")
 
-    tc = CompatLayerTestContext(td=td, logger=logger, layer=layer, test_software_layer_signatures=test_software_layer_signatures)
+    tc = CheckLayerTestContext(td=td, logger=logger, layer=layer, test_software_layer_signatures=test_software_layer_signatures)
     tc.loadTests(CASES_PATHS)
     return tc.runTests()
 
 def main():
     parser = argparse.ArgumentParser(
-            description="Yocto Project compatibility layer tool",
+            description="Yocto Project layer checking tool",
             add_help=False)
     parser.add_argument('layers', metavar='LAYER_DIR', nargs='+',
-            help='Layer to test compatibility with Yocto Project')
+            help='Layer to check')
     parser.add_argument('-o', '--output-log',
             help='File to output log (optional)', action='store')
     parser.add_argument('--dependency', nargs="+",
@@ -179,7 +179,7 @@ def main():
             layers_tested = layers_tested + 1
             continue
 
-        result = test_layer_compatibility(td, layer, args.test_software_layer_signatures)
+        result = test_layer(td, layer, args.test_software_layer_signatures)
         results[layer['name']] = result
         results_status[layer['name']] = 'PASS' if results[layer['name']].wasSuccessful() else 'FAIL'
         layers_tested = layers_tested + 1
similarity index 73%
rename from scripts/yocto-compat-layer-wrapper
rename to scripts/yocto-check-layer-wrapper
index b6baeb484eda21992fbbf1109c0677770e90edc3..bbf6ee176deb70c207423fad507f1af9ea78dd0c 100755 (executable)
@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 
-# Yocto Project compatibility layer tool wrapper
+# Yocto Project layer check tool wrapper
 #
-# Creates a temprary build directory to run Yocto Project Compatible
+# Creates a temporary build directory to run the yocto-check-layer
 # script to avoid a contaminated environment.
 #
 # Copyright (C) 2017 Intel Corporation
@@ -24,7 +24,7 @@ do
 done
 shift $(($OPTIND - 1))
 
-# generate a temp directory to run compat layer script
+# generate a temp directory to run check layer script
 base_dir=$(realpath $BUILDDIR/../)
 cd $base_dir
 
@@ -32,9 +32,9 @@ build_dir=$(mktemp -p $base_dir -d -t build-XXXX)
 
 source oe-init-build-env $build_dir
 if [[ $output_log != '' ]]; then
-       yocto-compat-layer.py -o "$output_log" "$*"
+       yocto-check-layer -o "$output_log" "$*"
 else
-       yocto-compat-layer.py "$@"
+       yocto-check-layer "$@"
 fi
 retcode=$?