pillar/tests/test_cli/test_maintenance.py

from unittest import mock

from bson import ObjectId

from pillar.api.utils import random_etag, utcnow
from pillar.tests import AbstractPillarTest
from pillar.tests import common_test_data as ctd


class PurgeHomeProjectsTest(AbstractPillarTest):
    def test_purge(self):
        self.create_standard_groups()
        # user_a will be soft-deleted, user_b will be hard-deleted.
        # We don't support soft-deleting users yet, but the code should be
        # handling that properly anyway.
        user_a = self.create_user(user_id=24 * 'a', roles={'subscriber'}, token='token-a')
        user_b = self.create_user(user_id=24 * 'b', roles={'subscriber'}, token='token-b')

        # GET the home project to create it.
        home_a = self.get('/api/bcloud/home-project', auth_token='token-a').get_json()
        home_b = self.get('/api/bcloud/home-project', auth_token='token-b').get_json()

        with self.app.app_context():
            users_coll = self.app.db('users')

            res = users_coll.update_one({'_id': user_a}, {'$set': {'_deleted': True}})
            self.assertEqual(1, res.modified_count)

            res = users_coll.delete_one({'_id': user_b})
            self.assertEqual(1, res.deleted_count)

        from pillar.cli.maintenance import purge_home_projects

        with self.app.app_context():
            self.assertEqual(2, purge_home_projects(go=True))

            proj_coll = self.app.db('projects')
            self.assertEqual(True, proj_coll.find_one({'_id': ObjectId(home_a['_id'])})['_deleted'])
            self.assertEqual(True, proj_coll.find_one({'_id': ObjectId(home_b['_id'])})['_deleted'])


class UpgradeAttachmentSchemaTest(AbstractPillarTest):
    def test_blog_post(self):
        from pillar.api.node_types import PILLAR_NAMED_NODE_TYPES
        from pillar.cli.maintenance import upgrade_attachment_schema

        old_blog_post_nt = {
            "name": "post",
            "description": "A blog post, for any project",
            "dyn_schema": {
                "content": {
                    "type": "string",
                    "minlength": 5,
                    "maxlength": 90000,
                    "required": True
                },
                "status": {
                    "type": "string",
                    "allowed": ["published", "pending"],
                    "default": "pending"
                },
                "category": {"type": "string"},
                "url": {"type": "string"},
                "attachments": {
                    "type": "dict",
                    "keyschema": {"type": "string", "regex": "^[a-zA-Z0-9_ ]+$"},
                    "valueschema": {
                        "type": "dict",
                        "schema": {
                            "oid": {"type": "objectid", "required": True},
                            "link": {
                                "type": "string",
                                "allowed": ["self", "none", "custom"],
                                "default": "self"
                            },
                            "link_custom": {"type": "string"},
                            "collection": {
                                "type": "string",
                                "allowed": ["files"],
                                "default": "files"
                            }
                        }
                    }
                }
            },
            "form_schema": {},
            "parent": ["blog"]
        }

        pid, project = self.ensure_project_exists(
            project_overrides={
                'picture_header': None,
                'picture_square': None,
                'node_types': [
                    PILLAR_NAMED_NODE_TYPES['group_texture'],
                    PILLAR_NAMED_NODE_TYPES['group'],
                    PILLAR_NAMED_NODE_TYPES['asset'],
                    PILLAR_NAMED_NODE_TYPES['storage'],
                    PILLAR_NAMED_NODE_TYPES['comment'],
                    PILLAR_NAMED_NODE_TYPES['blog'],
                    old_blog_post_nt,
                ]})

        with self.app.app_context():
            upgrade_attachment_schema(proj_url=project['url'], go=True)

            db_proj = self.app.db('projects').find_one({'_id': pid})
            db_node_type = db_proj['node_types'][-1]
            self.assertEqual('post', db_node_type['name'])

            self.assertEqual(
                PILLAR_NAMED_NODE_TYPES['post']['dyn_schema'],
                db_node_type['dyn_schema'])
            self.assertEqual({}, db_node_type['form_schema'])


class UpgradeAttachmentUsageTest(AbstractPillarTest):
    def setUp(self, **kwargs):
        super().setUp(**kwargs)
        self.pid, self.uid = self.create_project_with_admin(user_id=24 * 'a')

        with self.app.app_context():
            files_coll = self.app.db('files')

            res = files_coll.insert_one({
                **ctd.EXAMPLE_FILE,
                'project': self.pid,
                'user': self.uid,
            })
            self.fid = res.inserted_id

    def test_image_link(self):
        with self.app.app_context():
            nodes_coll = self.app.db('nodes')
            res = nodes_coll.insert_one({
                **ctd.EXAMPLE_NODE,
                'picture': self.fid,
                'project': self.pid,
                'user': self.uid,
                'description': "# Title\n\n@[slug 0]\n@[slug1]\n@[slug2]\nEitje van Fabergé.",
                'properties': {
                    'status': 'published',
                    'content_type': 'image',
                    'file': self.fid,
                    'attachments': {
                        'slug 0': {
                            'oid': self.fid,
                            'link': 'self',
                        },
                        'slug1': {
                            'oid': self.fid,
                            'link': 'custom',
                            'link_custom': 'https://cloud.blender.org/',
                        },
                        'slug2': {
                            'oid': self.fid,
                        },
                    }
                }
            })
            nid = res.inserted_id

        from pillar.cli.maintenance import upgrade_attachment_usage

        with self.app.app_context():
            upgrade_attachment_usage(proj_url=ctd.EXAMPLE_PROJECT['url'], go=True)
            node = nodes_coll.find_one({'_id': nid})

            self.assertEqual(
                "# Title\n\n"
                "{attachment 'slug-0' link='self'}\n"
                "{attachment 'slug1' link='https://cloud.blender.org/'}\n"
                "{attachment 'slug2'}\n"
                "Eitje van Fabergé.",
                node['description'],
                'The description should be updated')
            self.assertEqual(
                "<h1>Title</h1>\n"
                "<!-- {attachment 'slug-0' link='self'} -->\n"
                "<!-- {attachment 'slug1' link='https://cloud.blender.org/'} -->\n"
                "<!-- {attachment 'slug2'} -->\n"
                "<p>Eitje van Fabergé.</p>\n",
                node['_description_html'],
                'The _description_html should be updated')

            self.assertEqual(
                {'slug-0': {'oid': self.fid},
                 'slug1': {'oid': self.fid},
                 'slug2': {'oid': self.fid},
                 },
                node['properties']['attachments'],
                'The link should have been removed from the attachment')

    def test_post(self):
        """This requires checking the dynamic schema of the node."""
        with self.app.app_context():
            nodes_coll = self.app.db('nodes')
            res = nodes_coll.insert_one({
                **ctd.EXAMPLE_NODE,
                'node_type': 'post',
                'project': self.pid,
                'user': self.uid,
                'picture': self.fid,
                'description': "meh",
                'properties': {
                    'status': 'published',
                    'content': "# Title\n\n@[slug0]\n@[slug1]\n@[slug2]\nEitje van Fabergé.",
                    'attachments': {
                        'slug0': {
                            'oid': self.fid,
                            'link': 'self',
                        },
                        'slug1': {
                            'oid': self.fid,
                            'link': 'custom',
                            'link_custom': 'https://cloud.blender.org/',
                        },
                        'slug2': {
                            'oid': self.fid,
                        },
                    }
                }
            })
            nid = res.inserted_id

        from pillar.cli.maintenance import upgrade_attachment_usage

        with self.app.app_context():
            upgrade_attachment_usage(proj_url=ctd.EXAMPLE_PROJECT['url'], go=True)
            node = nodes_coll.find_one({'_id': nid})

            self.assertEqual(
                "# Title\n\n"
                "{attachment 'slug0' link='self'}\n"
                "{attachment 'slug1' link='https://cloud.blender.org/'}\n"
                "{attachment 'slug2'}\n"
                "Eitje van Fabergé.",
                node['properties']['content'],
                'The content should be updated')
            self.assertEqual(
                "<h1>Title</h1>\n"
                "<!-- {attachment 'slug0' link='self'} -->\n"
                "<!-- {attachment 'slug1' link='https://cloud.blender.org/'} -->\n"
                "<!-- {attachment 'slug2'} -->\n"
                "<p>Eitje van Fabergé.</p>\n",
                node['properties']['_content_html'],
                'The _content_html should be updated')

            self.assertEqual(
                {'slug0': {'oid': self.fid},
                 'slug1': {'oid': self.fid},
                 'slug2': {'oid': self.fid},
                 },
                node['properties']['attachments'],
                'The link should have been removed from the attachment')


class ReconcileNodeDurationTest(AbstractPillarTest):
    def setUp(self, **kwargs):
        super().setUp(**kwargs)
        self.pid, _ = self.ensure_project_exists()
        self.fake_now = utcnow()

        # Already correct. Should not be touched.
        self.node_id0 = self._create_video_node(file_duration=123, node_duration=123)
        # Out of sync, should be updated
        self.node_id1 = self._create_video_node(file_duration=3661, node_duration=15)
        self.node_id2 = self._create_video_node(file_duration=432, node_duration=5)
        self.node_id3 = self._create_video_node(file_duration=222)
        # No file duration. Should not be touched
        self.node_id4 = self._create_video_node()
        # No file. Should not be touched
        self.node_id5 = self._create_video_node(include_file=False)
        # Wrong node type. Should not be touched
        self.image_node_id = self._create_image_node()

        def id_to_original_dict(*nids):
            with self.app.app_context():
                nodes_coll = self.app.db('nodes')
                return dict(((nid, nodes_coll.find_one({'_id': nid})) for nid in nids))

        self.orig_nodes = id_to_original_dict(
            self.node_id0,
            self.node_id1,
            self.node_id2,
            self.node_id3,
            self.node_id4,
            self.node_id5,
            self.image_node_id,
        )

    def test_reconcile_all(self):
        from pillar.cli.maintenance import reconcile_node_video_duration

        with self.app.app_context():
            with mock.patch('pillar.api.utils.utcnow') as mock_utcnow:
                mock_utcnow.return_value = self.fake_now

                reconcile_node_video_duration(all_nodes=True, go=False)  # Dry run
                self.assertAllUnchanged()

                reconcile_node_video_duration(all_nodes=True, go=True)
                self.assertUnChanged(
                    self.node_id0,
                    self.node_id4,
                    self.image_node_id,
                )
                self.assertUpdated(self.node_id1, duration_seconds=3661)
                self.assertUpdated(self.node_id2, duration_seconds=432)
                self.assertUpdated(self.node_id3, duration_seconds=222)

    def test_reconcile_some(self):
        from pillar.cli.maintenance import reconcile_node_video_duration

        with self.app.app_context():
            with mock.patch('pillar.api.utils.utcnow') as mock_utcnow:
                mock_utcnow.return_value = self.fake_now

                to_reconcile = [str(self.node_id0), str(self.node_id1), str(self.node_id2), str(self.node_id5)]
                reconcile_node_video_duration(nodes_to_update=to_reconcile, go=False)  # Dry run
                self.assertAllUnchanged()

                reconcile_node_video_duration(nodes_to_update=to_reconcile, go=True)
                self.assertUnChanged(
                    self.node_id0,
                    self.node_id3,
                    self.node_id4,
                    self.image_node_id,
                )
                self.assertUpdated(self.node_id1, duration_seconds=3661)
                self.assertUpdated(self.node_id2, duration_seconds=432)

    def assertUpdated(self, nid, duration_seconds):
        nodes_coll = self.app.db('nodes')
        new_node = nodes_coll.find_one({'_id': nid})
        orig_node = self.orig_nodes[nid]
        self.assertNotEqual(orig_node['_etag'], new_node['_etag'])
        self.assertEquals(self.fake_now, new_node['_updated'])
        self.assertEquals(duration_seconds, new_node['properties']['duration_seconds'])

    def assertAllUnchanged(self):
        self.assertUnChanged(*self.orig_nodes.keys())

    def assertUnChanged(self, *node_ids):
        nodes_coll = self.app.db('nodes')
        for nid in node_ids:
            new_node = nodes_coll.find_one({'_id': nid})
            orig_node = self.orig_nodes[nid]
            self.assertEquals(orig_node, new_node)

    def _create_video_node(self, file_duration=None, node_duration=None, include_file=True):
        file_id, _ = self.ensure_file_exists(file_overrides={
            '_id': ObjectId(),
            'content_type': 'video/mp4',
            'variations': [
                {'format': 'mp4',
                 'duration': file_duration
                 },
            ],
        })

        node = {
            'name': 'Just a node name',
            'project': self.pid,
            'description': '',
            'node_type': 'asset',
            '_etag': random_etag(),
        }
        props = {'status': 'published',
                 'content_type': 'video',
                 'order': 0}
        if node_duration is not None:
            props['duration_seconds'] = node_duration
        if include_file:
            props['file'] = file_id
        return self.create_node({
            'properties': props,
            **node})

    def _create_image_node(self):
        file_id, _ = self.ensure_file_exists(file_overrides={
            '_id': ObjectId(),
            'variations': [
                {'format': 'jpeg'},
            ],
        })

        node = {
            'name': 'Just a node name',
            'project': self.pid,
            'description': '',
            'node_type': 'asset',
            '_etag': random_etag(),
        }
        props = {'status': 'published',
                 'file': file_id,
                 'content_type': 'image',
                 'order': 0}
        return self.create_node({
            'properties': props,
            **node})