Source code for estuary.models.bugzilla

# SPDX-License-Identifier: GPL-3.0+

from __future__ import unicode_literals

import re

from neomodel import (DateTimeProperty, RelationshipFrom, RelationshipTo,
                      StringProperty, UniqueIdProperty, ZeroOrOne)

from estuary.error import ValidationError
from estuary.models.base import EstuaryStructuredNode


class BugzillaBug(EstuaryStructuredNode):
    """Definition of a Bugzilla bug in Neo4j."""

    assignee = RelationshipTo('.user.User', 'ASSIGNED_TO', cardinality=ZeroOrOne)
    attached_advisories = RelationshipFrom('.errata.Advisory', 'ATTACHED')
    creation_time = DateTimeProperty()
    id_ = UniqueIdProperty(db_property='id')
    modified_time = DateTimeProperty(index=True)
    priority = StringProperty()
    # Called product_name in case we want to use product as a relationship later on
    product_name = StringProperty()
    product_version = StringProperty()
    qa_contact = RelationshipTo('.user.User', 'QA_BY', cardinality=ZeroOrOne)
    related_by_commits = RelationshipFrom('.distgit.DistGitCommit', 'RELATED')
    reporter = RelationshipTo('.user.User', 'REPORTED_BY', cardinality=ZeroOrOne)
    resolution = StringProperty()
    resolved_by_commits = RelationshipFrom('.distgit.DistGitCommit', 'RESOLVED')
    reverted_by_commits = RelationshipFrom('.distgit.DistGitCommit', 'REVERTED')
    severity = StringProperty()
    short_description = StringProperty()
    status = StringProperty()
    target_milestone = StringProperty()

    @property
    def display_name(self):
        """Get intuitive (human readable) display name for the node."""
        return 'RHBZ#{0}'.format(self.id_)

    @property
    def timeline_datetime(self):
        """Get the DateTime property used for the Estuary timeline."""
        return self.creation_time

    @classmethod
    def find_or_none(cls, identifier):
        """
        Find the node using the supplied identifier.

        :param str identifier: the identifier to search the node by
        :return: the node or None
        :rtype: EstuaryStructuredNode or None
        """
        uid = identifier
        if uid.lower().startswith('rhbz'):
            uid = uid[4:]
        if uid.startswith('#'):
            uid = uid[1:]

        # If we are left with something other than digits, then it is an invalid identifier
        if not re.match(r'^\d+$', uid):
            raise ValidationError('"{0}" is not a valid identifier'.format(identifier))

        return cls.nodes.get_or_none(id_=uid)