3016441843

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/google/santa/commit/<a class=hub.com/google/santa/commit/<a class="double-link" href="https://git"><a class=hub.com/google/santa/commit/<a class="double-link" href="https://git"><a class=hub.com/google/santa/commit/<a class="double-link" href="https://git"><a class=hub.com/google/santa/commit/43df6e9b7109de3f98e70ecf1728c912a91090a1">43df6e9b7">&lt;a href=&quot;https://github.com/google/santa/commit/</a><a class="double-link" href="https://github.com/google/santa/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/google/santa/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/google/santa/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/google/santa/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/google/santa/commit/43df6e9b7109de3f98e70ecf1728c912a91090a1">43df6e9b7</a><a href="https://github.com/google/santa/commit/43df6e9b7109de3f98e70ecf1728c912a91090a1">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/google/santa/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/google/santa/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/google/santa/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/google/santa/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/google/santa/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/google/santa/commit/43df6e9b7109de3f98e70ecf1728c912a91090a1&quot;&gt;43df6e9b7&lt;/a&gt;&lt;a href=&quot;https://github.com/google/santa/commit/43df6e9b7109de3f98e70ecf1728c912a91090a1&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/google/santa/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/google/santa/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://git&amp;quot... (continued)

Pull Request Pull Request #888: ES and Logging Interfaces Redesign

Run Details

2364 of 5438 branches covered (43.47%)

Branch coverage included in aggregate %.

3819 of 3819 new or added lines in 62 files covered. (100.0%)

9193 of 13965 relevant lines covered (65.83%)

15057.74 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

79.19

/Source/santad/Logs/EndpointSecurity/Writers/FileTest.mm

/// Copyright 2022 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.

#import <Foundation/Foundation.h>
#include <dispatch/dispatch.h>
#include <gtest/gtest.h>
#include <sys/stat.h>

#include <vector>

#include "Source/common/TestUtils.h"
#import "Source/santad/Logs/EndpointSecurity/Writers/File.h"

using santa::santad::logs::endpoint_security::writers::File;

namespace santa::santad::logs::endpoint_security::writers {

class FilePeer : public File {
 public:
  // Make constructors visible
  using File::File;

  NSFileHandle *FileHandle() { return file_handle_; }

  void BeginWatchingLogFile() { WatchLogFile(); }

  size_t InternalBufferSize() { return buffer_.size(); }
};

}  // namespace santa::santad::logs::endpoint_security::writers

using santa::santad::logs::endpoint_security::writers::FilePeer;

bool WaitFor(bool (^condition)(void)) {
  int attempts = 0;
  long sleepPerAttemptMS = 10;  // Wait 10ms between checks
  long maxSleep = 2000;         // Wait up to 2 seconds for new log file to be created
  long maxAttempts = maxSleep / sleepPerAttemptMS;

  do {
    SleepMS(sleepPerAttemptMS);

    // Break out once the condition holds
    if (condition()) {
      break;
    }
  } while (++attempts < maxAttempts);

  return attempts < maxAttempts;
}

bool WaitForNewLogFile(NSFileManager *fileManager, NSString *path) {
  return WaitFor(^bool() {
    return [fileManager fileExistsAtPath:path];
  });
}

bool WaitForBufferSize(std::shared_ptr<FilePeer> file, size_t expectedSize) {
  return WaitFor(^bool() {
    return file->InternalBufferSize() == expectedSize;
  });
}

@interface FileTest : XCTestCase
@property NSString *path;
@property NSString *logPath;
@property NSString *logRenamePath;
@property dispatch_queue_t q;
@property dispatch_source_t timer;
@property NSFileManager *fileManager;
@end

@implementation FileTest

- (void)setUp {
  self.path = [NSString stringWithFormat:@"%@santa-%d", NSTemporaryDirectory(), getpid()];

  self.logPath = [NSString stringWithFormat:@"%@/log.out", self.path];
  self.logRenamePath = [NSString stringWithFormat:@"%@/log.rename.out", self.path];

  self.fileManager = [NSFileManager defaultManager];

  XCTAssertTrue([self.fileManager createDirectoryAtPath:self.path
                            withIntermediateDirectories:YES
                                             attributes:nil
                                                  error:nil]);

  self.q = dispatch_queue_create(NULL, DISPATCH_QUEUE_SERIAL);
  XCTAssertNotNil(self.q);
  self.timer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, self.q);
  XCTAssertNotNil(self.timer);

  // Resume the timer to ensure its not inadvertently cancelled first
  dispatch_resume(self.timer);
}

- (void)tearDown {
  [self.fileManager removeItemAtPath:self.path error:nil];
}

- (void)testWatchLogFile {
  auto file = std::make_shared<FilePeer>(self.logPath, 100, 500, self.q, self.timer);
  file->BeginWatchingLogFile();

  // Constructing a File object will open the file at the given path
  struct stat wantSBOrig;
  struct stat gotSBOrig;
  XCTAssertEqual(stat([self.logPath UTF8String], &wantSBOrig), 0);
  XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSBOrig), 0);
  XCTAssertEqual(wantSBOrig.st_ino, gotSBOrig.st_ino);

  // Deleting the current log file will cause a new file to be created
  XCTAssertTrue([self.fileManager removeItemAtPath:self.logPath error:nil]);

  XCTAssertTrue(WaitForNewLogFile(self.fileManager, self.logPath),
                "New log file not created within expected time after deletion");

  struct stat wantSBAfterDelete;
  struct stat gotSBAfterDelete;
  XCTAssertEqual(stat([self.logPath UTF8String], &wantSBAfterDelete), 0);
  XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSBAfterDelete), 0);

  XCTAssertEqual(wantSBAfterDelete.st_ino, gotSBAfterDelete.st_ino);
  XCTAssertNotEqual(wantSBOrig.st_ino, wantSBAfterDelete.st_ino);

  // Renaming the current log file will cause a new file to be created
  XCTAssertTrue([self.fileManager moveItemAtPath:self.logPath toPath:self.logRenamePath error:nil]);

  XCTAssertTrue(WaitForNewLogFile(self.fileManager, self.logPath),
                "New log file not created within expected time after rename");

  struct stat wantSBAfterRename;
  struct stat gotSBAfterRename;
  XCTAssertEqual(stat([self.logPath UTF8String], &wantSBAfterRename), 0);
  XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSBAfterRename), 0);

  XCTAssertEqual(wantSBAfterRename.st_ino, gotSBAfterRename.st_ino);
  XCTAssertNotEqual(wantSBAfterDelete.st_ino, wantSBAfterRename.st_ino);
}

- (void)testWrite {
  // Start with empty file. Perform two writes. The first will only go into the
  // internal buffer. The second will meet/exceed capacity and flush to disk
  size_t bufferSize = 100;
  size_t writeSize = 50;
  auto file =
    std::make_shared<FilePeer>(self.logPath, bufferSize, bufferSize * 2, self.q, self.timer);

  // Starting out, file size and internal buffer are 0
  struct stat gotSB;
  XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSB), 0);
  XCTAssertEqual(0, gotSB.st_size);
  XCTAssertEqual(0, file->InternalBufferSize());

  // After the first write, the buffer is 50 bytes, but the file is still 0
  file->Write(std::vector<uint8_t>(writeSize, 'A'));
  WaitForBufferSize(file, 50);
  XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSB), 0);
  XCTAssertEqual(0, gotSB.st_size);
  XCTAssertEqual(50, file->InternalBufferSize());

  // After the second write, the buffer is flushed. File size 100, buffer is 0.
  file->Write(std::vector<uint8_t>(writeSize, 'B'));
  WaitForBufferSize(file, 0);
  XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSB), 0);
  XCTAssertEqual(100, gotSB.st_size);
  XCTAssertEqual(0, file->InternalBufferSize());
}

@end

1	/// Copyright 2022 Google Inc. All rights reserved.
2	///
3	/// Licensed under the Apache License, Version 2.0 (the "License");
4	/// you may not use this file except in compliance with the License.
5	/// You may obtain a copy of the License at
6	///
7	/// http://www.apache.org/licenses/LICENSE-2.0
8	///
9	/// Unless required by applicable law or agreed to in writing, software
10	/// distributed under the License is distributed on an "AS IS" BASIS,
11	/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	/// See the License for the specific language governing permissions and
13	/// limitations under the License.
14
15	#import <Foundation/Foundation.h>
16	#include <dispatch/dispatch.h>
17	#include <gtest/gtest.h>
18	#include <sys/stat.h>
19
20	#include <vector>
21
22	#include "Source/common/TestUtils.h"
23	#import "Source/santad/Logs/EndpointSecurity/Writers/File.h"
24
25	using santa::santad::logs::endpoint_security::writers::File;
26
27	namespace santa::santad::logs::endpoint_security::writers {
28
29	class FilePeer : public File {
30	public:
31	// Make constructors visible
32	using File::File;
33
34	NSFileHandle *FileHandle() { return file_handle_; }	6✔
35
36	void BeginWatchingLogFile() { WatchLogFile(); }	1✔
37
38	size_t InternalBufferSize() { return buffer_.size(); }	5✔
39	};
40
41	} // namespace santa::santad::logs::endpoint_security::writers
42
43	using santa::santad::logs::endpoint_security::writers::FilePeer;
44
45	bool WaitFor(bool (^condition)(void)) {	4✔
46	int attempts = 0;	4✔
47	long sleepPerAttemptMS = 10; // Wait 10ms between checks	4✔
48	long maxSleep = 2000; // Wait up to 2 seconds for new log file to be created	4✔
49	long maxAttempts = maxSleep / sleepPerAttemptMS;	4✔
50
51	do {	4✔
52	SleepMS(sleepPerAttemptMS);	4✔
53
54	// Break out once the condition holds
55	if (condition()) {	4!
56	break;	4✔
57	}	4✔
58	} while (++attempts < maxAttempts);	×
59
60	return attempts < maxAttempts;	4✔
61	}	4✔
62
63	bool WaitForNewLogFile(NSFileManager fileManager, NSString path) {	2✔
64	return WaitFor(^bool() {	2✔
65	return [fileManager fileExistsAtPath:path];	2✔
66	});	2✔
67	}	2✔
68
69	bool WaitForBufferSize(std::shared_ptr<FilePeer> file, size_t expectedSize) {	2✔
70	return WaitFor(^bool() {	2✔
71	return file->InternalBufferSize() == expectedSize;	2✔
72	});	2✔
73	}	2✔
74
75	@interface FileTest : XCTestCase
76	@property NSString *path;
77	@property NSString *logPath;
78	@property NSString *logRenamePath;
79	@property dispatch_queue_t q;
80	@property dispatch_source_t timer;
81	@property NSFileManager *fileManager;
82	@end
83
84	@implementation FileTest
85
86	- (void)setUp {	2✔
87	self.path = [NSString stringWithFormat:@"%@santa-%d", NSTemporaryDirectory(), getpid()];	2✔
88
89	self.logPath = [NSString stringWithFormat:@"%@/log.out", self.path];	2✔
90	self.logRenamePath = [NSString stringWithFormat:@"%@/log.rename.out", self.path];	2✔
91
92	self.fileManager = [NSFileManager defaultManager];	2✔
93
94	XCTAssertTrue([self.fileManager createDirectoryAtPath:self.path	2!
95	withIntermediateDirectories:YES	2✔
96	attributes:nil	2✔
97	error:nil]);	2✔
98
99	self.q = dispatch_queue_create(NULL, DISPATCH_QUEUE_SERIAL);	2✔
100	XCTAssertNotNil(self.q);	2!
101	self.timer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, self.q);	2✔
102	XCTAssertNotNil(self.timer);	2!
103
104	// Resume the timer to ensure its not inadvertently cancelled first
105	dispatch_resume(self.timer);	2✔
106	}	2✔
107
108	- (void)tearDown {	2✔
109	[self.fileManager removeItemAtPath:self.path error:nil];	2✔
110	}	2✔
111
112	- (void)testWatchLogFile {	1✔
113	auto file = std::make_shared<FilePeer>(self.logPath, 100, 500, self.q, self.timer);	1✔
114	file->BeginWatchingLogFile();	1✔
115
116	// Constructing a File object will open the file at the given path
117	struct stat wantSBOrig;	1✔
118	struct stat gotSBOrig;	1✔
119	XCTAssertEqual(stat([self.logPath UTF8String], &wantSBOrig), 0);	1!
120	XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSBOrig), 0);	1!
121	XCTAssertEqual(wantSBOrig.st_ino, gotSBOrig.st_ino);	1!
122
123	// Deleting the current log file will cause a new file to be created
124	XCTAssertTrue([self.fileManager removeItemAtPath:self.logPath error:nil]);	1!
125
126	XCTAssertTrue(WaitForNewLogFile(self.fileManager, self.logPath),	1!
127	"New log file not created within expected time after deletion");	1✔
128
129	struct stat wantSBAfterDelete;	1✔
130	struct stat gotSBAfterDelete;	1✔
131	XCTAssertEqual(stat([self.logPath UTF8String], &wantSBAfterDelete), 0);	1!
132	XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSBAfterDelete), 0);	1!
133
134	XCTAssertEqual(wantSBAfterDelete.st_ino, gotSBAfterDelete.st_ino);	1!
135	XCTAssertNotEqual(wantSBOrig.st_ino, wantSBAfterDelete.st_ino);	1!
136
137	// Renaming the current log file will cause a new file to be created
138	XCTAssertTrue([self.fileManager moveItemAtPath:self.logPath toPath:self.logRenamePath error:nil]);	1!
139
140	XCTAssertTrue(WaitForNewLogFile(self.fileManager, self.logPath),	1!
141	"New log file not created within expected time after rename");	1✔
142
143	struct stat wantSBAfterRename;	1✔
144	struct stat gotSBAfterRename;	1✔
145	XCTAssertEqual(stat([self.logPath UTF8String], &wantSBAfterRename), 0);	1!
146	XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSBAfterRename), 0);	1!
147
148	XCTAssertEqual(wantSBAfterRename.st_ino, gotSBAfterRename.st_ino);	1!
149	XCTAssertNotEqual(wantSBAfterDelete.st_ino, wantSBAfterRename.st_ino);	1!
150	}	1✔
151
152	- (void)testWrite {	1✔
153	// Start with empty file. Perform two writes. The first will only go into the
154	// internal buffer. The second will meet/exceed capacity and flush to disk
155	size_t bufferSize = 100;	1✔
156	size_t writeSize = 50;	1✔
157	auto file =	1✔
158	std::make_shared<FilePeer>(self.logPath, bufferSize, bufferSize * 2, self.q, self.timer);	1✔
159
160	// Starting out, file size and internal buffer are 0
161	struct stat gotSB;	1✔
162	XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSB), 0);	1!
163	XCTAssertEqual(0, gotSB.st_size);	1!
164	XCTAssertEqual(0, file->InternalBufferSize());	1!
165
166	// After the first write, the buffer is 50 bytes, but the file is still 0
167	file->Write(std::vector<uint8_t>(writeSize, 'A'));	1✔
168	WaitForBufferSize(file, 50);	1✔
169	XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSB), 0);	1!
170	XCTAssertEqual(0, gotSB.st_size);	1!
171	XCTAssertEqual(50, file->InternalBufferSize());	1!
172
173	// After the second write, the buffer is flushed. File size 100, buffer is 0.
174	file->Write(std::vector<uint8_t>(writeSize, 'B'));	1✔
175	WaitForBufferSize(file, 0);	1✔
176	XCTAssertEqual(fstat(file->FileHandle().fileDescriptor, &gotSB), 0);	1!
177	XCTAssertEqual(100, gotSB.st_size);	1!
178	XCTAssertEqual(0, file->InternalBufferSize());	1!
179	}	1✔
180
181	@end

google / santa / 3016441843

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous