psping_benchmark.py

# Copyright 2018 PerfKitBenchmarker Authors. All rights reserved.
#
# 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.

"""Run psping between two VMs."""

from absl import flags
from perfkitbenchmarker import configs
from perfkitbenchmarker import vm_util
from perfkitbenchmarker.windows_packages import psping

FLAGS = flags.FLAGS

BENCHMARK_NAME = 'psping'
BENCHMARK_CONFIG = """
psping:
  description: Run psping between two VMs.
  vm_groups:
    vm_1:
      vm_spec: *default_single_core
    vm_2:
      vm_spec: *default_single_core
"""


def GetConfig(user_config):
  return configs.LoadConfig(BENCHMARK_CONFIG, user_config, BENCHMARK_NAME)


def Prepare(benchmark_spec):
  vms = benchmark_spec.vms[:2]
  for vm in vms:
    vm.Install('psping')


def Run(benchmark_spec):
  """Measure TCP latency between two VMs.

  Args:
    benchmark_spec: The benchmark specification. Contains all data that is
      required to run the benchmark.

  Returns:
    A list of sample.Sample objects with the benchmark results.
  """

  vms = benchmark_spec.vms
  results = []

  def _RunTest(sending_vm, receiving_vm):
    if vm_util.ShouldRunOnExternalIpAddress():
      results.extend(
          psping.RunLatencyTest(sending_vm, receiving_vm, use_internal_ip=False)
      )

    if vm_util.ShouldRunOnInternalIpAddress(sending_vm, receiving_vm):
      results.extend(
          psping.RunLatencyTest(sending_vm, receiving_vm, use_internal_ip=True)
      )

  _RunTest(vms[0], vms[1])
  _RunTest(vms[1], vms[0])

  return results


def Cleanup(unused_benchmark_spec):
  pass