Files
duplicati/Duplicati/UnitTest/BasicSetupHelper.cs
T

229 lines
9.2 KiB
C#

// Copyright (C) 2015, The Duplicati Team
// http://www.duplicati.com, info@duplicati.com
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
using System;
using NUnit.Framework;
using System.IO;
using System.Collections.Generic;
using System.IO.Compression;
using Duplicati.Library.Common;
using Duplicati.Library.Common.IO;
using Duplicati.Library.Utility;
namespace Duplicati.UnitTest
{
public abstract class BasicSetupHelper
{
/// <summary>
/// The base folder where all data is trashed around
/// </summary>
protected static readonly string BASEFOLDER = Path.GetFullPath(
string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable("UNITTEST_BASEFOLDER"))
? "duplicati_testdata"
: Environment.GetEnvironmentVariable("UNITTEST_BASEFOLDER")
);
/// <summary>
/// The folder path that serves as the backup destination
/// </summary>
protected readonly string TARGETFOLDER = TestUtils.GetDefaultTarget(Path.Combine(BASEFOLDER, "autotest"));
/// <summary>
/// The folder that contains data to be backed up
/// </summary>
protected readonly string DATAFOLDER = Path.Combine(BASEFOLDER, "backup-data");
/// <summary>
/// The folder where data is restored into
/// </summary>
protected readonly string RESTOREFOLDER = Path.Combine(BASEFOLDER, "restored");
/// <summary>
/// The log file for manual examination
/// </summary>
protected readonly string LOGFILE = Path.Combine(BASEFOLDER, "logs/logfile.log");
/// <summary>
/// The database is fixed so it does not mess up the system where the test is performed
/// </summary>
protected readonly string DBFILE = Path.Combine(BASEFOLDER, "autotest.sqlite");
/// <summary>
/// Value indicating if all output is redirected to TestContext.Progress,
/// this can be used to diagnose errors on a CI build instance by setting
/// the environment variable DEBUG_OUTPUT=1 and running the job
/// </summary>
public static readonly bool DEBUG_OUTPUT = Library.Utility.Utility.ParseBool(Environment.GetEnvironmentVariable("DEBUG_OUTPUT"), false);
protected static readonly ISystemIO systemIO = SystemIO.IO_OS;
/// <summary>
/// Writes a message to TestContext.Progress and Console.Out
/// </summary>
/// <param name="msg">The string to write.</param>
/// <param name="args">The passed arguments.</param>
public static void ProgressWriteLine(string msg, params object[] args)
{
if (!DEBUG_OUTPUT)
TestContext.Progress.WriteLine(msg, args);
Console.WriteLine("==> " + msg, args);
}
[OneTimeSetUp]
public virtual void OneTimeSetUp()
{
if (DEBUG_OUTPUT)
{
Console.SetOut(TestContext.Progress);
}
systemIO.DirectoryCreate(BASEFOLDER);
this.TearDown();
this.OneTimeTearDown();
}
[OneTimeTearDown]
public virtual void OneTimeTearDown()
{
// No-op by default.
}
private static int count = 1;
[SetUp]
public virtual void SetUp()
{
systemIO.DirectoryCreate(this.DATAFOLDER);
systemIO.DirectoryCreate(this.TARGETFOLDER);
systemIO.DirectoryCreate(this.RESTOREFOLDER);
}
[TearDown]
public virtual void TearDown()
{
if (systemIO.DirectoryExists(this.DATAFOLDER))
{
systemIO.DirectoryDelete(this.DATAFOLDER, true);
}
if (systemIO.DirectoryExists(this.TARGETFOLDER))
{
systemIO.DirectoryDelete(this.TARGETFOLDER, true);
}
if (systemIO.DirectoryExists(this.RESTOREFOLDER))
{
systemIO.DirectoryDelete(this.RESTOREFOLDER, true);
}
if (systemIO.FileExists(this.DBFILE))
{
systemIO.FileDelete(this.DBFILE);
}
if (systemIO.FileExists($"{this.DBFILE}-journal"))
{
systemIO.FileDelete($"{this.DBFILE}-journal");
}
if (systemIO.FileExists(this.LOGFILE))
{
var source = new System.IO.FileStream(this.LOGFILE, System.IO.FileMode.Open, System.IO.FileAccess.Read);
var dest = new System.IO.FileStream($"{this.LOGFILE}.{count++}.gz", System.IO.FileMode.Create, System.IO.FileAccess.Write);
var gzip = new System.IO.Compression.GZipStream(dest, System.IO.Compression.CompressionMode.Compress);
source.CopyTo(gzip);
gzip.Flush();
source.Close();
gzip.Close();
dest.Close();
systemIO.FileDelete(this.LOGFILE);
}
}
protected virtual Dictionary<string, string> TestOptions
{
get
{
var opts = TestUtils.DefaultOptions;
//opts["blockhash-lookup-memory"] = "0";
//opts["filehash-lookup-memory"] = "0";
//opts["metadatahash-lookup-memory"] = "0";
//opts["disable-filepath-cache"] = "true";
opts["passphrase"] = "123456";
opts["debug-output"] = "true";
opts["log-file-log-level"] = nameof(Library.Logging.LogMessageType.Profiling);
opts["log-file"] = LOGFILE;
opts["dblock-size"] = "10mb";
opts["dbpath"] = DBFILE;
opts["blocksize"] = "10kb";
opts["backup-test-samples"] = "0";
opts["unittest-mode"] = "true";
return opts;
}
}
/// <summary>
/// Alternative to System.IO.Compression.ZipFile.ExtractToDirectory()
/// that handles long paths.
/// </summary>
protected static void ZipFileExtractToDirectory(string sourceArchiveFileName, string destinationDirectoryName)
{
if (Platform.IsClientWindows)
{
// Handle long paths under Windows by extracting to a
// temporary file and moving the resulting file to the
// actual destination using functions that support
// long paths.
using (var archive = ZipFile.OpenRead(sourceArchiveFileName))
{
foreach (var entry in archive.Entries)
{
// By the ZIP spec, directories end in a forward slash
var isDirectory = entry.FullName.EndsWith("/");
var destination =
systemIO.PathGetFullPath(systemIO.PathCombine(destinationDirectoryName, entry.FullName));
if (isDirectory)
{
systemIO.DirectoryCreate(destination);
}
else
{
// Not every directory is recorded separately,
// so create directories if needed
systemIO.DirectoryCreate(systemIO.PathGetDirectoryName(destination));
// Extract file to temporary file, then move to
// the (possibly) long path destination
var tempFile = Path.GetTempFileName();
try
{
entry.ExtractToFile(tempFile, true);
systemIO.FileMove(tempFile, destination);
}
finally
{
if (systemIO.FileExists(tempFile))
{
systemIO.FileDelete(tempFile);
}
}
}
}
}
}
else
{
ZipFile.ExtractToDirectory(sourceArchiveFileName, destinationDirectoryName);
}
}
}
}