OCA / runbot-addons / 817

pending completion

Build # 817

Build Type

Pull #185

travis-ci

Committed by

web-flow

Commit Message

[FIX] gitlab_runbot: to prevent exceptions with new runbot addon

we construct a head label for gitlab as well, otherwise generatingg the
branch_url will throw an exception in _get_branch_url()
https://github.com/odoo/runbot/commit/1330d5209#diff-f845984e99fe832a8c029aa2d2cc8d3aR44

Pull Request Pull Request #185: [FIX] runbot_gitlab: to prevent exceptions with runbot addon from 1330d5209879cebc

Run Details

1 of 1 new or added line in 1 file covered. (100.0%)

307 of 472 relevant lines covered (65.04%)

0.89 hits per line

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

25.97

/runbot_gitlab/models/runbot_repo.py

# Copyright <2017> <Vauxoo info@vauxoo.com>
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

import logging
import re
import urllib.parse

import requests

from odoo import fields, models

_logger = logging.getLogger(__name__)


def _get_url(url, base):
    """When get is URL_GITHUB/api/v4/User/keys must be convert to
    URL_GITLAB/User.keys Because the api of gitlab required admin token
    for get the ssh keys
    https://docs.gitlab.com/ee/api/users.html#list-ssh-keys"""
    match_object = re.search('([^/]+)/([^/]+)/([^/.]+(.git)?)', base)
    if match_object:
        prefix = ('https://%s/api/v4%s'
                  if not url.endswith('/keys') else 'https://%s%s')
        project_name = (match_object.group(2) + '/' + match_object.group(3))
        url = url.replace(':owner', match_object.group(2))
        url = url.replace(':repo', match_object.group(3))
        url = prefix % (match_object.group(1), url)
        url = url.replace('/repos/', '/projects/')
        url = url.replace('/commits/', '/repository/commits/')
        url = url.replace(project_name,
                          urllib.parse.quote(project_name, safe=''))
        if url.endswith('/keys'):
            url = url.replace('users/', '').replace('/keys', '')
            url = url + '.keys'
        if '/pulls/' in url:
            urls = url.split('/pulls/')
            url = urls[0] + '/merge_requests?iid=' + urls[1]
    return url


def _get_session(token):
    session = requests.Session()
    session.auth = (token, 'x-oauth-basic')
    session.headers.update({'PRIVATE-TOKEN': token})
    return session


class RunbotRepo(models.Model):
    _inherit = "runbot.repo"

    uses_gitlab = fields.Boolean(help='Enable the ability to use gitlab '
                                      'instead of github')
    warnings_are_errors = fields.Boolean(
        'Treat warnings as errors',
        default=True, help='When runbot reports warnings, report that as '
        'error to gitlab',
    )

    def _git(self, cmd):
        """Rewriting the parent method to get merge_request from gitlab"""
        repos_gitlab = self.filtered('uses_gitlab')
        for repo_gitlab in repos_gitlab:
            cmd_gitlab = cmd.copy()
            if ('fetch' in cmd_gitlab
                    and cmd_gitlab[-1] == '+refs/pull/*/head:refs/pull/*'):
                cmd_gitlab.pop()
                cmd_gitlab.append('+refs/merge-requests/*/head:refs/pull/*')
            return super(RunbotRepo, repos_gitlab)._git(cmd_gitlab)
        return super(RunbotRepo, self - repos_gitlab)._git(cmd)

    def _github(self, url, payload=None, ignore_errors=False):
        """This method is the same as the one in the odoo-extra/runbot.py
        file but with the translation of each request github to gitlab format
        - Get information from merge requests
            input: URL_GITLAB/projects/... instead of URL_GITHUB/repos/...
            output: res['base']['ref'] = res['gitlab_base_mr']
                    res['head']['ref'] = res['gitlab_head_mr']
        - Get user public keys
            input: URL_GITLAB/User.keys... instead of
                   URL_GITHUB/users/User/keys...
            output: res['author'] = {'login': data['username']}
                    res['committer'] = {'login': data['username']}
        - Report statutes
            input: URL_GITLABL/... instead of URL_GITHUB/statuses/...
            output: N/A
        """
        records_gitlab = self.filtered('uses_gitlab')
        for repo in records_gitlab.filtered('token'):
            try:
                url = _get_url(url, repo.base)
                if not url:
                    return
                is_url_keys = url.endswith('.keys')
                session = _get_session(repo.token)
                if payload:
                    response = session.post(url, data=payload)
                else:
                    response = session.get(url)
                response.raise_for_status()
                json = (response.json() if not is_url_keys
                        else response.text)
                if 'merge_requests?iid=' in url:
                    json = json[0]

                    json['head'] = {
                        'ref': json['target_branch'],
                        # github api returns a label like 'source-project-name:source-branch-name' the closest we got
                        # in gitlab api is source_project_id:source_branch (without additional http/db requests)
                        'label': '%s:%s' % (json['source_project_id'], json['source_branch']),
                    }
                    json['base'] = {'ref': json['source_branch']}
                if '/commits/' in url:
                    for own_key in ['author', 'committer']:
                        key_email = '%s_email' % own_key
                        if json[key_email]:
                            url = _get_url('/users?search=%s' %
                                           json[key_email],
                                           repo.base)
                            response = session.get(url)
                            response.raise_for_status()
                            data = response.json()
                            json[own_key] = {
                                'login': data and data[0]['username'] or ''
                            }
                if is_url_keys:
                    json = [{'key': ssh_rsa} for ssh_rsa in json.split('\n')]
                return json
            except Exception:
                if ignore_errors:
                    _logger.exception('Ignored gitlab error %s %r', url,
                                      payload)
                else:
                    raise
        return super(RunbotRepo, self - records_gitlab)._github(
            url, payload=payload, ignore_errors=ignore_errors)

1	# Copyright <2017> <Vauxoo info@vauxoo.com>
2	# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
3
4	import logging	2✔
5	import re	2✔
6	import urllib.parse	2✔
7
8	import requests	2✔
9
10	from odoo import fields, models	2✔
11
12	_logger = logging.getLogger(__name__)	2✔
13
14
15	def _get_url(url, base):	2✔
16	"""When get is URL_GITHUB/api/v4/User/keys must be convert to
17	URL_GITLAB/User.keys Because the api of gitlab required admin token
18	for get the ssh keys
19	https://docs.gitlab.com/ee/api/users.html#list-ssh-keys"""
20	match_object = re.search('([^/]+)/([^/]+)/([^/.]+(.git)?)', base)	×
21	if match_object:	×
22	prefix = ('https://%s/api/v4%s'	×
23	if not url.endswith('/keys') else 'https://%s%s')
24	project_name = (match_object.group(2) + '/' + match_object.group(3))	×
25	url = url.replace(':owner', match_object.group(2))	×
26	url = url.replace(':repo', match_object.group(3))	×
27	url = prefix % (match_object.group(1), url)	×
28	url = url.replace('/repos/', '/projects/')	×
29	url = url.replace('/commits/', '/repository/commits/')	×
30	url = url.replace(project_name,	×
31	urllib.parse.quote(project_name, safe=''))
32	if url.endswith('/keys'):	×
33	url = url.replace('users/', '').replace('/keys', '')	×
34	url = url + '.keys'	×
35	if '/pulls/' in url:	×
36	urls = url.split('/pulls/')	×
37	url = urls[0] + '/merge_requests?iid=' + urls[1]	×
38	return url	×
39
40
41	def _get_session(token):	2✔
42	session = requests.Session()	×
43	session.auth = (token, 'x-oauth-basic')	×
44	session.headers.update({'PRIVATE-TOKEN': token})	×
45	return session	×
46
47
48	class RunbotRepo(models.Model):	2✔
49	_inherit = "runbot.repo"	2✔
50
51	uses_gitlab = fields.Boolean(help='Enable the ability to use gitlab '	2✔
52	'instead of github')
53	warnings_are_errors = fields.Boolean(	2✔
54	'Treat warnings as errors',
55	default=True, help='When runbot reports warnings, report that as '
56	'error to gitlab',
57	)
58
59	def _git(self, cmd):	2✔
60	"""Rewriting the parent method to get merge_request from gitlab"""
61	repos_gitlab = self.filtered('uses_gitlab')	1✔
62	for repo_gitlab in repos_gitlab:	1✔
63	cmd_gitlab = cmd.copy()	×
64	if ('fetch' in cmd_gitlab	×
65	and cmd_gitlab[-1] == '+refs/pull//head:refs/pull/'):
66	cmd_gitlab.pop()	×
67	cmd_gitlab.append('+refs/merge-requests//head:refs/pull/')	×
68	return super(RunbotRepo, repos_gitlab)._git(cmd_gitlab)	×
69	return super(RunbotRepo, self - repos_gitlab)._git(cmd)	1✔
70
71	def _github(self, url, payload=None, ignore_errors=False):	2✔
72	"""This method is the same as the one in the odoo-extra/runbot.py
73	file but with the translation of each request github to gitlab format
74	- Get information from merge requests
75	input: URL_GITLAB/projects/... instead of URL_GITHUB/repos/...
76	output: res['base']['ref'] = res['gitlab_base_mr']
77	res['head']['ref'] = res['gitlab_head_mr']
78	- Get user public keys
79	input: URL_GITLAB/User.keys... instead of
80	URL_GITHUB/users/User/keys...
81	output: res['author'] = {'login': data['username']}
82	res['committer'] = {'login': data['username']}
83	- Report statutes
84	input: URL_GITLABL/... instead of URL_GITHUB/statuses/...
85	output: N/A
86	"""
87	records_gitlab = self.filtered('uses_gitlab')	2✔
88	for repo in records_gitlab.filtered('token'):	2✔
89	try:	×
90	url = _get_url(url, repo.base)	×
91	if not url:	×
92	return	×
93	is_url_keys = url.endswith('.keys')	×
94	session = _get_session(repo.token)	×
95	if payload:	×
96	response = session.post(url, data=payload)	×
97	else:
98	response = session.get(url)	×
99	response.raise_for_status()	×
100	json = (response.json() if not is_url_keys	×
101	else response.text)
102	if 'merge_requests?iid=' in url:	×
103	json = json[0]	×
104
105	json['head'] = {	×
106	'ref': json['target_branch'],
107	# github api returns a label like 'source-project-name:source-branch-name' the closest we got
108	# in gitlab api is source_project_id:source_branch (without additional http/db requests)
109	'label': '%s:%s' % (json['source_project_id'], json['source_branch']),
110	}
111	json['base'] = {'ref': json['source_branch']}	×
112	if '/commits/' in url:	×
113	for own_key in ['author', 'committer']:	×
114	key_email = '%s_email' % own_key	×
115	if json[key_email]:	×
116	url = _get_url('/users?search=%s' %	×
117	json[key_email],
118	repo.base)
119	response = session.get(url)	×
120	response.raise_for_status()	×
121	data = response.json()	×
122	json[own_key] = {	×
123	'login': data and data[0]['username'] or ''
124	}
125	if is_url_keys:	×
126	json = [{'key': ssh_rsa} for ssh_rsa in json.split('\n')]	×
127	return json	×
128	except Exception:	×
129	if ignore_errors:	×
130	_logger.exception('Ignored gitlab error %s %r', url,	×
131	payload)
132	else:
133	raise	×
134	return super(RunbotRepo, self - records_gitlab)._github(	2✔
135	url, payload=payload, ignore_errors=ignore_errors)

OCA / runbot-addons / 817

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