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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
// Copyright 2011 Google Inc. All Rights Reserved.
//
// 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.
#ifndef NINJA_TEST_H_
#define NINJA_TEST_H_
#include <gtest/gtest.h>
#include "disk_interface.h"
#include "manifest_parser.h"
#include "state.h"
// Support utilities for tests.
struct Node;
/// A base test fixture that includes a State object with a
/// builtin "cat" rule.
struct StateTestWithBuiltinRules : public testing::Test {
StateTestWithBuiltinRules();
/// Add a "cat" rule to \a state. Used by some tests; it's
/// otherwise done by the ctor to state_.
void AddCatRule(State* state);
/// Short way to get a Node by its path from state_.
Node* GetNode(const std::string& path);
State state_;
};
void AssertParse(State* state, const char* input,
ManifestParserOptions = ManifestParserOptions());
void AssertHash(const char* expected, uint64_t actual);
void VerifyGraph(const State& state);
/// An implementation of DiskInterface that uses an in-memory representation
/// of disk state. It also logs file accesses and directory creations
/// so it can be used by tests to verify disk access patterns.
struct VirtualFileSystem : public DiskInterface {
VirtualFileSystem() : now_(1) {}
/// "Create" a file with contents.
void Create(const std::string& path, const std::string& contents);
/// Tick "time" forwards; subsequent file operations will be newer than
/// previous ones.
int Tick() {
return ++now_;
}
// DiskInterface
virtual TimeStamp Stat(const std::string& path, std::string* err) const;
virtual bool WriteFile(const std::string& path, const std::string& contents);
virtual bool MakeDir(const std::string& path);
virtual Status ReadFile(const std::string& path, std::string* contents,
std::string* err);
virtual int RemoveFile(const std::string& path);
/// An entry for a single in-memory file.
struct Entry {
int mtime;
std::string stat_error; // If mtime is -1.
std::string contents;
};
std::vector<std::string> directories_made_;
std::vector<std::string> files_read_;
typedef std::map<std::string, Entry> FileMap;
FileMap files_;
std::set<std::string> files_removed_;
std::set<std::string> files_created_;
/// A simple fake timestamp for file operations.
int now_;
};
struct ScopedTempDir {
/// Create a temporary directory and chdir into it.
void CreateAndEnter(const std::string& name);
/// Clean up the temporary directory.
void Cleanup();
/// The temp directory containing our dir.
std::string start_dir_;
/// The subdirectory name for our dir, or empty if it hasn't been set up.
std::string temp_dir_name_;
};
/// A class that records a file path and ensures that it is removed
/// on destruction. This ensures that tests do not keep stale files in the
/// current directory where they run, even in case of assertion failure.
struct ScopedFilePath {
/// Constructor just records the file path.
ScopedFilePath(const std::string& path) : path_(path) {}
ScopedFilePath(const char* path) : path_(path) {}
/// Allow move operations.
ScopedFilePath(ScopedFilePath&&) noexcept;
ScopedFilePath& operator=(ScopedFilePath&&) noexcept;
/// Destructor destroys the file, unless Release() was called.
~ScopedFilePath();
/// Release the file, the destructor will not remove the file.
void Release();
const char* c_str() const { return path_.c_str(); }
const std::string& path() const { return path_; }
bool released() const { return released_; }
private:
std::string path_;
bool released_ = false;
};
#endif // NINJA_TEST_H_
|
