|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
using System.IO;
using Microsoft.Build.Framework;
using Microsoft.Build.Shared;
using Microsoft.Build.Tasks;
using Microsoft.Build.Utilities;
using Xunit;
#nullable disable
namespace Microsoft.Build.UnitTests
{
public sealed class Touch_Tests
{
internal static Microsoft.Build.Shared.FileExists fileExists = new Microsoft.Build.Shared.FileExists(FileExists);
internal static Microsoft.Build.Shared.FileCreate fileCreate = new Microsoft.Build.Shared.FileCreate(FileCreate);
internal static Microsoft.Build.Tasks.GetAttributes fileGetAttributes = new Microsoft.Build.Tasks.GetAttributes(GetAttributes);
internal static Microsoft.Build.Tasks.SetAttributes fileSetAttributes = new Microsoft.Build.Tasks.SetAttributes(SetAttributes);
internal static Microsoft.Build.Tasks.SetLastAccessTime setLastAccessTime = new Microsoft.Build.Tasks.SetLastAccessTime(SetLastAccessTime);
internal static Microsoft.Build.Tasks.SetLastWriteTime setLastWriteTime = new Microsoft.Build.Tasks.SetLastWriteTime(SetLastWriteTime);
internal static string myexisting_txt = NativeMethodsShared.IsWindows ? @"c:\touch\myexisting.txt" : @"/touch/myexisting.txt";
internal static string mynonexisting_txt = NativeMethodsShared.IsWindows ? @"c:\touch\mynonexisting.txt" : @"/touch/mynonexisting.txt";
internal static string nonexisting_txt = NativeMethodsShared.IsWindows ? @"c:\touch-nonexistent\file.txt" : @"/touch-nonexistent/file.txt";
internal static string myreadonly_txt = NativeMethodsShared.IsWindows ? @"c:\touch\myreadonly.txt" : @"/touch/myreadonly.txt";
private bool Execute(Touch t)
{
return t.ExecuteImpl(
fileExists,
fileCreate,
fileGetAttributes,
fileSetAttributes,
setLastAccessTime,
setLastWriteTime);
}
/// <summary>
/// Mock file exists.
/// </summary>
/// <param name="path"></param>
/// <returns></returns>
private static bool FileExists(string path)
{
if (path == myexisting_txt)
{
return true;
}
if (path == mynonexisting_txt)
{
return false;
}
if (path == nonexisting_txt)
{
return false;
}
if (path == myreadonly_txt)
{
return true;
}
Assert.True(false, "Unexpected file exists: " + path);
return true;
}
/// <summary>
/// Mock file create.
/// </summary>
/// <param name="path"></param>
private static FileStream FileCreate(string path)
{
if (path == mynonexisting_txt)
{
return null;
}
if (path == nonexisting_txt)
{
throw new DirectoryNotFoundException();
}
Assert.True(false, "Unexpected file create: " + path);
return null;
}
/// <summary>
/// Mock get attributes.
/// </summary>
/// <param name="path"></param>
private static FileAttributes GetAttributes(string path)
{
FileAttributes a = new FileAttributes();
if (path == myexisting_txt)
{
return a;
}
if (path == mynonexisting_txt)
{
// Has attributes because Touch created it.
return a;
}
if (path == myreadonly_txt)
{
return System.IO.FileAttributes.ReadOnly;
}
Assert.True(false, "Unexpected file attributes: " + path);
return a;
}
/// <summary>
/// Mock get attributes.
/// </summary>
/// <param name="path"></param>
private static void SetAttributes(string path, FileAttributes attributes)
{
if (path == myreadonly_txt)
{
return;
}
Assert.True(false, "Unexpected set file attributes: " + path);
}
/// <summary>
/// Mock SetLastAccessTime.
/// </summary>
/// <param name="path"></param>
private static void SetLastAccessTime(string path, DateTime timestamp)
{
if (path == myexisting_txt)
{
return;
}
if (path == mynonexisting_txt)
{
return;
}
if (path == myreadonly_txt)
{
// Read-only so throw an exception
throw new IOException();
}
Assert.True(false, "Unexpected set last access time: " + path);
}
/// <summary>
/// Mock SetLastWriteTime.
/// </summary>
/// <param name="path"></param>
private static void SetLastWriteTime(string path, DateTime timestamp)
{
if (path == myexisting_txt)
{
return;
}
if (path == mynonexisting_txt)
{
return;
}
if (path == myreadonly_txt)
{
return;
}
Assert.True(false, "Unexpected set last write time: " + path);
}
[Fact]
public void TouchExisting()
{
Touch t = new Touch();
MockEngine engine = new MockEngine();
t.BuildEngine = engine;
t.Files = new ITaskItem[]
{
new TaskItem(myexisting_txt)
};
bool success = Execute(t);
Assert.True(success);
Assert.Single(t.TouchedFiles);
Assert.Contains(
String.Format(AssemblyResources.GetString("Touch.Touching"), myexisting_txt),
engine.Log);
}
[Fact]
public void TouchNonExisting()
{
Touch t = new Touch();
MockEngine engine = new MockEngine();
t.BuildEngine = engine;
t.Files = new ITaskItem[]
{
new TaskItem(mynonexisting_txt)
};
bool success = Execute(t);
// Not success because the file doesn't exist
Assert.False(success);
Assert.Contains(
String.Format(AssemblyResources.GetString("Touch.FileDoesNotExist"), mynonexisting_txt),
engine.Log);
}
[Fact]
public void TouchNonExistingAlwaysCreate()
{
Touch t = new Touch();
MockEngine engine = new MockEngine();
t.BuildEngine = engine;
t.AlwaysCreate = true;
t.Files = new ITaskItem[]
{
new TaskItem(mynonexisting_txt)
};
bool success = Execute(t);
// Success because the file was created.
Assert.True(success);
Assert.Contains(
String.Format(AssemblyResources.GetString("Touch.CreatingFile"), mynonexisting_txt, "AlwaysCreate"),
engine.Log);
}
[Fact]
public void TouchNonExistingAlwaysCreateAndBadlyFormedTimestamp()
{
Touch t = new Touch();
MockEngine engine = new MockEngine();
t.BuildEngine = engine;
t.AlwaysCreate = true;
t.ForceTouch = false;
t.Time = "Badly formed time String.";
t.Files = new ITaskItem[]
{
new TaskItem(mynonexisting_txt)
};
bool success = Execute(t);
// Failed because of badly formed time string.
Assert.False(success);
Assert.Contains("MSB3376", engine.Log);
}
[Fact]
public void TouchReadonly()
{
Touch t = new Touch();
MockEngine engine = new MockEngine();
t.BuildEngine = engine;
t.AlwaysCreate = true;
t.Files = new ITaskItem[]
{
new TaskItem(myreadonly_txt)
};
bool success = Execute(t);
// Failed because file is readonly.
Assert.False(success);
Assert.Contains("MSB3374", engine.Log);
Assert.Contains(myreadonly_txt, engine.Log);
}
[Fact]
public void TouchReadonlyForce()
{
Touch t = new Touch();
MockEngine engine = new MockEngine();
t.BuildEngine = engine;
t.ForceTouch = true;
t.AlwaysCreate = true;
t.Files = new ITaskItem[]
{
new TaskItem(myreadonly_txt)
};
Execute(t);
}
[Fact]
public void TouchNonExistingDirectoryDoesntExist()
{
Touch t = new Touch();
MockEngine engine = new MockEngine();
t.BuildEngine = engine;
t.AlwaysCreate = true;
t.Files = new ITaskItem[]
{
new TaskItem(nonexisting_txt)
};
bool success = Execute(t);
// Failed because the target directory didn't exist.
Assert.False(success);
Assert.Contains("MSB3371", engine.Log);
Assert.Contains(nonexisting_txt, engine.Log);
}
/// <summary>
/// Question touch on non-existing file should return false.
/// </summary>
[Fact]
public void QuestionTouchNonExisting()
{
Touch t = new Touch();
MockEngine engine = new MockEngine();
t.BuildEngine = engine;
t.FailIfNotIncremental = true;
t.Files = new ITaskItem[]
{
new TaskItem(mynonexisting_txt)
};
bool success = Execute(t);
// Not success because the file doesn't exist
Assert.False(success);
Assert.Contains(
String.Format(AssemblyResources.GetString("Touch.FileDoesNotExist"), mynonexisting_txt),
engine.Log);
}
/// <summary>
/// Question touch on a non-existing file with AlwaysCreate property should return false.
/// </summary>
[Fact]
public void QuestionTouchNonExistingAlwaysCreate()
{
Touch t = new Touch();
MockEngine engine = new MockEngine();
t.BuildEngine = engine;
t.FailIfNotIncremental = true;
t.AlwaysCreate = true;
t.Files = new ITaskItem[]
{
new TaskItem(mynonexisting_txt)
};
bool success = Execute(t);
Assert.True(success);
Assert.Contains(
String.Format(AssemblyResources.GetString("Touch.CreatingFile"), mynonexisting_txt, "AlwaysCreate"),
engine.Log);
}
/// <summary>
/// Question touch should return true and the file is not touched.
/// </summary>
[Fact]
public void QuestionTouchExisting()
{
Touch t = new Touch();
MockEngine engine = new MockEngine();
t.BuildEngine = engine;
t.FailIfNotIncremental = true;
t.Files = new ITaskItem[]
{
new TaskItem(myexisting_txt)
};
bool success = Execute(t);
Assert.True(success);
Assert.Contains(
String.Format(AssemblyResources.GetString("Touch.Touching"), myexisting_txt),
engine.Log);
}
}
}
|