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 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
|
#
# Copyright (c) 2016 - 2024 -- Lars Heuer
# All rights reserved.
#
# License: BSD License
#
"""\
Tests against the command line script.
"""
import os
import io
import tempfile
import gzip
import shutil
import xml.etree.ElementTree as etree
import pytest
from segno import cli
def test_defaults():
args = cli.parse([''])
assert args.content == ['']
assert args.error is None
assert args.mode is None
assert args.pattern is None
assert args.version is None
assert args.scale == 1
assert args.encoding is None
assert not args.micro
assert args.output is None
assert args.border is None
assert args.dark is None
assert args.light is None
assert args.boost_error
assert not args.seq
assert args.symbol_count is None
# PNG
assert not args.dpi
assert args.finder_dark is None
assert args.finder_light is None
assert args.data_dark is None
assert args.data_light is None
assert args.alignment_dark is None
assert args.alignment_light is None
assert args.timing_dark is None
assert args.timing_light is None
assert args.format_dark is None
assert args.format_light is None
assert args.version_dark is None
assert args.version_light is None
assert args.quiet_zone is None
assert args.dark_module is None
assert args.separator is None
# SVG
assert args.xmldecl
assert not args.no_classes
assert args.svgencoding == 'utf-8'
assert args.title is None
assert args.desc is None
assert args.svgns is True
assert args.svgid is None
assert args.svgclass is None
assert args.lineclass is None
assert args.omitsize is False
assert args.unit is None
assert args.svgversion is None
assert args.nl is True
assert args.draw_transparent is False
# Terminal
assert args.compact is False
def test_segno_version():
try:
cli.parse(['--ver', ''])
except SystemExit as ex:
assert 0 == ex.code
def test_segno_version_shortcut():
try:
cli.parse(['-V', ''])
except SystemExit as ex:
assert 0 == ex.code
def test_noargs():
try:
cli.parse([])
except SystemExit as ex:
assert 1 == ex.code
def test_error():
args = cli.parse(['-e', 'm', ''])
assert args.error == 'M'
qr = cli.make_code(args)
assert 'H' == qr.error
def test_error2():
args = cli.parse(['-e', 'M', ''])
assert args.error == 'M'
qr = cli.make_code(args)
assert 'H' == qr.error
def test_error3():
args = cli.parse(['-e', '-', '123'])
assert args.error is None
qr = cli.make_code(args)
assert not qr.is_micro
assert 1 == qr.version
assert 'H' == qr.error
def test_error_allow_micro():
args = cli.parse(['-e', '-', '--micro', '123'])
assert args.error is None
qr = cli.make_code(args)
assert qr.is_micro
assert 'M1' == qr.version
assert qr.error is None
def test_error4():
args = cli.parse(['--error=q', '--no-error-boost', ''])
assert args.error == 'Q'
qr = cli.make_code(args)
assert 'Q' == qr.error
def test_version():
args = cli.parse(['-v', '1', ''])
assert args.version == '1'
qr = cli.make_code(args)
assert 1 == qr.version
def test_version2():
args = cli.parse(['--version', '40', ''])
assert args.version == '40'
qr = cli.make_code(args)
assert 40 == qr.version
def test_version_micro():
args = cli.parse(['-v', 'M1', '0'])
assert args.version == 'M1'
qr = cli.make_code(args)
assert 'M1' == qr.version
def test_version_micro_m1():
args = cli.parse(['-v', 'M1', '12345'])
assert args.version == 'M1'
qr = cli.make_code(args)
assert 'M1' == qr.version
def test_version_micro_m1_automatic():
args = cli.parse(['--micro', '12345'])
qr = cli.make_code(args)
assert 'M1' == qr.version
def test_version_micro_m2_automatic():
args = cli.parse(['--micro', '123456'])
qr = cli.make_code(args)
assert 'M2' == qr.version
def test_mode():
args = cli.parse(['-m', 'alphanumeric', 'A'])
assert args.mode == 'alphanumeric'
qr = cli.make_code(args)
assert 'alphanumeric' == qr.mode
def test_mode2():
args = cli.parse(['--mode=byte', ''])
assert args.mode == 'byte'
qr = cli.make_code(args)
assert 'byte' == qr.mode
def test_pattern():
args = cli.parse(['-p', '1', ''])
assert args.pattern == 1
qr = cli.make_code(args)
assert qr.mask == 1
def test_pattern2():
args = cli.parse(['--pattern', '5', ''])
assert args.pattern == 5
qr = cli.make_code(args)
assert qr.mask == 5
def test_micro_false():
args = cli.parse(['--no-micro', ''])
assert not args.micro
qr = cli.make_code(args)
assert not qr.is_micro
def test_micro_true():
args = cli.parse(['--micro', ''])
assert args.micro
qr = cli.make_code(args)
assert qr.is_micro
def test_boost_error_disable():
args = cli.parse(['--no-error-boost', ''])
assert not args.boost_error
def test_border():
args = cli.parse(['--border', '0', ''])
assert args.border == 0
def test_border_shortcut():
args = cli.parse(['-b', '10', ''])
assert args.border == 10
def test_scale():
args = cli.parse(['--scale=1.6', ''])
assert args.scale == 1.6
def test_scale2():
args = cli.parse(['--scale=2.0', ''])
assert args.scale == 2
assert isinstance(args.scale, int)
def test_scale_shortcut():
args = cli.parse(['-s=1.6', ''])
assert args.scale == 1.6
def test_sequence():
args = cli.parse(['--seq', '-v=1', ''])
assert args.seq
assert '1' == args.version
def test_sequence_symbol_count():
args = cli.parse(['--seq', '--symbol-count=4', ''])
assert args.seq
assert 4 == args.symbol_count
def test_sequence_symbol_count_shortcut():
args = cli.parse(['--seq', '-sc=8', ''])
assert args.seq
assert 8 == args.symbol_count
def test_sequence_output():
directory = tempfile.mkdtemp()
assert 0 == len(os.listdir(directory))
cli.main(['--seq', '-v=1', '-e=m', '-o=' + os.path.join(directory,
'test.svg'),
'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'])
number_of_files = len(os.listdir(directory))
shutil.rmtree(directory)
assert 4 == number_of_files
def test_dark():
args = cli.parse(['--dark', 'green', ''])
assert args.dark == 'green'
assert cli.build_config(args)['dark'] == 'green'
@pytest.mark.parametrize('arg', ['transparent', 'trans'])
def test_dark_transparent(arg):
args = cli.parse([f'--dark={arg}', '-output=x.png', ''])
assert args.dark == arg
assert cli.build_config(args)['dark'] is None
def test_light():
args = cli.parse(['--light', 'red', ''])
assert args.light == 'red'
@pytest.mark.parametrize('arg', ['transparent', 'trans'])
def test_light_transparent(arg):
args = cli.parse([f'--light={arg}', '-output=x.png', ''])
assert args.light == arg
assert cli.build_config(args)['light'] is None
def test_error_code():
try:
cli.main(['--version=M1', '--seq', '"This is a test"'])
except SystemExit as ex:
assert 1 == ex.code
@pytest.mark.parametrize('arg', ['-o', '--output'])
@pytest.mark.parametrize('ext, expected, mode', [('svg', b'<?xml ', 'rb'),
('pdf', b'%PDF-', 'rb'),
('png', b'\211PNG\r\n\032\n', 'rb'),
('svgz', b'\x1f\x8b\x08', 'rb'),
('txt', '000000', 'rt'),
('eps', '%!PS-Adobe-3.0 EPSF-3.0', 'rt'),
('ans', '\033[7m ', 'rt'),
('pam', b'P7', 'rb'),
('pbm', b'P4\n', 'rb'),
('ppm', b'P6', 'rb'),
('xbm', '#define ', 'rt'),
('xpm', '/* XPM */', 'rt'),
('tex', '% Creator: ', 'rt'),
])
def test_output(arg, ext, expected, mode):
f = tempfile.NamedTemporaryFile('w', suffix=f'.{ext}',
delete=False)
f.close()
try:
cli.main(['test', arg, f.name])
f = open(f.name, mode=mode)
val = f.read(len(expected))
f.close()
assert expected == val
finally:
os.unlink(f.name)
def test_terminal(capsys):
cli.main(['test'])
out, err = capsys.readouterr()
assert out
assert '' == err
assert '\033[0m' in out
def test_terminal_compact(capsys):
cli.main(['--compact', 'test'])
out, err = capsys.readouterr()
assert out
assert '' == err
assert '\u2580' in out
# -- PNG
def test_dpi():
args = cli.parse(['--dpi=300', ''])
assert 300 == args.dpi
# -- SVG
def test_xmldecl():
args = cli.parse(['--output=x.svg', ''])
assert args.xmldecl
assert cli.build_config(args)['xmldecl'] is True
def test_omit_xmldecl():
args = cli.parse(['--no-xmldecl', '--output=x.svg', ''])
assert not args.xmldecl
assert cli.build_config(args)['xmldecl'] is False
def test_not_omit_classes():
args = cli.parse(['--output=x.svg', ''])
assert not args.no_classes
config = cli.build_config(args)
assert 'svgclass' not in config
assert 'lineclass' not in config
def test_omit_classes():
args = cli.parse(['--no-classes', '--output=x.svg', ''])
assert args.no_classes
config = cli.build_config(args)
assert config['svgclass'] is None
assert config['lineclass'] is None
def test_encoding():
args = cli.parse(['--output=x.svg', ''])
assert args.svgencoding == 'utf-8'
assert cli.build_config(args)['encoding'] == 'utf-8'
def test_encoding2():
args = cli.parse(['--svgencoding=ascii', '--output=x.svg', ''])
assert args.svgencoding == 'ascii'
assert cli.build_config(args)['encoding'] == 'ascii'
def test_encoding3():
# Ignore --encoding since it is used to *create* a QR code
args = cli.parse(['--encoding=latin1', '--output=x.svg', ''])
assert args.svgencoding == 'utf-8'
assert cli.build_config(args)['encoding'] == 'utf-8'
def test_title():
args = cli.parse(['--output=x.svg', ''])
assert args.title is None
assert cli.build_config(args)['title'] is None
def test_title2():
args = cli.parse(['--title=Magnolia', '--output=x.svg', ''])
assert args.title == 'Magnolia'
assert cli.build_config(args)['title'] == 'Magnolia'
def test_desc():
args = cli.parse(['--output=x.svg', ''])
assert args.desc is None
assert cli.build_config(args)['desc'] is None
def test_desc2():
args = cli.parse(['--desc=Magnolia', '--output=x.svg', ''])
assert args.desc == 'Magnolia'
assert cli.build_config(args)['desc'] == 'Magnolia'
def test_nl():
args = cli.parse(['--output=x.svg', ''])
assert args.nl is True
assert cli.build_config(args)['nl'] is True
def test_nl2():
args = cli.parse(['--no-newline', '--output=x.svg', ''])
assert not args.nl
assert cli.build_config(args)['nl'] is False
def test_ns():
args = cli.parse(['--output=x.svg', ''])
assert args.svgns is True
assert cli.build_config(args)['svgns'] is True
def test_ns2():
args = cli.parse(['--no-namespace', '--output=x.svg', ''])
assert not args.svgns
assert cli.build_config(args)['svgns'] is False
def test_svgid():
args = cli.parse(['--output=x.svg', ''])
assert args.svgid is None
assert 'svgid' not in cli.build_config(args)
def test_svgid2():
args = cli.parse(['--svgid=magnolia', '--output=x.svg', ''])
assert args.svgid == 'magnolia'
assert cli.build_config(args)['svgid'] == 'magnolia'
def test_svgclass():
args = cli.parse(['--output=x.svg', ''])
assert args.svgclass is None
assert 'svgclass' not in cli.build_config(args)
def test_svgclass2():
args = cli.parse(['--svgclass=magnolia', '--output=x.svg', ''])
assert args.svgclass == 'magnolia'
assert cli.build_config(args)['svgclass'] == 'magnolia'
_SVG_NS = 'http://www.w3.org/2000/svg'
def _parse_xml(buff):
"""\
Parses XML and returns the root element.
"""
buff.seek(0)
return etree.parse(buff).getroot()
def test_svgclass3():
fname = _make_tmp_svg_filename()
res = cli.main([f'--output={fname}', 'test'])
assert 0 == res
with open(fname, 'rb') as f:
data = io.BytesIO(f.read())
root = _parse_xml(data)
assert root is not None
assert root.get('class') is not None
res = cli.main(['--svgclass', '', f'--output={fname}', 'test'])
assert 0 == res
with open(fname, 'rb') as f:
data = io.BytesIO(f.read())
os.unlink(fname)
root = _parse_xml(data)
assert root is not None
assert root.get('class') is None
def test_svg_lineclass():
args = cli.parse(['--output=x.svg', ''])
assert args.lineclass is None
assert 'lineclass' not in cli.build_config(args)
def test_svg_lineclass2():
args = cli.parse(['--lineclass=magnolia', ''])
assert args.lineclass == 'magnolia'
assert cli.build_config(args)['lineclass'] == 'magnolia'
def test_lineclass3():
fname = _make_tmp_svg_filename()
res = cli.main([f'--output={fname}', 'test'])
assert 0 == res
with open(fname, 'rb') as f:
data = io.BytesIO(f.read())
root = _parse_xml(data)
assert root is not None
path = root[0]
assert path is not None
assert path.get('class') is not None
res = cli.main(['--lineclass', '', f'--output={fname}', 'test'])
assert 0 == res
with open(fname, 'rb') as f:
data = io.BytesIO(f.read())
os.unlink(fname)
root = _parse_xml(data)
path = root[0]
assert path is not None
assert path.get('class') is None
def test_omitsize():
args = cli.parse(['--output=x.svg', ''])
assert not args.omitsize
assert cli.build_config(args)['omitsize'] is False
def test_omitsize2():
args = cli.parse(['--no-size', ''])
assert args.omitsize
assert cli.build_config(args)['omitsize'] is True
def test_unit():
args = cli.parse([''])
assert args.unit is None
assert cli.build_config(args)['unit'] is None
def test_unit2():
args = cli.parse(['--unit=cm', ''])
assert args.unit == 'cm'
assert cli.build_config(args)['unit'] == 'cm'
def test_svgversion():
args = cli.parse([''])
assert args.svgversion is None
assert cli.build_config(args)['svgversion'] is None
def test_svgversion2():
args = cli.parse(['--svgversion=1', ''])
assert args.svgversion == 1.0
assert cli.build_config(args)['svgversion'] == 1.0
def test_svgversion3():
args = cli.parse(['--svgversion=1.1', ''])
assert args.svgversion == 1.1
assert cli.build_config(args)['svgversion'] == 1.1
def test_draw_transparent():
fname = _make_tmp_svg_filename()
res = cli.main(['--dark=green', '--finder-dark=green', '--dark-module=blue',
'--align-light=yellow', '--quiet-zone=yellow',
f'--output={fname}', 'test'])
assert 0 == res
with open(fname, 'rb') as f:
data = io.BytesIO(f.read())
root = _parse_xml(data)
paths = root.findall('.//{%s}path' % _SVG_NS)
assert 3 == len(paths)
res = cli.main(['--dark=green', '--finder-dark=green', '--dark-module=blue',
'--align-light=yellow', '--quiet-zone=yellow',
'--draw-transparent', f'--output={fname}', 'test'])
assert 0 == res
with open(fname, 'rb') as f:
data = io.BytesIO(f.read())
os.unlink(fname)
root = _parse_xml(data)
paths = root.findall('.//{%s}path' % _SVG_NS)
assert 4 == len(paths)
assert 1 == len([p for p in paths if p.attrib.get('stroke') is None])
def test_png_svg_command():
args = cli.parse(['--svgversion=1.1', ''])
assert args.svgversion == 1.1
assert 'svgversion' in cli.build_config(args)
assert 'svgversion' not in cli.build_config(args, filename='x.png')
def test_output_svgz():
f = tempfile.NamedTemporaryFile('w', suffix='.svgz', delete=False)
f.close()
res = cli.main(['--scale=10', '--dark=red', f'--output={f.name}',
'test'])
assert 0 == res
with gzip.open(f.name) as f:
content = f.read()
os.unlink(f.name)
assert b'scale(10)' in content
assert b'stroke="red"' in content
def _make_tmp_svg_filename():
f = tempfile.NamedTemporaryFile('w', suffix='.svg', delete=False)
f.close()
return f.name
if __name__ == '__main__':
pytest.main([__file__])
|