src/test/java/com/google/devtools/build/lib/rules/java/JavaPluginsFlagAliasTest.java

// Copyright 2021 The Bazel Authors. All rights reserved.
//
// 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.devtools.build.lib.rules.java;

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

import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.util.BuildViewTestCase;
import com.google.devtools.build.lib.testutil.TestConstants;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Unit test for {@link JavaPluginsFlagAliasRule} */
@RunWith(JUnit4.class)
public class JavaPluginsFlagAliasTest extends BuildViewTestCase {
  /** Tests that java_plugins_flag_alias target cannot be created in arbitrary location. */
  @Test
  public void javaPluginFlagAlias_wrongLocationThrowsError() throws Exception {
    checkError(
        /* packageName = */ "mytools",
        /* ruleName = */ "custom_plugins_alias",
        /* expectedErrorMessage = */ "Rule //mytools:custom_plugins_alias cannot use private rule",
        "java_plugins_flag_alias(name = 'custom_plugins_alias')");
  }

  /**
   * Tests that when no --plugins flag is set java_plugins_flag_alias returns empty JavaPluginInfo.
   */
  @Test
  public void javaPluginFlagAlias_noFlagSet() throws Exception {
    useConfiguration();

    ConfiguredTarget target =
        getConfiguredTarget(TestConstants.TOOLS_REPOSITORY + "//tools/jdk:java_plugins_flag_alias");

    assertThat(target.get(JavaPluginInfo.PROVIDER)).isEqualTo(JavaPluginInfo.empty());
  }

  /** Tests that a single plugin passed by a flag is returned by java_plugins_flag_alias. */
  @Test
  public void javaPluginFlagAlias_flagWithSinglePlugin() throws Exception {
    scratch.file("java/BUILD", "java_plugin(name = 'plugin', srcs = ['A.java'])");
    useConfiguration("--plugin=//java:plugin");

    ConfiguredTarget target =
        getConfiguredTarget(TestConstants.TOOLS_REPOSITORY + "//tools/jdk:java_plugins_flag_alias");

    assertThat(target.get(JavaPluginInfo.PROVIDER).plugins().processorClasspath().toList())
        .hasSize(1);
  }

  /** Tests that two plugins passed by flag are returned by java_plugins_flag_alias. */
  @Test
  public void javaPluginFlagAlias_flagWithTwoPlugins() throws Exception {
    scratch.file(
        "java/BUILD",
        "java_plugin(name = 'plugin1', srcs = ['A.java'])",
        "java_plugin(name = 'plugin2', srcs = ['B.java'])");
    useConfiguration("--plugin=//java:plugin1", "--plugin=//java:plugin2");

    ConfiguredTarget target =
        getConfiguredTarget(TestConstants.TOOLS_REPOSITORY + "//tools/jdk:java_plugins_flag_alias");

    assertThat(target.get(JavaPluginInfo.PROVIDER).plugins().processorClasspath().toList())
        .hasSize(2);
  }

  /** Tests that passing a java_library to --plugin flag fails. */
  @Test
  public void javaPluginFlagAlias_flagWithJavaLibraryFails() throws Exception {
    scratch.file("java/BUILD", "java_library(name = 'lib', srcs = ['A.java'])");
    useConfiguration("--plugin=//java:lib");

    checkError(
        /* label = */ TestConstants.TOOLS_REPOSITORY + "//tools/jdk:java_plugins_flag_alias",
        getErrorMsgMandatoryProviderMissing("//java:lib", "JavaPluginInfo"));
  }
}