Add the SetAttribute request and response payloads

This change adds support for the SetAttribute operation in the
form of request and response payload structures. These will be used
in future updates to the client and server to fully support the
SetAttribute operation. A new unit test suite has been added to
cover the new changes.

Partially Implements #547
This commit is contained in:
Peter Hamilton 2019-11-19 12:59:44 -05:00 committed by Peter Hamilton
parent 072d55a9c3
commit 1bb314d523
3 changed files with 1052 additions and 0 deletions

View File

@ -123,6 +123,10 @@ from kmip.core.messages.payloads.revoke import (
RevokeRequestPayload,
RevokeResponsePayload
)
from kmip.core.messages.payloads.set_attribute import (
SetAttributeRequestPayload,
SetAttributeResponsePayload
)
from kmip.core.messages.payloads.sign import (
SignRequestPayload,
SignResponsePayload
@ -187,6 +191,8 @@ __all__ = [
"ResponsePayload",
"RevokeRequestPayload",
"RevokeResponsePayload",
"SetAttributeRequestPayload",
"SetAttributeResponsePayload",
"SignRequestPayload",
"SignResponsePayload",
"SignatureVerifyRequestPayload",

View File

@ -0,0 +1,401 @@
# Copyright (c) 2019 The Johns Hopkins University/Applied Physics Laboratory
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import six
from kmip.core import enums
from kmip.core import exceptions
from kmip.core import objects
from kmip.core import primitives
from kmip.core import utils
from kmip.core.messages.payloads import base
class SetAttributeRequestPayload(base.RequestPayload):
"""
A request payload for the SetAttribute operation.
Attributes:
unique_identifier: The unique ID of the object on which attribute
deletion should be performed.
new_attribute: The attribute to set on the specified object.
"""
def __init__(self,
unique_identifier=None,
attribute=None,
new_attribute=None):
"""
Construct a SetAttribute request payload.
Args:
unique_identifier (string): The unique ID of the object on which
attribute deletion should be performed. Optional, defaults to
None.
new_attribute (struct): A Primitive object (e.g., Enumeration,
TextString, etc) representing the value of the attribute to
set on the specified object. Optional, defaults to None.
Required for read/write.
"""
super(SetAttributeRequestPayload, self).__init__()
self._unique_identifier = None
self._new_attribute = None
self.unique_identifier = unique_identifier
self.new_attribute = new_attribute
@property
def unique_identifier(self):
if self._unique_identifier:
return self._unique_identifier.value
return None
@unique_identifier.setter
def unique_identifier(self, value):
if value is None:
self._unique_identifier = None
elif isinstance(value, six.string_types):
self._unique_identifier = primitives.TextString(
value=value,
tag=enums.Tags.UNIQUE_IDENTIFIER
)
else:
raise TypeError("The unique identifier must be a string.")
@property
def new_attribute(self):
if self._new_attribute:
return self._new_attribute
return None
@new_attribute.setter
def new_attribute(self, value):
if value is None:
self._new_attribute = None
elif isinstance(value, objects.NewAttribute):
self._new_attribute = value
else:
raise TypeError(
"The new attribute must be a NewAttribute object."
)
def read(self, input_buffer, kmip_version=enums.KMIPVersion.KMIP_2_0):
"""
Read the data encoding the SetAttribute request payload and decode
it into its constituent part.
Args:
input_buffer (stream): A data stream containing encoded object
data, supporting a read method; usually a BytearrayStream
object.
kmip_version (KMIPVersion): An enumeration defining the KMIP
version with which the object will be decoded. Optional,
defaults to KMIP 1.0.
Raises:
VersionNotSupported: Raised when a KMIP version is provided that
does not support the SetAttribute operation.
InvalidKmipEncoding: Raised if fields are missing from the
encoding.
"""
if kmip_version < enums.KMIPVersion.KMIP_2_0:
raise exceptions.VersionNotSupported(
"KMIP {} does not support the SetAttribute operation.".format(
kmip_version.value
)
)
super(SetAttributeRequestPayload, self).read(
input_buffer,
kmip_version=kmip_version
)
local_buffer = utils.BytearrayStream(input_buffer.read(self.length))
if self.is_tag_next(enums.Tags.UNIQUE_IDENTIFIER, local_buffer):
self._unique_identifier = primitives.TextString(
tag=enums.Tags.UNIQUE_IDENTIFIER
)
self._unique_identifier.read(
local_buffer,
kmip_version=kmip_version
)
else:
self._unique_identifier = None
if self.is_tag_next(enums.Tags.NEW_ATTRIBUTE, local_buffer):
self._new_attribute = objects.NewAttribute()
self._new_attribute.read(
local_buffer,
kmip_version=kmip_version
)
else:
raise exceptions.InvalidKmipEncoding(
"The SetAttribute request payload encoding is missing the new "
"attribute field."
)
self.is_oversized(local_buffer)
def write(self, output_buffer, kmip_version=enums.KMIPVersion.KMIP_2_0):
"""
Write the data encoding the SetAttribute request payload to a
stream.
Args:
output_buffer (stream): A data stream in which to encode object
data, supporting a write method; usually a BytearrayStream
object.
kmip_version (KMIPVersion): An enumeration defining the KMIP
version with which the object will be encoded. Optional,
defaults to KMIP 1.0.
Raises:
VersionNotSupported: Raised when a KMIP version is provided that
does not support the SetAttribute operation.
InvalidField: Raised if a required field is missing from the
payload object.
"""
if kmip_version < enums.KMIPVersion.KMIP_2_0:
raise exceptions.VersionNotSupported(
"KMIP {} does not support the SetAttribute operation.".format(
kmip_version.value
)
)
local_buffer = utils.BytearrayStream()
if self._unique_identifier:
self._unique_identifier.write(
local_buffer,
kmip_version=kmip_version
)
if self._new_attribute:
self._new_attribute.write(
local_buffer,
kmip_version=kmip_version
)
else:
raise exceptions.InvalidField(
"The SetAttribute request payload is missing the new "
"attribute field."
)
self.length = local_buffer.length()
super(SetAttributeRequestPayload, self).write(
output_buffer,
kmip_version=kmip_version
)
output_buffer.write(local_buffer.buffer)
def __repr__(self):
args = [
"unique_identifier='{}'".format(self.unique_identifier),
"new_attribute={}".format(
repr(self.new_attribute) if self.new_attribute else None
)
]
return "SetAttributeRequestPayload({})".format(", ".join(args))
def __str__(self):
return str(
{
"unique_identifier": self.unique_identifier,
"new_attribute": str(
self.new_attribute
) if self.new_attribute else None
}
)
def __eq__(self, other):
if isinstance(other, SetAttributeRequestPayload):
if self.unique_identifier != other.unique_identifier:
return False
elif self.new_attribute != other.new_attribute:
return False
else:
return True
else:
return NotImplemented
def __ne__(self, other):
if isinstance(other, SetAttributeRequestPayload):
return not self.__eq__(other)
else:
return NotImplemented
class SetAttributeResponsePayload(base.ResponsePayload):
"""
A response payload for the SetAttribute operation.
Attributes:
unique_identifier: The unique ID of the object on which the attribute
was set.
"""
def __init__(self, unique_identifier=None):
"""
Construct a SetAttribute response payload.
Args:
unique_identifier (string): The unique ID of the object on
which the attribute was set. Defaults to None. Required for
read/write.
"""
super(SetAttributeResponsePayload, self).__init__()
self._unique_identifier = None
self.unique_identifier = unique_identifier
@property
def unique_identifier(self):
if self._unique_identifier:
return self._unique_identifier.value
return None
@unique_identifier.setter
def unique_identifier(self, value):
if value is None:
self._unique_identifier = None
elif isinstance(value, six.string_types):
self._unique_identifier = primitives.TextString(
value=value,
tag=enums.Tags.UNIQUE_IDENTIFIER
)
else:
raise TypeError("The unique identifier must be a string.")
def read(self, input_buffer, kmip_version=enums.KMIPVersion.KMIP_2_0):
"""
Read the data encoding the SetAttribute response payload and decode
it into its constituent parts.
Args:
input_buffer (stream): A data stream containing encoded object
data, supporting a read method; usually a BytearrayStream
object.
kmip_version (enum): A KMIPVersion enumeration defining the KMIP
version with which the object will be decoded. Optional,
defaults to KMIP 1.0.
Raises:
VersionNotSupported: Raised when a KMIP version is provided that
does not support the SetAttribute operation.
InvalidKmipEncoding: Raised if any required fields are missing
from the encoding.
"""
if kmip_version < enums.KMIPVersion.KMIP_2_0:
raise exceptions.VersionNotSupported(
"KMIP {} does not support the SetAttribute operation.".format(
kmip_version.value
)
)
super(SetAttributeResponsePayload, self).read(
input_buffer,
kmip_version=kmip_version
)
local_buffer = utils.BytearrayStream(input_buffer.read(self.length))
if self.is_tag_next(enums.Tags.UNIQUE_IDENTIFIER, local_buffer):
self._unique_identifier = primitives.TextString(
tag=enums.Tags.UNIQUE_IDENTIFIER
)
self._unique_identifier.read(
local_buffer,
kmip_version=kmip_version
)
else:
raise exceptions.InvalidKmipEncoding(
"The SetAttribute response payload encoding is missing the "
"unique identifier field."
)
self.is_oversized(local_buffer)
def write(self, output_buffer, kmip_version=enums.KMIPVersion.KMIP_2_0):
"""
Write the data encoding the SetAttribute response payload to a
buffer.
Args:
output_buffer (buffer): A data buffer in which to encode object
data, supporting a write method; usually a BytearrayStream
object.
kmip_version (enum): A KMIPVersion enumeration defining the KMIP
version with which the object will be encoded. Optional,
defaults to KMIP 1.0.
Raises:
VersionNotSupported: Raised when a KMIP version is provided that
does not support the SetAttribute operation.
InvalidField: Raised if a required field is missing from the
payload object.
"""
if kmip_version < enums.KMIPVersion.KMIP_2_0:
raise exceptions.VersionNotSupported(
"KMIP {} does not support the SetAttribute operation.".format(
kmip_version.value
)
)
local_buffer = utils.BytearrayStream()
if self._unique_identifier:
self._unique_identifier.write(
local_buffer,
kmip_version=kmip_version
)
else:
raise exceptions.InvalidField(
"The SetAttribute response payload is missing the unique "
"identifier field."
)
self.length = local_buffer.length()
super(SetAttributeResponsePayload, self).write(
output_buffer,
kmip_version=kmip_version
)
output_buffer.write(local_buffer.buffer)
def __repr__(self):
args = [
"unique_identifier='{}'".format(self.unique_identifier)
]
return "SetAttributeResponsePayload({})".format(", ".join(args))
def __str__(self):
return str(
{
"unique_identifier": self.unique_identifier
}
)
def __eq__(self, other):
if isinstance(other, SetAttributeResponsePayload):
if self.unique_identifier != other.unique_identifier:
return False
else:
return True
return NotImplemented
def __ne__(self, other):
if isinstance(other, SetAttributeResponsePayload):
return not self.__eq__(other)
return NotImplemented

View File

@ -0,0 +1,645 @@
# Copyright (c) 2019 The Johns Hopkins University/Applied Physics Laboratory
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import testtools
from kmip.core import enums
from kmip.core import exceptions
from kmip.core import objects
from kmip.core import primitives
from kmip.core import utils
from kmip.core.messages import payloads
class TestSetAttributeRequestPayload(testtools.TestCase):
"""
A unit test suite for the SetAttribute request payload.
"""
def setUp(self):
super(TestSetAttributeRequestPayload, self).setUp()
# This encoding was adapted from test case 3.1.4-7 from the KMIP 1.1
# test suite. It was modified to reflect the new SetAttribute operation
# in KMIP 2.0. The new attribute was manually added.
#
# This encoding matches the following set of values.
# Request Payload
# Unique Identifier - b4faee10-aa2a-4446-8ad4-0881f3422959
# New Attribute
# Cryptographic Algorithm - AES
self.full_encoding = utils.BytearrayStream(
b'\x42\x00\x79\x01\x00\x00\x00\x48'
b'\x42\x00\x94\x07\x00\x00\x00\x24'
b'\x62\x34\x66\x61\x65\x65\x31\x30\x2D\x61\x61\x32\x61\x2D\x34\x34'
b'\x34\x36\x2D\x38\x61\x64\x34\x2D\x30\x38\x38\x31\x66\x33\x34\x32'
b'\x32\x39\x35\x39\x00\x00\x00\x00'
b'\x42\x01\x3D\x01\x00\x00\x00\x10'
b'\x42\x00\x28\x05\x00\x00\x00\x04\x00\x00\x00\x03\x00\x00\x00\x00'
)
# This encoding was adapted from test case 3.1.4-7 from the KMIP 1.1
# test suite. It was modified to reflect the new SetAttribute operation
# in KMIP 2.0. The new attribute was manually added and the unique
# identifier was removed.
#
# This encoding matches the following set of values.
# Request Payload
# New Attribute
# Cryptographic Algorithm - AES
self.no_unique_identifier_encoding = utils.BytearrayStream(
b'\x42\x00\x79\x01\x00\x00\x00\x18'
b'\x42\x01\x3D\x01\x00\x00\x00\x10'
b'\x42\x00\x28\x05\x00\x00\x00\x04\x00\x00\x00\x03\x00\x00\x00\x00'
)
self.empty_encoding = utils.BytearrayStream(
b'\x42\x00\x79\x01\x00\x00\x00\x00'
)
def tearDown(self):
super(TestSetAttributeRequestPayload, self).tearDown()
def test_invalid_unique_identifier(self):
"""
Test that a TypeError is raised when an invalid value is used to set
the unique identifier of a SetAttribute request payload.
"""
kwargs = {"unique_identifier": 0}
self.assertRaisesRegex(
TypeError,
"The unique identifier must be a string.",
payloads.SetAttributeRequestPayload,
**kwargs
)
args = (
payloads.SetAttributeRequestPayload(),
"unique_identifier",
0
)
self.assertRaisesRegex(
TypeError,
"The unique identifier must be a string.",
setattr,
*args
)
def test_invalid_new_attribute(self):
"""
Test that a TypeError is raised when an invalid value is used to set
the new attribute of a SetAttribute request payload.
"""
kwargs = {"new_attribute": "invalid"}
self.assertRaisesRegex(
TypeError,
"The new attribute must be a NewAttribute object.",
payloads.SetAttributeRequestPayload,
**kwargs
)
args = (
payloads.SetAttributeRequestPayload(),
"new_attribute",
"invalid"
)
self.assertRaisesRegex(
TypeError,
"The new attribute must be a NewAttribute object.",
setattr,
*args
)
def test_read(self):
"""
Test that a SetAttribute request payload can be read from a buffer.
"""
payload = payloads.SetAttributeRequestPayload()
self.assertIsNone(payload.unique_identifier)
self.assertIsNone(payload.new_attribute)
payload.read(self.full_encoding)
self.assertEqual(
"b4faee10-aa2a-4446-8ad4-0881f3422959",
payload.unique_identifier
)
self.assertEqual(
objects.NewAttribute(
attribute=primitives.Enumeration(
enums.CryptographicAlgorithm,
enums.CryptographicAlgorithm.AES,
enums.Tags.CRYPTOGRAPHIC_ALGORITHM
)
),
payload.new_attribute
)
def test_read_no_unique_identifier(self):
"""
Test that a SetAttribute request payload can be read from a buffer
even when the encoding is missing the unique identifier field.
"""
payload = payloads.SetAttributeRequestPayload()
self.assertIsNone(payload.unique_identifier)
self.assertIsNone(payload.new_attribute)
payload.read(self.no_unique_identifier_encoding)
self.assertIsNone(payload.unique_identifier)
self.assertEqual(
objects.NewAttribute(
attribute=primitives.Enumeration(
enums.CryptographicAlgorithm,
enums.CryptographicAlgorithm.AES,
enums.Tags.CRYPTOGRAPHIC_ALGORITHM
)
),
payload.new_attribute
)
def test_read_no_new_attribute(self):
"""
Test that an InvalidKmipEncoding error is raised when an invalid
encoding containing no encoded new attribute is used to decode
a SetAttribute request payload.
"""
payload = payloads.SetAttributeRequestPayload()
args = (self.empty_encoding, )
self.assertRaisesRegex(
exceptions.InvalidKmipEncoding,
"The SetAttribute request payload encoding is missing the "
"new attribute field.",
payload.read,
*args
)
def test_read_invalid_kmip_version(self):
"""
Test that a VersionNotSupported error is raised when an unsupported
version of KMIP is used to decode the SetAttribute request payload.
"""
payload = payloads.SetAttributeRequestPayload()
args = (self.empty_encoding, )
kwargs = {"kmip_version": enums.KMIPVersion.KMIP_1_0}
self.assertRaisesRegex(
exceptions.VersionNotSupported,
"KMIP 1.0 does not support the SetAttribute operation.",
payload.read,
*args,
**kwargs
)
def test_write(self):
"""
Test that a SetAttribute request payload can be written to a buffer.
"""
payload = payloads.SetAttributeRequestPayload(
unique_identifier="b4faee10-aa2a-4446-8ad4-0881f3422959",
new_attribute=objects.NewAttribute(
attribute=primitives.Enumeration(
enums.CryptographicAlgorithm,
enums.CryptographicAlgorithm.AES,
enums.Tags.CRYPTOGRAPHIC_ALGORITHM
)
)
)
buffer = utils.BytearrayStream()
payload.write(buffer)
self.assertEqual(len(self.full_encoding), len(buffer))
self.assertEqual(str(self.full_encoding), str(buffer))
def test_write_no_unique_identifier(self):
"""
Test that a SetAttribute request payload can be written to a buffer
without the unique identifier field.
"""
payload = payloads.SetAttributeRequestPayload(
new_attribute=objects.NewAttribute(
attribute=primitives.Enumeration(
enums.CryptographicAlgorithm,
enums.CryptographicAlgorithm.AES,
enums.Tags.CRYPTOGRAPHIC_ALGORITHM
)
)
)
buffer = utils.BytearrayStream()
payload.write(buffer)
self.assertEqual(len(self.no_unique_identifier_encoding), len(buffer))
self.assertEqual(str(self.no_unique_identifier_encoding), str(buffer))
def test_write_no_new_attribute(self):
"""
Test that an InvalidField error is raised when attempting to write
a SetAttribute request payload to a buffer with no new attribute
field specified.
"""
payload = payloads.SetAttributeRequestPayload()
args = (utils.BytearrayStream(), )
self.assertRaisesRegex(
exceptions.InvalidField,
"The SetAttribute request payload is missing the new attribute "
"field.",
payload.write,
*args
)
def test_write_invalid_kmip_version(self):
"""
Test that a VersionNotSupported error is raised when an unsupported
version of KMIP is used to encode the SetAttribute request payload.
"""
payload = payloads.SetAttributeRequestPayload()
args = (utils.BytearrayStream(), )
kwargs = {"kmip_version": enums.KMIPVersion.KMIP_1_0}
self.assertRaisesRegex(
exceptions.VersionNotSupported,
"KMIP 1.0 does not support the SetAttribute operation.",
payload.write,
*args,
**kwargs
)
def test_repr(self):
"""
Test that repr can be applied to a SetAttribute request payload.
"""
payload = payloads.SetAttributeRequestPayload(
unique_identifier="b4faee10-aa2a-4446-8ad4-0881f3422959",
new_attribute=None
)
args = [
"unique_identifier='b4faee10-aa2a-4446-8ad4-0881f3422959'",
"new_attribute=None"
]
self.assertEqual(
"SetAttributeRequestPayload({})".format(", ".join(args)),
repr(payload)
)
def test_str(self):
"""
Test that str can be applied to a SetAttribute request payload.
"""
payload = payloads.SetAttributeRequestPayload(
unique_identifier="b4faee10-aa2a-4446-8ad4-0881f3422959",
new_attribute=None
)
s = str(
{
"unique_identifier": "b4faee10-aa2a-4446-8ad4-0881f3422959",
"new_attribute": None
}
)
self.assertEqual(s, str(payload))
def test_comparison(self):
"""
Test that the equality/inequality operators return True/False when
comparing two SetAttribute request payloads with the same data.
"""
a = payloads.SetAttributeRequestPayload()
b = payloads.SetAttributeRequestPayload()
self.assertTrue(a == b)
self.assertTrue(b == a)
self.assertFalse(a != b)
self.assertFalse(b != a)
a = payloads.SetAttributeRequestPayload(
unique_identifier="b4faee10-aa2a-4446-8ad4-0881f3422959",
new_attribute=objects.NewAttribute(
attribute=primitives.Enumeration(
enums.CryptographicAlgorithm,
enums.CryptographicAlgorithm.AES,
enums.Tags.CRYPTOGRAPHIC_ALGORITHM
)
)
)
b = payloads.SetAttributeRequestPayload(
unique_identifier="b4faee10-aa2a-4446-8ad4-0881f3422959",
new_attribute=objects.NewAttribute(
attribute=primitives.Enumeration(
enums.CryptographicAlgorithm,
enums.CryptographicAlgorithm.AES,
enums.Tags.CRYPTOGRAPHIC_ALGORITHM
)
)
)
self.assertTrue(a == b)
self.assertTrue(b == a)
self.assertFalse(a != b)
self.assertFalse(b != a)
def test_comparison_on_different_unique_identifiers(self):
"""
Test that the equality/inequality operators return False/True when
comparing two SetAttribute request payloads with different unique
identifiers.
"""
a = payloads.SetAttributeRequestPayload(unique_identifier="1")
b = payloads.SetAttributeRequestPayload(unique_identifier="2")
self.assertFalse(a == b)
self.assertFalse(b == a)
self.assertTrue(a != b)
self.assertTrue(b != a)
def test_comparison_on_different_new_attributes(self):
"""
Test that the equality/inequality operators return False/True when
comparing two SetAttribute request payloads with different new
attributes.
"""
a = payloads.SetAttributeRequestPayload(
new_attribute=objects.NewAttribute(
attribute=primitives.Enumeration(
enums.CryptographicAlgorithm,
enums.CryptographicAlgorithm.AES,
enums.Tags.CRYPTOGRAPHIC_ALGORITHM
)
)
)
b = payloads.SetAttributeRequestPayload(
new_attribute=objects.NewAttribute(
attribute=primitives.Integer(
128,
enums.Tags.CRYPTOGRAPHIC_LENGTH
)
)
)
self.assertFalse(a == b)
self.assertFalse(b == a)
self.assertTrue(a != b)
self.assertTrue(b != a)
def test_comparison_on_type_mismatch(self):
"""
Test that the equality/inequality operators return False/True when
comparining a SetAttribute request payload against a different type.
"""
a = payloads.SetAttributeRequestPayload()
b = "invalid"
self.assertFalse(a == b)
self.assertFalse(b == a)
self.assertTrue(a != b)
self.assertTrue(b != a)
class TestSetAttributeResponsePayload(testtools.TestCase):
"""
A unit test suite for the SetAttribute response payload.
"""
def setUp(self):
super(TestSetAttributeResponsePayload, self).setUp()
# This encoding was adapted from test case 3.1.4-7 from the KMIP 1.1
# test suite.
#
# This encoding matches the following set of values:
# Response Payload
# Unique Identifier - b4faee10-aa2a-4446-8ad4-0881f3422959
self.full_encoding = utils.BytearrayStream(
b'\x42\x00\x7C\x01\x00\x00\x00\x30'
b'\x42\x00\x94\x07\x00\x00\x00\x24'
b'\x62\x34\x66\x61\x65\x65\x31\x30\x2D\x61\x61\x32\x61\x2D\x34\x34'
b'\x34\x36\x2D\x38\x61\x64\x34\x2D\x30\x38\x38\x31\x66\x33\x34\x32'
b'\x32\x39\x35\x39\x00\x00\x00\x00'
)
self.empty_encoding = utils.BytearrayStream(
b'\x42\x00\x7C\x01\x00\x00\x00\x00'
)
def tearDown(self):
super(TestSetAttributeResponsePayload, self).tearDown()
def test_invalid_unique_identifier(self):
"""
Test that a TypeError is raised when an invalid value is used to set
the unique identifier of a SetAttribute response payload.
"""
kwargs = {"unique_identifier": 0}
self.assertRaisesRegex(
TypeError,
"The unique identifier must be a string.",
payloads.SetAttributeResponsePayload,
**kwargs
)
args = (
payloads.SetAttributeResponsePayload(),
"unique_identifier",
0
)
self.assertRaisesRegex(
TypeError,
"The unique identifier must be a string.",
setattr,
*args
)
def test_read(self):
"""
Test that a SetAttribute response payload can be read from a buffer.
"""
payload = payloads.SetAttributeResponsePayload()
self.assertIsNone(payload.unique_identifier)
payload.read(self.full_encoding)
self.assertEqual(
"b4faee10-aa2a-4446-8ad4-0881f3422959",
payload.unique_identifier
)
def test_read_no_unique_identifier(self):
"""
Test that an InvalidKmipEncoding error is raised when an invalid
encoding containing no encoded unique identifier is used to decode
a SetAttribute response payload.
"""
payload = payloads.SetAttributeResponsePayload()
args = (self.empty_encoding, )
self.assertRaisesRegex(
exceptions.InvalidKmipEncoding,
"The SetAttribute response payload encoding is missing the "
"unique identifier field.",
payload.read,
*args
)
def test_read_invalid_kmip_version(self):
"""
Test that a VersionNotSupported error is raised when an unsupported
version of KMIP is used to decode the SetAttribute response payload.
"""
payload = payloads.SetAttributeResponsePayload()
args = (self.empty_encoding, )
kwargs = {"kmip_version": enums.KMIPVersion.KMIP_1_0}
self.assertRaisesRegex(
exceptions.VersionNotSupported,
"KMIP 1.0 does not support the SetAttribute operation.",
payload.read,
*args,
**kwargs
)
def test_write(self):
"""
Test that a SetAttribute response payload can be written to a
buffer.
"""
payload = payloads.SetAttributeResponsePayload(
unique_identifier="b4faee10-aa2a-4446-8ad4-0881f3422959"
)
buffer = utils.BytearrayStream()
payload.write(buffer)
self.assertEqual(len(self.full_encoding), len(buffer))
self.assertEqual(str(self.full_encoding), str(buffer))
def test_write_no_unique_identifier(self):
"""
Test that an InvalidField error is raised when attempting to write
a SetAttribute response payload to a buffer with no unique
identifier field specified.
"""
payload = payloads.SetAttributeResponsePayload()
args = (utils.BytearrayStream(), )
self.assertRaisesRegex(
exceptions.InvalidField,
"The SetAttribute response payload is missing the unique "
"identifier field.",
payload.write,
*args
)
def test_write_invalid_kmip_version(self):
"""
Test that a VersionNotSupported error is raised when an unsupported
version of KMIP is used to encode the SetAttribute response payload.
"""
payload = payloads.SetAttributeResponsePayload()
args = (utils.BytearrayStream(), )
kwargs = {"kmip_version": enums.KMIPVersion.KMIP_1_0}
self.assertRaisesRegex(
exceptions.VersionNotSupported,
"KMIP 1.0 does not support the SetAttribute operation.",
payload.write,
*args,
**kwargs
)
def test_repr(self):
"""
Test that repr can be applied to a SetAttribute response payload.
"""
payload = payloads.SetAttributeResponsePayload(
unique_identifier="b4faee10-aa2a-4446-8ad4-0881f3422959"
)
args = [
"unique_identifier='b4faee10-aa2a-4446-8ad4-0881f3422959'"
]
self.assertEqual(
"SetAttributeResponsePayload({})".format(", ".join(args)),
repr(payload)
)
def test_str(self):
"""
Test that str can be applied to a SetAttribute response payload.
"""
payload = payloads.SetAttributeResponsePayload(
unique_identifier="b4faee10-aa2a-4446-8ad4-0881f3422959"
)
s = str(
{
"unique_identifier": "b4faee10-aa2a-4446-8ad4-0881f3422959"
}
)
self.assertEqual(s, str(payload))
def test_comparison(self):
"""
Test that the equality/inequality operators return True/False when
comparing two SetAttribute response payloads with the same data.
"""
a = payloads.SetAttributeResponsePayload()
b = payloads.SetAttributeResponsePayload()
self.assertTrue(a == b)
self.assertTrue(b == a)
self.assertFalse(a != b)
self.assertFalse(b != a)
a = payloads.SetAttributeResponsePayload(
unique_identifier="b4faee10-aa2a-4446-8ad4-0881f3422959"
)
b = payloads.SetAttributeResponsePayload(
unique_identifier="b4faee10-aa2a-4446-8ad4-0881f3422959"
)
self.assertTrue(a == b)
self.assertTrue(b == a)
self.assertFalse(a != b)
self.assertFalse(b != a)
def test_comparison_on_different_unique_identifiers(self):
"""
Test that the equality/inequality operators return False/True when
comparing two SetAttribute response payloads with different unique
identifiers.
"""
a = payloads.SetAttributeResponsePayload(unique_identifier="1")
b = payloads.SetAttributeResponsePayload(unique_identifier="2")
self.assertFalse(a == b)
self.assertFalse(b == a)
self.assertTrue(a != b)
self.assertTrue(b != a)
def test_comparison_on_type_mismatch(self):
"""
Test that the equality/inequality operators return False/True when
comparining a SetAttribute response payload against a different
type.
"""
a = payloads.SetAttributeResponsePayload()
b = "invalid"
self.assertFalse(a == b)
self.assertFalse(b == a)
self.assertTrue(a != b)
self.assertTrue(b != a)