javatests/com/google/gerrit/server/restapi/change/ListChangeCommentsTest.java

// Copyright (C) 2020 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.

package com.google.gerrit.server.restapi.change;

import static com.google.common.truth.Truth.assertThat;

import com.google.common.collect.ImmutableList;
import com.google.gerrit.entities.Change;
import com.google.gerrit.entities.ChangeMessage;
import com.google.gerrit.extensions.common.CommentInfo;
import com.google.gerrit.server.ChangeMessagesUtil;
import com.google.gerrit.server.CommentsUtil;
import java.sql.Timestamp;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

@RunWith(JUnit4.class)
public class ListChangeCommentsTest {

  @Test
  public void commentsLinkedToChangeMessages() {
    /**
     * Human comments should not be linked to auto-generated messages. A comment is linked to the
     * nearest next change message in timestamp
     */
    CommentInfo c1 = getNewCommentInfo("c1", Timestamp.valueOf("2018-01-01 09:01:00"));
    CommentInfo c2 = getNewCommentInfo("c2", Timestamp.valueOf("2018-01-01 09:01:15"));
    CommentInfo c3 = getNewCommentInfo("c3", Timestamp.valueOf("2018-01-01 09:01:25"));

    ChangeMessage cm1 =
        getNewChangeMessage("cm1key", "cm1", Timestamp.valueOf("2018-01-01 00:00:00"), null);
    ChangeMessage cmIgnore =
        getNewChangeMessage(
            "cm2key",
            "cm2",
            Timestamp.valueOf("2018-01-01 09:01:15"),
            ChangeMessagesUtil.AUTOGENERATED_TAG_PREFIX);
    ChangeMessage cm2 =
        getNewChangeMessage("cm2key", "cm2", Timestamp.valueOf("2018-01-01 09:01:16"), null);
    ChangeMessage cm3 =
        getNewChangeMessage("cm3key", "cm3", Timestamp.valueOf("2018-01-01 09:01:27"), null);

    assertThat(c1.changeMessageId).isNull();
    assertThat(c2.changeMessageId).isNull();
    assertThat(c3.changeMessageId).isNull();

    ImmutableList<CommentInfo> comments = ImmutableList.of(c1, c2, c3);
    ImmutableList<ChangeMessage> changeMessages = ImmutableList.of(cm1, cmIgnore, cm2, cm3);

    CommentsUtil.linkCommentsToChangeMessages(comments, changeMessages, true);

    assertThat(c1.changeMessageId).isEqualTo(changeMessageKey(cm2));
    /** comment 2 ignored the auto-generated change message */
    assertThat(c2.changeMessageId).isEqualTo(changeMessageKey(cm2));
    assertThat(c3.changeMessageId).isEqualTo(changeMessageKey(cm3));
  }

  private static CommentInfo getNewCommentInfo(String message, Timestamp ts) {
    CommentInfo c = new CommentInfo();
    c.message = message;
    c.updated = ts;
    return c;
  }

  private static ChangeMessage getNewChangeMessage(
      String id, String message, Timestamp ts, String tag) {
    ChangeMessage.Key key = ChangeMessage.key(Change.id(1), id);
    ChangeMessage cm = new ChangeMessage(key, null, ts, null);
    cm.setMessage(message);
    cm.setTag(tag);
    return cm;
  }

  private static String changeMessageKey(ChangeMessage changeMessage) {
    return changeMessage.getKey().uuid();
  }
}