Test produit : SPCAF – Présentation et installation [1/3]

Cet article est le premier d’une série consacrée à l’outil SPCAF : SharePoint Code Analysis FrameWork (http://www.spcaf.com):

• Test produit : SPCAF – Présentation et installation [1/3] – Vous y êtes !
• Test produit : SPCAF – Utilisation de l’application cliente [2/3]
• Test produit : SPCAF – Utilisation dans Visual Studio [3/3] – Coming soon

Introduction

Vous qui travaillez avec SharePoint avez certainement eu à installer sur vos fermes des développements spécifiques, anciens ou récents, développés en interne ou par une société externe, bien codés ou non … Et c’est sur ce dernier point que SPCAF va vous être utile.

On est d’accord : tout développement SharePoint se doit de respecter des best-practices, des règles bien précises qui assureront que le code est maintenable, performant (en tout cas pas l’inverse), ou encore  « utilisable/migrable »  lors d’une migration SharePoint.

Oui mais …. Comment vous assurer que ces règles ont bien été respectées ? Comment vous assurer que le code que vous allez déployer ne soit pas le champion des fuites mémoire ?

SPCAF va se charger de toutes ces vérifications.

Vraiment utile ?

SPCAF peut vous aider sur de multiples tableaux :

• Préparation d’une migration vers une version supérieure de SharePoint ou vers SharePoint Online,
• Définition / Mise en place de vos normes de développement maison,
• Permettre aux équipes de dév. de profiter d’une intégration continue,
• Envisager une politique de dé-customisation : ai-je des éléments obsolètes, et dans le cas contraire puis-je envisager de réecrire/simplifier mes développements,
• …

Son fonctionnement

SPCAF peut être utilisé de plusieurs manières :

• Via l’application cliente

Si par exemple vous ne disposez pas des sources de votre WSP, vous pouvez utiliser ce client pour l’analyser. Des tonnes d’infos sont récupérées, et tout çà sans avoir le code source – Plus de détails dans un prochain article.

• Via Visual Studio

Lancez les analyses et la génération des rapports directement depuis Visual Studio, sur un projet ou une solution – Plus de détails dans un prochain article.

• Via TFS

SPCAF peut être couplé à TFS afin de s’intégrer au process de build.

A noter également :

• Un SDK est disponible afin de vous permettre d’étendre les fonctionnalités de l’outil.

• Un projet « OpenSource » est disponible à cette adresse.

Les versions disponibles

Je vais commencer par décrire les versions disponibles, car parmi ces versions on retrouve les 4 briques de base de l’outil : les analyseurs (Il est à noter que le code analysé peut être celui de WSPs ou d’Apps).

Ces analyseurs sont au nombre de 4 :

• SPCop : parcourt le code en effectuant une vérification sur plus de 400 règles de base; en cas de manquement à une règle, le détail de l’anomalie est ajouté au rapport (exemple de rapport),
• SPMetrics : parcourt le code en listant les éléments (features, listes, lignes de code, …) ce qui permet entre autre d’avoir une vue d’ensemble de la complexité du code (exemple de rapport),
• SPDepend : parcourt le code en listant les relations entre les éléments (exemple de rapport),
• SPInventory : effectue un inventaire des packages (exemple de rapport).

En plus de ces modules que vous pouvez acheter séparément, 2 versions de SPCAF « packagées » sont disponibles.

Comparez les fonctionnalités de ces 6 versions à cette adresse.

Licensing

SPCAF est un outil payant (promo de 25% jusqu’au 31 juillet) mais il le voir comme un bon investissement, compte-tenu des multiples fonctionnalités de cet outil et du temps qu’il peut vous faire gagner dans le futur (préparation de migrations, contrôle régulier du code, …).

Sans parler du temps gagné par rapport à un contrôle manuel …

A noter qu’une version gratuite est disponible à cette adresse, version suffisante pour un contrôle via Visual Studio de vos développements.

 

Pour des contrôles plus approfondis, la version Professional de SPCAF sera nécessaire.

Procédure d’installation

Je choisis pour cet article d’installer la version « Professional »; pour celà :

• Demandez votre licence trial ici
• Téléchargez SPCAF là.

1. Une fois téléchargé, quelques clics suffisent pour installer.

« Next » !

2. Saisissez votre clé de licence.

3. Choisissez le type d’installation – « Complete » dans mon cas.

4. Si vous choisissez une installation « Custom », vous aurez les choix suivants.

5. Vous devinez ?

6. SPCAF s’installe.

7. Done ! Si vous le souhaitez vous pouvez lancez directement la version « cliente » de l’outil à partir d’ici.

 Conclusion

J’espère que cette présentation assez synthétique de SPCAF vous aura mis l’eau à la bouche, les articles suivants arrivent, avec des détails sur les analyses, via l’outil client, et via Visual Studio !