mirror of
https://github.com/rickbarrette/redmine_qbo_label_agent.git
synced 2026-11-17 18:10:36 -05:00
Print agent for redmine_qbo_labels
Runs on the label printer's network, asks Redmine for labels every couple of seconds (Bearer token from Administration » Label printers), draws them like the print dialog's preview, and prints them on a Brother QL printer over TCP 9100. Finds the printer on the network over Bonjour/mDNS (or PRINTER), checks its status before each label and every minute, and reports back printed or failed with the printer's error. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
commit
e5ca5b6980
20 files changed
+1054
No files matched your search
Whitespace-only changes.
@@ -0,0 +1,83 @@
|
||||
import socket
|
||||
import threading
|
||||
|
||||
import pytest
|
||||
from brother_ql.models import ModelsManager
|
||||
|
||||
|
||||
def status_bytes(status_type=0x00, phase=0x00, errors1=0, errors2=0, width=62, media=0x0A):
|
||||
"""A Brother QL status message (32 bytes) as a QL-820NWB sends it"""
|
||||
model = next(m for m in ModelsManager().iter_elements() if m.identifier == 'QL-820NWB')
|
||||
data = bytearray(32)
|
||||
data[0:3] = b'\x80\x20\x42'
|
||||
data[3] = model.series_code
|
||||
data[4] = model.model_code
|
||||
data[8] = errors1
|
||||
data[9] = errors2
|
||||
data[10] = width
|
||||
data[11] = media
|
||||
data[18] = status_type
|
||||
data[19] = phase
|
||||
return bytes(data)
|
||||
|
||||
|
||||
class FakePrinter:
|
||||
"""A label printer on TCP: answers status requests, and after a print job sends the given messages"""
|
||||
|
||||
def __init__(self, answers_status=True, after_print=None, status=None):
|
||||
self.answers_status = answers_status
|
||||
self.status = status or status_bytes()
|
||||
self.after_print = after_print if after_print is not None else [status_bytes(0x01)]
|
||||
self.received = []
|
||||
self.server = socket.socket()
|
||||
self.server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
||||
self.server.bind(('127.0.0.1', 0))
|
||||
self.server.listen(5)
|
||||
self.port = self.server.getsockname()[1]
|
||||
self.thread = threading.Thread(target=self._serve, daemon=True)
|
||||
self.thread.start()
|
||||
|
||||
def _serve(self):
|
||||
while True:
|
||||
try:
|
||||
conn, _ = self.server.accept()
|
||||
except OSError:
|
||||
return
|
||||
with conn:
|
||||
conn.settimeout(1.0)
|
||||
data = b''
|
||||
answered = False
|
||||
while True:
|
||||
try:
|
||||
chunk = conn.recv(65536)
|
||||
except socket.timeout:
|
||||
break
|
||||
if not chunk:
|
||||
break
|
||||
data += chunk
|
||||
if self.answers_status and not answered and b'\x1b\x69\x53' in data:
|
||||
conn.sendall(self.status)
|
||||
answered = True
|
||||
# The print command (with feeding) ends a job: 0x1A
|
||||
if data.endswith(b'\x1a'):
|
||||
for message in self.after_print if self.answers_status else []:
|
||||
conn.sendall(message)
|
||||
break
|
||||
self.received.append(data)
|
||||
|
||||
def close(self):
|
||||
self.server.close()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def fake_printer():
|
||||
printers = []
|
||||
|
||||
def make(**kwargs):
|
||||
printer = FakePrinter(**kwargs)
|
||||
printers.append(printer)
|
||||
return printer
|
||||
|
||||
yield make
|
||||
for printer in printers:
|
||||
printer.close()
|
||||
@@ -0,0 +1,95 @@
|
||||
import json
|
||||
import threading
|
||||
from http.server import BaseHTTPRequestHandler, HTTPServer
|
||||
|
||||
from label_agent.__main__ import Agent
|
||||
|
||||
|
||||
class FakeRedmine:
|
||||
"""Redmine's label agent API: hands out the given jobs, records results"""
|
||||
|
||||
def __init__(self, jobs, token='qbl_test'):
|
||||
self.jobs = list(jobs)
|
||||
self.results = {}
|
||||
self.polls = []
|
||||
outer = self
|
||||
|
||||
class Handler(BaseHTTPRequestHandler):
|
||||
def log_message(self, *args):
|
||||
pass
|
||||
|
||||
def do_POST(self):
|
||||
body = json.loads(self.rfile.read(int(self.headers['Content-Length'] or 0)) or b'{}')
|
||||
if self.headers.get('Authorization') != f'Bearer {token}':
|
||||
return self.reply(401, {'error': 'unauthorized'})
|
||||
if self.path == '/label_agent/poll':
|
||||
outer.polls.append(body)
|
||||
job = outer.jobs.pop(0) if outer.jobs else None
|
||||
return self.reply(200, {'job': job, 'poll_seconds': 0.2})
|
||||
if self.path.startswith('/label_agent/jobs/'):
|
||||
outer.results[int(self.path.split('/')[3])] = body
|
||||
return self.reply(200, {'ok': True})
|
||||
self.reply(404, {})
|
||||
|
||||
def reply(self, code, payload):
|
||||
data = json.dumps(payload).encode()
|
||||
self.send_response(code)
|
||||
self.send_header('Content-Type', 'application/json')
|
||||
self.send_header('Content-Length', str(len(data)))
|
||||
self.end_headers()
|
||||
self.wfile.write(data)
|
||||
|
||||
self.server = HTTPServer(('127.0.0.1', 0), Handler)
|
||||
self.url = f'http://127.0.0.1:{self.server.server_address[1]}'
|
||||
threading.Thread(target=self.server.serve_forever, daemon=True).start()
|
||||
|
||||
def close(self):
|
||||
self.server.shutdown()
|
||||
|
||||
|
||||
def run_agent(agent, until, seconds=10):
|
||||
thread = threading.Thread(target=agent.run, daemon=True)
|
||||
thread.start()
|
||||
import time
|
||||
end = time.monotonic() + seconds
|
||||
while time.monotonic() < end and not until():
|
||||
time.sleep(0.05)
|
||||
agent.stop()
|
||||
thread.join(5)
|
||||
|
||||
|
||||
def test_prints_jobs_and_reports_back(fake_printer):
|
||||
printer = fake_printer()
|
||||
redmine = FakeRedmine([
|
||||
{'id': 7, 'lines': ['SMITH', 'E1234'], 'copies': 1, 'max_length_mm': 101.6, 'min_length_mm': 25.4},
|
||||
{'id': 8, 'lines': [], 'copies': 1},
|
||||
])
|
||||
agent = Agent({'REDMINE_URL': redmine.url, 'AGENT_TOKEN': 'qbl_test',
|
||||
'PRINTER': f'tcp://127.0.0.1:{printer.port}'})
|
||||
run_agent(agent, lambda: len(redmine.results) == 2)
|
||||
redmine.close()
|
||||
|
||||
assert redmine.results[7] == {'status': 'printed'}
|
||||
assert redmine.results[8]['status'] == 'failed'
|
||||
# The first poll tells Redmine about the printer
|
||||
assert redmine.polls[0]['agent']['printer_address'] == f'127.0.0.1:{printer.port}'
|
||||
assert redmine.polls[0]['agent']['printer_status'] == 'Ready, 62mm continuous'
|
||||
# ... and later polls don't repeat it
|
||||
assert 'agent' not in redmine.polls[-1]
|
||||
|
||||
|
||||
def test_unreachable_printer_fails_the_job():
|
||||
redmine = FakeRedmine([{'id': 9, 'lines': ['SMITH', 'W42'], 'copies': 1}])
|
||||
agent = Agent({'REDMINE_URL': redmine.url, 'AGENT_TOKEN': 'qbl_test', 'PRINTER': 'tcp://127.0.0.1:1'})
|
||||
run_agent(agent, lambda: 9 in redmine.results)
|
||||
redmine.close()
|
||||
assert redmine.results[9]['status'] == 'failed'
|
||||
assert "Can't reach the printer" in redmine.results[9]['error']
|
||||
|
||||
|
||||
def test_wrong_token_keeps_running_without_printing():
|
||||
redmine = FakeRedmine([{'id': 1, 'lines': ['X'], 'copies': 1}], token='qbl_other')
|
||||
agent = Agent({'REDMINE_URL': redmine.url, 'AGENT_TOKEN': 'qbl_test', 'PRINTER': 'tcp://127.0.0.1:1'})
|
||||
run_agent(agent, lambda: False, seconds=1)
|
||||
redmine.close()
|
||||
assert redmine.jobs and not redmine.results
|
||||
@@ -0,0 +1,67 @@
|
||||
import pytest
|
||||
|
||||
from label_agent.label import HEIGHT, MARGIN_X, MARGIN_Y, layout, mm_to_dots, render
|
||||
|
||||
|
||||
def test_label_is_the_roll_height_and_fits_the_text():
|
||||
image = render(['SMITH', 'E1234'], 25.4, 101.6)
|
||||
assert image.size[1] == HEIGHT
|
||||
assert mm_to_dots(25.4) <= image.size[0] <= mm_to_dots(101.6)
|
||||
assert image.mode == '1'
|
||||
|
||||
|
||||
def test_short_text_gets_a_short_label_with_the_biggest_letters():
|
||||
sizes_short, boxes, length_short = layout(['LI', 'W1'], 25.4, 101.6)
|
||||
sizes_long, _, length_long = layout(['WASHINGTON', 'E1234'], 25.4, 101.6)
|
||||
# The letters fill the roll's height, and the label is only as long as they need
|
||||
assert sum(box.height for box in boxes) > (HEIGHT - 2 * MARGIN_Y) * 0.85
|
||||
assert length_short < length_long
|
||||
assert sizes_short[0] > sizes_long[0]
|
||||
|
||||
|
||||
def test_the_minimum_length():
|
||||
_, _, length = layout(['I'], 50, 101.6)
|
||||
assert length == mm_to_dots(50)
|
||||
|
||||
|
||||
def test_long_names_stop_at_the_maximum_length_with_smaller_letters():
|
||||
sizes, boxes, length = layout(['VANDERSCHMIDTBERGER', 'I12345'], 25.4, 101.6)
|
||||
# As long as allowed, give or take a font size step
|
||||
assert mm_to_dots(101.6) - 40 <= length <= mm_to_dots(101.6)
|
||||
assert max(box.width for box in boxes) <= length - 2 * MARGIN_X
|
||||
longer_sizes, _, _ = layout(['VANDERSCHMIDTBERGER', 'I12345'], 25.4, 200)
|
||||
assert longer_sizes[0] > sizes[0]
|
||||
|
||||
|
||||
def test_a_long_name_leaves_room_for_a_bigger_po_number():
|
||||
sizes, boxes, _ = layout(['VANDERSCHMIDT', 'I12345'], 25.4, 101.6)
|
||||
assert sizes[1] > sizes[0] * 1.25
|
||||
assert sum(box.height for box in boxes) <= HEIGHT - 2 * MARGIN_Y
|
||||
|
||||
|
||||
def test_lines_about_the_same_length_are_the_same_size():
|
||||
sizes, _, _ = layout(['SMITH', 'E1234'], 25.4, 101.6)
|
||||
assert sizes[0] == sizes[1]
|
||||
|
||||
|
||||
def test_lines_fit_the_height():
|
||||
_, boxes, _ = layout(['SMITH', 'E1234'], 25.4, 300)
|
||||
assert sum(box.height for box in boxes) < HEIGHT
|
||||
|
||||
|
||||
def test_text_is_drawn_inside_the_margins():
|
||||
image = render(['SMITH', 'E1234'], 25.4, 101.6)
|
||||
left, top, right, bottom = image.point(lambda v: 255 - v).getbbox()
|
||||
assert left >= MARGIN_X - 1
|
||||
assert right <= image.size[0] - MARGIN_X + 1
|
||||
assert top > 0 and bottom < HEIGHT
|
||||
|
||||
|
||||
def test_blank_lines_are_dropped_and_an_empty_label_is_refused():
|
||||
assert render([' ', 'E1234'], 25.4, 101.6).size[1] == HEIGHT
|
||||
with pytest.raises(ValueError):
|
||||
render(['', ' '])
|
||||
|
||||
|
||||
def test_accented_names():
|
||||
render(['MÜLLER', 'ŁUKASZ', 'W42'], 25.4, 101.6)
|
||||
@@ -0,0 +1,57 @@
|
||||
import pytest
|
||||
|
||||
from label_agent.label import render
|
||||
from label_agent.printer import (Printer, PrinterError, PrinterUnreachable, describe_status, parse_address)
|
||||
from tests.conftest import status_bytes
|
||||
|
||||
|
||||
def label():
|
||||
return render(['SMITH', 'E1234'])
|
||||
|
||||
|
||||
def test_parse_address():
|
||||
assert parse_address('tcp://192.168.0.100') == ('192.168.0.100', 9100)
|
||||
assert parse_address('192.168.0.100:9101') == ('192.168.0.100', 9101)
|
||||
|
||||
|
||||
def test_raster_is_for_62mm_continuous_and_cuts():
|
||||
data = Printer('127.0.0.1').raster([label()])
|
||||
assert data.startswith(b'\x1bia\x01') # raster mode
|
||||
assert b'\x1biz' in data # media: 62mm
|
||||
assert data.endswith(b'\x1a')
|
||||
|
||||
|
||||
def test_status_describes_media(fake_printer):
|
||||
printer = fake_printer()
|
||||
status = Printer('127.0.0.1', printer.port).status()
|
||||
assert describe_status(status) == 'Ready, 62mm continuous'
|
||||
|
||||
|
||||
def test_prints_and_waits_for_the_printer(fake_printer):
|
||||
printer = fake_printer(after_print=[status_bytes(0x06, 0x01), status_bytes(0x01), status_bytes(0x01)])
|
||||
outcome = Printer('127.0.0.1', printer.port).print([label(), label()], timeout=5)
|
||||
assert outcome == 'printed'
|
||||
assert printer.received and b'\x1b\x69\x53' in printer.received[-1]
|
||||
|
||||
|
||||
def test_printer_without_network_status_is_sent(fake_printer):
|
||||
printer = fake_printer(answers_status=False)
|
||||
assert Printer('127.0.0.1', printer.port).print([label()], timeout=3) == 'sent'
|
||||
|
||||
|
||||
def test_printer_error_before_printing(fake_printer):
|
||||
printer = fake_printer(status=status_bytes(errors1=0x01)) # no media
|
||||
with pytest.raises(PrinterError) as error:
|
||||
Printer('127.0.0.1', printer.port).print([label()], timeout=3)
|
||||
assert 'Error' in str(error.value)
|
||||
|
||||
|
||||
def test_printer_error_while_printing(fake_printer):
|
||||
printer = fake_printer(after_print=[status_bytes(0x02, errors2=0x10)]) # cover open
|
||||
with pytest.raises(PrinterError):
|
||||
Printer('127.0.0.1', printer.port).print([label()], timeout=3)
|
||||
|
||||
|
||||
def test_unreachable_printer():
|
||||
with pytest.raises(PrinterUnreachable):
|
||||
Printer('127.0.0.1', 1).status()
|
||||
Reference in new issue
Block a user