sapling/hgext3rd/rage.py

# Copyright 2014 Facebook Inc.
#
"""upload useful diagnostics and give instructions for asking for help

    [rage]
    # Name of the rpm binary
    rpmbin = rpm
"""

from functools import partial
from mercurial.i18n import _
from mercurial import (
    bookmarks,
    commands,
    debugcommands,
    encoding,
    error,
    registrar,
    util,
)
from mercurial import pycompat, scmutil
from hgext import blackbox
from hgext3rd import (
    smartlog,
    fbsparse as sparse,
)
from phabricator import (
    arcconfig,
    conduit,
)
import os, socket, re, tempfile, time, traceback

from remotefilelog import (
    constants,
    shallowutil
)

cmdtable = {}
command = registrar.command(cmdtable)

_failsafeerrors = []

def _failsafe(func):
    try:
        return func()
    except Exception as ex:
        index = len(_failsafeerrors) + 1
        message = "[%d]: %s\n%s\n" % (index, str(ex), traceback.format_exc())
        _failsafeerrors.append(message)
        return '(Failed. See footnote [%d])' % index

def shcmd(cmd, input=None, check=True, keeperr=True):
    _, _, _, p = util.popen4(cmd)
    out, err = p.communicate(input)
    if check and p.returncode:
        raise error.Abort(cmd + ' error: ' + err)
    elif keeperr:
        out += err
    return out

def createtask(ui, repo, defaultdesc):
    """FBONLY: create task for source control oncall"""
    prompt = '''Title: [hg rage] %s on %s by %s

Description:
%s

HG: Edit task title and description. Lines beginning with 'HG:' are removed."
HG: First line is the title followed by the description.
HG: Feel free to add relevant information.
''' % (repo.root, socket.gethostname(), encoding.environ.get('LOGNAME'),
       defaultdesc)

    text = re.sub("(?m)^HG:.*(\n|$)", "", ui.edit(prompt, ui.username()))
    lines = text.splitlines()
    title = re.sub("(?m)^Title:\s+", "", lines[0])
    desc = re.sub("(?m)^Description:\s+", "", '\n'.join(lines[1:]))
    tag = 'hg rage'
    oncall = 'source_control'
    taskid = shcmd(' '.join([
        'tasks',
        'create',
        '--title=' + util.shellquote(title),
        '--pri=low',
        '--assign=' + util.shellquote(oncall),
        '--sub=' + util.shellquote(oncall),
        '--tag=' + util.shellquote(tag),
        '--desc=' + util.shellquote(desc),
        ])
    )
    tasknum = shcmd('tasks view ' + taskid).splitlines()[0].split()[0]
    ui.write(
        _('Task created: https://our.intern.facebook.com/intern/tasks/?t=%s\n')
        % tasknum)

def which(name):
    """ """
    for p in encoding.environ.get('PATH', '/bin').split(pycompat.ospathsep):
        path = os.path.join(p, name)
        if os.path.exists(path):
            return path
    return None

rageopts = [('p', 'preview', None,
             _('print diagnostic information without doing arc paste'))]
if which('oncalls'):
    rageopts.append(('', 'oncall', None,
                     _('file a task for source control oncall')))

def localconfig(ui):
    result = []
    for section, name, value in ui.walkconfig():
        source = ui.configsource(section, name)
        if source.find('/etc/') == -1 and source.find('/default.d/') == -1:
            result.append('%s.%s=%s  # %s' % (section, name, value, source))
    return result

def obsoleteinfo(repo, hgcmd):
    """Return obsolescence markers that are relevant to smartlog revset"""
    unfi = repo.unfiltered()
    revs = scmutil.revrange(unfi, ["smartlog()"])
    hashes = '|'.join(unfi[rev].hex() for rev in revs)
    markers = hgcmd(debugcommands.debugobsolete, rev=[])
    pat = re.compile('(^.*(?:'+hashes+').*$)', re.MULTILINE)
    relevant = pat.findall(markers)
    return "\n".join(relevant)

def usechginfo():
    """FBONLY: Information about whether chg is enabled"""
    files = {
        'system': '/etc/mercurial/usechg',
        'user': os.path.expanduser('~/.usechg'),
    }
    result = []
    for name, path in files.items():
        if os.path.exists(path):
            with open(path) as f:
                value = f.read().strip()
        else:
            value = '(not set)'
        result.append('%s: %s' % (name, value))
    return '\n'.join(result)

def rpminfo(ui):
    """FBONLY: Information about RPM packages"""
    result = set()
    rpmbin = ui.config('rage', 'rpmbin', 'rpm')
    for name in ['hg', 'hg.real']:
        path = which(name)
        if not path:
            continue
        result.add(shcmd('%s -qf %s' % (rpmbin, path), check=False))
    return ''.join(result)

@command('^rage', rageopts , _('hg rage'))
def rage(ui, repo, *pats, **opts):
    """collect useful diagnostics for asking help from the source control team

    The rage command collects useful diagnostic information.

    By default, the information will be uploaded to Phabricator and
    instructions about how to ask for help will be printed.
    """

    def format(pair, basic=True):
        if basic:
            fmt = "%s: %s\n"
        else:
            fmt =  "%s:\n---------------------------\n%s\n"
        return fmt % pair

    def hgcmd(func, *args, **opts):
        _repo = repo
        if '_repo' in opts:
            _repo = opts['_repo']
            del opts['_repo']
        ui.pushbuffer(error=True)
        try:
            func(ui, _repo, *args, **opts)
        finally:
            return ui.popbuffer()

    if opts.get('oncall') and opts.get('preview'):
        raise error.Abort('--preview and --oncall cannot be used together')

    basic = [
        ('date', time.ctime()),
        ('unixname', encoding.environ.get('LOGNAME')),
        ('hostname', socket.gethostname()),
        ('repo location', _failsafe(lambda: repo.root)),
        ('active bookmark',
            _failsafe(lambda: bookmarks._readactive(repo, repo._bookmarks))),
        ('hg version', _failsafe(
            lambda: __import__('mercurial.__version__').__version__.version)),
        ('obsstore size', _failsafe(
            lambda: str(repo.vfs.stat('store/obsstore').st_size))),
    ]

    ui._colormode = None

    detailed = [
        ('df -h', _failsafe(lambda: shcmd('df -h', check=False))),
        # smartlog as the user sees it
        ('hg sl (filtered)', _failsafe(lambda: hgcmd(
            smartlog.smartlog, template='{hsl}'))),
        # unfiltered smartlog for recent hidden changesets
        ('hg sl (unfiltered)', _failsafe(lambda: hgcmd(
            smartlog.smartlog, _repo=repo.unfiltered(), template='{hsl}'))),
        ('first 20 lines of "hg status"',
            _failsafe(lambda:
                '\n'.join(hgcmd(commands.status).splitlines()[:20]))),
        ('hg blackbox -l60',
            _failsafe(lambda: hgcmd(blackbox.blackbox, limit=60))),
        ('hg summary', _failsafe(lambda: hgcmd(commands.summary))),
        ('hg config (local)', _failsafe(lambda: '\n'.join(localconfig(ui)))),
        ('hg sparse',
            _failsafe(
                lambda: hgcmd(
                    sparse.sparse, include=False, exclude=False, delete=False,
                    force=False, enable_profile=False, disable_profile=False,
                    refresh=False, reset=False, import_rules=False,
                    clear_rules=False))),
        ('usechg', _failsafe(usechginfo)),
        ('rpm info', _failsafe(partial(rpminfo, ui))),
        ('klist', _failsafe(lambda: shcmd('klist', check=False))),
        ('ifconfig', _failsafe(lambda: shcmd('ifconfig'))),
        ('airport', _failsafe(
            lambda: shcmd('/System/Library/PrivateFrameworks/Apple80211.' +
                          'framework/Versions/Current/Resources/airport ' +
                          '--getinfo', check=False))),
        ('hg debugobsolete <smartlog>',
            _failsafe(lambda: obsoleteinfo(repo, hgcmd))),
        ('hg config (all)', _failsafe(lambda: hgcmd(commands.config))),
    ]

    if util.safehasattr(repo, 'name'):
        # Add the contents of both local and shared pack directories.
        packlocs = {
            'local': lambda category: shallowutil.getlocalpackpath(
                repo.svfs.vfs.base, category),
            'shared': lambda category: shallowutil.getcachepackpath(repo,
                category),
        }

        for loc, getpath in packlocs.iteritems():
            for category in constants.ALL_CATEGORIES:
                path = getpath(category)
                detailed.append((
                    "%s packs (%s)" % (loc, constants.getunits(category)),
                    "%s:\n%s" %
                    (path, _failsafe(lambda: shcmd("ls -lh %s" % path)))
                ))

    # This is quite slow, so we don't want to do it by default
    if ui.configbool("rage", "fastmanifestcached", False):
        detailed.append(
            ('hg sl -r "fastmanifestcached()"',
                _failsafe(lambda: hgcmd(smartlog.smartlog,
                          rev=["fastmanifestcached()"]))),
        )

    msg = '\n'.join(map(format, basic)) + '\n' +\
          '\n'.join(map(lambda x: format(x, False), detailed))
    if _failsafeerrors:
        msg += '\n' + '\n'.join(_failsafeerrors)

    if opts.get('preview'):
        ui.write('%s\n' % msg)
        return

    timeout = ui.configint('ssl', 'timeout', 5)
    ca_certs = repo.ui.configpath('web', 'cacerts')

    pasteurl = None

    try:
        resp = conduit.call_conduit('paste.create', {
            'content': msg,
            'title': 'hg rage for %s' % _failsafe(lambda: repo.root),
            'language': 'hgrage'
        }, timeout=timeout, ca_certs=ca_certs)
        pasteurl = resp.get('uri')
    except arcconfig.ArcConfigError:
        ui.warn(_('arcconfig configuration problem.\n'))
    except conduit.ClientError:
        ui.warn(_('Error talking to phabricator.\n'))
    except ValueError:
        ui.warn(_('Bad response from phabricator.\n'))

    if pasteurl:
        if opts.get('oncall'):
            createtask(ui, repo, 'rage info: %s' % pasteurl)
        else:
            ui.write(_('Please post your problem and the following link at'
                       ' %s for help:\n%s\n')
                     % (ui.config('ui', 'supportcontact'), pasteurl))
    else:
        ui.warn(_('No paste was created.\n'))
        fd, tmpname = tempfile.mkstemp(prefix='hg-rage-')
        with os.fdopen(fd, r'w') as tmpfp:
            tmpfp.write(msg)
            ui.warn(_('Saved contents to %s\n') % tmpname)