You are currently browsing the monthly archive for octubre 2017.

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
1.   Axioma de Unión

Es natural pensar que, dado un conjunto de conjuntos {\mathcal C}, haya un conjunto mayor para el cual todo conjunto de {\mathcal C} es un subconjunto.

Axioma 1 (Axioma de Unión). Sea {\mathcal C} un conjunto de conjuntos. Entonces hay un conjunto {C} tal que para cualquier conjunto {X} se cumple {X \in \mathcal C \iff X \subseteq C}.

Alternativamente, podríamos relajar la condición de equivalencia y usar la Especificación para crear la misma unión.

Ahora veamos algo de notación.

Definición 2 (Unión). Sea {\mathcal C} un conjunto de conjuntos. Sea {C} el conjunto garantizado por el Axioma de Unión. Entonces diremos que {C} es la unión de los conjuntos de {\mathcal C} y escribimos

\displaystyle  C = \bigcup\mathcal C = \bigcup_{X\in C} X.

Establecemos dos hechos triviales sobre las uniones.

Proposición 3.
1.

\displaystyle  \bigcup\emptyset = \bigcup_{X\in\emptyset}X = \emptyset.

2.

\displaystyle  \bigcup\{Y\} = \bigcup_{X\in\{Y\}}X = Y.

Demostración. La primera es un argumento trivial y la segunda es sólo la aplicación del axioma de extensión.\Box

Supongamos que tenemos un par de conjuntos. La unión de estos puede escribirse de una manera particular. Notemos que esta definición no es un excepción del axioma del par, sino, uno caso especial.

Definición 4 (Unión de un par). Sea {\mathcal C = \{X, Y\}}. Escribiremos

\displaystyle  \bigcup\mathcal C = X\cup Y = \{x : x\in X \lor x\in B\}.

Ahora veamos unos hechos elementales de las uniones de pares. Dejaré las pruebas para el lector (son la aplicación de las definiciones).

Proposición 5 (Propiedades de la unión de un par). Sean {X, Y, Z} conjuntos. Entonces
1.

\displaystyle  X\cup\emptyset = X.

2.

\displaystyle  X\cup Y = Y\cup A.

3.

\displaystyle  X\cup(Y\cup Z) = (X\cup Y)\cup Z.

4.

\displaystyle  X\cup X = X.

5.

\displaystyle  X \subseteq Y \iff X\cup Y = Y.

Volvemos con la serie sobre teoría de conjuntos. 🙂 Disculpad la demora.

1.   Axioma del Par

Supongamos que tenemos dos conjuntos {X} e {Y}. ¿Son elemeneots de algún conjunto? La teoría que tenemos hasta el momento no permite resolver esta cuestión. Lo que motiva el siguiente axioma:

Axioma 1 (Axioma del Par). Para cualquier par de conjuntos {X} e {Y}, hay un conjunto {A} que contiene a {X} e {Y} como elementos.

Mediante el uso de la Especificación, podemos hallar un conjunto {B \subseteq A} tal que {B = \{X,Y\}}. Consideremos {S(x) \equiv x = X \lor x = Y}.

Nombraremos dos tipos especiales de conjuntos:

Definición 2 (Par no ordenado). Con {X = \{a, b\}}, diremos que {X} es un par no ordenado.

Definición 3 (Conjunto unitario). Llamaremos al conjunto {X = \{x\}} conjunto unitario.

 

El equipo acaba la primera parte de sprint planning desgranando os PBIs en tareas, estimándolas y cada miembro del equipo empieza a trabajar en un ítem distinto. Esto lleva a problemas de integración y silos de implementaciones en los cuales no tenemos ni de lo que está sucediendo. Las tareas quedan a mitad de desarrollo al final del sprint y no da tiempo a integrar (ofreciendo algo de calidad). Sin embargo, el product owner aprieta los tiempos y el esfuerzo estimado para el sprint review. “Cuanto más, mejor”. Los desarrolladores (si se lo permiten) añaden la “deuda técnica” al backlog para seguramente no volver a verla.

Ward Cunningham presentó el concepto de “Technical Debt” en 1992. Es una metáfora para explicar cómo la ausencia de calidad en nuestro código terminará por generar sobrecostos en el matenimiento de la aplicación en dinero como esfuerzo del equipo (usualmente este último, lo que termina causando más deuda).

En mi opinión, el costo que nos genera la deuda técnica aumenta de manera geométrica respecto al tiempo. Así como no tenemos una manera de calcular la calidad del código, tampoco tenemos una para averiguar las consecuencias de la mala calidad. El problema radica en la definición de calidad. La ignorancia respecto a la necesidad de negocio que tratamos cubrir nos lleva a adquirir la deuda. Una manera de tener una idea acerca de la deuda técnica es clasificarla en dos factores, la prudencia y la conciencia de las decisiones de diseño que tomamos.

cuadrantes

La deuda prudente y deliberada es a la que nos vemos obligados a incurrir por factores externos siendo conscientes de ello. La prudente e inadvertida es la que tenemos que explicar a los stakeholders porque aparece en todo proyecto mientras vamos conociendo más el problema que tratamos de resolver e incluso analizamos si vale la pena pagar este tipo de deuda. La imprudente y deliberada es la peor de todas pues damos por sentado que estamos desarrollando algo que acabará con mala calidad y puede ser producida por una mala gestión, despropósitos técnicos y falta de compromiso. La imprudente e inadvertida se debe a una mala formación profesional que nos hace tomar una serie de decisiones equivocadas.

Es importante que los stakeholdders comprendan que siempre habrá deuda técnica en un proyecto. Por otro lado, los desarrolladores cuentan con principios básicos de programación como SOLID, YAGNI, KISS y DRY.

tiempo

También, tenemos algunos indicadores que debemos procurar detectar pronto:

  • Cuando es complejo adaptar el código es porque este es rígido resultando difícil de mantener y extender.

  • El código empieza a fallar en lugares donde no hemos tocado nada al cambiar un pequeño detalle del mantenimiento en el que estemos trabajando. Luego, solemos tratar con miedo el código, procuramos modificarlo lo menos posible generando más código repetitivo y hard-codeando haciéndolo incluso más frágil.

  • Aunque la aplicación tiene componentes útiles en otras, hay un gran riesgo de desacoplarlas del resto del código y el esfuerzo es tanto que preferimos estas soluciones inamovibles volviendo a escribir las implementaciones.

  • El proceso de desarrollo se vuelve lento e ineficiente, el código es difícil de utilizar y hay una ausencia de diseño. Ambos son viscosos porque tenemos que recurrir a trucos, genialidades, chiches para programar como el “diseño” fue pensando.

  • Los componentes son innecesariamente complejos con centenares de líneas de código, difíciles de identificar y entender su utilidad o manera de usar, con funciones y clases no usadas, y, en absoluto, código inútil.

  • Recurrimos al truco más recurrido: copiar y pegar. Las repeticiones de código nos llevan a un diseño pobre donde no hemos podido identificar los contextos comunes.

  • El código se vuelve opaco, complicado de leer, haciendo que queramos leerlos menos inclusive.

Un equipo maduro no empieza algo nuevo hasta no haber acabado el actual —manteniendo una o dos tareas simultáneamente. Mantener un ritmo de desarrollo ayuda a tratar la deuda técnica. También, podemos recurrir a algunas prácticas de XP como son TDD, y pair programming. Reescribir parte de la aplicación, o peor, toda la aplicación, no es una solución y es poco profesional así como permitir que la deuda técnica se acumule. Desde el punto de vista del desarrollador, estimar considerando el impacto, componentes invlucrados, refactoring, unit tests, entre otros, es lo deseable; no se necesita consultarlo con nadie de la misma manera que un médico no consulta con nosotros si debe o prescribir un medicamento. Simplemente lo hace y queda a responsabilidad del paciente tomarlo. Por otro lado, están los gestores que “tienen” que entregar más. Pero esto se maneja más con habilidades comunicativas y cuya responsabilidad escapa del equipo como un todo.

Validar

Implementar una función valid para que lance un error si se llama sin argumentos o un argumento no está definido. De lo contrario debe devolver el valor dado.

Remover una propiedad

Escribir una función removeProperty que recibe un objeto y el nombre de una propiedad realizando lo siguiente: si el objeto obj tiene una propiedad prop, la función elimina la propiedad del objeto y devuelve true; en los demás casos, devuelve false.

function removeProperty(obj, prop) {
  return null;
}

Fecha

Codear una función que convierta la fecha formateada como “M/D/AAAA” en un formato requerido “AAAAMMDD”. El parámetro “date” y el valor de retorno son string’s.

Por ejemplo, “31/12/2014” a “20141231”.

function format(date) {
  // M/D/YYYY => YYYYMMDD
}

console.log(format('12/31/2014'));

Galería de imágenes

El siguiente ejemplo es una galería de dos imágenes con botones de eliminación correspondientes:

class="image"> src="https://goo.gl/2oZU2S" alt="First"> class="remove">X
class="image"> src="https://goo.gl/tniGAc" alt="Second"> class="remove">X

Implementar una función registerClickHandler: cuando se hace clic en el botón de la clase remove, su elemento *

  • principal debe ser eliminado de la galería.

Por ejemplo, después de que la primera imagen haya sido eliminada de la galería anterior, su código HTML debería verse así:

class="image"> src="https://goo.gl/tniGAc" alt="Second"> class="remove">X
function registerClickHandler () {
  // implementar el clic para el botón 'remove'
}

Cerraduras

Corregir los errores en la función registerHandlers. Un alert debe mostrar el índice del en lugar de seguir el enlace.

Por ejemplo, en el documento de abajo, la alerta debe mostrar “2” cuando se hace clic en Google.


  My web search engines:
<a href="//www.yahoo.com">Yahoo!
<a href="//www.altavista.com">AltaVista
<a href="//www.google.com">Google
function registerHandlers() {
  var as = document.getElementsByTagName('a');
  for (var i = 0; i < as.length; i++) {
    as[i].onclick = function() {
      alert(i);
      return false;
    }
  }
}

Bucle

La función appendChildren debería agregar un nuevo div a cada div existente.

Por ejemplo, después de ejecutar appendChildren en

id="a">
id="b">

debería tomar la siguiente forma:

id="a">
id="b">

Por alguna razón el siguiente código tiene un bucle infinito:

function appendChildren() {
  var allDivs = document.getElementsByTagName('div');
  for (var i = 0; i < allDivs.length; i++) {
    var newDiv = document.createElement('div');
    allDivs[i].appendChild(newDiv);
  }
}

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.

Leyendo un rato la lista de cambios de Angular me entero que hay un cambio en los proveedores de la plataforma y el compilador y que se ha reemplazado el inyector reflexivo por uno estático. No todos usamos el ReflectiveInjector directamente en nuestro código así que no parece claro en qué nos afectaría.

Las preguntas, después del salto desde AngularJS y Angular 2, son: ¿por qué es mejor? ¿Cómo nos afecta? ¿Necesitaremos migrar?

¿Por qué reflexivo?

Veamos el siguiente ejemplo

class Resource { }

class Reader {
  constructor(@Inject(Resource) resource) { }
}

const injector = ReflectiveInjector.resolveAndCreate([Reader, Reource]);
const reader = injector.get(Reader);

Tenemos dos servicios y el servicio Reader depende del servicio Resource. Cuando los proveedores van hacia resolveAndCreate no especificamos qué depende de qué. El decorador Inject usa la biblioteca Reflect para asociar metadata a la Reader. (Me gustaría que veamos reflexión y metaprogramación en JS.) 😉

Esencialmente, el decorador Inject hace lo siguiente

function Inject(cls: any, unusedKey: any, index: number) {
  ...  // `parameters` contiene a `{token: Resource}`
  Reflect.defineMetadata('parameters', parameters, cls);
  return cls;
}

Con esto mantenemos la información de las dependencias asociadas a una clase.

Cuando pasamos los proveedores a resolveAndCreate, este recorre cada uno de ellos y recolecta todas sus dependencias usando el mismo objeto Reflect.

function resolveAndCreate(providers) {
  ...
  providers.forEach(provider => resolverReflectiveFactory(provider));
  ...
}

function resolverReflectiveFactory(provider) {
  ...
  if (provider.useClass) {
    const cls = resolve(provider.useClass);
    ...
    resolveDepdenencies = dependenciesFor(cls);
  }
}

Con esto vemos que el inyector se basa en la capacidad de reflexión provista por Reflect (y el lenguaje) para extraer las dependencias y hacernos la programación de ello implícita.

¿Cómo difiere del inyector estático?

Este nuevo inyector es más rápido ya que de momento los navegadores y javascript no soporta reflexión de manera “nativa”. Por ejemplo, este almacena en un mapa todas nuestras clases.

const getOrCreateMetadataMap = (target, targetKey, create) {
  const targetMetadata = store.get(target);
  if (!targetMetadata) {
    if (!create) return;
    store.set(target, targetMetadata = new Map);
  }
}

Personalmente, supongo que con la llegada de los decoradores en ES7, Reflect ya no sería necesario, por lo tanto, sería removido en el futuro.

¿Cómo nos afecta?

El inyector reflexivo no se hace explícito cuando creamos módulos. No obstante, Angular crea otros tres inyectores para Platform, Compiler y NgZone, opr lo que el uso ReflectiveInjector los afectará.

Notemos que nosotros usamos una línea como la siguiente:

platformBrowserDynamic().bootstrapModule(AppModule);

La primer llamada toma los proveedores de la plataforma. La segunda inicia el compilador JIT y toma sus proveedores. Con esto quiero decir que podríamos pasar los proveedores al inyector de la plataforma mediante

class B { }
class A { constructor(@Inject(B) b) { } }

platformBrowserDynamic([A, B])

y, al compilador,

class D { }
class C { constructor(@Inject(D) d) { } }

bootstrapModule(AppModule, {providers: [C, D]});

Ya que la plataforma migrará al inyector estático, no podremos resolver de manera implícita las dependencias mediante la metadata. De manera que tendremos que adaptar nuestro código.

class B { }
class A { constructor(@Inject(B) b) { } }

platformBrowserDynamic([{provide: A, useClass: A, deps: [B]}, B]);

class D { }
class C { constructor(@Inject(D) d) { } }

bootstrapModule(AppModule, {
  providers: [
    { provide: A, useClass: A, deps: [B] },
    B
  ]
});

Para quienes se hayan enfrentado al problema de inyectar en inyectables, esto no resultará extraño. Pero no nos preocupes. Como dije, esto sólo afecta a inyector de la plataforma y del compilador. Como el inyector reflexivo está marcado como “deprecated”, es buena idea que vayamos migrando hacia el nuevo inyector estático, en tanto lo hayamos usado en nuestro código.

Categorías

Anuncios