/*
 * Copyright (c) 2024, Oracle and/or its affiliates.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2.0,
 * as published by the Free Software Foundation.
 *
 * This program is designed to work with certain software (including
 * but not limited to OpenSSL) that is licensed under separate terms,
 * as designated in a particular file or component or in included license
 * documentation.  The authors of MySQL hereby grant you an additional
 * permission to link the program and your derivative works with the
 * separately licensed software that they have either included with
 * the program or referenced in the documentation.
 *
 * This program is distributed in the hope that it will be useful,  but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
 * the GNU General Public License, version 2.0, for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef UNITTEST_TEST_UTILS_CLEANUP_H_
#define UNITTEST_TEST_UTILS_CLEANUP_H_

#include <deque>
#include <functional>
#include <string>

namespace tests {

class Cleanup final {
 public:
  using Step = std::function<void()>;

  Cleanup() = default;

  Cleanup(const Cleanup &) = delete;
  Cleanup(Cleanup &&) = default;

  Cleanup &operator=(const Cleanup &) = delete;
  Cleanup &operator=(Cleanup &&) = default;

  ~Cleanup();

  Cleanup &add(Step step);

  Cleanup &add(Cleanup c);

  Cleanup &operator+=(Cleanup c);

  inline bool empty() const noexcept { return m_steps.empty(); }

  void cleanup();

  [[nodiscard]] static Cleanup unset_env_var(const char *name);

  [[nodiscard]] static Cleanup set_env_var(const char *name,
                                           const std::string &value);

  [[nodiscard]] static Cleanup write_file(const std::string &path,
                                          const std::string &contents,
                                          bool binary_mode = false);

 private:
  std::deque<Step> m_steps;
};

}  // namespace tests

#endif  // UNITTEST_TEST_UTILS_CLEANUP_H_
