Как я могу предупредить чаты Skype со статусом сборки Jenkins?
наша компания использует Skype для связи, и я хотел бы иметь возможность отправлять оповещения в чаты Skype, когда сборка Jenkins терпит неудачу (и когда она восстанавливается).
Как я могу это сделать?
3 ответов
Я сделал это с помощью Skype Public API
то, что я сделал, это написать сценарий Perl, который использует SkypeAPI модуль CPAN для обработки сообщений со Skype. Это немного неуклюже, так как скрипт должен работать на рабочем столе, на котором работает Skype. Я запускаю его на своем рабочем столе, который всегда включен, но это означает, что бот кажется "мной" для остальной части нашей команды.
конечный результат фантастический-всякий раз, когда Дженкинс build изменяет состояние, бот отправляет сообщение в любые чаты Skype, которые зарегистрировали интерес, введя * alert. Кроме того, любой разработчик может увидеть и поделиться последним статусом сборки, введя *jenkins
Шаг 1-расширение модуля SkypeAPI
теперь модуль SkypeAPI довольно прост. Он имеет цикл сообщений в методе listen (), который проверяет наличие новых событий от клиента Skype и спит на мгновение, если их нет.
Я хотел, чтобы мой скрипт чтобы подключиться к этому циклу, чтобы мой бот периодически проверял RSS-канал Дженкинса, поэтому я сделал следующие изменения в SkypeAPI.pm после того, как я установил его с помощью диспетчера пакетов ActiveState:
я объявил новое свойство "idler" вместе с существующими свойствами...
__PACKAGE__->mk_accessors(
qw/api handler_list stop_listen idler/
);
я добавил метод для установки обратного вызова "idler", который модуль будет вызывать вместо сна
sub register_idler {
my $self = shift;
my $ref_sub = shift;
$self->idler($ref_sub);
}
наконец, я изменил цикл сообщений, чтобы вызвать зеваку, если set
sub listen {
my $self = shift;
my $idler=$self->idler();
$self->stop_listen(0);
while (!$self->stop_listen) {
my $message;
{
lock @message_list;
$message = shift @message_list;
}
if (not defined $message) {
if ($idler)
{
$self->idler->($self);
}
else
{
sleep 0.1;
}
next;
}
for my $id (sort keys %{$self->handler_list}) {
$self->handler_list->{$id}->($self, $message);
}
}
}
Шаг 2-написать сценарий робота
теперь модуль немного более способен, это просто вопрос написания сценария, чтобы действовать как бот. Вот мой - я сделал несколько изменений из моего оригинала, поскольку он содержал другие нерелевантные функции, но это должно дать вам отправную точку.
все зависимые модули могут быть установлены с помощью диспетчера пакетов ActiveState.
use strict;
use SkypeAPI;
use LWP::Simple;
use Data::Dumper;
use dirtyRSS;
use Time::Local 'timegm';
use Math::Round;
use Storable;
#CHANGE THIS - where to get jenkins status from
my $jenkinsRss='http://username:password@jenkins.example.com/rssLatest';
my %commands=(
'jenkins' =>\&cmdJenkins,
'alert' =>\&cmdAlert,
'noalert' =>\&cmdNoAlert,
'help' =>\&cmdHelp,
);
my $helpMessage=<<HELP;
Who asked for help? Here's all the other special commands I know...
*jenkins - show status of our platform tests
*alert - add this room to get automatic notification of build status
*noalert - cancel notifcations
*help - displays this message
HELP
#status for jenkins tracking
my %builds;
my $lastJenkinsCheck=0;
my $alertRoomsFile='alert.rooms';
my $alertRooms={};
#store jenkins state
checkJenkins();
#because that was our first fetch, we'll have flagged everything as changed
#but it hasn't really, so we reset those flags
resetJenkinsChangeFlags();
#remember rooms we're supposed to alert
loadAlertRooms();
#attach to skype and enter message loop
my $skype = SkypeAPI->new();
my $attached=$skype->attach();
$skype->register_handler(\&onEvent);
$skype->register_idler(\&onIdle);
$skype->listen();
exit;
#here are the command handlers
sub cmdJenkins
{
my ($chatId, $args)=@_;
my $message="";
foreach my $build (keys(%builds))
{
$message.=formatBuildMessage($build)."\n";
#reset changed flag - we've just show the status
$builds{$build}->{'changed'}=0;
}
chatmessage($chatId, $message);
}
sub cmdAlert
{
my ($chatId, $args)=@_;
addChatroomToAlerts($chatId,1);
}
sub cmdNoAlert
{
my ($chatId, $args)=@_;
addChatroomToAlerts($chatId,0);
}
sub cmdHelp
{
my ($chatId, $args)=@_;
chatmessage($chatId, $helpMessage);
}
#simple helper to transmit a message to a specific chatroom
sub chatmessage
{
my ($chatId, $message)=@_;
my $commandstr="CHATMESSAGE $chatId $message";
my $command = $skype->create_command( { string => $commandstr} );
$skype->send_command($command);
}
#refreshes our copy of jenkins state, and will flag any builds
#which have changed state since the last check
sub checkJenkins{
my $xml = get($jenkinsRss);
my $tree = parse($xml);
my $items=$tree->{'channel'}->[0]->{'item'};
foreach my $item (@{$items})
{
my $title=$item->{'title'};
my $link=$item->{'link'};
my $built=$item->{'lastbuilddate'};
#print Dumper($item);
if ($title=~m/^(.*?) #(\d+)\s*(.*)$/)
{
my $build=;
my $buildnumber=;
my $status=;
#print "$build\n$buildnumber\n$status\n$link\n$built\n\n";
#build in progress, ignore
if (!exists($builds{$build}))
{
$builds{$build}={};
$builds{$build}->{'status'}='';
$builds{$build}->{'changed'}=0;
}
$builds{$build}->{'name'}=$build;
if ($status eq '(?)')
{
$builds{$build}->{'in_progress'}=1;
next; #don't update until complete
}
else
{
$builds{$build}->{'in_progress'}=0;
}
#is this status different to last status?
if ($builds{$build}->{'status'} ne $status)
{
$builds{$build}->{'changed'}=1;
}
$builds{$build}->{'status'}=$status;
$builds{$build}->{'build_number'}=$buildnumber;
$builds{$build}->{'link'}=$link;
$builds{$build}->{'built'}=$built;
}
}
#print Dumper(\%builds);
}
#generates a string suitable for displaying build status in skype
sub formatBuildMessage
{
my ($build)=@_;
my $status=$builds{$build}->{'status'};
my $smiley=":)";
if ($status=~m/broken/)
{
$smiley="(devil)";
}
elsif ($status=~m/\?/)
{
#this means the build is being retested, we should skip it
$smiley=":|";
}
my $message='';
if ($builds{$build}->{'in_progress'})
{
$message=":| $build - rebuild in progress..."
}
else
{
my ($y,$mon,$d,$h,$m,$s) = $builds{$build}->{'built'} =~ m/(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)Z/;
my $time = timegm($s,$m,$h,$d,$mon-1,$y);
my $age=time()-$time;
my $mins=round($age/60);
my $hrs=round($age/3600);
my $days=round($age/86400);
my $niceage;
if ($mins<=2)
{
$niceage="a few moments ago";
}
elsif ($mins<120)
{
$niceage="$mins minutes ago";
}
elsif ($hrs<48)
{
$niceage="$hrs hours ago";
}
else
{
$niceage="$days days ago";
}
$message="$smiley $build last built $niceage $status";
}
return $message;
}
#forget any changes we've flagged
sub resetJenkinsChangeFlags
{
foreach my $build (keys(%builds))
{
$builds{$build}->{'changed'}=0;
}
}
#checks for builds which have changed state. Can be called
#often, it will only kick in if 60 seconds have elapsed since
#last check
sub checkForJenkinsChanges
{
my $now=time();
if (($now-$lastJenkinsCheck) < 60)
{
#no need, we fetched it recently
return;
}
checkJenkins();
my $message='';
foreach my $build (keys(%builds))
{
if ($builds{$build}->{'changed'})
{
$builds{$build}->{'changed'}=0;
$message.=formatBuildMessage($build)."\n";
}
}
if (length($message))
{
foreach my $chatId (keys(%$alertRooms))
{
chatmessage($chatId, $message);
}
}
$lastJenkinsCheck=$now;
}
#adds or removes a room from the alerts
sub addChatroomToAlerts
{
my($chatId, $add)=@_;
if ($add)
{
if (exists($alertRooms->{$chatId}))
{
chatmessage($chatId, "/me says this room is already getting alerts");
}
else
{
$alertRooms->{$chatId}=1;
chatmessage($chatId, "/me added this chatroom to jenkins alerts");
}
}
else
{
delete($alertRooms->{$chatId});
chatmessage($chatId, "/me removed this chatroom from jenkins alerts");
}
store $alertRooms, $alertRoomsFile;
}
sub loadAlertRooms
{
if (-e $alertRoomsFile)
{
$alertRooms = retrieve( $alertRoomsFile);
}
}
# Skype event handler
sub onEvent {
my $skype = shift;
my $msg = shift;
#my $command = $skype->create_command( { string => "GET USERSTATUS"} );
#print $skype->send_command($command) , "\n";
#print "handler: $msg\n";
#an inbound chat message is either
#MESSAGE 13021257 STATUS RECEIVED (from others)
#MESSAGE 13021257 STATUS SENT (from us)
if ($msg =~ m/MESSAGE (\d+) STATUS (SEND|RECEIVED)/)
{
my $msgId=;
#get message body
my $commandstr="GET CHATMESSAGE $msgId BODY";
my $command = $skype->create_command( { string => $commandstr} );
my $output=$skype->send_command($command);
#if its a message for us...
if ($output =~ m/MESSAGE $msgId BODY \*([^\s]*)\s*(.*)/i)
{
my $botcmd=;
my $botargs=;
$commandstr="GET CHATMESSAGE $msgId CHATNAME";
$command = $skype->create_command( { string => $commandstr} );
$output=$skype->send_command($command);
if ($output =~ m/MESSAGE $msgId CHATNAME (.*)/)
{
my $chatId=;
if (exists($commands{$botcmd}))
{
$commands{$botcmd}->($chatId, $botargs);
}
else
{
chatmessage($chatId, "/me suggests trying *help as the robot didn't understand *$botcmd");
}
}
}
}
}
#skype idle handler
#Note - SkypeAPI.pm was modified to support this
sub onIdle {
my $skype = shift;
checkForJenkinsChanges();
sleep 0.1;
}
Шаг 3 - запустите бота
если вы сохранили это как robot.pl, просто откройте окно консоли и perl robot.pl
должен запустить его. Skype спросит вас, если perl.exe должно быть разрешено общаться с ним, и как только вы подтвердите это, вы хорошо идти!
зайдите в чат команды и введите *jenkins
для резюме последних сборок и зарегистрировать комнату для предупреждений об изменениях сборки с *alert
замечательно :)
хотя ответ, приведенный выше, является рабочим решением, я думаю, что это немного старый, и никакие инструменты не были доступны в то время, когда был задан вопрос. Существует плагин, доступный для Jenkins для интеграции с skype:https://wiki.jenkins-ci.org/display/JENKINS/Skype + плагин
этот плагин может использоваться для отправки уведомлений конкретному пользователю или групповому чату. Я использую его некоторое время, и он отлично работает. Я в основном использую Linux-серверы для своих серверов Jenkins и у меня есть выделенный сервер windows с установленным skype и вошел в систему как пользователь бота. Единственная конфигурация нужна для работы Skype в раба-это лейбл под названием "скайп". С помощью этой метки Дженкинс обнаружит ведомое и направит уведомление skype этому ведомому устройству.
можно использовать Sevabot (https://sevabot-skype-bot.readthedocs.org/) проект для настройки интерфейса на основе HTTP для Skype, а затем использовать плагин уведомлений Дженкина:
пример:https://sevabot-skype-bot.readthedocs.org/en/latest/jenkins.html