Skip to content

Fix Seek Operations in SftpFileStream #910

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
drieseng merged 7 commits into from
Nov 29, 2022
Merged

Fix Seek Operations in SftpFileStream #910

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bdcf48b
Update .gitignore
lemonyte Jan 5, 2022
a6b5e6e
Fix offset operations in SftpFileStream.Seek
lemonyte Jan 5, 2022
161c87e
Fix seek exception message and add default case for invalid seek origin
lemonyte Feb 16, 2022
731571c
Revert .gitignore changes
lemonyte Nov 18, 2022
fcf3c56
Use named params when throwing ArgumentException
lemonyte Nov 18, 2022
0cf229a
Add tests for seeking from end of file
lemonyte Nov 18, 2022
8d7e004
Fix seek tests
lemonyte Nov 18, 2022
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
102 changes: 102 additions & 0 deletions .../Sftp/SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginEndAndOffsetNegative.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
using System;
using System.IO;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using Renci.SshNet.Sftp;

namespace Renci.SshNet.Tests.Classes.Sftp
{
[TestClass]
public class SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginEndAndOffsetNegative : SftpFileStreamTestBase
{
private Random _random;
private string _path;
private FileMode _fileMode;
private FileAccess _fileAccess;
private int _bufferSize;
private uint _readBufferSize;
private uint _writeBufferSize;
private byte[] _handle;
private SftpFileStream _target;
private int _offset;
private SftpFileAttributes _attributes;
private EndOfStreamException _actualException;

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

_random = new Random();
_path = _random.Next().ToString();
_fileMode = FileMode.OpenOrCreate;
_fileAccess = FileAccess.Read;
_bufferSize = _random.Next(5, 1000);
_readBufferSize = (uint)_random.Next(5, 1000);
_writeBufferSize = (uint)_random.Next(5, 1000);
_handle = GenerateRandom(_random.Next(1, 10), _random);
_offset = _random.Next(int.MinValue, -1);
_attributes = SftpFileAttributes.Empty;
}

protected override void SetupMocks()
{
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.RequestOpen(_path, Flags.Read | Flags.CreateNewOrOpen, false))
.Returns(_handle);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.CalculateOptimalReadLength((uint)_bufferSize))
.Returns(_readBufferSize);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.CalculateOptimalWriteLength((uint)_bufferSize, _handle))
.Returns(_writeBufferSize);
SftpSessionMock.InSequence(MockSequence).Setup(p => p.IsOpen).Returns(true);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.RequestFStat(_handle, false))
.Returns(_attributes);
}

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

_target = new SftpFileStream(SftpSessionMock.Object, _path, _fileMode, _fileAccess, _bufferSize);
}

protected override void Act()
{
try
{
_target.Seek(_offset, SeekOrigin.End);
Assert.Fail();
}
catch (EndOfStreamException ex)
{
_actualException = ex;
}
}

[TestMethod]
public void SeekShouldHaveThrownEndOfStreamException()
{
Assert.IsNotNull(_actualException);
Assert.IsNull(_actualException.InnerException);
Assert.AreEqual("Attempted to read past the end of the stream.", _actualException.Message);
}

[TestMethod]
public void IsOpenOnSftpSessionShouldHaveBeenInvokedOnce()
{
SftpSessionMock.Verify(p => p.IsOpen, Times.Once);
}

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

Assert.AreEqual(0L, _target.Position);

SftpSessionMock.Verify(p => p.IsOpen, Times.Exactly(2));
}
}
}
92 changes: 92 additions & 0 deletions .../Sftp/SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginEndAndOffsetPositive.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
using System;
using System.IO;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using Renci.SshNet.Sftp;

namespace Renci.SshNet.Tests.Classes.Sftp
{
[TestClass]
public class SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginEndAndOffsetPositive : SftpFileStreamTestBase
{
private Random _random;
private string _path;
private FileMode _fileMode;
private FileAccess _fileAccess;
private int _bufferSize;
private uint _readBufferSize;
private uint _writeBufferSize;
private byte[] _handle;
private SftpFileStream _target;
private int _offset;
private SftpFileAttributes _attributes;
private long _actual;

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

_random = new Random();
_path = _random.Next().ToString();
_fileMode = FileMode.OpenOrCreate;
_fileAccess = FileAccess.Read;
_bufferSize = _random.Next(5, 1000);
_readBufferSize = (uint)_random.Next(5, 1000);
_writeBufferSize = (uint)_random.Next(5, 1000);
_handle = GenerateRandom(_random.Next(1, 10), _random);
_offset = _random.Next(1, int.MaxValue);
_attributes = SftpFileAttributes.Empty;
}

protected override void SetupMocks()
{
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.RequestOpen(_path, Flags.Read | Flags.CreateNewOrOpen, false))
.Returns(_handle);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.CalculateOptimalReadLength((uint)_bufferSize))
.Returns(_readBufferSize);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.CalculateOptimalWriteLength((uint)_bufferSize, _handle))
.Returns(_writeBufferSize);
SftpSessionMock.InSequence(MockSequence).Setup(p => p.IsOpen).Returns(true);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.RequestFStat(_handle, false))
.Returns(_attributes);
}

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

_target = new SftpFileStream(SftpSessionMock.Object, _path, _fileMode, _fileAccess, _bufferSize);
}

protected override void Act()
{
_actual = _target.Seek(_offset, SeekOrigin.End);
}

[TestMethod]
public void SeekShouldHaveReturnedOffset()
{
Assert.AreEqual(_offset, _actual);
}

[TestMethod]
public void IsOpenOnSftpSessionShouldHaveBeenInvokedOnce()
{
SftpSessionMock.Verify(p => p.IsOpen, Times.Once);
}

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

Assert.AreEqual(_offset, _target.Position);

SftpSessionMock.Verify(p => p.IsOpen, Times.Exactly(2));
}
}
}
90 changes: 90 additions & 0 deletions ...sses/Sftp/SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginEndAndOffsetZero.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
using System;
using System.IO;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using Renci.SshNet.Sftp;

namespace Renci.SshNet.Tests.Classes.Sftp
{
[TestClass]
public class SftpFileStreamTest_Seek_PositionedAtBeginningOfStream_OriginEndAndOffsetZero : SftpFileStreamTestBase
{
private Random _random;
private string _path;
private FileMode _fileMode;
private FileAccess _fileAccess;
private int _bufferSize;
private uint _readBufferSize;
private uint _writeBufferSize;
private byte[] _handle;
private SftpFileStream _target;
private SftpFileAttributes _attributes;
private long _actual;

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

_random = new Random();
_path = _random.Next().ToString();
_fileMode = FileMode.OpenOrCreate;
_fileAccess = FileAccess.Read;
_bufferSize = _random.Next(5, 1000);
_readBufferSize = (uint)_random.Next(5, 1000);
_writeBufferSize = (uint)_random.Next(5, 1000);
_handle = GenerateRandom(_random.Next(1, 10), _random);
_attributes = SftpFileAttributes.Empty;
}

protected override void SetupMocks()
{
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.RequestOpen(_path, Flags.Read | Flags.CreateNewOrOpen, false))
.Returns(_handle);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.CalculateOptimalReadLength((uint)_bufferSize))
.Returns(_readBufferSize);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.CalculateOptimalWriteLength((uint)_bufferSize, _handle))
.Returns(_writeBufferSize);
SftpSessionMock.InSequence(MockSequence).Setup(p => p.IsOpen).Returns(true);
SftpSessionMock.InSequence(MockSequence)
.Setup(p => p.RequestFStat(_handle, false))
.Returns(_attributes);
}

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

_target = new SftpFileStream(SftpSessionMock.Object, _path, _fileMode, _fileAccess, _bufferSize);
}

protected override void Act()
{
_actual = _target.Seek(0L, SeekOrigin.End);
}

[TestMethod]
public void SeekShouldHaveReturnedZero()
{
Assert.AreEqual(0L, _actual);
}

[TestMethod]
public void IsOpenOnSftpSessionShouldHaveBeenInvokedOnce()
{
SftpSessionMock.Verify(p => p.IsOpen, Times.Once);
}

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

Assert.AreEqual(0L, _target.Position);

SftpSessionMock.Verify(p => p.IsOpen, Times.Exactly(2));
}
}
}
62 changes: 22 additions & 40 deletions src/Renci.SshNet/Sftp/SftpFileStream.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -788,26 +788,6 @@ public override long Seek(long offset, SeekOrigin origin)
{
// Flush the write buffer and then seek.
FlushWriteBuffer();

switch (origin)
{
case SeekOrigin.Begin:
newPosn = offset;
break;
case SeekOrigin.Current:
newPosn = _position + offset;
break;
case SeekOrigin.End:
var attributes = _session.RequestFStat(_handle, false);
newPosn = attributes.Size - offset;
break;
}

if (newPosn == -1)
{
throw new EndOfStreamException("End of stream.");
}
_position = newPosn;
}
else
{
Expand Down Expand Up @@ -838,29 +818,31 @@ public override long Seek(long offset, SeekOrigin origin)
// Abandon the read buffer.
_bufferPosition = 0;
_bufferLen = 0;
}

// Seek to the new position.
switch (origin)
{
case SeekOrigin.Begin:
newPosn = offset;
break;
case SeekOrigin.Current:
newPosn = _position + offset;
break;
case SeekOrigin.End:
var attributes = _session.RequestFStat(_handle, false);
newPosn = attributes.Size - offset;
break;
}

if (newPosn < 0)
{
throw new EndOfStreamException();
}
// Seek to the new position.
switch (origin)
{
case SeekOrigin.Begin:
newPosn = offset;
break;
case SeekOrigin.Current:
newPosn = _position + offset;
break;
case SeekOrigin.End:
var attributes = _session.RequestFStat(_handle, false);
newPosn = attributes.Size + offset;
break;
default:
throw new ArgumentException(message: "Invalid seek origin.", paramName: "origin");
}

_position = newPosn;
if (newPosn < 0)
{
throw new EndOfStreamException();
}

_position = newPosn;
return _position;
}
}
Expand Down