20283898778

Committed 16 Dec 2025 09:52PM UTC coverage: 90.52% (+0.2%) from 90.36%

Build # 20283898778

Build Type

Pull #5167

github

Committed by

web-flow

Commit Message

Merge 795a38954 into 3d96b675e

Pull Request Pull Request #5167: Changes to reduce unnecessary inclusions

Run Details

101154 of 111748 relevant lines covered (90.52%)

12682929.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.32

/src/tests/test_compression.cpp

/*
* (C) 2015 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include "tests.h"

#if defined(BOTAN_HAS_COMPRESSION)
   #include <botan/compression.h>
   #include <botan/rng.h>
#endif

namespace Botan_Tests {

#if defined(BOTAN_HAS_COMPRESSION)

namespace {

const char* const COMPRESSION_TEST_TEXT =
   "'Twas brillig, and the slithy toves"
   "Did gyre and gimble in the wabe:"
   "All mimsy were the borogoves,"
   "And the mome raths outgrabe."

   "'Beware the Jabberwock, my son!"
   "The jaws that bite, the claws that catch!"
   "Beware the Jubjub bird, and shun"
   "The frumious Bandersnatch!'"

   "He took his vorpal sword in hand;"
   "Long time the manxome foe he sought-"
   "So rested he by the Tumtum tree"
   "And stood awhile in thought."

   "And, as in uffish thought he stood,"
   "The Jabberwock, with eyes of flame,"
   "Came whiffling through the tulgey wood,"
   "And burbled as it came!"

   "One, two! One, two! And through and through"
   "The vorpal blade went snicker-snack!"
   "He left it dead, and with its head"
   "He went galumphing back."

   "'And hast thou slain the Jabberwock?"
   "Come to my arms, my beamish boy!"
   "O frabjous day! Callooh! Callay!'"
   "He chortled in his joy."

   "'Twas brillig, and the slithy toves"
   "Did gyre and gimble in the wabe:"
   "All mimsy were the borogoves,"
   "And the mome raths outgrabe.";

class Compression_Tests final : public Test {
   public:
      std::vector<Test::Result> run() override {
         std::vector<Test::Result> results;
         const size_t text_len = std::strlen(COMPRESSION_TEST_TEXT);

         for(const std::string algo : {"zlib", "deflate", "gzip", "bz2", "lzma"}) {
            try {
               Test::Result result(algo + " compression");

               result.start_timer();

               auto c = Botan::Compression_Algorithm::create(algo);
               auto d = Botan::Decompression_Algorithm::create(algo);

               if(!c || !d) {
                  result.note_missing(algo);
                  continue;
               }

               result.test_ne("Not the same name", c->name(), d->name());

               const Botan::secure_vector<uint8_t> empty;
               const Botan::secure_vector<uint8_t> all_zeros(text_len, 0);
               const Botan::secure_vector<uint8_t> random_binary = this->rng().random_vec(text_len);
               const Botan::secure_vector<uint8_t> short_text = {'f', 'o', 'o', '\n'};

               const uint8_t* textb = reinterpret_cast<const uint8_t*>(COMPRESSION_TEST_TEXT);
               const Botan::secure_vector<uint8_t> text(textb, textb + text_len);

               const size_t c1_e = run_compression(result, 1, *c, *d, empty);
               const size_t c9_e = run_compression(result, 9, *c, *d, empty);
               const size_t c1_z = run_compression(result, 1, *c, *d, all_zeros);
               const size_t c9_z = run_compression(result, 9, *c, *d, all_zeros);
               const size_t c1_r = run_compression(result, 1, *c, *d, random_binary);
               const size_t c9_r = run_compression(result, 9, *c, *d, random_binary);
               const size_t c1_t = run_compression(result, 1, *c, *d, text);
               const size_t c9_t = run_compression(result, 9, *c, *d, text);
               const size_t c1_s = run_compression(result, 1, *c, *d, short_text);
               const size_t c9_s = run_compression(result, 9, *c, *d, short_text);

               result.test_gte("Empty input L1 compresses to non-empty output", c1_e, 1);
               result.test_gte("Empty input L9 compresses to non-empty output", c9_e, 1);

               // We assume that Level 9 is better than Level 1, but this is not
               // guaranteed (see GitHub #3896). Hence, we assert that level 9
               // it is at most 10% worse than level 1.
               result.test_gte("Level 9 compresses empty at least as well as level 1", c1_e + (c1_e / 10), c9_e);
               result.test_gte("Level 9 compresses zeros at least as well as level 1", c1_z + (c1_z / 10), c9_z);
               result.test_gte("Level 9 compresses random at least as well as level 1", c1_r + (c1_r / 10), c9_r);
               result.test_gte("Level 9 compresses text at least as well as level 1", c1_t + (c1_t / 10), c9_t);
               result.test_gte("Level 9 compresses short text at least as well as level 1", c1_s + (c1_s / 10), c9_s);

               result.test_lt("Zeros compresses much better than text", c1_z / 8, c1_t);
               result.test_lt("Text compresses much better than random", c1_t / 2, c1_r);

               result.end_timer();

               results.emplace_back(result);
            } catch(std::exception& e) {
               results.emplace_back(Test::Result::Failure("testing " + algo, e.what()));
            }
         }

         return results;
      }

   private:
      // Returns # of bytes of compressed message
      size_t run_compression(Test::Result& result,
                             size_t level,
                             Botan::Compression_Algorithm& c,
                             Botan::Decompression_Algorithm& d,
                             const Botan::secure_vector<uint8_t>& msg) {
         Botan::secure_vector<uint8_t> compressed(2 * msg.size());

         for(const bool with_flush : {true, false}) {
            try {
               compressed = msg;

               c.start(level);
               c.update(compressed, 0, false);

               if(with_flush) {
                  Botan::secure_vector<uint8_t> flush_bits;
                  c.update(flush_bits, 0, true);
                  compressed += flush_bits;
               }

               Botan::secure_vector<uint8_t> final_bits;
               c.finish(final_bits);
               compressed += final_bits;

               Botan::secure_vector<uint8_t> decompressed = compressed;
               d.start();
               d.update(decompressed);

               Botan::secure_vector<uint8_t> final_outputs;
               d.finish(final_outputs);

               decompressed += final_outputs;

               result.test_eq("compression round tripped", msg, decompressed);
            } catch(Botan::Exception& e) {
               result.test_failure(e.what());
            }
         }

         return compressed.size();
      }
};

BOTAN_REGISTER_TEST("compression", "compression_tests", Compression_Tests);

class CompressionCreate_Tests final : public Test {
   public:
      std::vector<Test::Result> run() override {
         std::vector<Test::Result> results;

         for(const std::string algo : {"zlib", "deflate", "gzip", "bz2", "lzma"}) {
            try {
               Test::Result result(algo + " create compression");

               auto c1 = Botan::Compression_Algorithm::create(algo);
               auto d1 = Botan::Decompression_Algorithm::create(algo);

               if(!c1 || !d1) {
                  result.note_missing(algo);
                  continue;
               }
               result.test_ne("Not the same name after create", c1->name(), d1->name());

               auto c2 = Botan::Compression_Algorithm::create_or_throw(algo);
               auto d2 = Botan::Decompression_Algorithm::create_or_throw(algo);

               if(!c2 || !d2) {
                  result.note_missing(algo);
                  continue;
               }
               result.test_ne("Not the same name after create_or_throw", c2->name(), d2->name());

               results.emplace_back(result);
            } catch(std::exception& e) {
               results.emplace_back(Test::Result::Failure("testing " + algo, e.what()));
            }
         }

         {
            Test::Result result("create invalid compression");
            result.test_throws("lookup error", "Unavailable Compression bogocompress", [&]() {
               Botan::Compression_Algorithm::create_or_throw("bogocompress");
            });
            result.test_throws("lookup error", "Unavailable Decompression bogocompress", [&]() {
               Botan::Decompression_Algorithm::create_or_throw("bogocompress");
            });
            results.emplace_back(result);
         }

         return results;
      }
};

BOTAN_REGISTER_TEST("compression", "create_compression", CompressionCreate_Tests);

}  // namespace

#endif

}  // namespace Botan_Tests

1	/*
2	* (C) 2015 Jack Lloyd
3	*
4	* Botan is released under the Simplified BSD License (see license.txt)
5	*/
6
7	#include "tests.h"
8
9	#if defined(BOTAN_HAS_COMPRESSION)
10	#include <botan/compression.h>
11	#include <botan/rng.h>
12	#endif
13
14	namespace Botan_Tests {
15
16	#if defined(BOTAN_HAS_COMPRESSION)
17
18	namespace {
19
20	const char* const COMPRESSION_TEST_TEXT =
21	"'Twas brillig, and the slithy toves"
22	"Did gyre and gimble in the wabe:"
23	"All mimsy were the borogoves,"
24	"And the mome raths outgrabe."
25
26	"'Beware the Jabberwock, my son!"
27	"The jaws that bite, the claws that catch!"
28	"Beware the Jubjub bird, and shun"
29	"The frumious Bandersnatch!'"
30
31	"He took his vorpal sword in hand;"
32	"Long time the manxome foe he sought-"
33	"So rested he by the Tumtum tree"
34	"And stood awhile in thought."
35
36	"And, as in uffish thought he stood,"
37	"The Jabberwock, with eyes of flame,"
38	"Came whiffling through the tulgey wood,"
39	"And burbled as it came!"
40
41	"One, two! One, two! And through and through"
42	"The vorpal blade went snicker-snack!"
43	"He left it dead, and with its head"
44	"He went galumphing back."
45
46	"'And hast thou slain the Jabberwock?"
47	"Come to my arms, my beamish boy!"
48	"O frabjous day! Callooh! Callay!'"
49	"He chortled in his joy."
50
51	"'Twas brillig, and the slithy toves"
52	"Did gyre and gimble in the wabe:"
53	"All mimsy were the borogoves,"
54	"And the mome raths outgrabe.";
55
56	class Compression_Tests final : public Test {	1✔
57	public:
58	std::vector<Test::Result> run() override {	1✔
59	std::vector<Test::Result> results;	1✔
60	const size_t text_len = std::strlen(COMPRESSION_TEST_TEXT);	1✔
61
62	for(const std::string algo : {"zlib", "deflate", "gzip", "bz2", "lzma"}) {	6✔
63	try {	5✔
64	Test::Result result(algo + " compression");	5✔
65
66	result.start_timer();	5✔
67
68	auto c = Botan::Compression_Algorithm::create(algo);	5✔
69	auto d = Botan::Decompression_Algorithm::create(algo);	5✔
70
71	if(!c \|\| !d) {	5✔
72	result.note_missing(algo);	×
73	continue;	×
74	}
75
76	result.test_ne("Not the same name", c->name(), d->name());	10✔
77
78	const Botan::secure_vector<uint8_t> empty;	5✔
79	const Botan::secure_vector<uint8_t> all_zeros(text_len, 0);	5✔
80	const Botan::secure_vector<uint8_t> random_binary = this->rng().random_vec(text_len);	5✔
81	const Botan::secure_vector<uint8_t> short_text = {'f', 'o', 'o', '\n'};	5✔
82
83	const uint8_t* textb = reinterpret_cast<const uint8_t*>(COMPRESSION_TEST_TEXT);	5✔
84	const Botan::secure_vector<uint8_t> text(textb, textb + text_len);	5✔
85
86	const size_t c1_e = run_compression(result, 1, c, d, empty);	5✔
87	const size_t c9_e = run_compression(result, 9, c, d, empty);	5✔
88	const size_t c1_z = run_compression(result, 1, c, d, all_zeros);	5✔
89	const size_t c9_z = run_compression(result, 9, c, d, all_zeros);	5✔
90	const size_t c1_r = run_compression(result, 1, c, d, random_binary);	5✔
91	const size_t c9_r = run_compression(result, 9, c, d, random_binary);	5✔
92	const size_t c1_t = run_compression(result, 1, c, d, text);	5✔
93	const size_t c9_t = run_compression(result, 9, c, d, text);	5✔
94	const size_t c1_s = run_compression(result, 1, c, d, short_text);	5✔
95	const size_t c9_s = run_compression(result, 9, c, d, short_text);	5✔
96
97	result.test_gte("Empty input L1 compresses to non-empty output", c1_e, 1);	5✔
98	result.test_gte("Empty input L9 compresses to non-empty output", c9_e, 1);	5✔
99
100	// We assume that Level 9 is better than Level 1, but this is not
101	// guaranteed (see GitHub #3896). Hence, we assert that level 9
102	// it is at most 10% worse than level 1.
103	result.test_gte("Level 9 compresses empty at least as well as level 1", c1_e + (c1_e / 10), c9_e);	5✔
104	result.test_gte("Level 9 compresses zeros at least as well as level 1", c1_z + (c1_z / 10), c9_z);	5✔
105	result.test_gte("Level 9 compresses random at least as well as level 1", c1_r + (c1_r / 10), c9_r);	5✔
106	result.test_gte("Level 9 compresses text at least as well as level 1", c1_t + (c1_t / 10), c9_t);	5✔
107	result.test_gte("Level 9 compresses short text at least as well as level 1", c1_s + (c1_s / 10), c9_s);	5✔
108
109	result.test_lt("Zeros compresses much better than text", c1_z / 8, c1_t);	5✔
110	result.test_lt("Text compresses much better than random", c1_t / 2, c1_r);	5✔
111
112	result.end_timer();	5✔
113
114	results.emplace_back(result);	5✔
115	} catch(std::exception& e) {	30✔
116	results.emplace_back(Test::Result::Failure("testing " + algo, e.what()));	×
117	}	×
118	}	5✔
119
120	return results;	1✔
121	}	×
122
123	private:
124	// Returns # of bytes of compressed message
125	size_t run_compression(Test::Result& result,	50✔
126	size_t level,
127	Botan::Compression_Algorithm& c,
128	Botan::Decompression_Algorithm& d,
129	const Botan::secure_vector<uint8_t>& msg) {
130	Botan::secure_vector<uint8_t> compressed(2 * msg.size());	50✔
131
132	for(const bool with_flush : {true, false}) {	150✔
133	try {	100✔
134	compressed = msg;	100✔
135
136	c.start(level);	100✔
137	c.update(compressed, 0, false);	100✔
138
139	if(with_flush) {	100✔
140	Botan::secure_vector<uint8_t> flush_bits;	50✔
141	c.update(flush_bits, 0, true);	50✔
142	compressed += flush_bits;	50✔
143	}	50✔
144
145	Botan::secure_vector<uint8_t> final_bits;	100✔
146	c.finish(final_bits);	100✔
147	compressed += final_bits;	100✔
148
149	Botan::secure_vector<uint8_t> decompressed = compressed;	100✔
150	d.start();	100✔
151	d.update(decompressed);	100✔
152
153	Botan::secure_vector<uint8_t> final_outputs;	100✔
154	d.finish(final_outputs);	100✔
155
156	decompressed += final_outputs;	100✔
157
158	result.test_eq("compression round tripped", msg, decompressed);	200✔
159	} catch(Botan::Exception& e) {	300✔
160	result.test_failure(e.what());	×
161	}	×
162	}
163
164	return compressed.size();	50✔
165	}	50✔
166	};
167
168	BOTAN_REGISTER_TEST("compression", "compression_tests", Compression_Tests);
169
170	class CompressionCreate_Tests final : public Test {	1✔
171	public:
172	std::vector<Test::Result> run() override {	1✔
173	std::vector<Test::Result> results;	1✔
174
175	for(const std::string algo : {"zlib", "deflate", "gzip", "bz2", "lzma"}) {	6✔
176	try {	5✔
177	Test::Result result(algo + " create compression");	5✔
178
179	auto c1 = Botan::Compression_Algorithm::create(algo);	5✔
180	auto d1 = Botan::Decompression_Algorithm::create(algo);	5✔
181
182	if(!c1 \|\| !d1) {	5✔
183	result.note_missing(algo);	×
184	continue;	×
185	}
186	result.test_ne("Not the same name after create", c1->name(), d1->name());	10✔
187
188	auto c2 = Botan::Compression_Algorithm::create_or_throw(algo);	5✔
189	auto d2 = Botan::Decompression_Algorithm::create_or_throw(algo);	5✔
190
191	if(!c2 \|\| !d2) {	5✔
192	result.note_missing(algo);	×
193	continue;	×
194	}
195	result.test_ne("Not the same name after create_or_throw", c2->name(), d2->name());	10✔
196
197	results.emplace_back(result);	5✔
198	} catch(std::exception& e) {	20✔
199	results.emplace_back(Test::Result::Failure("testing " + algo, e.what()));	×
200	}	×
201	}	5✔
202
203	{	1✔
204	Test::Result result("create invalid compression");	1✔
205	result.test_throws("lookup error", "Unavailable Compression bogocompress", [&]() {	2✔
206	Botan::Compression_Algorithm::create_or_throw("bogocompress");	1✔
207	});	×
208	result.test_throws("lookup error", "Unavailable Decompression bogocompress", [&]() {	2✔
209	Botan::Decompression_Algorithm::create_or_throw("bogocompress");	1✔
210	});	×
211	results.emplace_back(result);	1✔
212	}	1✔
213
214	return results;	1✔
215	}	×
216	};
217
218	BOTAN_REGISTER_TEST("compression", "create_compression", CompressionCreate_Tests);
219
220	} // namespace
221
222	#endif
223
224	} // namespace Botan_Tests

randombit / botan / 20283898778

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous