solrorbit/paths.py

# SPDX-License-Identifier: Apache-2.0
#
# Modifications by Apache Solr contributors; see git log for details.
# Licensed under the Apache License, Version 2.0.
#
# The OpenSearch Contributors require contributions made to
# this file be licensed under the Apache-2.0 license or a
# compatible open source license.
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.
# 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 solrorbit.utils.io import ensure_dir

def benchmark_confdir():
    default_home = os.path.expanduser("~")
    benchmark_confdir_path = os.path.join(os.getenv("BENCHMARK_HOME", default_home), ".solr-orbit")
    ensure_dir(benchmark_confdir_path)
    return benchmark_confdir_path

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


def test_runs_root(cfg):
    return os.path.join(cfg.opts("node", "root.dir"), "test-runs")


def test_run_root(cfg, test_run_id=None):
    if not test_run_id:
        test_run_id = cfg.opts("system", "test_run.id")
    return os.path.join(test_runs_root(cfg), test_run_id)

def aggregated_results_root(cfg, test_run_id=None):
    if not test_run_id:
        test_run_id = cfg.opts("system", "test_run.id")
    return os.path.join(cfg.opts("node", "root.dir"), "aggregated_results", test_run_id)

def install_root(cfg=None):
    install_id = cfg.opts("system", "install.id")
    return os.path.join(test_runs_root(cfg), install_id)


# There is a weird bug manifesting in jenkins that is somehow saying the following line has an invalid docstring
# So to work around it, we are adding this disable, even though the docstring is perfectly fine.
# pylint: disable=invalid-docstring-quote
def logs():
    """
    :return: The absolute path to the directory that contains Solr Orbit's log file.
    """
    return os.path.join(benchmark_confdir(), "logs")