| /* |
| * Copyright 2014-present Facebook, Inc. |
| * |
| * 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.facebook.buck.thrift; |
| |
| import static org.junit.Assert.assertEquals; |
| import static org.junit.Assert.assertNotEquals; |
| |
| import com.facebook.buck.model.BuildTarget; |
| import com.facebook.buck.model.BuildTargetFactory; |
| import com.facebook.buck.rules.AbstractBuildRule; |
| import com.facebook.buck.rules.BuildRuleParams; |
| import com.facebook.buck.rules.BuildRuleParamsFactory; |
| import com.facebook.buck.rules.BuildRuleResolver; |
| import com.facebook.buck.rules.FakeBuildContext; |
| import com.facebook.buck.rules.FakeBuildableContext; |
| import com.facebook.buck.rules.FakeRuleKeyBuilderFactory; |
| import com.facebook.buck.rules.RuleKey; |
| import com.facebook.buck.rules.RuleKeyBuilderFactory; |
| import com.facebook.buck.rules.SourcePath; |
| import com.facebook.buck.rules.SourcePathResolver; |
| import com.facebook.buck.rules.TestSourcePath; |
| import com.facebook.buck.step.Step; |
| import com.facebook.buck.step.fs.MakeCleanDirectoryStep; |
| import com.facebook.buck.testutil.FakeFileHashCache; |
| import com.google.common.base.Strings; |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.collect.ImmutableSet; |
| |
| import org.junit.Test; |
| |
| import java.nio.file.Path; |
| import java.nio.file.Paths; |
| |
| public class ThriftCompilerTest { |
| |
| private static final SourcePath DEFAULT_COMPILER = new TestSourcePath("thrift"); |
| private static final ImmutableList<String> DEFAULT_FLAGS = ImmutableList.of("--allow-64-bits"); |
| private static final Path DEFAULT_OUTPUT_DIR = Paths.get("output-dir"); |
| private static final SourcePath DEFAULT_INPUT = new TestSourcePath("test.thrift"); |
| private static final String DEFAULT_LANGUAGE = "cpp"; |
| private static final ImmutableSet<String> DEFAULT_OPTIONS = ImmutableSet.of("templates"); |
| private static final ImmutableList<Path> DEFAULT_INCLUDE_ROOTS = |
| ImmutableList.of(Paths.get("blah-dir")); |
| private static final ImmutableMap<Path, SourcePath> DEFAULT_INCLUDES = |
| ImmutableMap.<Path, SourcePath>of( |
| Paths.get("something.thrift"), |
| new TestSourcePath("blah/something.thrift")); |
| |
| private RuleKey.Builder.RuleKeyPair generateRuleKey( |
| RuleKeyBuilderFactory factory, |
| SourcePathResolver resolver, |
| AbstractBuildRule rule) { |
| |
| RuleKey.Builder builder = factory.newInstance(rule, resolver); |
| rule.appendToRuleKey(builder); |
| return builder.build(); |
| } |
| |
| @Test |
| public void testThatInputChangesCauseRuleKeyChanges() { |
| SourcePathResolver resolver = new SourcePathResolver(new BuildRuleResolver()); |
| BuildTarget target = BuildTargetFactory.newInstance("//foo:bar"); |
| BuildRuleParams params = BuildRuleParamsFactory.createTrivialBuildRuleParams(target); |
| RuleKeyBuilderFactory ruleKeyBuilderFactory = |
| new FakeRuleKeyBuilderFactory( |
| FakeFileHashCache.createFromStrings( |
| ImmutableMap.of( |
| "thrift", Strings.repeat("a", 40), |
| "test.thrift", Strings.repeat("b", 40), |
| "different", Strings.repeat("c", 40), |
| "something.thrift", Strings.repeat("d", 40), |
| "blah/something.thrift", Strings.repeat("e", 40)))); |
| |
| // Generate a rule key for the defaults. |
| RuleKey.Builder.RuleKeyPair defaultRuleKey = generateRuleKey( |
| ruleKeyBuilderFactory, |
| resolver, |
| new ThriftCompiler( |
| params, |
| resolver, |
| DEFAULT_COMPILER, |
| DEFAULT_FLAGS, |
| DEFAULT_OUTPUT_DIR, |
| DEFAULT_INPUT, |
| DEFAULT_LANGUAGE, |
| DEFAULT_OPTIONS, |
| DEFAULT_INCLUDE_ROOTS, |
| DEFAULT_INCLUDES)); |
| |
| // Verify that changing the compiler causes a rulekey change. |
| RuleKey.Builder.RuleKeyPair compilerChange = generateRuleKey( |
| ruleKeyBuilderFactory, |
| resolver, |
| new ThriftCompiler( |
| params, |
| resolver, |
| new TestSourcePath("different"), |
| DEFAULT_FLAGS, |
| DEFAULT_OUTPUT_DIR, |
| DEFAULT_INPUT, |
| DEFAULT_LANGUAGE, |
| DEFAULT_OPTIONS, |
| DEFAULT_INCLUDE_ROOTS, |
| DEFAULT_INCLUDES)); |
| assertNotEquals(defaultRuleKey.getTotalRuleKey(), compilerChange.getTotalRuleKey()); |
| |
| // Verify that changing the flags causes a rulekey change. |
| RuleKey.Builder.RuleKeyPair flagsChange = generateRuleKey( |
| ruleKeyBuilderFactory, |
| resolver, |
| new ThriftCompiler( |
| params, |
| resolver, |
| DEFAULT_COMPILER, |
| ImmutableList.of("--different"), |
| DEFAULT_OUTPUT_DIR, |
| DEFAULT_INPUT, |
| DEFAULT_LANGUAGE, |
| DEFAULT_OPTIONS, |
| DEFAULT_INCLUDE_ROOTS, |
| DEFAULT_INCLUDES)); |
| assertNotEquals(defaultRuleKey.getTotalRuleKey(), flagsChange.getTotalRuleKey()); |
| |
| // Verify that changing the flags causes a rulekey change. |
| RuleKey.Builder.RuleKeyPair outputDirChange = generateRuleKey( |
| ruleKeyBuilderFactory, |
| resolver, |
| new ThriftCompiler( |
| params, |
| resolver, |
| DEFAULT_COMPILER, |
| DEFAULT_FLAGS, |
| Paths.get("different-dir"), |
| DEFAULT_INPUT, |
| DEFAULT_LANGUAGE, |
| DEFAULT_OPTIONS, |
| DEFAULT_INCLUDE_ROOTS, |
| DEFAULT_INCLUDES)); |
| assertNotEquals(defaultRuleKey.getTotalRuleKey(), outputDirChange.getTotalRuleKey()); |
| |
| // Verify that changing the input causes a rulekey change. |
| RuleKey.Builder.RuleKeyPair inputChange = generateRuleKey( |
| ruleKeyBuilderFactory, |
| resolver, |
| new ThriftCompiler( |
| params, |
| resolver, |
| DEFAULT_COMPILER, |
| DEFAULT_FLAGS, |
| DEFAULT_OUTPUT_DIR, |
| new TestSourcePath("different"), |
| DEFAULT_LANGUAGE, |
| DEFAULT_OPTIONS, |
| DEFAULT_INCLUDE_ROOTS, |
| DEFAULT_INCLUDES)); |
| assertNotEquals(defaultRuleKey.getTotalRuleKey(), inputChange.getTotalRuleKey()); |
| |
| // Verify that changing the input causes a rulekey change. |
| RuleKey.Builder.RuleKeyPair languageChange = generateRuleKey( |
| ruleKeyBuilderFactory, |
| resolver, |
| new ThriftCompiler( |
| params, |
| resolver, |
| DEFAULT_COMPILER, |
| DEFAULT_FLAGS, |
| DEFAULT_OUTPUT_DIR, |
| DEFAULT_INPUT, |
| "different", |
| DEFAULT_OPTIONS, |
| DEFAULT_INCLUDE_ROOTS, |
| DEFAULT_INCLUDES)); |
| assertNotEquals(defaultRuleKey.getTotalRuleKey(), languageChange.getTotalRuleKey()); |
| |
| // Verify that changing the input causes a rulekey change. |
| RuleKey.Builder.RuleKeyPair optionsChange = generateRuleKey( |
| ruleKeyBuilderFactory, |
| resolver, |
| new ThriftCompiler( |
| params, |
| resolver, |
| DEFAULT_COMPILER, |
| DEFAULT_FLAGS, |
| DEFAULT_OUTPUT_DIR, |
| DEFAULT_INPUT, |
| DEFAULT_LANGUAGE, |
| ImmutableSet.of("different"), |
| DEFAULT_INCLUDE_ROOTS, |
| DEFAULT_INCLUDES)); |
| assertNotEquals(defaultRuleKey.getTotalRuleKey(), optionsChange.getTotalRuleKey()); |
| |
| // Verify that changing the includes does *not* cause a rulekey change, since we use a |
| // different mechanism to track header changes. |
| RuleKey.Builder.RuleKeyPair includeRootsChange = generateRuleKey( |
| ruleKeyBuilderFactory, |
| resolver, |
| new ThriftCompiler( |
| params, |
| resolver, |
| DEFAULT_COMPILER, |
| DEFAULT_FLAGS, |
| DEFAULT_OUTPUT_DIR, |
| DEFAULT_INPUT, |
| DEFAULT_LANGUAGE, |
| DEFAULT_OPTIONS, |
| ImmutableList.of(Paths.get("different")), |
| DEFAULT_INCLUDES)); |
| assertEquals(defaultRuleKey.getTotalRuleKey(), includeRootsChange.getTotalRuleKey()); |
| |
| // Verify that changing the name of the include causes a rulekey change. |
| RuleKey.Builder.RuleKeyPair includesKeyChange = generateRuleKey( |
| ruleKeyBuilderFactory, |
| resolver, |
| new ThriftCompiler( |
| params, |
| resolver, |
| DEFAULT_COMPILER, |
| DEFAULT_FLAGS, |
| DEFAULT_OUTPUT_DIR, |
| DEFAULT_INPUT, |
| DEFAULT_LANGUAGE, |
| DEFAULT_OPTIONS, |
| DEFAULT_INCLUDE_ROOTS, |
| ImmutableMap.<Path, SourcePath>of( |
| DEFAULT_INCLUDES.entrySet().iterator().next().getKey(), |
| new TestSourcePath("different")))); |
| assertNotEquals(defaultRuleKey.getTotalRuleKey(), includesKeyChange.getTotalRuleKey()); |
| |
| // Verify that changing the contents of an include causes a rulekey change. |
| RuleKey.Builder.RuleKeyPair includesValueChange = generateRuleKey( |
| ruleKeyBuilderFactory, |
| resolver, |
| new ThriftCompiler( |
| params, |
| resolver, |
| DEFAULT_COMPILER, |
| DEFAULT_FLAGS, |
| DEFAULT_OUTPUT_DIR, |
| DEFAULT_INPUT, |
| DEFAULT_LANGUAGE, |
| DEFAULT_OPTIONS, |
| DEFAULT_INCLUDE_ROOTS, |
| ImmutableMap.of( |
| Paths.get("different"), |
| DEFAULT_INCLUDES.entrySet().iterator().next().getValue()))); |
| assertNotEquals(defaultRuleKey.getTotalRuleKey(), includesValueChange.getTotalRuleKey()); |
| } |
| |
| @Test |
| public void thatCorrectBuildStepsAreUsed() { |
| SourcePathResolver pathResolver = new SourcePathResolver(new BuildRuleResolver()); |
| BuildTarget target = BuildTargetFactory.newInstance("//foo:bar"); |
| BuildRuleParams params = BuildRuleParamsFactory.createTrivialBuildRuleParams(target); |
| |
| ThriftCompiler thriftCompiler = new ThriftCompiler( |
| params, |
| pathResolver, |
| DEFAULT_COMPILER, |
| DEFAULT_FLAGS, |
| DEFAULT_OUTPUT_DIR, |
| DEFAULT_INPUT, |
| DEFAULT_LANGUAGE, |
| DEFAULT_OPTIONS, |
| DEFAULT_INCLUDE_ROOTS, |
| DEFAULT_INCLUDES); |
| |
| ImmutableList<Step> expected = ImmutableList.of( |
| new MakeCleanDirectoryStep(DEFAULT_OUTPUT_DIR), |
| new ThriftCompilerStep( |
| pathResolver.getPath(DEFAULT_COMPILER), |
| DEFAULT_FLAGS, |
| DEFAULT_OUTPUT_DIR, |
| pathResolver.getPath(DEFAULT_INPUT), |
| DEFAULT_LANGUAGE, |
| DEFAULT_OPTIONS, |
| DEFAULT_INCLUDE_ROOTS)); |
| ImmutableList<Step> actual = thriftCompiler.getBuildSteps( |
| FakeBuildContext.NOOP_CONTEXT, |
| new FakeBuildableContext()); |
| assertEquals(expected, actual); |
| } |
| |
| } |
