Jak przetestować usługę AngularJS z Jasmine?

107

(Jest tu powiązane pytanie: test Jasmine nie widzi modułu AngularJS )

Chcę tylko przetestować usługę bez uruchamiania Angulara.

Spojrzałem na kilka przykładów i tutorial, ale nigdzie się nie wybieram.

Mam tylko trzy pliki:

  • myService.js: gdzie definiuję usługę AngularJS

  • test_myService.js: gdzie definiuję test Jasmine dla usługi.

  • specRunner.html: plik HTML z normalną konfiguracją jasmine i gdzie importuję poprzednie dwa inne pliki oraz Jasmine, Angularjs i angular-mocks.js.

Oto kod usługi (który działa zgodnie z oczekiwaniami, gdy nie testuję):

var myModule = angular.module('myModule', []);

myModule.factory('myService', function(){

    var serviceImplementation   = {};
    serviceImplementation.one   = 1;
    serviceImplementation.two   = 2;
    serviceImplementation.three = 3;

    return serviceImplementation

});

Ponieważ próbuję przetestować usługę w izolacji, powinienem mieć do niej dostęp i sprawdzić ich metody. Moje pytanie brzmi: jak mogę wstrzyknąć usługę w moim teście bez ładowania AngularJS?

Na przykład, jak mogę przetestować wartość zwracaną dla metody usługi z Jasmine w następujący sposób:

describe('myService test', function(){
    describe('when I call myService.one', function(){
        it('returns 1', function(){
            myModule = angular.module('myModule');
                    //something is missing here..
            expect( myService.one ).toEqual(1);
        })

    })

});
Robert
źródło

Odpowiedzi:

137

Problem polega na tym, że metoda fabryczna, która tworzy instancję usługi, nie jest wywoływana w powyższym przykładzie (samo utworzenie modułu nie powoduje utworzenia instancji usługi).

Aby usługa została zainicjowana, angular.injector musi być wywołany z modułem, w którym jest zdefiniowana nasza usługa. Następnie możemy poprosić o nowy obiekt wtryskiwacza dla usługi i dopiero wtedy, gdy usługa zostanie ostatecznie utworzona.

Coś takiego działa:

describe('myService test', function(){
    describe('when I call myService.one', function(){
        it('returns 1', function(){
            var $injector = angular.injector([ 'myModule' ]);
            var myService = $injector.get( 'myService' );
            expect( myService.one ).toEqual(1);
        })

    })

});

Innym sposobem byłoby przekazanie usługi do funkcji za pomocą „ invoke ”:

describe('myService test', function(){
    describe('when I call myService.one', function(){
        it('returns 1', function(){

            myTestFunction = function(aService){
                expect( aService.one ).toEqual(1);
            }

            //we only need the following line if the name of the 
            //parameter in myTestFunction is not 'myService' or if
            //the code is going to be minify.
            myTestFunction.$inject = [ 'myService' ];

            var myInjector = angular.injector([ 'myModule' ]);
            myInjector.invoke( myTestFunction );
        })

    })

});

I wreszcie, „właściwym” sposobem na zrobienie tego jest użycie „ inject ” i „ module ” w bloku jaśminowym „ beforeEach ”. Robiąc to, musimy zdać sobie sprawę, że funkcja 'inject' nie znajduje się w standardowym pakiecie angularjs, ale w module ngMock i że działa tylko z jaśminem.

describe('myService test', function(){
    describe('when I call myService.one', function(){
        beforeEach(module('myModule'));
        it('returns 1', inject(function(myService){ //parameter name = service name

            expect( myService.one ).toEqual(1);

        }))

    })

});
Robert
źródło
13
Chciałbym zobaczyć przykład, kiedy Twoja usługa ma własne zależności (np. $ Log)
Roy Truelove
2
Przepraszam, szukałem czegoś takiego: stackoverflow.com/q/16565531/295797
Roy Truelove
1
Czy jest dobry sposób na wprowadzenie usługi w beforeEachprzypadku wielu ... wielu ... wielu testów niezbędnych do wykonania usługi? Testowanie modelu danych (usługi) i zawiera on mnóstwo zmiennych globalnych. Dzięki, C§
CSS
2
Nie mówisz, dlaczego (3) jest „właściwą drogą”
LeeGee
2
@LeeGee Myślę, że możemy to nazwać „właściwym” sposobem, ponieważ używa modułu ngMock AngularJS, który jest tam specjalnie do celów testowych.
Robert
5

Chociaż powyższa odpowiedź prawdopodobnie działa dobrze (nie próbowałem jej :)), często mam dużo więcej testów do wykonania, więc nie wstrzykuję w nich samych. Pogrupuję przypadki it () w bloki opisujące i uruchomię wstrzyknięcie w bloku beforeEach () lub beforeAll () w każdym bloku opisywania.

Robert ma również rację, mówiąc, że musisz użyć wtryskiwacza Angular $, aby uświadomić testom serwis lub fabrykę. Angular również używa tego wtryskiwacza w twoich aplikacjach, aby poinformować aplikację, co jest dostępne. Można go jednak wywołać w więcej niż jednym miejscu, a także niejawnie zamiast jawnie. Zauważysz w moim przykładowym pliku testu specyfikacji poniżej, blok beforeEach () niejawnie wywołuje wtryskiwacz, aby udostępnić rzeczy do przypisania w testach.

Wracając do grupowania rzeczy i używania bloków przed, oto mały przykład. Tworzę usługę Cat Service i chcę ją przetestować, więc moja prosta konfiguracja do pisania i testowania usługi wyglądałaby następująco:

app.js

var catsApp = angular.module('catsApp', ['ngMockE2E']);

angular.module('catsApp.mocks', [])
.value('StaticCatsData', function() {
  return [{
    id: 1,
    title: "Commando",
    name: "Kitty MeowMeow",
    score: 123
  }, {
    id: 2,
    title: "Raw Deal",
    name: "Basketpaws",
    score: 17
  }, {
    id: 3,
    title: "Predator",
    name: "Noseboops",
    score: 184
  }];
});

catsApp.factory('LoggingService', ['$log', function($log) {

  // Private Helper: Object or String or what passed
    // for logging? Let's make it String-readable...
  function _parseStuffIntoMessage(stuff) {
    var message = "";
    if (typeof stuff !== "string") {
      message = JSON.stringify(stuff)
    } else {
      message = stuff;
    }

    return message;
  }

  /**
   * @summary
   * Write a log statement for debug or informational purposes.
   */
  var write = function(stuff) {
    var log_msg = _parseStuffIntoMessage(stuff);
    $log.log(log_msg);
  }

  /**
   * @summary
   * Write's an error out to the console.
   */
  var error = function(stuff) {
    var err_msg = _parseStuffIntoMessage(stuff);
    $log.error(err_msg);
  }

  return {
    error: error,
    write: write
  };

}])

catsApp.factory('CatsService', ['$http', 'LoggingService', function($http, Logging) {

  /*
    response:
      data, status, headers, config, statusText
  */
  var Success_Callback = function(response) {
    Logging.write("CatsService::getAllCats()::Success!");
    return {"status": status, "data": data};
  }

  var Error_Callback = function(response) {
    Logging.error("CatsService::getAllCats()::Error!");
    return {"status": status, "data": data};
  }

  var allCats = function() {
    console.log('# Cats.allCats()');
    return $http.get('/cats')
      .then(Success_Callback, Error_Callback);
  }

  return {
    getAllCats: allCats
  };

}]);

var CatsController = function(Cats, $scope) {

  var vm = this;

  vm.cats = [];

  // ========================

  /**
   * @summary
   * Initializes the controller.
   */
  vm.activate = function() {
    console.log('* CatsCtrl.activate()!');

    // Get ALL the cats!
    Cats.getAllCats().then(
      function(litter) {
        console.log('> ', litter);
        vm.cats = litter;
        console.log('>>> ', vm.cats);
      }  
    );
  }

  vm.activate();

}
CatsController.$inject = ['CatsService', '$scope'];
catsApp.controller('CatsCtrl', CatsController);

Spec: kontroler kotów

'use strict';

describe('Unit Tests: Cats Controller', function() {

    var $scope, $q, deferred, $controller, $rootScope, catsCtrl, mockCatsData, createCatsCtrl;

    beforeEach(module('catsApp'));
    beforeEach(module('catsApp.mocks'));

    var catsServiceMock;

    beforeEach(inject(function(_$q_, _$controller_, $injector, StaticCatsData) {
      $q = _$q_;
      $controller = _$controller_;

      deferred = $q.defer();

      mockCatsData = StaticCatsData();

      // ToDo:
        // Put catsServiceMock inside of module "catsApp.mocks" ?
      catsServiceMock = {
        getAllCats: function() {
          // Just give back the data we expect.
          deferred.resolve(mockCatsData);
          // Mock the Promise, too, so it can run
            // and call .then() as expected
          return deferred.promise;
        }
      };
    }));


    // Controller MOCK
    var createCatsController;
    // beforeEach(inject(function (_$rootScope_, $controller, FakeCatsService) {
    beforeEach(inject(function (_$rootScope_, $controller, CatsService) {

      $rootScope = _$rootScope_;

      $scope = $rootScope.$new();
      createCatsController = function() {
          return $controller('CatsCtrl', {
              '$scope': $scope,
              CatsService: catsServiceMock
          });    
      };
    }));

    // ==========================

    it('should have NO cats loaded at first', function() {
      catsCtrl = createCatsController();

      expect(catsCtrl.cats).toBeDefined();
      expect(catsCtrl.cats.length).toEqual(0);
    });

    it('should call "activate()" on load, but only once', function() {
      catsCtrl = createCatsController();
      spyOn(catsCtrl, 'activate').and.returnValue(mockCatsData);

      // *** For some reason, Auto-Executing init functions
      // aren't working for me in Plunkr?
      // I have to call it once manually instead of relying on
      // $scope creation to do it... Sorry, not sure why.
      catsCtrl.activate();
      $rootScope.$digest();   // ELSE ...then() does NOT resolve.

      expect(catsCtrl.activate).toBeDefined();
      expect(catsCtrl.activate).toHaveBeenCalled();
      expect(catsCtrl.activate.calls.count()).toEqual(1);

      // Test/Expect additional  conditions for 
        // "Yes, the controller was activated right!"
      // (A) - there is be cats
      expect(catsCtrl.cats.length).toBeGreaterThan(0);
    });

    // (B) - there is be cats SUCH THAT
      // can haz these properties...
    it('each cat will have a NAME, TITLE and SCORE', function() {
      catsCtrl = createCatsController();
      spyOn(catsCtrl, 'activate').and.returnValue(mockCatsData);

      // *** and again...
      catsCtrl.activate();
      $rootScope.$digest();   // ELSE ...then() does NOT resolve.

      var names = _.map(catsCtrl.cats, function(cat) { return cat.name; })
      var titles = _.map(catsCtrl.cats, function(cat) { return cat.title; })
      var scores = _.map(catsCtrl.cats, function(cat) { return cat.score; })

      expect(names.length).toEqual(3);
      expect(titles.length).toEqual(3);
      expect(scores.length).toEqual(3); 
    });

});

Spec: Cats Service

'use strict';

describe('Unit Tests: Cats Service', function() {

  var $scope, $rootScope, $log, cats, logging, $httpBackend, mockCatsData;

  beforeEach(module('catsApp'));
  beforeEach(module('catsApp.mocks'));

  describe('has a method: getAllCats() that', function() {

    beforeEach(inject(function($q, _$rootScope_, _$httpBackend_, _$log_, $injector, StaticCatsData) {
      cats = $injector.get('CatsService');
      $rootScope = _$rootScope_;
      $httpBackend = _$httpBackend_;

      // We don't want to test the resolving of *actual data*
      // in a unit test.
      // The "proper" place for that is in Integration Test, which
      // is basically a unit test that is less mocked - you test
      // the endpoints and responses and APIs instead of the
      // specific service behaviors.
      mockCatsData = StaticCatsData();

      // For handling Promises and deferrals in our Service calls...
      var deferred = $q.defer();
      deferred.resolve(mockCatsData); //  always resolved, you can do it from your spec

      // jasmine 2.0
        // Spy + Promise Mocking
        // spyOn(obj, 'method'), (assumes obj.method is a function)
      spyOn(cats, 'getAllCats').and.returnValue(deferred.promise);

      /*
        To mock $http as a dependency, use $httpBackend to
        setup HTTP calls and expectations.
      */
      $httpBackend.whenGET('/cats').respond(200, mockCatsData);
    }));

    afterEach(function() {
      $httpBackend.verifyNoOutstandingExpectation();
      $httpBackend.verifyNoOutstandingRequest();
    })

    it(' exists/is defined', function() {
      expect( cats.getAllCats ).toBeDefined();
      expect( typeof cats.getAllCats ).toEqual("function");
    });

    it(' returns an array of Cats, where each cat has a NAME, TITLE and SCORE', function() {
      cats.getAllCats().then(function(data) {
        var names = _.map(data, function(cat) { return cat.name; })
        var titles = _.map(data, function(cat) { return cat.title; })
        var scores = _.map(data, function(cat) { return cat.score; })

        expect(names.length).toEqual(3);
        expect(titles.length).toEqual(3);
        expect(scores.length).toEqual(3);
      })
    });

  })

  describe('has a method: getAllCats() that also logs', function() {

      var cats, $log, logging;

      beforeEach(inject(
        function(_$log_, $injector) {
          cats = $injector.get('CatsService');
          $log = _$log_;
          logging = $injector.get('LoggingService');

          spyOn(cats, 'getAllCats').and.callThrough();
        }
      ))

      it('that on SUCCESS, $logs to the console a success message', function() {
        cats.getAllCats().then(function(data) {
          expect(logging.write).toHaveBeenCalled();
          expect( $log.log.logs ).toContain(["CatsService::getAllCats()::Success!"]);
        })
      });

    })

});

EDYCJA Na podstawie niektórych komentarzy zaktualizowałem moją odpowiedź, aby była nieco bardziej złożona, a także stworzyłem Plunkr demonstrujący testy jednostkowe. W szczególności jeden z komentarzy wspomniał „A co, jeśli usługa kontrolera sama ma prostą zależność, taką jak $ log?” - co jest zawarte w przykładzie z przypadkami testowymi. Mam nadzieję, że to pomoże! Przetestuj lub zhakuj planetę !!!

https://embed.plnkr.co/aSPHnr/

RoboBear
źródło
0

Musiałem przetestować dyrektywę, która wymagałaby innej dyrektywy, Google Places Autocomplete , debatowałem nad tym, czy powinienem z niej po prostu kpić ... i tak to zadziałało bez zgłaszania błędów dla dyrektywy, która wymagała gPlacesAutocomplete.

describe('Test directives:', function() {
    beforeEach(module(...));
    beforeEach(module(...));
    beforeEach(function() {
        angular.module('google.places', [])
        .directive('gPlacesAutocomplete',function() {
            return {
                require: ['ngModel'],
                restrict: 'A',
                scope:{},
                controller: function() { return {}; }
             };
        });
     });
     beforeEach(module('google.places'));
});
Jerinaw
źródło
-5

Jeśli chcesz przetestować kontroler, możesz wstrzyknąć i przetestować go jak poniżej.

describe('When access Controller', function () {
    beforeEach(module('app'));

    var $controller;

    beforeEach(inject(function (_$controller_) {
        // The injector unwraps the underscores (_) from around the parameter names when matching
        $controller = _$controller_;
    }));

    describe('$scope.objectState', function () {
        it('is saying hello', function () {
            var $scope = {};
            var controller = $controller('yourController', { $scope: $scope });
            expect($scope.objectState).toEqual('hello');
        });
    });
});
Lazaro Fernandes Lima Suleiman
źródło
2
Pytanie dotyczy usługi testowania, a nie kontrolera.
Bartek S