apple_test()

This is liable to change in the future.

An apple_test() rule contains Objective-C/C++ code which can be built and used to test code contained in other rules. The tests can be executed by running buck test.

Arguments

• name (required) #

  The short name for this build target.

• info_plist (required) #

  A path to an Info.plist file that will be placed in the bundle. The specified file will be processed by substituting variable names with their values (see info_plist_substitutions for more information).

• info_plist_substitutions (defaults to {}) #

  A dictionary that assigns variable names to their values. It is used for variable substitution when processing the file specified in info_plist. For example if this argument is set to {'VAR': 'MyValue'}, then each occurrence of $(VAR) or ${VAR} in the file will be replaced by MyValue.

• test_host_app (defaults to None) #

  A build target identifying an apple_bundle() rule that builds an application bundle. Output of the specified rule will be used as a test host of this test. This implies run_test_separately. Since symbols that are defined in the test host application and its dependencies will not be linked into the test binary, to make those symbols accessible to the test target they need to be specified as a dependency of this target and ['-undefined', 'dynamic_lookup'] needs to be added to this target's linker_flags (this will suppress undefined reference errors during compilation, but if the symbols do not exist, it might result in runtime crashes).

• srcs (defaults to []) #

  The set of C, C++, Objective-C, Objective-C++, or assembly source files to be preprocessed, compiled, and assembled by this rule. We determine which stages to run on each input source based on its file extension. See the GCC documentation for more detail on how file extensions are interpreted. Each element can be either a string specifying a source file (e.g. 'foo/bar.m') or a tuple of a string specifying a source file and a list of compilation flags (e.g. ('foo/bar.m', ['-Wall', '-Werror'])). In the latter case the specified flags will be used in addition to the rule's other flags when preprocessing and compiling that file (if applicable).

• platform_srcs (defaults to []) #

  Platform specific source files. These should be specified as a list of pairs where the first element is an un-anchored regex (in java.util.regex.Pattern syntax) against which the platform name is matched, and the second element is either a list of source files or a list of tuples of source files and a list of compilation flags to be preprocessed, compiled and assembled if the platform matches the regex. See srcs for more information.

• headers (defaults to []) #

  The set of header files that are made available for inclusion to the source files in this target. These should be specified as either a list of header files or a dictionary of header names to header files. The header names can contain forward slashes (/). If a list of header files is specified, the headers can be imported with #import "$HEADER_PATH_PREFIX/$HEADER_NAME" or #import "$HEADER_NAME", where $HEADER_PATH_PREFIX is the value of the target's header_path_prefix attribute, and $HEADER_NAME is the filename of the header file. If a dictionary is specified, each header can be imported with #import "$HEADER_NAME", where $HEADER_NAME is the key corresponding to this file. In this case, the header_path_prefix attribute is ignored. In either case, quotes in the import statements can be replaced with angle brackets.

• header_path_prefix (defaults to name) #

  A path prefix when including headers of this target. For example, headers from a library defined using

  apple_library(
      name = "Library",
      headers = glob(["**/*.h"]),
      header_path_prefix = "Lib",
  )
  

  can be imported using following mapping

  Library/SubDir/Header1.h -> Lib/Header1.h
  Library/Header2.h -> Lib/Header2.h
    

  Defaults to the short name of the target. Can contain forward slashes (/), but cannot start with one. See headers for more information.

• frameworks (defaults to []) #

  A list of system frameworks that the code in this target uses. Each entry should be a path starting with $SDKROOT or $PLATFORM_DIR to denote that the rest of the path is relative to the root of the SDK used for the build or to the platform toolchain directory.

• preprocessor_flags (defaults to []) #

  Flags to use when preprocessing any of the above sources (which require preprocessing).

• compiler_flags (defaults to []) #

  Flags to use when compiling any of the above sources (which require compilation).

• platform_compiler_flags (defaults to []) #

  Platform specific compiler flags. These should be specified as a list of pairs where the first element is an un-anchored regex (in java.util.regex.Pattern syntax) against which the platform name is matched, and the second element is a list of flags to use when compiling the target's sources. See compiler_flags for more information.

• linker_flags (defaults to []) #

  Flags to add to the linker command line whenever the output from this rule is used in a link operation, such as linked into an executable or a shared library.

• link_style (defaults to static) #

  Determines whether to build and link this rule's dependencies statically or dynamically. Can be either static, static_pic or shared.

• target_sdk_version (defaults to None) #

  The minimum OS version that the library target should support, overriding the minimum set in.buckconfig. When set, Buck will automatically add flags to both Objective-C and Swift compilation that will allow the use of the new APIs without guarding code inside availability checks.

• run_test_separately (defaults to False) #

  If set to True, the test(s) in this rule are run separately from all other tests. (This is useful for integration tests which access a physical device or other limited resource.)

  If unset, the test(s) in this rule in parallel with all other tests.

• labels (defaults to []) #

  A list of labels to be applied to these tests. These labels are arbitrary text strings and have no meaning within buck itself. They can, however, have meaning for you as a test author (e.g., smoke or fast). A label can be used to filter or include a specific test rule when executing buck test.

• extra_xcode_sources (defaults to []) #

  When the project is generated, this is the list of files that will added to the build phase "Compile Sources" of the given target.

• extra_xcode_files (defaults to []) #

  When the project is generated, this is the list of files that will added to the project. Those files won't be added to the build phase "Compile Sources".

• contacts (defaults to []) #

  A list of organizational contacts for this test. These could be individuals who you would contact in the event of a test failure or other issue with the test.

  contacts = [ 'Joe Sixpack', 'Erika Mustermann' ]
  

• visibility (defaults to []) #

  List of build target patterns that identify the build rules that can include this rule as a dependency, for example, by listing it in their deps or exported_deps attributes. For more information, see visibility.

• licenses (defaults to []) #

  Set of license files for this library. To get the list of license files for a given build rule and all of its dependencies, you can use buck query.

• labels (defaults to []) #

  Set of arbitrary strings which allow you to annotate a build rule with tags that can be searched for over an entire dependency tree using buck query attrfilter().

Examples

apple_test(
  name = 'MyTest',
  info_plist = 'MyTest-Info.plist',
  preprocessor_flags = ['-fobjc-arc'],
  srcs = [
    'MyTest.m',
  ],
  deps = [
    ':MyLibrary',
  ],
  frameworks = [
    '$SDKROOT/System/Library/Frameworks/Foundation.framework',
    '$SDKROOT/System/Library/Frameworks/UIKit.framework',
    '$PLATFORM_DIR/Developer/Library/Frameworks/XCTest.framework',
  ],
)