def test_decode(self):
"""Test decoding of a DIMSE message."""
primitive = C_STORE()
primitive.MessageID = 7
primitive.AffectedSOPClassUID = '1.1.1'
primitive.AffectedSOPInstanceUID = '1.2.1'
primitive.Priority = 0x02
primitive.MoveOriginatorApplicationEntityTitle = 'UNITTEST'
primitive.MoveOriginatorMessageID = 3
ds = Dataset()
ds.PatientID = 'Test1101'
ds.PatientName = 'Tube^HeNe'
primitive.DataSet = BytesIO(encode(ds, True, True))
dimse_msg = C_STORE_RQ()
dimse_msg.primitive_to_message(primitive)
# CMD: (1x4, 3x1), DS: (0x1, 2x1)
p_data = dimse_msg.encode_msg(12, 24)
# Command set decoding
dimse_msg.decode_msg(next(p_data)) # MCHB 1
dimse_msg.decode_msg(next(p_data)) # MCHB 1
dimse_msg.decode_msg(next(p_data)) # MCHB 1
dimse_msg.decode_msg(next(p_data)) # MCHB 1
dimse_msg.decode_msg(next(p_data)) # MCHB 3 - end of command set
assert dimse_msg.__class__ == C_STORE_RQ
# Test decoded command set
cs = dimse_msg.command_set
assert cs.CommandGroupLength == 94
assert cs.AffectedSOPClassUID == UID('1.1.1')
assert cs.AffectedSOPInstanceUID == UID('1.2.1')
assert cs.Priority == 2
assert cs.CommandDataSetType == 1
assert cs.CommandField == 1
assert cs.MoveOriginatorApplicationEntityTitle == 'UNITTEST'
assert cs.MoveOriginatorMessageID == 3
# Test decoded dataset
dimse_msg.decode_msg(next(p_data)) # MCHB 1 # MCHB 0
dimse_msg.decode_msg(next(p_data)) # MCHB 1 # MCHB 2
assert dimse_msg.data_set.getvalue() == c_store_ds[1:]
# Test returns false
msg = C_STORE_RSP()
assert not msg.decode_msg(c_store_rsp_cmd)
def test_scp_failed_ds_decode(self):
"""Test failure to decode the dataset"""
# Hard to test directly as decode errors won't show up until the
# dataset is actually used
def handle(event):
try:
for elem in event.dataset.iterall():
pass
except NotImplementedError:
status = Dataset()
status.Status = 0xC210
status.ErrorComment = "Unable to decode the dataset"
return status
return 0x0000
handlers = [(evt.EVT_C_STORE, handle)]
self.ae = ae = AE()
ae.add_supported_context(CTImageStorage)
ae.add_requested_context(CTImageStorage, ExplicitVRLittleEndian)
scp = ae.start_server(('', 11112), block=False, evt_handlers=handlers)
assoc = ae.associate('localhost', 11112)
assert assoc.is_established
req = C_STORE()
req.MessageID = 1
req.AffectedSOPClassUID = DATASET.SOPClassUID
req.AffectedSOPInstanceUID = DATASET.SOPInstanceUID
req.Priorty = 0x0002
req.DataSet = BytesIO(
b'\x08\x00\x01\x00\x04\x00\x00\x00\x00\x08\x00\x49')
# Send C-STORE request to DIMSE and get response
assoc.dimse.send_msg(req, 1)
cx_id, rsp = assoc.dimse.get_msg(True)
assert rsp.Status == 0xC210
assert rsp.ErrorComment == 'Unable to decode the dataset'
assoc.release()
assert assoc.is_released
scp.shutdown()
def test_uid_exceptions_false(self):
"""Test ValueError raised with ENFORCE_UID_CONFORMANCE = False."""
primitive = C_STORE()
_config.ENFORCE_UID_CONFORMANCE = False
primitive.AffectedSOPClassUID = 'abc'
assert primitive.AffectedSOPClassUID == 'abc'
primitive.AffectedSOPInstanceUID = 'abc'
assert primitive.AffectedSOPInstanceUID == 'abc'
# Can't have more than 64 characters
with pytest.raises(ValueError):
primitive.AffectedSOPClassUID = 'abc' * 22
with pytest.raises(ValueError):
primitive.AffectedSOPInstanceUID = 'abc' * 22
def test_primitive_to_message(self):
"""Test converting a DIMSE primitive to a DIMSE message."""
primitive = C_STORE()
primitive.MessageID = 7
primitive.AffectedSOPClassUID = "1.1.1"
primitive.AffectedSOPInstanceUID = "1.2.1"
primitive.Priority = 0x02
msg = C_STORE_RQ()
msg.primitive_to_message(primitive)
# Test unused command set elements are deleted
assert not "MoveOriginatorApplicationEntityTitle" in msg.command_set
# Test raise error for unknown DIMSE message type
msg.__class__.__name__ = "TestClass"
with pytest.raises(ValueError):
msg.primitive_to_message(primitive)
# Reset name to avoid errors in other tests
msg.__class__.__name__ = "C_STORE_RQ"
def test_cstore_rq(self):
"""Test creation of a DIMSE Message from a primitive works OK."""
# Testing that primitive_to_message doesn't affect the original class
# definition
req = C_STORE()
req.MessageID = 12
req.AffectedSOPClassUID = self.ds.SOPClassUID
req.AffectedSOPInstanceUID = self.ds.SOPInstanceUID
req.Priority = 0x02
req.MoveOriginatorApplicationEntityTitle = None
req.MoveOriginatorMessageID = None
req.DataSet = BytesIO(encode(self.ds, True, True))
msg = C_STORE_RQ()
msg.primitive_to_message(req)
cs = msg.command_set
assert cs.CommandGroupLength == 88
assert cs.AffectedSOPClassUID == "1.2.840.10008.5.1.4.1.1"
assert cs.CommandField == 1
assert cs.MessageID == 12
assert cs.Priority == 2
assert cs.CommandDataSetType == 1
assert cs.AffectedSOPInstanceUID == "1.2.3.4"
assert "MoveOriginatorApplicationEntityTitle" not in cs
assert "MoveOriginatorMessageID" not in cs
assert msg.data_set.getvalue() != b""
# Test new class instance is OK
msg = C_STORE_RQ()
cs = msg.command_set
ds = msg.data_set
assert cs.CommandGroupLength is None
assert cs.AffectedSOPClassUID in ["", None] # pydicom upstream change
assert cs.CommandField is None
assert cs.MessageID is None
assert cs.Priority is None
assert cs.CommandDataSetType is None
assert cs.AffectedSOPInstanceUID in ["", None]
assert cs.MoveOriginatorApplicationEntityTitle is None
assert cs.MoveOriginatorMessageID is None
assert ds.getvalue() == b""
def test_aet_short_true(self):
"""Test using short AE titles."""
primitive = C_STORE()
_config.USE_SHORT_DIMSE_AET = True
primitive.MoveOriginatorApplicationEntityTitle = b'A'
aet = primitive.MoveOriginatorApplicationEntityTitle
assert b'A ' == aet
primitive.MoveOriginatorApplicationEntityTitle = b'ABCDEFGHIJKLMNO'
aet = primitive.MoveOriginatorApplicationEntityTitle
assert b'ABCDEFGHIJKLMNO ' == aet
primitive.MoveOriginatorApplicationEntityTitle = b'ABCDEFGHIJKLMNOP'
aet = primitive.MoveOriginatorApplicationEntityTitle
assert b'ABCDEFGHIJKLMNOP' == aet
primitive.MoveOriginatorApplicationEntityTitle = b'ABCDEFGHIJKLMNOPQ'
aet = primitive.MoveOriginatorApplicationEntityTitle
assert b'ABCDEFGHIJKLMNOP' == aet
def test_encode_zero(self):
"""Test encoding with a 0 max pdu length."""
primitive = C_STORE()
primitive.MessageID = 7
primitive.AffectedSOPClassUID = "1.1.1"
primitive.AffectedSOPInstanceUID = "1.2.1"
primitive.Priority = 0x02
primitive.MoveOriginatorApplicationEntityTitle = "UNITTEST"
primitive.MoveOriginatorMessageID = 3
# Test encode without dataset
dimse_msg = C_STORE_RQ()
dimse_msg.primitive_to_message(primitive)
p_data_list = []
for pdata in dimse_msg.encode_msg(12, 0):
p_data_list.append(pdata)
assert p_data_list[0].presentation_data_value_list[0][1][
0:1] == b"\x03"
assert dimse_msg.context_id == 12
# Test encode with dataset
ds = Dataset()
ds.PatientID = "Test1101"
ds.PatientName = "Tube^HeNe"
primitive.DataSet = BytesIO(encode(ds, True, True))
dimse_msg = C_STORE_RQ()
dimse_msg.primitive_to_message(primitive)
p_data_list = []
for pdata in dimse_msg.encode_msg(13, 0):
p_data_list.append(pdata)
assert p_data_list[0].presentation_data_value_list[0][1][
0:1] == b"\x03"
assert p_data_list[0].presentation_data_value_list[0][
1] == c_store_rq_cmd
assert p_data_list[1].presentation_data_value_list[0][1][
0:1] == b"\x02"
assert p_data_list[1].presentation_data_value_list[0][1] == c_store_ds
assert dimse_msg.context_id == 13
def test_aet_short_true(self, caplog, use_long_aet):
"""Test using short AE titles."""
primitive = C_STORE()
primitive.MoveOriginatorApplicationEntityTitle = "A"
aet = primitive.MoveOriginatorApplicationEntityTitle
assert "A" == aet
primitive.MoveOriginatorApplicationEntityTitle = "ABCDEFGHIJKLMNO"
aet = primitive.MoveOriginatorApplicationEntityTitle
assert "ABCDEFGHIJKLMNO" == aet
primitive.MoveOriginatorApplicationEntityTitle = "ABCDEFGHIJKLMNOP"
aet = primitive.MoveOriginatorApplicationEntityTitle
assert "ABCDEFGHIJKLMNOP" == aet
with caplog.at_level(logging.ERROR, logger="pynetdicom"):
primitive.MoveOriginatorApplicationEntityTitle = "ABCDEFGHIJKLMNOPQ"
assert primitive.MoveOriginatorApplicationEntityTitle is None
assert (
"Invalid 'Move Originator AE Title' in C-STORE request"
) in caplog.text
"""Dummy Send method to test DIMSEServiceProvider.Send"""
pass
@staticmethod
def receive_pdu():
"""Dummy Receive method to test DIMSEServiceProvider.Receive"""
pass
@staticmethod
def peek_next_pdu():
return 0x01
REFERENCE_MSG = [
(C_ECHO(), ('C_ECHO_RQ', 'C_ECHO_RSP')),
(C_STORE(), ('C_STORE_RQ', 'C_STORE_RSP')),
(C_FIND(), ('C_FIND_RQ', 'C_FIND_RSP')),
(C_GET(), ('C_GET_RQ', 'C_GET_RSP')),
(C_MOVE(), ('C_MOVE_RQ', 'C_MOVE_RSP')),
(C_CANCEL(), (None, 'C_CANCEL_RQ')),
(N_EVENT_REPORT(), ('N_EVENT_REPORT_RQ', 'N_EVENT_REPORT_RSP')),
(N_GET(), ('N_GET_RQ', 'N_GET_RSP')),
(N_SET(), ('N_SET_RQ', 'N_SET_RSP')),
(N_ACTION(), ('N_ACTION_RQ', 'N_ACTION_RSP')),
(N_CREATE(), ('N_CREATE_RQ', 'N_CREATE_RSP')),
(N_DELETE(), ('N_DELETE_RQ', 'N_DELETE_RSP')),
]
class TestDIMSEProvider(object):
"""Test DIMSE service provider operations."""
def test_validate_status_unknown(self):
"""Test return unknown status"""
sop = StorageServiceClass(None)
rsp = C_STORE()
rsp = sop.validate_status(0xD011, rsp)
assert rsp.Status == 0xD011
def test_validate_status_invalid(self):
"""Test exception raised if invalid status value"""
sop = StorageServiceClass(None)
rsp = C_STORE()
rsp = sop.validate_status('test', rsp)
assert rsp.Status == 0xC002
def test_validate_status_int(self):
"""Test that validate_status works correctly with int"""
sop = StorageServiceClass(None)
rsp = C_STORE()
rsp = sop.validate_status(0x0000, rsp)
assert rsp.Status == 0x0000
def test_peek_item(self):
"""Test peek_msg with nothing on the queue."""
dimse = DIMSEServiceProvider(DummyAssociation())
primitive = C_STORE()
dimse.msg_queue.put((14, primitive))
assert dimse.peek_msg() == (14, primitive)
def test_exceptions(self):
""" Check incorrect types/values for properties raise exceptions """
primitive = C_STORE()
# MessageID
with pytest.raises(TypeError):
primitive.MessageID = 'halp'
with pytest.raises(TypeError):
primitive.MessageID = 1.111
with pytest.raises(ValueError):
primitive.MessageID = 65536
with pytest.raises(ValueError):
primitive.MessageID = -1
# MessageIDBeingRespondedTo
with pytest.raises(TypeError):
primitive.MessageIDBeingRespondedTo = 'halp'
with pytest.raises(TypeError):
primitive.MessageIDBeingRespondedTo = 1.111
with pytest.raises(ValueError):
primitive.MessageIDBeingRespondedTo = 65536
with pytest.raises(ValueError):
primitive.MessageIDBeingRespondedTo = -1
# AffectedSOPClassUID
with pytest.raises(TypeError):
primitive.AffectedSOPClassUID = 45.2
with pytest.raises(TypeError):
primitive.AffectedSOPClassUID = 100
# AffectedSOPInstanceUID
with pytest.raises(TypeError):
primitive.AffectedSOPInstanceUID = 45.2
with pytest.raises(TypeError):
primitive.AffectedSOPInstanceUID = 100
# Priority
with pytest.raises(ValueError):
primitive.Priority = 45.2
with pytest.raises(ValueError):
primitive.Priority = 'abc'
with pytest.raises(ValueError):
primitive.Priority = -1
with pytest.raises(ValueError):
primitive.Priority = 3
# MoveOriginatorApplicationEntityTitle
with pytest.raises(TypeError):
primitive.MoveOriginatorApplicationEntityTitle = 45.2
with pytest.raises(TypeError):
primitive.MoveOriginatorApplicationEntityTitle = 100
primitive.MoveOriginatorApplicationEntityTitle = ''
assert primitive.MoveOriginatorApplicationEntityTitle is None
with pytest.raises(ValueError):
primitive.MoveOriginatorApplicationEntityTitle = ' '
# MoveOriginatorMessageID
with pytest.raises(TypeError):
primitive.MoveOriginatorMessageID = 'halp'
with pytest.raises(TypeError):
primitive.MoveOriginatorMessageID = 1.111
with pytest.raises(ValueError):
primitive.MoveOriginatorMessageID = 65536
with pytest.raises(ValueError):
primitive.MoveOriginatorMessageID = -1
# DataSet
msg = r"'DataSet' parameter must be a BytesIO object"
with pytest.raises(TypeError, match=msg):
primitive.DataSet = 'halp'
with pytest.raises(TypeError):
primitive.DataSet = 1.111
with pytest.raises(TypeError):
primitive.DataSet = 50
with pytest.raises(TypeError):
primitive.DataSet = [30, 10]
# Status
with pytest.raises(TypeError):
primitive.Status = 19.4
def test_assignment(self):
"""Check assignment works correctly"""
primitive = C_STORE()
primitive.MessageID = None
assert primitive.MessageID is None
primitive.MessageID = 11
assert primitive.MessageID == 11
primitive.MessageIDBeingRespondedTo = None
assert primitive.MessageIDBeingRespondedTo is None
primitive.MessageIDBeingRespondedTo = 13
assert primitive.MessageIDBeingRespondedTo == 13
# AffectedSOPClassUID
primitive.AffectedSOPClassUID = None
assert primitive.AffectedSOPClassUID is None
primitive.AffectedSOPClassUID = "1.1.1"
assert primitive.AffectedSOPClassUID == UID("1.1.1")
assert isinstance(primitive.AffectedSOPClassUID, UID)
primitive.AffectedSOPClassUID = UID("1.1.2")
assert primitive.AffectedSOPClassUID == UID("1.1.2")
assert isinstance(primitive.AffectedSOPClassUID, UID)
primitive.AffectedSOPClassUID = b"1.1.3"
assert primitive.AffectedSOPClassUID == UID("1.1.3")
assert isinstance(primitive.AffectedSOPClassUID, UID)
# AffectedSOPInstanceUID
primitive.AffectedSOPInstanceUID = None
assert primitive.AffectedSOPInstanceUID is None
primitive.AffectedSOPInstanceUID = UID("1.2.2")
assert primitive.AffectedSOPInstanceUID == UID("1.2.2")
assert isinstance(primitive.AffectedSOPClassUID, UID)
primitive.AffectedSOPInstanceUID = "1.2.3"
assert primitive.AffectedSOPInstanceUID == UID("1.2.3")
assert isinstance(primitive.AffectedSOPClassUID, UID)
primitive.Priority = 0x02
assert primitive.Priority == 0x02
primitive.MoveOriginatorApplicationEntityTitle = "UNITTEST_SCP"
assert primitive.MoveOriginatorApplicationEntityTitle == "UNITTEST_SCP"
primitive.MoveOriginatorApplicationEntityTitle = ""
assert primitive.MoveOriginatorApplicationEntityTitle == ""
primitive.MoveOriginatorApplicationEntityTitle = " "
assert primitive.MoveOriginatorApplicationEntityTitle == " "
primitive.MoveOriginatorApplicationEntityTitle = None
assert primitive.MoveOriginatorApplicationEntityTitle is None
primitive.MoveOriginatorMessageID = 15
assert primitive.MoveOriginatorMessageID == 15
ref_ds = Dataset()
ref_ds.PatientID = 1234567
primitive.DataSet = BytesIO(encode(ref_ds, True, True))
# assert primitive.DataSet, ref_ds)
primitive.Status = 0x0000
assert primitive.Status == 0x0000
primitive.Status = 0xC123
assert primitive.Status == 0xC123
primitive.Status = 0xEE01
assert primitive.Status == 0xEE01
"""Dummy Send method to test DIMSEServiceProvider.Send"""
pass
@staticmethod
def receive_pdu():
"""Dummy Receive method to test DIMSEServiceProvider.Receive"""
pass
@staticmethod
def peek_next_pdu():
return 0x01
REFERENCE_MSG = [
(C_ECHO(), ("C_ECHO_RQ", "C_ECHO_RSP")),
(C_STORE(), ("C_STORE_RQ", "C_STORE_RSP")),
(C_FIND(), ("C_FIND_RQ", "C_FIND_RSP")),
(C_GET(), ("C_GET_RQ", "C_GET_RSP")),
(C_MOVE(), ("C_MOVE_RQ", "C_MOVE_RSP")),
(C_CANCEL(), (None, "C_CANCEL_RQ")),
(N_EVENT_REPORT(), ("N_EVENT_REPORT_RQ", "N_EVENT_REPORT_RSP")),
(N_GET(), ("N_GET_RQ", "N_GET_RSP")),
(N_SET(), ("N_SET_RQ", "N_SET_RSP")),
(N_ACTION(), ("N_ACTION_RQ", "N_ACTION_RSP")),
(N_CREATE(), ("N_CREATE_RQ", "N_CREATE_RSP")),
(N_DELETE(), ("N_DELETE_RQ", "N_DELETE_RSP")),
]
class TestDIMSEProvider:
"""Test DIMSE service provider operations."""
