Cleanup of bazel qps scenarios generator (#27622)

* cleanup of bazel qps scenarios generator

* regenerate bzl files

* add back outstanding_rpc_divisor

* regenerate

* fix check_qps_scenario_changes.py
pull/27659/head
Jan Tattermusch 3 years ago committed by GitHub
parent 9c33c690b4
commit 6f2021c48f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 200
      test/cpp/qps/gen_build_yaml.py
  2. 52
      test/cpp/qps/json_run_localhost_scenario_gen.py
  3. 81
      test/cpp/qps/json_run_localhost_scenarios.bzl
  4. 52
      test/cpp/qps/qps_json_driver_scenario_gen.py
  5. 35
      test/cpp/qps/qps_json_driver_scenarios.bzl
  6. 99
      test/cpp/qps/scenario_generator_helper.py
  7. 6
      tools/run_tests/sanity/check_qps_scenario_changes.py

@ -1,200 +0,0 @@
#!/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.
from __future__ import print_function
import json
import os
import pipes
import shutil
import sys
import yaml
run_tests_root = os.path.abspath(
os.path.join(os.path.dirname(sys.argv[0]), '../../../tools/run_tests'))
sys.path.append(run_tests_root)
import performance.scenario_config as scenario_config
configs_from_yaml = yaml.load(
open(
os.path.join(os.path.dirname(sys.argv[0]),
'../../../build_handwritten.yaml')))['configs'].keys()
def mutate_scenario(scenario_json, is_tsan):
# tweak parameters to get fast test times
scenario_json = dict(scenario_json)
scenario_json['warmup_seconds'] = 0
scenario_json['benchmark_seconds'] = 1
outstanding_rpcs_divisor = 1
if is_tsan and (
scenario_json['client_config']['client_type'] == 'SYNC_CLIENT' or
scenario_json['server_config']['server_type'] == 'SYNC_SERVER'):
outstanding_rpcs_divisor = 10
scenario_json['client_config']['outstanding_rpcs_per_channel'] = max(
1,
int(scenario_json['client_config']['outstanding_rpcs_per_channel'] /
outstanding_rpcs_divisor))
return scenario_json
def _scenario_json_string(scenario_json, is_tsan):
scenarios_json = {
'scenarios': [
scenario_config.remove_nonproto_fields(
mutate_scenario(scenario_json, is_tsan))
]
}
return json.dumps(scenarios_json)
def threads_required(scenario_json, where, is_tsan):
scenario_json = mutate_scenario(scenario_json, is_tsan)
if scenario_json['%s_config' % where]['%s_type' %
where] == 'ASYNC_%s' % where.upper():
return scenario_json['%s_config' % where].get(
'async_%s_threads' % where, 0)
return scenario_json['client_config'][
'outstanding_rpcs_per_channel'] * scenario_json['client_config'][
'client_channels']
def guess_cpu(scenario_json, is_tsan):
client = threads_required(scenario_json, 'client', is_tsan)
server = threads_required(scenario_json, 'server', is_tsan)
# make an arbitrary guess if set to auto-detect
# about the size of the jenkins instances we have for unit tests
if client == 0 or server == 0:
return 'capacity'
return (scenario_json['num_clients'] * client +
scenario_json['num_servers'] * server)
def maybe_exclude_gcov(scenario_json):
if scenario_json['client_config']['client_channels'] > 100:
return ['gcov']
return []
# Originally, this method was used to generate qps test cases for build.yaml,
# but since the test cases are now extracted from bazel BUILD file,
# this is not used for generating run_tests.py test cases anymore.
# Nevertheless, the output is still used by json_run_localhost_scenario_gen.py
# and qps_json_driver_scenario_gen.py to generate the scenario list for bazel.
# TODO(jtattermusch): cleanup this file, so that it only generates data needed
# by bazel.
def generate_yaml():
return {
'tests':
[{
'name':
'json_run_localhost',
'shortname':
'json_run_localhost:%s' % scenario_json['name'],
'args': [
'--scenarios_json',
_scenario_json_string(scenario_json, False)
],
'ci_platforms': ['linux'],
'platforms': ['linux'],
'flaky':
False,
'language':
'c++',
'boringssl':
True,
'defaults':
'boringssl',
'cpu_cost':
guess_cpu(scenario_json, False),
'exclude_configs': ['tsan', 'asan'] +
maybe_exclude_gcov(scenario_json),
'timeout_seconds':
2 * 60,
'excluded_poll_engines':
scenario_json.get('EXCLUDED_POLL_ENGINES', []),
'auto_timeout_scaling':
False
}
for scenario_json in scenario_config.CXXLanguage().scenarios()
if 'scalable' in scenario_json.get('CATEGORIES', [])] +
[{
'name':
'qps_json_driver',
'shortname':
'qps_json_driver:inproc_%s' % scenario_json['name'],
'args': [
'--run_inproc', '--scenarios_json',
_scenario_json_string(scenario_json, False)
],
'ci_platforms': ['linux'],
'platforms': ['linux'],
'flaky':
False,
'language':
'c++',
'boringssl':
True,
'defaults':
'boringssl',
'cpu_cost':
guess_cpu(scenario_json, False),
'exclude_configs': ['tsan', 'asan'],
'timeout_seconds':
6 * 60,
'excluded_poll_engines':
scenario_json.get('EXCLUDED_POLL_ENGINES', [])
}
for scenario_json in scenario_config.CXXLanguage().scenarios()
if 'inproc' in scenario_json.get('CATEGORIES', [])] +
[{
'name':
'json_run_localhost',
'shortname':
'json_run_localhost:%s_low_thread_count' %
scenario_json['name'],
'args': [
'--scenarios_json',
_scenario_json_string(scenario_json, True)
],
'ci_platforms': ['linux'],
'platforms': ['linux'],
'flaky':
False,
'language':
'c++',
'boringssl':
True,
'defaults':
'boringssl',
'cpu_cost':
guess_cpu(scenario_json, True),
'exclude_configs':
sorted(c
for c in configs_from_yaml
if c not in ('tsan', 'asan')),
'timeout_seconds':
10 * 60,
'excluded_poll_engines':
scenario_json.get('EXCLUDED_POLL_ENGINES', []),
'auto_timeout_scaling':
False
}
for scenario_json in scenario_config.CXXLanguage().scenarios()
if 'scalable' in scenario_json.get('CATEGORIES', [])]
}

@ -1,4 +1,4 @@
#!/usr/bin/env python2.7
#!/usr/bin/env python3
# Copyright 2018 gRPC authors.
#
@ -14,47 +14,15 @@
# See the License for the specific language governing permissions and
# limitations under the License.
import json
import os
import sys
import gen_build_yaml as gen
COPYRIGHT = """
# Copyright 2021 The 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.
"""
def generate_args():
all_scenario_set = gen.generate_yaml()
all_scenario_set = all_scenario_set['tests']
json_run_localhost_scenarios = \
[item for item in all_scenario_set if item['name'] == 'json_run_localhost']
json_run_localhost_arg_set = \
[item['args'][1] for item in json_run_localhost_scenarios \
if 'args' in item and len(item['args']) > 1]
deserialized_scenarios = [json.loads(item)['scenarios'][0] \
for item in json_run_localhost_arg_set]
all_scenarios = {scenario['name'].encode('ascii', 'ignore'): \
'\'{\'scenarios\' : [' + json.dumps(scenario) + ']}\'' \
for scenario in deserialized_scenarios}
serialized_scenarios_str = str(all_scenarios).encode('ascii', 'ignore')
with open('json_run_localhost_scenarios.bzl', 'wb') as f:
f.write(COPYRIGHT)
f.write('"""Scenarios run on localhost."""\n\n')
f.write('JSON_RUN_LOCALHOST_SCENARIOS = ' + serialized_scenarios_str +
'\n')
script_dir = os.path.dirname(sys.argv[0])
sys.path.append(script_dir)
import scenario_generator_helper as gen
generate_args()
gen.generate_scenarios_bzl(
gen.generate_json_run_localhost_scenarios(),
os.path.join(script_dir, 'json_run_localhost_scenarios.bzl'),
'JSON_RUN_LOCALHOST_SCENARIOS')

File diff suppressed because one or more lines are too long

@ -1,4 +1,4 @@
#!/usr/bin/env python2.7
#!/usr/bin/env python3
# Copyright 2018 gRPC authors.
#
@ -14,47 +14,15 @@
# See the License for the specific language governing permissions and
# limitations under the License.
import json
import os
import sys
import gen_build_yaml as gen
COPYRIGHT = """
# Copyright 2021 The 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.
"""
def generate_args():
all_scenario_set = gen.generate_yaml()
all_scenario_set = all_scenario_set['tests']
qps_json_driver_scenario_set = \
[item for item in all_scenario_set if item['name'] == 'qps_json_driver']
qps_json_driver_arg_set = \
[item['args'][2] for item in qps_json_driver_scenario_set \
if 'args' in item and len(item['args']) > 2]
deserialized_scenarios = [json.loads(item)['scenarios'][0] \
for item in qps_json_driver_arg_set]
all_scenarios = {scenario['name'].encode('ascii', 'ignore'): \
'\'{\'scenarios\' : [' + json.dumps(scenario) + ']}\'' \
for scenario in deserialized_scenarios}
serialized_scenarios_str = str(all_scenarios).encode('ascii', 'ignore')
with open('qps_json_driver_scenarios.bzl', 'w') as f:
f.write(COPYRIGHT)
f.write('"""Scenarios of qps driver."""\n\n')
f.write('QPS_JSON_DRIVER_SCENARIOS = ' + serialized_scenarios_str +
'\n')
script_dir = os.path.dirname(sys.argv[0])
sys.path.append(script_dir)
import scenario_generator_helper as gen
generate_args()
gen.generate_scenarios_bzl(
gen.generate_qps_json_driver_scenarios(),
os.path.join(script_dir, 'qps_json_driver_scenarios.bzl'),
'QPS_JSON_DRIVER_SCENARIOS')

File diff suppressed because one or more lines are too long

@ -0,0 +1,99 @@
#!/usr/bin/env python3
# Copyright 2021 The 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.
from __future__ import print_function
import json
import os
import sys
import yaml
run_tests_root = os.path.abspath(
os.path.join(os.path.dirname(sys.argv[0]), '../../../tools/run_tests'))
sys.path.append(run_tests_root)
import performance.scenario_config as scenario_config
_COPYRIGHT = """# Copyright 2021 The 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.
"""
def _mutate_scenario(scenario_json):
# tweak parameters to get fast test times
scenario_json = dict(scenario_json)
scenario_json['warmup_seconds'] = 0
scenario_json['benchmark_seconds'] = 1
outstanding_rpcs_divisor = 1
if scenario_json['client_config'][
'client_type'] == 'SYNC_CLIENT' or scenario_json['server_config'][
'server_type'] == 'SYNC_SERVER':
outstanding_rpcs_divisor = 10
scenario_json['client_config']['outstanding_rpcs_per_channel'] = max(
1,
int(scenario_json['client_config']['outstanding_rpcs_per_channel'] /
outstanding_rpcs_divisor))
return scenario_config.remove_nonproto_fields(scenario_json)
def generate_json_run_localhost_scenarios():
return [
_mutate_scenario(scenario_json)
for scenario_json in scenario_config.CXXLanguage().scenarios()
if 'scalable' in scenario_json.get('CATEGORIES', [])
]
def generate_qps_json_driver_scenarios():
return [
_mutate_scenario(scenario_json)
for scenario_json in scenario_config.CXXLanguage().scenarios()
if 'inproc' in scenario_json.get('CATEGORIES', [])
]
def generate_scenarios_bzl(json_scenarios, bzl_filename, bzl_variablename):
"""Generate .bzl file that defines a variable with JSON scenario configs."""
all_scenarios = []
for scenario in json_scenarios:
scenario_name = scenario['name']
# argument will be passed as "--scenarios_json" to the test binary
# the string needs to be quoted in \' to ensure it gets passed as a single argument in shell
scenarios_json_arg_str = '\\\'%s\\\'' % json.dumps(
{'scenarios': [scenario]})
all_scenarios.append((scenario_name, scenarios_json_arg_str))
with open(bzl_filename, 'w') as f:
f.write(_COPYRIGHT)
f.write(
'"""AUTOGENERATED: configuration of benchmark scenarios to be run as bazel test"""\n\n'
)
f.write('%s = {\n' % bzl_variablename)
for scenario in all_scenarios:
f.write(" \"%s\": '%s',\n" % (scenario[0], scenario[1]))
f.write('}\n')

@ -19,9 +19,9 @@ import subprocess
import sys
os.chdir(os.path.join(os.path.dirname(sys.argv[0]), '../../../test/cpp/qps'))
subprocess.call(['./json_run_localhost_scenario_gen.py'])
subprocess.call(['./qps_json_driver_scenario_gen.py'])
subprocess.call(['buildifier', '-v', '-r', '.'])
subprocess.check_call(['./json_run_localhost_scenario_gen.py'])
subprocess.check_call(['./qps_json_driver_scenario_gen.py'])
subprocess.check_call(['buildifier', '-v', '-r', '.'])
output = subprocess.check_output(['git', 'status', '--porcelain'])
qps_json_driver_bzl = 'test/cpp/qps/qps_json_driver_scenarios.bzl'

Loading…
Cancel
Save