1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
// Copyright 2021 The Pigweed Authors
//
// 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
//
// https://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.
#include "pw_stream/stream.h"
#include <limits>
#include "gtest/gtest.h"
#include "pw_stream/null_stream.h"
namespace pw::stream {
namespace {
static_assert(sizeof(Stream) <= 2 * sizeof(void*),
"Stream should be no larger than two pointers (vtable pointer & "
"packed members)");
class TestNonSeekableReader : public NonSeekableReader {
private:
StatusWithSize DoRead(ByteSpan) override { return StatusWithSize(0); }
};
class TestRelativeSeekableReader : public RelativeSeekableReader {
private:
StatusWithSize DoRead(ByteSpan) override { return StatusWithSize(0); }
Status DoSeek(ptrdiff_t, Whence) override { return Status(); }
};
class TestSeekableReader : public SeekableReader {
private:
StatusWithSize DoRead(ByteSpan) override { return StatusWithSize(0); }
Status DoSeek(ptrdiff_t, Whence) override { return Status(); }
};
class TestNonSeekableWriter : public NonSeekableWriter {
private:
Status DoWrite(ConstByteSpan) override { return OkStatus(); }
};
class TestRelativeSeekableWriter : public RelativeSeekableWriter {
private:
Status DoWrite(ConstByteSpan) override { return OkStatus(); }
Status DoSeek(ptrdiff_t, Whence) override { return OkStatus(); }
};
class TestSeekableWriter : public SeekableWriter {
private:
Status DoWrite(ConstByteSpan) override { return OkStatus(); }
Status DoSeek(ptrdiff_t, Whence) override { return OkStatus(); }
};
class TestNonSeekableReaderWriter : public NonSeekableReaderWriter {
private:
StatusWithSize DoRead(ByteSpan) override { return StatusWithSize(0); }
Status DoWrite(ConstByteSpan) override { return OkStatus(); }
};
class TestRelativeSeekableReaderWriter : public RelativeSeekableReaderWriter {
private:
StatusWithSize DoRead(ByteSpan) override { return StatusWithSize(0); }
Status DoWrite(ConstByteSpan) override { return OkStatus(); }
Status DoSeek(ptrdiff_t, Whence) override { return OkStatus(); }
};
class TestSeekableReaderWriter : public SeekableReaderWriter {
private:
StatusWithSize DoRead(ByteSpan) override { return StatusWithSize(0); }
Status DoWrite(ConstByteSpan) override { return OkStatus(); }
Status DoSeek(ptrdiff_t, Whence) override { return OkStatus(); }
};
// Test ReaderWriter conversions to Reader/Writer.
// clang-format off
static_assert(std::is_convertible<TestNonSeekableReaderWriter, Reader&>());
static_assert(std::is_convertible<TestNonSeekableReaderWriter, Writer&>());
static_assert(!std::is_convertible<TestNonSeekableReaderWriter, RelativeSeekableReader&>());
static_assert(!std::is_convertible<TestNonSeekableReaderWriter, RelativeSeekableWriter&>());
static_assert(!std::is_convertible<TestNonSeekableReaderWriter, SeekableWriter&>());
static_assert(!std::is_convertible<TestNonSeekableReaderWriter, SeekableReader&>());
static_assert(std::is_convertible<TestRelativeSeekableReaderWriter, Reader&>());
static_assert(std::is_convertible<TestRelativeSeekableReaderWriter, Writer&>());
static_assert(std::is_convertible<TestRelativeSeekableReaderWriter, RelativeSeekableReader&>());
static_assert(std::is_convertible<TestRelativeSeekableReaderWriter, RelativeSeekableWriter&>());
static_assert(!std::is_convertible<TestRelativeSeekableReaderWriter, SeekableWriter&>());
static_assert(!std::is_convertible<TestRelativeSeekableReaderWriter, SeekableReader&>());
static_assert(std::is_convertible<TestSeekableReaderWriter, Reader&>());
static_assert(std::is_convertible<TestSeekableReaderWriter, Writer&>());
static_assert(std::is_convertible<TestSeekableReaderWriter, RelativeSeekableReader&>());
static_assert(std::is_convertible<TestSeekableReaderWriter, RelativeSeekableWriter&>());
static_assert(std::is_convertible<TestSeekableReaderWriter, SeekableWriter&>());
static_assert(std::is_convertible<TestSeekableReaderWriter, SeekableReader&>());
// clang-format on
constexpr uint8_t kSeekable =
Stream::kBeginning | Stream::kCurrent | Stream::kEnd;
constexpr uint8_t kRelativeSeekable = Stream::kCurrent;
constexpr uint8_t kNonSeekable = 0;
enum Readable : bool { kNonReadable = false, kReadable = true };
enum Writable : bool { kNonWritable = false, kWritable = true };
template <typename T, Readable readable, Writable writable, uint8_t seekable>
void TestStreamImpl() {
T derived_stream;
Stream& stream = derived_stream;
// Check stream properties
ASSERT_EQ(writable, stream.writable());
ASSERT_EQ(readable, stream.readable());
ASSERT_EQ((seekable & Stream::kBeginning) != 0,
stream.seekable(Stream::kBeginning));
ASSERT_EQ((seekable & Stream::kCurrent) != 0,
stream.seekable(Stream::kCurrent));
ASSERT_EQ((seekable & Stream::kEnd) != 0, stream.seekable(Stream::kEnd));
ASSERT_EQ(seekable != kNonSeekable, stream.seekable());
// Check Read()/Write()/Seek()
ASSERT_EQ(readable ? OkStatus() : Status::Unimplemented(),
stream.Read({}).status());
ASSERT_EQ(writable ? OkStatus() : Status::Unimplemented(), stream.Write({}));
ASSERT_EQ(seekable ? OkStatus() : Status::Unimplemented(), stream.Seek(0));
// Check ConservativeLimits()
ASSERT_EQ(readable ? Stream::kUnlimited : 0, stream.ConservativeReadLimit());
ASSERT_EQ(writable ? Stream::kUnlimited : 0, stream.ConservativeWriteLimit());
}
TEST(Stream, NonSeekableReader) {
TestStreamImpl<TestNonSeekableReader,
kReadable,
kNonWritable,
kNonSeekable>();
}
TEST(Stream, RelativeSeekableReader) {
TestStreamImpl<TestRelativeSeekableReader,
kReadable,
kNonWritable,
kRelativeSeekable>();
}
TEST(Stream, SeekableReader) {
TestStreamImpl<TestSeekableReader, kReadable, kNonWritable, kSeekable>();
}
TEST(Stream, NonSeekableWriter) {
TestStreamImpl<TestNonSeekableWriter,
kNonReadable,
kWritable,
kNonSeekable>();
}
TEST(Stream, RelativeSeekableWriter) {
TestStreamImpl<TestRelativeSeekableWriter,
kNonReadable,
kWritable,
kRelativeSeekable>();
}
TEST(Stream, SeekableWriter) {
TestStreamImpl<TestSeekableWriter, kNonReadable, kWritable, kSeekable>();
}
TEST(Stream, NonSeekableReaderWriter) {
TestStreamImpl<TestNonSeekableReaderWriter,
kReadable,
kWritable,
kNonSeekable>();
}
TEST(Stream, RelativeSeekableReaderWriter) {
TestStreamImpl<TestRelativeSeekableReaderWriter,
kReadable,
kWritable,
kRelativeSeekable>();
}
TEST(Stream, SeekableReaderWriter) {
TestStreamImpl<TestSeekableReaderWriter, kReadable, kWritable, kSeekable>();
}
TEST(NullStream, DefaultConservativeWriteLimit) {
NullStream stream;
EXPECT_EQ(stream.ConservativeWriteLimit(), Stream::kUnlimited);
}
TEST(NullStream, DefaultConservativeReadLimit) {
NullStream stream;
EXPECT_EQ(stream.ConservativeReadLimit(), Stream::kUnlimited);
}
TEST(NullStream, DefaultConservativeReadWriteLimit) {
NullStream stream;
EXPECT_EQ(stream.ConservativeWriteLimit(), Stream::kUnlimited);
EXPECT_EQ(stream.ConservativeReadLimit(), Stream::kUnlimited);
}
TEST(NullStream, DefaultTell) {
NullStream stream;
EXPECT_EQ(stream.Tell(), Stream::kUnknownPosition);
}
} // namespace
} // namespace pw::stream
|
