1 /*****************************************************************************\
3 * Name : test_byte_filer *
4 * Author : Chris Koeritz *
6 *******************************************************************************
7 * Copyright (c) 1991-$now By Author. This program is free software; you can *
8 * redistribute it and/or modify it under the terms of the GNU General Public *
9 * License as published by the Free Software Foundation; either version 2 of *
10 * the License or (at your option) any later version. This is online at: *
11 * http://www.fsf.org/copyleft/gpl.html *
12 * Please send any updates to: fred@gruntose.com *
13 \*****************************************************************************/
15 #include <basis/byte_array.h>
16 #include <mathematics/chaos.h>
17 #include <basis/functions.h>
18 #include <basis/guards.h>
19 #include <basis/astring.h>
21 #include <application/hoople_main.h>
22 #include <configuration/application_configuration.h>
23 #include <filesystem/byte_filer.h>
24 #include <filesystem/directory.h>
25 #include <filesystem/filename.h>
26 #include <loggers/critical_events.h>
27 #include <loggers/program_wide_logger.h>
28 #include <mathematics/chaos.h>
29 #include <structures/checksums.h>
30 #include <structures/static_memory_gremlin.h>
31 #include <structures/string_array.h>
32 #include <unit_test/unit_base.h>
34 using namespace application;
35 using namespace basis;
36 using namespace configuration;
37 using namespace mathematics;
38 using namespace filesystem;
39 using namespace loggers;
40 using namespace structures;
41 using namespace textual;
42 using namespace timely;
43 using namespace unit_test;
45 #define LOG(s) CLASS_EMERGENCY_LOG(program_wide_logger::get(), s)
47 //#define DEBUG_BYTE_FILER
48 // uncomment for noisy test run.
50 class test_byte_filer : virtual public unit_base, virtual public application_shell
53 test_byte_filer() : application_shell() {}
54 DEFINE_CLASS_NAME("test_byte_filer");
55 int run_simple_test();
57 virtual int execute();
60 const astring &TEST_FILE()
62 const char *TEST_FILE_BASE = "/zz_garbage";
63 const char *TEST_FILE_SUFFIX = ".txt";
64 static astring __hidden_filename;
65 if (!__hidden_filename) {
66 __hidden_filename = environment::TMP();
67 if (!__hidden_filename) __hidden_filename = "/tmp";
68 // try to create it just in case it wasn't there already.
69 directory::make_directory(__hidden_filename);
70 __hidden_filename += TEST_FILE_BASE;
71 __hidden_filename += a_sprintf("%d", chaos().inclusive(0, 65535));
72 __hidden_filename += TEST_FILE_SUFFIX;
74 return __hidden_filename;
77 int test_byte_filer::run_simple_test()
79 FUNCDEF("run_simple_test");
80 #ifdef DEBUG_BYTE_FILER
81 LOG("ahoy, beginning file test...");
82 LOG(astring("test file is ") + TEST_FILE());
87 //hmmm: move to t_filename.
88 // test filename's exist operation.
89 byte_filer garbage(TEST_FILE().s(), "wb");
90 garbage.write("oy.\n");
92 filename test1(TEST_FILE());
93 ASSERT_TRUE(test1.exists(), "exists test file should exist");
94 filename test2("c:\\this_file_shouldNt_exist_ever.txt");
95 ASSERT_FALSE(test2.exists(), "weird file should not existed");
96 // test again to make sure it didn't create it.
97 ASSERT_FALSE(test2.exists(), "weird file should still not exist");
100 int block_size = randomizer.inclusive(3000, 30000);
101 #ifdef DEBUG_BYTE_FILER
102 LOG(a_sprintf("block size=%d", block_size));
104 abyte *original_block = new abyte[block_size];
105 for (int i = 0; i < block_size; i++)
106 original_block[i] = abyte(randomizer.inclusive(32, 126));
107 unsigned int original_checksum
108 = checksums::bizarre_checksum((abyte *)original_block, block_size);
109 if (original_checksum) {} // compiler quieting.
110 #ifdef DEBUG_BYTE_FILER
111 LOG(a_sprintf("random block checksum=%d", original_checksum));
114 byte_array to_stuff_in_file(block_size, original_block);
115 delete [] original_block;
116 byte_filer fred(TEST_FILE(), "w+");
117 fred.write(to_stuff_in_file);
119 #ifdef DEBUG_BYTE_FILER
120 LOG(astring("about to compare file to checksum"));
123 abyte *temp_array = new abyte[21309];
124 byte_array to_fake_stuff(21309, temp_array);
125 delete [] temp_array;
126 byte_filer fred(TEST_FILE(), "r");
127 #ifdef DEBUG_BYTE_FILER
128 LOG(astring("about to try writing to file"));
130 int should_be_failure = fred.write(to_fake_stuff);
131 ASSERT_EQUAL(should_be_failure, 0, "write on read only, should not succeed");
133 #ifdef DEBUG_BYTE_FILER
134 LOG(a_sprintf("about to try reading from file %d bytes", block_size * 2));
136 byte_array file_contents;
137 int bytes_read = fred.read(file_contents, block_size * 2);
138 ASSERT_EQUAL(bytes_read, block_size, "reading entire file should get proper size");
139 un_int check_2 = checksums::bizarre_checksum((abyte *)file_contents.access(), file_contents.length());
140 ASSERT_EQUAL((int)check_2, (int)original_checksum, "should read correct contents for checksum");
146 int numpacs = number_of_packets(block_size, FACTOR);
147 byte_filer fred(TEST_FILE(), "rb");
149 /// fred.chunk_factor(FACTOR);
151 for (int i = 0; i < numpacs; i++) {
153 int bytes_in = fred.read(blob_i, FACTOR);
154 ASSERT_FALSE(bytes_in > FACTOR, "we should never somehow read in more than we asked for");
155 whole_size += blob_i.length();
157 ASSERT_EQUAL(whole_size, fred.length(), "chunking comparison should see sizes as same");
160 // test writing out a copy and comparing them... there's no == on files!
162 ASSERT_TRUE(filename(TEST_FILE()).unlink(), "cleanup should be able to remove temporary file");
164 // it seems everything worked during our tests.
168 int test_byte_filer::run_file_scan()
170 FUNCDEF("run_file_scan");
173 string_array files(_global_argc, (const char **)_global_argv);
174 files.zap(0, 0); // toss the first element since that's our app filename.
176 if (!files.length()) {
177 // pretend they gave us the list of files in the current directory. some of
178 // these might fail if they're locked up.
179 astring tmpdir = application_configuration::current_directory();
180 directory dir(tmpdir);
181 for (int i = 0; i < dir.files().length(); i++) {
182 // skip text files since we use those right here.
183 if ( (dir.files()[i].ends(".txt")) || (dir.files()[i].ends(".txt")) )
185 astring chewed_string = tmpdir + "/" + dir.files()[i];
186 files += chewed_string;
188 //LOG(astring("added files since no cmd args: ") + files.text_form());
191 byte_array data_found;
192 for (int i = 0; i < files.length(); i++) {
193 astring curr = files[i];
194 // LOG(a_sprintf("file %d: ", i) + curr);
195 byte_filer test(curr, "rb");
197 LOG(astring("good check: ") + curr + " cannot be opened. is this bad?");
201 // check that we get the expected position report from scooting to the
203 test.seek(0, byte_filer::FROM_END);
204 ASSERT_EQUAL((int)test.tell(), (int)test.length(), "seek check should get to end as expected");
205 test.seek(0, byte_filer::FROM_START);
207 size_t len = test.length();
208 //log(a_sprintf("file len is %.0f", double(len)));
210 while ( (posn < len) && !test.eof() ) {
211 size_t readlen = randomizer.inclusive(1, 256 * KILOBYTE);
212 //log(a_sprintf("read %u bytes, posn now %d bytes", readlen, posn));
213 int bytes_read = int(test.read(data_found, int(readlen)));
214 ASSERT_TRUE(bytes_read >= 0, "reading should not fail to read some bytes");
215 if (bytes_read > 0) {
219 ASSERT_TRUE(test.eof(), "eof check should see us at eof");
220 ASSERT_EQUAL((int)posn, (int)len, "eof check should be at right position");
221 // log(astring("successfully read ") + curr);
227 int test_byte_filer::execute()
229 // FUNCDEF("execute");
230 int ret = run_simple_test();
231 if (ret) return ret; // failed.
232 ret = run_file_scan();
233 if (ret) return ret; // failed here.
235 return final_report();
238 HOOPLE_MAIN(test_byte_filer, )