Source code for tests.test_filehashtools
#!/usr/bin/env python3
"""Test the filehashtools module."""
from shutil import rmtree
from hashlib import algorithms_available as algos
from configparser import ConfigParser
import os
try:
import unittest.mock as mock
except ImportError:
import mock
import pytest
try:
import gnupg
except ImportError:
NOGNUPG = True
else:
NOGNUPG = False
from bbarchivist import filehashtools as bf
[docs]def setup_module(module):
"""
Create necessary files.
"""
if not os.path.exists("temp_filehashtools"):
os.mkdir("temp_filehashtools")
os.chdir("temp_filehashtools")
with open("tempfile.txt", "w") as targetfile:
targetfile.write("Jackdaws love my big sphinx of quartz")
os.mkdir("skipme")
[docs]def teardown_module(module):
"""
Delete necessary files.
"""
os.chdir("..")
rmtree("temp_filehashtools", ignore_errors=True)
[docs]class TestClassFilehashtools:
"""
Test hash/GnuPG utilities.
"""
[docs] def test_crc32hash(self):
"""
Test CRC32 checksum.
"""
assert bf.hc32("tempfile.txt") == "ed5d3f26"
[docs] def test_adler32hash(self):
"""
Test Adler32 checksum.
"""
assert bf.ha32("tempfile.txt") == "02470dcd"
[docs] def test_sha1hash(self):
"""
Test SHA-1 hash.
"""
assert bf.hs1("tempfile.txt") == "71dc7ce8f27c11b792be3f169ecf985865e276d0"
[docs] def test_sha224hash(self):
"""
Test SHA-224 hash.
"""
assert bf.hs224("tempfile.txt") == "7bcd7b77f63633bf0f7db181106f08eb630a58c521b109be1cc4a404"
[docs] def test_sha256hash(self):
"""
Test SHA-256 hash.
"""
assert bf.hs256("tempfile.txt") == "f118871c45171d5fe4e9049980959e033eeeabcfa12046c243fda310580e8a0b"
[docs] def test_sha384hash(self):
"""
Test SHA-384 hash.
"""
assert bf.hs384("tempfile.txt") == "76620873c0d27873c137b082425c6e87e3d601c4b19241a1f2222f7f700a2fe8d3c648b26f62325a411cb020bff527be"
[docs] def test_sha512hash(self):
"""
Test SHA-512 hash.
"""
assert bf.hs512("tempfile.txt") == "b66a5e8aa9b9705748c2ee585b0e1a3a41288d2dafc3be2db12fa89d2f2a3e14f9dec11de4ba865bb51eaa6c2cfeb294139455e34da7d827a19504b0906c01c1"
[docs] def test_md4hash(self):
"""
Test MD4 hash.
"""
if "md4" not in algos:
pass
else:
assert bf.hm4("tempfile.txt") == "df26ada1a895f94e1f1257fad984e809"
[docs] def test_md5hash(self):
"""
Test MD5 hash.
"""
assert bf.hm5("tempfile.txt") == "822e1187fde7c8d55aff8cc688701650"
[docs] def test_ripemd160hash(self):
"""
Test RIPEMD160 hash.
"""
if "ripemd160" not in algos:
pass
else:
assert bf.hr160("tempfile.txt") == "f3e191024c33768e2589e2efca53d55f4e4945ee"
[docs] def test_whirlpoolhash(self):
"""
Test Whirlpool hash.
"""
if "whirlpool" not in algos:
pass
else:
assert bf.hwp("tempfile.txt") == "9835d12f3cb3ea3934635e4a7cc918e489379ed69d894ebc2c09bbf99fe72567bfd26c919ad666e170752abfc4b8c37b376f5102f9e5de59af2b65efc2e01293"
[docs] def test_escreens(self):
"""
Test EScreens code generation.
"""
pin = "acdcacdc"
app = "10.3.2.500"
uptime = "69696969"
assert bf.calculate_escreens(pin, app, uptime, duration=2) == "E4A25067"
[docs] def test_verifier(self, onefile=False):
"""
Test batch hashing.
:param onefile: One file or not. Default is false.
:type onefile: bool
"""
confload = {}
confload['adler32'] = True
confload['crc32'] = True
confload['md4'] = True
confload['md5'] = True
confload['sha1'] = True
confload['sha224'] = True
confload['sha256'] = True
confload['sha384'] = True
confload['sha512'] = True
confload['ripemd160'] = True
confload['whirlpool'] = True
confload['blocksize'] = "16777216"
confload['onefile'] = onefile
print(confload)
with mock.patch('bbarchivist.filehashtools.verifier_config_loader',
mock.MagicMock(return_value=confload)):
bf.verifier(os.getcwd())
stocklines = [b"ADLER32",
b"02470DCD tempfile.txt",
b"CRC32",
b"ED5D3F26 tempfile.txt",
b"MD4",
b"DF26ADA1A895F94E1F1257FAD984E809 tempfile.txt",
b"MD5",
b"822E1187FDE7C8D55AFF8CC688701650 tempfile.txt",
b"SHA1",
b"71DC7CE8F27C11B792BE3F169ECF985865E276D0 tempfile.txt",
b"SHA224",
b"7BCD7B77F63633BF0F7DB181106F08EB630A58C521B109BE1CC4A404 tempfile.txt",
b"SHA256",
b"F118871C45171D5FE4E9049980959E033EEEABCFA12046C243FDA310580E8A0B tempfile.txt",
b"SHA384",
b"76620873C0D27873C137B082425C6E87E3D601C4B19241A1F2222F7F700A2FE8D3C648B26F62325A411CB020BFF527BE tempfile.txt",
b"SHA512",
b"B66A5E8AA9B9705748C2EE585B0E1A3A41288D2DAFC3BE2DB12FA89D2F2A3E14F9DEC11DE4BA865BB51EAA6C2CFEB294139455E34DA7D827A19504B0906C01C1 tempfile.txt",
b"RIPEMD160",
b"F3E191024C33768E2589E2EFCA53D55F4E4945EE tempfile.txt",
b"WHIRLPOOL",
b"9835D12F3CB3EA3934635E4A7CC918E489379ED69D894EBC2C09BBF99FE72567BFD26C919AD666E170752ABFC4B8C37B376F5102F9E5DE59AF2B65EFC2E01293 tempfile.txt",]
stocklines2 = []
for item in stocklines:
item2 = item.strip()
item2 = item2.replace(b'\r\n', b'')
item2 = item2.replace(b'\n', b'')
item2 = item2.replace(b'\r', b'')
stocklines2.append(item2)
if onefile:
filename = "all.cksum"
else:
filename = "tempfile.txt.cksum"
with open(filename, "rb") as checksumfile:
content = checksumfile.read().splitlines()
content2 = []
for item in content:
item2 = item.strip()
item2 = item2.replace(b'\r\n', b'')
item2 = item2.replace(b'\n', b'')
item2 = item2.replace(b'\r', b'')
content2.append(item2)
for idx, value in enumerate(content2):
assert stocklines2[idx] == value
[docs] def test_verifier_onefile(self):
"""
Test batch hashing, one output file.
"""
self.test_verifier(True)
[docs]class TestClassFilehashtoolsGPG:
"""
Test GPG-related tools.
"""
[docs] def test_gpgfile(self):
"""
Test GnuPG signing.
"""
if os.getenv("TRAVIS", "false") == "true":
pass
elif NOGNUPG:
pass
else:
gpgkey, gpgpass = bf.gpg_config_loader()
if gpgkey is None or gpgpass is None:
pass
else:
gpginst = gnupg.GPG()
# Note: if you get a "Unknown status message 'NEWSIG'" error, then look here:
# https://bitbucket.org/vinay.sajip/python-gnupg/issues/35/status-newsig-missing-in-verify
bf.gpgfile("tempfile.txt", gpginst, gpgkey, gpgpass)
with open("tempfile.txt.asc", "rb") as sig:
try:
verified = gpginst.verify_file(sig, 'tempfile.txt')
except ValueError as exc:
rep = str(exc)
if "NEWSIG" not in rep:
print(rep)
else:
pass
else:
assert verified
[docs] def test_gpgrunner(self):
"""
Test batch GnuPG signing.
"""
if os.getenv("TRAVIS", "false") == "true":
pass
elif NOGNUPG:
pass
else:
gpgkey, gpgpass = bf.gpg_config_loader()
if gpgkey is None or gpgpass is None:
pass
else:
gpginst = gnupg.GPG()
bf.gpgrunner(os.getcwd(), gpgkey, gpgpass, False)
with open("tempfile.txt.asc", "rb") as sig:
try:
verified = gpginst.verify_file(sig, 'tempfile.txt')
except ValueError as exc:
rep = str(exc)
if "NEWSIG" not in rep:
print(rep)
else:
pass
else:
assert verified
[docs] def test_gpgrunner_failure(self, capsys):
"""
Test GPGRunner going wrong during the process.
"""
if os.getenv("TRAVIS", "false") == "true":
pass
elif NOGNUPG:
pass
else:
with mock.patch("bbarchivist.filehashtools.gpgfile", mock.MagicMock(side_effect=Exception)):
with pytest.raises(SystemExit):
bf.gpgrunner(os.getcwd(), "12345678", "hunter2", False)
assert "SOMETHING WENT WRONG" in capsys.readouterr()[0]
[docs]class TestClassFilehashtoolsConfig:
"""
Test reading/writing configs with ConfigParser.
"""
@classmethod
[docs] def setup_class(cls):
"""
Create dictionaries for self.
"""
cls.hashdict = {}
cls.hashdict['crc32'] = False
cls.hashdict['adler32'] = False
cls.hashdict['sha1'] = True
cls.hashdict['sha224'] = False
cls.hashdict['sha256'] = True
cls.hashdict['sha384'] = False
cls.hashdict['sha512'] = False
cls.hashdict['md5'] = True
cls.hashdict['md4'] = False
cls.hashdict['ripemd160'] = False
cls.hashdict['whirlpool'] = False
cls.hashdict['onefile'] = False
cls.hashdict['blocksize'] = 16777216
[docs] def test_hash_loader(self):
"""
Test reading hash settings.
"""
try:
FileNotFoundError
except NameError:
FileNotFoundError = IOError
try:
os.remove("bbarchivist.ini")
except (OSError, FileNotFoundError):
pass
with mock.patch('os.path.expanduser', mock.MagicMock(return_value=os.getcwd())):
assert bf.verifier_config_loader() == self.hashdict
[docs] def test_hash_writer(self):
"""
Test writing hash settings.
"""
hash2 = self.hashdict
hash2['sha512'] = True
try:
FileNotFoundError
except NameError:
FileNotFoundError = IOError
try:
os.remove("bbarchivist.ini")
except (OSError, FileNotFoundError):
pass
with mock.patch('os.path.expanduser', mock.MagicMock(return_value=os.getcwd())):
with mock.patch('bbarchivist.filehashtools.verifier_config_loader',
mock.MagicMock(return_value=hash2)):
bf.verifier_config_writer()
assert bf.verifier_config_loader() == hash2
[docs] def test_gpg_loader_empty(self):
"""
Test reading GPG settings on empty.
"""
try:
FileNotFoundError
except NameError:
FileNotFoundError = IOError
try:
os.remove("bbarchivist.ini")
except (OSError, FileNotFoundError):
pass
with mock.patch('os.path.expanduser', mock.MagicMock(return_value=os.getcwd())):
assert bf.gpg_config_loader() == (None, None)
[docs] def test_gpg_loader_loaded(self):
"""
Test reading GPG settings when completed.
"""
config = ConfigParser()
open("bbarchivist.ini", 'w').close()
config.read("bbarchivist.ini")
config['gpgrunner'] = {}
config['gpgrunner']['key'] = "0xDEADBEEF"
config['gpgrunner']['pass'] = "hunter2"
with open("bbarchivist.ini", "w") as configfile:
config.write(configfile)
assert bf.gpg_config_loader(os.getcwd()) == ("0xDEADBEEF", "hunter2")
[docs] def test_gpg_writer(self):
"""
Test writing GPG settings.
"""
try:
FileNotFoundError
except NameError:
FileNotFoundError = IOError
try:
os.remove("bbarchivist.ini")
except (OSError, FileNotFoundError):
pass
with mock.patch('os.path.expanduser', mock.MagicMock(return_value=os.getcwd())):
bf.gpg_config_writer("0xDEADF00D", "swordfish")
assert bf.gpg_config_loader() == ("0xDEADF00D", "swordfish")