Justintime50 / pullbug / 35

pending completion

Build # 35

Build Type

Pull #13

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/Justintime50/pullbug/commit/<a class=hub.com/Justintime50/pullbug/commit/<a class="double-link" href="https://git"><a class=hub.com/Justintime50/pullbug/commit/<a class="double-link" href="https://git"><a class=hub.com/Justintime50/pullbug/commit/<a class="double-link" href="https://git"><a class=hub.com/Justintime50/pullbug/commit/<a class="double-link" href="https://git"><a class=hub.com/Justintime50/pullbug/commit/19f10e2868fc252b1766bb0f38acda2e99cc01fe">19f10e286">&lt;a href=&quot;https://github.com/Justintime50/pullbug/commit/</a><a class="double-link" href="https://github.com/Justintime50/pullbug/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Justintime50/pullbug/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Justintime50/pullbug/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Justintime50/pullbug/commit/19f10e2868fc252b1766bb0f38acda2e99cc01fe">19f10e286</a><a href="https://github.com/Justintime50/pullbug/commit/19f10e2868fc252b1766bb0f38acda2e99cc01fe">&lt;a href=&quot;https://github.com/Justintime50/pullbug/commit/19f10e2868fc252b1766bb0f38acda2e99cc01fe&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/Justintime50/pullbug/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/Justintime50/pullbug/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://git&amp;quot;&amp;gt;&amp;amp;lt;a class=&amp;lt;/a&amp;gt;hub.com/Justintime50/pullbug/commit/19f10e2868fc252b1766bb0f38acda2e99cc01fe&amp;quot;&amp;gt;19f10e286&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/Justintime50/pullbug/commit/19f10e2868fc252b1766bb0f38acda2e99cc01fe&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/Justintime50/pullbug/commit/19f10e2868fc252b1766bb0f38acda2e&amp;lt;/a&amp;gt;99cc01fe</a>&quot;&gt;&amp;quot;&amp;gt;Merge &amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/Justintime50/pullbug/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/Justintime50/pullbug/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/Justintime50/pullbug/commit/62dc97a44... (continued)

Pull Request Pull Request #13: WIP: v2.0.0

Run Details

225 of 225 new or added lines in 6 files covered. (100.0%)

227 of 235 relevant lines covered (96.6%)

2.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.24

/pullbug/gitlab_bug.py

import os
import requests
import logging
import sys
from pullbug.logger import PullBugLogger
from pullbug.messages import Messages


GITLAB_API_KEY = os.getenv('GITLAB_API_KEY')
GITLAB_API_URL = os.getenv('GITLAB_API_URL', 'https://gitlab.com/api/v4')
IGNORE_WIP = os.getenv('IGNORE_WIP')
GITLAB_HEADERS = {
    'authorization': f'Bearer {GITLAB_API_KEY}'
}
LOGGER = logging.getLogger(__name__)


class GitlabBug():
    @classmethod
    def run(cls, gitlab_scope, gitlab_state, wip, slack, rocketchat):
        """Run the logic to get MR's from GitLab and
        send that data via message.
        """
        PullBugLogger._setup_logging(LOGGER)
        merge_requests = cls.get_merge_requests(gitlab_scope, gitlab_state)
        message_preamble = ''
        if merge_requests == []:
            message = 'No merge requests are available from GitLab.'
            LOGGER.info(message)
            sys.exit()
        message_preamble = '\n:bug: *The following merge requests on GitLab ar still open and need your help!*\n'
        merge_request_messages = cls.iterate_merge_requests(merge_requests, wip)
        final_message = message_preamble + merge_request_messages
        if slack:
            Messages.slack(final_message)
        if rocketchat:
            Messages.rocketchat(final_message)
        LOGGER.info(final_message)

    @classmethod
    def get_merge_requests(cls, gitlab_scope, gitlab_state):
        """Get all repos of the GITLAB_API_URL.
        """
        LOGGER.info('Bugging GitLab for merge requests...')
        try:
            response = requests.get(
                f"{GITLAB_API_URL}/merge_requests?scope={gitlab_scope}&state={gitlab_state}&per_page=100",
                headers=GITLAB_HEADERS
            )
            print(response.json())
            LOGGER.info('GitLab merge requests retrieved!')
            if 'does not have a valid value' in response.text:
                error = f'Could not retrieve GitLab merge requests due to bad parameter: {gitlab_scope} | {gitlab_state}.'  # noqa
                LOGGER.warning(error)
                raise ValueError(error)
        except requests.exceptions.RequestException as response_error:
            LOGGER.warning(
                f'Could not retrieve GitLab merge requests: {response_error}'
            )
            raise requests.exceptions.RequestException(response_error)
        return response.json()

    @classmethod
    def iterate_merge_requests(cls, merge_requests, wip):
        """Iterate through each merge request and send
        a message to Slack if a PR exists.
        """
        final_message = ''
        for merge_request in merge_requests:
            # TODO: There is a "work_in_progress" key in the response
            # that could be used? https://docs.gitlab.com/ee/api/merge_requests.html
            if not wip and 'WIP' in merge_request['title'].upper():
                continue
            else:
                message = cls.prepare_message(merge_request)
                final_message += message
        return final_message

    @classmethod
    def prepare_message(cls, merge_request):
        """Prepare the message with merge request data.
        """
        try:
            if merge_request['assignees'][0]['username']:
                users = ''
                for assignee in merge_request['assignees']:
                    user = f"<{assignee['web_url']}|{assignee['username']}>"
                    users += user + ' '
            else:
                users = 'No assignee'
        except IndexError:
            users = 'No assignee'

        # Truncate description after 120 characters
        description = (merge_request['description'][:120] +
                       '...') if len(merge_request['description']) > 120 else merge_request['description']
        message = f"\n:arrow_heading_up: *Merge Request:* <{merge_request['web_url']}|" + \
            f"{merge_request['title']}>\n*Description:* {description}\n*Waiting on:* {users}\n"

        return message

1	import os	3✔
2	import requests	3✔
3	import logging	3✔
4	import sys	3✔
5	from pullbug.logger import PullBugLogger	3✔
6	from pullbug.messages import Messages	3✔
7
8
9	GITLAB_API_KEY = os.getenv('GITLAB_API_KEY')	3✔
10	GITLAB_API_URL = os.getenv('GITLAB_API_URL', 'https://gitlab.com/api/v4')	3✔
11	IGNORE_WIP = os.getenv('IGNORE_WIP')	3✔
12	GITLAB_HEADERS = {	3✔
13	'authorization': f'Bearer {GITLAB_API_KEY}'
14	}
15	LOGGER = logging.getLogger(__name__)	3✔
16
17
18	class GitlabBug():	3✔
19	@classmethod	3✔
20	def run(cls, gitlab_scope, gitlab_state, wip, slack, rocketchat):	1✔
21	"""Run the logic to get MR's from GitLab and
22	send that data via message.
23	"""
24	PullBugLogger._setup_logging(LOGGER)	3✔
25	merge_requests = cls.get_merge_requests(gitlab_scope, gitlab_state)	3✔
26	message_preamble = ''	3✔
27	if merge_requests == []:	3✔
28	message = 'No merge requests are available from GitLab.'	3✔
29	LOGGER.info(message)	3✔
30	sys.exit()	3✔
31	message_preamble = '\n:bug: The following merge requests on GitLab ar still open and need your help!\n'	3✔
32	merge_request_messages = cls.iterate_merge_requests(merge_requests, wip)	3✔
33	final_message = message_preamble + merge_request_messages	3✔
34	if slack:	3✔
35	Messages.slack(final_message)	3✔
36	if rocketchat:	3✔
37	Messages.rocketchat(final_message)	3✔
38	LOGGER.info(final_message)	3✔
39
40	@classmethod	3✔
41	def get_merge_requests(cls, gitlab_scope, gitlab_state):	1✔
42	"""Get all repos of the GITLAB_API_URL.
43	"""
44	LOGGER.info('Bugging GitLab for merge requests...')	3✔
45	try:	3✔
46	response = requests.get(	3✔
47	f"{GITLAB_API_URL}/merge_requests?scope={gitlab_scope}&state={gitlab_state}&per_page=100",
48	headers=GITLAB_HEADERS
49	)
50	print(response.json())	3✔
51	LOGGER.info('GitLab merge requests retrieved!')	3✔
52	if 'does not have a valid value' in response.text:	3✔
53	error = f'Could not retrieve GitLab merge requests due to bad parameter: {gitlab_scope} \| {gitlab_state}.' # noqa	×
54	LOGGER.warning(error)	×
55	raise ValueError(error)	×
56	except requests.exceptions.RequestException as response_error:	3✔
57	LOGGER.warning(	3✔
58	f'Could not retrieve GitLab merge requests: {response_error}'
59	)
60	raise requests.exceptions.RequestException(response_error)	3✔
61	return response.json()	3✔
62
63	@classmethod	3✔
64	def iterate_merge_requests(cls, merge_requests, wip):	1✔
65	"""Iterate through each merge request and send
66	a message to Slack if a PR exists.
67	"""
68	final_message = ''	3✔
69	for merge_request in merge_requests:	3✔
70	# TODO: There is a "work_in_progress" key in the response
71	# that could be used? https://docs.gitlab.com/ee/api/merge_requests.html
72	if not wip and 'WIP' in merge_request['title'].upper():	3✔
73	continue	3✔
74	else:
75	message = cls.prepare_message(merge_request)	3✔
76	final_message += message	3✔
77	return final_message	3✔
78
79	@classmethod	3✔
80	def prepare_message(cls, merge_request):	1✔
81	"""Prepare the message with merge request data.
82	"""
83	try:	3✔
84	if merge_request['assignees'][0]['username']:	3✔
85	users = ''	3✔
86	for assignee in merge_request['assignees']:	3✔
87	user = f"<{assignee['web_url']}\|{assignee['username']}>"	3✔
88	users += user + ' '	3✔
89	else:
90	users = 'No assignee'	3✔
91	except IndexError:	3✔
92	users = 'No assignee'	3✔
93
94	# Truncate description after 120 characters
95	description = (merge_request['description'][:120] +	3✔
96	'...') if len(merge_request['description']) > 120 else merge_request['description']
97	message = f"\n:arrow_heading_up: Merge Request: <{merge_request['web_url']}\|" + \	3✔
98	f"{merge_request['title']}>\nDescription: {description}\nWaiting on: {users}\n"
99
100	return message	3✔

Justintime50 / pullbug / 35

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous