def test_unresolvable_entries_dont_get_included(self):
client = Client(
'011npgaszg5o',
'42c9d93410a7319e9a735671fc1e415348f65e94a99fc768b70a7c649859d4fd')
entry = client.entry('1HR1QvURo4MoSqO0eqmUeO')
self.assertEqual(len(entry.modules), 2)
def test_client_entries(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False)
entries = client.entries()
self.assertEqual(str(entries[0]), "<Entry[cat] id='happycat'>")
def test_entry_incoming_references_with_query(self):
client = Client('cfexampleapi', 'b4c0n73n7fu1', content_type_cache=False)
entry = client.entry('nyancat')
entries = entry.incoming_references(client, {'content_type': 'cat', 'select': ['fields.name']})
self.assertEqual(len(entries), 1)
self.assertEqual(str(entries[0]), "<Entry[cat] id='happycat'>")
self.assertEqual(entries[0].fields(), {'name': 'Happy Cat'})
def test_client_entries_links_to_asset(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False)
entries = client.entries({'links_to_asset': 'nyancat'})
self.assertEqual(len(entries), 1)
self.assertEqual(str(entries[0]), "<Entry[cat] id='nyancat'>")
def test_rich_text_field_with_embeds_in_lists(self):
client = Client(
'jd7yc4wnatx3',
'6256b8ef7d66805ca41f2728271daf27e8fa6055873b802a813941a0fe696248',
gzip_encoded=False
)
entry = client.entry('6NGLswCREsGA28kGouScyY')
# Hyperlink data is conserved
self.assertEqual(entry.body['content'][0], {
'data': {},
'content': [
{'marks': [], 'value': 'A link to ', 'nodeType': 'text', 'nodeClass': 'text'},
{
'data': {'uri': 'https://google.com'},
'content': [{'marks': [], 'value': 'google', 'nodeType': 'text', 'nodeClass': 'text'}],
'nodeType': 'hyperlink',
'nodeClass': 'inline'
},
{'marks': [], 'value': '', 'nodeType': 'text', 'nodeClass': 'text'}
],
'nodeType': 'paragraph',
'nodeClass': 'block'
})
# Unordered lists and ordered lists can contain embedded entries
self.assertEqual(entry.body['content'][3]['nodeType'], 'unordered-list')
self.assertEqual(str(entry.body['content'][3]['content'][2]['content'][0]['data']['target']), "<Entry[embedded] id='49rofLvvxCOiIMIi6mk8ai'>")
self.assertEqual(entry.body['content'][4]['nodeType'], 'ordered-list')
self.assertEqual(str(entry.body['content'][4]['content'][2]['content'][0]['data']['target']), "<Entry[embedded] id='5ZF9Q4K6iWSYIU2OUs0UaQ'>")
def test_entries_dont_fail_with_unicode_characters(self):
client = Client(
'wltm0euukdog',
'bbe871957bb60f988af6cbeeccbb178c36cae09e36e8098357e27b51dd38d88e',
content_type_cache=True)
entries = client.entries()
self.assertEqual(entries[0].name, '😅')
def test_circular_references_default_depth(self):
client = Client('rk19fq93y3vw', '821aa502a7ce820e46adb30fa6942889619aac4342a7021cfe15197c52a593cc', content_type_cache=True)
a = client.entry('6kdfS7uMs8owuEIoSaOcQk')
self.assertEqual(str(a), "<Entry[a] id='6kdfS7uMs8owuEIoSaOcQk'>")
self.assertEqual(str(a.b), "<Entry[b] id='7oADpDPuneEAsWUiO2CmEo'>")
self.assertEqual(str(a.b.a.b.a.b.a.b.a.b.a.b.a.b.a.b.a.b.a.b.a), "<Entry[a] id='6kdfS7uMs8owuEIoSaOcQk'>")
self.assertEqual(str(a.b.a.b.a.b.a.b.a.b.a.b.a.b.a.b.a.b.a.b.a.b), "<Link[Entry] id='7oADpDPuneEAsWUiO2CmEo'>")
def test_client_get_content_type(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False)
ct = client.content_type('cat')
self.assertEqual(str(ct), "<ContentType[Cat] id='cat'>")
def test_entries_dont_fail_with_arrays_as_json_root(self):
client = Client(
'4int1zgmkwcf',
'd2ac2076019bd4a8357811cbdd5563bb7186d90d77e53c265a1bafd9f83439e8',
content_type_cache=True)
entries = client.entries()
self.assertEqual(entries[0].json, [{'foo': 'bar'}, {'baz': 'qux'}])
def test_asset_incoming_references(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False)
asset = client.asset('nyancat')
entries = asset.incoming_references(client)
self.assertEqual(len(entries), 1)
self.assertEqual(str(entries[0]), "<Entry[cat] id='nyancat'>")
def test_client_get_space(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False)
space = client.space()
self.assertEqual(str(space),
"<Space[Contentful Example API] id='cfexampleapi'>")
def test_client_get_content_types(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False)
cts = client.content_types()
self.assertEqual(str(cts[0]),
"<ContentType[City] id='1t9IbcfdCk6m04uISSsaIK'>")
def test_client_entry(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False)
entry = client.entry('nyancat')
self.assertEqual(str(entry), "<Entry[cat] id='nyancat'>")
self.assertEqual(str(entry.best_friend), "<Entry[cat] id='happycat'>")
def test_client_assets(self):
client = Client('cfexampleapi', 'b4c0n73n7fu1', content_type_cache=False)
assets = client.assets()
self.assertEqual(
str(assets[0]),
"<Asset id='1x0xpXu4pSGS4OukSyWGUK' url='//images.contentful.com/cfexampleapi/1x0xpXu4pSGS4OukSyWGUK/cc1239c6385428ef26f4180190532818/doge.jpg'>"
)
def test_client_asset(self):
client = Client('cfexampleapi', 'b4c0n73n7fu1', content_type_cache=False)
asset = client.asset('nyancat')
self.assertEqual(
str(asset),
"<Asset id='nyancat' url='//images.contentful.com/cfexampleapi/4gp6taAwW4CmSgumq2ekUm/9da0cd1936871b8d72343e895a00d611/Nyan_cat_250px_frame.png'>"
)
def test_client_sync_with_environments(self):
client = Client(
'a22o2qgm356c',
'bfbc63cf745a037125dbcc64f716a9a0e9d091df1a79e84920b890f87a6e7ab9',
environment='staging',
content_type_cache=False)
sync = client.sync({'initial': True})
self.assertEquals(sync.items[0].environment.id, 'staging')
def test_client_with_application_version_only_does_not_include_integration_in_header(
self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False,
application_version='0.1.0')
header = client._contentful_user_agent()
self.assertFalse('app /0.1.0;' in header)
def test_client_with_application_headers(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False,
application_name='foobar',
application_version='0.1.0')
header = client._contentful_user_agent()
self.assertTrue('app foobar/0.1.0;' in header)
def test_client_with_integration_name_only_headers(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False,
integration_name='foobar')
header = client._contentful_user_agent()
self.assertTrue('integration foobar;' in header)
self.assertFalse('integration foobar/;' in header)
def test_client_creates_wrapped_arrays(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False)
self.assertEquals(str(client.content_types()),
"<Array size='4' total='4' limit='100' skip='0'>")
self.assertEquals(str(client.entries()),
"<Array size='10' total='10' limit='100' skip='0'>")
self.assertEquals(str(client.assets()),
"<Array size='4' total='4' limit='100' skip='0'>")
def test_client_validations(self):
with self.assertRaises(ConfigurationException):
Client(None, 'foo')
with self.assertRaises(ConfigurationException):
Client('foo', None)
with self.assertRaises(ConfigurationException):
Client('foo', 'bar', api_url=None)
with self.assertRaises(ConfigurationException):
Client('foo', 'bar', default_locale=None)
with self.assertRaises(ConfigurationException):
Client('foo', 'bar', api_version=None)
def test_client_sync(self):
client = Client('cfexampleapi', 'b4c0n73n7fu1', content_type_cache=False)
sync = client.sync({'initial': True})
self.assertEqual(
str(sync),
"<SyncPage next_sync_token='{0}'>".format(
'w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1wrzCrBzCqMOpZAwOOcOvCcOAwqHDv0XCiMKaOcOxZA8BJUzDr8K-wo1lNx7DnHE'
)
)
self.assertEqual(str(sync.items[0]), "<Entry[1t9IbcfdCk6m04uISSsaIK] id='5ETMRzkl9KM4omyMwKAOki'>")
def test_rich_text_fields_should_not_get_hydrated_twice(self):
client = Client(
'fds721b88p6b',
'45ba81cc69423fcd2e3f0a4779de29481bb5c11495bc7e14649a996cf984e98e',
gzip_encoded=False)
entry = client.entry('1tBAu0wP9qAQEg6qCqMics')
# Not failing is already a success
self.assertEqual(str(entry.children[0]), str(entry.children[1]))
self.assertEqual(str(entry.children[0].body),
str(entry.children[1].body))
def test_client_entries_select(self):
client = Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False)
entries = client.entries({
'content_type': 'cat',
'sys.id': 'nyancat',
'select': ['fields.name']
})
self.assertEqual(str(entries[0]), "<Entry[cat] id='nyancat'>")
self.assertEqual(entries[0].fields(), {'name': 'Nyan Cat'})
def test_entries_with_none_values_on_all_fields(self):
client = Client('rtx5c7z0zbas', 'a6c8dc438d470c51d1094dad146a1f20fcdba41e21f4e263af6c3f70d8583634', content_type_cache=True)
entry = client.entries()[0]
self.assertEqual(entry.symbol, None)
self.assertEqual(entry.text, None)
self.assertEqual(entry.integer, None)
self.assertEqual(entry.number, None)
self.assertEqual(entry.date, None)
self.assertEqual(entry.location, None)
self.assertEqual(entry.asset, None)
self.assertEqual(entry.bool, None)
self.assertEqual(entry.json, None)
self.assertEqual(entry.link, None)
def test_client_locales_on_environment(self):
client = Client('facgnwwgj5fe',
'<ACCESS_TOKEN>',
environment='testing',
content_type_cache=False)
locales = client.locales()
self.assertEqual(str(locales),
"<Array size='3' total='3' limit='1000' skip='0'>")
self.assertEqual(
str(locales[0]),
"<Locale[U.S. English] code='en-US' default=True fallback_code=None optional=False>"
)
def test_uses_timeouts(self):
c = Client('cfexampleapi', 'b4c0n73n7fu1')
with requests_mock.mock() as m:
m.register_uri('GET', ANY, status_code=500)
self.assertRaises(HTTPError, c.entries)
self.assertEqual(m.call_count, 1)
self.assertEqual(m.request_history[0].timeout, 1)
c = Client('cfexampleapi', 'b4c0n73n7fu1', timeout_s=0.1231570235)
with requests_mock.mock() as m:
m.register_uri('GET', ANY, status_code=500)
self.assertRaises(HTTPError, c.entries)
self.assertEqual(m.call_count, 1)
self.assertEqual(m.request_history[0].timeout, c.timeout_s)
def test_client_repr(self):
self.assertEqual(
'<contentful.Client space_id="cfexampleapi" access_token="b4c0n73n7fu1" default_locale="en-US">',
str(
Client('cfexampleapi',
'b4c0n73n7fu1',
content_type_cache=False)))
def test_structured_text_field(self):
client = Client(
'jd7yc4wnatx3',
'6256b8ef7d66805ca41f2728271daf27e8fa6055873b802a813941a0fe696248')
entry = client.entry('4BupPSmi4M02m0U48AQCSM')
expected_entry_occurrances = 2
embedded_entry_index = 1
for content in entry.body['content']:
if content['nodeType'] == 'embedded-entry-block':
self.assertTrue(isinstance(content['data'], Entry))
self.assertEqual(content['data'].body,
'Embedded {0}'.format(embedded_entry_index))
expected_entry_occurrances -= 1
embedded_entry_index += 1
self.assertEqual(expected_entry_occurrances, 0)
def test_client_default_contentful_user_agent_headers(self):
client = Client('cfexampleapi', 'b4c0n73n7fu1', content_type_cache=False)
from contentful import __version__
import platform
expected = [
'sdk contentful.py/{0};'.format(__version__),
'platform python/{0};'.format(platform.python_version())
]
header = client._contentful_user_agent()
for e in expected:
self.assertTrue(e in header)
self.assertTrue(re.search('os (Windows|macOS|Linux)(\/.*)?;', header))
self.assertTrue('integration' not in header)
self.assertTrue('app' not in header)
