1 // Copyright 2023 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 // https://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, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14
15 #include <algorithm>
16
17 #include "metrics.h"
18 #include "pw_fuzzer/fuzztest.h"
19 #include "pw_unit_test/framework.h"
20
21 namespace pw::fuzzer::examples {
22
23 // DOCSTAG: [pwfuzzer_examples_fuzztest-metrics_fuzztest1]
ArbitrarySerializeAndDeserialize(const Vector<Metric> & metrics)24 void ArbitrarySerializeAndDeserialize(const Vector<Metric>& metrics) {
25 std::array<std::byte, Metrics::kMaxSerializedSize> buffer;
26
27 // Add and copy the names only.
28 Metrics src, dst;
29 for (const auto& metric : metrics) {
30 EXPECT_TRUE(src.SetValue(metric.name, 0).ok());
31 }
32 EXPECT_TRUE(dst.SetMetrics(src.GetMetrics()).ok());
33
34 // Modify the values.
35 for (const auto& metric : metrics) {
36 EXPECT_TRUE(src.SetValue(metric.name, metric.value).ok());
37 }
38
39 // Transfer the data and check.
40 EXPECT_TRUE(src.Serialize(buffer).ok());
41 EXPECT_TRUE(dst.Deserialize(buffer).ok());
42 for (const auto& metric : metrics) {
43 EXPECT_EQ(dst.GetValue(metric.name).value_or(0), metric.value);
44 }
45 }
46
47 // This unit test will run on host and may run on target devices (if supported).
TEST(MetricsTest,SerializeAndDeserialize)48 TEST(MetricsTest, SerializeAndDeserialize) {
49 Vector<Metric, 3> metrics;
50 metrics.emplace_back("one", 1);
51 metrics.emplace_back("two", 2);
52 metrics.emplace_back("three", 3);
53 ArbitrarySerializeAndDeserialize(metrics);
54 }
55 // DOCSTAG: [pwfuzzer_examples_fuzztest-metrics_fuzztest1]
56
57 // DOCSTAG: [pwfuzzer_examples_fuzztest-metrics_fuzztest2]
ArbitraryMetric()58 auto ArbitraryMetric() {
59 return ConstructorOf<Metric>(PrintableAsciiString<Metric::kMaxNameLen>(),
60 Arbitrary<uint32_t>());
61 }
62
63 // This fuzz test will only run on host.
64 FUZZ_TEST(MetricsTest, ArbitrarySerializeAndDeserialize)
65 .WithDomains(VectorOf<Metrics::kMaxMetrics>(ArbitraryMetric()));
66 // DOCSTAG: [pwfuzzer_examples_fuzztest-metrics_fuzztest2]
67
68 // DOCSTAG: [pwfuzzer_examples_fuzztest-metrics_fuzztest3]
ArbitraryDeserialize(pw::ConstByteSpan buffer)69 void ArbitraryDeserialize(pw::ConstByteSpan buffer) {
70 // Just make sure this does not crash.
71 Metrics dst;
72 dst.Deserialize(buffer).IgnoreError();
73 }
74
75 // This unit test will run on host and may run on target devices (if supported).
TEST(MetricsTest,DeserializeDoesNotCrash)76 TEST(MetricsTest, DeserializeDoesNotCrash) {
77 ArbitraryDeserialize(std::vector<std::byte>(100, std::byte(0x5C)));
78 }
79 // DOCSTAG: [pwfuzzer_examples_fuzztest-metrics_fuzztest3]
80
81 // DOCSTAG: [pwfuzzer_examples_fuzztest-metrics_fuzztest4]
82 // This fuzz test will only run on host.
83 FUZZ_TEST(MetricsTest, ArbitraryDeserialize)
84 .WithDomains(VectorOf<Metrics::kMaxSerializedSize>(Arbitrary<std::byte>()));
85 // DOCSTAG: [pwfuzzer_examples_fuzztest-metrics_fuzztest4]
86
87 } // namespace pw::fuzzer::examples
88