mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-13 13:50:40 +01:00
94c3328b61
This approach actually wraps the unique identifier generation into the function that provides the output path for a test. This way we don't need to add `CreateRandomUuid()` everywhere that we have `test::OutputPath` and instead just rename to `test::OutputPathRandomDir` Bug: webrtc:15833 Change-Id: Ic9b69b5b599727f07b2906569a84a40edeecd1a0 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/338645 Reviewed-by: Harald Alvestrand <hta@webrtc.org> Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> Commit-Queue: Jeremy Leconte <jleconte@google.com> Reviewed-by: Artem Titov <titovartem@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41730}
114 lines
4.4 KiB
C++
114 lines
4.4 KiB
C++
/*
|
|
* Copyright (c) 2011 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
|
|
#ifndef TEST_TESTSUPPORT_FILE_UTILS_H_
|
|
#define TEST_TESTSUPPORT_FILE_UTILS_H_
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "absl/base/attributes.h"
|
|
#include "absl/strings/string_view.h"
|
|
#include "absl/types/optional.h"
|
|
|
|
namespace webrtc {
|
|
namespace test {
|
|
|
|
// Slash or backslash, depending on platform.
|
|
ABSL_CONST_INIT extern const absl::string_view kPathDelimiter;
|
|
|
|
// Returns the absolute path to the output directory where log files and other
|
|
// test artifacts should be put. The output directory is generally a directory
|
|
// named "out" at the project root. This root is assumed to be two levels above
|
|
// where the test binary is located; this is because tests execute in a dir
|
|
// out/Whatever relative to the project root. This convention is also followed
|
|
// in Chromium.
|
|
//
|
|
// The exception is Android where we use /sdcard/ instead.
|
|
//
|
|
// If symbolic links occur in the path they will be resolved and the actual
|
|
// directory will be returned.
|
|
//
|
|
// Returns the path WITH a trailing path delimiter. If the project root is not
|
|
// found, the current working directory ("./") is returned as a fallback.
|
|
std::string OutputPath();
|
|
|
|
// Same as the above but appends a randomly named folder at the end of the path
|
|
// Primerly used to provide a solution for stress testing environments to
|
|
// prevent colission of files and folders.
|
|
std::string OutputPathWithRandomDirectory();
|
|
|
|
// Generates an empty file with a unique name in the specified directory and
|
|
// returns the file name and path.
|
|
// TODO(titovartem) rename to TempFile and next method to TempFilename
|
|
std::string TempFilename(absl::string_view dir, absl::string_view prefix);
|
|
|
|
// Generates a unique file name that can be used for file creation. Doesn't
|
|
// create any files.
|
|
std::string GenerateTempFilename(absl::string_view dir,
|
|
absl::string_view prefix);
|
|
|
|
// Returns a path to a resource file in [project-root]/resources/ dir.
|
|
// Returns an absolute path
|
|
//
|
|
// Arguments:
|
|
// name - Name of the resource file. If a plain filename (no directory path)
|
|
// is supplied, the file is assumed to be located in resources/
|
|
// If a directory path is prepended to the filename, a subdirectory
|
|
// hierarchy reflecting that path is assumed to be present.
|
|
// extension - File extension, without the dot, i.e. "bmp" or "yuv".
|
|
std::string ResourcePath(absl::string_view name, absl::string_view extension);
|
|
|
|
// Joins directory name and file name, separated by the path delimiter.
|
|
std::string JoinFilename(absl::string_view dir, absl::string_view name);
|
|
|
|
// Gets the current working directory for the executing program.
|
|
// Returns "./" if for some reason it is not possible to find the working
|
|
// directory.
|
|
std::string WorkingDir();
|
|
|
|
// Reads the content of a directory and, in case of success, returns a vector
|
|
// of strings with one element for each found file or directory. Each element is
|
|
// a path created by prepending `dir` to the file/directory name. "." and ".."
|
|
// are never added in the returned vector.
|
|
absl::optional<std::vector<std::string>> ReadDirectory(absl::string_view path);
|
|
|
|
// Creates a directory if it not already exists.
|
|
// Returns true if successful. Will print an error message to stderr and return
|
|
// false if a file with the same name already exists.
|
|
bool CreateDir(absl::string_view directory_name);
|
|
|
|
// Removes a directory, which must already be empty.
|
|
bool RemoveDir(absl::string_view directory_name);
|
|
|
|
// Removes a file.
|
|
bool RemoveFile(absl::string_view file_name);
|
|
|
|
// Checks if a file exists.
|
|
// TOOD(alito): Merge these once absl::string_view adoption is complete for this
|
|
// file.
|
|
bool FileExists(absl::string_view file_name);
|
|
|
|
// Checks if a directory exists.
|
|
bool DirExists(absl::string_view directory_name);
|
|
|
|
// Strips the rightmost path segment from a path.
|
|
std::string DirName(absl::string_view path);
|
|
|
|
// File size of the supplied file in bytes. Will return 0 if the file is
|
|
// empty or if the file does not exist/is readable.
|
|
size_t GetFileSize(absl::string_view filename);
|
|
|
|
} // namespace test
|
|
} // namespace webrtc
|
|
|
|
#endif // TEST_TESTSUPPORT_FILE_UTILS_H_
|