Add tests

Author: Szymon Janowski

tests/conftest.py

@@ -2,16 +2,13 @@
 
 import pytest  # pyright: ignore [reportMissingImports]
 from loguru import logger
+from _pytest.logging import caplog as _caplog
 
 
 @pytest.fixture()
 def caplog(_caplog):
 	"""Wrapper over caplog fixture to fix loguru logs.
 
-	Parameters
-	----------
-	_caplog: Pytest fixture
-
 	Yields
 	------
 	_caplog: Pytest fixture

tests/data/advanced_ignore_params.json

@@ -0,0 +1,28 @@
+{
+	"info": {
+		"program": "licensecheck",
+		"version": "2024",
+		"license": "MIT LICENSE"
+	},
+	"project_license": "MIT LICENSE",
+	"packages": [
+		{
+			"name": "example0",
+			"version": "1.0.0",
+			"size": 10,
+			"license": "MIT",
+			"licenseCompat": true,
+			"errorCode": 0,
+			"namever": "example0-1.0.0"
+		},
+		{
+			"name": "example1",
+			"version": "UNKNOWN",
+			"size": 10,
+			"license": "GPL3",
+			"licenseCompat": false,
+			"errorCode": 1,
+			"namever": "example1-UNKNOWN"
+		}
+	]
+}

tests/data/advanced_ignore_params.md

@@ -0,0 +1,32 @@
+## Info
+
+- **program**: licensecheck
+- **version**: 2024
+- **license**: MIT LICENSE
+
+## Project License
+
+MIT LICENSE
+
+## Packages
+
+Find a list of packages below
+
+|Compatible|Package|
+|:--|:--|
+|✔|example0|
+|✖|example1|
+
+### example0-1.0.0
+
+- HomePage: https://example.com
+- Author: example_author
+- License: MIT
+- Compatible: True
+
+### example1-UNKNOWN
+
+- HomePage: https://example.com
+- Author: example_author
+- License: GPL3
+- Compatible: False

tests/test_formatter.py

@@ -1,5 +1,6 @@
 from pathlib import Path
 
+import pytest
 from licensecheck import formatter, types
 
 THISDIR = str(Path(__file__).resolve().parent)
@@ -43,6 +44,12 @@ def test_advancedMarkdown() -> None:
 	assert fmt == Path(f"{THISDIR}/data/advanced.md").read_text("utf-8")
 
 
+def test_advancedMarkdownIgnoreParams() -> None:
+	fmt = formatter.markdown(myLice, complexPackages, hide_parameters=["SIZE"])
+	# Path(f"{THISDIR}/data/advanced_ignore_params.md").write_text(fmt, "utf-8")
+	assert fmt == Path(f"{THISDIR}/data/advanced_ignore_params.md").read_text("utf-8")
+
+
 def test_simpleRaw() -> None:
 	fmt = formatter.raw(myLice, simplePackages)
 	# Path(f"{THISDIR}/data/simple.json").write_text(fmt, "utf-8")
@@ -55,6 +62,12 @@ def test_advancedRaw() -> None:
 	assert fmt == Path(f"{THISDIR}/data/advanced.json").read_text("utf-8")
 
 
+def test_advancedRawIgnoreParams() -> None:
+	fmt = formatter.raw(myLice, complexPackages, hide_parameters=["HOMEPAGE", "AUTHOR"])
+	# Path(f"{THISDIR}/data/advanced_ignore_params.json").write_text(fmt, "utf-8")
+	assert fmt == Path(f"{THISDIR}/data/advanced_ignore_params.json").read_text("utf-8")
+
+
 def test_simpleRawCsv() -> None:
 	fmt = formatter.rawCsv(myLice, simplePackages)
 	# Path(f"{THISDIR}/data/simple.csv").write_text(fmt, "utf-8")
@@ -79,6 +92,11 @@ def test_advancedAnsi() -> None:
 	assert fmt == Path(f"{THISDIR}/data/advanced.ansi").read_text("utf-8")
 
 
+def test_advancedAnsiIgnoreParams() -> None:
+	fmt = formatter.ansi(myLice, complexPackages, hide_parameters=[])
+	assert fmt == Path(f"{THISDIR}/data/advanced.ansi").read_text("utf-8")
+
+
 def test_simplePlainText() -> None:
 	fmt = formatter.plainText(myLice, simplePackages)
 	# Path(f"{THISDIR}/data/simple.txt").write_text(fmt, "utf-8")
@@ -89,3 +107,8 @@ def test_advancedPlainText() -> None:
 	fmt = formatter.plainText(myLice, complexPackages)
 	# Path(f"{THISDIR}/data/advanced.txt").write_text(fmt, "utf-8")
 	assert fmt == Path(f"{THISDIR}/data/advanced.txt").read_text("utf-8")
+
+
+def test_advancedPlainTextIgnoreParams() -> None:
+	fmt = formatter.plainText(myLice, complexPackages, hide_parameters=["wrong_parameter"])
+	assert fmt == Path(f"{THISDIR}/data/advanced.txt").read_text("utf-8")