tyler.durden
/
PyKMIP
mirror of https://github.com/OpenKMIP/PyKMIP.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix tests to pass with SQLAlchemy>=1.4.0 

I'm not *entirely* sure what's going on here, but it seems that when we
do something like

    obj = OpaqueObject(...)
    Session = sessionmaker(...)
    session = Session()
    ...
    session.add(obj)
    session.commit()

the primary key (and maybe some foreign relations?) aren't automatically
populated on `obj` following the commit, and will attempt to lazy-load
on next reference. Since expire_on_commit defaults to True, the session
attached to `obj` (which is no longer the `session` in locals!) is closed
out when we later do

    session = Session()
    get_obj = session.query(OpaqueObject).filter(
        ManagedObject.unique_identifier == obj.unique_identifier).one()

leading to a DetachedInstanceError.

There seem to be a few different ways we can fix this:

* Set expire_on_commit=False so the old session is still useful for the
  lazy-loading.
* Re-use the same session instead of creating a new one.
* Explicitly refresh added objects post-commit.

Generally prefer the first one; there's some prior art to follow in
services/server/test_engine.py. Curiously, that same file runs into
trouble despite already setting expire_on_commit=False -- so do the
explicit refresh, on the assumption that there was a reason we went to
the trouble of creating a fresh session.

Closes #649
This commit is contained in:
Tim Burke 2021-09-21 18:16:09 -07:00 committed by Peter Hamilton
parent 6c2bc6b3d5
commit c0c9803956
8 changed files with 47 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
kmip/tests/unit/pie/objects/test_opaque_object.py
View File

@ -224,7 +224,7 @@ class TestOpaqueObject(testtools.TestCase):
test_name = 'bowser'
obj = OpaqueObject(
self.bytes_a, enums.OpaqueDataType.NONE, name=test_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -259,7 +259,7 @@ class TestOpaqueObject(testtools.TestCase):
expected_mo_names.append(sqltypes.ManagedObjectName(name, i))
self.assertEquals(expected_mo_names, obj._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -295,7 +295,7 @@ class TestOpaqueObject(testtools.TestCase):
self.assertEquals(expected_names, obj.names)
self.assertEquals(expected_mo_names, obj._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -334,7 +334,7 @@ class TestOpaqueObject(testtools.TestCase):
self.assertEquals(expected_names, obj.names)
self.assertEquals(expected_mo_names, obj._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -362,7 +362,7 @@ class TestOpaqueObject(testtools.TestCase):
first_name = 'bowser'
obj = OpaqueObject(
self.bytes_a, enums.OpaqueDataType.NONE, name=first_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -402,7 +402,7 @@ class TestOpaqueObject(testtools.TestCase):
obj.names.append(names[1])
obj.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -444,7 +444,7 @@ class TestOpaqueObject(testtools.TestCase):
obj.names.append(names[1])
obj.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()

14
kmip/tests/unit/pie/objects/test_private_key.py
View File

@ -563,7 +563,7 @@ class TestPrivateKey(testtools.TestCase):
key = PrivateKey(
enums.CryptographicAlgorithm.RSA, 2048, self.bytes_2048,
enums.KeyFormatType.PKCS_1, masks=masks, name=test_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -603,7 +603,7 @@ class TestPrivateKey(testtools.TestCase):
expected_mo_names.append(sqltypes.ManagedObjectName(name, i))
self.assertEquals(expected_mo_names, key._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -640,7 +640,7 @@ class TestPrivateKey(testtools.TestCase):
self.assertEquals(expected_names, key.names)
self.assertEquals(expected_mo_names, key._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -680,7 +680,7 @@ class TestPrivateKey(testtools.TestCase):
self.assertEquals(expected_names, key.names)
self.assertEquals(expected_mo_names, key._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -709,7 +709,7 @@ class TestPrivateKey(testtools.TestCase):
key = PrivateKey(
enums.CryptographicAlgorithm.RSA, 2048, self.bytes_2048,
enums.KeyFormatType.PKCS_1, name=first_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -750,7 +750,7 @@ class TestPrivateKey(testtools.TestCase):
key.names.append(names[1])
key.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -793,7 +793,7 @@ class TestPrivateKey(testtools.TestCase):
key.names.append(names[1])
key.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()

14
kmip/tests/unit/pie/objects/test_public_key.py
View File

@ -461,7 +461,7 @@ class TestPublicKey(testtools.TestCase):
key = PublicKey(
enums.CryptographicAlgorithm.RSA, 2048, self.bytes_2048,
enums.KeyFormatType.PKCS_1, masks=masks, name=test_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -501,7 +501,7 @@ class TestPublicKey(testtools.TestCase):
expected_mo_names.append(sqltypes.ManagedObjectName(name, i))
self.assertEquals(expected_mo_names, key._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -538,7 +538,7 @@ class TestPublicKey(testtools.TestCase):
self.assertEquals(expected_names, key.names)
self.assertEquals(expected_mo_names, key._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -578,7 +578,7 @@ class TestPublicKey(testtools.TestCase):
self.assertEquals(expected_names, key.names)
self.assertEquals(expected_mo_names, key._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -607,7 +607,7 @@ class TestPublicKey(testtools.TestCase):
key = PublicKey(
enums.CryptographicAlgorithm.RSA, 2048, self.bytes_2048,
enums.KeyFormatType.PKCS_1, name=first_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -648,7 +648,7 @@ class TestPublicKey(testtools.TestCase):
key.names.append(names[1])
key.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -691,7 +691,7 @@ class TestPublicKey(testtools.TestCase):
key.names.append(names[1])
key.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()

14
kmip/tests/unit/pie/objects/test_secret_data.py
View File

@ -243,7 +243,7 @@ class TestSecretData(testtools.TestCase):
test_name = 'bowser'
obj = SecretData(self.bytes_a, enums.SecretDataType.PASSWORD,
name=test_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -278,7 +278,7 @@ class TestSecretData(testtools.TestCase):
expected_mo_names.append(sqltypes.ManagedObjectName(name, i))
self.assertEquals(expected_mo_names, obj._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -314,7 +314,7 @@ class TestSecretData(testtools.TestCase):
self.assertEquals(expected_names, obj.names)
self.assertEquals(expected_mo_names, obj._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -353,7 +353,7 @@ class TestSecretData(testtools.TestCase):
self.assertEquals(expected_names, obj.names)
self.assertEquals(expected_mo_names, obj._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -381,7 +381,7 @@ class TestSecretData(testtools.TestCase):
first_name = 'bowser'
obj = SecretData(self.bytes_a, enums.SecretDataType.PASSWORD,
name=first_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -421,7 +421,7 @@ class TestSecretData(testtools.TestCase):
obj.names.append(names[1])
obj.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()
@ -463,7 +463,7 @@ class TestSecretData(testtools.TestCase):
obj.names.append(names[1])
obj.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(obj)
session.commit()

3
kmip/tests/unit/pie/objects/test_split_key.py
View File

@ -595,7 +595,8 @@ class TestSplitKey(testtools.TestCase):
prime_field_size=104729
)
session = sqlalchemy.orm.sessionmaker(bind=self.engine)()
session = sqlalchemy.orm.sessionmaker(
bind=self.engine, expire_on_commit=False)()
session.add(split_key)
session.commit()

14
kmip/tests/unit/pie/objects/test_symmetric_key.py
View File

@ -408,7 +408,7 @@ class TestSymmetricKey(testtools.TestCase):
enums.CryptographicAlgorithm.AES, 128, self.bytes_128a,
masks=masks,
name=test_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -448,7 +448,7 @@ class TestSymmetricKey(testtools.TestCase):
expected_mo_names.append(sqltypes.ManagedObjectName(name, i))
self.assertEquals(expected_mo_names, key._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -485,7 +485,7 @@ class TestSymmetricKey(testtools.TestCase):
self.assertEquals(expected_names, key.names)
self.assertEquals(expected_mo_names, key._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -525,7 +525,7 @@ class TestSymmetricKey(testtools.TestCase):
self.assertEquals(expected_names, key.names)
self.assertEquals(expected_mo_names, key._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -554,7 +554,7 @@ class TestSymmetricKey(testtools.TestCase):
key = SymmetricKey(
enums.CryptographicAlgorithm.AES, 128, self.bytes_128a,
name=first_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -595,7 +595,7 @@ class TestSymmetricKey(testtools.TestCase):
key.names.append(names[1])
key.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()
@ -638,7 +638,7 @@ class TestSymmetricKey(testtools.TestCase):
key.names.append(names[1])
key.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(key)
session.commit()

14
kmip/tests/unit/pie/objects/test_x509_certificate.py
View File

@ -320,7 +320,7 @@ class TestX509Certificate(testtools.TestCase):
masks = [enums.CryptographicUsageMask.ENCRYPT,
enums.CryptographicUsageMask.WRAP_KEY]
cert = X509Certificate(self.bytes_a, masks=masks, name=test_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(cert)
session.commit()
@ -354,7 +354,7 @@ class TestX509Certificate(testtools.TestCase):
expected_mo_names.append(sqltypes.ManagedObjectName(name, i))
self.assertEquals(expected_mo_names, cert._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(cert)
session.commit()
@ -389,7 +389,7 @@ class TestX509Certificate(testtools.TestCase):
self.assertEquals(expected_names, cert.names)
self.assertEquals(expected_mo_names, cert._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(cert)
session.commit()
@ -427,7 +427,7 @@ class TestX509Certificate(testtools.TestCase):
self.assertEquals(expected_names, cert.names)
self.assertEquals(expected_mo_names, cert._names)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(cert)
session.commit()
@ -454,7 +454,7 @@ class TestX509Certificate(testtools.TestCase):
"""
first_name = 'bowser'
cert = X509Certificate(self.bytes_a, name=first_name)
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(cert)
session.commit()
@ -493,7 +493,7 @@ class TestX509Certificate(testtools.TestCase):
cert.names.append(names[1])
cert.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(cert)
session.commit()
@ -534,7 +534,7 @@ class TestX509Certificate(testtools.TestCase):
cert.names.append(names[1])
cert.names.append(names[2])
Session = sessionmaker(bind=self.engine)
Session = sessionmaker(bind=self.engine, expire_on_commit=False)
session = Session()
session.add(cert)
session.commit()

3
kmip/tests/unit/services/server/test_engine.py
View File

@ -1386,6 +1386,7 @@ class TestKmipEngine(testtools.TestCase):
e._data_session.add(certificate)
e._data_session.add(opaque_object)
e._data_session.commit()
e._data_session.refresh(symmetric_key)
e._data_session = e._data_store_session_factory()
result = e._get_attribute_from_managed_object(
@ -1660,6 +1661,7 @@ class TestKmipEngine(testtools.TestCase):
e._data_session.add(symmetric_key)
e._data_session.add(certificate)
e._data_session.commit()
e._data_session.refresh(symmetric_key)
e._data_session = e._data_store_session_factory()
e._set_attribute_on_managed_object(
@ -2302,6 +2304,7 @@ class TestKmipEngine(testtools.TestCase):
e._data_session.add(symmetric_key)
e._data_session.commit()
e._data_session.refresh(symmetric_key)
e._data_session = e._data_store_session_factory()
e._set_attribute_on_managed_object(