Change the test code to use pytest (#124)

Signed-off-by: cjho0316 <[email protected]>

Author: cjho0316

tests/__init__.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+
+from fosslight_scanner._get_input import get_input, get_input_mode
+
+
+def test_get_input(monkeypatch):
+    # given
+    ask_msg = "Please enter the path to analyze:"
+    default_value = "default"
+
+    # when
+    # Mock input to return an empty string
+    monkeypatch.setattr('builtins.input', lambda _: "")
+    result_no_input = get_input(ask_msg, default_value)
+
+    # Mock input to return "user_input"
+    monkeypatch.setattr('builtins.input', lambda _: "user_input")
+    result_with_input = get_input(ask_msg, "user_input")
+
+    # then
+    assert result_no_input == "default"
+    assert result_with_input == "user_input"
+
+
+def test_get_input_mode(monkeypatch):
+    # given
+    executed_path = ""
+    mode_list = ["all", "dep"]
+
+    # Mock ask_to_run to return a predetermined input value
+    monkeypatch.setattr('fosslight_scanner._get_input.ask_to_run', lambda _: "1")
+
+    # Mock input to provide other necessary return values
+    monkeypatch.setattr('builtins.input', lambda _: "https://example.com")
+
+    # when
+    _, _, url_to_analyze = get_input_mode(executed_path, mode_list)
+
+    # then
+    assert url_to_analyze == "https://example.com"

tests/requirements.txt

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+
+import sys
+from fosslight_scanner._help import print_help_msg, _HELP_MESSAGE_SCANNER
+
+
+def test_print_help_msg(capsys, monkeypatch):
+    # given
+    # monkeypatch sys.exit to prevent the test from stopping
+    monkeypatch.setattr(sys, "exit", lambda: None)
+
+    # when
+    print_help_msg()
+
+    # then
+    captured = capsys.readouterr()
+    # Validate the help message output
+    assert _HELP_MESSAGE_SCANNER.strip() in captured.out

tests/test__get_input.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+from fosslight_scanner._parse_setting import parse_setting_json
+
+
+def test_parse_setting_json_valid_data():
+    data = {
+        'mode': ['test'],
+        'path': ['/some/path'],
+        'dep_argument': 'arg',
+        'output': 'output',
+        'format': 'json',
+        'link': 'http://example.com',
+        'db_url': 'sqlite:///:memory:',
+        'timer': True,
+        'raw': True,
+        'core': 4,
+        'no_correction': True,
+        'correct_fpath': '/correct/path',
+        'ui': True,
+        'exclude': ['/exclude/path'],
+        'selected_source_scanner': 'scanner',
+        'source_write_json_file': True,
+        'source_print_matched_text': True,
+        'source_time_out': 60,
+        'binary_simple': True
+    }
+    result = parse_setting_json(data)
+    assert result == (
+        ['test'], ['/some/path'], 'arg', 'output', 'json', 'http://example.com', 'sqlite:///:memory:', True,
+        True, 4, True, '/correct/path', True, ['/exclude/path'], 'scanner', True, True, 60, True
+    )

tests/test__help.py

@@ -0,0 +1,199 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+
+import pytest
+from fosslight_scanner._run_compare import write_result_json_yaml, parse_result_for_table, get_sample_html, \
+    write_result_html, write_result_xlsx, write_compared_result, get_comparison_result_filename, \
+    count_compared_result, run_compare, \
+    ADD, DELETE, CHANGE, XLSX_EXT, HTML_EXT, YAML_EXT, JSON_EXT
+import logging
+import json
+import yaml
+
+
+@pytest.mark.parametrize("ext, expected_content", [
+    # Test for JSON and YAML extensions
+    (".json", {"key": "value"}),
+    (".yaml", {"key": "value"}),
+
+    # Test for TXT extension (failure)
+    (".txt", {"key": "value"}),
+])
+def test_write_result_json_yaml(tmp_path, ext, expected_content):
+    # given
+    output_file = tmp_path / f"result{ext}"
+    compared_result = expected_content
+
+    # when
+    success = write_result_json_yaml(output_file, compared_result, ext)
+
+    # then
+    assert success is True, f"Failed to write file with extension {ext}"
+
+    # Verify content based on extension
+    if ext == ".json":
+        with open(output_file, 'r', encoding='utf-8') as f:
+            result_content = json.load(f)
+        assert result_content == compared_result, "The content of the JSON file does not match the expected content."
+
+    elif ext == ".yaml":
+        with open(output_file, 'r', encoding='utf-8') as f:
+            result_content = yaml.safe_load(f)
+        assert result_content == compared_result, "The content of the YAML file does not match the expected content."
+
+    elif ext == ".txt":
+        with open(output_file, 'r', encoding='utf-8') as f:
+            result_lines = f.readlines()
+        result_content = ''.join(result_lines)
+        assert result_content != compared_result, "The content of the TXT file does not match the expected string representation."
+
+
+def test_parse_result_for_table():
+    # given
+    add_expected = [ADD, '', '', 'test(1.0)', 'MIT']
+    oi = {"name": "test", "version": "1.0", "license": ["MIT"]}
+
+    # when
+    add_result = parse_result_for_table(oi, ADD)
+
+    # then
+    assert add_result == add_expected
+
+
+def test_get_sample_html():
+    # then
+    assert get_sample_html() != ''
+
+
+@pytest.mark.parametrize("compared_result, expected_before, expected_after", [
+    # Case with empty add, delete, change
+    ({ADD: [], DELETE: [], CHANGE: []}, "before.yaml", "after.yaml"),
+
+    # Case with one entry in add and no deletes or changes
+    ({ADD: [{"name": "test", "version": "1.0", "license": ["MIT"]}], DELETE: [], CHANGE: []},
+     "before.yaml", "after.yaml")
+])
+def test_write_result_html(tmp_path, compared_result, expected_before, expected_after):
+    # given
+    output_file = tmp_path / "result.html"
+
+    # when
+    success = write_result_html(output_file, compared_result, expected_before, expected_after)
+
+    # then
+    assert success is True, "Failed to write the HTML file."
+    assert output_file.exists(), "The HTML file was not created."
+    with open(output_file, 'r', encoding='utf-8') as f:
+        content = f.read()
+        assert content, "The HTML file is empty."
+
+
+@pytest.mark.parametrize("compared_result", [
+    # Case with empty add, delete, change
+    {ADD: [], DELETE: [], CHANGE: []},
+
+    # Case with one entry in add and no deletes or changes
+    {ADD: [{"name": "test", "version": "1.0", "license": ["MIT"]}], DELETE: [], CHANGE: []}
+])
+def test_write_result_xlsx(tmp_path, compared_result):
+    # given
+    output_file = tmp_path / "result.xlsx"
+
+    # when
+    success = write_result_xlsx(output_file, compared_result)
+
+    # then
+    assert success is True, "Failed to write the XLSX file."
+    assert output_file.exists(), "The XLSX file was not created."
+
+
+@pytest.mark.parametrize("ext, expected_output", [
+    (XLSX_EXT, "xlsx"),
+    (HTML_EXT, "html"),
+    (JSON_EXT, "json"),
+    (YAML_EXT, "yaml"),
+])
+def test_write_compared_result(tmp_path, ext, expected_output):
+    # given
+    output_file = tmp_path / "result"
+    compared_result = {ADD: [], DELETE: [], CHANGE: []}
+
+    # when
+    success, result_file = write_compared_result(output_file, compared_result, ext)
+
+    # then
+    assert success is True, f"Failed to write the compared result for extension {ext}"
+    if ext == XLSX_EXT:
+        assert str(result_file) == str(output_file), "The XLSX result file path does not match the expected output path."
+    elif ext == HTML_EXT:
+        expected_result_file = f"{str(output_file) + XLSX_EXT}, {str(output_file)}"
+        assert result_file == expected_result_file, "HTML file creation failed."
+    elif ext == JSON_EXT:
+        assert str(result_file) == str(output_file), "The JSON result file path does not match the expected output path."
+    else:
+        assert str(result_file) == str(output_file), "The YAML result file path does not match the expected output path."
+
+
+@pytest.mark.parametrize("path, file_name, ext, time_suffix, expected_output", [
+    # Case when file name is provided
+    ("/path", "file", XLSX_EXT, "time", "/path/file.xlsx"),
+
+    # Case when file name is empty, with different extensions
+    ("/path", "", XLSX_EXT, "time", "/path/fosslight_compare_time.xlsx"),
+    ("/path", "", HTML_EXT, "time", "/path/fosslight_compare_time.html"),
+    ("/path", "", YAML_EXT, "time", "/path/fosslight_compare_time.yaml"),
+    ("/path", "", JSON_EXT, "time", "/path/fosslight_compare_time.json"),
+])
+def test_get_comparison_result_filename(path, file_name, ext, time_suffix, expected_output):
+    # when
+    result = get_comparison_result_filename(path, file_name, ext, time_suffix)
+
+    # then
+    assert result == expected_output, f"Expected {expected_output} but got {result}"
+
+
+@pytest.mark.parametrize("compared_result, expected_log", [
+    ({ADD: [], DELETE: [], CHANGE: []}, "all oss lists are the same."),
+    ({ADD: [{"name": "test"}], DELETE: [], CHANGE: []}, "total 1 oss updated (add: 1, delete: 0, change: 0)")
+])
+def test_count_compared_result(compared_result, expected_log, caplog):
+    # when
+    with caplog.at_level(logging.INFO):
+        count_compared_result(compared_result)
+    # then
+    assert expected_log in caplog.text
+
+
+def test_run_compare_different_extension(tmp_path):
+    # given
+    before_f = tmp_path / "before.yaml"
+    after_f = tmp_path / "after.xlsx"
+    output_path = tmp_path
+    output_file = "result"
+    file_ext = ".yaml"
+    _start_time = "time"
+    _output_dir = tmp_path
+
+    # Write example content to before_f and after_f
+    before_content = {
+        "oss_list": [
+            {"name": "test", "version": "1.0", "license": "MIT"}
+        ]
+    }
+
+    # Write these contents to the files
+    with open(before_f, "w") as bf:
+        yaml.dump(before_content, bf)
+
+    # Create an empty xlsx file for after_f
+    with open(after_f, "w") as af:
+        af.write("")
+
+    # when
+    comparison_result = run_compare(before_f, after_f, output_path, output_file, file_ext, _start_time, _output_dir)
+
+    # then
+    assert comparison_result is False

tests/test__parse_setting.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+import pytest
+import json
+import sys
+from fosslight_scanner.cli import main, set_args
+
+
+def test_set_args(monkeypatch):
+    # Mocking os.path.isfile to return True
+    monkeypatch.setattr("os.path.isfile", lambda x: True)
+
+    # Mocking the open function to return a mock file object
+    mock_file_data = json.dumps({
+        "mode": ["test_mode"],
+        "path": ["test_path"],
+        "dep_argument": "test_dep_argument",
+        "output": "test_output",
+        "format": "test_format",
+        "link": "test_link",
+        "db_url": "test_db_url",
+        "timer": True,
+        "raw": True,
+        "core": 4,
+        "no_correction": True,
+        "correct_fpath": "test_correct_fpath",
+        "ui": True,
+        "exclude": ["test_exclude_path"],
+        "selected_source_scanner": "test_scanner",
+        "source_write_json_file": True,
+        "source_print_matched_text": True,
+        "source_time_out": 100,
+        "binary_simple": True
+    })
+
+    def mock_open(*args, **kwargs):
+        from io import StringIO
+        return StringIO(mock_file_data)
+
+    monkeypatch.setattr("builtins.open", mock_open)
+
+    # Call the function with some arguments
+    result = set_args(
+        mode=None, path=None, dep_argument=None, output=None, format=None, link=None, db_url=None, timer=None,
+        raw=None, core=-1, no_correction=None, correct_fpath=None, ui=None, setting="dummy_path", exclude_path=None
+    )
+
+    # Expected result
+    expected = (
+        ["test_mode"], ["test_path"], "test_dep_argument", "test_output", "test_format", "test_link", "test_db_url", True,
+        True, 4, True, "test_correct_fpath", True, ["test_exclude_path"], "test_scanner", True, True, 100, True
+    )
+
+    assert result == expected
+
+
+def test_main_invalid_option(capsys):
+    # given
+    test_args = ["fosslight_scanner", "--invalid_option"]
+    sys.argv = test_args
+
+    # when
+    with pytest.raises(SystemExit):  # 예상되는 SystemExit 처리
+        main()
+
+    # then
+    captured = capsys.readouterr()
+    assert "unrecognized arguments" in captured.err  # 인식되지 않은 인자에 대한 에러 메시지 확인