creating Custom Reporter from ReporterBase

[npmitche]

Hi, I'm trying to create a custom reporter (currently just a dummy), but am running into an issue and can't find the solution:

Custom Reporter:

from twisted.internet import defer
from twisted.python import log as twlog

from buildbot import config
from buildbot.process.results import statusToString, SUCCESS, WARNINGS, FAILURE, SKIPPED, EXCEPTION, RETRY, CANCELLED
from buildbot.reporters import utils
from buildbot.reporters.base import ReporterBase

class TestReporter(ReporterBase):
    name = "TestReporter"


    @defer.inlineCallbacks
    def sendMessage(self, reports):
        report = reports[0]
        build = reports[0]['builds'][0]
        description = report.get('body', None)
        if build['complete']:
            state = {
                SUCCESS: False,
                WARNINGS: True,
                FAILURE: True,
                SKIPPED: False,
                EXCEPTION: True,
                RETRY: True,
                CANCELLED: True
            }.get(build['results'], True)
        else:
            state = False
        twlog.msg("TestReporter")
        twlog.msg(reports)

In my master.cfg:

import testreporter as tr
#.....
genTr = reporters.BuildStatusGenerator(mode='all', builders=["builder1"])
thisTr = tr.TestReporter(generators=[genTr])

c['services'].append(thisTr)

And when I run it, I get this:

2021-10-13 11:36:37-0700 [-] while starting BuildMaster
        Traceback (most recent call last):
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/internet/defer.py", line 654, in _runCallbacks
            current.result = callback(current.result, *args, **kw)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/internet/defer.py", line 1475, in gotResult
            _inlineCallbacks(r, g, status)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/internet/defer.py", line 1416, in _inlineCallbacks
            result = result.throwExceptionIntoGenerator(g)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/python/failure.py", line 512, in throwExceptionIntoGenerator
            return g.throw(self.type, self.value, self.tb)
        --- <exception caught here> ---
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/buildbot/master.py", line 300, in startService
            yield self.reconfigServiceWithBuildbotConfig(self.config)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/internet/defer.py", line 1416, in _inlineCallbacks
            result = result.throwExceptionIntoGenerator(g)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/python/failure.py", line 512, in throwExceptionIntoGenerator
            return g.throw(self.type, self.value, self.tb)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/buildbot/util/service.py", line 49, in reconfigServiceWithBuildbotConfig
            yield svc.reconfigServiceWithBuildbotConfig(new_config)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/internet/defer.py", line 1416, in _inlineCallbacks
            result = result.throwExceptionIntoGenerator(g)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/python/failure.py", line 512, in throwExceptionIntoGenerator
            return g.throw(self.type, self.value, self.tb)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/buildbot/util/service.py", line 502, in reconfigServiceWithBuildbotConfig
            child.name, class_name)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/internet/defer.py", line 1416, in _inlineCallbacks
            result = result.throwExceptionIntoGenerator(g)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/python/failure.py", line 512, in throwExceptionIntoGenerator
            return g.throw(self.type, self.value, self.tb)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/buildbot/db/pool.py", line 246, in do
            args, kwargs)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/python/threadpool.py", line 250, in inContext
            result = inContext.theWork()
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/python/threadpool.py", line 266, in <lambda>
            inContext.theWork = lambda: context.call(ctx, func, *args, **kw)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/python/context.py", line 122, in callWithContext
            return self.currentContext().callWithContext(ctx, func, *args, **kw)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/twisted/python/context.py", line 85, in callWithContext
            return func(*args,**kw)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/buildbot/db/pool.py", line 207, in __thd
            rv = callable(arg, *args, **kwargs)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/buildbot/db/state.py", line 48, in thd
            return self.thdGetObjectId(conn, name, class_name)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/buildbot/db/state.py", line 78, in thdGetObjectId
            return ObjDict(id=select())
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/buildbot/db/state.py", line 61, in select
            res = conn.execute(q)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/sqlalchemy/engine/base.py", line 982, in execute
            return meth(self, multiparams, params)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/sqlalchemy/sql/elements.py", line 287, in _execute_on_connection
            return connection._execute_clauseelement(self, multiparams, params)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/sqlalchemy/engine/base.py", line 1101, in _execute_clauseelement
            distilled_params,
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/sqlalchemy/engine/base.py", line 1250, in _execute_context
            e, statement, parameters, cursor, context
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/sqlalchemy/engine/base.py", line 1476, in _handle_dbapi_exception
            util.raise_from_cause(sqlalchemy_exception, exc_info)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/sqlalchemy/util/compat.py", line 398, in raise_from_cause
            reraise(type(exception), exception, tb=exc_tb, cause=cause)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/sqlalchemy/util/compat.py", line 152, in reraise
            raise value.with_traceback(tb)
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/sqlalchemy/engine/base.py", line 1246, in _execute_context
            cursor, statement, parameters, context
          File "~/tmp/bb-master/sandbox/lib/python3.6/site-packages/sqlalchemy/engine/default.py", line 581, in do_execute
            cursor.execute(statement, parameters)
        sqlalchemy.exc.InterfaceError: (sqlite3.InterfaceError) Error binding parameter 0 - probably unsupported type.
        [SQL: SELECT objects.id
        FROM objects
        WHERE objects.name = ? AND objects.class_name = ?]
        [parameters: (('TestReporter',), 'testreporter.TestReporter')]
        (Background on this error at: http://sqlalche.me/e/rvf5)

2021-10-13 11:36:37-0700 [-] BuildMaster startup failed
2021-10-13 11:36:37-0700 [-] Initiating clean shutdown
2021-10-13 11:36:37-0700 [-] No running jobs, starting shutdown immediately
2021-10-13 11:36:37-0700 [-] BuildMaster is stopped
2021-10-13 11:36:37-0700 [-] Main loop terminated.
2021-10-13 11:36:37-0700 [-] Server Shut Down.

It looks like I need to register my reporter with the database, but I can't seem to find documentation on how to do that. Any help would be appreciated.

[npmitche]

I found a stray , in my code and when I removed it, the error disappeared. 🤦🏼‍♂️

[tardyp]

the mighty 3 pixels that change your value into a tuple :)