1//
2// Copyright (C) 2009 The Android Open Source Project
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8//      http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15//
16
17#include "update_engine/payload_consumer/bzip_extent_writer.h"
18
19#include <fcntl.h>
20
21#include <algorithm>
22#include <string>
23#include <vector>
24
25#include <brillo/make_unique_ptr.h>
26#include <gtest/gtest.h>
27
28#include "update_engine/common/test_utils.h"
29#include "update_engine/common/utils.h"
30
31using std::min;
32using std::string;
33using std::vector;
34
35namespace chromeos_update_engine {
36
37namespace {
38const uint32_t kBlockSize = 4096;
39}
40
41class BzipExtentWriterTest : public ::testing::Test {
42 protected:
43  void SetUp() override {
44    fd_.reset(new EintrSafeFileDescriptor);
45    ASSERT_TRUE(fd_->Open(temp_file_.path().c_str(), O_RDWR, 0600));
46  }
47  void TearDown() override {
48    fd_->Close();
49  }
50  void WriteAlignedExtents(size_t chunk_size, size_t first_chunk_size);
51  void TestZeroPad(bool aligned_size);
52
53  FileDescriptorPtr fd_;
54  test_utils::ScopedTempFile temp_file_{"BzipExtentWriterTest-file.XXXXXX"};
55};
56
57TEST_F(BzipExtentWriterTest, SimpleTest) {
58  vector<Extent> extents;
59  Extent extent;
60  extent.set_start_block(0);
61  extent.set_num_blocks(1);
62  extents.push_back(extent);
63
64  // 'echo test | bzip2 | hexdump' yields:
65  static const char test_uncompressed[] = "test\n";
66  static const uint8_t test[] = {
67    0x42, 0x5a, 0x68, 0x39, 0x31, 0x41, 0x59, 0x26, 0x53, 0x59, 0xcc, 0xc3,
68    0x71, 0xd4, 0x00, 0x00, 0x02, 0x41, 0x80, 0x00, 0x10, 0x02, 0x00, 0x0c,
69    0x00, 0x20, 0x00, 0x21, 0x9a, 0x68, 0x33, 0x4d, 0x19, 0x97, 0x8b, 0xb9,
70    0x22, 0x9c, 0x28, 0x48, 0x66, 0x61, 0xb8, 0xea, 0x00,
71  };
72
73  BzipExtentWriter bzip_writer(
74      brillo::make_unique_ptr(new DirectExtentWriter()));
75  EXPECT_TRUE(bzip_writer.Init(fd_, extents, kBlockSize));
76  EXPECT_TRUE(bzip_writer.Write(test, sizeof(test)));
77  EXPECT_TRUE(bzip_writer.End());
78
79  brillo::Blob buf;
80  EXPECT_TRUE(utils::ReadFile(temp_file_.path(), &buf));
81  EXPECT_EQ(strlen(test_uncompressed), buf.size());
82  EXPECT_EQ(string(buf.begin(), buf.end()), string(test_uncompressed));
83}
84
85TEST_F(BzipExtentWriterTest, ChunkedTest) {
86  // Generated with:
87  //   yes "ABC" | head -c 819200 | bzip2 -9 |
88  //     hexdump -v -e '"      " 11/1 "0x%02x, " "\n"'
89  static const uint8_t kCompressedData[] = {
90      0x42, 0x5a, 0x68, 0x39, 0x31, 0x41, 0x59, 0x26, 0x53, 0x59, 0xbe,
91      0x1c, 0xda, 0xee, 0x03, 0x1f, 0xff, 0xc4, 0x00, 0x00, 0x10, 0x38,
92      0x00, 0x20, 0x00, 0x50, 0x66, 0x9a, 0x05, 0x28, 0x38, 0x00, 0x11,
93      0x60, 0x00, 0x22, 0xd0, 0x00, 0x45, 0xc0, 0x00, 0x8b, 0xc5, 0xdc,
94      0x91, 0x4e, 0x14, 0x24, 0x2f, 0x87, 0x36, 0xbb, 0x80};
95  brillo::Blob compressed_data(std::begin(kCompressedData),
96                               std::end(kCompressedData));
97
98  const brillo::Blob::size_type kDecompressedLength = 800 * 1024;  // 800 KiB
99  const size_t kChunkSize = 3;
100
101  brillo::Blob decompressed_data(kDecompressedLength);
102  for (size_t i = 0; i < decompressed_data.size(); ++i)
103    decompressed_data[i] = static_cast<uint8_t>("ABC\n"[i % 4]);
104
105  vector<Extent> extents;
106  Extent extent;
107  extent.set_start_block(0);
108  extent.set_num_blocks((kDecompressedLength + kBlockSize - 1) / kBlockSize);
109  extents.push_back(extent);
110
111  BzipExtentWriter bzip_writer(
112      brillo::make_unique_ptr(new DirectExtentWriter()));
113  EXPECT_TRUE(bzip_writer.Init(fd_, extents, kBlockSize));
114
115  brillo::Blob original_compressed_data = compressed_data;
116  for (brillo::Blob::size_type i = 0; i < compressed_data.size();
117       i += kChunkSize) {
118    size_t this_chunk_size = min(kChunkSize, compressed_data.size() - i);
119    EXPECT_TRUE(bzip_writer.Write(&compressed_data[i], this_chunk_size));
120  }
121  EXPECT_TRUE(bzip_writer.End());
122
123  // Check that the const input has not been clobbered.
124  test_utils::ExpectVectorsEq(original_compressed_data, compressed_data);
125
126  brillo::Blob output;
127  EXPECT_TRUE(utils::ReadFile(temp_file_.path(), &output));
128  EXPECT_EQ(kDecompressedLength, output.size());
129  test_utils::ExpectVectorsEq(decompressed_data, output);
130}
131
132}  // namespace chromeos_update_engine
133