src/test/java/com/google/devtools/build/lib/analysis/platform/TemplateVariableInfoTest.java

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

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

import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.TemplateVariableInfo;
import com.google.devtools.build.lib.analysis.actions.SpawnAction;
import com.google.devtools.build.lib.analysis.util.BuildViewTestCase;
import com.google.devtools.build.lib.packages.StarlarkInfo;
import java.util.Map;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Tests of {@link TemplateVariableInfo}. */
@RunWith(JUnit4.class)
public class TemplateVariableInfoTest extends BuildViewTestCase {

  @Test
  public void proxyTemplateVariableInfo() throws Exception {
    scratch.file(
        "a/rule.bzl",
        """
        def _impl(ctx):
            return [ctx.attr._cc_toolchain[platform_common.TemplateVariableInfo]]

        crule = rule(_impl, attrs = {"_cc_toolchain": attr.label(default = Label("//a:a"))})
        """);

    scratch.file(
        "a/BUILD",
        """
        load(":rule.bzl", "crule")

        cc_toolchain_alias(name = "a")

        crule(name = "r")

        genrule(
            name = "g",
            srcs = [],
            outs = ["go"],
            cmd = "VAR $(CC)",
            toolchains = [":r"],
        )
        """);

    SpawnAction action = (SpawnAction) getGeneratingAction(getConfiguredTarget("//a:g"), "a/go");
    assertThat(action.getArguments().get(2)).containsMatch("VAR .*gcc");
  }

  @Test
  public void templateVariableInfo() throws Exception {
    scratch.file(
        "a/rule.bzl",
        """
        Info = provider()
        def _impl(ctx):
            return Info(
                variables = ctx.attr._cc_toolchain[platform_common.TemplateVariableInfo].variables,
            )

        crule = rule(_impl, attrs = {"_cc_toolchain": attr.label(default = Label("//a:a"))})
        """);

    scratch.file(
        "a/BUILD",
        """
        load(":rule.bzl", "crule")

        cc_toolchain_alias(name = "a")

        crule(name = "r")
        """);
    ConfiguredTarget ct = getConfiguredTarget("//a:r");

    StarlarkInfo info = getStarlarkProvider(ct, "Info");
    @SuppressWarnings("unchecked")
    Map<String, String> makeVariables = (Map<String, String>) info.getValue("variables");
    assertThat(makeVariables).containsKey("CC");
  }

  @Test
  public void templateVariableInfoConstructor() throws Exception {
    scratch.file(
        "a/rule.bzl",
        """
        Info = provider()
        def _consumer_impl(ctx):
            return Info(
                var = ctx.attr.supplier[platform_common.TemplateVariableInfo]
                    .variables[ctx.attr.var],
            )

        def _supplier_impl(ctx):
            return [platform_common.TemplateVariableInfo({ctx.attr.var: ctx.attr.value})]

        consumer = rule(
            _consumer_impl,
            attrs = {"var": attr.string(), "supplier": attr.label()},
        )
        supplier = rule(
            _supplier_impl,
            attrs = {"var": attr.string(), "value": attr.string()},
        )
        """);

    scratch.file(
        "a/BUILD",
        """
        load(":rule.bzl", "consumer", "supplier")

        consumer(
            name = "consumer",
            supplier = ":supplier",
            var = "cherry",
        )

        supplier(
            name = "supplier",
            value = "ontop",
            var = "cherry",
        )
        """);

    ConfiguredTarget consumer = getConfiguredTarget("//a:consumer");
    StarlarkInfo info = getStarlarkProvider(consumer, "Info");
    String value = info.getValue("var", String.class);
    assertThat(value).isEqualTo("ontop");

    ConfiguredTarget supplier = getConfiguredTarget("//a:supplier");
    assertThat(supplier.get(TemplateVariableInfo.PROVIDER).getVariables())
        .containsExactly("cherry", "ontop");
  }
}