| // Copyright 2016 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.proto; |
| |
| import static com.google.common.truth.Truth.assertThat; |
| import static com.google.devtools.build.lib.actions.util.ActionsTestUtil.prettyArtifactNames; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.eventbus.EventBus; |
| import com.google.devtools.build.lib.analysis.TransitiveInfoCollection; |
| import com.google.devtools.build.lib.analysis.util.BuildViewTestCase; |
| import com.google.devtools.build.lib.cmdline.Label; |
| import com.google.devtools.build.lib.packages.util.MockProtoSupport; |
| import com.google.devtools.build.lib.testutil.TestConstants; |
| import org.junit.Before; |
| import org.junit.Test; |
| import org.junit.runner.RunWith; |
| import org.junit.runners.JUnit4; |
| |
| @RunWith(JUnit4.class) |
| public class ProtoLangToolchainTest extends BuildViewTestCase { |
| @Before |
| public void setUp() throws Exception { |
| MockProtoSupport.setupWorkspace(scratch); |
| MockProtoSupport.setup(mockToolsConfig); |
| invalidatePackages(); |
| } |
| |
| private void validateProtoLangToolchain(ProtoLangToolchainProvider toolchain) throws Exception { |
| assertThat(toolchain.commandLine()).isEqualTo("cmd-line"); |
| assertThat(toolchain.pluginExecutable().getExecutable().getRootRelativePathString()) |
| .isEqualTo("third_party/x/plugin"); |
| |
| TransitiveInfoCollection runtimes = toolchain.runtime(); |
| assertThat(runtimes.getLabel()) |
| .isEqualTo(Label.parseAbsolute("//third_party/x:runtime", ImmutableMap.of())); |
| |
| assertThat(prettyArtifactNames(toolchain.blacklistedProtos())) |
| .containsExactly( |
| "third_party/x/metadata.proto", |
| "third_party/x/descriptor.proto", |
| "third_party/x/any.proto"); |
| } |
| |
| @Test |
| public void protoToolchain() throws Exception { |
| scratch.file( |
| "third_party/x/BUILD", |
| "licenses(['unencumbered'])", |
| "cc_binary(name = 'plugin', srcs = ['plugin.cc'])", |
| "cc_library(name = 'runtime', srcs = ['runtime.cc'])", |
| "filegroup(name = 'descriptors', srcs = ['metadata.proto', 'descriptor.proto'])", |
| "filegroup(name = 'any', srcs = ['any.proto'])", |
| "proto_library(name = 'blacklist', srcs = [':descriptors', ':any'])"); |
| |
| scratch.file( |
| "foo/BUILD", |
| TestConstants.LOAD_PROTO_LANG_TOOLCHAIN, |
| "licenses(['unencumbered'])", |
| "proto_lang_toolchain(", |
| " name = 'toolchain',", |
| " command_line = 'cmd-line',", |
| " plugin = '//third_party/x:plugin',", |
| " runtime = '//third_party/x:runtime',", |
| " blacklisted_protos = ['//third_party/x:blacklist']", |
| ")"); |
| |
| update(ImmutableList.of("//foo:toolchain"), false, 1, true, new EventBus()); |
| |
| validateProtoLangToolchain( |
| getConfiguredTarget("//foo:toolchain").getProvider(ProtoLangToolchainProvider.class)); |
| } |
| |
| @Test |
| public void protoToolchainBlacklistProtoLibraries() throws Exception { |
| scratch.file( |
| "third_party/x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "licenses(['unencumbered'])", |
| "cc_binary(name = 'plugin', srcs = ['plugin.cc'])", |
| "cc_library(name = 'runtime', srcs = ['runtime.cc'])", |
| "proto_library(name = 'descriptors', srcs = ['metadata.proto', 'descriptor.proto'])", |
| "proto_library(name = 'any', srcs = ['any.proto'], strip_import_prefix = '/third_party')"); |
| |
| scratch.file( |
| "foo/BUILD", |
| TestConstants.LOAD_PROTO_LANG_TOOLCHAIN, |
| "proto_lang_toolchain(", |
| " name = 'toolchain',", |
| " command_line = 'cmd-line',", |
| " plugin = '//third_party/x:plugin',", |
| " runtime = '//third_party/x:runtime',", |
| " blacklisted_protos = ['//third_party/x:descriptors', '//third_party/x:any']", |
| ")"); |
| |
| update(ImmutableList.of("//foo:toolchain"), false, 1, true, new EventBus()); |
| |
| validateProtoLangToolchain( |
| getConfiguredTarget("//foo:toolchain").getProvider(ProtoLangToolchainProvider.class)); |
| } |
| |
| @Test |
| public void protoToolchainMixedBlacklist() throws Exception { |
| scratch.file( |
| "third_party/x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "licenses(['unencumbered'])", |
| "cc_binary(name = 'plugin', srcs = ['plugin.cc'])", |
| "cc_library(name = 'runtime', srcs = ['runtime.cc'])", |
| "proto_library(name = 'metadata', srcs = ['metadata.proto'])", |
| "proto_library(", |
| " name = 'descriptor',", |
| " srcs = ['descriptor.proto'],", |
| " strip_import_prefix = '/third_party')", |
| "filegroup(name = 'any', srcs = ['any.proto'])"); |
| |
| scratch.file( |
| "foo/BUILD", |
| TestConstants.LOAD_PROTO_LANG_TOOLCHAIN, |
| "proto_lang_toolchain(", |
| " name = 'toolchain',", |
| " command_line = 'cmd-line',", |
| " plugin = '//third_party/x:plugin',", |
| " runtime = '//third_party/x:runtime',", |
| " blacklisted_protos = [", |
| " '//third_party/x:metadata',", |
| " '//third_party/x:descriptor',", |
| " '//third_party/x:any']", |
| ")"); |
| |
| update(ImmutableList.of("//foo:toolchain"), false, 1, true, new EventBus()); |
| |
| validateProtoLangToolchain( |
| getConfiguredTarget("//foo:toolchain").getProvider(ProtoLangToolchainProvider.class)); |
| } |
| |
| @Test |
| public void optionalFieldsAreEmpty() throws Exception { |
| scratch.file( |
| "foo/BUILD", |
| TestConstants.LOAD_PROTO_LANG_TOOLCHAIN, |
| "proto_lang_toolchain(", |
| " name = 'toolchain',", |
| " command_line = 'cmd-line',", |
| ")"); |
| |
| update(ImmutableList.of("//foo:toolchain"), false, 1, true, new EventBus()); |
| |
| ProtoLangToolchainProvider toolchain = |
| getConfiguredTarget("//foo:toolchain").getProvider(ProtoLangToolchainProvider.class); |
| |
| assertThat(toolchain.pluginExecutable()).isNull(); |
| assertThat(toolchain.runtime()).isNull(); |
| assertThat(toolchain.blacklistedProtos().toList()).isEmpty(); |
| } |
| |
| @Test |
| public void testMigrationLabel() throws Exception { |
| useConfiguration("--incompatible_load_proto_rules_from_bzl"); |
| scratch.file( |
| "a/BUILD", |
| "proto_lang_toolchain(", |
| " name = 'toolchain',", |
| " command_line = 'cmd-line',", |
| // Don't use |ProtoCommon.PROTO_RULES_MIGRATION_LABEL| here |
| // so we don't accidentally change it without breaking a local test. |
| " tags = ['__PROTO_RULES_MIGRATION_DO_NOT_USE_WILL_BREAK__'],", |
| ")"); |
| |
| getConfiguredTarget("//a:toolchain"); |
| } |
| |
| @Test |
| public void testMissingMigrationLabel() throws Exception { |
| useConfiguration("--incompatible_load_proto_rules_from_bzl"); |
| scratch.file( |
| "a/BUILD", |
| "proto_lang_toolchain(", |
| " name = 'toolchain',", |
| " command_line = 'cmd-line',", |
| ")"); |
| |
| reporter.removeHandler(failFastHandler); |
| getConfiguredTarget("//a:toolchain"); |
| assertContainsEvent("The native Protobuf rules are deprecated."); |
| } |
| |
| @Test |
| public void testMigrationLabelNotRequiredWhenDisabled() throws Exception { |
| useConfiguration("--noincompatible_load_proto_rules_from_bzl"); |
| scratch.file( |
| "a/BUILD", |
| "proto_lang_toolchain(", |
| " name = 'toolchain',", |
| " command_line = 'cmd-line',", |
| ")"); |
| |
| getConfiguredTarget("//a:toolchain"); |
| } |
| } |