1 //===- llvm/unittest/Support/FileOutputBuffer.cpp - unit tests ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Support/Errc.h"
11 #include "llvm/Support/ErrorHandling.h"
12 #include "llvm/Support/FileOutputBuffer.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"
19 using namespace llvm::sys;
21 #define ASSERT_NO_ERROR(x) \
22 if (std::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"; \
30 TEST(FileOutputBuffer, Test) {
31 // Create unique temporary directory for these tests
32 SmallString<128> TestDirectory;
35 fs::createUniqueDirectory("FileOutputBuffer-test", TestDirectory));
38 // TEST 1: Verify commit case.
39 SmallString<128> File1(TestDirectory);
40 File1.append("/file1");
42 std::unique_ptr<FileOutputBuffer> Buffer;
43 ASSERT_NO_ERROR(FileOutputBuffer::create(File1, 8192, Buffer));
44 // Start buffer with special header.
45 memcpy(Buffer->getBufferStart(), "AABBCCDDEEFFGGHHIIJJ", 20);
46 // Write to end of buffer to verify it is writable.
47 memcpy(Buffer->getBufferEnd() - 20, "AABBCCDDEEFFGGHHIIJJ", 20);
49 ASSERT_NO_ERROR(Buffer->commit());
52 // Verify file is correct size.
54 ASSERT_NO_ERROR(fs::file_size(Twine(File1), File1Size));
55 ASSERT_EQ(File1Size, 8192ULL);
56 ASSERT_NO_ERROR(fs::remove(File1.str()));
58 // TEST 2: Verify abort case.
59 SmallString<128> File2(TestDirectory);
60 File2.append("/file2");
62 std::unique_ptr<FileOutputBuffer> Buffer2;
63 ASSERT_NO_ERROR(FileOutputBuffer::create(File2, 8192, Buffer2));
64 // Fill buffer with special header.
65 memcpy(Buffer2->getBufferStart(), "AABBCCDDEEFFGGHHIIJJ", 20);
66 // Do *not* commit buffer.
68 // Verify file does not exist (because buffer not committed).
69 ASSERT_EQ(fs::access(Twine(File2), fs::AccessMode::Exist),
70 errc::no_such_file_or_directory);
71 ASSERT_NO_ERROR(fs::remove(File2.str()));
73 // TEST 3: Verify sizing down case.
74 SmallString<128> File3(TestDirectory);
75 File3.append("/file3");
77 std::unique_ptr<FileOutputBuffer> Buffer;
78 ASSERT_NO_ERROR(FileOutputBuffer::create(File3, 8192000, Buffer));
79 // Start buffer with special header.
80 memcpy(Buffer->getBufferStart(), "AABBCCDDEEFFGGHHIIJJ", 20);
81 // Write to end of buffer to verify it is writable.
82 memcpy(Buffer->getBufferEnd() - 20, "AABBCCDDEEFFGGHHIIJJ", 20);
83 ASSERT_NO_ERROR(Buffer->commit());
86 // Verify file is correct size.
88 ASSERT_NO_ERROR(fs::file_size(Twine(File3), File3Size));
89 ASSERT_EQ(File3Size, 8192000ULL);
90 ASSERT_NO_ERROR(fs::remove(File3.str()));
92 // TEST 4: Verify file can be made executable.
93 SmallString<128> File4(TestDirectory);
94 File4.append("/file4");
96 std::unique_ptr<FileOutputBuffer> Buffer;
97 ASSERT_NO_ERROR(FileOutputBuffer::create(File4, 8192, Buffer,
98 FileOutputBuffer::F_executable));
99 // Start buffer with special header.
100 memcpy(Buffer->getBufferStart(), "AABBCCDDEEFFGGHHIIJJ", 20);
102 ASSERT_NO_ERROR(Buffer->commit());
104 // Verify file exists and is executable.
105 fs::file_status Status;
106 ASSERT_NO_ERROR(fs::status(Twine(File4), Status));
107 bool IsExecutable = (Status.permissions() & fs::owner_exe);
108 EXPECT_TRUE(IsExecutable);
109 ASSERT_NO_ERROR(fs::remove(File4.str()));
112 ASSERT_NO_ERROR(fs::remove(TestDirectory.str()));
114 } // anonymous namespace