Skip to content

SftpFileStream: No longer track write position separately #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jul 16, 2017
Merged

SftpFileStream: No longer track write position separately #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
bcc8def
No longer track write position separately.
drieseng Mar 19, 2017
40efaa6
Move back to writing all read bytes to read buffer, not only those th…
drieseng Jun 5, 2017
6fd1cc7
Update Read(byte[] buffer, int offset, int count) to not write bytes …
drieseng Jun 12, 2017
50ea405
Sync project file.
drieseng Jun 12, 2017
c83188a
Harden test.
drieseng Jun 12, 2017
5dda8f5
Merge branch 'sftpfilestream' of https://github.com/sshnet/SSH.NET in…
drieseng Jun 12, 2017
416f7be
Ensure write buffer is initialized before attempting to use it.
drieseng Jun 17, 2017
5408aac
Avoid reading from the server twice to determine EOF.
drieseng Jul 16, 2017
b680765
Add comment to clarify that StreamReader uses a buffer size of 1024 b…
drieseng Jul 16, 2017
17a9c61
Use langversion 5 for .NET Core project.
drieseng Jul 16, 2017
bfc5229
Merge remote-tracking branch 'refs/remotes/origin/develop' into sftpf…
drieseng Jul 16, 2017
55e31b1
Sync project file
drieseng Jul 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Renci.SshNet.NETCore/Renci.SshNet.NETCore.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<AssemblyName>Renci.SshNet</AssemblyName>
<AssemblyOriginatorKeyFile>../Renci.SshNet.snk</AssemblyOriginatorKeyFile>
<LangVersion>5</LangVersion>
<SignAssembly>true</SignAssembly>
<PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
<GenerateAssemblyTitleAttribute>false</GenerateAssemblyTitleAttribute>
Expand Down
28 changes: 26 additions & 2 deletions src/Renci.SshNet.Tests.NET35/Renci.SshNet.Tests.NET35.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1202,8 +1202,29 @@
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_ReadByte_ReadMode_NoDataInWriteBufferAndNoDataInReadBuffer_LessDataThanReadBufferSizeAvailable.cs">
<Link>Classes\Sftp\SftpFileStreamTest_ReadByte_ReadMode_NoDataInWriteBufferAndNoDataInReadBuffer_LessDataThanReadBufferSizeAvailable.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_Read_ReadMode_NoDataInReaderBufferAndReadMoreBytesThanCount.cs">
<Link>Classes\Sftp\SftpFileStreamTest_Read_ReadMode_NoDataInReaderBufferAndReadMoreBytesThanCount.cs</Link>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_Read_ReadMode_NoDataInReaderBufferAndReadLessBytesFromServerThanCountAndEqualToBufferSize.cs">
<Link>Classes\Sftp\SftpFileStreamTest_Read_ReadMode_NoDataInReaderBufferAndReadLessBytesFromServerThanCountAndEqualToBufferSize.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_Read_ReadMode_NoDataInReaderBufferAndReadLessBytesFromServerThanCountAndLessThanBufferSize.cs">
<Link>Classes\Sftp\SftpFileStreamTest_Read_ReadMode_NoDataInReaderBufferAndReadLessBytesFromServerThanCountAndLessThanBufferSize.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_Read_ReadMode_NoDataInReaderBufferAndReadMoreBytesFromServerThanCount.cs">
<Link>Classes\Sftp\SftpFileStreamTest_Read_ReadMode_NoDataInReaderBufferAndReadMoreBytesFromServerThanCount.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginBeginAndOffsetNegative.cs">
<Link>Classes\Sftp\SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginBeginAndOffsetNegative.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginBeginAndOffsetPositive.cs">
<Link>Classes\Sftp\SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginBeginAndOffsetPositive.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginBeginAndOffsetZero.cs">
<Link>Classes\Sftp\SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginBeginAndOffsetZero.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_Seek_PositionedAtMiddleOfStream_OriginBeginAndOffsetZero_NoBuffering.cs">
<Link>Classes\Sftp\SftpFileStreamTest_Seek_PositionedAtMiddleOfStream_OriginBeginAndOffsetZero_NoBuffering.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_Seek_PositionedAtMiddleOfStream_OriginBeginAndOffsetZero_ReadBuffer.cs">
<Link>Classes\Sftp\SftpFileStreamTest_Seek_PositionedAtMiddleOfStream_OriginBeginAndOffsetZero_ReadBuffer.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_SetLength_Closed.cs">
<Link>Classes\Sftp\SftpFileStreamTest_SetLength_Closed.cs</Link>
Expand All @@ -1223,6 +1244,9 @@
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_SetLength_SessionOpen_FIleAccessWrite.cs">
<Link>Classes\Sftp\SftpFileStreamTest_SetLength_SessionOpen_FIleAccessWrite.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileStreamTest_Write_SessionOpen_CountGreatherThanTwoTimesTheWriteBufferSize.cs">
<Link>Classes\Sftp\SftpFileStreamTest_Write_SessionOpen_CountGreatherThanTwoTimesTheWriteBufferSize.cs</Link>
</Compile>
<Compile Include="..\Renci.SshNet.Tests\Classes\Sftp\SftpFileSystemInformationTest.cs">
<Link>Classes\Sftp\SftpFileSystemInformationTest.cs</Link>
</Compile>
Expand Down
29 changes: 25 additions & 4 deletions src/Renci.SshNet.Tests/Classes/BaseClientTest_Connected_KeepAlivesNotSentConcurrently.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@ public class BaseClientTest_Connected_KeepAlivesNotSentConcurrently
{
private Mock<IServiceFactory> _serviceFactoryMock;
private Mock<ISession> _sessionMock;
private MockSequence _mockSequence;
private BaseClient _client;
private ConnectionInfo _connectionInfo;
private ManualResetEvent _keepAliveSent;

[TestInitialize]
public void Setup()
Expand All @@ -24,20 +26,33 @@ public void Setup()
[TestCleanup]
public void Cleanup()
{
if (_client != null)
{
_sessionMock.InSequence(_mockSequence).Setup(p => p.OnDisconnecting());
_sessionMock.InSequence(_mockSequence).Setup(p => p.Dispose());
_client.Dispose();
}
}

protected void Arrange()
{
_connectionInfo = new ConnectionInfo("host", "user", new PasswordAuthenticationMethod("user", "pwd"));
_keepAliveSent = new ManualResetEvent(false);

_serviceFactoryMock = new Mock<IServiceFactory>(MockBehavior.Strict);
_sessionMock = new Mock<ISession>(MockBehavior.Strict);

_serviceFactoryMock.Setup(p => p.CreateSession(_connectionInfo)).Returns(_sessionMock.Object);
_sessionMock.Setup(p => p.Connect());
_sessionMock.Setup(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()))
_mockSequence = new MockSequence();

_serviceFactoryMock.InSequence(_mockSequence).Setup(p => p.CreateSession(_connectionInfo)).Returns(_sessionMock.Object);
_sessionMock.InSequence(_mockSequence).Setup(p => p.Connect());
_sessionMock.InSequence(_mockSequence).Setup(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()))
.Returns(true)
.Callback(() => Thread.Sleep(300));
.Callback(() =>
{
Thread.Sleep(300);
_keepAliveSent.Set();
});

_client = new MyClient(_connectionInfo, false, _serviceFactoryMock.Object)
{
Expand All @@ -51,6 +66,12 @@ protected void Act()
// should keep-alive message be sent concurrently, then multiple keep-alive
// message would be sent during this sleep period
Thread.Sleep(200);

// disable further keep-alives
_client.KeepAliveInterval = Session.InfiniteTimeSpan;

// wait until keep-alive has been sent at least once
Assert.IsTrue(_keepAliveSent.WaitOne(500));
}

[TestMethod]
Expand Down
155 changes: 155 additions & 0 deletions ...d_ReadMode_NoDataInReaderBufferAndReadLessBytesFromServerThanCountAndEqualToBufferSize.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
using System;
using System.IO;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using Renci.SshNet.Common;
using Renci.SshNet.Sftp;

namespace Renci.SshNet.Tests.Classes.Sftp
{
[TestClass]
public class SftpFileStreamTest_Read_ReadMode_NoDataInReaderBufferAndReadLessBytesFromServerThanCountAndEqualToBufferSize : SftpFileStreamTestBase
{
private string _path;
private SftpFileStream _target;
private byte[] _handle;
private uint _bufferSize;
private uint _readBufferSize;
private uint _writeBufferSize;
private int _actual;
private byte[] _buffer;
private byte[] _serverData1;
private byte[] _serverData2;
private int _serverData1Length;
private int _serverData2Length;
private int _numberOfBytesToRead;

protected override void SetupData()
{
base.SetupData();

var random = new Random();
_path = random.Next().ToString();
_handle = GenerateRandom(5, random);
_bufferSize = (uint)random.Next(1, 1000);
_readBufferSize = 20;
_writeBufferSize = 500;

_numberOfBytesToRead = (int) _readBufferSize + 5; // greather than read buffer size
_buffer = new byte[_numberOfBytesToRead];
_serverData1Length = (int) _readBufferSize; // equal to read buffer size
_serverData1 = GenerateRandom(_serverData1Length, random);
_serverData2Length = (int) _readBufferSize; // equal to read buffer size
_serverData2 = GenerateRandom(_serverData2Length, random);

Assert.IsTrue(_serverData1Length < _numberOfBytesToRead && _serverData1Length == _readBufferSize);
}

protected override void SetupMocks()
{
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.RequestOpen(_path, Flags.Read, false))
.Returns(_handle);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.CalculateOptimalReadLength(_bufferSize))
.Returns(_readBufferSize);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.CalculateOptimalWriteLength(_bufferSize, _handle))
.Returns(_writeBufferSize);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.IsOpen)
.Returns(true);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.RequestRead(_handle, 0UL, _readBufferSize))
.Returns(_serverData1);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.RequestRead(_handle, (ulong)_serverData1.Length, _readBufferSize))
.Returns(_serverData2);
}

[TestCleanup]
public void TearDown()
{
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.RequestClose(_handle));
}

protected override void Arrange()
{
base.Arrange();

_target = new SftpFileStream(SftpSessionMock.Object,
_path,
FileMode.Open,
FileAccess.Read,
(int)_bufferSize);
}

protected override void Act()
{
_actual = _target.Read(_buffer, 0, _numberOfBytesToRead);
}

[TestMethod]
public void ReadShouldHaveReturnedTheNumberOfBytesRequested()
{
Assert.AreEqual(_numberOfBytesToRead, _actual);
}

[TestMethod]
public void ReadShouldHaveWrittenBytesToTheCallerSuppliedBuffer()
{
Assert.IsTrue(_serverData1.IsEqualTo(_buffer.Take(_serverData1Length)));

var bytesWrittenFromSecondRead = _numberOfBytesToRead - _serverData1Length;
Assert.IsTrue(_serverData2.Take(bytesWrittenFromSecondRead).IsEqualTo(_buffer.Take(_serverData1Length, bytesWrittenFromSecondRead)));
}

[TestMethod]
public void PositionShouldReturnNumberOfBytesWrittenToCallerProvidedBuffer()
{
SftpSessionMock.InSequence(MockSequence).Setup(p => p.IsOpen).Returns(true);

Assert.AreEqual(_actual, _target.Position);

SftpSessionMock.Verify(p => p.IsOpen, Times.Exactly(2));
}

[TestMethod]
public void ReadShouldReturnAllRemaningBytesFromReadBufferWhenCountIsEqualToNumberOfRemainingBytes()
{
SftpSessionMock.InSequence(MockSequence).Setup(p => p.IsOpen).Returns(true);

var numberOfBytesRemainingInReadBuffer = _serverData1Length + _serverData2Length - _numberOfBytesToRead;

_buffer = new byte[numberOfBytesRemainingInReadBuffer];

var actual = _target.Read(_buffer, 0, _buffer.Length);

Assert.AreEqual(_buffer.Length, actual);
Assert.IsTrue(_serverData2.Take(_numberOfBytesToRead - _serverData1Length, _buffer.Length).IsEqualTo(_buffer));

SftpSessionMock.Verify(p => p.IsOpen, Times.Exactly(2));
}

[TestMethod]
public void ReadShouldReturnAllRemaningBytesFromReadBufferAndReadAgainWhenCountIsGreaterThanNumberOfRemainingBytesAndNewReadReturnsZeroBytes()
{
SftpSessionMock.InSequence(MockSequence).Setup(p => p.IsOpen).Returns(true);
SftpSessionMock.InSequence(MockSequence).Setup(p => p.RequestRead(_handle, (ulong)(_serverData1Length + _serverData2Length), _readBufferSize)).Returns(Array<byte>.Empty);

var numberOfBytesRemainingInReadBuffer = _serverData1Length + _serverData2Length - _numberOfBytesToRead;

_buffer = new byte[numberOfBytesRemainingInReadBuffer + 1];

var actual = _target.Read(_buffer, 0, _buffer.Length);

Assert.AreEqual(numberOfBytesRemainingInReadBuffer, actual);
Assert.IsTrue(_serverData2.Take(_numberOfBytesToRead - _serverData1Length, numberOfBytesRemainingInReadBuffer).IsEqualTo(_buffer.Take(numberOfBytesRemainingInReadBuffer)));
Assert.AreEqual(0, _buffer[numberOfBytesRemainingInReadBuffer]);

SftpSessionMock.Verify(p => p.IsOpen, Times.Exactly(2));
SftpSessionMock.Verify(p => p.RequestRead(_handle, (ulong)(_serverData1Length + _serverData2Length), _readBufferSize));
}
}
}
Loading