src/test/testhome.h

0001 /***************************************************************************
0002  *   Copyright (C) 2014 by Linuxstopmotion contributors;                   *
0003  *   see the AUTHORS file for details.                                     *
0004  *                                                                         *
0005  *   This program is free software; you can redistribute it and/or modify  *
0006  *   it under the terms of the GNU General Public License as published by  *
0007  *   the Free Software Foundation; either version 2 of the License, or     *
0008  *   (at your option) any later version.                                   *
0009  *                                                                         *
0010  *   This program is distributed in the hope that it will be useful,       *
0011  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
0012  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
0013  *   GNU General Public License for more details.                          *
0014  *                                                                         *
0015  *   You should have received a copy of the GNU General Public License     *
0016  *   along with this program; if not, write to the                         *
0017  *   Free Software Foundation, Inc.,                                       *
0018  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
0019  ***************************************************************************/
0020
0021 #ifndef TESTHOME_H_
0022 #define TESTHOME_H_
0023
0024 #include <stdio.h>
0025
0026 #include "oomtestutil.h"
0027
0028 /**
0029  * A filesystem/environment wrapper that makes only one change to the wrapped
0030  * filesystem/environment: it creates a temporary directory and pretends that
0031  * the HOME environment variable points to it.
0032  * @par
0033  * This is very useful for tests that exercise real Stopmotion functionality
0034  * (that assumes the presence of HOME) because some automatic test runners do
0035  * not have HOME set.
0036  */
0037 class TestHome : public MockableFileSystem {
0038     MockableFileSystem* delegate;
0039     char* fakeHome;
0040 public:
0041     TestHome();
0042     ~TestHome();
0043     void setDelegate(MockableFileSystem* mfs);
0044     FILE* fopen(const char* filename, const char* mode);
0045     FILE* freopen(const char* filename, const char* mode, FILE* fh);
0046     int fclose(FILE* fh);
0047     int fflush(FILE* fh);
0048     size_t fread (void *out, size_t blockSize,
0049                  size_t blockCount, FILE *fh);
0050     size_t fwrite (const void *in, size_t blockSize,
0051                   size_t blockCount, FILE *fh);
0052     int access (const char *name, int type);
0053     int ferror(FILE* fh);
0054     int unlink(const char *name);
0055     char *getenv(const char *name);
0056 };
0057
0058 #endif