Bodoconsult.Core.Web.Ftp

Autor: Bodoconsult EDV-Dienstleistungen GmbH Robert Leisner

Nuget package

https://www.nuget.org/packages/Bodoconsult.Core.Web.Ftp/

Github repository

https://github.com/RobertLeisner/Bodoconsult.Core.Web.Ftp

About the library Bodoconsult.Core.Web.Ftp

What does the library

Bodoconsult.Core.Database.Postgres library simplifies the access to Postgres based databases. It handles the most common database actions like getting datatables, running SQL statement or fetch scalar values from the database.

Additionally the library contains some tools for developers making the usage of the database layers derived from Bodoconsult.Core.Database as easy as possible. See below.

How to use the library

The source code contain a NUnit test classes, the following source code is extracted from. The samples below show the most helpful use cases for the library.

Overview

The main class in the library is the class SshHandler with the following methods:

Connect()
Disconnect()
Put(string localPath, string remotePath)
RemoveFile(string remotePath)
Exists(string path)
CreateDirectory(string remotePath)
RemoveDirectory(string remotePath)
GetDirectoryItems(string remotePath)
GetDirectoryItemsRaw(string remotePath)
DownloadFile(string remotePath, string localPath)

Samples

 [TestFixture]
	public class UnitTestSshHandler
	{

		private readonly SshCredentials _credentials = TestHelper.GetCredentials();

		[Test]
		public void TestConnect()
		{

			// Arrange
			var s = new SshHandler(_credentials);
			
			// Act
			s.Connect();

			var erg = s.IsConnected;

			s.Disconnect();

			// Assert
			Assert.IsTrue(erg);
		}


		[Test]
		public void TestPutMainDirectory()
		{

			// Arrange
			var localPath = TestHelper.FtpTestFilePath;

			const string remotePath = "/"+TestHelper.FtpTestFileName;

			var s = new SshHandler(_credentials);


			// Act
			s.Connect();

			var erg1 = s.IsConnected;

			
			s.Put(localPath, remotePath);

			s.Disconnect();

			// Assert
			Assert.IsTrue(erg1);
		}


		[Test]
		public void TestPutDirectory()
		{

			// Arrange
			var localPath = TestHelper.FtpTestFilePath;

			var remotePath = $"{TestHelper.FtpSubDir}/{TestHelper.FtpTestFileName}";

			var s = new SshHandler(_credentials);


			// Act
			s.Connect();

			var erg1 = s.IsConnected;


			s.Put(localPath, remotePath);

			s.Disconnect();

			// Assert
			Assert.IsTrue(erg1);
		}


		[Test]
		public void TestRemoveFile()
		{

			// Arrange
			var localPath = TestHelper.FtpTestFilePath;

			var remotePath = $"{TestHelper.FtpSubDir}/{TestHelper.FtpTestFileName}";

			var s = new SshHandler(_credentials);


			// Act
			s.Connect();

			var erg1 = s.IsConnected;

			s.Put(localPath, remotePath);

			Assert.IsTrue(s.Exists(remotePath));

			// Act
			s.RemoveFile(remotePath);
			var erg2 = s.Exists(remotePath);
			s.Disconnect();

			// Assert
			Assert.IsTrue(erg1);
			Assert.IsFalse(erg2);
		}


		[Test]
		public void TestRemoveFileFileNotExisting()
		{

			// Arrange
			var localPath = TestHelper.FtpTestFilePath;

			var remotePath = $"{TestHelper.FtpSubDir}/AAA{TestHelper.FtpTestFileName}";

			var s = new SshHandler(_credentials);

			s.Connect();

			var erg1 = s.IsConnected;

			s.Put(localPath, remotePath);

			// Act
			s.RemoveFile(remotePath);
			var erg2 = s.Exists(remotePath);
			s.Disconnect();

			// Assert
			Assert.IsTrue(erg1);
			Assert.IsFalse(erg2);
		}


		[Test]
		public void TestCreateDirectory()
		{

			// Arrange
			var remotePath = TestHelper.FtpSubDirCreate;

			var s = new SshHandler(_credentials);


			// Act
			s.Connect();

			var erg1 = s.IsConnected;

			s.RemoveDirectory(remotePath);
			Assert.IsFalse(s.Exists(remotePath));

			// Act
			s.CreateDirectory(remotePath);
			var erg2 = s.Exists(remotePath);
			s.Disconnect();

			// Assert
			Assert.IsTrue(erg1);
			Assert.IsTrue(erg2);
		}


		[Test]
		public void TestListDirectory()
		{

			// Arrange
			const string remotePath = TestHelper.FtpSubDir;

			var remotePath1 = TestHelper.FtpSubDirCreate;

			var s = new SshHandler(_credentials);

			s.Connect();

			if (!s.Exists(remotePath1)) s.CreateDirectory(remotePath1);

			var erg1 = s.IsConnected;

			var localPath = TestHelper.FtpTestFilePath;

			var remotePathFile = $"{TestHelper.FtpSubDir}/{TestHelper.FtpTestFileName}";

			if (!s.Exists(remotePathFile)) s.Put(localPath, remotePathFile);

			// Act
			var erg2 = s.GetDirectoryItems(remotePath).ToList();

			s.Disconnect();

			// Assert
			Assert.IsTrue(erg1);
			Assert.IsTrue(erg2.Any());
			Assert.IsTrue(erg2.Any(x => x.IsDirectory));
			Assert.IsTrue(erg2.Any(x => !x.IsDirectory));
		}



		[Test]
		public void TestListDirectoryRaw()
		{

			// Arrange
			const string remotePath = TestHelper.FtpSubDir;

			var remotePath1 = TestHelper.FtpSubDirCreate;

			var s = new SshHandler(_credentials);

			s.Connect();

			if (!s.Exists(remotePath1)) s.CreateDirectory(remotePath1);

			var erg1 = s.IsConnected;

			var localPath = TestHelper.FtpTestFilePath;

			var remotePathFile = $"{TestHelper.FtpSubDir}/{TestHelper.FtpTestFileName}";

			if (!s.Exists(remotePathFile)) s.Put(localPath, remotePathFile);

			// Act
			var erg2 = s.GetDirectoryItems(remotePath).ToList();

			s.Disconnect();

			// Assert
			Assert.IsTrue(erg1);
			Assert.IsTrue(erg2.Any());
			Assert.IsTrue(erg2.Any(x => x.IsDirectory));
			Assert.IsTrue(erg2.Any(x => !x.IsDirectory));
		}

		[Test]
		public void TestDownloadFile()
		{

			// Arrange
			var remotePath = "/"+ TestHelper.FtpTestFileName;
			var localPath = Path.Combine(TestHelper.LocalTargetPath,"AAA.txt");

			var s = new SshHandler(_credentials);


			if (File.Exists(localPath))
			{
				File.Delete(localPath);
			}


			// Act
			s.Connect();

			var erg1 = s.IsConnected;

			// Act
			s.DownloadFile(remotePath, localPath);
			s.Disconnect();

			var erg2 = File.Exists(localPath);

			// Assert
			Assert.IsTrue(erg1);
			Assert.IsTrue(erg2);
		}


		[Test]
		public void TestRemoveDirectory()
		{

			// Arrange
			var remotePath1 = TestHelper.FtpSubDirCreate;

			var s = new SshHandler(_credentials);

			s.Connect();

			if (!s.Exists(remotePath1)) s.CreateDirectory(remotePath1);

			var erg1 = s.IsConnected;

			// Act
			s.RemoveDirectory(remotePath1);

			// Assert
			var erg2 = s.Exists(remotePath1);

			s.Disconnect();

			
			Assert.IsTrue(erg1);
			Assert.IsFalse(erg2);
		}

	}

About us

Bodoconsult (http://www.bodoconsult.de) is a Munich based software development company from Germany.

Robert Leisner is senior software developer at Bodoconsult. See his profile on http://www.bodoconsult.de/Curriculum_vitae_Robert_Leisner.pdf.

Licence for the library Bodoconsult.Core.Web.Ftp

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Licenses used by Bodoconsult.Core.Web.Ftp

SSH.NET by Renzi

Project-Url: https://github.com/sshnet/SSH.NET

The MIT License (MIT)

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.