Skip to content

Commit

Permalink
Explain ios_*_test_suite rules more plainly in the documentation.
Browse files Browse the repository at this point in the history
This should help explain why they are named the way they are and how to use them.

RELNOTES: Add explanation that ios_*_test_suite generates a test_suite(but doesn't work like the general test_suite) and adds links between the ios_*_test and ios_*_test_suite rules with notes on usage.
PiperOrigin-RevId: 262399698
  • Loading branch information
gabebear authored and swiple-rules-gardener committed Aug 8, 2019
1 parent 9658cc5 commit d0f1422
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions doc/rules-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -1185,6 +1185,9 @@ test_host, data, deps, provisioning_profile, [test specific attributes])
Builds and bundles an iOS UI `.xctest` test bundle. Runs the tests using the
provided test runner when invoked with `bazel test`.

To run the same test on multiple simulators/devices see
[ios_ui_test_suite](#ios_ui_test_suite).

The following is a list of the `ios_ui_test` specific attributes; for a list
of the attributes inherited by all test rules, please check the
[Bazel documentation](https://bazel.build/versions/master/docs/be/common-definitions.html#common-attributes-tests).
Expand Down Expand Up @@ -1318,7 +1321,11 @@ minimum_os_version, runners, test_host, data, deps, provisioning_profile,
[test specific attributes])
```

Builds an XCUITest test suite with the given runners.
Generates a
[test_suite](https://docs.bazel.build/versions/master/be/general.html#test_suite)
containing an [ios_ui_test](ios_ui_test) for each of the given `runners`.
`ios_ui_test_suite` takes the same parameters as [ios_ui_test](ios_ui_test),
except `runner` is replaced by `runners`.

<table class="table table-condensed table-bordered table-params">
<colgroup>
Expand Down Expand Up @@ -1468,6 +1475,9 @@ certain functionalities might not be present (e.g. UI layout, NSUserDefaults).
You can find more information about app and library testing for Apple platforms
[here](https://developer.apple.com/library/content/documentation/DeveloperTools/Conceptual/testing_with_xcode/chapters/03-testing_basics.html).

To run the same test on multiple simulators/devices see
[ios_unit_test_suite](#ios_unit_test_suite).

The following is a list of the `ios_unit_test` specific attributes; for a list
of the attributes inherited by all test rules, please check the
[Bazel documentation](https://bazel.build/versions/master/docs/be/common-definitions.html#common-attributes-tests).
Expand Down Expand Up @@ -1600,7 +1610,11 @@ ios_unit_test_suite(name, bundle_id, env, frameworks, infoplists,
minimum_os_version, runners, test_host, deps, [test specific attributes])
```

Builds an XCTest unit test suite with the given runners.
Generates a
[test_suite](https://docs.bazel.build/versions/master/be/general.html#test_suite)
containing an [ios_unit_test](#ios_unit_test) for each of the given `runners`.
`ios_unit_test_suite` takes the same parameters as
[ios_unit_test](#ios_unit_test), except `runner` is replaced by `runners`.

<table class="table table-condensed table-bordered table-params">
<colgroup>
Expand Down

0 comments on commit d0f1422

Please sign in to comment.