openproject/frontend/app/components/query/query-service.service.test.js

// -- copyright
// OpenProject is a project management system.
// Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License version 3.
//
// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
// Copyright (C) 2006-2013 Jean-Philippe Lang
// Copyright (C) 2010-2013 the ChiliProject Team
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// See doc/COPYRIGHT.rdoc for more details.
// ++

describe('QueryService', function() {


  var QueryService, PathHelper, query, queryData, stateParams = {}, $rootScope,
    $httpBackend;

  beforeEach(angular.mock.module('openproject.layout',
                    'openproject.models',
                    'openproject.api',
                    'openproject.services'));

  beforeEach(angular.mock.module('openproject.templates', function($provide) {
    var configurationService = {};

    configurationService.isTimezoneSet = sinon.stub().returns(false);

    $provide.constant('$stateParams', stateParams);
    $provide.constant('ConfigurationService', configurationService);
  }));

  beforeEach(angular.mock.inject(function(_QueryService_, _$rootScope_, _$httpBackend_, _PathHelper_) {
    QueryService = _QueryService_;
    $rootScope = _$rootScope_;
    PathHelper = _PathHelper_;
    $httpBackend = _$httpBackend_;
  }));

  describe('query setup', function () {

    beforeEach(function() {
      queryData = {
        group_by: 'type',
        display_sums: 1,
        filters: {
          type_id: {
            operator: '~',
            values: ['Bug', 'Feature']
          }
        }
      };

      query = QueryService.initQuery(null, queryData);
    });

    it('should set query.groupBy', function() {
      expect(query.groupBy).to.equal(queryData.group_by);
    });

    it('should set query.displaySums', function() {
      expect(query.displaySums).to.equal(queryData.display_sums);
    });

    describe('filters', function() {
      // TODO mock promise-returning `getAvailableWorkPackageFilters` method

      it('should load the available filters');

      it('should assign filters to the query');
    });

  });

  describe('deleteQuery', function() {
    var spy;
    beforeEach(function() {
      spy = sinon.spy($rootScope, '$broadcast');
      queryData = { name: '_', 'project_id': 1 };
      QueryService.initQuery(1, queryData);
      var path = PathHelper.apiProjectQueryPath(1, 1);
      $httpBackend.when('DELETE', new RegExp(path + '*')).respond(200, []);
      $httpBackend.when(
        'GET',
        PathHelper.apiProjectCustomFieldsPath(1)
      ).respond(200, []);
      $httpBackend.when(
        'GET',
        PathHelper.apiProjectGroupedQueriesPath(1)
      ).respond(200, []);
      QueryService.deleteQuery();
      $httpBackend.flush();
    });

    afterEach(function() {
      spy.restore();
    });

    it('should broadcast a query deletion message', function() {
      expect($rootScope.$broadcast.calledWith('openproject.layout.removeMenuItem')).to.be.true;
    });
  });

  describe('getQueryName', function() {
    var defaultTitle = 'Work Packages';

    describe('when the query is undefined', function() {
      it('returns undefined', function() {
        expect(QueryService.getQueryName()).to.be.undefined;
      });
    });

    describe('when the query name equals "_"', function() {
      beforeEach(function() {
        queryData = { name: '_' };
        QueryService.initQuery(null, queryData);
      });

      it('returns undefined', function() {
        expect(QueryService.getQueryName()).to.be.undefined;
      });
    });

    describe('when the query has a name', function() {
      var queryName = 'abc';

      beforeEach(function() {
        queryData = { name: queryName };
        QueryService.initQuery(null, queryData);
      });

      it('returns undefined', function() {
        expect(QueryService.getQueryName()).to.equal(queryName);
      });
    });
  });

  describe('loadAvailableGroupedQueries', function() {
    var projectIdentifier = 'test_project',
        $httpBackend,
        path,
        groupedQueries;

    function loadAvailableGroupedQueries() {
      QueryService.loadAvailableGroupedQueries(projectIdentifier);
      $httpBackend.flush();
    }

    beforeEach(inject(function(_$httpBackend_, _PathHelper_) {
      $httpBackend = _$httpBackend_;
      PathHelper = _PathHelper_;

      path = PathHelper.apiProjectGroupedQueriesPath(projectIdentifier);
      groupedQueries = {
        user_queries: [{}, {}],
        queries: [{}]
      };

      $httpBackend.when('GET', path).respond(200, groupedQueries);
    }));

    describe('when called for the first time', function() {
      it('triggers an http request', function() {
        $httpBackend.expectGET(path);

        loadAvailableGroupedQueries();
      });

      it('stores the grouped queries', function() {
        loadAvailableGroupedQueries();

        expect(QueryService.getAvailableGroupedQueries()).to.deep.equal(groupedQueries);
      });
    });

    describe('when called for the second time', function() {
      it('does not do another http call', function() {
        loadAvailableGroupedQueries();
        QueryService.loadAvailableGroupedQueries(projectIdentifier);
        $rootScope.$apply();

        $httpBackend.verifyNoOutstandingRequest();
      });
    });

  });
});