518dcf8bdb
There are a few pieces of information that are useful to know in the web
layer.
websocket_url is a config setting that, if set, is needed by the
console streaming. We currently pass this in appended to the streaming
url as a url parameter (which since it's a URL is a bit extra odd)
The endpoint is normally relative to the webapp,
but may need to be overridden in cases like publishing the html and
javascript to a disconnected location such as the draft output into the
log server in openstack or publishing built html/javascript to swift.
Add WebInfo and TenantWebInfo objects and corresponding /info and
/{tenant}/info routes. As an alternative, we could collapse WebInfo
and TenantWebInfo to just WebInfo and leave the tenant field set to None
for the /info route.
Some of the API functions are optionally provided by
plugins. The github plugin provides webhook URLs and the SQLReporter
plugin is needed for the builds endpoints. Add a Capabilities object
that can report on the existance of such things and pass it to plugin
route registration so that capabilities can be registered.
Add support for configuring stats_url
The old zuul status page had sparklines and other graphs on it, which
are not present in the current one because the graphite server wasn't
parameterized.
Add a config setting allowing a URL to a graphite server to be set and
expose that in the /info endpoint. Since statsd itself can emit to multiple
different backends, add a setting for the type of server, defaulting to
graphite.
Change-Id: I606a3b2cdf03cb73aa3ffd69d9d64c171b23b97a
107 lines
4.1 KiB
Python
107 lines
4.1 KiB
Python
# Copyright 2014 Rackspace Australia
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import abc
|
|
|
|
|
|
class BaseConnection(object, metaclass=abc.ABCMeta):
|
|
"""Base class for connections.
|
|
|
|
A connection is a shared object that sources, triggers and reporters can
|
|
use to speak with a remote API without needing to establish a new
|
|
connection each time or without having to authenticate each time.
|
|
|
|
Multiple instances of the same connection may exist with different
|
|
credentials, for example, thus allowing for different pipelines to operate
|
|
on different Gerrit installations or post back as a different user etc.
|
|
|
|
Connections can implement their own public methods. Required connection
|
|
methods are validated by the {trigger, source, reporter} they are loaded
|
|
into. For example, a trigger will likely require some kind of query method
|
|
while a reporter may need a review method."""
|
|
|
|
def __init__(self, driver, connection_name, connection_config):
|
|
# connection_name is the name given to this connection in zuul.ini
|
|
# connection_config is a dictionary of config_section from zuul.ini for
|
|
# this connection.
|
|
# __init__ shouldn't make the actual connection in case this connection
|
|
# isn't used in the layout.
|
|
self.driver = driver
|
|
self.connection_name = connection_name
|
|
self.connection_config = connection_config
|
|
|
|
def logEvent(self, event):
|
|
self.log.debug(
|
|
'Scheduling event from {connection}: {event}'.format(
|
|
connection=self.connection_name,
|
|
event=event))
|
|
try:
|
|
if self.sched.statsd:
|
|
self.sched.statsd.incr(
|
|
'zuul.event.{driver}.{event}'.format(
|
|
driver=self.driver.name, event=event.type))
|
|
self.sched.statsd.incr(
|
|
'zuul.event.{driver}.{connection}.{event}'.format(
|
|
driver=self.driver.name,
|
|
connection=self.connection_name,
|
|
event=event.type))
|
|
except Exception:
|
|
self.log.exception("Exception reporting event stats")
|
|
|
|
def onLoad(self):
|
|
pass
|
|
|
|
def onStop(self):
|
|
pass
|
|
|
|
def registerScheduler(self, sched):
|
|
self.sched = sched
|
|
|
|
def maintainCache(self, relevant):
|
|
"""Make cache contain relevant changes.
|
|
|
|
This lets the user supply a list of change objects that are
|
|
still in use. Anything in our cache that isn't in the supplied
|
|
list should be safe to remove from the cache."""
|
|
|
|
def getWebHandlers(self, zuul_web, info):
|
|
"""Return a list of web handlers to register with zuul-web.
|
|
|
|
:param zuul.web.ZuulWeb zuul_web:
|
|
Zuul Web instance.
|
|
:param zuul.model.WebInfo info:
|
|
The WebInfo object for the Zuul Web instance. Can be used by
|
|
plugins to toggle API capabilities.
|
|
:returns: List of `zuul.web.handler.BaseWebHandler` instances.
|
|
"""
|
|
return []
|
|
|
|
def validateWebConfig(self, config, connections):
|
|
"""Validate config and determine whether to register web handlers.
|
|
|
|
By default this method returns False, which means this connection
|
|
has no web handlers to register.
|
|
|
|
If the method returns True, then its `getWebHandlers` method
|
|
should be called during route registration.
|
|
|
|
If there is a fatal error, the method should raise an exception.
|
|
|
|
:param config:
|
|
The parsed config object.
|
|
:param zuul.lib.connections.ConnectionRegistry connections:
|
|
Registry of all configured connections.
|
|
"""
|
|
return False
|