Skip to content

Commit

Permalink
Add 'args' to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dzbarsky committed Aug 25, 2024
1 parent 9572fa9 commit 989cded
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
8 changes: 7 additions & 1 deletion docs/itest.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ itest_service(<a href="#itest_service-name">name</a>, <a href="#itest_service-au

An itest_service is a binary that is intended to run for the duration of the integration test. Examples include databases, HTTP/RPC servers, queue consumers, external service mocks, etc.

All [common binary attributes](https://bazel.build/reference/be/common-definitions#common-attributes-binaries) are supported including `args`.

**ATTRIBUTES**


Expand Down Expand Up @@ -88,7 +90,9 @@ itest_task(<a href="#itest_task-name">name</a>, <a href="#itest_task-data">data<
</pre>

A task is a one-shot (not long-running binary) that is intended to be executed as part of the itest scenario creation.
Examples include: filesystem setup, dynamic config file generation (especially if it depends on ports), DB migrations or seed data creation
Examples include: filesystem setup, dynamic config file generation (especially if it depends on ports), DB migrations or seed data creation.

All [common binary attributes](https://bazel.build/reference/be/common-definitions#common-attributes-binaries) are supported including `args`.

**ATTRIBUTES**

Expand Down Expand Up @@ -134,6 +138,8 @@ service_test(

Typically this would be wrapped into a macro.

All [common binary attributes](https://bazel.build/reference/be/common-definitions#common-attributes-binaries) are supported including `args`.

**ATTRIBUTES**


Expand Down
12 changes: 9 additions & 3 deletions private/itest.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,9 @@ itest_service = rule(
implementation = _itest_service_impl,
attrs = _itest_service_attrs,
executable = True,
doc = "An itest_service is a binary that is intended to run for the duration of the integration test. Examples include databases, HTTP/RPC servers, queue consumers, external service mocks, etc.",
doc = """An itest_service is a binary that is intended to run for the duration of the integration test. Examples include databases, HTTP/RPC servers, queue consumers, external service mocks, etc.
All [common binary attributes](https://bazel.build/reference/be/common-definitions#common-attributes-binaries) are supported including `args`.""",
)

def _itest_task_impl(ctx):
Expand All @@ -263,7 +265,9 @@ itest_task = rule(
attrs = _itest_binary_attrs,
executable = True,
doc = """A task is a one-shot (not long-running binary) that is intended to be executed as part of the itest scenario creation.
Examples include: filesystem setup, dynamic config file generation (especially if it depends on ports), DB migrations or seed data creation""",
Examples include: filesystem setup, dynamic config file generation (especially if it depends on ports), DB migrations or seed data creation.
All [common binary attributes](https://bazel.build/reference/be/common-definitions#common-attributes-binaries) are supported including `args`.""",
)

def _itest_service_group_impl(ctx):
Expand Down Expand Up @@ -397,7 +401,9 @@ service_test(
)
```
Typically this would be wrapped into a macro.""",
Typically this would be wrapped into a macro.
All [common binary attributes](https://bazel.build/reference/be/common-definitions#common-attributes-binaries) are supported including `args`.""",
)

def _create_version_file(ctx, inputs):
Expand Down

0 comments on commit 989cded

Please sign in to comment.