polygerrit-ui/app/scripts/gr-reviewer-suggestions-provider/gr-reviewer-suggestions-provider_test.ts

/**
 * @license
 * Copyright (C) 2019 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import '../../test/common-test-setup-karma';
import {GrReviewerSuggestionsProvider} from './gr-reviewer-suggestions-provider';
import {getAppContext} from '../../services/app-context';
import {stubRestApi} from '../../test/test-utils';
import {
  ChangeInfo,
  GroupId,
  GroupName,
  NumericChangeId,
  ReviewerState,
} from '../../api/rest-api';
import {
  SuggestedReviewerAccountInfo,
  SuggestedReviewerGroupInfo,
} from '../../types/common';
import {
  createAccountDetailWithIdNameAndEmail,
  createChange,
  createServerInfo,
} from '../../test/test-data-generators';

suite('GrReviewerSuggestionsProvider tests', () => {
  const suggestion1: SuggestedReviewerAccountInfo = {
    account: createAccountDetailWithIdNameAndEmail(3),
    count: 1,
  };
  const suggestion2: SuggestedReviewerAccountInfo = {
    account: createAccountDetailWithIdNameAndEmail(4),
    count: 1,
  };
  const suggestion3: SuggestedReviewerGroupInfo = {
    group: {
      id: 'suggested group id' as GroupId,
      name: 'suggested group' as GroupName,
    },
    count: 4,
  };
  const change: ChangeInfo = createChange();
  let getChangeSuggestedReviewersStub: sinon.SinonStub;
  let getChangeSuggestedCCsStub: sinon.SinonStub;
  let provider: GrReviewerSuggestionsProvider;

  setup(() => {
    getChangeSuggestedReviewersStub = stubRestApi(
      'getChangeSuggestedReviewers'
    ).resolves([suggestion1, suggestion2, suggestion3]);
    getChangeSuggestedCCsStub = stubRestApi('getChangeSuggestedCCs').resolves([
      suggestion1,
      suggestion2,
      suggestion3,
    ]);
    provider = new GrReviewerSuggestionsProvider(
      getAppContext().restApiService,
      ReviewerState.REVIEWER,
      createServerInfo(),
      true,
      change._number
    );
  });

  test('getSuggestions', async () => {
    const reviewers = await provider.getSuggestions('');

    assert.sameDeepMembers(reviewers, [suggestion1, suggestion2, suggestion3]);
  });

  test('getSuggestions short circuits when logged out', async () => {
    await provider.getSuggestions('');
    assert.isTrue(getChangeSuggestedReviewersStub.calledOnce);

    // not logged in
    provider = new GrReviewerSuggestionsProvider(
      getAppContext().restApiService,
      ReviewerState.REVIEWER,
      createServerInfo(),
      false,
      change._number
    );

    await provider.getSuggestions('');

    // no additional call is made
    assert.isTrue(getChangeSuggestedReviewersStub.calledOnce);
  });

  test('only returns REVIEWER suggestions shared by all changes', async () => {
    getChangeSuggestedReviewersStub
      .onSecondCall()
      .resolves([suggestion2, suggestion3]);
    provider = new GrReviewerSuggestionsProvider(
      getAppContext().restApiService,
      ReviewerState.REVIEWER,
      createServerInfo(),
      true,
      ...[change._number, 43 as NumericChangeId]
    );

    // suggestion1 is excluded because it is not returned for the second
    // change.
    assert.sameDeepMembers(await provider.getSuggestions('s'), [
      suggestion2,
      suggestion3,
    ]);
  });

  test('only returns CC suggestions shared by all changes', async () => {
    getChangeSuggestedCCsStub
      .onSecondCall()
      .resolves([suggestion2, suggestion3]);
    provider = new GrReviewerSuggestionsProvider(
      getAppContext().restApiService,
      ReviewerState.CC,
      createServerInfo(),
      true,
      ...[change._number, 43 as NumericChangeId]
    );

    // suggestion1 is excluded because it is not returned for the second
    // change.
    assert.sameDeepMembers(await provider.getSuggestions('s'), [
      suggestion2,
      suggestion3,
    ]);
  });

  test('makeSuggestionItem formats account or group accordingly', () => {
    let account = createAccountDetailWithIdNameAndEmail(1);
    const account3 = createAccountDetailWithIdNameAndEmail(2);
    let suggestion = provider.makeSuggestionItem({account, count: 1});
    assert.deepEqual(suggestion, {
      name: `${account.name} <${account.email}>`,
      value: {account, count: 1},
    });

    const group = {name: 'test' as GroupName, id: '5' as GroupId};
    suggestion = provider.makeSuggestionItem({group, count: 1});
    assert.deepEqual(suggestion, {
      name: `${group.name} (group)`,
      value: {group, count: 1},
    });

    suggestion = provider.makeSuggestionItem(account);
    assert.deepEqual(suggestion, {
      name: `${account.name} <${account.email}>`,
      value: {account, count: 1},
    });

    suggestion = provider.makeSuggestionItem({account: {}, count: 1});
    assert.deepEqual(suggestion, {
      name: 'Name of user not set',
      value: {account: {}, count: 1},
    });

    provider = new GrReviewerSuggestionsProvider(
      getAppContext().restApiService,
      ReviewerState.REVIEWER,
      {
        ...createServerInfo(),
        user: {
          anonymous_coward_name: 'Anonymous Coward Name',
        },
      },
      true,
      change._number
    );

    suggestion = provider.makeSuggestionItem({account: {}, count: 1});
    assert.deepEqual(suggestion, {
      name: 'Anonymous Coward Name',
      value: {account: {}, count: 1},
    });

    account = {...createAccountDetailWithIdNameAndEmail(3), status: 'OOO'};

    suggestion = provider.makeSuggestionItem({account, count: 1});
    assert.deepEqual(suggestion, {
      name: `${account.name} <${account.email}> (OOO)`,
      value: {account, count: 1},
    });

    suggestion = provider.makeSuggestionItem(account);
    assert.deepEqual(suggestion, {
      name: `${account.name} <${account.email}> (OOO)`,
      value: {account, count: 1},
    });

    account3.email = undefined;

    suggestion = provider.makeSuggestionItem(account3);
    assert.deepEqual(suggestion, {
      name: account3.name,
      value: {account: account3, count: 1},
    });
  });
});