more tests

Author: FredHappyface

licensecheck/io/cli.py

@@ -133,7 +133,7 @@ def cli() -> None:  # pragma: no cover
 		config += Config.from_path(file, optional=True)
 
 	scopedData: ConfigNode = config.get("tool", {}).get("licensecheck", ConfigNode())
-	licensecheckConf: LC_Config = LC_Config.from_mapping(**scopedData.data, **args)
+	licensecheckConf: LC_Config = LC_Config.from_mapping(**{**scopedData.data, **args})
 
 	ec = main(licensecheckConf)
 	stdin_path.unlink(missing_ok=True)

licensecheck/models/packageinfo.py

@@ -30,8 +30,9 @@ def get_filtered_dict(self, hide_output_parameters: set[str]) -> dict:
 		:param set[str] hide_output_parameters: set of parameters to ignore
 		:return dict: filtered dictionary
 		"""
+		hide_output_parameters_upper = {x.upper for x in hide_output_parameters}
 		return {
 			k: (v if v is not None else UNKNOWN)
 			for k, v in self.__dict__.items()
-			if k.upper() not in hide_output_parameters
+			if k.upper() not in hide_output_parameters_upper
 		}

tests/io/data/fmt/advanced_ignore_params.json

@@ -10,6 +10,8 @@
 			"name": "example0",
 			"version": "1.0.0",
 			"size": 10,
+			"homePage": "https://example.com",
+			"author": "example_author",
 			"license": "mit",
 			"licenseCompat": true,
 			"errorCode": 0,
@@ -19,6 +21,8 @@
 			"name": "example1",
 			"version": "UNKNOWN",
 			"size": 10,
+			"homePage": "https://example.com",
+			"author": "example_author",
 			"license": "gpl3",
 			"licenseCompat": false,
 			"errorCode": 1,

tests/io/test_cli_main.py

@@ -0,0 +1,214 @@
+import pytest
+
+from licensecheck.models.config import LC_Config
+from licensecheck.io.cli import main
+
+
+@pytest.fixture
+def config() -> LC_Config:
+	return LC_Config(
+		requirements_paths={"requirements.txt"},
+		file=None,
+		license="MIT",
+		pypi_api=None,
+		groups=set(),
+		extras=set(),
+		ignore_packages=set(),
+		fail_packages=set(),
+		ignore_licenses=set(),
+		fail_licenses=set(),
+		only_licenses=set(),
+		skip_dependencies=set(),
+		hide_output_parameters=set(),
+		format="simple",
+		show_only_failing=False,
+		zero=False,
+	)
+
+
+def test_main_success(
+	config: LC_Config,
+	monkeypatch,
+) -> None:
+	monkeypatch.setattr(
+		"licensecheck.io.cli.checker.check",
+		lambda **_: (False, []),
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.formatMap",
+		{"simple": object()},
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.fmt",
+		lambda *args, **kwargs: "output",
+	)
+
+	assert main(config) == 0
+
+
+def test_main_invalid_format(
+	config: LC_Config,
+	monkeypatch,
+):
+	config.format = "does-not-exist"
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.checker.check",
+		lambda **_: (False, []),
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.formatMap",
+		{},
+	)
+
+	assert main(config) == 2
+
+
+@pytest.mark.parametrize(
+	("zero", "incompatible", "expected"),
+	[
+		(False, False, 0),
+		(False, True, 0),
+		(True, False, 0),
+		(True, True, 1),
+	],
+)
+def test_main_exit_code_zero_mode(
+	config: LC_Config,
+	monkeypatch,
+	zero: bool,
+	incompatible: bool,
+	expected: int,
+) -> None:
+	config.zero = zero
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.checker.check",
+		lambda **_: (incompatible, []),
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.formatMap",
+		{"simple": object()},
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.fmt",
+		lambda *args, **kwargs: "",
+	)
+
+	assert main(config) == expected
+
+
+def test_main_invalid_hidden_parameter(
+	config: LC_Config,
+	monkeypatch,
+):
+	config.hide_output_parameters = {"NOT_A_FIELD"}
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.checker.check",
+		lambda **_: (False, []),
+	)
+
+	with pytest.raises(
+		ValueError,
+		match="Invalid parameter",
+	):
+		main(config)
+
+
+@pytest.mark.parametrize(
+	"hidden",
+	[
+		[],
+		["LICENSE"],
+		["LICENSE", "NAME"],
+	],
+)
+def test_main_valid_hidden_parameters(
+	config: LC_Config,
+	monkeypatch,
+	hidden: list[str],
+):
+	config.hide_output_parameters = hidden
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.checker.check",
+		lambda **_: (False, []),
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.formatMap",
+		{"simple": object()},
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.fmt",
+		lambda *args, **kwargs: "",
+	)
+
+	assert main(config) == 0
+
+
+def test_main_passes_args_to_checker(
+	config: LC_Config,
+	monkeypatch,
+):
+	called = {}
+
+	def fake_check(**kwargs):
+		called.update(kwargs)
+		return False, []
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.checker.check",
+		fake_check,
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.formatMap",
+		{"simple": object()},
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.fmt",
+		lambda *args, **kwargs: "",
+	)
+
+	main(config)
+
+	assert called["groups"] == config.groups
+	assert called["extras"] == config.extras
+	assert called["skip_dependencies"] == config.skip_dependencies
+
+
+def test_main_closes_output_file(
+	config: LC_Config,
+	monkeypatch,
+	tmp_path,
+):
+	output = tmp_path / "out.txt"
+
+	config.file = str(output)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.checker.check",
+		lambda **_: (False, []),
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.formatMap",
+		{"simple": object()},
+	)
+
+	monkeypatch.setattr(
+		"licensecheck.io.cli.fmt.fmt",
+		lambda *args, **kwargs: "hello",
+	)
+
+	assert main(config) == 0
+	assert output.read_text() == "hello\n"