sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-01-31 02:00:45 +00:00
Code Issues Releases Wiki Activity
devlib/tests/test_target.py

77 lines
2.2 KiB
Python
Raw Normal View History

test_target: Add copyright statement Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-01-10 15:56:35 +00:00
#
# Copyright 2024 ARM Limited
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
tests/test_target: Read target connection settings from a YAML file This will be useful in automating CI tests without modifying the source code. Replace unittest with pytest in order to make parameter passing to test functions easier. Move target configuration reading and generating target object outside of the test function. Because we will run the test function for new targets and may want to add new test functions. While we are here, also fix pylint issues. Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-02-05 08:36:19 +00:00
"""Module for testing targets."""
target: read_tree_values: handle multiline values Extend Target.read_tree_values() to handle notes that contain line breaks in their values. Underlying this method, is a call to grep -r '' /tree/root/ When files under that location contain multiple lines, grep will output each line prefixed with the path; e.g. a file "test" with the contents "one\n\ntwo\n" will be output by grep as: /tree/root/test: one /tree/root/test: /tree/root/test: two Previous implementation of read_tree_values() was assuming one value per line, and that the paths were unique. Since it wasn't checking for duplicate paths, it would simply override the earlier entries resulting with the value of "two" for test. This change ensure that such multiline values are now handled correctly, and the entire value is preserved. To keep compatibility with existing uses of read_tree_values(), the trailing new lines are stripped.
2018-08-23 09:57:56 +01:00
import os
import shutil
import tempfile
tests/test_target: Read target connection settings from a YAML file This will be useful in automating CI tests without modifying the source code. Replace unittest with pytest in order to make parameter passing to test functions easier. Move target configuration reading and generating target object outside of the test function. Because we will run the test function for new targets and may want to add new test functions. While we are here, also fix pylint issues. Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-02-05 08:36:19 +00:00
from pprint import pp
import pytest
target: read_tree_values: handle multiline values Extend Target.read_tree_values() to handle notes that contain line breaks in their values. Underlying this method, is a call to grep -r '' /tree/root/ When files under that location contain multiple lines, grep will output each line prefixed with the path; e.g. a file "test" with the contents "one\n\ntwo\n" will be output by grep as: /tree/root/test: one /tree/root/test: /tree/root/test: two Previous implementation of read_tree_values() was assuming one value per line, and that the paths were unique. Since it wasn't checking for duplicate paths, it would simply override the earlier entries resulting with the value of "two" for test. This change ensure that such multiline values are now handled correctly, and the entire value is preserved. To keep compatibility with existing uses of read_tree_values(), the trailing new lines are stripped.
2018-08-23 09:57:56 +01:00
from devlib import LocalLinuxTarget
tests/test_target: Read target connection settings from a YAML file This will be useful in automating CI tests without modifying the source code. Replace unittest with pytest in order to make parameter passing to test functions easier. Move target configuration reading and generating target object outside of the test function. Because we will run the test function for new targets and may want to add new test functions. While we are here, also fix pylint issues. Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-02-05 08:36:19 +00:00
from devlib.utils.misc import load_struct_from_yaml
def build_targets():
"""Read targets from a YAML formatted config file"""
config_file = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'target_configs.yaml')
target_configs = load_struct_from_yaml(config_file)
if target_configs is None:
raise ValueError(f'{config_file} looks empty!')
targets = []
if target_configs.get('LocalLinuxTarget') is not None:
print('> LocalLinux targets:')
for entry in target_configs['LocalLinuxTarget'].values():
pp(entry)
ll_target = LocalLinuxTarget(connection_settings=entry['connection_settings'])
targets.append(ll_target)
return targets
target: read_tree_values: handle multiline values Extend Target.read_tree_values() to handle notes that contain line breaks in their values. Underlying this method, is a call to grep -r '' /tree/root/ When files under that location contain multiple lines, grep will output each line prefixed with the path; e.g. a file "test" with the contents "one\n\ntwo\n" will be output by grep as: /tree/root/test: one /tree/root/test: /tree/root/test: two Previous implementation of read_tree_values() was assuming one value per line, and that the paths were unique. Since it wasn't checking for duplicate paths, it would simply override the earlier entries resulting with the value of "two" for test. This change ensure that such multiline values are now handled correctly, and the entire value is preserved. To keep compatibility with existing uses of read_tree_values(), the trailing new lines are stripped.
2018-08-23 09:57:56 +01:00
tests/test_target: Read target connection settings from a YAML file This will be useful in automating CI tests without modifying the source code. Replace unittest with pytest in order to make parameter passing to test functions easier. Move target configuration reading and generating target object outside of the test function. Because we will run the test function for new targets and may want to add new test functions. While we are here, also fix pylint issues. Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-02-05 08:36:19 +00:00
@pytest.mark.parametrize("target", build_targets())
def test_read_multiline_values(target):
"""
Test Target.read_tree_values_flat()
target: read_tree_values: handle multiline values Extend Target.read_tree_values() to handle notes that contain line breaks in their values. Underlying this method, is a call to grep -r '' /tree/root/ When files under that location contain multiple lines, grep will output each line prefixed with the path; e.g. a file "test" with the contents "one\n\ntwo\n" will be output by grep as: /tree/root/test: one /tree/root/test: /tree/root/test: two Previous implementation of read_tree_values() was assuming one value per line, and that the paths were unique. Since it wasn't checking for duplicate paths, it would simply override the earlier entries resulting with the value of "two" for test. This change ensure that such multiline values are now handled correctly, and the entire value is preserved. To keep compatibility with existing uses of read_tree_values(), the trailing new lines are stripped.
2018-08-23 09:57:56 +01:00
tests/test_target: Read target connection settings from a YAML file This will be useful in automating CI tests without modifying the source code. Replace unittest with pytest in order to make parameter passing to test functions easier. Move target configuration reading and generating target object outside of the test function. Because we will run the test function for new targets and may want to add new test functions. While we are here, also fix pylint issues. Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-02-05 08:36:19 +00:00
:param target: Type of target per :class:`Target` based classes.
:type target: Target
"""
target: read_tree_values: handle multiline values Extend Target.read_tree_values() to handle notes that contain line breaks in their values. Underlying this method, is a call to grep -r '' /tree/root/ When files under that location contain multiple lines, grep will output each line prefixed with the path; e.g. a file "test" with the contents "one\n\ntwo\n" will be output by grep as: /tree/root/test: one /tree/root/test: /tree/root/test: two Previous implementation of read_tree_values() was assuming one value per line, and that the paths were unique. Since it wasn't checking for duplicate paths, it would simply override the earlier entries resulting with the value of "two" for test. This change ensure that such multiline values are now handled correctly, and the entire value is preserved. To keep compatibility with existing uses of read_tree_values(), the trailing new lines are stripped.
2018-08-23 09:57:56 +01:00
tests/test_target: Read target connection settings from a YAML file This will be useful in automating CI tests without modifying the source code. Replace unittest with pytest in order to make parameter passing to test functions easier. Move target configuration reading and generating target object outside of the test function. Because we will run the test function for new targets and may want to add new test functions. While we are here, also fix pylint issues. Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-02-05 08:36:19 +00:00
data = {
'test1': '1',
'test2': '2\n\n',
'test3': '3\n\n4\n\n',
}
target: read_tree_values: handle multiline values Extend Target.read_tree_values() to handle notes that contain line breaks in their values. Underlying this method, is a call to grep -r '' /tree/root/ When files under that location contain multiple lines, grep will output each line prefixed with the path; e.g. a file "test" with the contents "one\n\ntwo\n" will be output by grep as: /tree/root/test: one /tree/root/test: /tree/root/test: two Previous implementation of read_tree_values() was assuming one value per line, and that the paths were unique. Since it wasn't checking for duplicate paths, it would simply override the earlier entries resulting with the value of "two" for test. This change ensure that such multiline values are now handled correctly, and the entire value is preserved. To keep compatibility with existing uses of read_tree_values(), the trailing new lines are stripped.
2018-08-23 09:57:56 +01:00
tests/test_target: Read target connection settings from a YAML file This will be useful in automating CI tests without modifying the source code. Replace unittest with pytest in order to make parameter passing to test functions easier. Move target configuration reading and generating target object outside of the test function. Because we will run the test function for new targets and may want to add new test functions. While we are here, also fix pylint issues. Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-02-05 08:36:19 +00:00
tempdir = tempfile.mkdtemp(prefix='devlib-test-')
for key, value in data.items():
path = os.path.join(tempdir, key)
with open(path, 'w', encoding='utf-8') as wfh:
wfh.write(value)
target: read_tree_values: handle multiline values Extend Target.read_tree_values() to handle notes that contain line breaks in their values. Underlying this method, is a call to grep -r '' /tree/root/ When files under that location contain multiple lines, grep will output each line prefixed with the path; e.g. a file "test" with the contents "one\n\ntwo\n" will be output by grep as: /tree/root/test: one /tree/root/test: /tree/root/test: two Previous implementation of read_tree_values() was assuming one value per line, and that the paths were unique. Since it wasn't checking for duplicate paths, it would simply override the earlier entries resulting with the value of "two" for test. This change ensure that such multiline values are now handled correctly, and the entire value is preserved. To keep compatibility with existing uses of read_tree_values(), the trailing new lines are stripped.
2018-08-23 09:57:56 +01:00
tests/test_target: Read target connection settings from a YAML file This will be useful in automating CI tests without modifying the source code. Replace unittest with pytest in order to make parameter passing to test functions easier. Move target configuration reading and generating target object outside of the test function. Because we will run the test function for new targets and may want to add new test functions. While we are here, also fix pylint issues. Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-02-05 08:36:19 +00:00
raw_result = target.read_tree_values_flat(tempdir)
result = {os.path.basename(k): v for k, v in raw_result.items()}
target: read_tree_values: handle multiline values Extend Target.read_tree_values() to handle notes that contain line breaks in their values. Underlying this method, is a call to grep -r '' /tree/root/ When files under that location contain multiple lines, grep will output each line prefixed with the path; e.g. a file "test" with the contents "one\n\ntwo\n" will be output by grep as: /tree/root/test: one /tree/root/test: /tree/root/test: two Previous implementation of read_tree_values() was assuming one value per line, and that the paths were unique. Since it wasn't checking for duplicate paths, it would simply override the earlier entries resulting with the value of "two" for test. This change ensure that such multiline values are now handled correctly, and the entire value is preserved. To keep compatibility with existing uses of read_tree_values(), the trailing new lines are stripped.
2018-08-23 09:57:56 +01:00
tests/test_target: Read target connection settings from a YAML file This will be useful in automating CI tests without modifying the source code. Replace unittest with pytest in order to make parameter passing to test functions easier. Move target configuration reading and generating target object outside of the test function. Because we will run the test function for new targets and may want to add new test functions. While we are here, also fix pylint issues. Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-02-05 08:36:19 +00:00
shutil.rmtree(tempdir)
target: read_tree_values: handle multiline values Extend Target.read_tree_values() to handle notes that contain line breaks in their values. Underlying this method, is a call to grep -r '' /tree/root/ When files under that location contain multiple lines, grep will output each line prefixed with the path; e.g. a file "test" with the contents "one\n\ntwo\n" will be output by grep as: /tree/root/test: one /tree/root/test: /tree/root/test: two Previous implementation of read_tree_values() was assuming one value per line, and that the paths were unique. Since it wasn't checking for duplicate paths, it would simply override the earlier entries resulting with the value of "two" for test. This change ensure that such multiline values are now handled correctly, and the entire value is preserved. To keep compatibility with existing uses of read_tree_values(), the trailing new lines are stripped.
2018-08-23 09:57:56 +01:00
tests/test_target: Read target connection settings from a YAML file This will be useful in automating CI tests without modifying the source code. Replace unittest with pytest in order to make parameter passing to test functions easier. Move target configuration reading and generating target object outside of the test function. Because we will run the test function for new targets and may want to add new test functions. While we are here, also fix pylint issues. Signed-off-by: Metin Kaya <metin.kaya@arm.com>
2024-02-05 08:36:19 +00:00
assert {k: v.strip() for k, v in data.items()} == result
Reference in New Issue Copy Permalink