# Copyright Swiss Data Science Center (SDSC). A partnership between
# École Polytechnique Fédérale de Lausanne (EPFL) and
# Eidgenössische Technische Hochschule Zürich (ETHZ).
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Git utilities."""
import os
import re
from pathlib import Path
from typing import Optional
from urllib.parse import urlparse
import attr
from renku.core import errors
from renku.core.util.os import is_ascii, normalize_to_ascii
from renku.ui.service.utils import normalize_git_url
_RE_SCHEME = r"(?P<scheme>(git\+)?(https?|git|ssh|rsync))\://"
_RE_USERNAME = r"(?:(?P<username>.+)@)?"
_RE_USERNAME_PASSWORD = r"(?:(?P<username>[^:]+)(:(?P<password>[^@]+))?@)?"
# RFC 1123 compliant hostname regex
_RE_HOSTNAME = (
r"(?P<hostname>"
r"([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}"
r"[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}"
r"[a-zA-Z0-9]))*)"
)
_RE_PORT = r":(?P<port>\d+)"
_RE_PATHNAME = r"(?P<path>((\~[\w\-\.]+)/)*?(((?P<owner>[\w\-\./]+?)/)?(?P<name>[\w\-\.]+)(\.git)?)?)/*"
_RE_PATHNAME_WITH_GITLAB = (
r"(?P<path>((((gitlab/){0,1}|([\w\-\~\.]+/)*?)(?P<owner>([\w\-\.]+/)*[\w\-\.]+)/)?"
r"(?P<name>[\w\-\.]+)(\.git)?)?)/*"
)
_RE_UNIXPATH = r"(file\://)?(?P<path>\/$|((?=\/)|\.|\.\.)(\/(?=[^/\0])[^/\0]+)*\/?)"
def _build(*parts):
"""Assemble the regex."""
return re.compile(r"^" + r"".join(parts) + r"$")
#: Define possible repository URLs.
_REPOSITORY_URLS = [
# https://user:pass@example.com/owner/repo.git
_build(_RE_SCHEME, _RE_USERNAME_PASSWORD, _RE_HOSTNAME, r"/", _RE_PATHNAME_WITH_GITLAB),
# https://user:pass@example.com:gitlab/owner/repo.git
_build(_RE_SCHEME, _RE_USERNAME_PASSWORD, _RE_HOSTNAME, _RE_PORT, r"/", _RE_PATHNAME_WITH_GITLAB),
# git@example.com:owner/repo.git
_build(_RE_USERNAME, _RE_HOSTNAME, r":", _RE_PATHNAME_WITH_GITLAB),
# /path/to/repo
_build(_RE_UNIXPATH),
]
[docs]@attr.s()
class GitURL:
"""Parser for common Git URLs."""
# Initial value
href = attr.ib()
path = attr.ib(default=None)
scheme = attr.ib(default="ssh")
hostname = attr.ib(default="localhost")
username = attr.ib(default=None)
password = attr.ib(default=None)
port = attr.ib(default=None)
owner = attr.ib(default=None)
name: Optional[str] = attr.ib(default=None, converter=normalize_git_url)
slug = attr.ib(default=None)
_regex = attr.ib(default=None, eq=False, order=False)
def __attrs_post_init__(self):
"""Derive basic information."""
if not self.name and self.path:
self.name = normalize_git_url(Path(self.path).name)
self.slug = normalize_to_ascii(self.name)
[docs] @classmethod
def parse(cls, href) -> "GitURL":
"""Derive URI components."""
if not is_ascii(href):
raise UnicodeError(f"`{href}` is not a valid Git remote")
url_regexes = _REPOSITORY_URLS
gitlab_url = os.environ.get("GITLAB_BASE_URL", None)
if gitlab_url:
# NOTE: use known gitlab url to simplify regex to make detection more robust
parsed_gitlab_url = urlparse(gitlab_url)
gitlab_re = _build(
_RE_SCHEME,
_RE_USERNAME_PASSWORD,
r"(?P<hostname>" + re.escape(parsed_gitlab_url.hostname) + ")", # type: ignore
r":(?P<port>" + str(parsed_gitlab_url.port) + ")" if parsed_gitlab_url.port else "",
r"/",
re.escape(parsed_gitlab_url.path) + r"/" if parsed_gitlab_url.path else "",
_RE_PATHNAME,
)
url_regexes = [gitlab_re] + url_regexes
for regex in url_regexes:
matches = re.search(regex, href)
if matches:
return cls(href=href, regex=regex, **matches.groupdict())
else:
raise errors.InvalidGitURL(f"`{href}` is not a valid Git URL")
@property
def instance_url(self):
"""Get the url of the git instance."""
url = urlparse(self.href)
path = self.path.split(self.owner, 1)[0]
url = url._replace(path=path)
return url.geturl()
@property
def image(self):
"""Return image name."""
img = self.hostname
if self.owner:
img += "/" + self.owner
if self.name:
img += "/" + self.name
return img