SharePoint: Análisis de soluciones SharePoint con MSOCAF (I)!

Si tenemos que hacer una auditoría de un ambiente SharePoint o estamos trabajando para un cliente en el que se nos exigen ciertos parámetros de calidad en los componentes que estamos desarrollando y que se irán al entorno de pre-producción primero y de producción posteriormente, es interesante realizar un análisis exhaustivo de los componentes que se están auditando o se van a desplegar para detectar cualquier problema en los mismos. Una de las opciones que tenemos para realizar ese análisis es el uso de MSOCAF (Microsoft SharePoint Online Code Analysis Framework) proporcionado por Microsoft y que tenéis disponible en el siguiente enlace: https://caf.sharepoint.microsoftonline.com/. En este primer post de la serie, vamos a hacer una aproximación al uso de MSOCAF para el análisis de soluciones SharePoint.

  • Accedemos a la página de MSOCAF y en la parte inferior hacemos clic en la versión que nos interesa. En mi caso, voy a hacer uso de la versión de MSOCAF para SharePoint 2010.
  • A continuación se muestra una página con los requerimientos mínimos que necesitamos para hacer uso de MSOCAF y también el correspondiente acuerdo de licencia. Lógicamente, en mi caso necesito SharePoint 2010 y .NET Framework 3.5 SP1. Hacemos clic en “Install”.
image image
  • El proceso de instalación nos va a indicar que se necesitan componentes adicionales como MSOCAF Event Source y Enterprise Library 4.1. Los instalamos.
  • Una vez se han instalado todos los componentes necesarios y el propio MSOCAF, se muestra la pantalla principal de la herramienta desde la que podremos comenzar a realizar nuestros análisis de código de soluciones existentes. Para comenzar a analizar una solución, hacemos clic en Analyze.
image image
  • A continuación se muestra una pantalla en la que se informa como tienen que ser la estructura de carpetas necesaria para proceder a realizar el análisis. Fijaros como se indica que las carpetas, con el nombre correspondiente, son obligatorias para realizar el análisis.
  • A continuación se muestran el conjunto de reglas que se van a utilizar en el análisis y que en mi opinión es bastante completo.
image image
  • Por último, se muestra la pantalla en la que tenemos que indicar la ruta raíz del código a analizar. Tras especificar dicha ruta, pulsaremos el botón analizar.
  • Si por ejemplo MSOCAF detecta problemas en la estructura de carpetas, mostrará un primer mensaje de error a pesar del cuál podréis seguir adelante con el análisis. Por ejemplo, si la carpeta de Release documents está vacía, es motivo para que se produzca un error. Lo solucionamos y empezamos de nuevo.
image image
  • A partir de aquí, y aunque haya errores de estructura, podremos realizar un análisis de nuestros artefactos que sin duda es un gran valor añadido de MSOCAF. Por ejemplo, en mi caso de prueba tonto al final obtendremos un informe con advertencias y errores en el código que tendremos que solucionar si es necesario (Nota: Aclaración en este punto, digo si es necesario porque no tenéis que olvidaros que MSOCAF es utilizado por Microsoft para dar de pasos los desarrollos de terceros para Office 365). Otro aspecto interesante del informe es que puedes aprender buenas prácticas, si no haces uso de ellas, en aspectos como la gestión de excepciones, evitar el uso de palabras reservadas en el código, etc.

image

Y hasta aquí llega este primer post sobre el uso de MSOCAF para el análisis de soluciones SharePoint. Espero que os haya resultado de utilidad.

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión /  Cambiar )

Google photo

Estás comentando usando tu cuenta de Google. Cerrar sesión /  Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión /  Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión /  Cambiar )

Conectando a %s