def test_upload_job_path_ok(self, mock_post_uri, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.return_value = {
"state": {
"text": "Operational"
},
"temperature": {},
}
mock_post_uri.return_value.status_code = 201
mock_post_uri.return_value.json.return_value = {
"files": {
"local": {
"name": "20mm-umlaut-box",
"origin": "local",
"refs": {
"resource":
"http://example.com/api/files/local/whistle_v2.gcode",
"download":
"http://example.com/downloads/files/local/whistle_v2.gcode",
},
}
},
"done": True,
}
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.upload_and_start_job(self.file_mock.name,
path="sub/path/on/disk")
self.assertTrue(result)
args, kwargs = mock_post_uri.call_args
self.assertEqual(kwargs["data"], {
"path": "karmen/sub/path/on/disk",
"print": True
})
self.assertEqual(kwargs["files"]["file"].name, self.file_mock.name)
def test_job_ok(self, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.return_value = {
"job": {
"file": {
"display": "test-pouzdro-na-iphone.gcode"
}
},
"progress": {
"completion": 12,
"printTimeLeft": 35,
"printTime": 10
},
"state": "Printing",
}
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.job()
self.assertEqual(
result,
{
"name": "test-pouzdro-na-iphone.gcode",
"completion": 12,
"printTimeLeft": 35,
"printTime": 10,
},
)
def test_unknown_actino(self):
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
with self.assertRaises(Exception) as ctx:
printer.modify_current_job("random")
self.assertTrue("random is not allowed" in str(ctx.exception))
def test_modify_job_disconnect(self, mock_post_uri):
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
self.assertTrue(printer.client.connected)
result = printer.modify_current_job("toggle")
self.assertFalse(result)
self.assertFalse(printer.client.connected)
def test_deactivate_non_200_responding_printer(self, mock_get_uri):
mock_get_uri.return_value.status_code = 404
printer = Octoprint("192.168.1.15")
printer.sniff()
self.assertEqual(printer.client.connected, False)
self.assertEqual(printer.client.version, {})
self.assertEqual(printer.client.read_only, False)
def test_webcam_no_absolute_url(self, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.return_value = {
"webcam": {
"bitrate": "5000k",
"ffmpegPath": "/usr/bin/ffmpeg",
"ffmpegThreads": 1,
"flipH": True,
"flipV": True,
"rotate90": False,
"snapshotSslValidation": True,
"snapshotTimeout": 5,
"snapshotUrl": "http://127.0.0.1:8080/?action=snapshot",
"streamRatio": "4:3",
"streamTimeout": 5,
"streamUrl": "/webcam/?action=stream",
"timelapseEnabled": True,
"watermark": True,
"webcamEnabled": True,
}
}
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.webcam()
self.assertEqual(
result,
{
"message": "OK",
"stream": "http://192.168.1.15/webcam/?action=stream",
"flipHorizontal": True,
"flipVertical": True,
"rotate90": False,
},
)
def test_403_not_octoprint(self, mock_get_uri):
mock_get_uri.return_value.status_code = 403
printer = Octoprint("192.168.1.15")
printer.sniff()
self.assertEqual(printer.client.connected, False)
self.assertEqual(printer.client.read_only, False)
self.assertEqual(printer.client.version, {})
def test_status_unreachable(self, mock_get_uri):
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.status()
self.assertEqual(result, {
"state": "Printer is not responding",
"temperature": {}
})
def test_activate_responding_printer(self, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.return_value = {"text": "OctoPrint"}
printer = Octoprint("192.168.1.15")
printer.sniff()
self.assertEqual(printer.client.connected, True)
self.assertEqual(printer.client.version, {"text": "OctoPrint"})
self.assertEqual(printer.client.read_only, False)
def test_no_crash_on_different_response(self, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.return_value = {"random": "field"}
printer = Octoprint("192.168.1.15")
printer.sniff()
self.assertEqual(printer.client.connected, False)
self.assertEqual(printer.client.version, {"random": "field"})
self.assertEqual(printer.client.read_only, False)
def test_job_malformed_json(self, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.side_effect = json.decoder.JSONDecodeError(
"msg", "aa", 123)
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.job()
self.assertEqual(result, {})
def test_modify_job_cancel_ok(self, mock_post_uri):
mock_post_uri.return_value.status_code = 204
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.modify_current_job("cancel")
self.assertTrue(result)
args, kwargs = mock_post_uri.call_args
self.assertEqual(kwargs["json"], {"command": "cancel"})
def test_deactivate_no_data_responding_printer(self, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.side_effect = json.decoder.JSONDecodeError(
"msg", "aa", 123)
printer = Octoprint("192.168.1.15")
printer.sniff()
self.assertEqual(printer.client.connected, False)
self.assertEqual(printer.client.version, {})
self.assertEqual(printer.client.read_only, False)
def test_status_conflict(self, mock_get_uri):
mock_get_uri.return_value.status_code = 409
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.status()
self.assertEqual(
result,
{
"state": "Printer is not connected to Octoprint",
"temperature": {}
},
)
def test_upload_job_no_response(self, mock_post_uri, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.return_value = {
"state": {
"text": "Operational"
},
"temperature": {},
}
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.upload_and_start_job(self.file_mock.name)
self.assertFalse(result)
def test_upload_job_printing(self, mock_post_uri, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.return_value = {
"state": {
"text": "Printing"
},
"temperature": {},
}
with self.assertRaises(PrinterDriverException) as context:
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
printer.upload_and_start_job(self.file_mock.name)
self.assertTrue("Printer is printing" in str(context.exception))
def test_status_malformed_json(self, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.side_effect = json.decoder.JSONDecodeError(
"msg", "aa", 123)
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.status()
self.assertEqual(
result,
{
"state": "Printer is responding with invalid data",
"temperature": {}
},
)
def test_webcam_disabled(self, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.return_value = {
"webcam": {
"flipH": True,
"flipV": True,
"rotate90": False,
"streamUrl": "http://1.2.3.4/webcam/?action=stream",
"webcamEnabled": False,
}
}
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.webcam()
self.assertEqual(result, {"message": "Stream disabled in octoprint"})
def get_printer_instance(printer):
if not "client" in printer:
raise RuntimeError("Printer has no client defined")
if printer["client"] == "octoprint":
return Octoprint(**printer)
raise RuntimeError("Printer has an unknown client %s defined" %
printer["client"])
def test_connected_printer(self, mock_get_uri):
class Response:
def __init__(self, status_code, contents):
self.status_code = status_code
self.contents = contents
def json(self):
return {"text": "something"}
def mock_call(uri, **kwargs):
return Response(200, "")
mock_get_uri.side_effect = mock_call
printer = Octoprint("192.168.1.15")
self.assertFalse(printer.client.connected)
self.assertTrue(printer.is_alive())
self.assertTrue(printer.client.connected)
self.assertEqual(mock_get_uri.call_count, 2)
def test_job_offline_printer(self, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.return_value = {
"job": {
"file": {
"display": "test-pouzdro-na-iphone.gcode"
}
},
"progress": {
"completion": 100,
"printTimeLeft": 0,
"printTime": 10
},
"state":
"Offline (Error: Too many consecutive timeouts, printer still connected and alive?)",
}
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.job()
self.assertEqual(result, {})
def test_parse_client_props(self):
printer = Octoprint(
"192.168.1.15",
hostname="octopi.local",
client_props={
"connected": True,
"read_only": False,
"version": {}
},
)
self.assertTrue(printer.client.connected)
def test_access_protected_octoprint(self, mock_get_uri):
class Response:
def __init__(self, status_code, contents):
self.status_code = status_code
self.contents = contents
def json(self):
return {"text": "something"}
def mock_call(ip, **kwargs):
if "settings" in kwargs["endpoint"]:
return Response(200, "")
return Response(403, "")
mock_get_uri.side_effect = mock_call
printer = Octoprint("192.168.1.15")
printer.sniff()
self.assertEqual(printer.client.connected, True)
self.assertEqual(printer.client.read_only, True)
self.assertEqual(printer.client.version, {})
def test_status_ok(self, mock_get_uri):
mock_get_uri.return_value.status_code = 200
mock_get_uri.return_value.json.return_value = {
"state": {
"text": "Printing"
},
"temperature": {
"bed": {
"actual": 49.8,
"offset": 0,
"target": 50.0
},
"tool0": {
"actual": 240.4,
"offset": 0,
"target": 240.0
},
},
}
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.status()
self.assertEqual(
result,
{
"state": "Printing",
"temperature": {
"bed": {
"actual": 49.8,
"offset": 0,
"target": 50.0
},
"tool0": {
"actual": 240.4,
"offset": 0,
"target": 240.0
},
},
},
)
def test_deactivate_non_responding_printer(self, mock_get_uri):
printer = Octoprint("192.168.1.15")
self.assertFalse(printer.client.connected)
printer.sniff()
self.assertEqual(printer.client.connected, False)
self.assertEqual(printer.client.version, {})
def test_modify_job_inactive_printer(self, mock_post_uri):
printer = Octoprint("192.168.1.15")
self.assertEqual(mock_post_uri.call_count, 0)
result = printer.modify_current_job("toggle")
self.assertFalse(result)
def test_modify_job_disconnected(self, mock_post_uri):
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=False))
result = printer.modify_current_job("toggle")
self.assertEqual(mock_post_uri.call_count, 0)
self.assertFalse(result)
def test_upload_job_inactive_printer(self, mock_post_uri, mock_get_uri):
printer = Octoprint("192.168.1.15")
self.assertEqual(mock_post_uri.call_count, 0)
result = printer.upload_and_start_job(self.file_mock.name)
self.assertFalse(result)
def test_job_no_response(self, mock_get_uri):
printer = Octoprint("192.168.1.15",
client=PrinterClientInfo(connected=True))
result = printer.job()
self.assertEqual(result, {})
def test_job_inactive_printer(self, mock_get_uri):
printer = Octoprint("192.168.1.15")
self.assertEqual(mock_get_uri.call_count, 0)
result = printer.job()
self.assertEqual(result, {})