doris/be/test/olap/file_utils_test.cpp

// 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.

#include "util/file_utils.h"

#include <algorithm>
#include <filesystem>
#include <fstream>
#include <set>
#include <vector>

#include "agent/status.h"
#include "common/configbase.h"
#include "env/env.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include "olap/file_helper.h"
#include "olap/olap_define.h"
#include "util/logging.h"

#ifndef BE_TEST
#define BE_TEST
#endif

using ::testing::_;
using ::testing::Return;
using ::testing::SetArgPointee;
using std::string;

namespace doris {

class FileUtilsTest : public testing::Test {
public:
    // create a mock cgroup folder
    virtual void SetUp() {
        ASSERT_FALSE(std::filesystem::exists(_s_test_data_path));
        // create a mock cgroup path
        ASSERT_TRUE(std::filesystem::create_directory(_s_test_data_path));
    }
    void save_string_file(const std::filesystem::path& filename, const std::string& content) {
        std::ofstream file;
        file.exceptions(std::ofstream::failbit | std::ofstream::badbit);
        file.open(filename, std::ios_base::binary);
        file.write(content.c_str(), content.size());
    }

    // delete the mock cgroup folder
    virtual void TearDown() { ASSERT_TRUE(std::filesystem::remove_all(_s_test_data_path)); }

    static std::string _s_test_data_path;
};

std::string FileUtilsTest::_s_test_data_path = "./file_utils_testxxxx123";

TEST_F(FileUtilsTest, TestCopyFile) {
    FileHandler src_file_handler;
    std::string src_file_name = _s_test_data_path + "/abcd12345.txt";
    // create a file using open
    ASSERT_FALSE(std::filesystem::exists(src_file_name));
    OLAPStatus op_status = src_file_handler.open_with_mode(
            src_file_name, O_CREAT | O_EXCL | O_WRONLY, S_IRUSR | S_IWUSR);
    ASSERT_EQ(OLAPStatus::OLAP_SUCCESS, op_status);
    ASSERT_TRUE(std::filesystem::exists(src_file_name));

    char large_bytes2[(1 << 12)];
    memset(&large_bytes2, 0, sizeof(large_bytes2));
    int i = 0;
    while (i < 1 << 10) {
        src_file_handler.write(&large_bytes2, sizeof(large_bytes2));
        ++i;
    }
    src_file_handler.write(&large_bytes2, 13);
    src_file_handler.close();

    std::string dst_file_name = _s_test_data_path + "/abcd123456.txt";
    FileUtils::copy_file(src_file_name, dst_file_name);
    FileHandler dst_file_handler;
    dst_file_handler.open(dst_file_name, O_RDONLY);
    int64_t dst_length = dst_file_handler.length();
    int64_t src_length = 4194317;
    ASSERT_EQ(src_length, dst_length);
}

TEST_F(FileUtilsTest, TestRemove) {
    // remove_all
    ASSERT_TRUE(FileUtils::remove_all("./file_test").ok());
    ASSERT_FALSE(FileUtils::check_exist("./file_test"));

    ASSERT_TRUE(FileUtils::create_dir("./file_test/123/456/789").ok());
    ASSERT_TRUE(FileUtils::create_dir("./file_test/abc/def/zxc").ok());
    ASSERT_TRUE(FileUtils::create_dir("./file_test/abc/123").ok());

    save_string_file("./file_test/s1", "123");
    save_string_file("./file_test/123/s2", "123");

    ASSERT_TRUE(FileUtils::check_exist("./file_test"));
    ASSERT_TRUE(FileUtils::remove_all("./file_test").ok());
    ASSERT_FALSE(FileUtils::check_exist("./file_test"));

    // remove
    ASSERT_TRUE(FileUtils::create_dir("./file_test/abc/123").ok());
    save_string_file("./file_test/abc/123/s2", "123");

    ASSERT_FALSE(FileUtils::remove("./file_test").ok());
    ASSERT_FALSE(FileUtils::remove("./file_test/abc/").ok());
    ASSERT_FALSE(FileUtils::remove("./file_test/abc/123").ok());

    ASSERT_TRUE(FileUtils::check_exist("./file_test/abc/123/s2"));
    ASSERT_TRUE(FileUtils::remove("./file_test/abc/123/s2").ok());
    ASSERT_FALSE(FileUtils::check_exist("./file_test/abc/123/s2"));

    ASSERT_TRUE(FileUtils::check_exist("./file_test/abc/123"));
    ASSERT_TRUE(FileUtils::remove("./file_test/abc/123/").ok());
    ASSERT_FALSE(FileUtils::check_exist("./file_test/abc/123"));

    ASSERT_TRUE(FileUtils::remove_all("./file_test").ok());
    ASSERT_FALSE(FileUtils::check_exist("./file_test"));

    // remove paths
    ASSERT_TRUE(FileUtils::create_dir("./file_test/123/456/789").ok());
    ASSERT_TRUE(FileUtils::create_dir("./file_test/abc/def/zxc").ok());
    save_string_file("./file_test/s1", "123");
    save_string_file("./file_test/s2", "123");

    std::vector<std::string> ps;
    ps.push_back("./file_test/123/456/789");
    ps.push_back("./file_test/123/456");
    ps.push_back("./file_test/123");

    ASSERT_TRUE(FileUtils::check_exist("./file_test/123"));
    ASSERT_TRUE(FileUtils::remove_paths(ps).ok());
    ASSERT_FALSE(FileUtils::check_exist("./file_test/123"));

    ps.clear();
    ps.push_back("./file_test/s1");
    ps.push_back("./file_test/abc/def");

    ASSERT_FALSE(FileUtils::remove_paths(ps).ok());
    ASSERT_FALSE(FileUtils::check_exist("./file_test/s1"));
    ASSERT_TRUE(FileUtils::check_exist("./file_test/abc/def/"));

    ps.clear();
    ps.push_back("./file_test/abc/def/zxc");
    ps.push_back("./file_test/s2");
    ps.push_back("./file_test/abc/def");
    ps.push_back("./file_test/abc");

    ASSERT_TRUE(FileUtils::remove_paths(ps).ok());
    ASSERT_FALSE(FileUtils::check_exist("./file_test/s2"));
    ASSERT_FALSE(FileUtils::check_exist("./file_test/abc"));

    ASSERT_TRUE(FileUtils::remove_all("./file_test").ok());
}

TEST_F(FileUtilsTest, TestCreateDir) {
    // normal
    std::string path = "./file_test/123/456/789";
    FileUtils::remove_all("./file_test");
    ASSERT_FALSE(FileUtils::check_exist(path));

    ASSERT_TRUE(FileUtils::create_dir(path).ok());

    ASSERT_TRUE(FileUtils::check_exist(path));
    ASSERT_TRUE(FileUtils::is_dir("./file_test"));
    ASSERT_TRUE(FileUtils::is_dir("./file_test/123"));
    ASSERT_TRUE(FileUtils::is_dir("./file_test/123/456"));
    ASSERT_TRUE(FileUtils::is_dir("./file_test/123/456/789"));

    FileUtils::remove_all("./file_test");

    // normal
    path = "./file_test/123/456/789/";
    FileUtils::remove_all("./file_test");
    ASSERT_FALSE(FileUtils::check_exist(path));

    ASSERT_TRUE(FileUtils::create_dir(path).ok());

    ASSERT_TRUE(FileUtils::check_exist(path));
    ASSERT_TRUE(FileUtils::is_dir("./file_test"));
    ASSERT_TRUE(FileUtils::is_dir("./file_test/123"));
    ASSERT_TRUE(FileUtils::is_dir("./file_test/123/456"));
    ASSERT_TRUE(FileUtils::is_dir("./file_test/123/456/789"));

    FileUtils::remove_all("./file_test");

    // absolute path;
    std::string real_path;
    Env::Default()->canonicalize(".", &real_path);
    ASSERT_TRUE(FileUtils::create_dir(real_path + "/file_test/absolute/path/123/asdf").ok());
    ASSERT_TRUE(FileUtils::is_dir("./file_test/absolute/path/123/asdf"));
    FileUtils::remove_all("./file_test");
}

TEST_F(FileUtilsTest, TestListDirsFiles) {
    std::string path = "./file_test/";
    FileUtils::remove_all(path);
    FileUtils::create_dir("./file_test/1");
    FileUtils::create_dir("./file_test/2");
    FileUtils::create_dir("./file_test/3");
    FileUtils::create_dir("./file_test/4");
    FileUtils::create_dir("./file_test/5");

    std::set<string> dirs;
    std::set<string> files;

    ASSERT_TRUE(FileUtils::list_dirs_files("./file_test", &dirs, &files, Env::Default()).ok());
    ASSERT_EQ(5, dirs.size());
    ASSERT_EQ(0, files.size());

    dirs.clear();
    files.clear();

    ASSERT_TRUE(FileUtils::list_dirs_files("./file_test", &dirs, nullptr, Env::Default()).ok());
    ASSERT_EQ(5, dirs.size());
    ASSERT_EQ(0, files.size());

    save_string_file("./file_test/f1", "just test");
    save_string_file("./file_test/f2", "just test");
    save_string_file("./file_test/f3", "just test");

    dirs.clear();
    files.clear();

    ASSERT_TRUE(FileUtils::list_dirs_files("./file_test", &dirs, &files, Env::Default()).ok());
    ASSERT_EQ(5, dirs.size());
    ASSERT_EQ(3, files.size());

    dirs.clear();
    files.clear();

    ASSERT_TRUE(FileUtils::list_dirs_files("./file_test", nullptr, &files, Env::Default()).ok());
    ASSERT_EQ(0, dirs.size());
    ASSERT_EQ(3, files.size());

    FileUtils::remove_all(path);
}
} // namespace doris

int main(int argc, char** argv) {
    std::string conffile = std::string(getenv("DORIS_HOME")) + "/conf/be.conf";
    if (!doris::config::init(conffile.c_str(), false)) {
        fprintf(stderr, "error read config file. \n");
        return -1;
    }
    doris::init_glog("be-test");
    ::testing::InitGoogleTest(&argc, argv);
    return RUN_ALL_TESTS();
}