Notification Center on Jean-Christophe Gay

Notifications de bureau pour Gradle

Wed, 13 May 2015 17:35:00 +0200

Comme (trop ?) souvent avec les builds, le temps parait long… Souvent lancé un peu en tâche de fond, j’aime bien avoir une notification quand ceux ci se terminent.
Gradle propose un plugin par défaut pour enrichir son build de notifications mais on verra comment avoir accès à une panoplie de nouveaux types de notifications !

Gradle Build Announcements
#

C’est le plugin disponible par défaut dans la distribution de Gradle. Il est lui même basé sur le plugin Announce qui permet d’envoyer des notifications personnalisées pendant un build.
Il supporte 4 types de notifications :

twitter
notify-send
Snarl
Growl

Pour l’activer, c’est très simple il suffit de le déclarer dans build.gradle :

apply plugin: 'build-announcements'

ou de le déclarer directement dans $HOME/.gradle/init.gradle pour que le plugin soit actif pour tous les projets :

rootProject {
 apply plugin: 'build-announcements'
}

C’est vraiment très sympa d’avoir cette fonctionnalité disponible directement sans rien installer… Par contre le choix d’applications est assez limité et les notifications ne sont pas très visuelles (l’icône est toujours la même quelque soit l’état du build par exemple).

Gradle notifier
#

Comme j’avais déjà mes notifications pour Maven avec maven-notifier, j’en ai profité pour les porter vers Gradle avec gradle-notifier !

Il supporte l’envoi de notifications vers :

Notifier	Screenshot
Growl, pour Windows et OS X.
Snarl, pour Windows
terminal-notifier, OS X
notification center OS X (depuis Mavericks)
notify-send pour Linux
SystemTray depuis Java 6
Pushbullet
Kdialog pour KDE
notifu for Windows
AnyBar pour OS X et Linux
Toaster pour Windows 8
Notify since Java 6
BurntToast for Windows 10
Slack

Installation
#

Le plugin peut être ajouté dans la phase d’initialisation ou directement au sein d’un projet.

Script d’initialisation
#

Pa exemple, créer (ou modifier) le fichier $HOME/.gradle/init.gradle :

initscript {
 repositories {
 mavenCentral()
 }

 dependencies {
 classpath group: 'fr.jcgay', name: 'gradle-notifier', version: '1.1.0'
 }
}

rootProject {
 apply plugin: fr.jcgay.gradle.notifier.GradleNotifierPlugin
}

Script du projet
#

Dans le script build.gradle, ajouter :

buildscript {
 repositories {
 mavenCentral()
 }
 
 dependencies {
 classpath group: 'fr.jcgay', name: 'gradle-notifier', version: '1.1.0'
 }
}

apply plugin: 'fr.jcgay.gradle-notifier'

ou en utilisant le mécanisme de plugin introduit depuis Gradle 2.1:

plugins {
 id "fr.jcgay.gradle-notifier" version "1.1.0"
}

Configuration
#

Reposant sur send-notification, la configuration des applications et le choix de celle utilisée pour recevoir les notifications peut se faire dans le fichier $HOME/.send-notification (Voir les paramètres disponibles dans la documentation).

Ou bien l’outil est configurable directement au sein d’un script Gradle :

notifier {
 implementation = 'notificationcenter'
 threshold {
 time = 10
 unit = java.util.concurrent.TimeUnit.SECONDS
 }
 growl {
 port = 23053
 host = 'localhost'
 password = 'azerty123'
 }

Et voilà plus moyen d’oublier son build au fin fond d’une console !

Maven: complétion, couleurs et notifications de bureau

Sun, 14 Apr 2013 14:02:00 +0200

Maven, out of the box n’est pas l’outil le plus sexy du monde… Utilisé dans un IDE, il saura se faire oublié mais il mérite mieux lors de son usage en ligne de commande.

Complétion
#

Il existe des scripts de complétion automatique des commandes Maven.

Les utilisateurs de bash pourront compter sur :

maven-bash-completion, une représentation statique de plugins/goals/options. Celà fonctionne très bien, malheureusement il faut que chaque plugin soit décrit pour pouvoir être reconnu.
Un second script maintenu dans le paquet ubuntu de maven. Il fonctionne sur la même base que le précédent.

Si vous utilisez zsh, deux solutions sont disponibles :

le plugin mvn au sein du framework oh-my-zsh s’occupe de la complétion. En cadeau on a également tout une collection d’alias très pratique.
dans zsh-completions, un script permet de découvrir les goals de manière automatique à la première utilisation d’un plugin (mvn plugin:<TAB>). La première exécution est un peu plus longue mais après la complétion est instantanée (Merci à Thomas Queste qui en a parlé dans les commentaires).

Notifications de bureau
#

Avoir un build rapide c’est bien… seulement il arrive que ce ne soit pas du tout le cas. Rester devant sa console pour un build qui dure plusieurs minutes n’a pas vraiment d’intérêt… Pouvoir être notifié du résultat à la fin de son build devient alors indispensable.

maven-notifier
#

J’ai développé une extension Maven qui permet d’envoyer une notification à la fin d’un build : maven-notifier. Il fonctionne avec tous les systèmes d’exploitation.
Par défaut, l’extension tentera de trouver un notifier disponible sur la machine depuis cette liste d’outils.
Il est possible de configurer le système de notification utilisé et bien d’autres choses (format des messages, etc) en créant un fichier maven-notifier.properties.

Notifier	Capture d’écran
Growl, disponible pour Windows et OS X.	maven-notifier-growl
Snarl, disponible pour Windows	maven-notifier-snarl
terminal-notifier, OS X
notification center OS X (depuis Mavericks)
notify-send pour Linux
SystemTray depuis Java 6
Pushbullet	maven-notifier-pushbullet
Kdialog utilisable avec KDE	maven-notifier-kdialog
notifu disponible pour Windows	maven-notifier-notifu
AnyBar pour OS X et Linux	maven-notifier-anybar
Toaster pour Windows 8
Notify since Java 6
BurntToast for Windows 10
Slack

Les scripts
#

On peut aussi se contenter de wrapper la commande mvn pour récupérer son statut et envoyer une notification.

Growl via growlnotify : Intégration de Growl avec Maven, maven-growl
notification center via terminal-notifier : maven-notification-center
notify-send : Intégration de notify-send avec Maven.

Couleurs
#

La sortie console de Maven est toute terne. Il n’est pas toujours facile d’y retrouver les messages d’erreurs et c’est encore pire pour les messages d’avertissement…

maven-color
#

maven-color ajoute de la couleur dans les logs de Maven.

Les dernières versions de Maven (depuis la version 3.1.x) utilisent SLF4J en interne, cela veut dire que l’on peut choisir l’implémentation de log que l’on veut !
Cet article très complet explique comment avoir une console en couleur avec Log4j 2 ou Logback. C’est la technique utilisée par maven-color

Pour les versions plus anciennes (entre la 3.0.x et la 3.1.0), j’ai utilisé Jansi et remplacé les loggers utilisés en interne par Maven avec un agent. Cela fonctionne avec les goals interactifs, par contre c’est beaucoup moins facile à mettre en place et bien moins résistant aux changements d’implémentation au sein de Maven et du plugin Surefire… maven-color.

Les scripts
#

On peut ajouter un peu de couleur pour y voir plus clair :

Ces scripts sont très biens et faciles à mettre en place, malheureusement ils ne fonctionnent pas avec les goals interactifs. N’espérez pas utiliser maven-release-plugin ou maven-archetype-plugin en mode interactif, les messages de demande de saisis n’apparaitront pas.

Tout en un (pour OS X)
#

Comme c’était dommage de réinstaller toutes ces extensions à la main pour chaque version de Maven, j’ai créé une formule pour brew.

brew tap jcgay/jcgay
brew install maven-deluxe

Celà installera la dernière version de Maven, maven-notifier, maven-color et maven-profiler.

Conclusion
#

Xzibit

Thanks Xzibit for pimping my Maven !

Notification Center on Jean-Christophe Gay

Notifications de bureau pour Gradle

Gradle Build Announcements #

Gradle notifier #

Installation #

Script d’initialisation #

Script du projet #

Configuration #

Maven: complétion, couleurs et notifications de bureau

Complétion #

Notifications de bureau #

maven-notifier #

Les scripts #

Couleurs #

maven-color #

Les scripts #

Tout en un (pour OS X) #

Conclusion #

Gradle Build Announcements
#

Gradle notifier
#

Installation
#

Script d’initialisation
#

Script du projet
#

Configuration
#

Complétion
#

Notifications de bureau
#

maven-notifier
#

Les scripts
#

Couleurs
#

maven-color
#

Les scripts
#

Tout en un (pour OS X)
#

Conclusion
#