VirtualFileSystem Struct Reference

An implementation of DiskInterface that uses an in-memory representation of disk state. More...

#include <test.h>

Inheritance diagram for VirtualFileSystem:

Classes
struct	Entry
	An entry for a single in-memory file. More...

Public Types
typedef std::map< std::string, Entry >	FileMap
enum	Status { Okay , NotFound , OtherError }
	Result of ReadFile. More...

Public Member Functions
void	Create (const std::string &path, const std::string &contents)
	"Create" a file with contents.
bool	MakeDir (const std::string &path) override
	Create a directory, returning false on failure.
bool	MakeDirs (const std::string &path)
	Create all the parent directories for path; like mkdir -p basename path.
Status	ReadFile (const std::string &path, std::string *contents, std::string *err) override
	Read and store in given string.
int	RemoveFile (const std::string &path) override
	Remove the file named path.
TimeStamp	Stat (const std::string &path, std::string *err) const override
	stat() a file, returning the mtime, or 0 if missing and -1 on other errors.
int	Tick ()
	Tick "time" forwards; subsequent file operations will be newer than previous ones.
	VirtualFileSystem ()
bool	WriteFile (const std::string &path, const std::string &contents, bool) override
	Create a file, with the specified name and contents If crlf_on_windows is true, will be converted to \r (only on Windows builds of Ninja).

Public Attributes
std::vector< std::string >	directories_made_
FileMap	files_
std::set< std::string >	files_created_
std::vector< std::string >	files_read_
std::set< std::string >	files_removed_
int	now_
	A simple fake timestamp for file operations.

Detailed Description

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.

Definition at line 51 of file test.h.

Member Typedef Documentation

FileMap

typedef std::map<std::string, Entry> VirtualFileSystem::FileMap

Definition at line 81 of file test.h.

Member Enumeration Documentation

Status

enum FileReader::Status

inherited

Result of ReadFile.

Enumerator
Okay
NotFound
OtherError

Definition at line 29 of file disk_interface.h.

Constructor & Destructor Documentation

VirtualFileSystem()

VirtualFileSystem::VirtualFileSystem ( )

inline

Definition at line 52 of file test.h.

References now_.

Member Function Documentation

Create()

void VirtualFileSystem::Create	(	const std::string &	path,
		const std::string &	contents )

"Create" a file with contents.

Definition at line 145 of file test.cc.

References files_, files_created_, and now_.

Referenced by TestPhonyUseCase(), and WriteFile().

MakeDir()

bool VirtualFileSystem::MakeDir ( const std::string & path )

overridevirtual

Create a directory, returning false on failure.

Implements DiskInterface.

Definition at line 167 of file test.cc.

References directories_made_.

MakeDirs()

bool DiskInterface::MakeDirs ( const std::string & path )

inherited

Create all the parent directories for path; like mkdir -p basename path.

Definition at line 140 of file disk_interface.cc.

References Error(), MakeDir(), MakeDirs(), and Stat().

Referenced by MakeDirs().

ReadFile()

FileReader::Status VirtualFileSystem::ReadFile ( const std::string & path, std::string * contents, std::string * err )

overridevirtual

Read and store in given string.

On success, return Okay. On error, return another Status and fill |err|.

Implements FileReader.

Definition at line 172 of file test.cc.

References files_, files_read_, FileReader::NotFound, and FileReader::Okay.

RemoveFile()

int VirtualFileSystem::RemoveFile ( const std::string & path )

overridevirtual

Remove the file named path.

It behaves like 'rm -f path' so no errors are reported if it does not exists.

Returns

0 if the file has been removed, 1 if the file does not exist, and -1 if an error occurs.

Implements DiskInterface.

Definition at line 185 of file test.cc.

References directories_made_, files_, and files_removed_.

Stat()

TimeStamp VirtualFileSystem::Stat ( const std::string & path, std::string * err ) const

overridevirtual

stat() a file, returning the mtime, or 0 if missing and -1 on other errors.

Implements DiskInterface.

Definition at line 152 of file test.cc.

References files_.

Tick()

int VirtualFileSystem::Tick ( )

inline

Tick "time" forwards; subsequent file operations will be newer than previous ones.

Definition at line 59 of file test.h.

References now_.

Referenced by TestPhonyUseCase().

WriteFile()

bool VirtualFileSystem::WriteFile ( const std::string & path, const std::string & contents, bool crlf_on_windows )

overridevirtual

Create a file, with the specified name and contents If crlf_on_windows is true,
will be converted to \r
(only on Windows builds of Ninja).

Returns true on success, false on failure

Implements DiskInterface.

Definition at line 161 of file test.cc.

References Create().

Member Data Documentation

directories_made_

std::vector<std::string> VirtualFileSystem::directories_made_

Definition at line 79 of file test.h.

Referenced by MakeDir(), and RemoveFile().

files_

FileMap VirtualFileSystem::files_

Definition at line 82 of file test.h.

Referenced by Create(), ReadFile(), RemoveFile(), and Stat().

files_created_

std::set<std::string> VirtualFileSystem::files_created_

Definition at line 84 of file test.h.

Referenced by Create().

files_read_

std::vector<std::string> VirtualFileSystem::files_read_

Definition at line 80 of file test.h.

Referenced by ReadFile().

files_removed_

std::set<std::string> VirtualFileSystem::files_removed_

Definition at line 83 of file test.h.

Referenced by RemoveFile().

now_

int VirtualFileSystem::now_

A simple fake timestamp for file operations.

Definition at line 87 of file test.h.

Referenced by Create(), TestPhonyUseCase(), Tick(), and VirtualFileSystem().

---

The documentation for this struct was generated from the following files:

• test.h
• test.cc