You are currently browsing the category archive for the ‘sw.dev.angularjs’ category.

Desde hace poco más de un mes lidio el testing de componentes con AngularJS. Ahora veremos algunos detalles sobre este proceso.

Un componente encapsula un elemento UI y sus interacciones con el usuario. Tiene que ser claro, reusable y probado como una unidad sin recurrir a ninguna implementación de Selenium como puede ser Protractor.

Ahora bien, usualmente no encontraremos con dos maneras de escribir pruebas unitarias. La primera puede ser como en el ejemplo de AngularJS probando el controlador sin considerar la vista. El otro usa el servicio $compile para renderizar el componente accediendo con selectores del DOM y lanzando eventos.

Podríamos tener un componente como el siguiente:

<div>
  <item-input on-added="$ctrl.onAdded(item)"></item-input>
  <items titles="$ctrl.titles"></items>
</div>

Vemos en dos subcomponentes más.

angular.module(...)
  .component('item', {
    bindings: {
      title: '=',
    },
    template: 'Title: {{ $ctrl.title }}',
  })
  .component('items', {
    bindings: {
      titles: '=',
    },
    template: `
    <ul>
      <li>
        <item title="title"></item>
      </li>
    </ul>
    `,
  })
;

La prueba unitaria del controlador

La prueba unitaria elemental (e incompleta) es la que se hace mediante el controlador asociado al componente. El problema de esto es que se necesita exponer los métodos que actúan sobre el formato de los atributos que son usados en el template.

class ItemController {
  displayTitle() {
    return `Title: ${this.title}`;
  }
}

angular.module(...)
  .component('item', {
    bindings: {
      title: '=',
    },
    controller: ItemController,
    template: '{{ $ctrl.displayTitle() }}',
  })
;

Luego, podemos escribir la prueba unitaria con los displayers en el controlador:

describe('ItemController', () => {
  beforeEach(angular.mock.module(...));

  it('should display labeled title', inject($componentController => {
    const bindings = {
      title: 'A Title',
    };
    const controller = $componentController('item', null, bindings);

    expect(controller.displayTitle()).toBe('Title: A Title');
  }));
});

No se necesita más para identificar algunos problemas:

  1. Tenemos que adaptar el componente incluso creando código particular para lograr la prueba unitaria, el mismo que irá a parar a producción; incluso usando el servicio $componentController para evitar el registro del controlador.
  2. Exponemos el comportamiento interno del componente ya que si miramos el método displayTitle, este no es parte de la API pública; además, la prueba fallaría con sólo renombrarlo.
  3. La prueba podría ser inútil, pues nada nos asegura que el método es usado por la vista. Si no llamados apropiadamente, simplemente no lo llamamos o lo ponemos en la vista, la prueba seguirá pasando como correcta.

La prueba unitaria de la vista

Podemos orientar la prueba desde la vista de la siguiente manera:

describe('ItemComponent', () => {
  let $compile, $rootScope;

  beforeEach(angular.mock.module(...));

  beforeEach(inject((_$compile_, _$rootScope_) => {
    $compile = _$compile_;
    $rootScope = _$rootScope_;
  }));

  it('should display labeled title', () => {
    const $scope = $rootScope.$new();
    $scope['title'] = 'A Title';

    const element = $compile('<item title="title"></item>')($scope);

    $scope.$digest();

    expect(element.text()).toBe('Title: A Title');
  });
});

Estas pruebas no son exhaustivas.

describe('ItemsComponent', () => {
  let $compile, $rootScope;

  beforeEach(angular.mock.module(...));

  beforeEach(inject((_$compile_, _$rootScope_) => {
    $compile = _$compile_;
    $rootScope = _$rootScope_;
  }));

  it('should list titles', () = {
    const $scope = $rootScope.$new();
    $scope['titles'] = ['A Title', 'Other Title'];

    const element = $compile('<items titles="titles"></items>'){$scope);

    $scope.$digest();

    expect(element.find('item').length).toBe(2);
  });

  it('should display titles', () => {
    const $scope = $rootScope.$new();
    $scope['titles'] = ['A Title', 'Other Title'];

    const element = $compile('<items titles="titles"></items>')($scope);

    $scope.$digest();

    const displayedTitle = element.find('item').text();

    expect(displayedTitle).toBe('Title: A Title');
  });

});

Estos componentes nos hacen notar que ciertas cosas en la manera de probarlos.

  • Hay un patrón al escribir las pruebas que se repite. Podemos reducirlas mediante su configuración con el método beforeEach. Esto nos podría llevar a tener más contextos describe en los cuales agrupar las pruebas según los atributos usados durante la configuración del componente; por ejemplo, probar el comportamiento del componente cuando la lista de títulos está vacía.
  • Si dependemos de un componente de una library externa, tenemos que crear un mock para poder probar los componentes que la requieren.

Esto último podría hacer que necesitemos conocer el funcionamiento del framework a un nivel de especialización para poder lograr la prueba. Sin embargo, disponemos de algunos patrones que evitan esta complejidad. El patrón PageObject descrito por Selenium es una buena alternativa que ataca este problema. Pero esto es material para un próximo artículo. 🙂

 

Anuncios

Usar el objeto $rootScope es como usar variables globales en Javascript, excepto que este vive en el sistema de inyección de dependencias de AngularJS. Aunque esto sólo lo hace un tanto menos problemático: hace que el estado de un programa sea impredecible.

Imaginemos que tener un par de objetos que utilizan la misma variable global. Suponiendo incluso que no se usa ninguna función aleatoria en los módulos, entonces, el resultado de cualquier método puede predecirse ,y por lo tanto probarse, cuando se conoce el estado desde el cual se ejecuta.

Sin embargo, si un método de alguno de los objetos desencadena un efecto secundario que cambia el valor del estado global, no se sabrá cuál es el estado inicial cuando se ejecuta un método en el otro objeto. Ahora ya no se puede predecir el resultado del método y, por lo tanto, no puede probarse.

Esto no puede parecer tan serio, pero ser incapaz de hace una prueba unitaria dificulta probar la corrección de los objetos. Supongamos que tenemos una clase que asigna valores a una estructura de datos global y otra clase que consume los datos de esa estructura cambiando su estado o destruyéndola en el proceso. Si la clase que procesa ejecuta un método previo a que se complete la asignación, el resultado es que este procesador probablemente tendrá datos incompletos que procesar y la estructura de datos en la que estaba trabajando el asignador podría estar dañada o destruida. El comportamiento es impredecible y dará lugar a pérdida de información.

Además, los estados globales dificultan la legibilidad del código. Hay una dependencia externa que no se introduce explícitamente en el código. Así, cualquier responsable de mantener el código tendrá que averiguar de dónde vino determinado valor.

En cuanto a alternativas, es imposible no tener ningún estado global en absoluto, pero es posible restringirlos a un sólo objeto que engloba a todos los demás y que nunca debe referenciarse en base a las reglas de alcance del lenguaje. Si un objeto en particular necesita un estado particular, debería pedirlo explícitamente haciéndolo para como un argumento a su constructor o por un método setter. Esto se conoce como inyección de dependencia.

Puede parecer tonto pasar un estado al que ya se puede acceder mediante as reglas de alcance del lenguaje, pero tiene sus ventajas. Si alguien mira el código de forma aislada, queda claro qué necesita y de dónde viene. También tiene beneficios respecto a la flexibilidad del código mejorando las oportunidades de reuso. Si el estado se transmite y los cambios en el estado son locales al bloque de código, podemos pasar a cualquier estado que deseemos (con el tipo de dato correcto) y hacer que nuestro código lo procese. Con este estilo se tiende a tener la apariencia de una colección de componentes ligeramente asociados que pueden intercambiarse fácilmente. Al código de un módulo no debería importarle de dónde proviene el estado, sino cómo procesarlo. Si pasamos el estado a un bloque de código, este bloque puede existir de forma aislada, lo que no sucede si confiamos en la existencia de un estado global.

Resumen

  • Los errores del estado global mutable. Los errores puede ser causados por el cambio en cualquier lugar del programa que son difíciles de rastrear.

  • Pobreza de las pruebas. Cualquier prueba necesitará configurar el estado global. Esto complica escribir las pruebas, por ejemplo, las credenciales para acceder a una base de datos de toda la aplicación.

  • Poco flexible. Cuando una parte del código requiere determinado valor en el estado global, pero otra parte requiere otro valor. Se ve una desagradable refactorización.

  • Funciones impuras. Las funciones puras son aquellas cuyo resultado depende únicamente de sus argumentos, las mismas que son más sencillas de analizar y componer para crear grandes aplicaciones. Un estado global hace que sea impura.

  • Legibilidad. Un código con una cantidad considerable de variables globales se vuelve difícil de comprender haciendo incluso intratable su mantenimiento.

  • Problemas de concurrencia. El estado global requiere algún tipo de bloqueo, lo que es muy complicado y costoso de mantener.

  • Rendimiento. Si el mismo estado es usado globalmente por varios subprocesos, provoca la contención de caché y lentitud del proceso.

Alternativas

  • Parámetro de función. Tener una estructura de datos como contexto de la función. Nos ayuda a mantenerla pura y puede ser usado para pasar ese contexto a otras funciones que envuelvan toda la información relevante.

  • Inyección de dependencias. Como en el caso de los parámetros. Debemos tener cuidado si las dependencias son mutables (que pueden causar el mismo problema que las variables globales).

  • Estado global inmutable. Una constante que no debe ser mutable en ningún momento posterior.

  • Singletons inmutables. Similar al anterior, pero se les tiene que definir un momento de instanciación. Son útiles cuando grandes estructuras requieres un precálculo costoso. En su versión mutable son tan nocivos con el estado global mutable.

  • Enlazado dinámico. No se aplica a todos los lenguajes. Aisla las variables de determinado proceso haciendo que se actúe sólo sobre el hilo asignado. Es útil cuando se manejan múltiples subprocesos de transacciones independientes.

Antes veíamos una manera de comunicar dos componentes. Ahora presentaremos una forma de validar los campos de un formulario.

Añadimos la directiva de validación al módulo de EvaluationComponentsModule:

const AmountValidatorDirective: ng.IDirective = () => ({
  require: 'ngModel',
  link(scope, elm, attrs, ctrl) {
    ctrl.$validators['amount'] = (modelValue, viewValue) => {
      if (ctrl.$isEmpty(modelValue)) return true;
      return modelValue < 5;
    };
  },
});

Sólo queda usarla en el template de SurveyComponent para empezar a validar que solamente se ingresen números menores que cinco. El ejemplo completo se muestra aquí. 🙂

Como comentaba en una publicación anterior, ahora veremos una forma de comunicación entre dos componentes de AngularJS que forman parte de otro componente intermediario.

Tenemos un componente de evaluación

const EvaluationComponent: ng.IComponentOptions = {
  controller: EvaluationController,
  template: `
  <survey data="$ctrl.data"></survey>
  <chart data="$ctrl.data"></chart>
  `,
}

y su controlador

class EvaluationController implements ng.IController {
  data: EvaluationData;

  constructor() {
    this.data = {
      amount: 0,
    };
  }
}

Notemos que este componente se sirve de otros dos para poder ingresar datos y luego mostrarlos respectivamente. Así pues, la manera más sencilla de pasar información entre componentes es tener un padre común, EvaluationComponent, que inicie este contenedor de datos y lo comparta a su jerarquía de subcomponentes, como es el caso de ChartComponent y SurveyComponent.

const ChartComponent: ng.IComponentOptions = {
  bindings: {
    data: '=',
  },
  controller: ChartController,
  template: `
  <label>chart: {{ $ctrl.data.amount }}</label>
  <button ng-click="$ctrl.next()">Next</button>
  `,
};
const SurveyComponent: ng.IComponentOptions = {
  bindings: {
    data: '=',
  },
  template: `
  survey:
  <input
    ng-model="$ctrl.data.amount"
    value="$ctrl.data.amount"
  >
  `,
};

En el caso de SurveyComponent, el monto se actualiza desde el formulario, mientras que ChartComponent lanza un evento clic

class ChartController {
  data: EvaluationData;

  next() {
    this.data.amount++;
  }
}

El ejemplo completo puede verse aquí.

Categorías