# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this,
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
from pathlib
import Path
from typing
import (
Optional,
Union,
)
from mozversioncontrol.errors
import (
InvalidRepoPath,
MissingConfigureInfo,
MissingVCSInfo,
MissingVCSTool,
)
from mozversioncontrol.repo.git
import GitRepository
from mozversioncontrol.repo.mercurial
import HgRepository
from mozversioncontrol.repo.source
import SrcRepository
def get_repository_object(
path: Optional[Union[str, Path]], hg=
"hg", git=
"git", src=
"src"
):
"""Get a repository object for the repository at `path`.
If `path`
is not a known VCS repository,
raise an exception.
"""
# If we provide a path to hg that does not match the on-disk casing (e.g.,
# because `path` was normcased), then the hg fsmonitor extension will call
# watchman with that path and watchman will spew errors.
path = Path(path).resolve()
if (path /
".hg").is_dir():
return HgRepository(path, hg=hg)
elif (path /
".git").exists():
return GitRepository(path, git=git)
elif (path /
"config" /
"milestone.txt").exists():
return SrcRepository(path, src=src)
else:
raise InvalidRepoPath(f
"Unknown VCS, or not a source checkout: {path}")
def get_repository_from_build_config(config):
"""Obtain a repository from the build configuration.
Accepts an object that has a ``topsrcdir``
and ``subst`` attribute.
"""
flavor = config.substs.get(
"VCS_CHECKOUT_TYPE")
# If in build mode, only use what configure found. That way we ensure
# that everything in the build system can be controlled via configure.
if not flavor:
raise MissingConfigureInfo(
"could not find VCS_CHECKOUT_TYPE "
"in build config; check configure "
"output and verify it could find a "
"VCS binary"
)
if flavor ==
"hg":
return HgRepository(Path(config.topsrcdir), hg=config.substs[
"HG"])
elif flavor ==
"git":
return GitRepository(Path(config.topsrcdir), git=config.substs[
"GIT"])
elif flavor ==
"src":
return SrcRepository(Path(config.topsrcdir), src=config.substs[
"SRC"])
else:
raise MissingVCSInfo(
"unknown VCS_CHECKOUT_TYPE value: %s" % flavor)
def get_repository_from_env():
"""Obtain a repository object by looking at the environment.
If inside a build environment (denoted by presence of a ``buildconfig``
module), VCS info
is obtained
from it,
as found via configure. This allows
us to respect what was passed into configure. Otherwise, we fall back to
scanning the filesystem.
"""
try:
import buildconfig
return get_repository_from_build_config(buildconfig)
except (ImportError, MissingVCSTool):
pass
paths_to_check = [Path.cwd(), *Path.cwd().parents]
for path
in paths_to_check:
try:
return get_repository_object(path)
except InvalidRepoPath:
continue
raise MissingVCSInfo(f
"Could not find Mercurial or Git checkout for {Path.cwd()}")
