Archives par mot-clé : angularjs

AngularJs : Quelques astuces pour les tests unitaires

Une des grandes forces d’Angular est qu’il a été développé pour être facilement testable. Voici quelques astuces pour mieux tester vos applications angular.

Nommage

Dans un fichier de test, nous allons avoir besoin d’utiliser plusieurs fois des objets (services, controllers, …) dans plusieurs tests. Une bonne pratique pour avoir moins de code est d’injecter les différents objets avant chaque test dans le beforeEach global de notre fichier. Comme angular va se charger d’injecter nos objets via leur nom, il n’est pas possible de nommer ses variables du nom de l’objet. Il existe une astuce qui consiste à entourer le nom du service par des underscore (par exemple _user_)

// Defined out reference variable outside
var myService;

// Wrap the parameter in underscores
beforeEach( inject( function(_myService_){
  myService = _myService_;
}));

// Use myService in a series of tests.
it('makes use of myService', function() {
  myService.doStuff();
});

Le lien vers la documentation d’Angular concernant ce point

Organisation de vos tests

Un fichier de tests avec Jasmine est organisé en blocs (describe) qui contiennent des sous blocs et des tests (it). Un bloc describe peut également contenir une fonction beforeEach qui permet d’initialiser des objets avant un test. N’hésitez pas à faire plusieurs niveaux de describe ayant chacun un beforeEach afin de simplifier votre fichier de tests

describe('Mon fichier à tester', function() {
  // Chargement du module à tester
  beforeEach(module('myWebApp'));

  var monCtrl,
      scope,
      myService;

  // Init global ...
  // Initialize the controller and a mock scope
  beforeEach(inject(function ($controller, $rootScope, _myService_) {
    scope = $rootScope.$new();
    myService = _myService_;

    monCtrl = $controller('MonCtrl', {
      $scope: scope
    });
  });

  describe('Mon fonction à tester', function() {
    beforeEach(function() {
      //init lié à ma fonction (création var, spy, ...)
    });
    
    it('test 1', function () {
        ...
    });

    it('test 2', function () {
        ...
    });

  });

  describe('Mon 2eme fonction à tester', function() {
    beforeEach(function() {
      //init lié à ma fonction (création var, spy, ...)
    });

    it('test 3', function () {
        ...
    });

  });

});

Simuler un serveur web

Pour tester vos fonctions qui ont besoins de retour du serveur, angular founit l’objet $httpBackend qui permet de mocker des réponses à des requêtes http.

Voici comment par exemple simuler le retour d’un appel serveur qui renvoie un user

$httpBackend.when('GET', '/user/1').respond({userId: 1, firstname : 'Julien', lastname : 'Roy'});

Le lien vers la documentation de $httpBackend.

Tester des promises

Angular inclut $q, un service de promise, qui permet de facilement gérer enchaînement de méthodes asynchrones.

Voyons comment tester une méthode appelant une méthode retournant une promise.

var deferredSuccess = q.defer();

spyOn(projectFactory, 'getPotentialOwnersForProject')
   .and.returnValue(deferredSuccess.promise);

deferredSuccess.resolve(usersMock);
//Il faut appeler digest pour que le resolve soit pris en compte.
scope.$digest(); //ou scope.$apply();

Filtrer les tests à exécuter

Lors de l’écrire de vos tests, il se peut que vous n’ayez pas envie de jouer tous les tests de votre application pour corriger un test ou une série de tests (bloc describe contenant 1 ou plusieurs test it). Il est possible avec Jasmine de filtrer et d’exclure des tests :

  • Ne jouer qu’un seul test : changer it en iit
  • Ne pas jouer un test : changer it en xit
  • Jouer un bloc describe : changer describe en ddescribe
  • Ne pas jouer un bloc describe :changer describe en xdescribe

Edit 14/06/2015 : à partir la version 2.1 de Jasmine, il faut utiliser respectivement fit et fdescribe au lieu de iit et ddescribe (http://jasmine.github.io/2.1/focused_specs.html).

Ecrire dans la console des tests

Si vous souhaitez écrire dans la console des tests (à des fins de debug par exemple), il faut utiliser la méthode dump(var) au lieu de console.log(var) comme on pourrait le penser.

Directive et isolate scope

Dans le cas de directive avec un isolate scope, le moyen d’accéder au scope de la directive se fait via :

element.isolateScope()

Liens

AngularJS : Migration de ngRoute vers AngularUI Router

Je viens d’effectuer la migration, de ngRoute (le gestionnaire de route par défaut d’angular) vers UI Router, le router fournit par le projet Angular UI (je vous conseille de regarder les différents modules qui peuvent être très pratique).

Le router fournit de base par Angular a quelques limitations et peut être pénalisant pour des applications complexes (Il a d’ailleurs été retiré d’Angular pour en faire un module à part depuis la version 1.2. La version 2.0 d’Angular devrait améliorer ce dernier et combler ses lacunes).

UI Router apporte notamment :

  • la gestion des vues imbriqués
  • Vues Multiples
  • resolve imbriqués
  • des directives
    • ui-sref pour la génération des liens
    • ui-sref-active pour ajouter une classe si un état est actif
  • des callbacks onEnter et onExit

Voici un petit tutoriel/retour d’expérience pour effectuer la migration vers UI Router. Dans mon cas, cela s’est très bien passé 🙂 ).

Migration

Installation

Le plus simple est d’installer angular-ui-router via bower avec la commande suivante :

bower install angular-ui-router --save

Il faut ensuite inclure le script dans votre page (pensez à supprimer l’inclusion du script de angular-route et à le supprimer de bower)

<script src="libs/angular-ui-router/release/angular-ui-router.js"></script>

Il faut également injecter la dépendance ui-router dans votre application (et supprimer celle de ngRoute)

angular.module('volleyApp',['ngRoute','angularCharts','ui.bootstrap'])

devient donc

angular.module('volleyApp',['ui.router','angularCharts','ui.bootstrap'])

ng-view est également à remplacer par ui-view.

<div ng-view></div>

Devient

<div ui-view></div>

Gestion des routes

Dans votre fichier de configuration des routes :

app.config(function ($routeProvider) {
  $routeProvider
    .when('/', {
      templateUrl: 'views/home.html',
      controller: 'HomeCtrl'
    })
    .when('/todo', {
      templateUrl: 'views/todo.html',
      controller: 'TodoCtrl'
    })
    //vos autres routes ...
    .when('/histo/stat/:matchId', {
      templateUrl: 'views/stat.html',
      controller: 'StatCtrl'
    })
    .otherwise({
      redirectTo: '/'
    });
});

devient

app.config(function ($stateProvider, $urlRouterProvider) {
  //Set default route
  $urlRouterProvider.otherwise('/');

  //Declare states
  $stateProvider
    .state('home', {
      url : '/',
      templateUrl: 'views/home.html',
      controller: 'HomeCtrl'
    })
    .state('todo', {
      url : '/todo',
      templateUrl: 'views/todo.html',
      controller: 'TodoCtrl'
    })
    //autres routes ...
    .state('stat', {
      url : '/histo/stat/:matchId',
      templateUrl: 'views/stat.html',
      controller: 'StatCtrl'
    });
});

Comme vous pouvez le voir, il n’y a pas grand à faire ici :

  • injecter les providers $stateProvider et $urlRouterProvider à la place de $routeProvider
  • Définition de la route par défaut via $urlRouterProvider.otherwise
  • remplacer when par state et donner un nom de vue (qui sera utiliser plus tard lors de l’utilisation de ui-sref)
  • rajouter un paramètre url pour chaque state.

Récupération des paramètres des routes

Dans ma vue de consultation des statistiques d’un match, j’utilise un paramètre dans l’url pour récuperer le match à consulter.

angular.module('volleyApp')
   .controller('StatCtrl', ['$scope', '$routeParams']
     function ($scope, $routeParams) {
       $scope.matchId = $routeParams.matchId;

Devient

angular.module('volleyApp')
   .controller('StatCtrl', ['$scope', '$stateParams']
     function ($scope, $stateParams) {
       $scope.matchId = $stateParams.matchId;

Ici non plus rien de très complexe. On injecte $stateParams à la place de $routeParams et on l’utilise.

Utilisation de ui-sref et ui-sref-active

UI Router fournit la directive ui-sref permettant la gestion des url.

<a class="btn btn-primary" href="#/histo/stat/{{$index}}>Stats</a>

Devient

<a class="btn btn-primary" ui-sref="stat({matchId: $index})>Stats</a>

Vous remarquerez que l’on utilise le nom du state vers lequel on souhaite être redirigé et que l’on passe les paramètres de l’URL via un objet.

ui-sref-active permet de d’ajouter des classes si l’état est sélectionné. Mon menu de navigation devient donc :

<nav>
  <ul class="nav nav-pills black">
    <li ui-sref-active="active"><a id="homeMenu" ui-sref="home">Home</a></li>
    <li ui-sref-active="active"><a id="matchMenu" ui-sref="match">Match</a></li>
    <li ui-sref-active="active"><a id="matchMenu" ui-sref="histo">Historique</a></li>
    <li ui-sref-active="active"><a id="todoMenu" ui-sref="todo">Todo</a></li>
  </ul>
</nav>

Karma

Si vous avez généré votre projet avec yeoman et que vous utilisez les tests unitaires avec karma, il faut également effectuer quelques changements :

  • Remplacer l’inclusion du angular-route.js par angular-ui-router.min.js dans la partie files du fichier karma.conf
  • Remplacer dans vos fichiers de tests l’utilisation de $routeParams par $stateParams.

Liens

Angular : Retour d’expérience

Comme je l’ai mentionné dans un article précédent, je m’intéresse de près à Angular JS.

J’ai ainsi réécrit mon application de gestion de score de Volley avec ce framework. Le code est disponible sur github et l’application est disponible à cette adresse.

Voici quelques astuces/retours sur des problèmes que j’ai pu rencontrer.

Retour sur l’utilisation de Angular JS

Angular est un framework MVW (Model View Whatever comme aime le décrire Google). Je suis maintenant fan de ce framework. En voici quelques raisons :

  • Projet architecturé : angular définit un certains nombre de concept/objects (modules, controllers, services, directives, …) qui permettent de très bien structurer son code et de le rendre modulaire
  • Binding bi-directionnel : Un des plus de Angular est la gestion du binding bi-directionnel (la vue se met à jour automatiquement suite à une modification de la donnée sur laquelle est est bindée et inversement). Ce mécanisme permet de développer de manière très rapide.
  • POJO : On utilise des objets JavaScript standards et on n’hérite pas d’objets liés à un framework comme ça peut être le cas avec d’autres comme Backbone, Ember, knockout, …)
  • Injection de dépendances : Angular met en place de l’injection de dépendance ce qui va facilité le découplage de vos composants et les tests
  • Directives : Une des forces de Angular est l’utilisation de directives. Elles permettent de créer de nouveaux élément/attribut HTML que vous allez pouvoir utiliser directement dans votre vue. Cela facilite la réutilisation des composants et permet d’avoir une vue en full html. Cela va dans le sens de l’évolution du HTML avec les web components
  • Testabilité : Angular a été développé pour être facilement testable … et il l’est.

Angular est vraiment un super framework qui permet de développer rapidement et très bien pensé. N’hésitez pas, testez le !!! Vous allez rapidement l’adopter. Il y a un fort engouement autour du projet avec une grosse communauté, un écosystème de module et des outils adaptés.

Utilisation du générateur yeoman

J’ai parlé dans un article précédent de yeoman, un outil qui permet d’améliorer le worklow front end. J’avais déjà commencé à travailler sur mon application avec angular avant de décider d’utiliser yeoman. Pour cela, j’ai créé un nouveau projet avec le générateur angular et je l’ai intégré dans mon projet existant. Avec le recul, j’aurai du faire l’inverse 🙂 .

Les commentaires dans le fichier index.html sont très important, ils permettent de gérer l’inclusion aux bons endroits des fichiers js, la concaténation lors du build, …

Si, comme moi, vous changez le dossier par défaut de le bower_components, il ne faut pas le modifier seulement le fichier .bowerrc mais dans tout le projet (.gitignore, Gruntfile.js, …).

L’utilisation de yeoman s’est révélée très  pratique. A la création d’un fichier (controller, directives, services, ….), un fichier de test est automatiquement généré. Grunt et Karma sont déjà configurés afin de vous facilité la vie (live relead, tests, ….).

Publication

Le générateur inclus un tache de build qui va optimiser votre application (concaténation, minification, …) pour le déploiement.

grunt build

Si vous voulez tester votre site optimisé il faut utiliser la commande

grunt serve:dist

Dans le processus d’optimisation, il y a une tache concernant les images qui sont renommés afin d’éviter d’utiliser une ancienne image du cache du navigateur (ex : volley.svg en 56103f21.volley.svg). La tache va ainsi renommer vos fichiers images et les liens vers celles ci dans vos fichiers HTML et CSS. J’ai rencontré un problème avec une image au format SVG. Il est possible d’inclure une image au format SVG de plusieurs manière dans votre code HTML : embed, object, img ou svg (article sur alsacreations). J’utilisais la balise object et le lien vers l’image n’était pas mis à jour dans le code HTML. L’utilisation d’une balise img a résolu le problème.

Controller et ngRoute

Dans mon application, j’utilise le module ngRoute fourni de base par Angular. J’ai une container ngView qui affiche la vue en fonction de la route courante.

Ce qu’il faut savoir, c’est que à chaque changement de vue, un nouveau controller est instancié. Ainsi si on revient sur une page, ce n’est pas le précédent controller qui nous est injecté mais un nouveay. Les données du scope du controller sont donc perdues. Dans mon cas, si on changait de page en cours d’un match, les données du match en cours étaient perdues et il fallait recommencer de zéro.

La solution à ce problème consiste à utiliser un service car celui ci est un singleton. C’est lui qui va garder l’état de vos données. L’utilisation des services est une des bonnes pratiques d’angular. Le controller doit permettre le lien entre vos données et la vue. Ne mettez pas de code métier dans votre controller. Utiliser des services !!

Voici un exemple de code d’un service (sous la forme d’une factory) qui stocke les données

angular.
module('myApp', []).
factory('myData', function() {    
  return {
    shareData : {
      foo : 'foo',
      bar : 'bar'
    }
  }
});

Le code du controller qui expose les données à la vue

angular.
module('myApp', []).
controller('dataCtrl', ['$scope', 'myData', function($scope, myData) {    
   $scope.data = myData.shareData;
  }
]);

Un exemple complet et fonctionnel sur JsFiddle.

Utilisation de module externes

J’ai utilisé des modules externes (angular-charts et angular-bootstrap) dans mon application. Le plus simple est de les ajouter via bower

bower install angular-bootstrap --save

Il faut ensuite ajouter les liens vers les fichiers des modules dans :

  • index.html

    • JavaScript dans la partie <!– build:js scripts/vendor.js –>
    • CSS dans la partie <!– build:css styles/vendor.css –>

  • karma.conf
    • JavaScript dans le tableau files

Edit du 02/06/2014 :
Les scripts sont intégrés automatiquement par grunt dans le fichier index.html via la tache bower-intall configurée par le générateur yeoman (merci Gilles 🙂 )

Si vous n’incluez pas les fichiers dans le karma.conf, vous aurez des erreurs de ce type lors de vos tests :

Error: [$injector:modulerr] Failed to instantiate module volleyApp due to:
Error: [$injector:modulerr] Failed to instantiate module ui.bootstrap due to:
Error: [$injector:nomod] Module 'ui.bootstrap' is not available! You either misspelled the module name or forgot to load it. If registering a module ensure that you specify the dependencies as the second argument.

Directives

Les directives sont vraiment très puissante. J’ai eu, dans le cadre de mon application, à créer mes propres directives. Je me suis heurté à un problème de rafraîchissement de ma vue dans une de mes directives. Cette directive permet de créer un input select avec des options numérique. La directive prend en paramètres la valeur max des options à créer. Il est possible d’associer une fonction à appeler au changement de valeur. La solution de mon problème est l’utilisation de scope.$apply qui permet de forcer un refresh.

Voici le code de la partie liée à l’appel de fonction au changement de valeur :

element.bind('change', function() {
  scope.$apply(function() {
    scope.onChange();
  });
});

Le code de ma directive sous github

Jasmine Matcher

Comme préciser plus haut, j’utilise le générateur yeoman pour angular et celui-ci utilise Jasmine comme framework de test. Jasmine inclut un petit nombre de matcher par défaut. Jasmine matcher permet d’en rajouter pour faciliter l’écriture de vos tests.

L’installation se fait via la commande suivante :

npm install jasmine-expect --save-dev

Il n’existe pas encore de plugins karma pour l’intégrer. Il faut rajouter l’inclusion du fichier js dans le fichier de configuration de karma (karma.conf.js)

files: [
            'node_modules/jasmine-expect/dist/jasmine-matchers.js',
            'src/main/webapp/js/angular/angular.js',
            'src/main/webapp/js/angular/angular-*.js',
            ... etc ...

Batarang

Batarang est une extension Chrome spécifique à Angular. Cela permet de rajouter un onglet dans la  barre d’outils développeur.  Cela permet de voir le scope, l’héritage de scope, consulter les méthodes les plus coûteuses en temps…

Liens

Ajouter la couverture de code dans un projet Angular avec Karma

Certains d’entre vous le savent peut être si vous me suivez sur Twitter, je suis en train de porter mon application de gestion de score de volley (qui utilise knockout JS) sous Angular JS (avec en prime de nouvelles fonctionnalités 🙂 .

J’utilise yeoman pour la gestion de mon application via le générateur pour angular.

Par défaut, le générateur utilise Karma pour la gestion des tests unitaires. Karma permet de tester votre code dans différents navigateurs.

Par défaut, vous n’avez pas d’information concernant la couverture de code des tests, métrique très importante afin de savoir quelle partie de votre code est couvert par les tests ou celle qui ne l’est pas. Voyons comment l’ajouter.

Mise en place de la couverture de code

La gestion de la couverture de code utilise le module karma-coverage (qui utilise le module istanbul) à installer via la commande (l’option –save-dev permet de rajouter le module en tant que dépendance de développement (devDependencies) dans le fichier package.json de votre application) :

npm install karma-coverage --save-dev

Il faut ensuite ajouter les lignes suivantes dans le fichier karma.conf.js :

//Code Coverage
reporters: ['progress', 'coverage'],
preprocessors: { 'app/scripts/**/*.js': ['coverage'] }

C’est tout !!

Utilisation

Le lancement de vos tests unitaires se fait toujours via la commande :

grunt test

Un dossier coverage est créé dans votre arborescence et contient un dossier par navigateur dans lequel vous avez testé votre application.
Ajout du dossier coverage
Dans ces dossier vous avez un fichier index.html. Lancez ce fichier dans votre navigateur et vous avez maintenant accès à la couverture de code de votre application. Vous naviguer dans l’arborescence de votre projet et consulter fichier par fichier la couverture de code.

Couverture de code de votre application

Couverture de code d'un fichier

Comme vous pouvez le voir, la couverture n’est pas complète mais j’y travaille 😉 .

Bonus : Pensez à rajouter le dossier coverage dans le fichier .gitignore.