esrally/paths.py

# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you 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.
import os

from esrally import types


def rally_confdir():
    default_home = os.path.expanduser("~")
    return os.path.join(os.getenv("RALLY_HOME", default_home), ".rally")


def rally_root():
    return os.path.dirname(os.path.realpath(__file__))


def races_root(cfg: types.Config):
    return os.path.join(cfg.opts("node", "root.dir"), "races")


def race_root(cfg: types.Config, race_id=None):
    if not race_id:
        race_id = cfg.opts("system", "race.id")
    return os.path.join(races_root(cfg), race_id)


def install_root(cfg: types.Config):
    install_id = cfg.opts("system", "install.id")
    return os.path.join(races_root(cfg), install_id)


def libs():
    return os.path.join(rally_confdir(), "libs")


def logs():
    """
    :return: The absolute path to the directory that contains Rally's log file.
    """
    return os.path.join(rally_confdir(), "logs")