Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ simply by adding a parameter named `sftpserver` to your test function:
As can be seen from this example `sftpserver` serves content directly from
python objects instead of files.

It is also possible to use the package without `pytest`:

.. code-block:: python

from pytest_sftpserver import sftpserver_factory

@sftpserver_factory()
def test_sftp_fetch(sftpserver):
with sftpserver.serve_content({'a_dir': {'somefile.txt': "File content"}}):
assert get_sftp_file(sftpserver.host, sftpserver.port, "user",
"pw", "/a_dir/somefile.txt") == "File content"

Installation
============
Expand Down
6 changes: 2 additions & 4 deletions pytest_sftpserver/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
VERSION = (1, 3, 0)
from pytest_sftpserver.decorator import sftpserver_factory # noqa: F401


def get_version():
return ".".join(str(i) for i in VERSION)
from .__version__ import VERSION, get_version # noqa: F401
5 changes: 5 additions & 0 deletions pytest_sftpserver/__version__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
VERSION = (1, 3, 0)


def get_version():
return ".".join(str(i) for i in VERSION)
23 changes: 23 additions & 0 deletions pytest_sftpserver/decorator.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
from functools import wraps

from pytest_sftpserver.sftp.server import SFTPServer


class sftpserver_factory(object):
def __enter__(self):
self.server = SFTPServer()
self.server.start()
return self.server

def __exit__(self, *args, **kwargs):
if self.server.is_alive():
self.server.shutdown()

def __call__(self, func):
@wraps(func)
def wrapper(*args, **kwargs):
with self:
kwargs["sftpserver"] = self.server
return func(*args, **kwargs)

return wrapper
11 changes: 3 additions & 8 deletions pytest_sftpserver/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,10 @@

import pytest

from pytest_sftpserver.sftp.server import SFTPServer
from pytest_sftpserver.decorator import sftpserver_factory


@pytest.yield_fixture(scope="session")
def sftpserver(request):
server = SFTPServer()
server.start()

yield server

if server.is_alive():
server.shutdown()
with sftpserver_factory() as server:
yield server
22 changes: 20 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,25 @@
import codecs
import os
import re

from setuptools import setup, find_packages, Command

here = os.path.abspath(os.path.dirname(__file__))


def read(*parts):
with codecs.open(os.path.join(here, *parts), 'r') as fp:
return fp.read()


version = __import__('pytest_sftpserver').get_version()
def find_version(*file_paths):
version_file = read(*file_paths)
version_match = re.search(
r"^VERSION = \(([^\)]*)\)", version_file, re.M
)
if version_match:
return '.'.join(i.strip() for i in version_match.group(1).split(','))
raise RuntimeError('Unable to find version string.')


class Test(Command):
Expand All @@ -23,7 +41,7 @@ def run(self):

setup(
name='pytest-sftpserver',
version=version,
version=find_version('pytest_sftpserver', '__version__.py'),
author='Ulrich Petri',
author_email='[email protected]',
license='MIT License',
Expand Down
6 changes: 6 additions & 0 deletions tests/test_sftp.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from paramiko.channel import Channel
from paramiko.sftp_client import SFTPClient

from pytest_sftpserver import sftpserver_factory
from pytest_sftpserver.sftp.server import SFTPServer

# fmt: off
Expand Down Expand Up @@ -188,3 +189,8 @@ def test_sftpserver_chmod_non_existing(sftpclient, sftpserver):
with sftpserver.serve_content({}):
with pytest.raises(IOError):
sftpclient.chmod("/a", 600)


@sftpserver_factory()
def test_decorator(sftpserver):
assert isinstance(sftpserver, SFTPServer)