Skip to content

Commit

Permalink
apacheGH-44158: [Archery][Integration] Add more explanation how --tar…
Browse files Browse the repository at this point in the history
…get-integrations works

We can use not only `click.command(help)` but also docstring to show
long command description for "archery integration --help". This uses
docstring not `click.command(help)`.
  • Loading branch information
kou committed Sep 21, 2024
1 parent b153791 commit 55555d6
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions dev/archery/archery/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,64 @@ def _set_default(opt, default):
help=("Substring for test names to include in run, "
"e.g. -k primitive"))
def integration(with_all=False, random_seed=12345, **args):
"""If you don't specify the "--target-implementations" option nor
the "ARCHERY_INTEGRATION_TARGET_IMPLEMENTATIONS" environment
variable, test patterns are product of all specified
implementations and all specified implementations.
If "--with-cpp", "--with-java" and "--with-rust" are specified,
the following patterns are tested:
\b
| Producer | Consumer |
|----------|----------|
| C++ | C++ |
| C++ | Java |
| C++ | Rust |
| Java | C++ |
| Java | Java |
| Java | Rust |
| Rust | C++ |
| Rust | Java |
| Rust | Rust |
If "--target-implementations=cpp,java" or
"ARCHERY_INTEGRATION_TARGET_IMPLEMENTATIONS=cpp,java" is
specified, test patterns are:
\b
* product of {C++,Java} and {C++,Java}
* product of {C++,Java} and {Rust}
* product of {Rust} and {C++,Java}
\b
| Producer | Consumer |
|----------|----------|
| C++ | C++ |
| C++ | Java |
| Java | C++ |
| Java | Java |
| C++ | Rust |
| Java | Rust |
| Rust | C++ |
| Rust | Java |
In general, we can reduce test time by specifying only
implementations in our repository. For example, we can use
"ARCHERY_INTEGRATION_TARGET_IMPLEMENTATIONS=rust" for
apache/arrow-rs. It uses only the following test patterns:
\b
| Producer | Consumer |
|----------|----------|
| Rust | Rust |
| Rust | C++ |
| Rust | Java |
| C++ | Rust |
| Java | Rust |
"""

from .integration.runner import write_js_test_json, run_all_tests
import numpy as np

Expand Down

0 comments on commit 55555d6

Please sign in to comment.