openproject/frontend/app/components/routing/wp-list/wp-list.controller.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('WorkPackagesListController', function() {
  var scope, ctrl, win, testProjectService, testWorkPackageService, testQueryService,
      testPaginationService, testApiWorkPackages, testAuthorisationService;
  var testQueries;
  var buildController;
  var stateParams = {};

  beforeEach(angular.mock.module('openproject.api', 'openproject.workPackages.controllers',
    'openproject.workPackages.services', 'ng-context-menu', 'btford.modal', 'openproject.layout',
    'openproject.services', 'openproject.wpButtons'));

  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(inject(function($rootScope, $controller, $timeout, $q) {
    scope = $rootScope.$new();
    win   = {
      location: { pathname: '' }
    };

    var defaultWorkPackagesData = {
      meta: {
        query: {
          _links: []
        },
        sums: [null]
      },
      work_packages: []
    };
    var workPackagesDataByQueryId = {
      meta: {
        query: {
          props: { id: 1 },
          _links: []
        },
        sums: [null]
      },
      work_packages: []
    };
    var columnData = {
    };
    var availableQueryiesData = {
    };

    var projectData  = { embedded: { types: [] } };
    var projectsData = [ projectData ];
    testQueries = {
      '1': {
        id: 1,
        columns: ['type'],
        getSortation: function() { return null; },
        isNew: function() { return false; }
      },
      '2': {
        id: 2,
        columns: ['type'],
        getSortation: function() { return null; },
        isNew: function() { return false; }
      }
    };

    testProjectService = {
      getProject: function() {
        return $timeout(function() {
          return projectData;
        }, 10);
      },
      getProjects: function() {
        return $timeout(function() {
          return projectsData;
        }, 10);
      }
    };

    testWorkPackageService = {
      getWorkPackages: function () {
        return $timeout(function () {
          return defaultWorkPackagesData;
        }, 10);
      },
      getWorkPackagesByQueryId: function () {
        return $timeout(function () {
          return workPackagesDataByQueryId;
        }, 10);
      }
    };

    testApiWorkPackages = {
      list: function() {
        var deferred = $q.defer();
        deferred.resolve({
          "_type": "Collection",
          "elements": [],
        });
        return deferred.promise;
      }
    };

    testQueryService = {
      getQuery: function () {
        return {
          getQueryString: function () {
          }
        };
      },
      initQuery: function (id) {
        var queryId = id || 1;
        return testQueries[queryId];
      },
      clearQuery: function() {},
      loadAvailableColumns: function () {
        return $timeout(function () {
          return columnData;
        }, 10);
      },
      loadAvailableGroupedQueries: function () {
        return $timeout(function () {
          return availableQueryiesData;
        }, 10);
      },

      loadAvailableUnusedColumns: function() {
        return $timeout(function () {
          return columnData;
        }, 10);
      },

      getTotalEntries: function() {
      },

      setTotalEntries: function() {
        return 10;
      },
    };
    testPaginationService = {
      setPerPageOptions: function () {
      },
      setPerPage: function () {
      },
      setPage: function () {
      }
    };
    testAuthorisationService = {
      initModelAuth: function(model, links) {
      }
    };

    buildController = function(params, state, location) {
      scope.projectIdentifier = 'test';

      ctrl = $controller("WorkPackagesListController", {
        $scope:  scope,
        $window: win,
        QueryService:       testQueryService,
        PaginationService:  testPaginationService,
        ProjectService:     testProjectService,
        WorkPackageService: testWorkPackageService,
        apiWorkPackages:    testApiWorkPackages,
        $stateParams:       params,
        $state:             state,
        $location:          location,
      });

      $timeout.flush();
    };

  }));

  describe('initialisation of default query', function() {
    var testParams, testState, testLocation;

    beforeEach(function(){
      testParams = { projectPath: '/projects/my-project' };
      testState = {
        params: testParams,
        href: function() { return ''; }
      };
      testLocation = {
        search: function() {
          return {};
        },
        url: angular.identity
      };

      buildController(testParams, testState, testLocation);
    });

    it('should initialise', function() {
      expect(scope.settingUpPage).to.be.defined;
      expect(scope.operatorsAndLabelsByFilterType).to.be.defined;
      expect(scope.disableFilters).to.eq(false);
      expect(scope.disableNewWorkPackage).to.eq(true);
      expect(scope.query.id).to.eq(testQueries['1'].id);
      expect(scope.showFiltersOptions).to.eq(false);
    });

    context('second initialisation', function() {
      beforeEach(function() {
        scope.toggleShowFilterOptions();
        buildController(testParams, testState, testLocation);
      });

      it('should persist the showFiltersOptions value', function() {
        expect(scope.showFiltersOptions).to.eq(true);
      });
    });
  });

  describe('initialisation of query by id', function() {
    var testParams, testState, testLocation;

    beforeEach(function(){
      testParams = { projectPath: '/projects/my-project' };
      testState = {
        params: {
          query_id: testQueries['2'].id
        },
        href: function() { return ''; }
      };
      testLocation = {
        search: function() {
          return {};
        },
        url: angular.identity
      };

      buildController(testParams, testState, testLocation);
    });

    it('should initialise', function() {
      expect(scope.query.id).to.eq(testQueries['2'].id);
    });
  });

  describe('getFilterCount', function() {
    beforeEach(function(){
      var testState = {
        params: {
          query_id: testQueries['2'].id
        },
        href: function() { return ''; }
      };
      var testLocation = {
        search: function() {
          return {};
        },
        url: angular.identity
      };

      buildController({projectPath: ''}, testState, testLocation);
    });

    it('returns 0 with no filters', function() {
      expect(scope.getFilterCount()).to.eq(0);
    });

    it('returns the filter count with filters', function() {
      scope.query.filters = [{}, {}];

      expect(scope.getFilterCount()).to.eq(2);
    });

    it('returns the filter count with deactivated filters', function() {
      scope.query.filters = [{}, { deactivated: true }, { deactivated: true }];

      expect(scope.getFilterCount()).to.eq(1);
    });
  });

  describe('setting projectIdentifier', function() {
    var testParams, testState, testLocation;

    beforeEach(function() {
      testParams = { projectPath: 'my-project' };
      testState = {
        href: function() { return '' },
        params: testParams
      };
      testLocation = {
        search: function() { return {} },
        url: angular.identity
      };
      buildController(testParams, testState, testLocation);
    });

    it('should set the projectIdentifier', function() {
      expect(scope.projectIdentifier).to.eq('my-project');
    });
  });
});