android/android-emu/android/base/testing/TestTempDir.h

// Copyright (C) 2015 The Android Open Source Project
//
// 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 "android/base/Compiler.h"
#include "android/base/Log.h"
#include "android/base/StringFormat.h"
#include "android/base/StringView.h"
#include "android/utils/file_io.h"

#ifdef _WIN32
#include <windows.h>
#undef ERROR
#include <errno.h>
#include <stdio.h>
#endif

#include <dirent.h>
#include <fcntl.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>

namespace android {
namespace base {

// A class used to model a temporary directory used during testing.
// Usage is simple:
//
//      {
//        TestTempDir myDir("my_test");   // creates new temp directory.
//        ASSERT_TRUE(myDir.path());      // NULL if error during creation.
//        ... write files into directory path myDir->path()
//        ... do your test
//      }   // destructor removes temp directory and all files under it.

class TestTempDir {
public:
    // Create new instance. This also tries to create a new temporary
    // directory. |debugPrefix| is an optional name prefix and can be NULL.
    TestTempDir(StringView debugName) {
        std::string temp_dir = getTempPath();
        if (!debugName.empty()) {
            temp_dir += debugName;
            temp_dir += ".";
        }
        temp_dir += "XXXXXX";
        if (mkdtemp(&temp_dir[0])) {
            mPath = temp_dir.c_str();
        }
    }

    // Return the path to the temporary directory, or NULL if it could not
    // be created for some reason.
    const char* path() const { return mPath.size() ? mPath.c_str() : NULL; }

    // Return the path as a string. It will be empty if the directory could
    // not be created for some reason.
    const std::string& pathString() const { return mPath; }

    // Destroy instance, and removes the temporary directory and all files
    // inside it.
    ~TestTempDir() {
        if (mPath.size()) {
            DeleteRecursive(mPath);
        }
    }

    // Create the path of a directory entry under the temporary directory.
    std::string makeSubPath(StringView subpath) {
        return StringFormat("%s/%s", mPath, subpath);
    }

    // Create an empty directory under the temporary directory.
    bool makeSubDir(StringView subdir) {
        std::string path = makeSubPath(subdir);
#ifdef _WIN32
        if (mkdir(path.c_str()) < 0) {
            PLOG(ERROR) << "Can't create " << path.c_str() << ": ";
            return false;
        }
#else
        if (mkdir(path.c_str(), 0755) < 0) {
            PLOG(ERROR) << "Can't create " << path.c_str() << ": ";
            return false;
        }
#endif
        return true;
    }

    // Create an empty file under the temporary directory.
    bool makeSubFile(StringView file) {
        std::string path = makeSubPath(file);
        int fd = ::open(path.c_str(), O_WRONLY|O_CREAT, 0744);
        if (fd < 0) {
            PLOG(ERROR) << "Can't create " << path.c_str() << ": ";
            return false;
        }
        ::close(fd);
        return true;
    }

private:
    DISALLOW_COPY_AND_ASSIGN(TestTempDir);

    void DeleteRecursive(const std::string& path) {
        // First remove any files in the dir
        DIR* dir = opendir(path.c_str());
        if (!dir) {
            return;
        }

        dirent* entry;
        while ((entry = readdir(dir)) != NULL) {
            if (!strcmp(entry->d_name, ".") || !strcmp(entry->d_name, "..")) {
                continue;
            }
            std::string entry_path = StringFormat("%s/%s", path, entry->d_name);
            struct stat stats;
            android_lstat(entry_path.c_str(), &stats);
            if (S_ISDIR(stats.st_mode)) {
                DeleteRecursive(entry_path);
            } else {
                unlink(entry_path.c_str());
            }
        }
        closedir(dir);
        rmdir(path.c_str());
    }

#ifdef _WIN32
    std::string getTempPath() {
        std::string result;
        DWORD len = GetTempPath(0, NULL);
        if (!len) {
            LOG(FATAL) << "Can't find temporary path!";
        }
        result.resize(static_cast<size_t>(len));
        GetTempPath(len, &result[0]);
        // The length returned by GetTempPath() is sometimes too large.
        result.resize(::strlen(result.c_str()));
        for (size_t n = 0; n < result.size(); ++n) {
            if (result[n] == '\\') {
                result[n] = '/';
            }
        }
        if (result.size() && result[result.size() - 1] != '/') {
            result += '/';
        }
        return result;
    }

    char* mkdtemp(char* path) {
        char* sep = ::strrchr(path, '/');
        if (sep) {
            struct stat st;
            int ret;
            *sep = '\0';  // temporarily zero-terminate the dirname.
            ret = android_stat(path, &st);
            *sep = '/';   // restore full path.
            if (ret < 0) {
                return NULL;
            }
            if (!S_ISDIR(st.st_mode)) {
                errno = ENOTDIR;
                return NULL;
            }
        }

        // Loop. On each iteration, replace the XXXXXX suffix with a random
        // number.
        char* path_end = path + ::strlen(path);
        const size_t kSuffixLen = 6U;
        for (int tries = 128; tries > 0; tries--) {
            int random = rand() % 1000000;

            snprintf(path_end - kSuffixLen, kSuffixLen + 1, "%0d", random);
            if (mkdir(path) == 0) {
                return path;  // Success
            }
            if (errno != EEXIST) {
                return NULL;
            }
        }
        return NULL;
    }
#else  // !_WIN32
    std::string getTempPath() {
        std::string result;
        // Only check TMPDIR if we're not root.
        if (getuid() != 0 && getgid() != 0) {
            const char* tmpdir = ::getenv("TMPDIR");
            if (tmpdir && tmpdir[0]) {
                result = tmpdir;
            }
        }
        // Otherwise use P_tmpdir, which defaults to /tmp
        if (result.empty()) {
#  ifndef P_tmpdir
#  define P_tmpdir "/tmp"
#  endif
            result = P_tmpdir;
        }
        // Check that it exists and is a directory.
        struct stat st;
        int ret = android_stat(result.c_str(), &st);
        if (ret < 0 || !S_ISDIR(st.st_mode)) {
            LOG(FATAL) << "Can't find temporary path: ["
                    << result.c_str() << "]";
        }
        // Ensure there is a trailing directory separator.
        if (result.size() && result[result.size() - 1] != '/') {
            result += '/';
        }
        return result;
    }
#endif  // !_WIN32

    std::string mPath;
};

}  // namespace base
}  // namespace android