javatests/com/google/gerrit/index/IndexUpgradeValidatorTest.java

// Copyright (C) 2022 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.index;

import static com.google.common.truth.Truth.assertThat;
import static com.google.gerrit.index.SchemaUtil.schema;
import static com.google.gerrit.testing.GerritJUnit.assertThrows;

import com.google.common.collect.ImmutableList;
import com.google.gerrit.index.SchemaFieldDefs.Getter;
import com.google.gerrit.server.index.change.ChangeField;
import com.google.gerrit.server.query.change.ChangeData;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Tests {@link IndexUpgradeValidator}. */
@RunWith(JUnit4.class)
public class IndexUpgradeValidatorTest {

  // TODO(mariasavtchouk): adopt this test to verity IndexedFields follow the same constraints as
  // SchemaFields.
  @Test
  public void valid() {
    IndexUpgradeValidator.assertValid(
        schema(
            1,
            ImmutableList.<IndexedField<ChangeData, ?>>of(ChangeField.CHANGE_ID_FIELD),
            ImmutableList.<IndexedField<ChangeData, ?>.SearchSpec>of(ChangeField.CHANGE_ID_SPEC)),
        schema(
            2,
            ImmutableList.<IndexedField<ChangeData, ?>>of(ChangeField.CHANGE_ID_FIELD),
            ImmutableList.<IndexedField<ChangeData, ?>.SearchSpec>of(ChangeField.CHANGE_ID_SPEC)));
    IndexUpgradeValidator.assertValid(
        schema(
            1,
            ImmutableList.<IndexedField<ChangeData, ?>>of(ChangeField.CHANGE_ID_FIELD),
            ImmutableList.<IndexedField<ChangeData, ?>.SearchSpec>of(ChangeField.CHANGE_ID_SPEC)),
        schema(
            2,
            ImmutableList.<IndexedField<ChangeData, ?>>of(
                ChangeField.OWNER_FIELD, ChangeField.CHANGE_ID_FIELD),
            ImmutableList.<IndexedField<ChangeData, ?>.SearchSpec>of(
                ChangeField.OWNER_SPEC, ChangeField.CHANGE_ID_SPEC)));
    IndexUpgradeValidator.assertValid(
        schema(
            1,
            ImmutableList.<IndexedField<ChangeData, ?>>of(ChangeField.CHANGE_ID_FIELD),
            ImmutableList.<IndexedField<ChangeData, ?>.SearchSpec>of(ChangeField.CHANGE_ID_SPEC)),
        schema(
            2,
            ImmutableList.<IndexedField<ChangeData, ?>>of(
                ChangeField.CHANGE_ID_FIELD,
                ChangeField.OWNER_FIELD,
                ChangeField.COMMITTER_PARTS_FIELD),
            ImmutableList.<IndexedField<ChangeData, ?>.SearchSpec>of(
                ChangeField.CHANGE_ID_SPEC,
                ChangeField.OWNER_SPEC,
                ChangeField.COMMITTER_PARTS_SPEC)));
  }

  @Test
  public void invalid_addAndRemove() {
    AssertionError e =
        assertThrows(
            AssertionError.class,
            () ->
                IndexUpgradeValidator.assertValid(
                    schema(
                        1,
                        ImmutableList.<IndexedField<ChangeData, ?>>of(ChangeField.CHANGE_ID_FIELD),
                        ImmutableList.<IndexedField<ChangeData, ?>.SearchSpec>of(
                            ChangeField.CHANGE_ID_SPEC)),
                    schema(
                        2,
                        ImmutableList.<IndexedField<ChangeData, ?>>of(ChangeField.OWNER_FIELD),
                        ImmutableList.<IndexedField<ChangeData, ?>.SearchSpec>of(
                            ChangeField.OWNER_SPEC))));
    assertThat(e)
        .hasMessageThat()
        .contains("Schema upgrade to version 2 may either add or remove fields, but not both");
  }

  @Test
  public void invalid_modify() {
    // Change value type from String to Integer.
    IndexedField<ChangeData, Integer> ID_MODIFIED =
        IndexedField.<ChangeData>integerBuilder(ChangeField.CHANGE_ID_FIELD.name()).build(cd -> 42);
    AssertionError e =
        assertThrows(
            AssertionError.class,
            () ->
                IndexUpgradeValidator.assertValid(
                    schema(
                        1,
                        ImmutableList.<IndexedField<ChangeData, ?>>of(ChangeField.CHANGE_ID_FIELD),
                        ImmutableList.<IndexedField<ChangeData, ?>.SearchSpec>of(
                            ChangeField.CHANGE_ID_SPEC)),
                    schema(
                        2,
                        ImmutableList.<IndexedField<ChangeData, ?>>of(ID_MODIFIED),
                        ImmutableList.<IndexedField<ChangeData, ?>.SearchSpec>of())));
    assertThat(e).hasMessageThat().contains("Fields may not be modified");
    assertThat(e).hasMessageThat().contains(ChangeField.CHANGE_ID_FIELD.name());
  }

  @Test
  public void invalid_modify_referenceEquality() {
    // Comparison uses Object.equals(), i.e. reference equality.
    Getter<ChangeData, String> getter = cd -> cd.change().getKey().get();
    IndexedField<ChangeData, String> ID_1 =
        IndexedField.<ChangeData>stringBuilder(ChangeField.CHANGE_ID_FIELD.name()).build(getter);
    IndexedField<ChangeData, String> ID_2 =
        IndexedField.<ChangeData>stringBuilder(ChangeField.CHANGE_ID_FIELD.name()).build(getter);
    AssertionError e =
        assertThrows(
            AssertionError.class,
            () ->
                IndexUpgradeValidator.assertValid(
                    schema(1, ImmutableList.of(ID_1), ImmutableList.of()),
                    schema(2, ImmutableList.of(ID_2), ImmutableList.of())));
    assertThat(e).hasMessageThat().contains("Fields may not be modified");
    assertThat(e).hasMessageThat().contains(ChangeField.CHANGE_ID_FIELD.name());
  }
}