fixture_base.h

Go to the documentation of this file.

/*
 * Copyright 2021 MusicScience37 (Kenta Kabashima)
 *
 * 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.
 */
#pragma once
 
#include <cstddef>
#include <memory>
#include <string>
#include <utility>
 
#include "stat_bench/bench_impl/i_benchmark_case.h"
#include "stat_bench/current_invocation_context.h"
#include "stat_bench/invocation_context.h"
#include "stat_bench/param/num_threads_parameter_name.h"
#include "stat_bench/param/parameter_config.h"
#include "stat_bench/param/parameter_name.h"
#include "stat_bench/param/parameter_value_vector.h"
 
namespace stat_bench {

class FixtureBase : public bench_impl::IBenchmarkCase {
public:

    virtual void setup(InvocationContext& context) {
        // no operation in default implementation
        (void)context;
    }

    virtual void tear_down(InvocationContext& context) {
        // no operation in default implementation
        (void)context;
    }



    template <typename T>
    [[nodiscard]] auto add_param(const param::ParameterName& param_name)
        -> std::shared_ptr<param::ParameterValueVector<T>> {
        return params_.add<T>(param_name);
    }

    template <typename T>
    [[nodiscard]] auto add_param(std::string param_name)
        -> std::shared_ptr<param::ParameterValueVector<T>> {
        return add_param<T>(param::ParameterName(std::move(param_name)));
    }

    auto add_threads_param()
        -> std::shared_ptr<param::ParameterValueVector<std::size_t>> {
        return add_param<std::size_t>(param::num_threads_parameter_name());
    }


    virtual void run() = 0;
 
    FixtureBase(const FixtureBase&) = delete;
    FixtureBase(FixtureBase&&) = delete;
    auto operator=(const FixtureBase&) -> FixtureBase& = delete;
    auto operator=(FixtureBase&&) -> FixtureBase& = delete;

    ~FixtureBase() override = default;
 
protected:
    FixtureBase() = default;
 
private:
    void execute() final {
        auto& context = current_invocation_context();
        setup(context);
        try {
            run();
            tear_down(context);
        } catch (...) {
            tear_down(context);
            throw;
        }
    }

    [[nodiscard]] auto params() const noexcept
        -> const param::ParameterConfig& final {
        return params_;
    }

    param::ParameterConfig params_{};
};
 
}  // namespace stat_bench