src/test/java/com/google/devtools/build/lib/rules/platform/PlatformConfigurationApiTest.java

// Copyright 2018 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.platform;

import static com.google.common.truth.Truth.assertThat;
import static com.google.devtools.build.lib.testutil.MoreAsserts.assertThrows;

import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.util.BuildViewTestCase;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.packages.SkylarkProvider.SkylarkKey;
import com.google.devtools.build.lib.packages.StructImpl;
import java.util.List;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Tests Skylark API for Platform configuration fragments. */
@RunWith(JUnit4.class)
public class PlatformConfigurationApiTest extends BuildViewTestCase {

  @Test
  public void testHostPlatform() throws Exception {
    scratch.file("platforms/BUILD", "platform(name = 'test_platform')");

    scratch.file(
        "verify/verify.bzl",
        "result = provider()",
        "def _impl(ctx):",
        "  platformConfig = ctx.fragments.platform",
        "  host_platform = platformConfig.host_platform",
        "  return [result(",
        "    host_platform = host_platform,",
        "  )]",
        "verify = rule(",
        "  implementation = _impl,",
        "  fragments = ['platform'],",
        ")");
    scratch.file("verify/BUILD", "load(':verify.bzl', 'verify')", "verify(name = 'verify')");

    useConfiguration("--host_platform=//platforms:test_platform");

    ConfiguredTarget myRuleTarget = getConfiguredTarget("//verify:verify");
    StructImpl info =
        (StructImpl)
            myRuleTarget.get(
                new SkylarkKey(
                    Label.parseAbsolute("//verify:verify.bzl", ImmutableMap.of()), "result"));

    Label hostPlatform = (Label) info.getValue("host_platform");
    assertThat(hostPlatform).isEqualTo(Label.parseAbsoluteUnchecked("//platforms:test_platform"));
  }

  @Test
  public void testTargetPlatform_single() throws Exception {
    scratch.file("platforms/BUILD", "platform(name = 'test_platform')");

    scratch.file(
        "verify/verify.bzl",
        "result = provider()",
        "def _impl(ctx):",
        "  platformConfig = ctx.fragments.platform",
        "  target_platform = platformConfig.platform",
        "  return [result(",
        "    target_platform = target_platform,",
        "  )]",
        "verify = rule(",
        "  implementation = _impl,",
        "  fragments = ['platform'],",
        ")");
    scratch.file("verify/BUILD", "load(':verify.bzl', 'verify')", "verify(name = 'verify')");

    useConfiguration("--platforms=//platforms:test_platform");

    ConfiguredTarget myRuleTarget = getConfiguredTarget("//verify:verify");
    StructImpl info =
        (StructImpl)
            myRuleTarget.get(
                new SkylarkKey(
                    Label.parseAbsolute("//verify:verify.bzl", ImmutableMap.of()), "result"));

    Label targetPlatform = (Label) info.getValue("target_platform");
    assertThat(targetPlatform).isEqualTo(Label.parseAbsoluteUnchecked("//platforms:test_platform"));
  }

  @Test
  public void testEnabledToolchainTypes() throws Exception {
    scratch.file(
        "toolchains/BUILD",
        "toolchain_type(name = 'test_toolchain_type1')",
        "toolchain_type(name = 'test_toolchain_type2')",
        "toolchain_type(name = 'test_toolchain_type3')");

    scratch.file(
        "verify/verify.bzl",
        "result = provider()",
        "def _impl(ctx):",
        "  platformConfig = ctx.fragments.platform",
        "  enabled_toolchain_types = platformConfig.enabled_toolchain_types",
        "  return [result(",
        "    enabled_toolchain_types = enabled_toolchain_types,",
        "  )]",
        "verify = rule(",
        "  implementation = _impl,",
        "  fragments = ['platform'],",
        ")");
    scratch.file("verify/BUILD", "load(':verify.bzl', 'verify')", "verify(name = 'verify',", ")");

    setSkylarkSemanticsOptions("--incompatible_remove_enabled_toolchain_types=false");
    useConfiguration(
        "--enabled_toolchain_types="
            + "//toolchains:test_toolchain_type1,//toolchains:test_toolchain_type3");

    ConfiguredTarget myRuleTarget = getConfiguredTarget("//verify:verify");
    StructImpl info =
        (StructImpl)
            myRuleTarget.get(
                new SkylarkKey(
                    Label.parseAbsolute("//verify:verify.bzl", ImmutableMap.of()), "result"));

    @SuppressWarnings("unchecked")
    List<Label> enabledToolchainTypes = (List<Label>) info.getValue("enabled_toolchain_types");
    assertThat(enabledToolchainTypes)
        .containsExactly(
            Label.parseAbsoluteUnchecked("//toolchains:test_toolchain_type1"),
            Label.parseAbsoluteUnchecked("//toolchains:test_toolchain_type3"));
  }

  @Test
  public void testEnabledToolchainTypes_disabled() throws Exception {
    scratch.file(
        "toolchains/BUILD",
        "toolchain_type(name = 'test_toolchain_type1')",
        "toolchain_type(name = 'test_toolchain_type2')",
        "toolchain_type(name = 'test_toolchain_type3')");

    scratch.file(
        "verify/verify.bzl",
        "result = provider()",
        "def _impl(ctx):",
        "  platformConfig = ctx.fragments.platform",
        "  enabled_toolchain_types = platformConfig.enabled_toolchain_types",
        "  return [result(",
        "    enabled_toolchain_types = enabled_toolchain_types,",
        "  )]",
        "verify = rule(",
        "  implementation = _impl,",
        "  fragments = ['platform'],",
        ")");
    scratch.file("verify/BUILD", "load(':verify.bzl', 'verify')", "verify(name = 'verify',", ")");

    setSkylarkSemanticsOptions("--incompatible_remove_enabled_toolchain_types");
    useConfiguration(
        "--enabled_toolchain_types="
            + "//toolchains:test_toolchain_type1,//toolchains:test_toolchain_type3");

    AssertionError error =
        assertThrows(AssertionError.class, () -> getConfiguredTarget("//verify:verify"));
    assertThat(error)
        .hasMessageThat()
        .contains("object of type 'platform' has no field 'enabled_toolchain_types'");
  }
}