[apt.git] / test / libapt / fileutl_test.cc

#include <config.h>

#include <apt-pkg/error.h>
#include <apt-pkg/fileutl.h>
#include <apt-pkg/strutl.h>
#include <apt-pkg/aptconfiguration.h>

#include <string>
#include <vector>
#include <stdlib.h>
#include <string.h>

#include <gtest/gtest.h>

#include "file-helpers.h"

static void TestFileFd(mode_t const a_umask, mode_t const ExpectedFilePermission,
      unsigned int const filemode, APT::Configuration::Compressor const &compressor)
{
   std::string trace;
   strprintf(trace, "TestFileFd: Compressor: %s umask: %#o permission: %#o mode: %d", compressor.Name.c_str(), a_umask, ExpectedFilePermission, filemode);
   SCOPED_TRACE(trace);

   static const char* fname = "apt-filefd-test.txt";
   if (FileExists(fname) == true)
      EXPECT_EQ(0, unlink(fname));

   FileFd f;
   umask(a_umask);
   EXPECT_TRUE(f.Open(fname, filemode, compressor));
   EXPECT_TRUE(f.IsOpen());
   EXPECT_FALSE(f.Failed());
   EXPECT_EQ(umask(a_umask), a_umask);

   std::string test = "This is a test!\n";
   EXPECT_TRUE(f.Write(test.c_str(), test.size()));
   EXPECT_TRUE(f.IsOpen());
   EXPECT_FALSE(f.Failed());

   f.Close();
   EXPECT_FALSE(f.IsOpen());
   EXPECT_FALSE(f.Failed());

   EXPECT_TRUE(f.Open(fname, FileFd::ReadOnly, compressor));
   EXPECT_TRUE(f.IsOpen());
   EXPECT_FALSE(f.Failed());
   EXPECT_FALSE(f.Eof());
   EXPECT_NE(0, f.FileSize());
   EXPECT_FALSE(f.Failed());
   EXPECT_NE(0, f.ModificationTime());
   EXPECT_FALSE(f.Failed());

   // ensure the memory is as predictably messed up
#define APT_INIT_READBACK \
   char readback[20]; \
   memset(readback, 'D', sizeof(readback)/sizeof(readback[0])); \
   readback[19] = '\0';
#define EXPECT_N_STR(expect, actual) \
   EXPECT_EQ(0, strncmp(expect, actual, strlen(expect)));

   {
      APT_INIT_READBACK
      char const * const expect = "This";
      EXPECT_TRUE(f.Read(readback, strlen(expect)));
      EXPECT_FALSE(f.Failed());
      EXPECT_FALSE(f.Eof());
      EXPECT_N_STR(expect, readback);
      EXPECT_EQ(strlen(expect), f.Tell());
   }
   {
      APT_INIT_READBACK
      char const * const expect = "test!\n";
      EXPECT_TRUE(f.Skip((test.size() - f.Tell()) - strlen(expect)));
      EXPECT_TRUE(f.Read(readback, strlen(expect)));
      EXPECT_FALSE(f.Failed());
      EXPECT_FALSE(f.Eof());
      EXPECT_N_STR(expect, readback);
      EXPECT_EQ(test.size(), f.Tell());
   }
   {
      APT_INIT_READBACK
      EXPECT_TRUE(f.Seek(0));
      EXPECT_FALSE(f.Eof());
      EXPECT_TRUE(f.Read(readback, 20, true));
      EXPECT_FALSE(f.Failed());
      EXPECT_TRUE(f.Eof());
      EXPECT_N_STR(test.c_str(), readback);
      EXPECT_EQ(f.Size(), f.Tell());
   }
   {
      APT_INIT_READBACK
      EXPECT_TRUE(f.Seek(0));
      EXPECT_FALSE(f.Eof());
      EXPECT_TRUE(f.Read(readback, test.size(), true));
      EXPECT_FALSE(f.Failed());
      EXPECT_FALSE(f.Eof());
      EXPECT_N_STR(test.c_str(), readback);
      EXPECT_EQ(f.Size(), f.Tell());
   }
   {
      APT_INIT_READBACK
      EXPECT_TRUE(f.Seek(0));
      EXPECT_FALSE(f.Eof());
      unsigned long long actual;
      EXPECT_TRUE(f.Read(readback, 20, &actual));
      EXPECT_FALSE(f.Failed());
      EXPECT_TRUE(f.Eof());
      EXPECT_EQ(test.size(), actual);
      EXPECT_N_STR(test.c_str(), readback);
      EXPECT_EQ(f.Size(), f.Tell());
   }
   {
      APT_INIT_READBACK
      EXPECT_TRUE(f.Seek(0));
      EXPECT_FALSE(f.Eof());
      f.ReadLine(readback, 20);
      EXPECT_FALSE(f.Failed());
      EXPECT_FALSE(f.Eof());
      EXPECT_EQ(test, readback);
      EXPECT_EQ(f.Size(), f.Tell());
   }
   {
      APT_INIT_READBACK
      EXPECT_TRUE(f.Seek(0));
      EXPECT_FALSE(f.Eof());
      char const * const expect = "This";
      f.ReadLine(readback, strlen(expect) + 1);
      EXPECT_FALSE(f.Failed());
      EXPECT_FALSE(f.Eof());
      EXPECT_N_STR(expect, readback);
      EXPECT_EQ(strlen(expect), f.Tell());
   }
#undef APT_INIT_READBACK

   f.Close();
   EXPECT_FALSE(f.IsOpen());
   EXPECT_FALSE(f.Failed());

   // regression test for permission bug LP: #1304657
   struct stat buf;
   EXPECT_EQ(0, stat(fname, &buf));
   EXPECT_EQ(0, unlink(fname));
   EXPECT_EQ(ExpectedFilePermission, buf.st_mode & 0777);
}

static void TestFileFd(unsigned int const filemode)
{
   std::vector<APT::Configuration::Compressor> compressors = APT::Configuration::getCompressors();

   // testing the (un)compress via pipe, as the 'real' compressors are usually built in via libraries
   compressors.push_back(APT::Configuration::Compressor("rev", ".reversed", "rev", NULL, NULL, 42));
   //compressors.push_back(APT::Configuration::Compressor("cat", ".ident", "cat", NULL, NULL, 42));

   for (std::vector<APT::Configuration::Compressor>::const_iterator c = compressors.begin(); c != compressors.end(); ++c)
   {
      if ((filemode & FileFd::ReadWrite) == FileFd::ReadWrite &&
	    (c->Name.empty() != true && c->Binary.empty() != true))
	 continue;
      TestFileFd(0002, 0664, filemode, *c);
      TestFileFd(0022, 0644, filemode, *c);
      TestFileFd(0077, 0600, filemode, *c);
      TestFileFd(0026, 0640, filemode, *c);
   }
}

TEST(FileUtlTest, FileFD)
{
   std::string const startdir = SafeGetCWD();
   EXPECT_FALSE(startdir.empty());
   std::string tempdir;
   createTemporaryDirectory("filefd", tempdir);
   EXPECT_EQ(0, chdir(tempdir.c_str()));

   TestFileFd(FileFd::WriteOnly | FileFd::Create);
   TestFileFd(FileFd::WriteOnly | FileFd::Create | FileFd::Empty);
   TestFileFd(FileFd::WriteOnly | FileFd::Create | FileFd::Exclusive);
   TestFileFd(FileFd::WriteOnly | FileFd::Atomic);
   TestFileFd(FileFd::WriteOnly | FileFd::Create | FileFd::Atomic);
   // short-hands for ReadWrite with these modes
   TestFileFd(FileFd::WriteEmpty);
   TestFileFd(FileFd::WriteAny);
   TestFileFd(FileFd::WriteTemp);
   TestFileFd(FileFd::WriteAtomic);

   EXPECT_EQ(0, chdir(startdir.c_str()));
   removeDirectory(tempdir);
}
TEST(FileUtlTest, Glob)
{
   std::vector<std::string> files;
   // normal match
   files = Glob("*akefile");
   EXPECT_EQ(1, files.size());

   // not there
   files = Glob("xxxyyyzzz");
   EXPECT_TRUE(files.empty());
   EXPECT_FALSE(_error->PendingError());

   // many matches (number is a bit random)
   files = Glob("*.cc");
   EXPECT_LT(10, files.size());
}
TEST(FileUtlTest, GetTempDir)
{
   char const * const envtmp = getenv("TMPDIR");
   std::string old_tmpdir;
   if (envtmp != NULL)
      old_tmpdir = envtmp;

   unsetenv("TMPDIR");
   EXPECT_EQ("/tmp", GetTempDir());

   setenv("TMPDIR", "", 1);
   EXPECT_EQ("/tmp", GetTempDir());

   setenv("TMPDIR", "/not-there-no-really-not", 1);
   EXPECT_EQ("/tmp", GetTempDir());

   setenv("TMPDIR", "/usr", 1);
   EXPECT_EQ("/usr", GetTempDir());

   unsetenv("TMPDIR");
   if (old_tmpdir.empty() == false)
      setenv("TMPDIR", old_tmpdir.c_str(), 1);
}

TEST(FileUtlTest, Popen)
{
   FileFd Fd;
   pid_t Child;
   char buf[1024];
   std::string s;
   unsigned long long n = 0;
   std::vector<std::string> OpenFds;

   // count Fds to ensure we don't have a resource leak
   if(FileExists("/proc/self/fd"))
      OpenFds = Glob("/proc/self/fd/*");

   // output something
   const char* Args[10] = {"/bin/echo", "meepmeep", NULL};
   bool res = Popen(Args, Fd, Child, FileFd::ReadOnly);
   Fd.Read(buf, sizeof(buf)-1, &n);
   buf[n] = 0;
   EXPECT_NE(n, 0);
   EXPECT_EQ(res, true);
   EXPECT_STREQ(buf, "meepmeep\n");

   // wait for the child to exit and cleanup
   ExecWait(Child, "PopenRead");
   Fd.Close();

   // ensure that after a close all is good again
   if(FileExists("/proc/self/fd"))
      EXPECT_EQ(Glob("/proc/self/fd/*").size(), OpenFds.size());


   // ReadWrite is not supported
   res = Popen(Args, Fd, Child, FileFd::ReadWrite);
   EXPECT_EQ(res, false);
   _error->Discard();

   // write something
   Args[0] = "/bin/bash";
   Args[1] = "-c";
   Args[2] = "read";
   Args[3] = NULL;
   res = Popen(Args, Fd, Child, FileFd::WriteOnly);
   s = "\n";
   Fd.Write(s.c_str(), s.size());
   Fd.Close();
   ExecWait(Child, "PopenWrite");
}
Commit	Line	Data
453b82a3 DK	1	#include <config.h>
453b82a3 DK	2
488011fa MV	3	#include <apt-pkg/error.h>
488011fa MV	4	#include <apt-pkg/fileutl.h>
f00832cc	5	#include <apt-pkg/strutl.h>
f7feb041	6	#include <apt-pkg/aptconfiguration.h>
488011fa	7
488011fa MV	8	#include <string>
488011fa MV	9	#include <vector>
488011fa	10	#include <stdlib.h>
f7feb041	11	#include <string.h>
488011fa	12
f00832cc	13	#include <gtest/gtest.h>
488011fa	14
f00832cc	15	#include "file-helpers.h"
f7feb041	16
f00832cc DK	17	static void TestFileFd(mode_t const a_umask, mode_t const ExpectedFilePermission,
f00832cc DK	18	unsigned int const filemode, APT::Configuration::Compressor const &compressor)
f22b65b4	19	{
f00832cc DK	20	std::string trace;
	21	strprintf(trace, "TestFileFd: Compressor: %s umask: %#o permission: %#o mode: %d", compressor.Name.c_str(), a_umask, ExpectedFilePermission, filemode);
	22	SCOPED_TRACE(trace);
	23
bb93178b DK	24	static const char* fname = "apt-filefd-test.txt";
bb93178b DK	25	if (FileExists(fname) == true)
f00832cc	26	EXPECT_EQ(0, unlink(fname));
f22b65b4	27
f00832cc	28	FileFd f;
f22b65b4	29	umask(a_umask);
f00832cc DK	30	EXPECT_TRUE(f.Open(fname, filemode, compressor));
	31	EXPECT_TRUE(f.IsOpen());
	32	EXPECT_FALSE(f.Failed());
	33	EXPECT_EQ(umask(a_umask), a_umask);
f7feb041	34
bb93178b	35	std::string test = "This is a test!\n";
f00832cc DK	36	EXPECT_TRUE(f.Write(test.c_str(), test.size()));
	37	EXPECT_TRUE(f.IsOpen());
	38	EXPECT_FALSE(f.Failed());
f7feb041	39
f22b65b4	40	f.Close();
f00832cc DK	41	EXPECT_FALSE(f.IsOpen());
	42	EXPECT_FALSE(f.Failed());
	43
	44	EXPECT_TRUE(f.Open(fname, FileFd::ReadOnly, compressor));
	45	EXPECT_TRUE(f.IsOpen());
	46	EXPECT_FALSE(f.Failed());
	47	EXPECT_FALSE(f.Eof());
	48	EXPECT_NE(0, f.FileSize());
	49	EXPECT_FALSE(f.Failed());
	50	EXPECT_NE(0, f.ModificationTime());
	51	EXPECT_FALSE(f.Failed());
f7feb041	52
bb93178b	53	// ensure the memory is as predictably messed up
f00832cc	54	#define APT_INIT_READBACK \
bb93178b DK	55	char readback[20]; \
	56	memset(readback, 'D', sizeof(readback)/sizeof(readback[0])); \
	57	readback[19] = '\0';
f00832cc DK	58	#define EXPECT_N_STR(expect, actual) \
	59	EXPECT_EQ(0, strncmp(expect, actual, strlen(expect)));
	60
f7feb041	61	{
bb93178b	62	APT_INIT_READBACK
f7feb041	63	char const * const expect = "This";
f00832cc DK	64	EXPECT_TRUE(f.Read(readback, strlen(expect)));
	65	EXPECT_FALSE(f.Failed());
	66	EXPECT_FALSE(f.Eof());
	67	EXPECT_N_STR(expect, readback);
	68	EXPECT_EQ(strlen(expect), f.Tell());
f7feb041 DK	69	}
f7feb041 DK	70	{
bb93178b DK	71	APT_INIT_READBACK
bb93178b DK	72	char const * const expect = "test!\n";
f00832cc DK	73	EXPECT_TRUE(f.Skip((test.size() - f.Tell()) - strlen(expect)));
	74	EXPECT_TRUE(f.Read(readback, strlen(expect)));
	75	EXPECT_FALSE(f.Failed());
	76	EXPECT_FALSE(f.Eof());
	77	EXPECT_N_STR(expect, readback);
	78	EXPECT_EQ(test.size(), f.Tell());
f7feb041	79	}
bb93178b DK	80	{
bb93178b DK	81	APT_INIT_READBACK
f00832cc DK	82	EXPECT_TRUE(f.Seek(0));
	83	EXPECT_FALSE(f.Eof());
	84	EXPECT_TRUE(f.Read(readback, 20, true));
	85	EXPECT_FALSE(f.Failed());
	86	EXPECT_TRUE(f.Eof());
	87	EXPECT_N_STR(test.c_str(), readback);
	88	EXPECT_EQ(f.Size(), f.Tell());
bb93178b DK	89	}
	90	{
	91	APT_INIT_READBACK
f00832cc DK	92	EXPECT_TRUE(f.Seek(0));
	93	EXPECT_FALSE(f.Eof());
	94	EXPECT_TRUE(f.Read(readback, test.size(), true));
	95	EXPECT_FALSE(f.Failed());
	96	EXPECT_FALSE(f.Eof());
	97	EXPECT_N_STR(test.c_str(), readback);
	98	EXPECT_EQ(f.Size(), f.Tell());
bb93178b DK	99	}
	100	{
	101	APT_INIT_READBACK
f00832cc DK	102	EXPECT_TRUE(f.Seek(0));
f00832cc DK	103	EXPECT_FALSE(f.Eof());
bb93178b	104	unsigned long long actual;
f00832cc DK	105	EXPECT_TRUE(f.Read(readback, 20, &actual));
	106	EXPECT_FALSE(f.Failed());
	107	EXPECT_TRUE(f.Eof());
	108	EXPECT_EQ(test.size(), actual);
	109	EXPECT_N_STR(test.c_str(), readback);
	110	EXPECT_EQ(f.Size(), f.Tell());
bb93178b DK	111	}
	112	{
	113	APT_INIT_READBACK
f00832cc DK	114	EXPECT_TRUE(f.Seek(0));
f00832cc DK	115	EXPECT_FALSE(f.Eof());
bb93178b	116	f.ReadLine(readback, 20);
f00832cc DK	117	EXPECT_FALSE(f.Failed());
	118	EXPECT_FALSE(f.Eof());
	119	EXPECT_EQ(test, readback);
	120	EXPECT_EQ(f.Size(), f.Tell());
bb93178b DK	121	}
	122	{
	123	APT_INIT_READBACK
f00832cc DK	124	EXPECT_TRUE(f.Seek(0));
f00832cc DK	125	EXPECT_FALSE(f.Eof());
bb93178b DK	126	char const * const expect = "This";
bb93178b DK	127	f.ReadLine(readback, strlen(expect) + 1);
f00832cc DK	128	EXPECT_FALSE(f.Failed());
	129	EXPECT_FALSE(f.Eof());
	130	EXPECT_N_STR(expect, readback);
	131	EXPECT_EQ(strlen(expect), f.Tell());
bb93178b DK	132	}
bb93178b DK	133	#undef APT_INIT_READBACK
f7feb041 DK	134
f7feb041 DK	135	f.Close();
f00832cc DK	136	EXPECT_FALSE(f.IsOpen());
f00832cc DK	137	EXPECT_FALSE(f.Failed());
f7feb041 DK	138
f7feb041 DK	139	// regression test for permission bug LP: #1304657
f00832cc DK	140	struct stat buf;
	141	EXPECT_EQ(0, stat(fname, &buf));
	142	EXPECT_EQ(0, unlink(fname));
	143	EXPECT_EQ(ExpectedFilePermission, buf.st_mode & 0777);
f22b65b4 MV	144	}
f22b65b4 MV	145
f00832cc	146	static void TestFileFd(unsigned int const filemode)
488011fa	147	{
bb93178b DK	148	std::vector<APT::Configuration::Compressor> compressors = APT::Configuration::getCompressors();
	149
	150	// testing the (un)compress via pipe, as the 'real' compressors are usually built in via libraries
	151	compressors.push_back(APT::Configuration::Compressor("rev", ".reversed", "rev", NULL, NULL, 42));
	152	//compressors.push_back(APT::Configuration::Compressor("cat", ".ident", "cat", NULL, NULL, 42));
	153
f7feb041 DK	154	for (std::vector<APT::Configuration::Compressor>::const_iterator c = compressors.begin(); c != compressors.end(); ++c)
	155	{
	156	if ((filemode & FileFd::ReadWrite) == FileFd::ReadWrite &&
	157	(c->Name.empty() != true && c->Binary.empty() != true))
	158	continue;
f00832cc DK	159	TestFileFd(0002, 0664, filemode, *c);
	160	TestFileFd(0022, 0644, filemode, *c);
	161	TestFileFd(0077, 0600, filemode, *c);
	162	TestFileFd(0026, 0640, filemode, *c);
f7feb041	163	}
f7feb041	164	}
488011fa	165
f00832cc DK	166	TEST(FileUtlTest, FileFD)
	167	{
	168	std::string const startdir = SafeGetCWD();
	169	EXPECT_FALSE(startdir.empty());
	170	std::string tempdir;
	171	createTemporaryDirectory("filefd", tempdir);
	172	EXPECT_EQ(0, chdir(tempdir.c_str()));
	173
	174	TestFileFd(FileFd::WriteOnly \| FileFd::Create);
	175	TestFileFd(FileFd::WriteOnly \| FileFd::Create \| FileFd::Empty);
	176	TestFileFd(FileFd::WriteOnly \| FileFd::Create \| FileFd::Exclusive);
	177	TestFileFd(FileFd::WriteOnly \| FileFd::Atomic);
	178	TestFileFd(FileFd::WriteOnly \| FileFd::Create \| FileFd::Atomic);
	179	// short-hands for ReadWrite with these modes
	180	TestFileFd(FileFd::WriteEmpty);
	181	TestFileFd(FileFd::WriteAny);
	182	TestFileFd(FileFd::WriteTemp);
	183	TestFileFd(FileFd::WriteAtomic);
	184
	185	EXPECT_EQ(0, chdir(startdir.c_str()));
	186	removeDirectory(tempdir);
	187	}
	188	TEST(FileUtlTest, Glob)
f7feb041	189	{
f7feb041	190	std::vector<std::string> files;
488011fa	191	// normal match
f00832cc DK	192	files = Glob("*akefile");
f00832cc DK	193	EXPECT_EQ(1, files.size());
488011fa MV	194
	195	// not there
	196	files = Glob("xxxyyyzzz");
f00832cc DK	197	EXPECT_TRUE(files.empty());
f00832cc DK	198	EXPECT_FALSE(_error->PendingError());
488011fa MV	199
	200	// many matches (number is a bit random)
	201	files = Glob("*.cc");
f00832cc DK	202	EXPECT_LT(10, files.size());
	203	}
	204	TEST(FileUtlTest, GetTempDir)
	205	{
	206	char const * const envtmp = getenv("TMPDIR");
	207	std::string old_tmpdir;
	208	if (envtmp != NULL)
	209	old_tmpdir = envtmp;
488011fa	210
a077861a	211	unsetenv("TMPDIR");
f00832cc	212	EXPECT_EQ("/tmp", GetTempDir());
a077861a MV	213
a077861a MV	214	setenv("TMPDIR", "", 1);
f00832cc	215	EXPECT_EQ("/tmp", GetTempDir());
a077861a MV	216
a077861a MV	217	setenv("TMPDIR", "/not-there-no-really-not", 1);
f00832cc	218	EXPECT_EQ("/tmp", GetTempDir());
a077861a MV	219
a077861a MV	220	setenv("TMPDIR", "/usr", 1);
f00832cc	221	EXPECT_EQ("/usr", GetTempDir());
a077861a	222
f00832cc DK	223	unsetenv("TMPDIR");
	224	if (old_tmpdir.empty() == false)
	225	setenv("TMPDIR", old_tmpdir.c_str(), 1);
488011fa	226	}
7ad2a347 MV	227
	228	TEST(FileUtlTest, Popen)
	229	{
	230	FileFd Fd;
	231	pid_t Child;
	232	char buf[1024];
	233	std::string s;
	234	unsigned long long n = 0;
	235	std::vector<std::string> OpenFds;
	236
	237	// count Fds to ensure we don't have a resource leak
	238	if(FileExists("/proc/self/fd"))
	239	OpenFds = Glob("/proc/self/fd/*");
	240
	241	// output something
	242	const char* Args[10] = {"/bin/echo", "meepmeep", NULL};
	243	bool res = Popen(Args, Fd, Child, FileFd::ReadOnly);
	244	Fd.Read(buf, sizeof(buf)-1, &n);
	245	buf[n] = 0;
	246	EXPECT_NE(n, 0);
	247	EXPECT_EQ(res, true);
	248	EXPECT_STREQ(buf, "meepmeep\n");
	249
	250	// wait for the child to exit and cleanup
	251	ExecWait(Child, "PopenRead");
	252	Fd.Close();
	253
	254	// ensure that after a close all is good again
	255	if(FileExists("/proc/self/fd"))
	256	EXPECT_EQ(Glob("/proc/self/fd/*").size(), OpenFds.size());
	257
	258
	259	// ReadWrite is not supported
	260	res = Popen(Args, Fd, Child, FileFd::ReadWrite);
	261	EXPECT_EQ(res, false);
	262	_error->Discard();
	263
	264	// write something
	265	Args[0] = "/bin/bash";
	266	Args[1] = "-c";
	267	Args[2] = "read";
	268	Args[3] = NULL;
	269	res = Popen(Args, Fd, Child, FileFd::WriteOnly);
	270	s = "\n";
	271	Fd.Write(s.c_str(), s.size());
	272	Fd.Close();
	273	ExecWait(Child, "PopenWrite");
	274	}