view frontends/src/jp/cmd_debug.py @ 2420:03da3ef5fb5b

plugin tickets: added ticketsSet and ticketsSchemaGet methods: those methods are high level methods specialised for tickets. ticketsSet will use default tickets node if node is not set, set "created" and "updated" fields, create comments node if the ticket is new, and associate it with "comments_uri" field. ticketsSchemaGet is like getUISchema with node defaulting to tickets default node.
author Goffi <goffi@goffi.org>
date Sun, 05 Nov 2017 15:36:06 +0100
parents 192ae573901a
children e86dc8cb4345
line wrap: on
line source

#!/usr/bin/env python2
# -*- coding: utf-8 -*-

# jp: a SàT command line tool
# Copyright (C) 2009-2017 Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.


import base
from sat.core.i18n import _
from sat_frontends.jp.constants import Const as C
from sat.tools.common.ansi import ANSI as A
import json

__commands__ = ["Debug"]


class BridgeCommon(object):

    def evalArgs(self):
        if self.args.arg:
            try:
                return eval(u'[{}]'.format(u",".join(self.args.arg)))
            except SyntaxError as e:
                self.disp(u"Can't evaluate arguments: {mess}\n{text}\n{offset}^".format(
                    mess=e,
                    text=e.text.decode('utf-8'),
                    offset=u" "*(e.offset-1)
                    ), error=True)
                self.host.quit(C.EXIT_BAD_ARG)
        else:
            return []


class Method(base.CommandBase, BridgeCommon):

    def __init__(self, host):
        base.CommandBase.__init__(self, host, 'method', help=_(u'call a bridge method'))
        BridgeCommon.__init__(self)
        self.need_loop=True

    def add_parser_options(self):
        self.parser.add_argument("method", type=str, help=_(u"name of the method to execute"))
        self.parser.add_argument("arg", type=base.unicode_decoder, nargs="*", help=_(u"argument of the method"))

    def method_cb(self, ret=None):
        if ret is not None:
            self.disp(unicode(ret))
        self.host.quit()

    def method_eb(self, failure):
        self.disp(_(u"Error while executing {}: {}".format(self.args.method, failure)), error=True)
        self.host.quit(C.EXIT_ERROR)

    def start(self):
        method = getattr(self.host.bridge, self.args.method)
        args = self.evalArgs()
        try:
            method(*args, profile=self.profile, callback=self.method_cb, errback=self.method_eb)
        except TypeError:
            # maybe the method doesn't need a profile ?
            try:
                method(*args, callback=self.method_cb, errback=self.method_eb)
            except TypeError:
                self.method_eb(_(u"bad arguments"))


class Signal(base.CommandBase, BridgeCommon):

    def __init__(self, host):
        base.CommandBase.__init__(self, host, 'signal', help=_(u'send a fake signal from backend'))
        BridgeCommon.__init__(self)

    def add_parser_options(self):
        self.parser.add_argument("signal", type=str, help=_(u"name of the signal to send"))
        self.parser.add_argument("arg", type=base.unicode_decoder, nargs="*", help=_(u"argument of the signal"))

    def start(self):
        args = self.evalArgs()
        json_args = json.dumps(args)
        # XXX: we use self.args.profile and not self.profile
        #      because we want the raw profile_key (so plugin handle C.PROF_KEY_NONE)
        self.host.bridge.debugFakeSignal(self.args.signal, json_args, self.args.profile)


class Bridge(base.CommandBase):
    subcommands = (Method, Signal)

    def __init__(self, host):
        super(Bridge, self).__init__(host, 'bridge', use_profile=False, help=_('bridge s(t)imulation'))


class Monitor(base.CommandBase):

    def __init__(self, host):
        super(Monitor, self).__init__(host,
                                      'monitor',
                                      use_verbose=True,
                                      use_profile=False,
                                      use_output=C.OUTPUT_XML,
                                      help=_('monitor XML stream'))
        self.need_loop = True

    def add_parser_options(self):
        self.parser.add_argument("-d", "--direction", choices=('in', 'out', 'both'), default='both', help=_(u"stream direction filter"))

    def printXML(self, direction, xml_data, profile):
        if self.args.direction == 'in' and direction != 'IN':
            return
        if self.args.direction == 'out' and direction != 'OUT':
            return
        verbosity = self.host.verbosity
        if not xml_data.strip():
            if verbosity <= 2:
                return
            whiteping = True
        else:
            whiteping = False

        if verbosity:
            profile_disp = u' ({})'.format(profile) if verbosity>1 else u''
            if direction == 'IN':
                self.disp(A.color(A.BOLD, A.FG_YELLOW, '<<<===== IN ====', A.FG_WHITE, profile_disp))
            else:
                self.disp(A.color(A.BOLD, A.FG_CYAN, '==== OUT ====>>>', A.FG_WHITE, profile_disp))
        if whiteping:
            self.disp('[WHITESPACE PING]')
        else:
            self.output(xml_data)

    def start(self):
        self.host.bridge.register_signal('xmlLog', self.printXML, 'plugin')


class Debug(base.CommandBase):
    subcommands = (Bridge, Monitor)

    def __init__(self, host):
        super(Debug, self).__init__(host, 'debug', use_profile=False, help=_('debugging tools'))