hadoop-hdfs-project/hadoop-hdfs-native-client/src/main/native/libhdfspp/tests/tools/hdfs-tool-test.h

/*
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF 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.
*/

#ifndef LIBHDFSPP_TOOLS_HDFS_TOOL_TEST
#define LIBHDFSPP_TOOLS_HDFS_TOOL_TEST

#include <functional>
#include <memory>
#include <string>
#include <tuple>

#include <gtest/gtest.h>

#include "hdfs-tool.h"

/**
 * {@class HdfsToolBasicTest} is a fixture that houses basic tests on {@class
 * hdfs::tools::HdfsTool} interface. It contains the "Happy path" tests which
 * covers the scenarios where {@class hdfs::tools::HdfsTool} is expected to
 * work just fine.
 *
 * {@class HdfsToolBasicTest} is parameterized on a lambda returning an instance
 * of {@class hdfs::tools::HdfsTool} wrapped in a std::unique_ptr. We then run
 * the tests on this instance. Each test runs in isolation. So, a new instance
 * is created for each test.
 */
class HdfsToolBasicTest
    : public testing::TestWithParam<
          std::function<std::unique_ptr<hdfs::tools::HdfsTool>()>> {
public:
  // Abiding to the rule of 5
  HdfsToolBasicTest() = default;
  HdfsToolBasicTest(const HdfsToolBasicTest &) = delete;
  HdfsToolBasicTest(HdfsToolBasicTest &&) = delete;
  HdfsToolBasicTest &operator=(const HdfsToolBasicTest &) = delete;
  HdfsToolBasicTest &operator=(HdfsToolBasicTest &&) = delete;
  ~HdfsToolBasicTest() override;

protected:
  void SetUp() override { hdfs_tool_ = GetParam()(); }

  std::unique_ptr<hdfs::tools::HdfsTool> hdfs_tool_{nullptr};
};

/**
 * {@class HdfsToolNegativeTest} is a fixture that houses negative tests on
 * {@class hdfs::tools::HdfsTool} interface. It covers the tests where
 * unfavorable inputs are presented to the {@class hdfs::tools::HdfsTool}
 * instance and is expected to not crash and is handled gracefully.
 */
class HdfsToolNegativeTest : public HdfsToolBasicTest {
public:
  // Abiding to the rule of 5
  HdfsToolNegativeTest() = default;
  HdfsToolNegativeTest(const HdfsToolNegativeTest &) = delete;
  HdfsToolNegativeTest(HdfsToolNegativeTest &&) = delete;
  HdfsToolNegativeTest &operator=(const HdfsToolNegativeTest &) = delete;
  HdfsToolNegativeTest &operator=(HdfsToolNegativeTest &&) = delete;
  ~HdfsToolNegativeTest() override;
};

TEST_P(HdfsToolBasicTest, RunTool) { EXPECT_TRUE(this->hdfs_tool_->Do()); }

TEST_P(HdfsToolNegativeTest, RunTool) {
  EXPECT_ANY_THROW({ std::ignore = this->hdfs_tool_->Do(); });
}

template <class T> std::unique_ptr<hdfs::tools::HdfsTool> PassAPath() {
  constexpr auto argc = 2;
  static std::string exe("hdfs_tool_name");
  static std::string arg1("a/b/c");

  static char *argv[] = {exe.data(), arg1.data()};
  return std::make_unique<T>(argc, argv);
}

template <class T> std::unique_ptr<hdfs::tools::HdfsTool> CallHelp() {
  constexpr auto argc = 2;
  static std::string exe("hdfs_tool_name");
  static std::string arg1("-h");

  static char *argv[] = {exe.data(), arg1.data()};
  return std::make_unique<T>(argc, argv);
}

template <class T> std::unique_ptr<hdfs::tools::HdfsTool> Pass2Paths() {
  constexpr auto argc = 3;
  static std::string exe("hdfs_tool_name");
  static std::string arg1("a/b/c");
  static std::string arg2("d/e/f");

  static char *argv[] = {exe.data(), arg1.data(), arg2.data()};
  return std::make_unique<T>(argc, argv);
}

#endif