Siren of Shame

Tuesday, February 7, 2017

Released: Siren of Shame 2.4

Version 2.4 has a huge number of features and bug fixes since 2.3. Here are highlights:

Custom Avatars!

Custom avatars has been the #1 requested feature (usually predicated with "whoever thought of cat and dog avatars should be shot").

You can now add custom images by clicking a person and then "change" on the left:

Then the new picker dialog gives two additional choices. Gravatar, which requires an e-mail address:

And Custom which allows selecting images on disk, from a url, or from Active Directory. In all cases images will be resized and possibly stretched if they are not already square.

Import avatars en-mass from AD

Theoretically you can now import avatars for all of your users if active directory contains images. Do this from settings.

However, users have seen mixed results. If you have an active directory with images we would greatly appreciate your help in flushing out this feature.

New Full Screen Mode

Alt-F (or "Full Screen" from the ribbon) now gives you a lot more information:

If everything is too small by default we now have:

Ability to zoom

Ctrl+ and Ctrl- will zoom nearly everything (currently excluding avatars) which is super handy when projecting to a dedicated screen, although it works in normal mode too. Ctrl-0 will reset to normal. On that topic:

Ability to start in full screen mode

This long time feature request is handy for dedicated machines that project build info. Get to it in settings.

TFS 2015 Support and New Build Definitions

This is a completely new server type that uses the new TFS REST API and supports the new non-XAML based build definitions.

If you're using Visual Studio Team Services (Visual Studio Online) you probably need to generate a Personal Access Token for authentication, more details in a future blog post.

Support for AppVeyor CI Servers

Through a generous contribution from from jezzsantos.

And Some Other Stuff

Replaced all unencrypted server communication with https
Added rank indicator to list of leaders (thanks to Johan Olsson)
Support for Team City 10.0.4 (thanks to iamkrillin)
Adds a maximize button (different from full-screen)
App now shows in taskbar when not minimized

And Some Bug Fixes

Fixed issue where sos tries to update itself after every reboot
Resolved Issue #67 where leaders where getting duplicated
Fixed bug with long running reputation resets conflicting with in-progress builds
Fixed issue where opening and closing settings dialog would show stale build info
Fixed bug in (older) TFS dialog where checking project or project collection didn't check build definitions
Team city builds that have been deleted on the server can now be removed by editing the server configuration
Fixes Issue #68 - Manually triggered builds in TeamCity had no-one associated with them (generously contributed by @iamkrillin)

Summary

We hope you'll download and try out the new version today. Let us know what you think in the comments, on twitter, or on facebook.

Monday, May 30, 2016

New Nuget Package for Custom UWP Siren Apps

We just release a new SirenOfShame.Device nuget package for controlling sirens from Universal Windows Platform (UWP) projects. Between that and the new cross platform soscmd.jar capability we released last week, and the original device api, there's no reason not to build that siren-based bathroom timer you've always wanted for your office.

What's cool about our new UWP support is that you can now build apps for a wide range of devices including Windows PC's, tablets, (phones?), Raspberry Pi's running Windows IoT, and even XBox (!). In fact, the first person that successfully runs a siren from an XBox gets a free mug (tweet us).

The documentation is in the GitHub project, but at the moment it looks something like the following.

Getting Started

To create your own custom siren of shame device software:

In Visual Studio Create new Universal Windows Platform project
In Nuget Package Manager:

Install-Package SirenOfShame.Device

Add the following to the Package.appxmanifest:

<Capabilities>
  <DeviceCapability Name="humaninterfacedevice">
    <Device Id="vidpid:16D0 0646">
      <Function Type="usage:FF9C 0001"/>
    </Device>
  </DeviceCapability>
</Capabilities>

Instantiate a SirenOfShameDevice, subscribe to Connected, try turning on the led's like this:

public MainPage() {
  _sirenOfShameDevice = new SirenOfShameDevice();
  _sirenOfShameDevice.Connected += SirenOfShameDeviceOnConnected;
}
private async void SirenOfShameDeviceOnConnected(
  object sender, EventArgs eventArgs) {

  var manualControlData = new ManualControlData
  {
    Led0 = (byte)255,
    Led1 = (byte)255,
    Led2 = (byte)255,
    Led3 = (byte)255,
    Led4 = (byte)255,
    Siren = false
  };
  await _sirenOfShameDevice.ManualControl(manualControlData);
}

For more details on how to use the API check out the SirenOfShame.HardwareTestGui project

Summary

We hope you enjoy. Please consider sharing anything fun that you create. If you have any questions please don't hesitate to ask on twitter, facebook, or here in the comments.

Monday, May 23, 2016

Announcing soscmd-1.0.jar

Until today integrating a siren of shame device into non-continuous integration workflows has involved either writing a custom app or paying for a Team CI Pro subscription to get a custom HTTP endpoint for your siren. Even still the Linux story has been weak and the Mac story has been non-existent.

Today we are happy to release a new tool to address non-CI, cross-platform, custom workflow requirements of siren owners. That tool is soscmd-1.0.jar.

As with everything, soscmd is open source. All of the hardest work was performed with a generous contribution from Filip Hanik. We are very grateful to him for his help.

Finally, this tool is also our first step in working toward a truly cross platform CI monitoring solution. More details to come.

How-to

To get started

Download soscmd-1.0.jar.
Ensure you have Java 8 JRE or later installed
Enter java -jar soscmd-1.0.jar

With any luck you'll get something like this:

usage: soscmd -[i|ra|rl|m|l|a|sa|sl]

-i Retrieve info about device
-ra List audio patterns
-rl List led patterns
-m Manually set LED's
-l Play an LED pattern
-a Play an audio pattern
-sa Stop audio
-sl Stop LED's

At this point you should be able to connect a siren and do

java -jar soscmd-1.0.jar -i

and get something like this:

Firmware Version: 2

Hardware Type: Standard
Hardware Version: 1
Audio Mode: 0
Audio Play Seconds Remaining: 0
Led Mode: 0
Led Play Seconds Remaining: 0
External Memory Size: 0

Now if you want to manually light up some of the light bars you can do

java -jar soscmd-1.0.jar -m 128 0 255 0 0

which will set the 1st led bar to 50%, the 3rd led bar to 100% and the remaining bars to off.

To view the led or light patterns that your device has (which is based on your device's firmware) enter either the -ra or -rl command and you'll get something like this:

java -jar soscmd-1.0.jar -ra
Audio Patterns:
1 - Sad Trombone
2 - Ding!
3 - Plunk

If you want to play one of the audio commands above note the ID# and specify it along with a duration in seconds like this:

java -jar soscmd-1.0.jar -a 1 5

That plays the Sad Trombone for 5 seconds. You can accomplish the same thing with a -l command to play led patterns or you can turn audio or led patterns off with -sa or -sl.

Summary

That's it! Hope you enjoy, and if you do something fun with it please let us know.

Wednesday, May 11, 2016

New API: Snapshot Stats

If you're a Team CI Pro user enjoying the weekly e-mails and stats, and thinking what fun you could have with that raw data (we won't judge), then we've got some fantastic news: we've opened up a new API just for you!

Weekly recap e-mail

This API is basically a list of weekly snapshots of your teams stats. We originally took these snapshots to get the delta's that are in the e-mails. But now they're available for you to use and abuse.

API Key

To get started you'll need an API key. To get it click the new "Get Your API Key" button in the Team CI section of the site.

Then type your password, click the button and copy the resulting API Key.

Hit That API

To get the data POST to http://sirenofshame.com/ApiV1/Snapshots. To pass your credentials you can use: Content-Type: application/json with

{'UserName': '[YourUsername]','Password': '[YourApiKey]'}

or if you prefer you can use Content-Type: application/x-www-form-urlencoded with

Username=[YourUsername]&Password=[YourApiKey]

In other words:

curl --url http://sirenofshame.com/ApiV1/Snapshots -H "Content-Type:application/x-www-form-urlencoded" -d "UserName=[Username]&Password=[ApiKey]"

The result is hopefully something like:

{

"Success": true,

"ErrorMessage": null,

"Result": [

{

"StatSnapshotId": 174,

"SnapshotDate": "/Date(1428091201543)/",

"Users": [

{

"DisplayName": "Lee Richardson",

"RawName": "leerichardson",

"Fseb": 4,

"TotalBuilds": 399,

"Csb": 0,

"FailPercent": 105,

"Achievements": 12,

"Reputation": 189,

"UserId": 782,

"UserStatSnapshotId": 2958

{ /* all of your other users should be listed here */ }

]

/* up to 2 years worth of snapshots should be here */

]

}

Summary

Hope you enjoy. If you do something fun with the data please consider sharing by posting here or shooting us a note on twitter or Facebook.

Wednesday, October 7, 2015

Updated Android App V1.2

The Good News

We've fixed a bug in the Siren of Shame Android App that was turning on Android devices when users received push notifications. This issue was causing mass butt-dialing everywhere. For that we apologize to both senders and receivers alike. The issue is fixed now ... with the caveat that:

The Bad News

The idiot who build our last app (an intern, honestly, not the author of this post) lost the original Android signing key. That means the old version (1.1) won't auto-upgrade.

To get the new Android app you'll need to search Google Play for "Siren of Shame 2".

That also means we've lost all our excellent ratings. Any ratings, good or bad, you could give the new app would be greatly appreciated.

Fortunately, the individuals responsible (stupid interns) have been thoroughly chewed out, tar and feathered, and made to back up the new key by scratching it into a bar of depleted uranium, so nothing like this will ever happen again.

Wednesday, February 25, 2015

Introducing Team CI Pro - 8 New Feature's You'll Love

Today we are very proud to announce our biggest change in almost two years: it's a new service called Team CI Pro.

The CI Problem

You're trying to improve software quality. You implement continuous integration. You're lucky, you have a motivated team that rarely breaks the build and religiously fixes breaks. If this is you, Siren of Shame probably adds a some fun around the office, but is mostly a toy. In this case you likely don't need most of what Team CI Pro offers (skip to Curl to Siren, below).

If you're like the rest of us your team or program breaks the build with some regularity, fails to fix it quickly, requires nagging, and/or avoids fixing builds when someone else caused the break. If this is you, our new Team CI Pro service will provide the extra motivation your team needs to realize the full potential of continuous integration.

If it Ain't Broke?

But why a new service? Today, at little to no cost, you can increase build awareness by throwing builds up on a dedicated monitor with our free desktop app and full-screen feature. You can light up a siren when the build breaks. You can require that everyone download desktop clients to get the motivating stats and gamification information.

You could even mandate that everyone sign up for My CI to get build information, stats, and gamification information pushed to their e-mail and phones for free.

But what if you don't have the authority to require your team members do anything? How do you deal with team members less passionate about CI, and far less likely to install another app, than you? And what if you have a distributed team that can't all see the siren or the dedicated monitor?

Even if you could mandate desktop clients and My CI for all, there's a bigger problem. If a desktop client instance is turned off it can get out of sync. For instance when developer #1 goes on vacation for a week, their client misses a week's worth of reputation changes and achievements from their team mates.

It's hard to brag about your superior reputation or "Consecutive Successful Build (FSB)" score when everyone has different numbers.

Feature #1 - Consolidated Accounts

Team CI Pro inherently addresses these problems with an architecture designed around a single instance of the desktop client.

Continuous integration data flows in from the CI server (bottom right) through a single desktop client (and maybe fewer, see A Shameful Future below for details) into Siren of Shame Online. The desktop client sync's its stats and achievements to SoS Online, where the information is distributed to team members through a variety of mediums.

To facilitate distributing information to team members, teams maintain a single Team CI Pro master account on Siren of Shame Online. Desktop clients sync to the master account in the SoS Online menu as if they were doing My CI.

Once that master account has signed up for Team CI Pro (via the 'start free trial' button at of the Team CI Page) it can access a configuration page where it can add team member accounts that will receive the master account's data.

Team members added to the configuration page gain access to a number of cool new features.

#protip - Syncing to a team master account and adding yourself as a team member allows your team to continue with Team CI Pro in the event you ever leave the team.

Feature #2 - Reputation Over Time

While the web client isn't new, Team CI Pro adds some new features. Team members will get a new chart at the bottom of their Team CI page so they can see reputation over time.

Feature #3 - Team Heckling

Team Members will also get the ability to chat (via the blue floating button in the bottom left). Chat messages are sent as news items to Shame Extruders (see below), mobile clients, and other web clients in realtime so team members can taunt, brag, heckle, or worst case discuss actual work.

Feature #4 - Web Full Screen Mode

All web clients now get a new full screen view (via the leftmost red button in the screenshot above). The page is fully responsive and is designed to look good at tiny phone resolutions as well as large, high-dpi displays.

The full screen page could easily replace the full screen view in the desktop client and teams could throw identical build data up on multiple information radiators around the office, or around multiple distributed offices. Just hit F11 (or Command+Control+F).

Feature #5 - Personalized Mobile Clients

The Android, iOS, Win Phone, and Windows Store mobile clients today show your build information, your placement and stats among a large list of virtual strangers on the SoS Online Leaderboard, and a list of news items that mostly don't relate to you or your team.

Members of Team CI Pro will immediately have news items replaced with only news items relevant to your project (build events, achievements of fellow team members, and chat messages).

Team CI Pro members will also see their placement and stats among just their team members. The end result is the data displayed will be more meaningful and engaging.

And of course Team CI Pro members will continue to receive push notifications about build events and badge updates with the number of currently broken builds just like they did with My CI.

Feature #6 - Shame Extruders

A very exciting new feature for Team CI Pro members are Shame Extruders. Shame Extruders are lightweight desktop clients that give team members all the benefits of desktop clients without any of the polling (updates are sent via SignalR).

Specifically team members can install the Shame Extruder from our download page to get

Tray notifications
Build status, leaderboards, and news
The ability to connect USB Sirens (see the data flow diagram earlier)
Team chat

They can even configure rules

While nice for individuals Shame Extruders make it even easier to install multiple sirens in different rooms or at different locations around an office with a large or distributed team.

Feature #7 - Weekly Recap E-mails

My CI sent team leads e-mails when achievements were unlocked or builds broken (including stats like highest CSB attained). Team CI extends these features by sending e-mails directly to appropriate team members.

Better yet it provides a weekly recap e-mail with overall pass/fail ratio and a summary of team members standings and delta's to help maintain the team's continued focus on quality.

Feature #8 - Curl To Siren

We're extremely excited by the potential of this last feature. Curl to Siren allows the master account to light up any siren in their network that's connected via a shame extruder by hitting a REST based URL.

To make it work fire up a Shame Extruder, log on as the team owner account or a team member, and connect a USB siren. Now navigate to the master account's My CI page. The red button furthest left should have a badge with the number of Extruder's connected.

When you click you can select "test" to fire a quick default audio and led pattern. Or if you click the "curl" button you'll be presented with a CURL builder that will allow you to build the exact command you can run from the command line on any computer in the world to light up that siren.

You can extrapolate how you would light up the siren via JavaScript or your favorite language, but let us know if you have difficulty and we'll be glad to help.

This feature should enable you to integrate sirens into all kinds of things. Stock ticker watchers, e-mail notifiers, room busy indicators, train schedules, or ifttt. We can't wait to hear what you come up with.

Pricing

Pricing starts as low as $10 per month for small teams. Check out our pricing page for more details.

Or better yet try it out at no cost for a month. It's one click to get started. No credit cards, or DNA samples required.

A Shameful Future

We've got some exciting things in the works, but limited resources. Please vote here to let us know what you'd like to see us work on next:

https://www.surveymonkey.com/r/W73C6S2

Shame Extruder for Mac - Right now the Shame Extruders are for Windows clients only. Vote for this option if you use a Mac and like Team CI Pro, but the web and mobile options aren't cutting it.

Team CI On Premise - Behind a firewall but still want all that Team CI Pro goodness?

Bluetooth Controlled Power Plug - For integrating lava lamps, model trains, or other on/off items into your CI pipeline. This is actually prototyped out and just about ready to go.

Shame Whisperer - Wouldn't it be great to cut out polling and the Desktop Client all together? Shame Whisperers are Plugins to CI servers that send data up to Siren of Shame Online.

Productized Raspberry Pi - You can hook your siren up to a Raspberry Pi today with some fiddling. Wouldn't it be great if you could buy a pre-configured Raspberry Pi or download an image to turn your siren into an IoT device with virtually no effort? Even cooler with curl to siren.

Full Desktop Client for Mac - This is expensive and time consuming, but if a Shame Extruder and/or a Shame Whisperer isn't right for you we're ready to start work on a native Mac client today.

Slack Integration - If you use Slack and want your gamification data integrated vote for this.

What Else? - There's a write in option. Please submit any other great ideas, we'd love to hear them all.

Summary

We've put a lot into these features and hope you love them. We hope you'll check out the free trial. We've also got some exciting plans for what's next, and we hope you'll help us choose our next direction. As always please let us know what you think in the comments, on twitter, facebook, or google+.

Wednesday, January 7, 2015

Released 2.3.10

We just released version 2.3.10 to prod. If you were on 2.3.7 (our last non-beta version) you now get:

Support for Team City 9.X
This was generously contributed by @tupac21354

A Slew of TFS Fixes

TFS was showing "IndividualCI" instead of the author and comment while build definitions were building. This has been fixed and a large part of the TFS logic rewritten (Issue #53)
Fixed an issue in TFS where you couldn't easily select all build definitions (Issue #44)

And Some Misc Fixes

Fixed SOS was ignorning "Never check for updates (Issue #50)
Fixed a bug where you can't set "Who I Am" in the settings page

Summary

Short and sweet this time. Please shoot us a note at support at our domain name if you need help or drop a bug on github if you find any issues.

Thursday, October 30, 2014

Released 2.3.7

We just released verison 2.3.7 and took the 2.3.x line out of beta. If you've been sticking with the more stable 2.2 line then you now have the following features and bug fixes to look forward to:

TFS 2013

We now support Team Foundation Server 2013 including the new Git based projects. You may also be happy to learn we fixed some issues we had with watching builds from multiple project collections. You can also search and add new builds more easily for those with large TFS repo's.

Travis Pro and Enterprise

We now support Travis Pro and Travis Enterprise.

Jenkins

If you have a large Jenkins repository you can now filter and select all nodes more easily.

CruiseControl.Net

CruiseControl.Net now returns comments and build names. Big thanks to Benoit Martin (benoit808) and Jonathan Ritchie for these contributions.

Bug Fixes

The chat box in news now only appears if you're a Team CI member - in which case it allows you to chat with your team only (What is Team CI? More on this later.)
Fixed the issue with adding and playing custom .mp3's when you had upgraded via wyGet
You can now type your username in "Who I Am" rather than having to wait until you perform a build (Issue #47)
The full screen shortcut key ("F") is now Alt-F, fixing a problem with using that character while chatting :)
Fixes performance issues when watching many builds (see Issue #38 and Issue #16 on Github)
When a build definition is unavailable, Team City no longer breaks (thanks @monovo for this contribution)
In TeamCity when one build fails to connect we now return unknown build status rather than mark the entire server an unavailable (Issue #24)

Summary

That's it for now. This update sets the stage for a big announcement we'll have shortly. In the meantime thanks for all your support!

Sunday, September 14, 2014

Released 2.3.4 with Travis Pro / Enterprise Support

We just released version 2.3.4 which adds support for Travis Pro and Travis Enterprise.

Unfortunately setting up authentication isn't as straightforward as it could be. To set up a private repository:

Configure Server in Sos

Add Server, Select Travis
Enter your Owner and Project
Select a type of Public, Private (Pro), or Enterprise
If you select Enterprise enter the full url to your domain (e.g. https://travis.example.com/api/)

Generate a Travis API Access Token

Click "Generate New Auth Token"
Follow the instructions on the page. Specifically:
Open GitHub's Application Settings
Generate New Personal Access Token
Give it a name and select the following scopes: repo, user:email, write:repo_hook, repo:status, read:org, repo_deployment
Click Generate Token
Copy the token's value and paste it into the textbox
Click "Generate Token" and we will initiate a request to Travis (using the URL you specified on the previous screen) to create a travis API access token.
Upon success the new travis api access token will be entered into the textbox on the configure server page and you can click "Add" and then "Add" again

Bug Fixes

Can now open up the Sounds menu from a fresh install
When a build definition is unavailable, Team City no longer breaks (thanks @monovo for this contribution)

Summary

We hope you enjoy the new features. Shoot us a note at support at our domain name if you need help or drop a bug on github if you find any issues.

Tuesday, July 15, 2014

Raspberry Pi Powered Siren of Shame via Node.js

If you have a spare Raspberry Pi sitting around (and who doesn't) or are seeking an excuse to buy that newly released Model B+ model with 4 USB ports, then have you considered combining it with a Siren of Shame to hassle your build breaking office mates whether you're at the office or not? If that sounds good this article is for you.

Getting Started

You'll need a Siren of Shame device and a Raspberry Pi that's running and connected to the Internet. Element14 has a great getting started set of videos if you're completely new to Raspberry Pi. This post used the Raspbian OS, but theoretically it shouldn't matter what OS you use.

libusb

Libusb provides an API for applications to interface with USB devices, including Human Interface Devices (HID) such as the Siren of Shame. To install libusb use apt-get (the universal Linux installer).

If this is a new Raspberry Pi with a fresh install of Linux then you will need to update your list of available packages with

sudo apt-get update

Follow that up with:

sudo apt-get install libusb-dev

You should now be able to run lsusb from the command line to list devices. Plug in a Siren of Shame, run lsusb, and you should get a device with an id of 16d0:0646 called GrauTec. It should look like:

lsusb

...
Bus 001 Device 011: ID 16d0:0646 GrauTec

If your device doesn't show up, it could be an issue with the cable. Andy Lowry, who has an excellent blog post where he lights up his siren of shame when freight trains are near, reports that he had to try several cables before finding one that worked.

Node.js

Thanks exclusively to Joe Ferner and his node-sos-device project we have a solution for connecting Siren of Shame's to linux using Node.js. To install Node.js it should be as easy as:

sudo apt-get install nodejs
sudo apt-get install npm

Incidentally, rather than using node-sos-device directly, we will be using the higher-level node-sos-client, which knows how to monitor Jenkins and Bamboo CI servers.

Node-sos-client

If you haven't configured your device to work with git you could do it the right way with SSH and generate an ssh key or you could just:

git clone https://github.com/AutomatedArchitecture/node-sos-client.git

and

cd node-sos-client

Next you'll need to download all Node dependencies. If this is a fresh install you'll need to tell the node package manager (npm) where to retrieve dependencies from:

npm config set registry http://registry.npmjs.org/

Now you can install all dependencies for node-sos-client by running

npm install

Upgrading Node

For some fortunate users (Andy Lowry for one) installing node via apt-get works fine. If, however, you get an error about node being out of date you'll have to uninstall, download, and update your path.

First, to uninstall the old version of node:

sudo apt-get remove npm
sudo apt-get remove node

No download and unpack:

cd ~
wget http://nodejs.org/dist/v0.10.2/node-v0.10.2-linux-arm-pi.tar.gz
tar -xvzf node-v0.10.2-linux-arm-pi.tar.gz

To add it to your path

nano .bashrc

And add the following two lines at the bottom:

NODE_JS_HOME=/home/pi/node-v0.10.2-linux-arm-pi
PATH=$PATH:$NODE_JS_HOME/bin

If you restart your command prompt and type node --version you should get v0.10.2.

Now retry npm install.

cd node-sos-client
npm install

And you should be good to go.

Running node-sos-client

First make a copy of the default configuration file:

cp config.json.example config.json

We'll configure it correctly later. Next pick up the dependency on node-sos-device by running:

npm install sos-device

To run the app you should be able to run

sudo node build/sos-client.js

However, if you had to install node with the wget method, then you'll need to run

sudo $NODE_JS_HOME/bin/node build/sos-client.js

If you're lucky you'll see the app print out the device stats as json and a configuration error, something like:

deviceInfo: { version: 1,
hardwareType: 1,
hardwareVersion: 1,
externalMemorySize: 0,
audioMode: 0,
audioPlayDuration: 0,
ledMode: 0,
ledPlayDuration: 0,
ledPatterns:
[ { id: 2, name: 'On/Off' },
{ id: 3, name: 'Fade' },
{ id: 4, name: 'Chase' },
{ id: 5, name: 'Fade Chase' } ],
audioPatterns:
[ { id: 1, name: 'Sad Trombone' },
{ id: 2, name: 'Ding!' },
{ id: 3, name: 'Plunk' } ] }
Failed to poll: bamboo0 { [Error: getaddrinfo ENOTFOUND] code: 'ENOTFOUND', errno: 'ENOTFOUND', syscall: 'getaddrinfo' }

However, if you have a cable that doesn't work well, or are connecting through a non-powered USB hub you may see:

Error: usb_detach_kernel_driver_np: -113 could not detach kernel driver from interface 0: No route to host

In this case try experimenting with the way you connect the device to the Pi.

Configuring the Connection

Today node-sos-client can connect to two CI servers: Bamboo, and Jenkins. To connect to Jenkins update the config file to something like:

{
"builds": [
{
"type": "jenkins",
"config": {
"url": "http://127.0.0.1/jenkins/api/json/",
"username": "[username]",
"password": "[password]"
}
}
]
}

And you're done. With any luck running sudo node build/sos-client.js will light the siren and sound the speaker on initial connection, and whenever the build breaks.

Summary

And now you too can terrorize your build breaking colleagues, even when you're not at the office. Enjoy!

Saturday, April 19, 2014

Released 2.2.0

Today we released Siren of Shame 2.2.0, adding some good stuff including the #1 most requested feature:

Custom Audio Sounds

"Sounds", it's a new option in the menu:

Click it to add/delete/preview MP3's or WAV's:

Then configure rules to play them:

With per-user rules and our fancy rule engine you can now taunt co-workers by name when they break the build. How cool is that?

Visual Studio Online

If you're into TFS (by choice or divine mandate) and using the Microsoft-hosted cloud version (previously called Team Foundation Services) we now have your back. See Configuring Visual Studio Online for details.

Keyboard Shortcuts

If you're a keyboard kind of person (and what self-respecting developer isn't?) you'll appreciate the following new keyboard shortcuts:

1-9 - Go to the build detail page for the appropriate build
Backspace - Go to the home page
Alt+1-9 - Go to the the user detail page for the appropriate user
F - Go full-screen

Bug Fixes

Can now treat unstable as passing for Jenkins (Issue #30)
When new users are added, the leaders tab now immediately updates (Issue #26)
Fixes an issue with Team City authentication
Fixes a bug with users that have comma's in their user names
Fixes a bug with hidden users
Fixes some issues with build dates (thank you @mightymuke)
Fixed authentication issues in Travis
Fixed issue #48 typo
Fixed a bug with user mappings (thank you @gregorycu)
Improved pretty date calculations

Configuring Visual Studio Online for Siren of Shame

As of Siren of Shame 2.2.0 we now support Visual Studio Online (previously Team Foundation Services).

You will need to configure Visual Studio Online to enable authentication from Siren of Shame. To do this:

1. Log in to Visual Studio Online
2. Edit your Profile

3. Click Credentials and select "Enable alternate credentials"

4. Enter a username and password
5. When you add a server in Siren of Shame the URL should be https://[myproject]/visualstudio.com/, and the username/password should be what you entered in alternate authentication credentials

Sunday, January 5, 2014

My CI Gets Localized

We recently talked with a Siren of Shame user who proudly announced that Siren of Shame was the second app they installed on their new smartphone. Naturally we asked: "So what did you think?" to which they sheepishly responded "Um, it installed".

The problem was that the Siren of Shame app (Android in this case, but all the apps work the same way) showed global leader boards and global news. The user could see the state of their builds, and the push notifications were nice, but they wanted localized gamification data. They wanted to know their reputation within their team and to see news relevant to their project rather than competing with a bunch of people they didn't know.

Today we are proud to announce two new features for My CI customers that help make data more localized and relevant.

My CI News Feed

First, My CI customers now get news on their My CI page. In fact, the page should look nearly identical to the Siren of Shame desktop app itself. The My CI page used to look like this:

And now the My CI page looks like this:

Better? We think so, but feel free to respond in the comments.

Localized Mobile Apps

The second feature we want to announce is that effective immediately all mobile apps including Android, iPhone, Windows Phone, and Windows 8 now will show localized news and leader boards if you're signed up for My CI. For instance here is the iPhone news feed, complete with check-in comments aggregated across build definitions:

The Leaders page looks similar in that only those individuals listed above will be shown.

Summary

We hope you enjoy the new localized data. Please post in the comments if you feel we're headed in the right direction (or not) because there is more great stuff to come along these lines in 2014 (hint: it's called Team CI and it's nearly ready).

Saturday, June 29, 2013

How to Add Support for a new CI Server to Siren of Shame

Siren of Shame supports eight CI servers today, but adding additional ones is pretty easy. Read on if you you're interested in adding support for achievements, reputation, or push notifications to mobile devices to your favorite CI server.

Architecture Overview

We use a plugin model to interact with CI server's via the Managed Extensibility Framework (MEF). The main project (SirenOfShame.csproj) looks in the \plugins directory to find class libraries (.dll's) that export classes (via MEF's ExportAttribute) that inherit from ICiEntryPoint. Theoretically you could export multiple CiEntryPoints per assembly, but we only do one per C# project to separate concerns.

If you'd like to start with a reference project for either reading through or copying, consider checking out HudsonServices.csproj as it is one of our more mature plugins.

ICiEntryPoint

public interface ICiEntryPoint
{
    ConfigureServerBase CreateConfigurationWindow(
        SirenOfShameSettings settings,
        CiEntryPointSetting ciEntryPointSetting
        );

string Name { get; }

string DisplayName { get; }

WatcherBase GetWatcher(SirenOfShameSettings settings);

}

The ICiEntryPoint interface requires a Name and DisplayName. Name (e.g. "Hudson") is used extensively in a user's persisted settings as an ID. It is never displayed to a user, and should never be changed.

DisplayName (e.g. "Hudson/Jenkins") is displayed in the dropdown of available CI servers in the Add CI Server dialog and may be changed over time if necessary.

SirenOfShame calls ICiEntryPoint's CreateConfigurationWindow() when a user adds an instance of a new build definition to watch. It should return a class that inherits from ConfigureServerBase, which in turn inherits from UserControl. The control will be embedded in a windows forms page when a user selects the associated CI server on the add CI server dialog or goes to edit an existing CI server. This form should be used to allow a user to connect to a CI server, select the build definitions to watch, and optionally persist a username and password. For example:

public ConfigureServerBase CreateConfigurationWindow(
SirenOfShameSettings settings,
CiEntryPointSetting ciEntryPointSetting) {

return new ConfigureHudson(settings, this, ciEntryPointSetting);

}

Finally, GetWatcher() is called when the system starts watching CI servers (e.g. after adding a CI server, or on startup). Its job is to instantiate and return a class that inherits from WatcherBase whose job is to handle polling for build status changes. For example:

public WatcherBase GetWatcher(SirenOfShameSettings settings) {

return new HudsonWatcher(settings, this);

}

WatcherBase

Pretty must the only responsibility of WatcherBase that's important is overriding:

protected override IList<BuildStatus> GetBuildStatus();

This method is called very frequently by the rules engine (RulesEngine.cs) to check for build status changes. It is is expected to retrieve the build definitions that the user is watching and return a BuildStatus for each one. It could utilize a separate class, such as one that inherits from ServiceBase, like HudsonService.cs does, but this isn't strictly necessary.

The build engine is run on a background thread, to free up the UI thread, but it does call GetBuildStatus synchronously. Consequently any long delays inside GetBuildStatus decrease the frequency that users get build statuses. For example if the user has set the polling interval as 10 seconds and GetBuildStatus takes 10 seconds to run then the user actually gets build statuses every 20 seconds. For this reason it might be a good idea to request build statuses for each build definition in parallel like HudsonService.cs does:

public IList<HudsonBuildStatus> GetBuildsStatuses(
        string rootUrl,
        string userName,
        string password,
        BuildDefinitionSetting[] watchedBuildDefinitions) {

    rootUrl = GetRootUrl(rootUrl);

    var parallelResult = from buildDefinitionSetting in watchedBuildDefinitions
                         select GetBuildStatus(rootUrl, buildDefinitionSetting, userName, password);
    return parallelResult.AsParallel().ToList();
}

At any time GetBuildStatus() can throw ServerUnavailableException to indicate that something is temporarily wrong (e.g. the web connection is down or the server is down for maintenance). In response the main engine will notify the user and continue polling the server periodically until the situation has resolved itself. If you choose the overload with an exception, the user will be given the opportunity to click on the error message and send the result back to us for diagnosis.

Next Steps

If you have any questions feel free to e-mail us at support at our domain name. And once you get it working we hope you'll consider initiating a pull request from our GitHub project.