AndroidInstrumentationApk.java example

Explorer
buck-master
/*
 * Copyright 2012-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.android;

import com.facebook.buck.jvm.java.JavaLibrary;
import com.facebook.buck.rules.BuildRuleParams;
import com.facebook.buck.rules.SourcePath;
import com.facebook.buck.rules.SourcePathRuleFinder;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.util.concurrent.ListeningExecutorService;
import java.util.EnumSet;
import java.util.Optional;

/**
 * Apk that functions as a test package in Android.
 *
 * <p>Android's <a href="http://developer.android.com/tools/testing/testing_android.html">Testing
 * Fundamentals</a> documentation includes a diagram that shows the relationship between an
 * "application package" and a "test package" when running a test. This corresponds to a test
 * package. Note that a test package has an interesting quirk where it is <em>compiled against</em>
 * an application package, but <em>must not include</em> the resources or Java classes of the
 * application package. Therefore, this class takes responsibility for making sure the appropriate
 * bits are excluded. Failing to do so will generate mysterious runtime errors when running the
 * test.
 */
public class AndroidInstrumentationApk extends AndroidBinary {

  private AndroidBinary apkUnderTest;

  AndroidInstrumentationApk(
      BuildRuleParams buildRuleParams,
      SourcePathRuleFinder ruleFinder,
      Optional<SourcePath> proGuardJarOverride,
      String proGuardMaxHeapSize,
      Optional<String> proguardAgentPath,
      AndroidBinary apkUnderTest,
      ImmutableSortedSet<JavaLibrary> rulesToExcludeFromDex,
      AndroidGraphEnhancementResult enhancementResult,
      ListeningExecutorService dxExecutorService) {
    super(
        buildRuleParams,
        ruleFinder,
        proGuardJarOverride,
        proGuardMaxHeapSize,
        apkUnderTest.getProguardJvmArgs(),
        proguardAgentPath,
        apkUnderTest.getKeystore(),
        PackageType.INSTRUMENTED,
        // Do not split the test apk even if the tested apk is split
        DexSplitMode.NO_SPLIT,
        apkUnderTest.getBuildTargetsToExcludeFromDex(),
        apkUnderTest.getSdkProguardConfig(),
        apkUnderTest.getOptimizationPasses(),
        apkUnderTest.getProguardConfig(),
        apkUnderTest.getSkipProguard(),
        Optional.empty(), // RedexOptions
        apkUnderTest.getResourceCompressionMode(),
        apkUnderTest.getCpuFilters(),
        apkUnderTest.getResourceFilter(),
        EnumSet.noneOf(ExopackageMode.class),
        apkUnderTest.getMacroExpander(),
        // preprocessJavaClassBash is not supported in instrumentation
        Optional.empty(),
        rulesToExcludeFromDex,
        enhancementResult,
        // reordering is not supported in instrumentation. TODO(dtarjan): add support
        false,
        Optional.empty(),
        Optional.empty(),
        Optional.empty(),
        dxExecutorService,
        false,
        false,
        apkUnderTest.getManifestEntries(),
        apkUnderTest.getJavaRuntimeLauncher(),
        Optional.empty());
    this.apkUnderTest = apkUnderTest;
  }

  public AndroidBinary getApkUnderTest() {
    return apkUnderTest;
  }
}