xamarin-macios/tests/monotouch-test/Foundation/FileManagerTest.cs

//
// Unit tests for NSFileManager
//
// Authors:
//	Sebastien Pouliot <sebastien@xamarin.com>
//
// Copyright 2011 Xamarin Inc. All rights reserved.
//

using System;
using System.Diagnostics;
using System.IO;
using System.Threading;
using Foundation;
#if MONOMAC
using AppKit;
#else
using UIKit;
#endif
using ObjCRuntime;
using NUnit.Framework;

namespace MonoTouchFixtures.Foundation {
	
	[TestFixture]
	[Preserve (AllMembers = true)]
	public class NSFileManagerTest {
		// we might believe that Envioment.UserName os the same as NSFileManager.UserName, but it is not. On the simulator for
		// example, NSFileManager.UserName is an empty string while mono returns 'somebody'
		[Test]
		public void GetUserNameTest () => Assert.IsNotNull (NSFileManager.UserName);

		[Test]
		public void GetUserFullNameTest () => Assert.IsNotNull (NSFileManager.FullUserName); // cannot check the value since it depends on the enviroment

		[Test]
		public void GetHomeDirectoryTest () => Assert.IsNotNull (NSFileManager.HomeDirectory); // cannot check the value since it depends on the enviroment

		[Test]
		public void GetHomeDirectoryForUserTest () => Assert.AreEqual (NSFileManager.HomeDirectory, NSFileManager.GetHomeDirectory (NSFileManager.UserName));

		[Test]
		public void TemporaryDirectoryTest () => Assert.IsNotNull (NSFileManager.TemporaryDirectory); // cannot check the value since it depends on the enviroment

		[Test]
		public void GetUrlForUbiquityContainer ()
		{
			NSFileManager fm = new NSFileManager ();
			if (TestRuntime.CheckXcodeVersion (4, 5) && fm.UbiquityIdentityToken == null) {
				// UbiquityIdentityToken is a fast way to check if iCloud is enabled
				Assert.Pass ("not iCloud enabled"); 
			}

			NSUrl c = null;
			Exception e = null;
			ManualResetEvent evt = new ManualResetEvent (false);

			new Thread (() =>
			{
				try {
					// From Apple's documentaiton:
					// Important: Do not call this method from your app’s main thread. Because this method might take a nontrivial amount of time to set up 
					// iCloud and return the requested URL, you should always call it from a secondary thread. 
					c = fm.GetUrlForUbiquityContainer (null);
				} catch (Exception ex) {
					e = ex;
				} finally {
					evt.Set ();
				}
			})
			{
				IsBackground = true,
			}.Start ();

			if (evt.WaitOne (TimeSpan.FromSeconds (15))) {
				if (e != null)
					throw e;

				if (c == null)
					Assert.Pass ("not iCloud enabled"); // simulator or provisioning profile without iCloud enabled (old ones)
				else {
					Assert.That (c.ToString (), Does.StartWith ("file://localhost/private/var/mobile/Library/Mobile%20Documents").
												Or.StartWith ("file:///private/var/mobile/Library/Mobile%20Documents"));
				}
			} else {
				Assert.Pass ("iCloud is probably not enabled");
				// aborting is evil, so don't bother aborting the thread, just let it run its course
			}
		}
		//GetSkipBackupAttribute doesn't exist on Mac
#if !MONOMAC
		
		[Test]
		public void GetSkipBackupAttribute ()
		{
			Assert.False (NSFileManager.GetSkipBackupAttribute (NSBundle.MainBundle.ExecutableUrl.ToString ()), "MainBundle");

			string filename = Path.Combine (Environment.GetFolderPath (Environment.SpecialFolder.Personal), $"DoNotBackupMe-NSFileManager-{Process.GetCurrentProcess ().Id}");
			try {
				File.WriteAllText (filename, "not worth a bit");
				
				Assert.False (NSFileManager.GetSkipBackupAttribute (filename), "DoNotBackupMe-0");
		
				NSFileManager.SetSkipBackupAttribute (filename, true);

				NSError error;
				Assert.True (NSFileManager.GetSkipBackupAttribute (filename, out error), "DoNotBackupMe-1");
				Assert.Null (error, "error-1");

				error = NSFileManager.SetSkipBackupAttribute (filename, false);
				Assert.False (NSFileManager.GetSkipBackupAttribute (filename), "DoNotBackupMe-2");
				Assert.Null (error, "error-2");
			}
			finally {
				// otherwise the attribute won't reset even if the file is overwritten
				File.Delete (filename);
			}
		}
#endif

		[Test]
		public void DefaultManager ()
		{
			// ICE on devices ? ref: http://forums.xamarin.com/discussion/6807/system-invalidcastexception-while-trying-to-get-nsfilemanager-defaultmanager
			Assert.NotNull (NSFileManager.DefaultManager, "DefaultManager");
		}

#if !MONOMAC // DocumentsDirectory and MyDocuments point to different locations on mac
		[Test]
		[Ignore ("DocumentsDirectory and MyDocuments point to different locations on mac")]
		public void DocumentDirectory ()
		{
			var path = NSFileManager.DefaultManager.GetUrls (NSSearchPathDirectory.DocumentDirectory, NSSearchPathDomain.User) [0].Path;
			var file = Path.Combine (path, "myfile.txt");
			try {
				// because it's read-only MyDocuments != DocumentDirectory on tvOS as the former is required by a lot of code in the BCL
				if (!TestRuntime.IsTVOS) {
					File.WriteAllText (Path.Combine (path, "myfile.txt"), "woohoo");
					Assert.That (path, Is.EqualTo (Environment.GetFolderPath (Environment.SpecialFolder.MyDocuments)), "GetFolderPath");
				}
			}
			finally {
				File.Delete (file);
			}
		}

		// "Environment.SpecialFolder.Resources is empty string on mac"
		[Test]
		public void LibraryDirectory ()
		{
			var path = NSFileManager.DefaultManager.GetUrls (NSSearchPathDirectory.LibraryDirectory, NSSearchPathDomain.User) [0].Path;
			var file = Path.Combine (path, "myfile.txt");
			try {
				File.WriteAllText (Path.Combine (path, "myfile.txt"), "woohoo");
				Assert.That (path, Is.EqualTo (Environment.GetFolderPath (Environment.SpecialFolder.Resources)), "GetFolderPath");
			}
			catch (UnauthorizedAccessException) {
				// DocumentDirectory cannot be written to on tvOS
				if (!TestRuntime.IsTVOS)
					throw;
			}
			finally {
				File.Delete (file);
			}
		}
#endif
	}
}