test: formatter

FredHappyface · FredHappyface · commit cee0115f804e · 2022-12-30T21:56:37.000Z
diff --git a/README.md b/README.md
@@ -176,7 +176,7 @@ Add optional path to requirements.txt as outlined in https://github.com/FHPython
 		{
 			"name": "requirements-parser",
 			"version": "0.5.0",
-			"namever": "requirements-parser 0.5.0",
+			"namever": "requirements-parser-0.5.0",
 			"size": 11523,
 			"homePage": "https://github.com/madpah/requirements-parser",
 			"author": "Paul Horton",
diff --git a/licensecheck/packageinfo.py b/licensecheck/packageinfo.py
@@ -41,7 +41,6 @@ def getPackageInfoLocal(requirement: str) -> PackageInfo:
 		return PackageInfo(
 			name=name,
 			version=version,
-			namever=f"{name}-{version}",
 			homePage=homePage,
 			author=author,
 			size=size,
@@ -68,7 +67,6 @@ def getPackageInfoPypi(requirement: str) -> PackageInfo:
 		return PackageInfo(
 			name=requirement,
 			version=info["version"],
-			namever=f"{requirement} {info['version']}",
 			homePage=info["home_page"],
 			author=info["author"],
 			size=int(response["urls"][-1]["size"]),
diff --git a/licensecheck/types.py b/licensecheck/types.py
@@ -2,7 +2,7 @@
 """
 from __future__ import annotations
 
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from enum import Enum
 
 UNKNOWN = "UNKNOWN"
@@ -14,14 +14,17 @@ class PackageInfo:
 
 	name: str
 	version: str = UNKNOWN
-	namever: str = UNKNOWN
+	namever: str  = field(init=False)
 	size: int = -1
 	homePage: str = UNKNOWN
 	author: str = UNKNOWN
 	license: str = UNKNOWN
 	licenseCompat: bool = False
 	errorCode: int = 0
 
+	def __post_init__(self):
+		self.namever = f"{self.name}-{self.version}"
+
 
 class License(Enum):
 	"""License Enum to hold a set of potential licenses."""
diff --git a/tests/data/advanced.ansi b/tests/data/advanced.ansi
@@ -0,0 +1,16 @@
+[3m            [0m
+[3m  list of   [0m
+[3m   errors   [0m
+┌──────────┐
+│[1m [0m[1mPackage [0m[1m [0m│
+├──────────┤
+│[35m [0m[35mexample1[0m[35m [0m│
+└──────────┘
+[3m                                      [0m
+[3m           list of packages           [0m
+┌────────────┬──────────┬────────────┐
+│[1m [0m[1mCompatible[0m[1m [0m│[1m [0m[1mPackage [0m[1m [0m│[1m [0m[1mLicense(s)[0m[1m [0m│
+├────────────┼──────────┼────────────┤
+│[36m [0m[32m✔[0m[36m         [0m[36m [0m│[35m [0m[35mexample0[0m[35m [0m│[35m [0m[35mmit       [0m[35m [0m│
+│[36m [0m[31m✖[0m[36m         [0m[36m [0m│[35m [0m[35mexample1[0m[35m [0m│[35m [0m[35mgpl3      [0m[35m [0m│
+└────────────┴──────────┴────────────┘
diff --git a/tests/data/advanced.csv b/tests/data/advanced.csv
@@ -0,0 +1,3 @@
+name,version,size,homePage,author,license,licenseCompat,errorCode,namever
+example0,1.0.0,10,https://example.com,example_author,mit,True,0,example0-1.0.0
+example1,UNKNOWN,10,https://example.com,example_author,gpl3,False,1,example1-UNKNOWN
diff --git a/tests/data/advanced.json b/tests/data/advanced.json
@@ -0,0 +1,30 @@
+{
+	"info": {
+		"program": "licensecheck",
+		"version": "2022.2.0"
+	},
+	"packages": [
+		{
+			"name": "example0",
+			"version": "1.0.0",
+			"size": 10,
+			"homePage": "https://example.com",
+			"author": "example_author",
+			"license": "mit",
+			"licenseCompat": true,
+			"errorCode": 0,
+			"namever": "example0-1.0.0"
+		},
+		{
+			"name": "example1",
+			"version": "UNKNOWN",
+			"size": 10,
+			"homePage": "https://example.com",
+			"author": "example_author",
+			"license": "gpl3",
+			"licenseCompat": false,
+			"errorCode": 1,
+			"namever": "example1-UNKNOWN"
+		}
+	]
+}
diff --git a/tests/data/advanced.md b/tests/data/advanced.md
@@ -0,0 +1,24 @@
+
+# Packages
+Find a list of packages below
+
+|Compatible|Package|
+|:--|:--|
+|True|example0|
+|False|example1|
+
+## example0-1.0.0
+
+- HomePage: https://example.com
+- Author: example_author
+- License: mit
+- Compatible: True
+- Size: 10
+
+## example1-UNKNOWN
+
+- HomePage: https://example.com
+- Author: example_author
+- License: gpl3
+- Compatible: False
+- Size: 10
diff --git a/tests/data/advanced.txt b/tests/data/advanced.txt
@@ -0,0 +1,16 @@
+            
+  list of   
+   errors   
+┌──────────┐
+│ Package  │
+├──────────┤
+│ example1 │
+└──────────┘
+                                      
+           list of packages           
+┌────────────┬──────────┬────────────┐
+│ Compatible │ Package  │ License(s) │
+├────────────┼──────────┼────────────┤
+│ ✔          │ example0 │ mit        │
+│ ✖          │ example1 │ gpl3       │
+└────────────┴──────────┴────────────┘
diff --git a/tests/data/simple.ansi b/tests/data/simple.ansi
@@ -0,0 +1,7 @@
+[3m                                     [0m
+[3m          list of packages           [0m
+┌────────────┬─────────┬────────────┐
+│[1m [0m[1mCompatible[0m[1m [0m│[1m [0m[1mPackage[0m[1m [0m│[1m [0m[1mLicense(s)[0m[1m [0m│
+├────────────┼─────────┼────────────┤
+│[36m [0m[31m✖[0m[36m         [0m[36m [0m│[35m [0m[35mexample[0m[35m [0m│[35m [0m[35mUNKNOWN   [0m[35m [0m│
+└────────────┴─────────┴────────────┘
diff --git a/tests/data/simple.csv b/tests/data/simple.csv
@@ -0,0 +1,2 @@
+name,version,size,homePage,author,license,licenseCompat,errorCode,namever
+example,UNKNOWN,-1,UNKNOWN,UNKNOWN,UNKNOWN,False,0,example-UNKNOWN
diff --git a/tests/data/simple.json b/tests/data/simple.json
@@ -0,0 +1,19 @@
+{
+	"info": {
+		"program": "licensecheck",
+		"version": "2022.2.0"
+	},
+	"packages": [
+		{
+			"name": "example",
+			"version": "UNKNOWN",
+			"size": -1,
+			"homePage": "UNKNOWN",
+			"author": "UNKNOWN",
+			"license": "UNKNOWN",
+			"licenseCompat": false,
+			"errorCode": 0,
+			"namever": "example-UNKNOWN"
+		}
+	]
+}
diff --git a/tests/data/simple.md b/tests/data/simple.md
@@ -0,0 +1,15 @@
+
+# Packages
+Find a list of packages below
+
+|Compatible|Package|
+|:--|:--|
+|False|example|
+
+## example-UNKNOWN
+
+- HomePage: UNKNOWN
+- Author: UNKNOWN
+- License: UNKNOWN
+- Compatible: False
+- Size: -1
diff --git a/tests/data/simple.txt b/tests/data/simple.txt
@@ -0,0 +1,7 @@
+                                     
+          list of packages           
+┌────────────┬─────────┬────────────┐
+│ Compatible │ Package │ License(s) │
+├────────────┼─────────┼────────────┤
+│ ✖          │ example │ UNKNOWN    │
+└────────────┴─────────┴────────────┘
diff --git a/tests/test_formatter.py b/tests/test_formatter.py
@@ -0,0 +1,56 @@
+
+from licensecheck import formatter
+from licensecheck import types
+
+from pathlib import Path
+THISDIR = str(Path(__file__).resolve().parent)
+
+
+simplePackages = [types.PackageInfo(name='example')]
+complexPackages = [types.PackageInfo(name='example0', version="1.0.0", size=10, homePage="https://example.com", author="example_author", license="mit", licenseCompat=True, errorCode=0),types.PackageInfo(name='example1', size=10, homePage="https://example.com", author="example_author", license="gpl3", licenseCompat=False, errorCode=1)]
+
+def test_simpleMarkdown():
+	# Path(f"{THISDIR}/data/simple.md").write_text(formatter.markdown(simplePackages), "utf-8")
+	assert formatter.markdown(simplePackages) == Path(f"{THISDIR}/data/simple.md").read_text("utf-8")
+
+def test_advancedMarkdown():
+	# Path(f"{THISDIR}/data/advanced.md").write_text(formatter.markdown(complexPackages), "utf-8")
+	assert formatter.markdown(complexPackages) == Path(f"{THISDIR}/data/advanced.md").read_text("utf-8")
+
+
+def test_simpleRaw():
+	# Path(f"{THISDIR}/data/simple.json").write_text(formatter.raw(simplePackages), "utf-8")
+	assert formatter.raw(simplePackages) == Path(f"{THISDIR}/data/simple.json").read_text("utf-8")
+
+def test_advancedRaw():
+	# Path(f"{THISDIR}/data/advanced.json").write_text(formatter.raw(complexPackages), "utf-8")
+	assert formatter.raw(complexPackages) == Path(f"{THISDIR}/data/advanced.json").read_text("utf-8")
+
+
+def test_simpleRawCsv():
+	# Path(f"{THISDIR}/data/simple.csv").write_text(formatter.rawCsv(simplePackages), "utf-8")
+	assert formatter.rawCsv(simplePackages) == Path(f"{THISDIR}/data/simple.csv").read_text("utf-8")
+
+def test_advancedRawCsv():
+	# Path(f"{THISDIR}/data/advanced.csv").write_text(formatter.rawCsv(complexPackages), "utf-8")
+	assert formatter.rawCsv(complexPackages) == Path(f"{THISDIR}/data/advanced.csv").read_text("utf-8")
+
+
+
+def test_simpleAnsi():
+	# Path(f"{THISDIR}/data/simple.ansi").write_text(formatter.ansi(simplePackages), "utf-8")
+	assert formatter.ansi(simplePackages) == Path(f"{THISDIR}/data/simple.ansi").read_text("utf-8")
+
+def test_advancedAnsi():
+	# Path(f"{THISDIR}/data/advanced.ansi").write_text(formatter.ansi(complexPackages), "utf-8")
+	assert formatter.ansi(complexPackages) == Path(f"{THISDIR}/data/advanced.ansi").read_text("utf-8")
+
+
+
+def test_simplePlainText():
+	# Path(f"{THISDIR}/data/simple.txt").write_text(formatter.plainText(simplePackages), "utf-8")
+	assert formatter.plainText(simplePackages) == Path(f"{THISDIR}/data/simple.txt").read_text("utf-8")
+
+def test_advancedPlainText():
+	# Path(f"{THISDIR}/data/advanced.txt").write_text(formatter.plainText(complexPackages), "utf-8")
+	assert formatter.plainText(complexPackages) == Path(f"{THISDIR}/data/advanced.txt").read_text("utf-8")

Original file line number	Diff line number	Diff line change
`@@ -176,7 +176,7 @@ Add optional path to requirements.txt as outlined in https://github.com/FHPython`
`176`	`176`	`{`
`177`	`177`	`"name": "requirements-parser",`
`178`	`178`	`"version": "0.5.0",`
`179`		`- "namever": "requirements-parser 0.5.0",`
	`179`	`+ "namever": "requirements-parser-0.5.0",`
`180`	`180`	`"size": 11523,`
`181`	`181`	`"homePage": "https://github.com/madpah/requirements-parser",`
`182`	`182`	`"author": "Paul Horton",`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,16 @@ @@
 +[3m            [0m
 +[3m  list of   [0m
 +[3m   errors   [0m
 +┌──────────┐
 +│[1m [0m[1mPackage [0m[1m [0m│
 +├──────────┤
 +│[35m [0m[35mexample1[0m[35m [0m│
 +└──────────┘
 +[3m                                      [0m
 +[3m           list of packages           [0m
 +┌────────────┬──────────┬────────────┐
 +│[1m [0m[1mCompatible[0m[1m [0m│[1m [0m[1mPackage [0m[1m [0m│[1m [0m[1mLicense(s)[0m[1m [0m│
 +├────────────┼──────────┼────────────┤
 +│[36m [0m[32m✔[0m[36m         [0m[36m [0m│[35m [0m[35mexample0[0m[35m [0m│[35m [0m[35mmit       [0m[35m [0m│
 +│[36m [0m[31m✖[0m[36m         [0m[36m [0m│[35m [0m[35mexample1[0m[35m [0m│[35m [0m[35mgpl3      [0m[35m [0m│
 +└────────────┴──────────┴────────────┘
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+name,version,size,homePage,author,license,licenseCompat,errorCode,namever`
	`2`	`+example0,1.0.0,10,https://example.com,example_author,mit,True,0,example0-1.0.0`
	`3`	`+example1,UNKNOWN,10,https://example.com,example_author,gpl3,False,1,example1-UNKNOWN`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+name,version,size,homePage,author,license,licenseCompat,errorCode,namever`
	`2`	`+example,UNKNOWN,-1,UNKNOWN,UNKNOWN,UNKNOWN,False,0,example-UNKNOWN`