• Antes de empezar a programar +
  • ¿Qué versión de Symfony utiliza?
  • Sistema de Prioridades de Plugins
  • Diagramas de tablas
  • Cómo hacer un pull-request
• Creación de Plugins +
  • El archivo facturascripts.ini
  • El archivo Init.php
  • Los Controladores +
    • Controladores extendidos +
      • ListController en FacturaScripts +
        • addFilterAutocomplete()
        • addFilterCheckbox()
        • addFilterDatePicker()
        • addFilterNumber()
        • addFilterPeriod()
        • addFilterSelect()
        • addFilterSelectWhere()
      • EditController
      • PanelController +
        • addHtmlView()
        • addEditView()
        • addEditListView()
        • addListView()
      • Personalizando con Settings
      • Método disableColumn()
      • Interacción con las Vistas
    • Obtener Parámetros de la URL, Formularios o Cookies
    • Cómo guardar una cookie
    • Consultar el usuario y sus permisos
    • Formularios de edición de facturas, albaranes, etc
  • Añadir un Endpoint a la API
  • Los modelos +
    • Operaciones comunes con modelos
    • XML de la tabla
    • ModelOnChangeClass
    • Modelos de Más de Una Tabla
    • Modelos Especiales
    • Cómo crear una factura, albarán, pedido o presupuesto
    • Herencia de Modelos
    • $modelo->install()
    • $modelo->all()
    • $modelo->clear()
    • $modelo->count()
    • $modelo->delete()
    • $modelo->exists()
    • $modelo->loadFromData()
    • $modelo->get()
    • $modelo->getModelFields()
    • $modelo->loadFromCode()
    • $modelo->primaryColumnValue()
    • $modelo->primaryColumn()
    • $modelo->newCode()
    • $modelo->tableName()
    • $modelo->save()
    • $modelo->primaryDescription()
    • $modelo->primaryDescriptionColumn()
    • $modelo->url()
    • $modelo->test()
  • Las vistas HTML +
    • Iconos disponibles
    • Herencia de plantillas
  • Las vistas XML (XMLView) +
    • Columns
    • Rows +
      • Row status
      • Row statistics
      • Row actions
      • Row header y footer
    • Modals
    • Group
    • Column
    • Widgets +
      • Widget Autocomplete
      • Widget Bytes
      • Widget Checkbox
      • Widget Color
      • Widget Datalist
      • Widget Date
      • Widget Datetime
      • Widget File
      • Widget Library
      • Widget Link
      • Widget Money
      • Widget Number
      • Widget Password
      • Widget Select
      • Widget Stars
      • Widget Text
      • Widget Textarea
      • Widget Time
      • Widget Radio
      • Widget Variante
  • Las traducciones en Plugins
  • Las extensiones +
    • Extensiones de controladores
    • Extensiones de modelos
    • Extensiones de tablas
    • Extensiones de XMLView
    • Extensiones de Vistas HTML
  • Mostrar mensajes, errores y alertas
  • Acceso a la Base de Datos +
    • DbQuery
    • Where
    • DataBaseWhere
  • Settings: opciones del panel de control +
    • Cómo crear preferencias de aplicación para su plugin
  • Generación de PDF y Excel
  • AssetManager
  • El archivo Cron.php
  • Cómo publicar plugins
• Profundizando en el CORE +
  • Enrutado
  • Gestión de Errores
  • Gestión de Plugins
  • Uso de la caché
  • La cola de trabajos
  • Descarga de Archivos desde MyFiles
  • Cliente de API de OpenAI
  • Cliente HTTP +
    • Conectar con otro FacturaScripts mediante API
  • Validar Emails, Cadenas y URLs
  • Enviar emails con NewMail
• Test unitarios en plugins
• Migración de plugins antiguos +
  • Row Business (Obsoleto)
  • Migrar los XML de las tablas de 2017
  • Migrar Modelos de 2017
  • addGridView() - (obsoleto)
• La API REST +
  • Listado de recursos
  • Listar, filtrar y ordenar registros
  • Obtener un registro concreto
  • Crear o añadir registros
  • Cómo crear facturas
  • Obtener el PDF de una factura
  • Modificar registros
  • Eliminar registros

Pruebas de Plugins (tests unitarios)

Podemos realizar pruebas de nuestro plugin utilizando PHPUnit, colocando los tests unitarios en la carpeta Test del plugin. A continuación, podemos observar un ejemplo en el repositorio de GitHub del plugin Informes.

🗂️ Estructura de archivos

El plugin debe tener una carpeta Test y dentro otra carpeta main, donde finalmente van los archivos php con los tests unitarios, además del archivo install-plugins.txt

• Test
  • main
    • install-plugins.txt
    • MiTest.php
    • MiSegundoTest.php
    • ...

Si además queremos ejecutar pruebas de nuestro plugin en combinación con otros, podemos crear más carpetas dentro de Test, cada una con un archivo install-plugins.txt propio donde indicaremos los plugins a activar para ejecutar esos tests.

• Test
  • main
    • install-plugins.txt
    • MiTest.php
    • MiSegundoTest.php
    • ...
  • informes
    • install-plugins.txt
    • ...

📃 Archivo install-plugins.txt

En el archivo install-plugins.txt debemos incluir los nombres de los plugins a instalar. Por defecto, se debe añadir el nombre del propio plugin. Si se requieren activar otros plugins previamente, simplemente se debe colocar la lista de plugins a instalar, separados por comas. No olvides incluir el nombre del plugin que estás desarrollando:

StockAvanzado,Servicios

🧪 Creación de un Test Unitario

Podemos crear un test unitario utilizando fsmaker con el parámetro test. Nos pedirá el nombre del archivo y lo creará en la carpeta.

fsmaker test

También podemos crear el test manualmente. Este debe ser un archivo PHP cuyo nombre termine por Test. Debe usar el espacio de nombres FacturaScripts\Test\Plugins y heredar de PHPUnit\Framework\TestCase. Además, las funciones a ejecutar dentro del test unitario deben tener un nombre que comience por test.

<?php

namespace FacturaScripts\Test\Plugins;

use PHPUnit\Framework\TestCase;

class MiTest extends TestCase
{
    public function testCreate(): void
    {
        // tu código aquí
    }
}

Recuerda que las funciones deben comenzar por test, de lo contrario no se ejecutarán al pasar los tests.

🚀 Ejecución de Tests

Para ejecutar los tests del plugin podemos usar igualmente fsmaker, pero con la opción run-tests:

fsmaker run-tests

Si preferimos ejecutarlos manualemente, debemos copiar los tests del plugin a la carpeta Test/Plugins de FacturaScripts, abrir un terminal en la carpeta raíz de FacturaScripts y ejecutar los siguientes comandos:

php install-plugins.php
vendor/bin/phpunit phpunit-plugins.xml

🕑 Ejecución de Tests como GitHub Actions

Puedes crear una acción de GitHub para ejecutar los tests del plugin con cada nuevo commit. Aquí tienes un ejemplo:

• Ejemplo de GitHub Action