Oficina de Calidad Subdirección de Tecnologías de la Información y Comunicaciones. Gestión de Entregas. Procedimiento para la Entrega de Software

Transcripción

1 Gestión de Entregas Versión: v03r04 Fecha: 15/10/2014

2 CONTROL DE CAMBIOS DEL DOCUMENTO Registro de cambios Autor Versión Referencia de cambios Fecha Fco. Javier Delgado V02r04 Creación del documento 14/10/2011 Fco. Javier Delgado V03r01 Versionado. Inclusión del código QR de la Web 14/01/2012 de Unifica. Corrección de la numeración de los subapartados del apartado Inclusión de notas al pie en apartados 2.1 y 2.4. Actualización de la referencia a la ficha de entrega de Sw e inclusión de nueva imagen con el contenido de la ficha de entrega de software en el apartado 3 Fco. Javier Delgado V03r02 Versionado. Actualización de la imagen corporativa del documento. Actualización de la política de versionado. Actualización de los apartados 2.1.4, , , , 2.3.2, 2.4 y Anexo I 26/06/2012 Antonio García Moreno V03r03 Versionado. Cambio nombre de la 03/10/2013 subdirección Arquitectura y Desarrollo V03r04 Versionado. Actualización del procedimiento para incluir los pasos correspondientes a las solicitudes de incorporación de librerías de código al repositorio Artifactory y de alta de los desarrollos en el proceso de Integración Continua y Revisión de Calidad. Inclusión ruta plantilla ficha de entrega de software. Otros cambios menores 15/10/2014 Revisores Nombre Versión Aprobada Posición Fecha Francisco Javier Delgado V03r04 Responsable de Desarrollo STIC 15/10/2014 Propiedades del documento Propiedad Detalle Título Gestión de Entregas Proyecto Autor Francisco Javier Delgado Leal Nombre fichero OCa_Nrm_SVN_GestionEntregas_v03r04 Fecha de creación 13/09/ :54 Ultima actualización 15/10/ :00 Plantilla base OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 2 de 12

3 INDICE 1 INTRODUCCIÓN OBJETIVO ALCANCE CONDICIONES DE USO GESTIÓN DE ENTREGAS ENTORNO TECNOLÓGICO ESTRUCTURA DEL REPOSITORIO ESTRUCTURA DE CÓDIGO FUENTE PROCEDIMIENTO DE ENTREGA DE CÓDIGO FUENTE GLOSARIO BIBLIOGRAFÍA Y REFERENCIAS OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 3 de 12

4 LISTA DE FIGURAS Figura 1. Organización de los fuentes en el repositorio de código Figura 2. Campo Ficha de Entrega de Sw en el formulario de la PL OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 4 de 12

5 1 Introducción La gran diversidad de tecnologías aplicadas hasta el momento para el desarrollo de las aplicaciones existentes en el marco de la (STIC) del Servicio Andaluz de Salud (SAS) de la Junta de Andalucía (JA), hace necesaria la elaboración de unas normas específicas que posibiliten la homogeneización de los desarrollos y su adecuación al entorno de explotación específico definido. 1.1 Objetivo Partiendo de la base proporcionada por MADEJA, este documento recoge la Normativa aplicable a la Gestión de Entregas, así como el procedimiento relativo a la entrega de Software de los desarrollados realizados dentro del marco de la STIC. Con la aplicación de estas normas y recomendaciones, la STIC pretende: Definir las herramientas para la Gestión de Entregas. Definir la estructura del código fuente, los acuerdos de marcado de versiones y la política de numeración de versiones. Implantar y normalizar el procedimiento de entrega de código fuente. Con esto, el fin último de este documento es proporcionar un repositorio único para el almacenamiento del código fuente de los productos Software de la STIC. 1.2 Alcance El presente documento va dirigido a los siguientes actores: Los Equipos de Desarrollo, que han de cumplir las normas y recomendaciones aquí presentadas. La (OCa) y el Equipo de Jefes de Proyectos del Departamento de Desarrollo Los equipos de Despliegue de los productos Software. Los Responsables de la Gestión de Cambios y la Gestión de Lanzamientos. 1.3 Condiciones de Uso Las normas y recomendaciones recogidas en este catálogo son de obligado cumplimiento. La STIC podrá estudiar los casos excepcionales. Asimismo cualquier aspecto no recogido en este documento deberá ser puesto de manifiesto ante la STIC por el equipo de desarrollo para la adopción de una decisión al respecto. La STIC se reserva el derecho a la modificación de la norma sin previo aviso, tras lo cual, notificará del cambio a los actores implicados para su adopción inmediata. En el caso de que algún actor considere conveniente y/o necesario el incumplimiento de alguna de las normas y/o recomendaciones, deberá aportar previamente la correspondiente justificación fehaciente y documentada de la solución alternativa propuesta, así como toda aquella documentación que le sea requerida por la STIC para proceder a su validación técnica. OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 5 de 12

6 2 Gestión de Entregas La gestión de las entregas del software desarrollado por y para la Subdirección de Tecnologías de la Información y Comunicaciones del Servicio Andaluz de Salud se realizará usando las herramientas y los procedimientos y normas definidos a continuación. 2.1 Entorno Tecnológico Subversion La entrega de código fuente, independientemente de la tecnología empleada para el desarrollo de la aplicación software, deberá realizarse accediendo, a través de VPN, al repositorio Subversion publicado en la dirección donde: proyecto es el anagrama o el nombre del repositorio que alberga el proyecto. es opcional. Puede implicar navegación por subproyectos y/o módulos. aplicación es el anagrama o el nombre de la aplicación dentro del proyecto Artifactory Las librerías utilizadas para el desarrollo de las aplicaciones deberán proceder del repositorio de librerías del SAS: En caso de que fuese necesaria la implementación de una librería propia del proyecto, o el uso de librerías pertenecientes a un repositorio no incluido, deberá reseñarse en la ficha de entrega de la PL correspondiente, para proceder a su incorporación al propio del SAS TortoiseSVN Para el acceso al repositorio desde sistemas Windows se recomienda el uso de la herramienta TortoiseSVN Maven De forma general, los desarrollos JEE cuyo código fuente sea incorporado al repositorio de la STIC deberán ser configurados con la herramienta Maven, según las pautas definidas por MADEJA. El uso de Maven se restringirá a la versión 3.X. 2.2 Estructura del Repositorio La estructura del repositorio de código fuente Subversion se ajustará en todo momento a la establecida por MADEJA, definiendo para cada aplicación los directorios trunk, branches y tags. 2.3 Estructura de Código Fuente La estructura del código fuente variará dependiendo de la tecnología de desarrollo empleada Estructura de Directorios Desarrollos Java y PHP Para nuevos desarrollos con tecnología JEE y PHP, el código fuente deberá estar estructurado según las pautas proporcionadas por MADEJA, según se trate de proyectos simples o proyectos complejos. OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 6 de 12

7 Desarrollos VB6 y.net Para los desarrollos.net, el código fuente deberá estar estructurado según las pautas definidas en el documento de definición del Framework Base.NET desarrollado en base a la Arquitectura de Referencia.NET y referenciado en el documento de Normas de Desarrollo.NET publicado en el portal Unifica Desarrollos ENSEMBLE Para los desarrollos realizados con tecnología ENSEMBLE e incorporados al repositorio de código no existe una estructura de directorios específica. Estos desarrollos son incorporados al repositorio como un fichero con formato XML plano Otros desarrollos: Cobol y Delphi El resto de proyectos existentes en la STIC, con tecnología Cobol y Delphi, mantendrán la estructura de directorios existente actualmente debiéndose incluir, en la medida de lo posible y para aquellos casos que no hagan ya, los scripts de BBDD en un directorio identificado a tal efecto dentro del mismo paquete de software Versionado de las entregas El versionado de las entregas, independientemente de la tecnología de desarrollo, deberá corresponderse con el establecido por MADEJA, identificado con 4 dígitos, según la notación mayor.menor.revisión.entrega, donde: mayor: indica la versión principal del software, consistiendo en un conjunto de funcionalidades concretas que son recogidas y cubiertas en dicha versión. Debe modificarse cuando la versión que se entregue presente nuevas funcionalidades claves de la aplicación respecto de la versión anterior. La modificación de esté dígito se realiza por la inclusión de nuevos requerimientos al sistema, tal y como la inclusión de nuevos módulos o una revisión completa de los existentes. menor: indica la funcionalidad menor cubierta en la versión de software entregada. Debe ser modificado cuando hay cambios significativos en la forma en la que se ofrece la funcionalidad existente, cuando se corrigen grandes fallos del sistema, o cuando hay nuevas versiones evolutivas que modifican significativamente la funcionalidad ofrecida. revisión: se modifica cuando hay revisiones de código ante fallos de la aplicación. entrega: a diferencia de Madeja, este dígito indica el número de veces que un paquete ha sido entregado o, lo que es lo mismo, el número de PLs entregadas para una misma RFC. Debe incrementarse con cada nueva PL creada para una RFC tras la anulación de la anterior como consecuencia de un defecto de software detectado en la fase de despliegue o instalación del software. La primera versión estable de cualquier producto debe comenzar en la versión Además: El versionado de las RFCs debe realizarse con 3 dígitos según la notación mayor.menor.revisión. El versionado de las PLs de cada RFC debe añadir un cuarto dígito a la versión identificada para la RFC de la que depende, según la notación mayor.menor.revisión.entrega y, siempre, en consonancia con el versionado de las entregas de software realizadas en el repositorio de código de corporativo del Servicio Andaluz de Salud. OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 7 de 12

8 2.4 Procedimiento de entrega de Código Fuente La entrega de código fuente en el repositorio de código de la STIC se realizará conforme al siguiente procedimiento: 1. Previa entrega, y en caso de no existir ya, se deberá solicitar, mediante petición CGES al menos 48 horas hábiles antes de la entrega del Software, la creación del repositorio y la estructura de carpetas correspondiente para el proyecto y la aplicación en cuestión para la que se van a incorporar los fuentes en Subversion. En dicha solicitud, el proveedor deberá proporcionar la siguiente información: Aplicación afectada: ALM_SUBVERSION Usuario asignado: TIC OCA DESARROLLO-ARQUITECTURA Asunto de la Solicitud: [Subversion] Asignación de espacio para <Proyecto/Aplicación> Cuerpo de la Solicitud: Solicito la asignación de espacio en el repositorio de Código Subversion para el <proyecto/aplicación> siguiente: Nombre y Anagrama del proyecto identificado en FARO Nombre y Anagrama de la aplicación identificada en FARO Número de la RFC generada en FARO para la solicitud del cambio Datos de contacto del Director o Coordinador del proyecto en la STIC/SAS - Nombre y Apellidos - Teléfono de contacto - Dirección de correo electrónico corporativo Nombre de la empresa proveedora Datos del Jefe del Proyecto o Responsable Técnico para el acceso al repositorio - Nombre y Apellidos - NIF - Teléfono de contacto - Dirección de correo electrónico corporativo (bien de la junta de Andalucía o, en su defecto, del proveedor). 2. Preparar el paquete para la entrega, incluyendo código fuente y scripts de base de datos según la estructura de directorios definida en los apartados anteriores. 3. Cumplimentar la Ficha de Entrega de Software según la plantilla proporcionada en Unifica +Sw./12a9f7b2-acd3-451d a4f59d66a54, identificándola según el formato siguiente <IDPRY>.<IDAPL>_EntregaSoftware_<VERSION>, donde: <IDPRY> es el identificador o anagrama del proyecto, <IDAPL> es el identificador o anagrama de la aplicación y <VERSION> es el número de versión de la entrega de software (3 dígitos) Ejemplo: DY.Diabaco_EntregaSofware_100.xls 4. Para aquellos aplicativos cuya construcción (JEE,.NET, etc.) requiera de la existencia de librerías nuevas o actualizadas propias del proveedor o externas y cuyo código fuente no sea propiedad del Servicio Andaluz de Salud, éstas deberán ser recopiladas y empaquetadas junto con la ficha de entrega en un fichero con formato.zip, identificado con el mismo nombre que la propia ficha (p.e. DY.Diabaco_EntregaSofware_100.zip). El fichero.zip generado deberá ser enviado, mediante petición CGES al menos 48 horas hábiles antes de la entrega de la PL, para la incorporación de las librerías al repositorio corporativo (Artifactory) antes de la construcción del OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 8 de 12

9 proyecto durante la revisión de calidad de la PL. Los datos asociados a esta petición CGES deben ser los siguientes: Aplicación afectada: ALM_ARTIFACTORY Usuario asignado: TIC OCA DESARROLLO-ARQUITECTURA Asunto de la Solicitud: [Artifactory] Incorporación/Actualización de librerías Cuerpo de la Solicitud: Solicito la <incorporación>/<actualización> de las librerías adjuntas a esta petición en el repositorio de librerías corporativo del Servicio Andaluz de Salud. Proyecto asociado: <Nombre y Anagrama del proyecto identificado en FARO> Aplicación asociada: <Nombre y Anagrama de la aplicación identificada en FARO> Empresa proveedora:<nombre empresa proveedora> Responsable técnico:<nombre responsable técnico empresa proveedora> Responsable STIC:<Nombre del responsable del proyecto en la STIC> Documentos adjuntos: <(Ejemplo)DY.Diabaco_EntregaSofware_100.zip> 5. Incorporar los fuentes a la rama trunk de la aplicación en el repositorio correspondiente, sobreescribiendo los fuentes existentes y siempre agrupados en una carpeta de aplicación o módulo única (Figura 1). 6. En caso de tratarse de la primera subida de código al repositorio o en el caso de que no se haya realizado ya antes, y para aquellos proyectos con tecnología Java o PHP, será necesario solicitar, mediante petición CGES al menos 48 horas hábiles antes de la entrega de la PL, el alta de la tarea de construcción asociada el proyecto para su inclusión en el proceso de Integración Continua y Revisión de la Calidad del Código Fuente. Será necesario indicar o adjuntar a esta petición los detalles relativos a la configuración de la tarea en el motor de Integración Continua (perfiles a utilizar, instrucciones y comandos ant a especificar, ficheros o instrucciones a tomar como referencia en caso necesario, exclusiones a tener en cuenta para la revisión de calidad, etc.). Los datos asociados a esta petición CGES deben ser los siguientes: Aplicación afectada: ALM_JENKINS Usuario asignado: TIC OCA DESARROLLO-ARQUITECTURA Asunto de la Solicitud: [Integración Continua] Solicitud de alta Cuerpo de la Solicitud: Solicito el alta del aplicativo siguiente en el proceso de Integración Continua y Revisión de la Calidad del Código Fuente del Servicio Andaluz de Salud. Proyecto asociado: <Nombre y Anagrama del proyecto identificado en FARO> Aplicación asociada: <Nombre y Anagrama de la aplicación identificada en FARO> Url Repositorio Código: Empresa proveedora:<nombre empresa proveedora> Responsable técnico:<nombre responsable técnico empresa proveedora> Responsable STIC:<Nombre del responsable del proyecto en la STIC> Documentos adjuntos: <Ficheros e indicaciones para realizar la configuración> 7. Etiquetar la entrega de la rama trunk en la rama tags según la normativa definida para el versionado y manteniendo la misma organización definida para la rama trunk (Figura 1). 8. Incorporar la ficha de entrega cumplimentada en (3) o, en su caso, el paquete de entrega de software definido en (4), al campo Ficha de Entrega de Software habilitado para ello en el formulario de la petición de lanzamiento (PL) correspondiente (Figura 2). OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 9 de 12

10 9. Cumplimentar el campo observaciones de la PL correspondiente con los comentarios relativos a las excepciones o peculiaridades a tener en cuenta durante la revisión de calidad de dicha PL, como pueden ser las peticiones CGES no resueltas y con las que exista alguna dependencia. Figura 1. Organización de los fuentes en el repositorio de código Figura 2. Campo Ficha de Entrega de Sw en el formulario de la PL OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 10 de 12

11 3 Glosario JA Junta de Andalucía SAS Servicio Andaluz de Salud STIC Subdirección de Tecnologías de Información OCa MADEJA MArco de DEsarrollo de la Junta de Andalucía OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 11 de 12

12 4 Bibliografía y Referencias MADEJA: OCa_Nrm_SVN_GestionEntregas_v03r04.doc Página 12 de 12