File: block_tests_writing_to_special_dirs.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (56 lines) | stat: -rw-r--r-- 1,900 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef BASE_FILES_BLOCK_TESTS_WRITING_TO_SPECIAL_DIRS_H_
#define BASE_FILES_BLOCK_TESTS_WRITING_TO_SPECIAL_DIRS_H_

#include <optional>
#include <set>
#include <vector>

#include "base/base_export.h"
#include "base/gtest_prod_util.h"

namespace base {

class FilePath;

using FileWriteBlockedForTestingFunctionPtr = void (*)(const FilePath&);

// Utility class for production code to check if writing to special directories
// is blocked for tests.
class BASE_EXPORT BlockTestsWritingToSpecialDirs {
 public:
  static bool CanWriteToPath(const FilePath& path);

  BlockTestsWritingToSpecialDirs(
      std::vector<int> blocked_dirs,
      FileWriteBlockedForTestingFunctionPtr failure_callback);
  BlockTestsWritingToSpecialDirs(
      const BlockTestsWritingToSpecialDirs& blocker) = delete;
  BlockTestsWritingToSpecialDirs& operator=(
      const BlockTestsWritingToSpecialDirs&) = delete;

  ~BlockTestsWritingToSpecialDirs();

 private:
  friend class BlockTestsWritingToSpecialDirsTest;
  friend class ScopedBlockTestsWritingToSpecialDirs;

  // This private method is used by `ScopedBlockTestsWritingToSpecialDirs` to
  // create an object of this class stored in a function static object.
  // `CanWriteToPath` above checks the paths stored in that object, if it is
  // set. Thus, only ScopedBlockTestsWritingToSpecialDirs should be able to
  // block tests writing to special dirs.
  static std::optional<BlockTestsWritingToSpecialDirs>& Get();

  // `blocked_paths_` will be initialized lazily, from `blocked_dirs_`.
  std::set<FilePath> blocked_paths_;
  std::vector<int> blocked_dirs_;
  FileWriteBlockedForTestingFunctionPtr failure_callback_ = nullptr;
};

}  // namespace base

#endif  // BASE_FILES_BLOCK_TESTS_WRITING_TO_SPECIAL_DIRS_H_