File: test_record.py

package info (click to toggle)
python-dist-meta 0.9.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,964 kB
  • sloc: python: 2,944; makefile: 9
file content (195 lines) | stat: -rw-r--r-- 7,121 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# stdlib
import pathlib

# 3rd party
import handy_archives
import pytest
from coincidence import AdvancedDataRegressionFixture, AdvancedFileRegressionFixture
from domdf_python_tools.paths import PathPlus
from domdf_python_tools.typing import PathLike
from shippinglabel.checksum import get_sha256_hash

# this package
from dist_meta.distributions import Distribution
from dist_meta.record import FileHash, RecordEntry


def test_file_hash(tmp_pathplus: PathPlus):

	(tmp_pathplus / "LICENSE").write_text("Do what you want,")

	fh = FileHash("sha256", "WUk2cO6oqWOYz3wqsKUFJi432cyMjFrMjiucuBR3K4E")
	assert fh.to_string() == "sha256=WUk2cO6oqWOYz3wqsKUFJi432cyMjFrMjiucuBR3K4E"
	assert FileHash.from_string("sha256=WUk2cO6oqWOYz3wqsKUFJi432cyMjFrMjiucuBR3K4E") == fh

	sha256_hash = get_sha256_hash(tmp_pathplus / "LICENSE")
	assert fh.hexdigest() == sha256_hash.hexdigest()
	assert fh.digest() == sha256_hash.digest()
	assert FileHash.from_hash(sha256_hash) == fh

@pytest.mark.skip(reason="function cannot read the file format")
def test_record_entry(
		wheel_directory: PathPlus,
		tmp_pathplus: PathPlus,
		advanced_file_regression: AdvancedFileRegressionFixture,
		):

	handy_archives.unpack_archive(wheel_directory / "domdf_python_tools-2.9.1-py3-none-any.whl", tmp_pathplus)
	dist_info = tmp_pathplus / "domdf_python_tools-2.9.1.dist-info"
	assert dist_info.is_dir()

	license_file = dist_info / "LICENSE"
	assert license_file.is_file()

	distro = Distribution.from_path(dist_info)

	license_record = RecordEntry(
			license_file.relative_to(tmp_pathplus),
			FileHash("sha256", "46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg"),
			7652,
			distro,
			)

	assert license_record.size == 7652
	assert license_record.hash is not None
	assert license_record.hash.to_string() == "sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg"

	assert license_record.read_text() == license_file.read_text()
	assert license_record.read_bytes() == license_file.read_bytes()

	expected = "domdf_python_tools-2.9.1.dist-info/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652"
	assert license_record.as_record_entry() == expected

	advanced_file_regression.check(repr(license_record))

@pytest.mark.skip(reason="function cannot read the file format")
def test_record_entry_no_distro(
		wheel_directory: PathPlus,
		tmp_pathplus: PathPlus,
		advanced_file_regression: AdvancedFileRegressionFixture,
		):
	handy_archives.unpack_archive(wheel_directory / "domdf_python_tools-2.9.1-py3-none-any.whl", tmp_pathplus)
	dist_info = tmp_pathplus / "domdf_python_tools-2.9.1.dist-info"
	assert dist_info.is_dir()

	license_file = dist_info / "LICENSE"
	assert license_file.is_file()

	license_record = RecordEntry(
			license_file.relative_to(tmp_pathplus),
			FileHash("sha256", "46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg"),
			7652,
			)

	with pytest.raises(ValueError, match="Cannot read files with 'self.distro = None'"):
		license_record.read_text()
	with pytest.raises(ValueError, match="Cannot read files with 'self.distro = None'"):
		license_record.read_bytes()

	expected = "domdf_python_tools-2.9.1.dist-info/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652"
	assert license_record.as_record_entry() == expected

	advanced_file_regression.check(repr(license_record))


def test_record_entry_no_attributes(
		tmp_pathplus: PathPlus,
		advanced_file_regression: AdvancedFileRegressionFixture,
		):
	license_record = RecordEntry("domdf_python_tools-2.9.1.dist-info/RECORD")

	with pytest.raises(ValueError, match="Cannot read files with 'self.distro = None'"):
		license_record.read_text()
	with pytest.raises(ValueError, match="Cannot read files with 'self.distro = None'"):
		license_record.read_bytes()

	assert license_record.as_record_entry() == "domdf_python_tools-2.9.1.dist-info/RECORD,,"

	advanced_file_regression.check(repr(license_record))


@pytest.mark.parametrize(
		"record_string",
		[
				pytest.param(
						"apeye-1.0.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4",
						id="INSTALLER"
						),
				pytest.param("apeye/__pycache__/email_validator.cpython-38.pyc,,", id="__pycache__"),
				pytest.param(
						"apeye/cache.py,sha256=NIQAPrl-YG2wYo-xomLJhy9Iyq9NM6hMSeYoxJBtI28,4158", id="cache.py"
						),
				pytest.param(
						"apeye/public_suffix_list.dat,sha256=sIQS28R2dRmXsqHy1dLS2poPCw9luJPejevcHnhvCME,233455",
						id="public_suffix_list.dat"
						),
				pytest.param("apeye/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0", id="py.typed"),
				]
		)
def test_from_record_entry_string(record_string: str, advanced_data_regression: AdvancedDataRegressionFixture):
	record = RecordEntry.from_record_entry(record_string)
	assert record.as_record_entry() == record_string
	advanced_data_regression.check({"path": record, "size": record.size, "hash": record.hash})

	fake_distro = object()
	record = RecordEntry.from_record_entry(record_string, distro=fake_distro)  # type: ignore[arg-type]
	assert record.as_record_entry() == record_string
	assert record.distro is fake_distro


@pytest.mark.parametrize(
		"record_string",
		[
				pytest.param(
						"\napeye/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0",
						id="newline_before"
						),
				pytest.
				param("apeye/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0\n", id="newline_after"),
				pytest.param(
						"\napeye/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0\n",
						id="newline_before_and_after"
						),
				]
		)
def test_from_record_entry_string_multiline(record_string: str):
	record = RecordEntry.from_record_entry(record_string)
	assert record.as_record_entry() == "apeye/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0"
	assert record.as_posix() == "apeye/py.typed"
	assert record.size == 0
	assert record.hash == ("sha256", "47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU")

	fake_distro = object()
	record = RecordEntry.from_record_entry(record_string, distro=fake_distro)  # type: ignore[arg-type]
	assert record.as_record_entry() == "apeye/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0"
	assert record.distro is fake_distro


def test_from_record_entry_multiline_error():
	with pytest.raises(ValueError, match="'entry' must be a single-line entry."):
		RecordEntry.from_record_entry(
				'\n'.join([
						"apeye-1.0.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4,",
						"apeye/public_suffix_list.dat,sha256=sIQS28R2dRmXsqHy1dLS2poPCw9luJPejevcHnhvCME,233455,",
						])
				)


@pytest.mark.parametrize(
		"path",
		[
				pathlib.PureWindowsPath(r"c:\a\b\c"),
				pathlib.PureWindowsPath("/a/b/c"),
				pathlib.PurePosixPath("/etc/apt/sources.list"),
				pathlib.Path("/etc/apt/sources.list"),
				"/etc/apt/sources.list",
				]
		)
def test_record_entry_absolute(path: PathLike):
	with pytest.raises(ValueError, match="RecordEntry paths cannot be absolute"):
		RecordEntry(path)


def test_coercion_windows():
	assert str(RecordEntry(pathlib.PureWindowsPath("a/b/c"))) == "a/b/c"
	assert str(RecordEntry(pathlib.PureWindowsPath(r"a\b\c"))) == "a/b/c"