openproject/frontend/app/components/api/api-v3/hal-resources/work-package-resource.service.test.ts

//-- 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.
//++

import {opApiModule} from '../../../../angular-modules';
import {WorkPackageResourceInterface} from './work-package-resource.service';
import {WorkPackageCacheService} from '../../../work-packages/work-package-cache.service';
import IHttpBackendService = angular.IHttpBackendService;
import SinonStub = Sinon.SinonStub;

describe('WorkPackageResource service', () => {
  var $httpBackend: IHttpBackendService;
  var WorkPackageResource;
  var AttachmentCollectionResource;
  var wpCacheService: WorkPackageCacheService;

  beforeEach(angular.mock.module(opApiModule.name));
  beforeEach(angular.mock.inject(function (_$httpBackend_,
                                           _WorkPackageResource_,
                                           _AttachmentCollectionResource_,
                                           _wpCacheService_) {
    [
      $httpBackend,
      WorkPackageResource,
      AttachmentCollectionResource,
      wpCacheService
    ] = _.toArray(arguments);
  }));

  it('should exist', () => {
    expect(WorkPackageResource).to.exist;
  });

  describe('when the resource was created', () => {
    var source: any;
    var workPackage: WorkPackageResourceInterface;
    var updateWorkPackageStub: SinonStub;

    const expectUncachedRequests = (urls) => {
      urls.forEach(url => {
        $httpBackend
          .expectGET(url, headers => headers.caching.enabled === false)
          .respond(200, {});
      });
      $httpBackend.flush();
    };
    const testWpCacheUpdateWith = (prepare, ...urls) => {
      beforeEach(() => {
        prepare();
        expectUncachedRequests(urls);
      });

      it('should update the work package cache', () => {
        expect(updateWorkPackageStub.calledWith(workPackage)).to.be.true;
      });
    };

    beforeEach(() => {
      source = {
        _links: {
          activities: {
            href: 'activities'
          },
          attachments: {
            href: 'attachments'
          }
        }
      };
      workPackage = new WorkPackageResource(source);
      updateWorkPackageStub = sinon.stub(wpCacheService, 'updateWorkPackage');
    });

    afterEach(() => {
      updateWorkPackageStub.restore();
    });

    it('should have attachments that are of type `AttachmentCollectionResource`', () => {
      expect(workPackage.attachments).to.be.instanceOf(AttachmentCollectionResource);
    });

    describe('when updating multiple linked resource', () => {
      testWpCacheUpdateWith(() => {
        workPackage.updateLinkedResources('activities', 'attachments');
      }, 'activities', 'attachments');
    });

    describe('when updating the activities', () => {
      testWpCacheUpdateWith(() => {
        workPackage.updateActivities();
      }, 'activities');
    });

    describe('when updating the attachments', () => {
      testWpCacheUpdateWith(() => {
        workPackage.updateAttachments();
      }, 'activities', 'attachments');
    });
  });
});