MANUAL DE USUARIO Plugins para maven Framework ATLAS. Versión 1.1

Transcripción

1 MANUAL DE USUARIO Plugins para maven Framework ATLAS Versión 1.1

2 Hoja de Control Título Documento de Referencia Responsable Manual de generación del zip para herramienta de validación COVER NORMATIVA ATLAS ICM Versión 1.1 Fecha Versión 15/12/ Revisado/Validado por: Fecha Revisión/Validación 2 Aprobado por: Fecha Aprobación Registro de Cambios Versión Causa del Cambio Responsable del Cambio Fecha del Cambio 1.0 Versión inicial del documento Arquitectura de Software 13/05/ Entregas SVN Arquitectura de Software 15/12/2014 Página 2 de 21

3 Índice 1 INTRODUCCIÓN AUDIENCIA OBJETIVO CONOCIMIENTOS PREVIOS GENERACIÓN DEL ZIP PARA COVER PROCESO DE CREACIÓN DEL ZIP EJEMPLO DE GENERACIÓN PARA ARQUETIPO DE TIPO WEB SERVICE USO DE LA HERRAMIENTA SUBIDA DEL INFORME GENERADO A SUBVERSIÓN PLUGIN MAVEN ENTREGAS SVN REQUISITOS PREVIOS: CONFIGURACIÓN PREPARACIÓN DEL PROYECTO MAVEN EJECUCIÓN EJEMPLO DE UNA ENTREGA CON ECLIPSE Página 3 de 21

4 Contenido 1 INTRODUCCIÓN En este documento se indica el procedimiento a seguir para la validación de la normativa de Atlas mediante COVER. La herramienta COVER permite comprobar si un proyecto generado mediante cualquier tipo de arquetipo de Atlas se ajusta a la normativa Atlas recogida en el documento ATLAS_NORMATIVA.pdf. 1.1 AUDIENCIA OBJETIVO Este documento está orientado a toda aquella persona que necesite verificar si un desarrollo realizado con el framework de atlas se ajusta a la normativa atlas vigente. 1.2 CONOCIMIENTOS PREVIOS Para un completo entendimiento del documento, el lector deberá tener conocimientos previos sobre las siguientes tecnologías: Maven Framework de desarrollo de aplicaciones ATLAS Página 4 de 21

5 2 GENERACIÓN DEL ZIP PARA COVER En este apartado se explica cómo generar el archivo empaquetado (.zip) que habremos de crear para su uso por parte de la herramienta COVER. La generación del archivo.zip es muy sencilla y se puede llevar a cabo al mismo tiempo que la generación del arquetipo. 2.1 PROCESO DE CREACIÓN DEL ZIP Para crear el fichero.zip que necesitaremos para COVER, basta con ejecutar el siguiente comando de Maven desde el directorio padre de nuestro proyecto: mvn package P compresor -E Con este comando le indicamos a Maven que ejecute el empaquetado del proyecto con el perfil para la generación del ZIP (compresor) y que no lo haga de manera recursiva para el resto de proyectos hijos, si es que los hay. Para el caso de los arquetipos de tipo WEB (incluye GSTA y Documentum) y Web Service habrá que ejecutar el comando desde el directorio en el que se halla el archivo pom.xml padre, que es el directorio del que cuelgan los subproyectos web, test y lib (para el caso del arquetipo web service) El fichero.zip se generará dentro de un directorio denominado target que estará colgando directamente del proyecto padre. 2.2 EJEMPLO DE GENERACIÓN PARA ARQUETIPO DE TIPO WEB SERVICE Vamos a ilustrar lo mencionado anteriormente con el ejemplo de generación del.zip para un proyecto basado en un arquetipo de tipo Web Service. Además, el ejemplo se realizará desde el IDE Eclipse. 1. Partiremos de un proyecto creado a partir de dicho arquetipo, que tendrá la siguiente estructura: Página 5 de 21

6 2. Nos situaremos sobre el proyecto padre (ejpl_ws) y pincharemos con el botón izquierdo del ratón y seleccionaremos la opción Run as / Maven Build 3. En la ventana de configuración que nos aparecerá iremos a la ventana de texto que indica Goals y teclearemos clean install. En la ventana de texto inferior que indica Profiles teclearemos compresor, marcaremos la casilla Non-recursive y a continuación haremos click en el botón Run. En el ejemplo también hemos seleccionado la casilla Skip Tests para que sea más rápida la generación Página 6 de 21

7 4. Cuando Maven haya terminado de realizar sus tareas nos debería aparecer un mensaje similar a este en la consola de Eclipse: Página 7 de 21

8 Para obtener el archivo zip que necesitaremos subir a COVER debemos ir a la carpeta target que se habrá generado dentro del directorio de nuestro proyecto. Para ello debemos ir hasta donde tengamos desplegado nuestro workspace de Eclipse y acceder al proyecto oportuno. Si todo ha ido bien comprobaremos que se ha creado un directorio target y dentro del mismo un archivo.zip cuyo nombre se corresponde con el del proyecto. En nuestro ejemplo quedaría así: Página 8 de 21

9 3 USO DE LA HERRAMIENTA Para acceder a la herramienta COVER abriremos esta URL desde un navegador ( Ya existe un documento que explica cómo utilizar COVER, que está en esta dirección: Subida del informe generado a Subversión El informe generado por COVER en PDF se debe subir a subversion a la carpeta certificados del proyecto Esta carpeta deberá estar a la misma altura que test y web. Si no está creada, crearla. En esta carpeta certificados se deberán guardar todas las autorizaciones excepcionales del proyecto y todos los informes de cover por fechas. Página 9 de 21

10 4 PLUGIN MAVEN ENTREGAS SVN El plugin maven de entregas SVN es el encargado de actualiza automáticamente la versión de los proyectos maven y realizar liberaciones de este en una ruta especifica en subversión. 4.1 Requisitos Previos: El usuario debe tener permisos de lectura y escritura sobre la carpeta raíz del proyecto. El proyecto debe existir previamente en subversión. La carpeta entregas debe existir en subversión. Antes de ejecutar el plugin debe estar consolidada una versión estable del proyecto en el repositorio. El proyecto debe tener la siguiente estructura de carpetas en el repositorio: Estructura de proyecto en repositorio Entregas/ (Entregas realizas. Valor para la propiedad tags) o o _expl_v1.0.1/ _expl_v1.0.2/ V0/ (Raíz del código fuente) o o o o pom.xml expl_app/ expl_lib/ La copia de trabajo local debe ser una copia exacta de la que se encuentra en el repositorio. Página 10 de 21

11 4.2 Configuración Preparación del proyecto maven. Las siguientes modificaciones se realizaran en el fichero pom.xml del contenedor de proyectos. Para los nuevos proyectos creados con la versión de atlas no es necesario seguir estos pasos, pero si se debe comprobar que las rutas asignadas a los parámetros trunk y tags existan. Seguir los siguiente pasos para configurar el perfil de entregas en el proyecto. 1. Abrir el fichero pom.xml del padre de nuestro proyecto 2. Agregar la siguiente propiedad en el fichero pom.xml: <?xml version="1.0" encoding="utf-8"?> Propiedades <project xmlns=" xmlns:xsi=" xsi:schemalocation=" <properties> Página 11 de 21

12 ... <urlrepo> </properties>... </project> Página 12 de 21

13 3. Agregar el siguiente perfil: Perfil entregas-svn <?xml version="1.0" encoding="utf-8"?> <project xmlns=" xmlns:xsi=" xsi:schemalocation=" <profiles>... <profile> <id>entregas_svn</id> <build> <plugins> <plugin> <groupid>atlasfrm</groupid> <artifactid>atlasfrm-plugins-svn-releases</artifactid> <version>1.2.8</version> <configuration> <trunk>${urlrepo}/v0/</trunk> <tags>${urlrepo}/entregas/</tags> </configuration> <executions> <execution> <goals> </goals> </execution> </executions> <goal>perform</goal> Página 13 de 21

14 </plugin> </plugins> </build> </profile>... </profiles>... </project> Importante Una vez agregado el perfil en el fichero pom.xml del proyecto, se debe realizar commit de este fichero. El plugins de entregas svn consta de los siguientes parámetros de configuración: Nombre Tipo Desde Descripción trunk url - Ruta principal donde se encuentra el proyecto en subversión. Valor por defecto: null Uso obligatorio: si tags url - Ruta donde se almacenaran las entregas en subversión Valor por defecto: null Uso obligatorio: si Página 14 de 21

15 4.2.2 Ejecución Para ejecutar el plugin maven de entregas-svn, basta con ejecutar el siguiente comando maven desde el directorio padre de nuestro proyecto. Comando Maven Windows Linux C:\>workspace\proyecto> mvn Pentregas_svn $ mvn Pentregas_svn Con el anterior comando indicamos que se ejecute el proceso para realizar la entrega del proyecto en subversión. La ejecución realiza los siguiente pasos: Paso Descripción Muestra ventana que permite al usuario digitar las credenciales de subversión. 1. Solicitar Credenciales: Página 15 de 21

16 2. Inicializar Librerías: 3. Validar Acceso y Rutas: 4. Verificar cambios: Inicializa las librerías de conexión a subversión para los protocolos http y https. Verifica las credenciales del usuario y que las rutas especificadas en las propiedades de configuración trunk y tags corresponda a una ruta de carpeta valida. Verifica que en la copia de trabajo local no existan modificaciones o ficheros nuevos no subidos al repositorio. 5. Verificar Versión de entrega: Verifica que la entrega no exista en el repositorio. 6. Actualizar Versión de ficheros pom.xml: 7. Commit de ficheros pom.xml: 8. Crear entrega: 9. Actualiza copia de trabajo local: Actualiza automáticamente la versión de todos los proyectos maven a la siguiente versión. Sube a la ruta especificada en la propiedad trunk solo los ficheros pom.xml que han sido modificados con la subida de versión. Copia el contenido se encuentra dentro de la trunk en tag creando una nueva carpeta con el siguiente formato: yyyymmdd_proyecto_vx.y.z. Ejemplo: _expl_v1.0.1 Actualiza la copia de trabajo local con la nueva revisión. 10. Cerrar conexión. Cierra conexión a subversión. Página 16 de 21

17 Página 17 de 21

18 4.3 Ejemplo de una entrega con eclipse A continuación detallaremos paso a paso como realizar una entrega de un proyecto que contiene varios módulos maven desde el IDE de desarrollo eclipse. 1. El proyecto ejemplo tendrá la siguiente estructura: 2. Posiciónese sobre el proyecto padre y presione el botón izquierdo del ratón. Seleccione la opción Run as / Maven Build Aparecerá la ventana de configuración de ejecuciones maven. 3. En la ventana de configuración, en el campo profiles digitar el nombre del perfil a ejecutar, en nuestro caso entregas_svn. A continuación presione el botón Run para ejecutar el perfil. Página 18 de 21

19 4. Durante la ejecución aparecerá una ventana de login que pedirá las credenciales de acceso al repositorio. Digite usuario y contraseña. Por ultimo presione el botón Aceptar. Si presiona el botón cancelar finalizara la ejecución. 5. Cuando maven haya terminado de realizar sus tareas veremos en la consola de logs de eclipse un mensaje indicando que la entrega se ha realizado. Página 19 de 21

20 6. Para comprobar que la entrega se ha realizado exitosamente, solo debemos revisar que en la ruta del repositorio designada a entregas se ha creado una carpeta una con la fecha de la ejecución y la versión esperada de la entrega del proyecto. Página 20 de 21

21 Página 21 de 21