grpc/test/core/end2end/generate_tests.bzl

#!/usr/bin/env python2.7
# Copyright 2015 gRPC authors.
#
# 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.
"""Generates the appropriate build.json data for all the end2end tests."""

load(
    "//bazel:grpc_build_system.bzl",
    "grpc_cc_binary",
    "grpc_cc_library",
    "grpc_sh_test",
)

def _fixture_options(
        fullstack = True,
        includes_proxy = False,
        dns_resolver = True,
        name_resolution = True,
        secure = True,
        tracing = False,
        _platforms = ["windows", "linux", "mac", "posix"],
        is_inproc = False,
        is_1byte = False,
        is_http2 = True,
        supports_proxy_auth = False,
        supports_write_buffering = True,
        client_channel = True,
        supports_msvc = True,
        supports_retry = None,
        flaky_tests = [],
        tags = []):
    if supports_retry == None:
        supports_retry = client_channel
    return struct(
        fullstack = fullstack,
        includes_proxy = includes_proxy,
        dns_resolver = dns_resolver,
        name_resolution = name_resolution,
        secure = secure,
        tracing = tracing,
        is_inproc = is_inproc,
        is_1byte = is_1byte,
        is_http2 = is_http2,
        supports_proxy_auth = supports_proxy_auth,
        supports_write_buffering = supports_write_buffering,
        client_channel = client_channel,
        supports_msvc = supports_msvc,
        _platforms = _platforms,
        flaky_tests = flaky_tests,
        supports_retry = supports_retry,
        tags = tags,
    )

# maps fixture name to whether it requires the security library
END2END_FIXTURES = {
    "h2_compress": _fixture_options(),
    "h2_census": _fixture_options(),
    # TODO(juanlishen): This is disabled for now, but should be considered to re-enable once we have
    # decided how the load reporting service should be enabled.
    #'h2_load_reporting': _fixture_options(),
    "h2_fakesec": _fixture_options(),
    "h2_fd": _fixture_options(
        dns_resolver = False,
        fullstack = False,
        client_channel = False,
        _platforms = ["linux", "mac", "posix"],
        tags = ["no_test_ios"],
    ),
    "h2_full": _fixture_options(),
    "h2_full_no_retry": _fixture_options(supports_retry = False),
    "h2_full+pipe": _fixture_options(_platforms = ["linux"]),
    "h2_full+trace": _fixture_options(tracing = True),
    "h2_http_proxy": _fixture_options(supports_proxy_auth = True),
    "h2_insecure": _fixture_options(secure = True),
    "h2_oauth2": _fixture_options(),
    "h2_proxy": _fixture_options(includes_proxy = True),
    "h2_sockpair_1byte": _fixture_options(
        fullstack = False,
        dns_resolver = False,
        client_channel = False,
        is_1byte = True,
    ),
    "h2_sockpair": _fixture_options(
        fullstack = False,
        dns_resolver = False,
        client_channel = False,
    ),
    "h2_sockpair+trace": _fixture_options(
        fullstack = False,
        dns_resolver = False,
        tracing = True,
        client_channel = False,
    ),
    "h2_ssl": _fixture_options(secure = True),
    "h2_ssl_cred_reload": _fixture_options(secure = True),
    "h2_tls": _fixture_options(secure = True),
    "h2_local_abstract_uds_percent_encoded": _fixture_options(
        secure = True,
        dns_resolver = False,
        _platforms = ["linux", "posix"],
    ),
    "h2_local_uds": _fixture_options(
        secure = True,
        dns_resolver = False,
        _platforms = ["linux", "mac", "posix"],
    ),
    "h2_local_uds_percent_encoded": _fixture_options(
        secure = True,
        dns_resolver = False,
        _platforms = ["linux", "mac", "posix"],
    ),
    "h2_local_ipv4": _fixture_options(
        secure = True,
        dns_resolver = False,
        _platforms = ["linux", "mac", "posix"],
        tags = ["requires-net:ipv4", "requires-net:loopback"],
    ),
    "h2_local_ipv6": _fixture_options(
        secure = True,
        dns_resolver = False,
        _platforms = ["linux", "mac", "posix"],
    ),
    "h2_ssl_proxy": _fixture_options(includes_proxy = True, secure = True),
    "h2_uds": _fixture_options(
        dns_resolver = False,
        _platforms = ["linux", "mac", "posix"],
    ),
    "inproc": _fixture_options(
        secure = True,
        fullstack = False,
        dns_resolver = False,
        name_resolution = False,
        is_inproc = True,
        is_http2 = False,
        supports_write_buffering = False,
        client_channel = False,
    ),
}

def _test_options(
        needs_fullstack = False,
        needs_dns = False,
        needs_names = False,
        proxyable = True,
        secure = False,
        traceable = False,
        exclude_inproc = False,
        exclude_1byte = False,
        needs_http2 = False,
        needs_proxy_auth = False,
        needs_write_buffering = False,
        needs_client_channel = False,
        needs_retry = False,
        short_name = None,
        exclude_pollers = []):
    return struct(
        needs_fullstack = needs_fullstack,
        needs_dns = needs_dns,
        needs_names = needs_names,
        proxyable = proxyable,
        secure = secure,
        traceable = traceable,
        exclude_inproc = exclude_inproc,
        exclude_1byte = exclude_1byte,
        needs_http2 = needs_http2,
        needs_proxy_auth = needs_proxy_auth,
        needs_write_buffering = needs_write_buffering,
        needs_client_channel = needs_client_channel,
        needs_retry = needs_retry,
        short_name = short_name,
        exclude_pollers = exclude_pollers,
    )

# maps test names to options
END2END_TESTS = {
    "bad_hostname": _test_options(needs_names = True),
    "bad_ping": _test_options(needs_fullstack = True, proxyable = False),
    "binary_metadata": _test_options(),
    "resource_quota_server": _test_options(
        proxyable = False,
        # TODO(b/151212019): Test case known to be flaky under epoll1.
        exclude_pollers = ["epoll1"],
        exclude_1byte = True,
    ),
    "call_creds": _test_options(secure = True),
    "call_host_override": _test_options(
        needs_fullstack = True,
        needs_dns = True,
        needs_names = True,
    ),
    "cancel_after_accept": _test_options(),
    "cancel_after_client_done": _test_options(),
    "cancel_after_invoke": _test_options(),
    "cancel_after_round_trip": _test_options(),
    "cancel_before_invoke": _test_options(),
    "cancel_in_a_vacuum": _test_options(),
    "cancel_with_status": _test_options(),
    "client_streaming": _test_options(),
    "compressed_payload": _test_options(proxyable = False, exclude_inproc = True),
    "connectivity": _test_options(
        needs_fullstack = True,
        needs_names = True,
        proxyable = False,
    ),
    "channelz": _test_options(),
    "default_host": _test_options(
        needs_fullstack = True,
        needs_dns = True,
        needs_names = True,
    ),
    "disappearing_server": _test_options(needs_fullstack = True, needs_names = True),
    "empty_batch": _test_options(),
    "filter_causes_close": _test_options(),
    "filter_init_fails": _test_options(),
    "filter_context": _test_options(),
    "filtered_metadata": _test_options(),
    "graceful_server_shutdown": _test_options(exclude_inproc = True),
    "grpc_authz": _test_options(secure = True),
    "hpack_size": _test_options(
        proxyable = False,
        traceable = False,
        exclude_inproc = True,
    ),
    "high_initial_seqno": _test_options(),
    "invoke_large_request": _test_options(exclude_1byte = True),
    "keepalive_timeout": _test_options(proxyable = False, needs_http2 = True),
    "large_metadata": _test_options(exclude_1byte = True),
    "max_concurrent_streams": _test_options(
        proxyable = False,
        exclude_inproc = True,
    ),
    "max_connection_age": _test_options(exclude_inproc = True),
    "max_connection_idle": _test_options(needs_fullstack = True, proxyable = False),
    "max_message_length": _test_options(),
    "negative_deadline": _test_options(),
    "no_error_on_hotpath": _test_options(proxyable = False),
    "no_logging": _test_options(traceable = False),
    "no_op": _test_options(),
    "payload": _test_options(exclude_1byte = True),
    # TODO(juanlishen): This is disabled for now because it depends on some generated functions in
    # end2end_tests.cc, which are not generated because they would depend on OpenCensus while
    # OpenCensus can only be built via Bazel so far.
    # 'load_reporting_hook': _test_options(),
    "ping_pong_streaming": _test_options(),
    "ping": _test_options(needs_fullstack = True, proxyable = False),
    "proxy_auth": _test_options(needs_proxy_auth = True),
    "registered_call": _test_options(),
    "request_with_flags": _test_options(proxyable = False),
    "request_with_payload": _test_options(),
    "retry": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_cancellation": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_cancel_during_delay": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_cancel_with_multiple_send_batches": _test_options(
        # TODO(jtattermusch): too long bazel test name makes the test flaky on Windows RBE
        # See b/151617965
        short_name = "retry_cancel3",
        needs_client_channel = True,
        needs_retry = True,
    ),
    "retry_cancel_after_first_attempt_starts": _test_options(
        # TODO(jtattermusch): too long bazel test name makes the test flaky on Windows RBE
        # See b/151617965
        short_name = "retry_cancel4",
        needs_client_channel = True,
        needs_retry = True,
    ),
    "retry_disabled": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_exceeds_buffer_size_in_delay": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_exceeds_buffer_size_in_initial_batch": _test_options(
        needs_client_channel = True,
        # TODO(jtattermusch): too long bazel test name makes the test flaky on Windows RBE
        # See b/151617965
        short_name = "retry_exceeds_buffer_size_in_init",
        needs_retry = True,
    ),
    "retry_exceeds_buffer_size_in_subsequent_batch": _test_options(
        needs_client_channel = True,
        # TODO(jtattermusch): too long bazel test name makes the test flaky on Windows RBE
        # See b/151617965
        short_name = "retry_exceeds_buffer_size_in_subseq",
        needs_retry = True,
    ),
    "retry_lb_drop": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_lb_fail": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_non_retriable_status": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_non_retriable_status_before_recv_trailing_metadata_started": _test_options(
        needs_client_channel = True,
        # TODO(jtattermusch): too long bazel test name makes the test flaky on Windows RBE
        # See b/151617965
        short_name = "retry_non_retriable_status2",
        needs_retry = True,
    ),
    "retry_per_attempt_recv_timeout": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_per_attempt_recv_timeout_on_last_attempt": _test_options(
        needs_client_channel = True,
        # TODO(jtattermusch): too long bazel test name makes the test flaky on Windows RBE
        # See b/151617965
        short_name = "retry_per_attempt_recv_timeout2",
        needs_retry = True,
    ),
    "retry_recv_initial_metadata": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_recv_message": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_recv_message_replay": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_recv_trailing_metadata_error": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_send_initial_metadata_refs": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_send_op_fails": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_send_recv_batch": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_server_pushback_delay": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_server_pushback_disabled": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_streaming": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_streaming_after_commit": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_streaming_succeeds_before_replay_finished": _test_options(
        needs_client_channel = True,
        # TODO(jtattermusch): too long bazel test name makes the test flaky on Windows RBE
        # See b/151617965
        short_name = "retry_streaming2",
        needs_retry = True,
    ),
    "retry_throttled": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_too_many_attempts": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_transparent_goaway": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_transparent_not_sent_on_wire": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_transparent_max_concurrent_streams": _test_options(
        needs_client_channel = True,
        proxyable = False,
        # TODO(jtattermusch): too long bazel test name makes the test flaky on Windows RBE
        # See b/151617965
        short_name = "retry_transparent_mcs",
        needs_retry = True,
    ),
    "retry_unref_before_finish": _test_options(needs_client_channel = True, needs_retry = True),
    "retry_unref_before_recv": _test_options(needs_client_channel = True, needs_retry = True),
    "server_finishes_request": _test_options(),
    "server_streaming": _test_options(needs_http2 = True),
    "shutdown_finishes_calls": _test_options(),
    "shutdown_finishes_tags": _test_options(),
    "simple_delayed_request": _test_options(needs_fullstack = True),
    "simple_metadata": _test_options(),
    "simple_request": _test_options(),
    "streaming_error_response": _test_options(),
    "trailing_metadata": _test_options(),
    "authority_not_supported": _test_options(),
    "filter_latency": _test_options(),
    "filter_status_code": _test_options(),
    "write_buffering": _test_options(needs_write_buffering = True),
    "write_buffering_at_end": _test_options(needs_write_buffering = True),
}

def _compatible(fopt, topt):
    if topt.needs_fullstack:
        if not fopt.fullstack:
            return False
    if topt.needs_dns:
        if not fopt.dns_resolver:
            return False
    if topt.needs_names:
        if not fopt.name_resolution:
            return False
    if not topt.proxyable:
        if fopt.includes_proxy:
            return False
    if not topt.traceable:
        if fopt.tracing:
            return False
    if topt.exclude_inproc:
        if fopt.is_inproc:
            return False
    if topt.exclude_1byte:
        if fopt.is_1byte:
            return False
    if topt.needs_http2:
        if not fopt.is_http2:
            return False
    if topt.needs_proxy_auth:
        if not fopt.supports_proxy_auth:
            return False
    if topt.needs_write_buffering:
        if not fopt.supports_write_buffering:
            return False
    if topt.needs_client_channel:
        if not fopt.client_channel:
            return False
    if topt.needs_retry:
        if not fopt.supports_retry:
            return False
    return True

def _platform_support_tags(fopt):
    result = []
    if not "windows" in fopt._platforms:
        result.append("no_windows")
    if not "mac" in fopt._platforms:
        result.append("no_mac")
    if not "linux" in fopt._platforms:
        result.append("no_linux")
    return result

# buildifier: disable=unnamed-macro
def grpc_end2end_tests():
    """Instantiates the gRPC end2end tests."""
    grpc_cc_library(
        name = "end2end_tests",
        srcs = ["end2end_tests.cc", "end2end_test_utils.cc"] +
               ["tests/%s.cc" % t for t in sorted(END2END_TESTS.keys())],
        hdrs = [
            "tests/cancel_test_helpers.h",
            "end2end_tests.h",
        ],
        language = "C++",
        testonly = 1,
        deps = [
            ":cq_verifier",
            ":ssl_test_data",
            ":http_proxy",
            ":proxy",
            ":local_util",
            "//test/core/util:test_lb_policies",
            "//:grpc_authorization_provider",
            "//test/core/compression:args_utils",
        ],
    )
    for f, fopt in END2END_FIXTURES.items():
        bin_name = "%s_test" % f
        grpc_cc_binary(
            name = bin_name,
            srcs = ["fixtures/%s.cc" % f],
            language = "C++",
            testonly = 1,
            data = [
                "//src/core/tsi/test_creds:ca.pem",
                "//src/core/tsi/test_creds:server1.key",
                "//src/core/tsi/test_creds:server1.pem",
            ],
            deps = [
                ":end2end_tests",
                "//test/core/util:grpc_test_util",
                "//:grpc",
                "//:gpr",
                "//test/core/compression:args_utils",
            ],
            tags = _platform_support_tags(fopt) + fopt.tags,
        )
        for t, topt in END2END_TESTS.items():
            if not _compatible(fopt, topt):
                continue
            test_short_name = str(t) if not topt.short_name else topt.short_name
            grpc_sh_test(
                name = "%s_test@%s" % (f, test_short_name),
                srcs = ["run.sh"],
                data = [":" + bin_name],
                args = ["$(location %s)" % bin_name, t],
                tags = _platform_support_tags(fopt) + fopt.tags + [
                    "no_test_ios",
                ],
                flaky = t in fopt.flaky_tests,
                exclude_pollers = topt.exclude_pollers,
            )