| // 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 com.google.common.collect.ImmutableMap; |
| import com.google.devtools.build.lib.analysis.ConfiguredTarget; |
| import com.google.devtools.build.lib.analysis.platform.ConstraintCollection; |
| import com.google.devtools.build.lib.analysis.platform.ConstraintSettingInfo; |
| import com.google.devtools.build.lib.analysis.platform.ConstraintValueInfo; |
| import com.google.devtools.build.lib.analysis.platform.PlatformInfo; |
| 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 com.google.devtools.build.lib.syntax.SkylarkList; |
| import java.util.Collection; |
| import java.util.Set; |
| import java.util.stream.Collectors; |
| import javax.annotation.Nullable; |
| import org.junit.Test; |
| import org.junit.runner.RunWith; |
| import org.junit.runners.JUnit4; |
| |
| /** Tests Skylark API for {@link ConstraintCollection} providers. */ |
| @RunWith(JUnit4.class) |
| public class ConstraintCollectionApiTest extends PlatformTestCase { |
| |
| @Test |
| public void testConstraintSettings() throws Exception { |
| constraintBuilder("//foo:s1").addConstraintValue("value1").write(); |
| constraintBuilder("//foo:s2").addConstraintValue("value2").write(); |
| platformBuilder("//foo:my_platform").addConstraint("value1").addConstraint("value2").write(); |
| |
| ConstraintCollection constraintCollection = fetchConstraintCollection("//foo:my_platform"); |
| assertThat(constraintCollection).isNotNull(); |
| |
| assertThat(collectLabels(constraintCollection.constraintSettings())) |
| .containsExactly( |
| Label.parseAbsoluteUnchecked("//foo:s1"), Label.parseAbsoluteUnchecked("//foo:s2")); |
| } |
| |
| @Test |
| public void testConstraintValue() throws Exception { |
| constraintBuilder("//foo:s1").addConstraintValue("value1").write(); |
| constraintBuilder("//foo:s2").addConstraintValue("value2").write(); |
| constraintBuilder("//foo:unused").write(); |
| platformBuilder("//foo:my_platform").addConstraint("value1").addConstraint("value2").write(); |
| |
| ConstraintCollection constraintCollection = fetchConstraintCollection("//foo:my_platform"); |
| assertThat(constraintCollection).isNotNull(); |
| |
| ConstraintSettingInfo setting = |
| ConstraintSettingInfo.create(Label.parseAbsoluteUnchecked("//foo:s1")); |
| assertThat(constraintCollection.has(setting)).isTrue(); |
| ConstraintValueInfo value = constraintCollection.get(setting); |
| assertThat(value).isNotNull(); |
| assertThat(value.label()).isEqualTo(Label.parseAbsoluteUnchecked("//foo:value1")); |
| assertThat( |
| constraintCollection.has( |
| ConstraintSettingInfo.create(Label.parseAbsoluteUnchecked("//foo:unused")))) |
| .isFalse(); |
| } |
| |
| @Test |
| public void testContraintValue_parent() throws Exception { |
| constraintBuilder("//foo:s1").addConstraintValue("value1").write(); |
| constraintBuilder("//foo:s2").addConstraintValue("value2").write(); |
| constraintBuilder("//foo:s3").addConstraintValue("value3").addConstraintValue("value4").write(); |
| platformBuilder("//foo:p1").addConstraint("value1").addConstraint("value4").write(); |
| platformBuilder("//foo:p2").setParent("//foo:p1").addConstraint("value2").write(); |
| platformBuilder("//foo:p3").setParent("//foo:p2").addConstraint("value3").write(); |
| |
| ConstraintCollection constraintCollection = fetchConstraintCollection("//foo:p3"); |
| assertThat(constraintCollection).isNotNull(); |
| |
| ConstraintSettingInfo setting = |
| ConstraintSettingInfo.create(Label.parseAbsoluteUnchecked("//foo:s1")); |
| assertThat(constraintCollection.has(setting)).isTrue(); |
| ConstraintValueInfo value = constraintCollection.get(setting); |
| assertThat(value).isNotNull(); |
| assertThat(value.label()).isEqualTo(Label.parseAbsoluteUnchecked("//foo:value1")); |
| |
| setting = ConstraintSettingInfo.create(Label.parseAbsoluteUnchecked("//foo:s2")); |
| assertThat(constraintCollection.has(setting)).isTrue(); |
| value = constraintCollection.get(setting); |
| assertThat(value).isNotNull(); |
| assertThat(value.label()).isEqualTo(Label.parseAbsoluteUnchecked("//foo:value2")); |
| |
| setting = ConstraintSettingInfo.create(Label.parseAbsoluteUnchecked("//foo:s3")); |
| assertThat(constraintCollection.has(setting)).isTrue(); |
| value = constraintCollection.get(setting); |
| assertThat(value).isNotNull(); |
| assertThat(value.label()).isEqualTo(Label.parseAbsoluteUnchecked("//foo:value3")); |
| } |
| |
| @Test |
| public void testConstraintValue_starlark() throws Exception { |
| setSkylarkSemanticsOptions("--experimental_platforms_api=true"); |
| constraintBuilder("//foo:s1").addConstraintValue("value1").write(); |
| constraintBuilder("//foo:s2").addConstraintValue("value2").write(); |
| platformBuilder("//foo:my_platform").addConstraint("value1").addConstraint("value2").write(); |
| |
| scratch.file( |
| "verify/verify.bzl", |
| "result = provider()", |
| "def _impl(ctx):", |
| " platform = ctx.attr.platform[platform_common.PlatformInfo]", |
| " constraint_setting = ctx.attr.constraint_setting[platform_common.ConstraintSettingInfo]", |
| " constraint_collection = platform.constraints", |
| " value_from_index = constraint_collection[constraint_setting]", |
| " value_from_get = constraint_collection.get(constraint_setting)", |
| " used_constraints = constraint_collection.constraint_settings", |
| " has_constraint = constraint_collection.has(constraint_setting)", |
| " return [result(", |
| " value_from_index = value_from_index,", |
| " value_from_get = value_from_get,", |
| " used_constraints = used_constraints,", |
| " has_constraint = has_constraint,", |
| " )]", |
| "verify = rule(", |
| " implementation = _impl,", |
| " attrs = {", |
| " 'platform': attr.label(providers = [platform_common.PlatformInfo]),", |
| " 'constraint_setting': attr.label(", |
| " providers = [platform_common.ConstraintSettingInfo]),", |
| " },", |
| ")"); |
| scratch.file( |
| "verify/BUILD", |
| "load(':verify.bzl', 'verify')", |
| "verify(name = 'verify',", |
| " platform = '//foo:my_platform',", |
| " constraint_setting = '//foo:s1',", |
| ")"); |
| |
| ConfiguredTarget myRuleTarget = getConfiguredTarget("//verify:verify"); |
| StructImpl info = |
| (StructImpl) |
| myRuleTarget.get( |
| new SkylarkKey( |
| Label.parseAbsolute("//verify:verify.bzl", ImmutableMap.of()), "result")); |
| |
| @SuppressWarnings("unchecked") |
| ConstraintValueInfo constraintValueFromIndex = |
| (ConstraintValueInfo) info.getValue("value_from_index"); |
| assertThat(constraintValueFromIndex).isNotNull(); |
| assertThat(constraintValueFromIndex.label()) |
| .isEqualTo(Label.parseAbsoluteUnchecked("//foo:value1")); |
| |
| @SuppressWarnings("unchecked") |
| ConstraintValueInfo constraintValueFromGet = |
| (ConstraintValueInfo) info.getValue("value_from_get"); |
| assertThat(constraintValueFromGet).isNotNull(); |
| assertThat(constraintValueFromGet.label()) |
| .isEqualTo(Label.parseAbsoluteUnchecked("//foo:value1")); |
| |
| @SuppressWarnings("unchecked") |
| SkylarkList<ConstraintSettingInfo> usedConstraints = |
| (SkylarkList<ConstraintSettingInfo>) info.getValue("used_constraints"); |
| assertThat(usedConstraints).isNotNull(); |
| assertThat(usedConstraints) |
| .containsExactly( |
| ConstraintSettingInfo.create(Label.parseAbsoluteUnchecked("//foo:s1")), |
| ConstraintSettingInfo.create(Label.parseAbsoluteUnchecked("//foo:s2"))); |
| |
| boolean hasConstraint = (boolean) info.getValue("has_constraint"); |
| assertThat(hasConstraint).isTrue(); |
| } |
| |
| @Test |
| public void testGet_defaultConstraintValues() throws Exception { |
| constraintBuilder("//constraint/default:basic") |
| .defaultConstraintValue("foo") |
| .addConstraintValue("bar") |
| .write(); |
| constraintBuilder("//constraint/default:other").write(); |
| |
| platformBuilder("//constraint/default:plat_with_default").write(); |
| platformBuilder("//constraint/default:plat_without_default").addConstraint("bar").write(); |
| |
| ConstraintSettingInfo basicConstraintSetting = |
| fetchConstraintSettingInfo("//constraint/default:basic"); |
| ConstraintSettingInfo otherConstraintSetting = |
| fetchConstraintSettingInfo("//constraint/default:other"); |
| |
| ConstraintCollection constraintCollectionWithDefault = |
| fetchConstraintCollection("//constraint/default:plat_with_default"); |
| assertThat(constraintCollectionWithDefault).isNotNull(); |
| assertThat(constraintCollectionWithDefault.has(basicConstraintSetting)).isTrue(); |
| assertThat(constraintCollectionWithDefault.get(basicConstraintSetting)).isNotNull(); |
| assertThat(constraintCollectionWithDefault.get(basicConstraintSetting).label()) |
| .isEqualTo(makeLabel("//constraint/default:foo")); |
| assertThat(constraintCollectionWithDefault.has(otherConstraintSetting)).isFalse(); |
| assertThat(constraintCollectionWithDefault.get(otherConstraintSetting)).isNull(); |
| |
| ConstraintCollection constraintCollectionWithoutDefault = |
| fetchConstraintCollection("//constraint/default:plat_without_default"); |
| assertThat(constraintCollectionWithoutDefault).isNotNull(); |
| assertThat(constraintCollectionWithDefault.has(basicConstraintSetting)).isTrue(); |
| assertThat(constraintCollectionWithoutDefault.get(basicConstraintSetting)).isNotNull(); |
| assertThat(constraintCollectionWithoutDefault.get(basicConstraintSetting).label()) |
| .isEqualTo(makeLabel("//constraint/default:bar")); |
| } |
| |
| private Set<Label> collectLabels(Collection<? extends ConstraintSettingInfo> settings) { |
| return settings.stream().map(ConstraintSettingInfo::label).collect(Collectors.toSet()); |
| } |
| |
| @Nullable |
| private ConstraintCollection fetchConstraintCollection(String platformLabel) throws Exception { |
| PlatformInfo platformInfo = fetchPlatformInfo(platformLabel); |
| if (platformInfo == null) { |
| return null; |
| } |
| return platformInfo.constraints(); |
| } |
| } |