test/com/facebook/buck/apple/AppleBuildRulesTest.java

/*
 * 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.apple;

import static com.facebook.buck.apple.ProjectGeneratorTestUtils.createDescriptionArgWithDefaults;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

import com.facebook.buck.cxx.CxxDescriptionEnhancer;
import com.facebook.buck.model.BuildTarget;
import com.facebook.buck.rules.BuildRule;
import com.facebook.buck.rules.BuildRuleParams;
import com.facebook.buck.rules.BuildRuleResolver;
import com.facebook.buck.rules.BuildRuleType;
import com.facebook.buck.rules.FakeBuildRuleParamsBuilder;
import com.facebook.buck.rules.Label;
import com.facebook.buck.rules.TargetNode;
import com.facebook.buck.rules.coercer.Either;
import com.facebook.buck.testutil.TargetGraphFactory;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.Iterables;

import org.junit.Test;

public class AppleBuildRulesTest {

  @Test
  public void testAppleLibraryIsXcodeTargetBuildRuleType() throws Exception {
    assertTrue(AppleBuildRules.isXcodeTargetBuildRuleType(AppleLibraryDescription.TYPE));
  }

  @Test
  public void testIosResourceIsNotXcodeTargetBuildRuleType() throws Exception {
    assertFalse(AppleBuildRules.isXcodeTargetBuildRuleType(AppleResourceDescription.TYPE));
  }

  @Test
  public void testAppleTestIsXcodeTargetTestBuildRuleType() throws Exception {
    BuildRuleResolver resolver = new BuildRuleResolver();

    AppleTestBuilder appleTestBuilder = new AppleTestBuilder(
        BuildTarget.builder("//foo", "xctest").build())
        .setExtension(Either.<AppleBundleExtension, String>ofLeft(AppleBundleExtension.XCTEST))
        .setContacts(Optional.of(ImmutableSortedSet.<String>of()))
        .setLabels(Optional.of(ImmutableSortedSet.<Label>of()))
        .setDeps(Optional.of(ImmutableSortedSet.<BuildTarget>of()));
    BuildRule testRule = appleTestBuilder.build(resolver);

    assertTrue(AppleBuildRules.isXcodeTargetTestBuildRule(testRule));
  }

  @Test
  public void testAppleLibraryIsNotXcodeTargetTestBuildRuleType() throws Exception {
    BuildRuleParams params =
        new FakeBuildRuleParamsBuilder(BuildTarget.builder("//foo", "lib").build())
            .setType(AppleLibraryDescription.TYPE)
            .build();
    AppleNativeTargetDescriptionArg arg =
        createDescriptionArgWithDefaults(FakeAppleRuleDescriptions.LIBRARY_DESCRIPTION);
    BuildRule libraryRule =
        FakeAppleRuleDescriptions.LIBRARY_DESCRIPTION.createBuildRule(
            params, new BuildRuleResolver(), arg);

    assertFalse(AppleBuildRules.isXcodeTargetTestBuildRule(libraryRule));
  }

  @Test
  public void testXctestIsTestBundleExtension() throws Exception {
    assertTrue(AppleBuildRules.isXcodeTargetTestBundleExtension(AppleBundleExtension.XCTEST));
  }

  @Test
  public void testOctestIsTestBundleExtension() throws Exception {
    assertTrue(AppleBuildRules.isXcodeTargetTestBundleExtension(AppleBundleExtension.OCTEST));
  }

  @Test
  public void testRecursiveTargetsIncludesBundleBinaryFromOutsideBundle() throws Exception {
    BuildTarget libraryTarget = BuildTarget.builder("//foo", "lib").build();
    TargetNode<?> libraryNode = AppleLibraryBuilder
        .createBuilder(libraryTarget)
        .build();

    BuildTarget bundleTarget = BuildTarget.builder("//foo", "bundle").build();
    TargetNode<?> bundleNode = AppleBundleBuilder
        .createBuilder(bundleTarget)
        .setExtension(Either.<AppleBundleExtension, String>ofLeft(AppleBundleExtension.XCTEST))
        .setBinary(libraryTarget)
        .build();

    BuildTarget rootTarget = BuildTarget.builder("//foo", "root").build();
    TargetNode<?> rootNode = AppleLibraryBuilder
        .createBuilder(rootTarget)
        .setDeps(Optional.of(ImmutableSortedSet.of(libraryTarget, bundleTarget)))
        .build();

    Iterable<TargetNode<?>> rules = AppleBuildRules.getRecursiveTargetNodeDependenciesOfTypes(
        TargetGraphFactory.newInstance(ImmutableSet.of(libraryNode, bundleNode, rootNode)),
        AppleBuildRules.RecursiveDependenciesMode.BUILDING,
        rootNode,
        Optional.<ImmutableSet<BuildRuleType>>absent());

    assertTrue(Iterables.elementsEqual(ImmutableSortedSet.of(libraryNode, bundleNode), rules));
  }

  @Test
  public void exportedDepsOfDylibsAreCollectedForLinking() throws Exception {
    BuildTarget fooLibTarget =
        BuildTarget
            .builder("//foo", "lib")
            .addFlavors(CxxDescriptionEnhancer.SHARED_FLAVOR)
            .build();
    TargetNode<?> fooLibNode = AppleLibraryBuilder
        .createBuilder(fooLibTarget)
        .build();

    BuildTarget fooFrameworkTarget = BuildTarget.builder("//foo", "framework").build();
    TargetNode<?> fooFrameworkNode = AppleBundleBuilder
        .createBuilder(fooFrameworkTarget)
        .setExtension(Either.<AppleBundleExtension, String>ofLeft(AppleBundleExtension.FRAMEWORK))
        .setBinary(fooLibTarget)
        .build();

    BuildTarget barLibTarget =
        BuildTarget
            .builder("//bar", "lib")
            .addFlavors(CxxDescriptionEnhancer.SHARED_FLAVOR)
            .build();
    TargetNode<?> barLibNode = AppleLibraryBuilder
        .createBuilder(barLibTarget)
        .setDeps(Optional.of(ImmutableSortedSet.of(fooFrameworkTarget)))
        .setExportedDeps(Optional.of(ImmutableSortedSet.of(fooFrameworkTarget)))
        .build();

    BuildTarget barFrameworkTarget = BuildTarget.builder("//bar", "framework").build();
    TargetNode<?> barFrameworkNode = AppleBundleBuilder
        .createBuilder(barFrameworkTarget)
        .setExtension(Either.<AppleBundleExtension, String>ofLeft(AppleBundleExtension.FRAMEWORK))
        .setBinary(barLibTarget)
        .build();

    BuildTarget rootTarget = BuildTarget.builder("//foo", "root").build();
    TargetNode<?> rootNode = AppleLibraryBuilder
        .createBuilder(rootTarget)
        .setDeps(Optional.of(ImmutableSortedSet.of(barFrameworkTarget)))
        .build();

    Iterable<TargetNode<?>> rules = AppleBuildRules.getRecursiveTargetNodeDependenciesOfTypes(
        TargetGraphFactory.newInstance(
            ImmutableSet.of(
                rootNode,
                fooLibNode,
                fooFrameworkNode,
                barLibNode,
                barFrameworkNode)),
        AppleBuildRules.RecursiveDependenciesMode.LINKING,
        rootNode,
        Optional.<ImmutableSet<BuildRuleType>>absent());

    assertEquals(
        ImmutableSortedSet.of(
            barFrameworkNode,
            fooFrameworkNode),
        ImmutableSortedSet.copyOf(rules));
  }

  @Test
  public void exportedDepsAreCollectedForCopying() throws Exception {
    BuildTarget fooLibTarget =
        BuildTarget
            .builder("//foo", "lib")
            .addFlavors(CxxDescriptionEnhancer.SHARED_FLAVOR)
            .build();
    TargetNode<?> fooLibNode = AppleLibraryBuilder
        .createBuilder(fooLibTarget)
        .build();

    BuildTarget fooFrameworkTarget = BuildTarget.builder("//foo", "framework").build();
    TargetNode<?> fooFrameworkNode = AppleBundleBuilder
        .createBuilder(fooFrameworkTarget)
        .setExtension(Either.<AppleBundleExtension, String>ofLeft(AppleBundleExtension.FRAMEWORK))
        .setBinary(fooLibTarget)
        .build();

    BuildTarget barLibTarget =
        BuildTarget
            .builder("//bar", "lib")
            .addFlavors(CxxDescriptionEnhancer.SHARED_FLAVOR)
            .build();
    TargetNode<?> barLibNode = AppleLibraryBuilder
        .createBuilder(barLibTarget)
        .setDeps(Optional.of(ImmutableSortedSet.of(fooFrameworkTarget)))
        .setExportedDeps(Optional.of(ImmutableSortedSet.of(fooFrameworkTarget)))
        .build();

    BuildTarget barFrameworkTarget = BuildTarget.builder("//bar", "framework").build();
    TargetNode<?> barFrameworkNode = AppleBundleBuilder
        .createBuilder(barFrameworkTarget)
        .setExtension(Either.<AppleBundleExtension, String>ofLeft(AppleBundleExtension.FRAMEWORK))
        .setBinary(barLibTarget)
        .build();

    BuildTarget bazLibTarget =
        BuildTarget
            .builder("//baz", "lib")
            .addFlavors(CxxDescriptionEnhancer.SHARED_FLAVOR)
            .build();
    TargetNode<?> bazLibNode = AppleLibraryBuilder
        .createBuilder(bazLibTarget)
        .setDeps(Optional.of(ImmutableSortedSet.of(barFrameworkTarget)))
        .build();

    BuildTarget bazFrameworkTarget = BuildTarget.builder("//baz", "framework").build();
    TargetNode<?> bazFrameworkNode = AppleBundleBuilder
        .createBuilder(bazFrameworkTarget)
        .setExtension(Either.<AppleBundleExtension, String>ofLeft(AppleBundleExtension.FRAMEWORK))
        .setBinary(bazLibTarget)
        .build();

    ImmutableSet<TargetNode<?>> targetNodes =
        ImmutableSet.<TargetNode<?>>builder()
          .add(
            fooLibNode,
            fooFrameworkNode,
            barLibNode,
            barFrameworkNode,
            bazLibNode,
            bazFrameworkNode)
          .build();

    Iterable<TargetNode<?>> rules = AppleBuildRules.getRecursiveTargetNodeDependenciesOfTypes(
        TargetGraphFactory.newInstance(targetNodes),
        AppleBuildRules.RecursiveDependenciesMode.COPYING,
        bazFrameworkNode,
        Optional.<ImmutableSet<BuildRuleType>>absent());

    assertEquals(
        ImmutableSortedSet.of(
            barFrameworkNode,
            fooFrameworkNode),
        ImmutableSortedSet.copyOf(rules));
  }
}