Source code

Revision control

Other Tools

# 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
"""module for tooltool operations"""
from __future__ import absolute_import
import os
import sys
from mozharness.base.errors import PythonErrorList
from mozharness.base.log import ERROR, FATAL
TooltoolErrorList = PythonErrorList + [{"substr": "ERROR - ", "level": ERROR}]
_here = os.path.abspath(os.path.dirname(__file__))
_external_tools_path = os.path.normpath(
os.path.join(_here, "..", "..", "external_tools")
class TooltoolMixin(object):
"""Mixin class for handling tooltool manifests.
To use a tooltool server other than the Mozilla server, set
TOOLTOOL_HOST in the environment. To specify a different authentication
file than that used in releng automation,override
config['tooltool_authentication_file']; set it to None to not pass
any authentication information (OK for public files)
def _get_auth_file(self):
# set the default authentication file based on platform; this
# corresponds to where puppet puts the token
if "tooltool_authentication_file" in self.config:
fn = self.config["tooltool_authentication_file"]
elif self._is_windows():
fn = r"c:\builds\relengapi.tok"
fn = "/builds/relengapi.tok"
# if the file doesn't exist, don't pass it to tooltool (it will just
# fail). In taskcluster, this will work OK as the relengapi-proxy will
# take care of auth. Everywhere else, we'll get auth failures if
# necessary.
if os.path.exists(fn):
return fn
def tooltool_fetch(self, manifest, output_dir=None, privileged=False, cache=None):
"""docstring for tooltool_fetch"""
if cache is None:
cache = os.environ.get("TOOLTOOL_CACHE")
for d in (output_dir, cache):
if d is not None and not os.path.exists(d):
if self.topsrcdir:
cmd = [
os.path.join(self.topsrcdir, "mach"),
cmd = [
os.path.join(_external_tools_path, ""),
# handle authentication file, if given
auth_file = self._get_auth_file()
if auth_file and os.path.exists(auth_file):
cmd.extend(["--authentication-file", auth_file])
if self.topsrcdir:
cmd.extend(["--tooltool-manifest", manifest])
["--artifact-manifest", os.path.join(self.topsrcdir, "toolchains.json")]
cmd.extend(["fetch", "-m", manifest, "-o"])
if cache:
cmd.extend(["--cache-dir" if self.topsrcdir else "-c", cache])
toolchains = os.environ.get("MOZ_TOOLCHAINS")
if toolchains:
if not self.topsrcdir:
raise Exception(
"MOZ_TOOLCHAINS is not supported for tasks without "
"a source checkout."
timeout = self.config.get("tooltool_timeout", 10 * 60)
"cwd": output_dir,
"error_list": TooltoolErrorList,
"privileged": privileged,
"output_timeout": timeout,
error_message="Tooltool %s fetch failed!" % manifest,
def create_tooltool_manifest(self, contents, path=None):
"""Currently just creates a manifest, given the contents.
We may want a template and individual values in the future?
if path is None:
dirs = self.query_abs_dirs()
path = os.path.join(dirs["abs_work_dir"], "")
self.write_to_file(path, contents, error_level=FATAL)
return path