mono/mcs/class/System/Test/System.Net/FtpWebRequestTest.cs

//
// FtpWebRequestTest.cs - NUnit Test Cases for System.Net.FtpWebRequest
//
// Authors:
//	Carlos Alberto Cortez <[email protected]>
// 	Gonzalo Paniagua Javier <[email protected]>
//
// Copyright (c) 2006,2007,2008 Novell, Inc. (http://www.novell.com)
//
using NUnit.Framework;
using System;
using System.Collections.Generic;
using System.IO;
using System.Net;
using System.Net.Sockets;
using System.Text;
using System.Threading;

namespace MonoTests.System.Net 
{
	[TestFixture]
	public class FtpWebRequestTest
	{
		FtpWebRequest defaultRequest;
		
		private string _tempDirectory;
		private string _tempFile;

		[SetUp]
		public void SetUp ()
		{
			_tempDirectory = Path.Combine (Path.GetTempPath (), "MonoTests.System.Net.FileWebRequestTest");
			_tempFile = Path.Combine (_tempDirectory, "FtpWebRequestTest.tmp");
			if (!Directory.Exists (_tempDirectory)) {
				Directory.CreateDirectory (_tempDirectory);
			} else {
				// ensure no files are left over from previous runs
				string [] files = Directory.GetFiles (_tempDirectory, "*");
				foreach (string file in files)
					File.Delete (file);
			}
		}

		[TearDown]
		public void TearDown ()
		{
			if (Directory.Exists (_tempDirectory))
				Directory.Delete (_tempDirectory, true);
		}

		[TestFixtureSetUp]
		public void Init ()
		{
			defaultRequest = (FtpWebRequest) WebRequest.Create ("ftp://www.contoso.com");
		}
		
		[Test]
		public void ContentLength ()
		{
			try {
				long l = defaultRequest.ContentLength;
			} catch (NotSupportedException) {
				Assert.Fail ("#1"); // Not overriden
			}

			try {
				defaultRequest.ContentLength = 2;
			} catch (NotSupportedException) {
				Assert.Fail ("#2"); // Not overriden
			}
		}

		[Test]
		public void ContentType ()
		{
			try {
				string t = defaultRequest.ContentType;
				Assert.Fail ("#1");
			} catch (NotSupportedException) {
			}

			try {
				defaultRequest.ContentType = String.Empty;
				Assert.Fail ("#2");
			} catch (NotSupportedException) {
			}
		}

		[Test]
		public void ContentOffset ()
		{
			try {
				defaultRequest.ContentOffset = -2;
				Assert.Fail ("#1");
			} catch (ArgumentOutOfRangeException) {
			}
		}

		[Test]
		public void Credentials ()
		{
			try {
				defaultRequest.Credentials = null;
				Assert.Fail ("#1");
			} catch (ArgumentNullException) {
			}

		}

		[Test]
		public void Method ()
		{
			try {
				defaultRequest.Method = null;
				Assert.Fail ("#1");
			} catch (ArgumentNullException) {
			}

			try {
				defaultRequest.Method = String.Empty;
				Assert.Fail ("#2");
			} catch (ArgumentException) {
			}

			try {
				defaultRequest.Method = "WrongValue";
				Assert.Fail ("#3");
			} catch (ArgumentException) {
			}
		}

		[Test]
		public void PreAuthenticate ()
		{
			try {
				bool p = defaultRequest.PreAuthenticate;
				Assert.Fail ("#1");
			} catch (NotSupportedException) {
			}

			try {
				defaultRequest.PreAuthenticate = true;
			} catch (NotSupportedException) {
			}
		}

		[Test]
		public void ReadWriteTimeout ()
		{
			try {
				defaultRequest.ReadWriteTimeout = -2;
				Assert.Fail ("#2");
			} catch (ArgumentOutOfRangeException) {
			}
		}

		[Test]
		public void Timeout ()
		{
			try {
				defaultRequest.Timeout = -2;
				Assert.Fail ("#2");
			} catch (ArgumentOutOfRangeException) {
			}
		}
		
		[Test]
		public void DefaultValues ()
		{
			FtpWebRequest request = (FtpWebRequest) WebRequest.Create ("ftp://www.contoso.com");
			
			Assert.AreEqual (0, request.ContentOffset, "ContentOffset");
			Assert.AreEqual (false, request.EnableSsl, "EnableSsl");
			// FIXME: Disabled this one by now. KeepAlive is not well supported.
			// Assert.AreEqual (true, request.KeepAlive, "KeepAlive");
			Assert.AreEqual (WebRequestMethods.Ftp.DownloadFile, request.Method, "#1");
			Assert.AreEqual (300000, request.ReadWriteTimeout, "ReadWriteTimeout");
			Assert.IsNull (request.RenameTo, "RenameTo");
			Assert.AreEqual (true, request.UseBinary, "UseBinary");
			Assert.AreEqual (100000, request.Timeout, "Timeout");
			Assert.AreEqual (true, request.UsePassive, "UsePassive");
		}

		[Test]
		public void RenameTo ()
		{
			try {
				defaultRequest.RenameTo = null;
				Assert.Fail ("#1");
			} catch (ArgumentException) {
			}

			try {
				defaultRequest.RenameTo = String.Empty;
				Assert.Fail ("#2");
			} catch (ArgumentException) {
			}
		}

		[Test]
		public void UploadFile1 ()
		{
			ServerPut sp = new ServerPut ();
			sp.Start ();
			string uri = String.Format ("ftp://{0}:{1}/uploads/file.txt", sp.IPAddress, sp.Port);
			try {
				FtpWebRequest ftp = (FtpWebRequest) WebRequest.Create (uri);
				ftp.KeepAlive = false;
				ftp.Timeout = 5000;
				ftp.Method = WebRequestMethods.Ftp.UploadFile;
				ftp.ContentLength = 10;
				ftp.UseBinary = true;
				Stream stream = ftp.GetRequestStream ();
				for (int i = 0; i < 10; i++)
					stream.WriteByte ((byte)i);
				stream.Close ();
				FtpWebResponse response = (FtpWebResponse) ftp.GetResponse ();
				Assert.IsTrue ((int) response.StatusCode >= 200 && (int) response.StatusCode < 300, "UP#01");
				Assert.AreEqual (10, sp.result.Count, "UP#02");
				response.Close ();
			} catch (Exception) {
				if (!String.IsNullOrEmpty (sp.Where))
					throw new Exception (sp.Where);
				throw;
			} finally {
				sp.Stop ();
			}
		}

		[Test]
		public void UploadFile_WebClient ()
		{
			ServerPut sp = new ServerPut ();
			File.WriteAllText (_tempFile, "0123456789");
			sp.Start ();

			using (WebClient m_WebClient = new WebClient())
			{
				string uri = String.Format ("ftp://{0}:{1}/uploads/file.txt", sp.IPAddress, sp.Port);
				
				m_WebClient.UploadFile(uri, _tempFile);
			}
			Assert.AreEqual (10, sp.result.Count, "WebClient/Ftp#01");
	    
			sp.Stop ();
		}

		[Test]
		public void DownloadFile1 ()
		{
			DownloadFile (new ServerDownload ());
		}

		void DownloadFile (ServerDownload sp)
		{
			sp.Start ();
			string uri = String.Format ("ftp://{0}:{1}/file.txt", sp.IPAddress, sp.Port);
			try {
				FtpWebRequest ftp = (FtpWebRequest) WebRequest.Create (uri);
				ftp.KeepAlive = false;
				ftp.Timeout = 5000;
				ftp.Method = WebRequestMethods.Ftp.DownloadFile;
				ftp.UseBinary = true;
				FtpWebResponse response = (FtpWebResponse) ftp.GetResponse ();
				Assert.IsTrue ((int) response.StatusCode >= 100 && (int) response.StatusCode < 200, "DL#01");
				using (Stream st = response.GetResponseStream ()) {
				}
				// This should be "220 Bye" or similar (no KeepAlive)
				Assert.IsTrue ((int) response.StatusCode >= 200 && (int) response.StatusCode < 300, "DL#02");
				response.Close ();
			} catch (Exception) {
				if (!String.IsNullOrEmpty (sp.Where))
					throw new Exception (sp.Where);
				throw;
			} finally {
				sp.Stop ();
			}
		}

		[Test]
		public void DownloadFile2 ()
		{
			// Some embedded FTP servers in Industrial Automation Hardware report
			// the PWD using backslashes, but allow forward slashes for CWD.
			DownloadFile (new ServerDownload (@"\Users\someuser", "/Users/someuser/"));
		}

		[Test]
		public void DeleteFile1 ()
		{
			ServerDeleteFile sp = new ServerDeleteFile ();
			sp.Start ();
			string uri = String.Format ("ftp://{0}:{1}/file.txt", sp.IPAddress, sp.Port);
			try {
				FtpWebRequest ftp = (FtpWebRequest) WebRequest.Create (uri);
				Console.WriteLine (ftp.RequestUri);
				ftp.KeepAlive = false;
				ftp.Timeout = 5000;
				ftp.Method = WebRequestMethods.Ftp.DeleteFile;
				ftp.UseBinary = true;
				FtpWebResponse response = (FtpWebResponse) ftp.GetResponse ();
				Assert.IsTrue ((int) response.StatusCode >= 200 && (int) response.StatusCode < 300, "DF#01");
				response.Close ();
			} catch (Exception e) {
				Console.WriteLine (e);
				if (!String.IsNullOrEmpty (sp.Where))
					throw new Exception (sp.Where);
				throw;
			} finally {
				sp.Stop ();
			}
		}

		[Test]
		public void ListDirectory1 ()
		{
			ServerListDirectory sp = new ServerListDirectory ();
			sp.Start ();
			string uri = String.Format ("ftp://{0}:{1}/somedir/", sp.IPAddress, sp.Port);
			try {
				FtpWebRequest ftp = (FtpWebRequest) WebRequest.Create (uri);
				Console.WriteLine (ftp.RequestUri);
				ftp.KeepAlive = false;
				ftp.Timeout = 5000;
				ftp.Method = WebRequestMethods.Ftp.ListDirectoryDetails;
				ftp.UseBinary = true;
				using (FtpWebResponse response = (FtpWebResponse) ftp.GetResponse ()) {
					StreamReader reader = new StreamReader (response.GetResponseStream ());
					string result = reader.ReadToEnd ();
					Assert.IsTrue ((int) response.StatusCode >= 200 && (int) response.StatusCode < 300, "DF#01");
				}
			} catch (Exception e) {
				Console.WriteLine (e);
				if (!String.IsNullOrEmpty (sp.Where))
					throw new Exception (sp.Where);
				throw;
			} finally {
				sp.Stop ();
			}
		}

		class ServerListDirectory : FtpServer {
			protected override void Run ()
			{
				Socket client = control.Accept ();
				NetworkStream ns = new NetworkStream (client, false);
				StreamWriter writer = new StreamWriter (ns, Encoding.ASCII);
				StreamReader reader = new StreamReader (ns, Encoding.UTF8);
				if (!DoAnonymousLogin (writer, reader)) {
					client.Close ();
					return;
				}

				if (!DoInitialDialog (writer, reader, "/home/someuser", "/home/someuser/somedir/")) {
					client.Close ();
					return;
				}

				string str = reader.ReadLine ();
				if (str != "PASV") {
					Where = "PASV";
					client.Close ();
					return;
				}

				IPEndPoint end_data = (IPEndPoint) data.LocalEndPoint;
				byte [] addr_bytes = end_data.Address.GetAddressBytes ();
				byte [] port = new byte [2];
				port[0] = (byte) ((end_data.Port >> 8) & 255);
				port[1] = (byte) (end_data.Port & 255);
				StringBuilder sb = new StringBuilder ("227 Passive (");
				foreach (byte b in addr_bytes) {
					sb.AppendFormat ("{0},", b);	
				}
				sb.AppendFormat ("{0},", port [0]);	
				sb.AppendFormat ("{0})", port [1]);	
				writer.WriteLine (sb.ToString ());
				writer.Flush ();

				str = reader.ReadLine ();
				if (str != "LIST") {
					Where = "LIST - '" + str + "'";
					client.Close ();
					return;
				}
				writer.WriteLine ("150 Here comes the directory listing");
				writer.Flush ();

				Socket data_cnc = data.Accept ();
				byte [] dontcare = Encoding.ASCII.GetBytes ("drwxr-xr-x    2 ftp      ftp          4096 Oct 27 20:17 tests");
				data_cnc.Send (dontcare, 1, SocketFlags.None);
				data_cnc.Close ();
				writer.WriteLine ("226 Directory send Ok");
				writer.Flush ();
				if (!EndConversation (writer, reader)) {
					client.Close ();
					return;
				}
				client.Close ();
			}
		}

		class ServerDeleteFile : FtpServer {
			protected override void Run ()
			{
				Socket client = control.Accept ();
				NetworkStream ns = new NetworkStream (client, false);
				StreamWriter writer = new StreamWriter (ns, Encoding.ASCII);
				StreamReader reader = new StreamReader (ns, Encoding.UTF8);
				if (!DoAnonymousLogin (writer, reader)) {
					client.Close ();
					return;
				}

				if (!DoInitialDialog (writer, reader, "/home/someuser", "/home/someuser/")) {
					client.Close ();
					return;
				}

				string str = reader.ReadLine ();
				if (str.Trim () != "DELE file.txt") {
					Where = "DELE - " + str;
					client.Close ();
					return;
				}
				writer.WriteLine ("250 Delete operation successful");
				writer.Flush ();
				if (!EndConversation (writer, reader)) {
					client.Close ();
					return;
				}
				client.Close ();
			}
		}

		class ServerDownload : FtpServer {

			string Pwd, Cwd;

			public ServerDownload ()
				: this (null, null)
			{
			}

			public ServerDownload (string pwd, string cwd)
			{
				Pwd = pwd ?? "/home/someuser";
				Cwd = cwd ?? "/home/someuser/";
			}

			protected override void Run ()
			{
				Socket client = control.Accept ();
				NetworkStream ns = new NetworkStream (client, false);
				StreamWriter writer = new StreamWriter (ns, Encoding.ASCII);
				StreamReader reader = new StreamReader (ns, Encoding.UTF8);
				if (!DoAnonymousLogin (writer, reader)) {
					client.Close ();
					return;
				}

				if (!DoInitialDialog (writer, reader, Pwd, Cwd)) {
					client.Close ();
					return;
				}

				string str = reader.ReadLine ();
				if (str != "PASV") {
					Where = "PASV";
					client.Close ();
					return;
				}

				IPEndPoint end_data = (IPEndPoint) data.LocalEndPoint;
				byte [] addr_bytes = end_data.Address.GetAddressBytes ();
				byte [] port = new byte [2];
				port[0] = (byte) ((end_data.Port >> 8) & 255);
				port[1] = (byte) (end_data.Port & 255);
				StringBuilder sb = new StringBuilder ("227 Passive (");
				foreach (byte b in addr_bytes) {
					sb.AppendFormat ("{0},", b);	
				}
				sb.AppendFormat ("{0},", port [0]);	
				sb.AppendFormat ("{0})", port [1]);	
				writer.WriteLine (sb.ToString ());
				writer.Flush ();

				str = reader.ReadLine ();
				if (str != "RETR file.txt") {
					Where = "RETR - " + str;
					client.Close ();
					return;
				}
				writer.WriteLine ("150 Opening BINARY mode data connection for blah (n bytes)");
				writer.Flush ();

				Socket data_cnc = data.Accept ();
				byte [] dontcare = new byte [1];
				data_cnc.Receive (dontcare, 1, SocketFlags.None);
				data_cnc.Close ();
				writer.WriteLine ("226 File send Ok");
				writer.Flush ();
				if (!EndConversation (writer, reader)) {
					client.Close ();
					return;
				}
				client.Close ();
			}
		}

		class ServerPut : FtpServer {
			public List<byte> result = new List<byte> ();
			
			protected override void Run ()
			{
				Socket client = control.Accept ();
				NetworkStream ns = new NetworkStream (client, false);
				StreamWriter writer = new StreamWriter (ns, Encoding.ASCII);
				StreamReader reader = new StreamReader (ns, Encoding.UTF8);
				if (!DoAnonymousLogin (writer, reader)) {
					client.Close ();
					return;
				}

				if (!DoInitialDialog (writer, reader, "/home/someuser", "/home/someuser/uploads/")) {
					client.Close ();
					return;
				}

				string str = reader.ReadLine ();
				if (str != "PASV") {
					Where = "PASV";
					client.Close ();
					return;
				}

				IPEndPoint end_data = (IPEndPoint) data.LocalEndPoint;
				byte [] addr_bytes = end_data.Address.GetAddressBytes ();
				byte [] port = new byte [2];
				port[0] = (byte) ((end_data.Port >> 8) & 255);
				port[1] = (byte) (end_data.Port & 255);
				StringBuilder sb = new StringBuilder ("227 Passive (");
				foreach (byte b in addr_bytes) {
					sb.AppendFormat ("{0},", b);	
				}
				sb.AppendFormat ("{0},", port [0]);	
				sb.AppendFormat ("{0})", port [1]);	
				writer.WriteLine (sb.ToString ());
				writer.Flush ();

				str = reader.ReadLine ();
				if (str != "STOR file.txt") {
					Where = "STOR - " + str;
					client.Close ();
					return;
				}
				writer.WriteLine ("150 Ok to send data");
				writer.Flush ();

				Socket data_cnc = data.Accept ();
				var datastr = new NetworkStream (data_cnc, false);
				int ch;
				while ((ch = datastr.ReadByte ()) != -1){
					result.Add ((byte)ch);

				}
				data_cnc.Close ();
				writer.WriteLine ("226 File received Ok");
				writer.Flush ();
				if (!EndConversation (writer, reader)) {
					client.Close ();
					return;
				}
				client.Close ();
			}
		}

		abstract class FtpServer {
			protected Socket control;
			protected Socket data;
			protected ManualResetEvent evt;
			public string Where = "";

			public FtpServer ()
			{
				control = new Socket (AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
				control.Bind (new IPEndPoint (IPAddress.Loopback, 0));
				control.Listen (1);
				data = new Socket (AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
				data.Bind (new IPEndPoint (IPAddress.Loopback, 0));
				data.Listen (1);
			}

			public void Start ()
			{
				evt = new ManualResetEvent (false);
				Thread th = new Thread (new ThreadStart (Run));
				th.Start ();
			}

			public void Stop ()
			{
				evt.Set ();
				data.Close ();
				control.Close ();
			}

			// PWD, CWD and TYPE I (type could be moved out of here)
			protected bool DoInitialDialog (StreamWriter writer, StreamReader reader, string pwd, string cwd)
			{
				string str = reader.ReadLine ();
				if (!str.StartsWith ("OPTS utf8 on")) {
					Where = "OPTS utf8 - " + str;
					return false;
				}
				writer.WriteLine ("200 Always in UTF8 mode"); // vsftpd
				writer.Flush ();
				str = reader.ReadLine ();
				if (!str.StartsWith ("PWD")) {
					Where = "PWD - " + str;
					return false;
				}
				writer.WriteLine ("257 \"{0}\"", pwd);
				writer.Flush ();
				str = reader.ReadLine ();
				if (str != ("CWD " + cwd)) {
					Where = "CWD - " + str;
					return false;
				}
				writer.WriteLine ("250 Directory changed");
				writer.Flush ();
				str = reader.ReadLine ();
				if (str != ("TYPE I")) {
					Where = "TYPE - " + str;
					return false;
				}
				writer.WriteLine ("200 Switching to binary mode");
				writer.Flush ();
				return true;
			}

			protected bool EndConversation (StreamWriter writer, StreamReader reader)
			{
				string str = reader.ReadLine ();
				if (str != "QUIT") {
					Where = "QUIT";
					return false;
				}
				writer.WriteLine ("220 Bye");
				writer.Flush ();
				Thread.Sleep (250);
				return true;
			}

			protected bool DoAnonymousLogin (StreamWriter writer, StreamReader reader)
			{
				writer.WriteLine ("220 Welcome to the jungle");
				writer.Flush ();
				string str = reader.ReadLine ();
				if (!str.StartsWith ("USER ")) {
					Where = "USER";
					return false;
				}
				writer.WriteLine ("331 Say 'Mellon'");
				writer.Flush ();
				str = reader.ReadLine ();
				if (!str.StartsWith ("PASS ")) {
					Where = "PASS";
					return false;
				}
				writer.WriteLine ("230 Logged in");
				writer.Flush ();
				return true;
			}
			
			public IPAddress IPAddress {
				get { return ((IPEndPoint) control.LocalEndPoint).Address; }
			}
			
			public int Port {
				get { return ((IPEndPoint) control.LocalEndPoint).Port; }
			}

			protected abstract void Run ();
		}
	}
}