openproject/frontend/app/components/api/api-paths/api-paths.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 {ApiPathsService} from "./api-paths.service";


describe('apiPaths', () => {
  var apiPaths:ApiPathsService;
  var $document:ng.IDocumentService;

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

  beforeEach(angular.mock.inject((_$document_, _apiPaths_) => {
    $document = _$document_;
    apiPaths = _apiPaths_;
  }));

  describe('when with app_base_path', () => {
    beforeEach(() => {
      //reset internal caching of the basePath
      apiPaths.basePath = undefined;
      $document.find('head').append('<meta name="app_base_path" content="my_path" />');
    });

    afterEach(() => {
      $document.find('meta').remove();
      //reset internal caching of the basePath
      apiPaths.basePath = undefined;
    });

    it('should get the app base path from the app_base_path meta tag', () => {
      expect(apiPaths.appBasePath).to.eq('my_path');
    });

    it('should remove trailing slashes from the appBasePath', () => {
      $document.find('meta').remove();
      $document.find('head').append('<meta name="app_base_path" content="my_path/" />');

      expect(apiPaths.appBasePath).to.eq('my_path');
    });

    it('should prepend the paths with the app base path', () => {
      expect(apiPaths.path('v3')).to.eq('my_path/api/v3/');
      expect(apiPaths.v3).to.eq('my_path/api/v3/');
    });
  });

  describe('when without app_base_path', () => {
    it('should return the root path as appBasePath', () => {
      expect(apiPaths.appBasePath).to.eq('');
    });

    describe('when using path()', () => {
      it('should return an api experimental path', () => {
        expect(apiPaths.path('experimental')).to.eq('/api/experimental/');
      });

      it('should return an api v2 path', () => {
        expect(apiPaths.path('v2')).to.eq('/api/v2/');
      });

      it('should return an api v3 path', () => {
        expect(apiPaths.path('v3')).to.eq('/api/v3/');
      });
    });

    describe('when using v3', () => {
      it('should return an api v3 path', () => {
        expect(apiPaths.v3).to.eq('/api/v3/');
      });
    });

    describe('when using v2', () => {
      it('should return an api v3 path', () => {
        expect(apiPaths.v2).to.eq('/api/v2/');
      });
    });

    describe('when using experimental', () => {
      it('should return an api experimental path', () => {
        expect(apiPaths.experimental).to.eq('/api/experimental/');
      });
    });
  });
});