def test_disable_preview_on_revisions_list(self):
simple_page = SimplePage(title='simple page', content="hello")
self.root_page.add_child(instance=simple_page)
simple_page.save_revision(log_action=True)
# check preview shows up by default
response = self.client.get(
reverse('wagtailadmin_pages:history', args=(simple_page.id, )))
preview_url = reverse('wagtailadmin_pages:revisions_view',
args=(simple_page.id,
simple_page.get_latest_revision().id))
self.assertContains(response, 'Preview')
self.assertContains(response, preview_url)
stream_page = StreamPage(title='stream page', body=[('text', 'hello')])
self.root_page.add_child(instance=stream_page)
latest_revision = stream_page.save_revision(log_action=True)
# StreamPage has preview_modes = []
response = self.client.get(
reverse('wagtailadmin_pages:history', args=(stream_page.id, )))
preview_url = reverse('wagtailadmin_pages:revisions_view',
args=(stream_page.id, latest_revision.id))
self.assertNotContains(response, 'Preview')
self.assertNotContains(response, preview_url)
def disable_preview_in_moderation_list(self):
stream_page = StreamPage(title='stream page', body=[('text', 'hello')])
self.root_page.add_child(instance=stream_page)
latest_revision = stream_page.save_revision(user=self.user, submitted_for_moderation=True)
response = self.client.get(reverse('wagtailadmin_home'))
preview_url = reverse('wagtailadmin_pages:preview_for_moderation', args=(latest_revision.id,))
self.assertNotContains(response, '<li class="preview">')
self.assertNotContains(response, 'data-action="%s"' % preview_url)
class MigrationsUtilTestCase(TestCase):
def setUp(self):
self.root = Page.objects.get(slug='cfgov')
self.page = StreamPage(title="Test Page", slug="testpage")
save_new_page(self.page, self.root)
set_stream_data(self.page, 'body', [
{'type': 'text', 'value': 'some text'}
])
self.revision = self.page.save_revision()
self.page.save()
def test_is_page_page(self):
""" Test that a page is verifably a page """
self.assertTrue(is_page(self.page))
def test_is_page_revision(self):
""" Test that a revision is verifiably not a page """
self.assertFalse(is_page(self.revision))
def test_get_stream_data_page(self):
""" Test that get_stream_data fetches the stream_data correctly
from a page object. """
stream_data = get_stream_data(self.page, 'body')
self.assertEqual(stream_data[0]['type'], 'text')
self.assertEqual(stream_data[0]['value'], 'some text')
def test_get_stream_data_revision(self):
""" Test that get_stream_data fetches the stream_data correctly
from a revision object. """
stream_data = get_stream_data(self.revision, 'body')
self.assertEqual(stream_data[0]['type'], 'text')
self.assertEqual(stream_data[0]['value'], 'some text')
def test_get_stream_data_revision_no_field(self):
""" Test that get an empty list for fields that don't exist on
revisions """
stream_data = get_stream_data(self.revision, 'notbody')
self.assertEqual(stream_data, [])
def test_set_stream_data_page(self):
""" Test that set_stream_data correctly sets stream data for a
given page and saves the page. """
new_stream_data = [{'type': 'text', 'value': 'new text'}]
set_stream_data(self.page, 'body', new_stream_data)
self.assertEqual(self.page.body.stream_data[0]['value'], 'new text')
def test_set_stream_data_revision(self):
""" Test that set_stream_data correctly sets stream data for a
given revision and saves the page. """
new_stream_data = [{'type': 'text', 'value': 'new text'}]
set_stream_data(self.revision, 'body', new_stream_data)
self.assertEqual(
self.revision.as_page_object().body.stream_data[0]['value'],
'new text')
def test_set_stream_data_page_without_committing(self):
""" Test that set_stream_data correctly sets stream data for a
given page and saves the page. """
self.page.save = mock.Mock()
new_stream_data = [{'type': 'text', 'value': 'new text'}]
set_stream_data(self.page, 'body', new_stream_data, commit=False)
self.assertEqual(self.page.save.mock_calls, [])
def test_migrate_stream_data_recursion(self):
mapper = mock.Mock(return_value='new text')
stream_data = [
{
'type': 'not-migratory',
'value': [
{
'type': 'migratory',
'value': 'old text',
},
]
},
{
'type': 'not-migratory',
'value': []
},
]
result, migrated = migrate_stream_data(
self.page, ['not-migratory', 'migratory'], stream_data, mapper
)
self.assertTrue(migrated)
self.assertEquals(result[0]['value'][0]['value'], 'new text')
def test_migrate_stream_data_flat(self):
mapper = mock.Mock(return_value='new text')
stream_data = [
{
'type': 'not-migratory',
'value': 'old text',
},
{
'type': 'migratory',
'value': 'old text',
},
]
result, migrated = migrate_stream_data(
self.page, ['migratory', ], stream_data, mapper
)
self.assertTrue(migrated)
self.assertEquals(result[1]['value'], 'new text')
def test_migrate_stream_data_empty_block_path(self):
mapper = mock.Mock(return_value='new text')
result, migrated = migrate_stream_data(
self.page, [], {}, mapper
)
self.assertFalse(migrated)
def test_migrate_stream_field_page(self):
""" Test that the migrate_stream_field function correctly gets
old data, calls the mapper function, and stores new data
based on the mapper results. """
# Mock the field mapper migration function. We'll inspect the
# call to this and ensure the return value makes it to
# set_stream_data.
mapper = mock.Mock(return_value='new text')
migrate_stream_field(self.page, 'body', 'text', mapper)
mapper.assert_called_with(self.page, 'some text')
self.assertEqual(self.page.body.stream_data[0]['value'],
'new text')
def test_migrate_stream_field_revision(self):
""" Test that the migrate_stream_field function correctly gets
old data, calls the mapper function, and stores new data
based on the mapper results. """
# Mock the field mapper migration function. We'll inspect the
# call to this and ensure the return value makes it to
# set_stream_data.
mapper = mock.Mock(return_value='new text')
migrate_stream_field(self.revision, 'body', 'text', mapper)
mapper.assert_called_with(self.revision, 'some text')
self.assertEqual(
self.revision.as_page_object().body.stream_data[0]['value'],
'new text')
@mock.patch('v1.util.migrations.set_stream_data')
def test_migrate_stream_field_not_migrated(self,
mock_set_stream_data):
""" Test that the migrate_stream_field function correctly
ignores a field that does not have the correct type and
shouldn't be migrated. """
mapper = mock.Mock()
migrate_stream_field(self.page, 'body', 'other_type', mapper)
# The mapper should not be called
mapper.assert_not_called()
# set_stream_data should not be called
mock_set_stream_data.assert_not_called()
@mock.patch('v1.util.migrations.migrate_stream_field')
def test_migrate_page_types_and_fields(self,
mock_migrate_stream_field):
""" Test that the migrate_page_types_and_fields function
correctly calls the migrate_stream_field function with
the appropriate values from the list of page types and
fields. """
mapper = mock.Mock()
page_types_and_fields = [
('tests', 'StreamPage', 'body', 'text'),
]
migrate_page_types_and_fields(apps, page_types_and_fields, mapper)
# Check that migrate_stream_field was correct called with the page
mock_migrate_stream_field.assert_any_call(self.page,
'body',
'text',
mapper)
# Check that the revision lookup happened correctly and that the
# revision stream field was correctly migrated.
mock_migrate_stream_field.assert_any_call(self.revision,
'body',
'text',
mapper)
class MigrationsUtilTestCase(TestCase):
def setUp(self):
self.root = Page.objects.get(slug='cfgov')
self.page = StreamPage(title="Test Page", slug="testpage")
save_new_page(self.page, self.root)
set_stream_data(self.page, 'body', [{
'type': 'text',
'value': 'some text'
}])
self.revision = self.page.save_revision()
self.page.save()
def test_is_page_page(self):
""" Test that a page is verifably a page """
self.assertTrue(is_page(self.page))
def test_is_page_revision(self):
""" Test that a revision is verifiably not a page """
self.assertFalse(is_page(self.revision))
def test_get_stream_data_page(self):
""" Test that get_stream_data fetches the stream_data correctly
from a page object. """
stream_data = get_stream_data(self.page, 'body')
self.assertEqual(stream_data[0]['type'], 'text')
self.assertEqual(stream_data[0]['value'], 'some text')
def test_get_stream_data_revision(self):
""" Test that get_stream_data fetches the stream_data correctly
from a revision object. """
stream_data = get_stream_data(self.revision.as_page_object(), 'body')
self.assertEqual(stream_data[0]['type'], 'text')
self.assertEqual(stream_data[0]['value'], 'some text')
def test_set_stream_data_page(self):
""" Test that set_stream_data correctly sets stream data for a
given page and saves the page. """
new_stream_data = [{'type': 'text', 'value': 'new text'}]
set_stream_data(self.page, 'body', new_stream_data)
self.assertEqual(self.page.body.stream_data[0]['value'], 'new text')
def test_set_stream_data_revision(self):
""" Test that set_stream_data correctly sets stream data for a
given revision and saves the page. """
new_stream_data = [{'type': 'text', 'value': 'new text'}]
set_stream_data(self.revision, 'body', new_stream_data)
self.assertEqual(
self.revision.as_page_object().body.stream_data[0]['value'],
'new text')
def test_set_stream_data_page_without_committing(self):
""" Test that set_stream_data correctly sets stream data for a
given page and saves the page. """
self.page.save = mock.Mock()
new_stream_data = [{'type': 'text', 'value': 'new text'}]
set_stream_data(self.page, 'body', new_stream_data, commit=False)
self.assertEqual(self.page.save.mock_calls, [])
def test_migrate_stream_field_page(self):
""" Test that the migrate_stream_field function correctly gets
old data, calls the mapper function, and stores new data
based on the mapper results. """
# Mock the field mapper migration function. We'll inspect the
# call to this and ensure the return value makes it to
# set_stream_data.
mapper = mock.Mock(return_value='new text')
migrate_stream_field(self.page, 'body', 'text', mapper)
mapper.assert_called_with(self.page, 'some text')
self.assertEqual(self.page.body.stream_data[0]['value'], 'new text')
def test_migrate_stream_field_revision(self):
""" Test that the migrate_stream_field function correctly gets
old data, calls the mapper function, and stores new data
based on the mapper results. """
# Mock the field mapper migration function. We'll inspect the
# call to this and ensure the return value makes it to
# set_stream_data.
mapper = mock.Mock(return_value='new text')
migrate_stream_field(self.revision, 'body', 'text', mapper)
mapper.assert_called_with(self.revision, 'some text')
self.assertEqual(
self.revision.as_page_object().body.stream_data[0]['value'],
'new text')
@mock.patch('v1.util.migrations.set_stream_data')
def test_migrate_stream_field_not_migrated(self, mock_set_stream_data):
""" Test that the migrate_stream_field function correctly
ignores a field that does not have the correct type and
shouldn't be migrated. """
mapper = mock.Mock()
migrate_stream_field(self.page, 'body', 'other_type', mapper)
# The mapper should not be called
mapper.assert_not_called()
# set_stream_data should not be called
mock_set_stream_data.assert_not_called()
@mock.patch('v1.util.migrations.migrate_stream_field')
def test_migrate_page_types_and_fields(self, mock_migrate_stream_field):
""" Test that the migrate_page_types_and_fields function
correctly calls the migrate_stream_field function with
the appropriate values from the list of page types and
fields. """
mapper = mock.Mock()
page_types_and_fields = [
('tests', 'StreamPage', 'body', 'text'),
]
migrate_page_types_and_fields(apps, page_types_and_fields, mapper)
# Check that migrate_stream_field was correct called with the page
mock_migrate_stream_field.assert_any_call(self.page, 'body', 'text',
mapper)
# Check that the revision lookup happened correctly and that the
# revision stream field was correctly migrated.
mock_migrate_stream_field.assert_any_call(self.revision, 'body',
'text', mapper)