| // 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.cpp.proto; |
| |
| import static com.google.common.truth.Truth.assertThat; |
| import static com.google.devtools.build.lib.actions.util.ActionsTestUtil.getFirstArtifactEndingWith; |
| import static com.google.devtools.build.lib.actions.util.ActionsTestUtil.prettyArtifactNames; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.Iterables; |
| import com.google.common.eventbus.EventBus; |
| import com.google.devtools.build.lib.actions.Artifact; |
| import com.google.devtools.build.lib.analysis.ConfiguredTarget; |
| import com.google.devtools.build.lib.analysis.actions.SpawnAction; |
| import com.google.devtools.build.lib.analysis.util.BuildViewTestCase; |
| import com.google.devtools.build.lib.cmdline.Label; |
| import com.google.devtools.build.lib.cmdline.LabelSyntaxException; |
| import com.google.devtools.build.lib.cmdline.RepositoryName; |
| import com.google.devtools.build.lib.packages.AspectParameters; |
| import com.google.devtools.build.lib.packages.StarlarkAspectClass; |
| import com.google.devtools.build.lib.packages.util.Crosstool.CcToolchainConfig; |
| import com.google.devtools.build.lib.packages.util.MockProtoSupport; |
| import com.google.devtools.build.lib.rules.cpp.CcCompilationContext; |
| import com.google.devtools.build.lib.rules.cpp.CcInfo; |
| import com.google.devtools.build.lib.rules.cpp.CppCompileAction; |
| import com.google.devtools.build.lib.rules.cpp.CppRuleClasses; |
| import com.google.devtools.build.lib.testutil.TestConstants; |
| import com.google.devtools.build.lib.vfs.FileSystemUtils; |
| import com.google.devtools.build.lib.vfs.PathFragment; |
| import java.util.List; |
| import org.junit.Before; |
| import org.junit.Test; |
| import org.junit.runner.RunWith; |
| import org.junit.runners.JUnit4; |
| |
| @RunWith(JUnit4.class) |
| public class CcProtoLibraryTest extends BuildViewTestCase { |
| |
| private final StarlarkAspectClass starlarkCcProtoAspect = |
| new StarlarkAspectClass( |
| Label.parseAbsoluteUnchecked("@_builtins//:common/cc/cc_proto_library.bzl"), |
| "cc_proto_aspect"); |
| |
| @Before |
| public void setUp() throws Exception { |
| MockProtoSupport.setup(mockToolsConfig); |
| scratch.file( |
| "third_party/bazel_rules/rules_cc/cc/proto/BUILD", |
| "toolchain_type(name = 'toolchain_type', visibility = ['//visibility:public'])"); |
| scratch.file("protobuf/WORKSPACE"); |
| scratch.overwriteFile( |
| "protobuf/BUILD", |
| TestConstants.LOAD_PROTO_LANG_TOOLCHAIN, |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "package(default_visibility=['//visibility:public'])", |
| "exports_files(['protoc'])", |
| "proto_library(", |
| " name = 'any_proto',", |
| " srcs = ['any.proto'],", |
| ")", |
| "proto_lang_toolchain(", |
| " name = 'cc_toolchain',", |
| " command_line = '--cpp_out=$(OUT)',", |
| " blacklisted_protos = [':any_proto'],", |
| " progress_message = 'Generating C++ proto_library %{label}',", |
| ")"); |
| scratch.appendFile( |
| "WORKSPACE", |
| "local_repository(", |
| " name = 'com_google_protobuf',", |
| " path = 'protobuf',", |
| ")"); |
| invalidatePackages(); // A dash of magic to re-evaluate the WORKSPACE file. |
| } |
| |
| @Test |
| public void protoToolchainResolution_enabled() throws Exception { |
| setBuildLanguageOptions("--incompatible_enable_proto_toolchain_resolution"); |
| getAnalysisMock() |
| .ccSupport() |
| .setupCcToolchainConfig( |
| mockToolsConfig, |
| CcToolchainConfig.builder() |
| .withFeatures( |
| CppRuleClasses.SUPPORTS_DYNAMIC_LINKER, |
| CppRuleClasses.SUPPORTS_INTERFACE_SHARED_LIBRARIES)); |
| scratch.file( |
| "x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(name = 'foo_cc_proto', deps = ['foo_proto'])", |
| "proto_library(name = 'foo_proto', srcs = ['foo.proto'])"); |
| assertThat(prettyArtifactNames(getFilesToBuild(getConfiguredTarget("//x:foo_cc_proto")))) |
| .containsExactly( |
| "x/foo.pb.h", |
| "x/foo.pb.cc", |
| "x/libfoo_proto.a", |
| "x/libfoo_proto.ifso", |
| "x/libfoo_proto.so"); |
| } |
| |
| @Test |
| public void basic() throws Exception { |
| getAnalysisMock() |
| .ccSupport() |
| .setupCcToolchainConfig( |
| mockToolsConfig, |
| CcToolchainConfig.builder() |
| .withFeatures( |
| CppRuleClasses.SUPPORTS_DYNAMIC_LINKER, |
| CppRuleClasses.SUPPORTS_INTERFACE_SHARED_LIBRARIES)); |
| scratch.file( |
| "x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(name = 'foo_cc_proto', deps = ['foo_proto'])", |
| "proto_library(name = 'foo_proto', srcs = ['foo.proto'])"); |
| assertThat(prettyArtifactNames(getFilesToBuild(getConfiguredTarget("//x:foo_cc_proto")))) |
| .containsExactly("x/foo.pb.h", "x/foo.pb.cc", "x/libfoo_proto.a", |
| "x/libfoo_proto.ifso", "x/libfoo_proto.so"); |
| } |
| |
| @Test |
| public void canBeUsedFromCcRules() throws Exception { |
| scratch.file( |
| "x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_library(name = 'foo', srcs = ['foo.cc'], deps = ['foo_cc_proto'])", |
| "cc_binary(name = 'bin', srcs = ['bin.cc'], deps = ['foo_cc_proto'])", |
| "cc_proto_library(name = 'foo_cc_proto', deps = ['foo_proto'])", |
| "proto_library(name = 'foo_proto', srcs = ['foo.proto'])"); |
| |
| update( |
| ImmutableList.of("//x:foo", "//x:bin"), |
| false /* keepGoing */, |
| 1 /* loadingPhaseThreads */, |
| true /* doAnalysis */, |
| new EventBus()); |
| } |
| |
| @Test |
| public void disallowMultipleDeps() throws Exception { |
| checkError( |
| "x", |
| "foo_cc_proto", |
| "'deps' attribute must contain exactly one label", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(name = 'foo_cc_proto', deps = ['foo_proto', 'bar_proto'])", |
| "proto_library(name = 'foo_proto', srcs = ['foo.proto'])", |
| "proto_library(name = 'bar_proto', srcs = ['bar.proto'])"); |
| |
| checkError( |
| "y", |
| "foo_cc_proto", |
| "'deps' attribute must contain exactly one label", |
| "cc_proto_library(name = 'foo_cc_proto', deps = [])"); |
| } |
| |
| @Test |
| public void aliasProtos() throws Exception { |
| scratch.file( |
| "x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(name = 'foo_cc_proto', deps = ['alias_proto'])", |
| "proto_library(name = 'alias_proto', deps = [':foo_proto'])", |
| "proto_library(name = 'foo_proto', srcs = ['foo.proto'])"); |
| |
| CcCompilationContext ccCompilationContext = |
| getConfiguredTarget("//x:foo_cc_proto").get(CcInfo.PROVIDER).getCcCompilationContext(); |
| assertThat(prettyArtifactNames(ccCompilationContext.getDeclaredIncludeSrcs())) |
| .containsExactly("x/foo.pb.h"); |
| } |
| |
| @Test |
| public void blacklistedProtos() throws Exception { |
| scratch.file( |
| "x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(name = 'any_cc_proto', deps = ['@com_google_protobuf//:any_proto'])"); |
| |
| CcCompilationContext ccCompilationContext = |
| getConfiguredTarget("//x:any_cc_proto").get(CcInfo.PROVIDER).getCcCompilationContext(); |
| assertThat(prettyArtifactNames(ccCompilationContext.getDeclaredIncludeSrcs())).isEmpty(); |
| } |
| |
| @Test |
| public void blacklistedProtosInTransitiveDeps() throws Exception { |
| scratch.file( |
| "x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(name = 'foo_cc_proto', deps = ['foo_proto'])", |
| "proto_library(", |
| " name = 'foo_proto',", |
| " srcs = ['foo.proto'],", |
| " deps = ['@com_google_protobuf//:any_proto'],", |
| ")"); |
| |
| CcCompilationContext ccCompilationContext = |
| getConfiguredTarget("//x:foo_cc_proto").get(CcInfo.PROVIDER).getCcCompilationContext(); |
| assertThat(prettyArtifactNames(ccCompilationContext.getDeclaredIncludeSrcs())) |
| .containsExactly("x/foo.pb.h"); |
| } |
| |
| @Test |
| public void ccCompilationContext() throws Exception { |
| scratch.file( |
| "x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(name = 'foo_cc_proto', deps = ['foo_proto'])", |
| "proto_library(name = 'foo_proto', srcs = ['foo.proto'], deps = [':bar_proto'])", |
| "proto_library(name = 'bar_proto', srcs = ['bar.proto'])"); |
| |
| CcCompilationContext ccCompilationContext = |
| getConfiguredTarget("//x:foo_cc_proto").get(CcInfo.PROVIDER).getCcCompilationContext(); |
| assertThat(prettyArtifactNames(ccCompilationContext.getDeclaredIncludeSrcs())) |
| .containsExactly("x/foo.pb.h", "x/bar.pb.h"); |
| } |
| |
| @Test |
| public void outputDirectoryForProtoCompileAction() throws Exception { |
| scratch.file( |
| "x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(name = 'foo_cc_proto', deps = [':bar_proto'])", |
| "proto_library(name = 'bar_proto', srcs = ['bar.proto'])"); |
| |
| Artifact hFile = |
| getFirstArtifactEndingWith( |
| getFilesToBuild(getConfiguredTarget("//x:foo_cc_proto")), "bar.pb.h"); |
| SpawnAction protoCompileAction = getGeneratingSpawnAction(hFile); |
| |
| assertThat(protoCompileAction.getArguments()) |
| .contains( |
| String.format( |
| "--cpp_out=%s", getTargetConfiguration().getGenfilesFragment(RepositoryName.MAIN))); |
| } |
| |
| @Test |
| public void outputDirectoryForProtoCompileAction_externalRepos() throws Exception { |
| setBuildLanguageOptions("--experimental_builtins_injection_override=+cc_proto_library"); |
| scratch.file( |
| "x/BUILD", "cc_proto_library(name = 'foo_cc_proto', deps = ['@bla//foo:bar_proto'])"); |
| |
| scratch.file("/bla/WORKSPACE"); |
| // Create the rule '@bla//foo:bar_proto'. |
| scratch.file( |
| "/bla/foo/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "package(default_visibility=['//visibility:public'])", |
| "proto_library(name = 'bar_proto', srcs = ['bar.proto'])"); |
| String existingWorkspace = |
| new String(FileSystemUtils.readContentAsLatin1(rootDirectory.getRelative("WORKSPACE"))); |
| scratch.overwriteFile( |
| "WORKSPACE", "local_repository(name = 'bla', path = '/bla/')", existingWorkspace); |
| invalidatePackages(); // A dash of magic to re-evaluate the WORKSPACE file. |
| |
| ConfiguredTarget target = getConfiguredTarget("//x:foo_cc_proto"); |
| Artifact hFile = getFirstArtifactEndingWith(getFilesToBuild(target), "bar.pb.h"); |
| SpawnAction protoCompileAction = getGeneratingSpawnAction(hFile); |
| |
| assertThat(protoCompileAction.getArguments()) |
| .contains( |
| String.format( |
| "--cpp_out=%s/external/bla", |
| getTargetConfiguration().getGenfilesFragment(RepositoryName.MAIN))); |
| |
| Artifact headerFile = |
| getDerivedArtifact( |
| PathFragment.create("external/bla/foo/bar.pb.h"), |
| targetConfig.getGenfilesDirectory(RepositoryName.create("bla")), |
| getOwnerForAspect( |
| getConfiguredTarget("@bla//foo:bar_proto"), |
| starlarkCcProtoAspect, |
| AspectParameters.EMPTY)); |
| CcCompilationContext ccCompilationContext = |
| target.get(CcInfo.PROVIDER).getCcCompilationContext(); |
| assertThat(ccCompilationContext.getDeclaredIncludeSrcs().toList()).containsExactly(headerFile); |
| } |
| |
| @Test |
| public void commandLineControlsOutputFileSuffixes() throws Exception { |
| getAnalysisMock() |
| .ccSupport() |
| .setupCcToolchainConfig( |
| mockToolsConfig, |
| CcToolchainConfig.builder() |
| .withFeatures( |
| CppRuleClasses.SUPPORTS_DYNAMIC_LINKER, |
| CppRuleClasses.SUPPORTS_INTERFACE_SHARED_LIBRARIES)); |
| useConfiguration( |
| "--cc_proto_library_header_suffixes=.pb.h,.proto.h", |
| "--cc_proto_library_source_suffixes=.pb.cc,.pb.cc.meta"); |
| scratch.file( |
| "x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(name = 'foo_cc_proto', deps = ['foo_proto'])", |
| "proto_library(name = 'foo_proto', srcs = ['foo.proto'])"); |
| |
| assertThat(prettyArtifactNames(getFilesToBuild(getConfiguredTarget("//x:foo_cc_proto")))) |
| .containsExactly("x/foo.pb.cc", "x/foo.pb.h", "x/foo.pb.cc.meta", "x/foo.proto.h", |
| "x/libfoo_proto.a", "x/libfoo_proto.ifso", "x/libfoo_proto.so"); |
| } |
| |
| // TODO(carmi): test blacklisted protos. I don't currently understand what's the wanted behavior. |
| |
| @Test |
| public void generatedSourcesNotCoverageInstrumented() throws Exception { |
| useConfiguration("--collect_code_coverage", "--instrumentation_filter=."); |
| scratch.file( |
| "x/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(name = 'foo_cc_proto', deps = ['foo_proto'])", |
| "proto_library(name = 'foo_proto', srcs = ['foo.proto'])"); |
| ConfiguredTarget target = getConfiguredTarget("//x:foo_cc_proto"); |
| List<CppCompileAction> compilationSteps = |
| actionsTestUtil() |
| .findTransitivePrerequisitesOf( |
| getFirstArtifactEndingWith(getFilesToBuild(target), ".a"), CppCompileAction.class); |
| List<String> options = compilationSteps.get(0).getCompilerOptions(); |
| assertThat(options).doesNotContain("-fprofile-arcs"); |
| assertThat(options).doesNotContain("-ftest-coverage"); |
| } |
| |
| @Test |
| public void importPrefixWorksWithRepositories() throws Exception { |
| FileSystemUtils.appendIsoLatin1( |
| scratch.resolve("WORKSPACE"), "local_repository(name = 'yolo_repo', path = '/yolo_repo')"); |
| invalidatePackages(); |
| |
| scratch.file("/yolo_repo/WORKSPACE"); |
| scratch.file("/yolo_repo/yolo_pkg/yolo.proto"); |
| scratch.file( |
| "/yolo_repo/yolo_pkg/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "proto_library(", |
| " name = 'yolo_proto',", |
| " srcs = ['yolo.proto'],", |
| " import_prefix = 'bazel.build/yolo',", |
| ")", |
| "cc_proto_library(", |
| " name = 'yolo_cc_proto',", |
| " deps = [':yolo_proto'],", |
| ")"); |
| assertThat(getTarget("@yolo_repo//yolo_pkg:yolo_cc_proto")).isNotNull(); |
| assertThat(getProtoHeaderExecPath()) |
| .endsWith("_virtual_includes/yolo_proto/bazel.build/yolo/yolo_pkg/yolo.pb.h"); |
| } |
| |
| @Test |
| public void stripImportPrefixWorksWithRepositories() throws Exception { |
| FileSystemUtils.appendIsoLatin1( |
| scratch.resolve("WORKSPACE"), "local_repository(name = 'yolo_repo', path = '/yolo_repo')"); |
| invalidatePackages(); |
| |
| scratch.file("/yolo_repo/WORKSPACE"); |
| scratch.file("/yolo_repo/yolo_pkg/yolo.proto"); |
| scratch.file( |
| "/yolo_repo/yolo_pkg/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "proto_library(", |
| " name = 'yolo_proto',", |
| " srcs = ['yolo.proto'],", |
| " strip_import_prefix = '/yolo_pkg',", |
| ")", |
| "cc_proto_library(", |
| " name = 'yolo_cc_proto',", |
| " deps = [':yolo_proto'],", |
| ")"); |
| assertThat(getTarget("@yolo_repo//yolo_pkg:yolo_cc_proto")).isNotNull(); |
| assertThat(getProtoHeaderExecPath()).endsWith("_virtual_includes/yolo_proto/yolo.pb.h"); |
| } |
| |
| @Test |
| public void importPrefixAndStripImportPrefixWorksWithRepositories() throws Exception { |
| FileSystemUtils.appendIsoLatin1( |
| scratch.resolve("WORKSPACE"), "local_repository(name = 'yolo_repo', path = '/yolo_repo')"); |
| invalidatePackages(); |
| |
| scratch.file("/yolo_repo/WORKSPACE"); |
| scratch.file("/yolo_repo/yolo_pkg/yolo.proto"); |
| scratch.file( |
| "/yolo_repo/yolo_pkg/BUILD", |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "proto_library(", |
| " name = 'yolo_proto',", |
| " srcs = ['yolo.proto'],", |
| " import_prefix = 'bazel.build/yolo',", |
| " strip_import_prefix = '/yolo_pkg'", |
| ")", |
| "cc_proto_library(", |
| " name = 'yolo_cc_proto',", |
| " deps = [':yolo_proto'],", |
| ")"); |
| getTarget("@yolo_repo//yolo_pkg:yolo_cc_proto"); |
| |
| assertThat(getTarget("@yolo_repo//yolo_pkg:yolo_cc_proto")).isNotNull(); |
| assertThat(getProtoHeaderExecPath()) |
| .endsWith("_virtual_includes/yolo_proto/bazel.build/yolo/yolo.pb.h"); |
| } |
| |
| private String getProtoHeaderExecPath() throws LabelSyntaxException { |
| ConfiguredTarget configuredTarget = getConfiguredTarget("@yolo_repo//yolo_pkg:yolo_cc_proto"); |
| CcInfo ccInfo = configuredTarget.get(CcInfo.PROVIDER); |
| ImmutableList<Artifact> headers = |
| ccInfo.getCcCompilationContext().getDeclaredIncludeSrcs().toList(); |
| return Iterables.getOnlyElement(headers).getExecPathString(); |
| } |
| |
| @Test |
| public void testCcProtoLibraryLoadedThroughMacro() throws Exception { |
| if (!analysisMock.isThisBazel()) { |
| return; |
| } |
| setupTestCcProtoLibraryLoadedThroughMacro(/* loadMacro= */ true); |
| assertThat(getConfiguredTarget("//a:a")).isNotNull(); |
| assertNoEvents(); |
| } |
| |
| private void setupTestCcProtoLibraryLoadedThroughMacro(boolean loadMacro) throws Exception { |
| scratch.file( |
| "a/BUILD", |
| getAnalysisMock().ccSupport().getMacroLoadStatement(loadMacro, "cc_proto_library"), |
| TestConstants.LOAD_PROTO_LIBRARY, |
| "cc_proto_library(", |
| " name='a',", |
| " deps=[':a_p'],", |
| ")", |
| "proto_library(", |
| " name='a_p',", |
| " srcs = ['a.proto'],", |
| ")"); |
| } |
| } |
