Widget / Porltet

Resumen simple de una estructura base de un Widget/Portlet para desarrollar en Transbank.

 

Estructura básica del proyecto web.

1) src/main/java Directorio packages y de clases Java.

2) src/main/resources Directorio de recursos web, js, properties y log4j.

3) src/test/java Directorio packages y de clases donde habilitarán los test unitarios.

4) gradle Directorio del wrapper de gradle para ejecutar tareas de gradle como limpiar, compilar y desplegar el proyecto. [versiones 5.6.4 - 6.0 compatibles con el plugin de liferay]

5) bnd.bnd Archivo de configuración del bundle OSGi donde se configura el nombre del bundle (widget), resolución de importación y exportacion clases y packages, y version (actualmente la version esta parametrizada)

6) build.gradle Archivo de configuración de los plugins y dependencias del proyecto y tareas personalizadas

7) gradlew Script de gradle que se utilizara para ejecutar las tareas configuradas en el build.gradle, este archivo invocara el wrapper configurado en el punto 4)

8) pipeline.yml Archivo de instrucciones secuenciales requerido por el proceso de Pipeline Jenkins, el cual validará 4 tareas principales - Compilación correcta del projecto - Ejecución de test unitarios[Y cálculo de cobertura] - Escaneo de código estáticoKiuwan - Despliegue de artefacto a repositorio Artifactory Debe considerarse solicitar a QA la creacion del proyecto en Kiuwan el cual debe seguir la nomenclatura "por-nombre-proyecto-x"

9) settings.gradle Archivo de configuracion del proyecto gradle donde se configura el nombre del projecto (este nombre debe coincidir con el nombre de la carpeta donde se aloja el projecto)

Transbank Liferay Generator

Projecto desarrollado con Ant para procesar plantillas freemarker con codigo java y generar un projecto base

Requisitos para utilizar el generador

1) Instalar Apache Ant el cual puede descargarse del siguiente link

2) Una vez descargado descomprimir en un directorio

3) Configurar variables de entorno (Windows)

3.1 Configurar variables de entorno (macOS)

Ejecutar el comando para editar las variables de entorno del usuario

vim ~/.bash_profile

Declarar la variables ANT_HOME

export ANT_HOME=/directorio/de/tu/ant-1.10.12/

Agregar la variable declarada ANT_HOME a tu variable PATH agregandole /bin alfinal

export PATH=$PATH:$GRADLE_HOME/bin:$M2_HOME/bin:$ANT_HOME/bin

Ejecutar comando ant -v para validar el correcto funcionamiento de Ant

ant -v

Ejemplo de como configurar Ant

Projecto Transbank Liferay Generator [Widget/Portlet]

El proyecto de generador de proyecto base se puede encontrar aquí una vez clonado el proyecto podremos ejecutar los comandos Ant.

Comandos Ant

1) ant clean

2) ant dist

3) ant generate <portletName> <packageName> <projectName> <type> <description> <gradleVersion>

Ejemplo de comando generador de Widget/Portlet

ant generate -Dtbk.portletName=ExamplePortlet -Dtbk.packageName=cl.tbk.example -Dtbk.projectName=tbk-example-web -Dtbk.type=portlet -Dtbk.description='Portlet de ejemplo' -Dtbk.gradleVersion=6

Projecto Transbank Liferay Generator [Api/Service]

Próximamente