javatests/com/google/gerrit/acceptance/api/change/PluginFieldsIT.java

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

package com.google.gerrit.acceptance.api.change;

import com.google.gerrit.acceptance.NoHttpd;
import com.google.gerrit.extensions.annotations.Exports;
import com.google.gerrit.server.change.ChangeAttributeFactory;
import com.google.inject.AbstractModule;
import org.junit.Test;

@NoHttpd
public class PluginFieldsIT extends AbstractPluginFieldsTest {
  // No tests for /detail via the extension API, since the extension API doesn't have that method.

  @Test
  public void queryChangeApiWithNullAttribute() throws Exception {
    getChangeWithNullAttribute(
        id -> pluginInfoFromSingletonList(gApi.changes().query(id.toString()).get()));
  }

  @Test
  public void getChangeApiWithNullAttribute() throws Exception {
    getChangeWithNullAttribute(
        id -> pluginInfoFromChangeInfo(gApi.changes().id(id.toString()).get()));
  }

  @Test
  public void queryChangeApiWithSimpleAttribute() throws Exception {
    getChangeWithSimpleAttribute(
        id -> pluginInfoFromSingletonList(gApi.changes().query(id.toString()).get()));
  }

  @Test
  public void getChangeApiWithSimpleAttribute() throws Exception {
    getChangeWithSimpleAttribute(
        id -> pluginInfoFromChangeInfo(gApi.changes().id(id.toString()).get()));
  }

  @Test
  public void queryChangeApiWithOption() throws Exception {
    getChangeWithOption(
        id -> pluginInfoFromSingletonList(gApi.changes().query(id.toString()).get()),
        (id, opts) ->
            pluginInfoFromSingletonList(
                gApi.changes().query(id.toString()).withPluginOptions(opts).get()));
  }

  @Test
  public void getChangeApiWithOption() throws Exception {
    getChangeWithOption(
        id -> pluginInfoFromChangeInfo(gApi.changes().id(id.get()).get()),
        (id, opts) -> pluginInfoFromChangeInfo(gApi.changes().id(id.get()).get(opts)));
  }

  static class SimpleAttributeWithExplicitExportModule extends AbstractModule {
    @Override
    public void configure() {
      bind(ChangeAttributeFactory.class)
          .annotatedWith(Exports.named("simple"))
          .toInstance((cd, bp, p) -> new MyInfo("change " + cd.getId()));
    }
  }

  @Test
  public void getChangeApiWithSimpleAttributeWithExplicitExport() throws Exception {
    // For backwards compatibility with old plugins, allow modules to bind into the
    // DynamicSet<ChangeAttributeFactory> as if it were a DynamicMap. We only need one variant of
    // this test to prove that the mapping works.
    getChangeWithSimpleAttribute(
        id -> pluginInfoFromChangeInfo(gApi.changes().id(id.toString()).get()),
        SimpleAttributeWithExplicitExportModule.class);
  }
}