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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
|
"""This package contains various utilities use in the pyzor tests."""
import os
import sys
import time
import redis
import shutil
import unittest
import subprocess
from datetime import datetime
try:
from unittest.mock import mock_open as _mock_open
except ImportError:
from mock import mock_open as _mock_open
import pyzor.client
def mock_open(mock=None, read_data=""):
mock = _mock_open(mock, read_data)
mock.return_value.__iter__ = lambda x: iter(read_data.splitlines())
return mock
msg = """Newsgroups:
Date: Wed, 10 Apr 2002 22:23:51 -0400 (EDT)
From: Frank Tobin <ftobin@neverending.org>
Fcc: sent-mail
Message-ID: <20020410222350.E16178@palanthas.neverending.org>
X-Our-Headers: X-Bogus,Anon-To
X-Bogus: aaron7@neverending.org
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
Test Email
"""
digest = "7421216f915a87e02da034cc483f5c876e1a1338"
_dt_decode = (
lambda x: None if x == "None" else datetime.strptime(x, "%a %b %d %H:%M:%S %Y")
)
class PyzorTestBase(unittest.TestCase):
"""Test base that starts the pyzord daemon in setUpClass with specified
arguments. The daemon is killed in tearDownClass. This also create the
necessary files and the homedir.
"""
pyzord = None
_args = {
"homedir": "--homedir",
"engine": "-e",
"dsn": "--dsn",
"address": "-a",
"port": "-p",
"threads": "--threads",
"max_threads": "--max-threads",
"processes": "--processes",
"max_processes": "--max-processes",
"db_connections": "--db-connections",
"password_file": "--password-file",
"access_file": "--access-file",
"cleanup_age": "--cleanup-age",
"log_file": "--log-file",
"detach": "--detach",
"prefork": "--pre-fork",
}
homedir = "./pyzor-test/"
threads = "False"
access_file = "pyzord.access"
password_file = "pyzord.passwd"
log_file = "pyzord-test.log"
dsn = "localhost,,,10"
engine = "redis"
access = """check report ping pong info whitelist : alice : deny
check report ping pong info whitelist : bob : allow
ALL : dan : allow
pong info whitelist : dan : deny
"""
passwd = """alice : fc7f1cad729b5f3862b2ef192e2d9e0d0d4bd515
bob : cf88277c5d4abdc0a3f56f416011966d04a3f462
dan : c1a50281fc43e860fe78c16c73b9618ada59f959
"""
servers = """127.0.0.1:9999
"""
accounts_alice = """127.0.0.1 : 9999 : alice : d28f86151e80a9accba4a4eba81c460532384cd6,fc7f1cad729b5f3862b2ef192e2d9e0d0d4bd515
"""
accounts_bob = """127.0.0.1 : 9999 : bob : de6ef568787256bf5f55909dc0c398e49b5c9808,cf88277c5d4abdc0a3f56f416011966d04a3f462
"""
accounts_chuck = """127.0.0.1 : 9999 : bob : de6ef568787256bf5f55909dc0c398e49b5c9808,af88277c5d4abdc0a3f56f416011966d04a3f462
"""
accounts_dan = """127.0.0.1 : 9999 : dan : 1cc2efa77d8833d83556e0cc4fa617c64eebc7fb,c1a50281fc43e860fe78c16c73b9618ada59f959
"""
@classmethod
def write_homedir_file(cls, name, content):
if not name or not content:
return
with open(os.path.join(cls.homedir, name), "w") as f:
f.write(content)
@classmethod
def setUpClass(cls):
super(PyzorTestBase, cls).setUpClass()
try:
os.mkdir(cls.homedir)
except OSError:
pass
cls.write_homedir_file(cls.access_file, cls.access)
cls.write_homedir_file(cls.password_file, cls.passwd)
cls.write_homedir_file(cls.password_file, cls.passwd)
cls.write_homedir_file("servers", cls.servers)
cls.write_homedir_file("alice", cls.accounts_alice)
cls.write_homedir_file("bob", cls.accounts_bob)
cls.write_homedir_file("chuck", cls.accounts_chuck)
cls.write_homedir_file("dan", cls.accounts_dan)
args = ["pyzord"]
for key, value in cls._args.items():
option = getattr(cls, key, None)
if option:
args.append(value)
args.append(option)
cls.pyzord = []
for line in cls.servers.splitlines():
line = line.strip()
if not line:
continue
addr, port = line.rsplit(":", 1)
cls.pyzord.append(subprocess.Popen(args + ["-a", addr, "-p", port]))
time.sleep(1) # allow time to initialize server
def setUp(self):
unittest.TestCase.setUp(self)
self.client_args = {
"--homedir": self.homedir,
"--servers-file": "servers",
"-t": None, # timeout
"-r": None, # report threshold
"-w": None, # whitelist threshold
"-s": None, # style
}
def tearDown(self):
unittest.TestCase.tearDown(self)
@classmethod
def tearDownClass(cls):
super(PyzorTestBase, cls).tearDownClass()
for pyzord in cls.pyzord:
pyzord.terminate()
pyzord.wait()
shutil.rmtree(cls.homedir, True)
redis.StrictRedis(db=10).flushdb()
def check_pyzor(self, cmd, user, input=None, code=None, exit_code=None, counts=()):
"""Call the pyzor client with the specified args from self.client_args
and verifies the response.
"""
args = ["pyzor"]
if user:
args.append("--accounts-file")
args.append(user)
for key, value in self.client_args.items():
if value:
args.append(key)
args.append(value)
args.append(cmd)
pyzor = subprocess.Popen(
args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE
)
if input:
stdout, stderr = pyzor.communicate(input.encode("utf8"))
else:
stdout, stderr = pyzor.communicate()
if stderr:
self.fail(stderr)
if code is not None:
try:
stdout = stdout.decode("utf8")
results = stdout.strip().split("\t")
status = eval(results[1])
except Exception as e:
self.fail("Parsing error: %s of %r" % (e, stdout))
self.assertEqual(status[0], code, status)
if counts:
self.assertEqual(counts, (int(results[2]), int(results[3])))
if exit_code is not None:
self.assertEqual(exit_code, pyzor.returncode)
return stdout
def check_pyzor_multiple(
self, cmd, user, input=None, code=None, exit_code=None, counts=()
):
"""Call the pyzor client with the specified args from self.client_args
and verifies the response.
"""
args = ["pyzor"]
if user:
args.append("--accounts-file")
args.append(user)
for key, value in self.client_args.items():
if value:
args.append(key)
args.append(value)
args.append(cmd)
pyzor = subprocess.Popen(
args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE
)
if input:
stdout, stderr = pyzor.communicate(input.encode("utf8"))
else:
stdout, stderr = pyzor.communicate()
if stderr:
self.fail(stderr)
stdout = stdout.decode("utf8")
for i, line in enumerate(stdout.splitlines()):
try:
line = line.strip()
if not line:
continue
results = line.strip().split("\t")
except Exception as e:
self.fail("Parsing error: %s of %r" % (e, stdout))
if code is not None:
try:
status = eval(results[1])
except Exception as e:
self.fail("Parsing error: %s of %r" % (e, stdout))
self.assertEqual(status[0], code[i], status)
if counts:
self.assertEqual((int(results[2]), int(results[3])), counts[i])
if exit_code is not None:
self.assertEqual(exit_code, pyzor.returncode)
return stdout
def check_digest(self, digest, address, counts=(0, 0)):
result = self.client.check(digest, address)
self.assertEqual((int(result["Count"]), int(result["WL-Count"])), counts)
return result
def get_record(self, input, user="bob"):
"""Uses `pyzor info` to get the record data."""
stdout = self.check_pyzor("info", user, input, code=200, exit_code=0)
info = stdout.splitlines()[1:]
record = {}
try:
for line in info:
line = line.strip()
if not line:
continue
key, value = line.split(":", 1)
record[key.strip()] = value.strip()
except Exception as e:
self.fail("Error parsing %r: %s" % (info, e))
return record
def check_fuzzy_date(self, date1, date2=None, seconds=10):
"""Check if the given date is almost equal to now."""
date1 = _dt_decode(date1)
if not date2:
date2 = datetime.now()
delta = abs((date2 - date1).total_seconds())
if delta > seconds:
self.fail("Delta %s is too big: %s, %s" % (delta, date1, date2))
class PyzorTest(object):
"""MixIn class for PyzorTestBase that performs a series of basic tests."""
def test_ping(self):
self.check_pyzor("ping", "bob")
def test_pong(self):
input = "Test1 pong1 Test2"
self.check_pyzor(
"pong", "bob", input=input, code=200, exit_code=0, counts=(sys.maxsize, 0)
)
def test_check(self):
input = "Test1 check1 Test2"
self.check_pyzor(
"check", "bob", input=input, code=200, exit_code=1, counts=(0, 0)
)
r = self.get_record(input)
self.assertEqual(r["Count"], "0")
def test_report(self):
input = "Test1 report1 Test2"
self.check_pyzor("report", "bob", input=input, code=200, exit_code=0)
self.check_pyzor(
"check", "bob", input=input, code=200, exit_code=0, counts=(1, 0)
)
r = self.get_record(input)
self.assertEqual(r["Count"], "1")
self.check_fuzzy_date(r["Entered"])
def test_report_update(self):
input = "Test1 report update1 Test2"
self.check_pyzor("report", "bob", input=input, code=200, exit_code=0)
self.check_pyzor(
"check", "bob", input=input, code=200, exit_code=0, counts=(1, 0)
)
time.sleep(1)
self.check_pyzor("report", "bob", input=input, code=200, exit_code=0)
self.check_pyzor(
"check", "bob", input=input, code=200, exit_code=0, counts=(2, 0)
)
r = self.get_record(input)
self.assertEqual(r["Count"], "2")
self.assertNotEqual(r["Entered"], r["Updated"])
self.check_fuzzy_date(r["Updated"])
def test_whitelist(self):
input = "Test1 white list1 Test2"
self.check_pyzor("whitelist", "bob", input=input, code=200, exit_code=0)
self.check_pyzor(
"check", "bob", input=input, code=200, exit_code=1, counts=(0, 1)
)
r = self.get_record(input)
self.assertEqual(r["WL-Count"], "1")
self.check_fuzzy_date(r["WL-Entered"])
def test_whitelist_update(self):
input = "Test1 white list update1 Test2"
self.check_pyzor("whitelist", "bob", input=input, code=200, exit_code=0)
self.check_pyzor(
"check", "bob", input=input, code=200, exit_code=1, counts=(0, 1)
)
time.sleep(1)
self.check_pyzor("whitelist", "bob", input=input, code=200, exit_code=0)
self.check_pyzor(
"check", "bob", input=input, code=200, exit_code=1, counts=(0, 2)
)
r = self.get_record(input)
self.assertEqual(r["WL-Count"], "2")
self.assertNotEqual(r["WL-Entered"], r["WL-Updated"])
self.check_fuzzy_date(r["WL-Updated"])
def test_report_whitelist(self):
input = "Test1 white list report1 Test2"
self.check_pyzor("whitelist", "bob", input=input, code=200, exit_code=0)
self.check_pyzor("report", "bob", input=input, code=200, exit_code=0)
self.check_pyzor(
"check", "bob", input=input, code=200, exit_code=1, counts=(1, 1)
)
r = self.get_record(input)
self.assertEqual(r["Count"], "1")
self.check_fuzzy_date(r["Entered"])
self.assertEqual(r["WL-Count"], "1")
self.check_fuzzy_date(r["WL-Entered"])
def test_report_whitelist_update(self):
input = "Test1 white list report update1 Test2"
self.check_pyzor("whitelist", "bob", input=input, code=200, exit_code=0)
self.check_pyzor("report", "bob", input=input, code=200, exit_code=0)
self.check_pyzor(
"check", "bob", input=input, code=200, exit_code=1, counts=(1, 1)
)
time.sleep(1)
self.check_pyzor("whitelist", "bob", input=input, code=200, exit_code=0)
self.check_pyzor("report", "bob", input=input, code=200, exit_code=0)
self.check_pyzor(
"check", "bob", input=input, code=200, exit_code=1, counts=(2, 2)
)
r = self.get_record(input)
self.assertEqual(r["Count"], "2")
self.assertNotEqual(r["Entered"], r["Updated"])
self.check_fuzzy_date(r["Updated"])
self.assertEqual(r["WL-Count"], "2")
self.assertNotEqual(r["WL-Entered"], r["WL-Updated"])
self.check_fuzzy_date(r["WL-Updated"])
|