1 //===- llvm/unittest/Support/FileOutputBuffer.cpp - unit tests ------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #include "llvm/Support/FileOutputBuffer.h"
11 #include "llvm/ADT/OwningPtr.h"
12 #include "llvm/Support/ErrorHandling.h"
13 #include "llvm/Support/FileSystem.h"
14 #include "llvm/Support/Path.h"
15 #include "llvm/Support/raw_ostream.h"
16 #include "gtest/gtest.h"
17
18 using namespace llvm;
19 using namespace llvm::sys;
20
21 #define ASSERT_NO_ERROR(x) \
22 if (error_code ASSERT_NO_ERROR_ec = x) { \
23 errs() << #x ": did not return errc::success.\n" \
24 << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n" \
25 << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n"; \
26 } else {}
27
28 namespace {
TEST(FileOutputBuffer,Test)29 TEST(FileOutputBuffer, Test) {
30 // Create unique temporary directory for these tests
31 SmallString<128> TestDirectory;
32 {
33 ASSERT_NO_ERROR(
34 fs::createUniqueDirectory("FileOutputBuffer-test", TestDirectory));
35 }
36
37 // TEST 1: Verify commit case.
38 SmallString<128> File1(TestDirectory);
39 File1.append("/file1");
40 {
41 OwningPtr<FileOutputBuffer> Buffer;
42 ASSERT_NO_ERROR(FileOutputBuffer::create(File1, 8192, Buffer));
43 // Start buffer with special header.
44 memcpy(Buffer->getBufferStart(), "AABBCCDDEEFFGGHHIIJJ", 20);
45 // Write to end of buffer to verify it is writable.
46 memcpy(Buffer->getBufferEnd() - 20, "AABBCCDDEEFFGGHHIIJJ", 20);
47 // Commit buffer.
48 ASSERT_NO_ERROR(Buffer->commit());
49 }
50 // Verify file exists and starts with special header.
51 bool MagicMatches = false;
52 ASSERT_NO_ERROR(fs::has_magic(Twine(File1), Twine("AABBCCDDEEFFGGHHIIJJ"),
53 MagicMatches));
54 EXPECT_TRUE(MagicMatches);
55 // Verify file is correct size.
56 uint64_t File1Size;
57 ASSERT_NO_ERROR(fs::file_size(Twine(File1), File1Size));
58 ASSERT_EQ(File1Size, 8192ULL);
59
60 // TEST 2: Verify abort case.
61 SmallString<128> File2(TestDirectory);
62 File2.append("/file2");
63 {
64 OwningPtr<FileOutputBuffer> Buffer2;
65 ASSERT_NO_ERROR(FileOutputBuffer::create(File2, 8192, Buffer2));
66 // Fill buffer with special header.
67 memcpy(Buffer2->getBufferStart(), "AABBCCDDEEFFGGHHIIJJ", 20);
68 // Do *not* commit buffer.
69 }
70 // Verify file does not exist (because buffer not commited).
71 bool Exists = false;
72 ASSERT_NO_ERROR(fs::exists(Twine(File2), Exists));
73 EXPECT_FALSE(Exists);
74
75 // TEST 3: Verify sizing down case.
76 SmallString<128> File3(TestDirectory);
77 File3.append("/file3");
78 {
79 OwningPtr<FileOutputBuffer> Buffer;
80 ASSERT_NO_ERROR(FileOutputBuffer::create(File3, 8192000, Buffer));
81 // Start buffer with special header.
82 memcpy(Buffer->getBufferStart(), "AABBCCDDEEFFGGHHIIJJ", 20);
83 // Write to end of buffer to verify it is writable.
84 memcpy(Buffer->getBufferEnd() - 20, "AABBCCDDEEFFGGHHIIJJ", 20);
85 // Commit buffer, but size down to smaller size
86 ASSERT_NO_ERROR(Buffer->commit(5000));
87 }
88 // Verify file exists and starts with special header.
89 bool MagicMatches3 = false;
90 ASSERT_NO_ERROR(fs::has_magic(Twine(File3), Twine("AABBCCDDEEFFGGHHIIJJ"),
91 MagicMatches3));
92 EXPECT_TRUE(MagicMatches3);
93 // Verify file is correct size.
94 uint64_t File3Size;
95 ASSERT_NO_ERROR(fs::file_size(Twine(File3), File3Size));
96 ASSERT_EQ(File3Size, 5000ULL);
97
98 // TEST 4: Verify file can be made executable.
99 SmallString<128> File4(TestDirectory);
100 File4.append("/file4");
101 {
102 OwningPtr<FileOutputBuffer> Buffer;
103 ASSERT_NO_ERROR(FileOutputBuffer::create(File4, 8192, Buffer,
104 FileOutputBuffer::F_executable));
105 // Start buffer with special header.
106 memcpy(Buffer->getBufferStart(), "AABBCCDDEEFFGGHHIIJJ", 20);
107 // Commit buffer.
108 ASSERT_NO_ERROR(Buffer->commit());
109 }
110 // Verify file exists and is executable.
111 fs::file_status Status;
112 ASSERT_NO_ERROR(fs::status(Twine(File4), Status));
113 bool IsExecutable = (Status.permissions() & fs::owner_exe);
114 EXPECT_TRUE(IsExecutable);
115
116 // Clean up.
117 uint32_t RemovedCount;
118 ASSERT_NO_ERROR(fs::remove_all(TestDirectory.str(), RemovedCount));
119 }
120 } // anonymous namespace
121