tests: Add test case for environment variables

These additional test cases check if the env section
can:

- export variables with their default value
- add variables with 'None' assigned only to
  BB_ENV_PASSTHROUGH_ADDITIONS or to the deprecated
  BB_ENV_EXTRAWHITE
- bitbake: make sure that variables actually make it into bitbake

The BB_ENV_EXTRAWHITE variable is still present, so a test case has also
been added for this.

Signed-off-by: Benedikt Niedermayr <benedikt.niedermayr@siemens.com>
[Jan: ensure python 3.5 compatibility, adjust copyright header]
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>

tests/test_environment_variables.py

@@ -1,5 +1,30 @@
+# kas - setup tool for bitbake based projects
+#
+# Copyright (c) Peter Hatina, 2021
+# Copyright (c) Siemens AG, 2021-2022
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 import os
 import shutil
+import pathlib
+import re
 from kas import kas
 
 
@@ -28,3 +53,74 @@ def test_build_dir_can_be_specified_by_environment_variable(changedir, tmpdir):
     del os.environ['KAS_BUILD_DIR']
 
     assert os.path.exists(os.path.join(build_dir, 'conf'))
+
+
+def _test_env_section_export(changedir, tmpdir, bb_env_var, bb_repo):
+    conf_dir = pathlib.Path(str(tmpdir.mkdir('test_env_variables')))
+    env_out = conf_dir / 'env_out'
+    bb_env_out = conf_dir / 'bb_env_out'
+    init_build_env = conf_dir / 'oe-init-build-env'
+
+    shutil.rmtree(str(conf_dir), ignore_errors=True)
+    shutil.copytree('tests/test_environment_variables', str(conf_dir))
+    os.chdir(str(conf_dir))
+
+    # Overwrite oe-init-build-env script
+    # BB_ENV_* filter variables are only exported by
+    # kas when they are already exported in the setup environment script
+    script = """#!/bin/sh
+    export %s="FOO"
+    export PATH="%s/%s/bin:${PATH}"
+    """ % (bb_env_var, str(conf_dir), bb_repo)
+    init_build_env.write_text(script)
+    init_build_env.chmod(0o775)
+
+    # Before executing bitbake, first get the bitbake.conf
+    kas.kas(['checkout', 'test_env.yml'])
+    shutil.copy(str(conf_dir / bb_repo / 'conf' / 'bitbake.conf'),
+                str(pathlib.Path('build') / 'conf' / 'bitbake.conf'))
+
+    kas.kas(['shell', '-c', 'env > %s' % env_out, 'test_env.yml'])
+    kas.kas(['shell', '-c', 'bitbake -e > %s' % bb_env_out, 'test_env.yml'])
+
+    # Check kas environment
+    test_env = {}
+    with env_out.open() as f:
+        for line in f.readlines():
+            key, val = line.split("=", 1)
+            test_env[key] = val.strip()
+
+    # Variables with 'None' assigned should not be added to environment
+    try:
+        _ = test_env['TESTVAR_WHITELIST']
+        assert False
+    except KeyError:
+        assert True
+
+    assert test_env['TESTVAR_DEFAULT_VAL'] == 'BAR'
+    assert 'TESTVAR_WHITELIST' in test_env[bb_env_var]
+
+    # Check bitbake's environment
+    test_bb_env = {}
+    with bb_env_out.open() as f:
+        for line in f.readlines():
+            if re.match(r'^#', line):
+                continue
+            match = re.match(r'(^[a-zA-Z0-9_]+)=\"([a-zA-Z0-9_ ]+)\"', line)
+            if match:
+                key, val = match.group(1), match.group(2)
+                test_bb_env[key] = val.strip()
+
+    assert 'TESTVAR_WHITELIST' in test_bb_env[bb_env_var]
+    assert test_bb_env["TESTVAR_DEFAULT_VAL"] == "BAR"
+
+
+# BB_ENV_EXTRAWHITE is deprecated but may still be used
+def test_env_section_export_bb_extra_white(changedir, tmpdir):
+    _test_env_section_export(changedir, tmpdir, 'BB_ENV_EXTRAWHITE',
+                             'bitbake_old')
+
+
+def test_env_section_export_bb_env_passthrough_additions(changedir, tmpdir):
+    _test_env_section_export(changedir, tmpdir, 'BB_ENV_PASSTHROUGH_ADDITIONS',
+                             'bitbake_new')

tests/test_environment_variables/meta-dummy/conf/layer.conf

@@ -0,0 +1,2 @@
+# We have a conf and classes directory, add to BBPATH
+BBPATH .= ":${LAYERDIR}"

tests/test_environment_variables/test_env.yml

@@ -0,0 +1,25 @@
+header:
+  version: 13
+
+env:
+  TESTVAR_DEFAULT_VAL: "BAR"
+  TESTVAR_WHITELIST:
+
+repos:
+  this:
+    layers:
+     meta-dummy:
+
+  # Testing new BB_ENV_PASSTHROUGH_ADDITIONS
+  bitbake_new:
+    url: https://git.openembedded.org/bitbake
+    refspec: 87104b6a167188921da157c7dba45938849fb22a
+    layers:
+      .: excluded
+
+  # Testing deprecated BB_ENV_WHITELIST
+  bitbake_old:
+    url: https://git.openembedded.org/bitbake
+    refspec: efaafc9ec2e8c0475e3fb27e877a1c0a5532a0e5
+    layers:
+      .: excluded