RVD/rvd_tools/importer/gitlab.py at master · aliasrobotics/RVD · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# -*- coding: utf-8 -*-
#
# Alias Robotics SL
# https://aliasrobotics.com

"""
Gitlab importer class, fetches tickets/flaws from Gitlab's
private repositories.

Requires ones to have the right configuration file at
    $HOME/.python-gitlab.cfg
"""

import os
import sys
import gitlab
import yaml
from ..database.base import Base
from ..utils import red
from ..database.flaw import Flaw
from ..utils import yellow


class GitlabImporter(Base):
    """
    Class to interact and import tickets from Gitlab
    """

    def __init__(self, username="aliasrobotics", repo="RVD", project=15400852):
        """
        Imports tickets from Gitlab's private repos
        """
        super().__init__(username, repo)

        try:
            self.token = os.environ["GITLAB_TOKEN"]
        except KeyError:
            red("ERROR, make sure that you've GITLAB_TOKEN exported")
            sys.exit(1)

        # Initialize Gitlab's object
        self.repo = gitlab.Gitlab("https://gitlab.com", private_token=self.token)
        self.project = project

    def get_flaw(self, id, importar=False):
        """
        Returns a flaw instance populated from the ticket with id number

        :param id, id number of the ticket
        :return Flaw
        """
        project = self.repo.projects.get(self.project)
        issue = project.issues.get(id)
        document_raw = (
            issue.attributes["description"].replace("```yaml", "").replace("```", "")
        )
        document = yaml.safe_load(document_raw, Loader=yaml.FullLoader)
        flaw = Flaw(document)
        labels = issue.attributes["labels"]

        if not "ready" in labels and importar:
            yellow(
                "Importing a ticket that's not 'ready' just yet, \
make sure the ticket has 'ready' label."
            )
            sys.exit(1)

        if "flaw" in labels:
            labels.remove("flaw")
        if "Offensive team" in labels:
            labels.remove("Offensive team")
        if "ready" in labels:
            labels.remove("ready")
        return flaw, labels

    def get_ready_flaws(self, labels):
        """
        Get all the tickets that include 'labels' and that have
        the 'ready' label

        :return [Flaw], list of Flaws
        """
        raise NotImplementedError

    def get_table(self, label):
        """
        Returns a tabulate ready table with elements
        [RVDid (0), private ID, title]

        NOTE: RVD id of all private tickets is 0 by convention.
        NOTE2: Only open issues are considered for this source of information.

        :param label, tuple with labels, could be more than one
        :param is, status of the issues (could be "open", "closed" or "all")
        :return list[list]
        """
        table = []
        project = self.repo.projects.get(self.project)
        issues = project.issues.list(state="opened", all=True)

        for issue in issues:
            # print(issue.attributes['title'])
            # print(issue.attributes['iid'])
            # print(issue.attributes['state'])
            # print(issue.attributes['labels'])

            # only consider if the `flaw` label is in there
            if "flaw" in issue.attributes["labels"]:
                # yellow(issue.attributes['title'])
                # print(issue.attributes.keys())
                if label:
                    all_labels = True
                    for lab in label:
                        if lab in issue.attributes["labels"]:
                            continue
                        all_labels = False
                    if all_labels:
                        # print(issue.attributes['title'])
                        row = [0, issue.attributes["iid"], issue.attributes["title"]]
                        table.append(row)
                else:
                    row = [0, issue.attributes["iid"], issue.attributes["title"]]
                    table.append(row)

        return table