CruiseControl.rb : intégration continue en moins de 10min ?

Bon, j’ai trouvé cette nouvelle version de CruiseControl en Ruby très intéressante:

Cruise_logo_large

On y mentionne pouvoir faire notre setup en 10 minutes (!)

Fini les fichiers XML à configurer. Hmm, cela semble attirant. Il faut cependant avoir SVN Subversion comme gestionnaire de code source et Ruby. On peut compiler des projets en Java ou en C#.

Notre code de configuration de notre build est fait en Ruby, un vrai langage de programation. Par exemple, un snippet de code peut ressembler à cela:

Project.configure do |project|
  case project.name
  when 'MyProject.Quick' then project.rake_task = 'test:units'
  when 'MyProject.BigBertha' then project.rake_task = 'cruise:all_tests'
  else raise "Don't know what to build for project #{project.name.inspect}" 
  end
end

J’adore cette manière très lisible de voir le code. Je ne pense pas que cela peut égaler la facilité d’utilisation et les nombreuses options de FinalBuilder, mais pour du OpenSource, cela semble prometteur. Moi qui n’aime pas trop les fichiers de configuration XML, voilà une bonne occasion d’essayer ce CruiseControl.rb !

Ghost Doc

J’ai découvert l’autre jour un petit utilitaire fort intéressant: Ghost Doc. Il permet de faciliter grandement l’ajout de commentaires "xml" dans le code. Ghost Doc analyse le code à commenter et génère un genre d’esquisse de commentaires et il ne nous reste plus qu’à le finaliser.

Exemple:

Voici une méthode en C# pour aller chercher une liste de répertoire sous un nom de server dans un fichier XML:

public static StringCollection GetDirectoryList(String serverName)
{
StringCollection collDir = new StringCollection();
XmlDocument xmlDoc;
XmlNodeList xmlNodeDirList;
XmlNode xmlNode;

}

Au lieu de faire les "///" traditionnelles, je me positionne sur la méthode à documenter et j’active la nouvelle option venant de GhostDoc avec le menu contextuel (clic droit), "Comment This" :

Et j’obtiens ceci sans rien faire d’autre:

/// <summary>
/// Gets the directory list.
/// </summary>
/// <param name="serverName">Name of the server.</param>
/// <returns></returns>

Je fais quelques petites modifications pour améliorer le tout et voilà:

/// <summary>
/// Used by the console or windows client to get the list of directories to scan
/// for the server name passed in the parameters
/// </summary>
/// <param name="serverName">Name of the server.</param>
/// <returns>
/// Return an array of string representing a list of directory
/// </returns>

 

Autre exemple avec une fonction de type "bool":

public static bool IsExcludeDirExist(string serverName)
{
bool nodeData = IsNodeDataExist(serverName.ToLower(), "ExcludedDirectories");
return nodeData;
}

J’utilise "Comment this" et j’obtient directement ceci:

/// <summary>
/// Determines whether [is exclude dir exist] [the specified server name].
/// </summary>
/// <param name="serverName">Name of the server.</param>
/// <returns>
/// <c>true</c> if [is exclude dir exist] [the specified server name]; otherwise, <c>false</c>.
/// </returns>

Et par la suite, j’y fais quelques modifications:

/// <summary>
/// Determines whether an excluded directory exist for the specified server name.
/// </summary>
/// <param name="serverName">Name of the server.</param>
/// <returns>
/// <c>true</c> if an excluded directory exist for the specified server name; otherwise, <c>false</c>.
/// </returns>

Intéressant, non  ?

Ghost Doc ne fait pas des miracles, mais il rend la création de commentaires XML beaucoup plus facile. Par contre, il est important de bien nommer ses fonctions et méthodes pour que Ghost Doc puisse en faire une bonne analyse. C’est en fait une bonne pratique de toujours s’assurer que les noms de fonctions et méthodes sont toujours significatifs. Pour y arriver, il s’agit simplement de suivre ces trois règles:

  • Utiliser le "PascalCasing" ou le "camelCasing" pour écrire les noms avec plusieurs mots
  • Débuter les noms des méthodes avec un verbe
  • Ne pas utiliser d’abréviation dans les noms

    GhostDoc marche principalement avec le C#, mais je crois qu’il y a quelques fonctionnalités pour VB aussi.

    Pour une simple introduction de GhostDoc, voici un article intéressant:

    http://dotnetslackers.com/articles/vs_addin/Introduction_ghostdoc.aspx

    Et pour le télécharger:

    http://www.roland-weigelt.de/ghostdoc/

  • SvnBridge – Use TortoiseSVN with Team Foundation Server

    Pour les amateurs de Tortoise SVN et de Subversion, les gens de CodeFlex travaillent actuellement sur un outil appelé "SvnBridge" pour être utilisé avec Team Foundation Server:

    http://www.codeplex.com/SvnBridge

     

    Si TortoiseSVN ou le concept de Subversion ne vous dit pas grand chose, voici quelques liens:

    Définition de "Subversion":

    http://en.wikipedia.org/wiki/Subversion_%28software%29

     

    Logiciel de subversion "OpenSource" pour .NET:

    http://tortoisesvn.net/

    Logiciel pour l’intégration de Tortoise dans .NET (~50$ la licence):

    http://www.visualsvn.com/

     

    J’ai fait l’essai de TortoiseSVN dans quelques projets et je trouve cela très bien et aussi fiable (sinon plus) que VSS.  Le concept de "merge" est puissant, ne causant que rarement des conflits. Il permet à plusieurs personnes de travailler dans le même fichier de code (ex: dans des fonctions différentes) en même temps  sans créer aucun conflits. L’intégration de Tortoise avec le "Windows Explorer" est bien réalisée, améliorant ainsi l’opération de se créer un "Working folder".  Et VisualSVN rend l’utilisation de tout ceci encore plus facile car tout se fait en direct dans Visual Studio.