Circleci (#12)

Upgrade libssh to 0.9.4
Added tests and manylinux builds on CircleCI
Updated manylinux builds to 2010

Author: pkittenis

.appveyor.yml

@@ -3,59 +3,29 @@ environment:
     # SDK v7.0 MSVC Express 2008's SetEnv.cmd script will fail if the
     # /E:ON and /V:ON options are not enabled in the batch script intepreter
     # See: http://stackoverflow.com/a/13751649/163740
-    CMD_IN_ENV: "cmd /E:ON /V:ON /C %APPVEYOR_BUILD_FOLDER%\\ci\\appveyor\\run_with_env.cmd"
+    # CMD_IN_ENV: "cmd /E:ON /V:ON /C %APPVEYOR_BUILD_FOLDER%\\ci\\appveyor\\run_with_env.cmd"
     PYTHONUNBUFFERED: 1
-    EMBEDDED_LIB: 1
-    OPENSSL_VER: 1.0.2l
+    OPENSSL_VER: 1.1.0h
+    SYSTEM_LIBSSH: 1
     PYPI_USER:
       secure: 2m0jy6JD/R9RExIosOT6YA==
     PYPI_PASS:
       secure: x+dF0A8BZUf2IrPNRN1O0w==
   matrix:
-    - PYTHON: "C:\\Python27"
-      PYTHON_VERSION: "2.7"
-      PYTHON_ARCH: "32"
-      MSVC: "Visual Studio 9"
-      ARCH: i386
-
-    - PYTHON: "C:\\Python27-x64"
-      PYTHON_VERSION: "2.7"
-      PYTHON_ARCH: "64"
-      MSVC: "Visual Studio 9"
-      ARCH: x64_86
-
-    - PYTHON: "C:\\Python34"
-      PYTHON_VERSION: "3.4"
-      PYTHON_ARCH: "32"
-      MSVC: "Visual Studio 10"
-      ARCH: i386
-
-    - PYTHON: "C:\\Python34-x64"
-      PYTHON_VERSION: "3.4"
+    - PYTHON: "C:\\Python36-x64"
+      PYTHON_VERSION: "3.6"
       PYTHON_ARCH: "64"
-      MSVC: "Visual Studio 10 Win64"
+      MSVC: "Visual Studio 14 Win64"
       ARCH: x64_86
 
-    - PYTHON: "C:\\Python35"
-      PYTHON_VERSION: "3.5"
-      PYTHON_ARCH: "32"
-      MSVC: "Visual Studio 14"
-      ARCH: i386
-
-    - PYTHON: "C:\\Python35-x64"
-      PYTHON_VERSION: "3.5"
+    - PYTHON: "C:\\Python37-x64"
+      PYTHON_VERSION: "3.7"
       PYTHON_ARCH: "64"
       MSVC: "Visual Studio 14 Win64"
       ARCH: x64_86
 
-    - PYTHON: "C:\\Python36"
-      PYTHON_VERSION: "3.6"
-      PYTHON_ARCH: "32"
-      MSVC: "Visual Studio 14"
-      ARCH: i386
-
-    - PYTHON: "C:\\Python36-x64"
-      PYTHON_VERSION: "3.6"
+    - PYTHON: "C:\\Python38-x64"
+      PYTHON_VERSION: "3.8"
       PYTHON_ARCH: "64"
       MSVC: "Visual Studio 14 Win64"
       ARCH: x64_86
@@ -92,31 +62,37 @@ install:
   # target Python version and architecture
   - "%CMD_IN_ENV% pip install -r requirements_dev.txt"
   - "%CMD_IN_ENV% pip install -U wheel setuptools twine"
-  - git submodule update --init --recursive
 
   # .c files need to be generated on Windows to handle platform
   # specific code.
   # Fix version used by versioneer to current git tag so the generated .c files
   # do not cause a version change.
   - python ci/appveyor/fix_version.py .
   - mv -f .git .git.bak
-  - appveyor DownloadFile http://zlib.net/zlib1211.zip
-  - 7z x zlib1211.zip
-  - appveyor DownloadFile https://indy.fulgan.com/SSL/openssl-%OPENSSL_VER%-%ARCH%-win%PYTHON_ARCH%.zip
-  - 7z x openssl-%OPENSSL_VER%-%ARCH%-win%PYTHON_ARCH%.zip
-  - cp ssleay32.dll ssh2\
-  - cp libeay32.dll ssh2\
-  - ps: ls ssh2
+  - IF NOT "%PYTHON_VERSION%" == "2.7" (
+      7z x ci\appveyor\zlib1211.zip
+      7z x ci\appveyor\kfw-4.1-src.zip
+      appveyor DownloadFile https://indy.fulgan.com/SSL/Archive/Experimental/openssl-%OPENSSL_VER%-x%PYTHON_ARCH%-VC2017.zip
+      7z x openssl-%OPENSSL_VER%-x%PYTHON_ARCH%-VC2017.zip
+      cp openssl-%OPENSSL_VER%-x%PYTHON_ARCH%-VC2017\libssl-1_1-x%PYTHON_ARCH%.dll ssh\ || cp openssl-%OPENSSL_VER%-x%PYTHON_ARCH%-VC2017\libssl-1_1.dll ssh\
+      cp openssl-%OPENSSL_VER%-x%PYTHON_ARCH%-VC2017\libcrypto-1_1-x%PYTHON_ARCH%.dll ssh\ || cp openssl-%OPENSSL_VER%-x%PYTHON_ARCH%-VC2017\libcrypto-1_1.dll ssh\
+    )
+  - ps: ls ssh
+  - ps: ls
 
 build_script:
+  - "%CMD_IN_ENV% ci\\appveyor\\build_krb.bat"
   - "%CMD_IN_ENV% ci\\appveyor\\build_zlib.bat"
-  - "%CMD_IN_ENV% ci\\appveyor\\build_ssh2.bat"
-  - rm -f ssh2/*.c
+  - "%CMD_IN_ENV% ci\\appveyor\\build_ssh.bat"
+  - rm -f ssh/*.c
+  - "%CMD_IN_ENV% python setup.py build_ext -I ci/appveyor/include"
   - "%CMD_IN_ENV% python setup.py build"
-  - "%CMD_IN_ENV% python setup.py build_ext -i"
+  - "%CMD_IN_ENV% python setup.py install"
 
 test_script:
-  - python -c "from ssh2.session import Session; Session()"
+  - cd dist
+  - python ..\\ci\\appveyor\\import_test.py
+  - cd ..
 
 after_test:
   # If tests are successful, create binary packages for the project.

.circleci/config.yml

@@ -0,0 +1,114 @@
+version: 2.1
+
+orbs:
+  python: circleci/python@0.3.2
+
+jobs:
+  python_test:
+    parameters:
+      python_ver:
+        type: string
+        default: "3.6"
+    docker:
+      - image: circleci/python:<< parameters.python_ver >>
+    steps:
+      - checkout
+      - python/load-cache:
+          dependency-file: requirements_dev.txt
+          key: depsv3-{{ .Branch }}.{{ arch }}-PY<< parameters.python_ver >>
+      - run:
+          name: Deps
+          command: |
+            sudo apt-get install cmake openssh-server
+            pip install flake8 jinja2 sphinx sphinx_rtd_theme pytest pytest-rerunfailures
+      - python/save-cache:
+          dependency-file: requirements_dev.txt
+          key: depsv3-{{ .Branch }}.{{ arch }}-PY<< parameters.python_ver >>
+      - run:
+          command: |
+            python setup.py build_ext --inplace
+            eval "$(ssh-agent -s)"
+          name: Build
+      - run:
+          command: |
+            ls -lhtr ssh/
+            pwd
+            pytest tests
+            flake8 ssh
+            python setup.py sdist
+            cd dist; pip install *; cd ..
+          name: Test
+  osx:
+    macos:
+      xcode: 11.6.0
+    environment:
+      HOMEBREW_NO_AUTO_UPDATE: 1
+      PYENV: 3.6.11
+      SYSTEM_LIBSSH: 1
+    steps:
+      - checkout
+      - run:
+          name: deps
+          command: |
+            brew install cmake git-lfs
+            pip install twine
+            which twine
+  manylinux:
+    machine:
+      image: ubuntu-1604:201903-01
+    steps:
+      - checkout
+      - python/load-cache:
+          key: manylinuxdepsv6-{{ .Branch }}.{{ arch }}
+          dependency-file: requirements_dev.txt
+      - run:
+          name: Git LFS
+          command: |
+            curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash
+            sudo apt-get install git-lfs
+            git lfs install
+            git lfs pull
+      - run:
+          name: Deps
+          command: |
+            sudo apt-get install python-pip
+            pip install -U pip
+            pip install twine
+            which twine
+      - python/save-cache:
+          key: manylinuxdepsv6-{{ .Branch }}.{{ arch }}
+          dependency-file: requirements_dev.txt
+      - run:
+          name: Build Wheels
+          command: |
+            if [[ -z "${CIRCLE_PULL_REQUEST}" ]]; then
+              echo "$DOCKER_PASSWORD" | docker login -u="$DOCKER_USERNAME" --password-stdin;
+            fi
+            ./ci/travis/build-manylinux.sh
+      - run:
+          name: Upload Wheels
+          command: twine upload --skip-existing -u $PYPI_USER -p $PYPI_PASSWORD wheelhouse/*
+workflows:
+  version: 2.1
+  main:
+    jobs:
+      - python_test:
+          matrix:
+            parameters:
+              python_ver:
+                - "3.6"
+                - "3.7"
+                - "3.8"
+      - manylinux:
+          context: Docker
+          requires:
+            - python_test
+          filters:
+            branches:
+              ignore: /.*/
+            tags:
+              only: /.*/
+      # - osx
+        # filters:
+        #   tags:
+        #     only: /.*/

.gitattributes

@@ -0,0 +1,2 @@
+*.tar.gz filter=lfs diff=lfs merge=lfs -text
+*.rpm filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -3,4 +3,6 @@
 dist
 build
 *~
-*.so
+*.so*
+src
+libssh/compile_commands.json

.travis.yml

@@ -1,15 +1,20 @@
 language: python
-cache: pip
+cache:
+  - pip
+  - directories:
+      - "$HOME/.pyenv"
+      - "$HOME/Library/Caches/Homebrew"
+      - "$HOME/.git/lfs"
 notifications:
   email: false
 sudo: required
 services:
   - docker
 python:
   - 2.7
-  - 3.4
-  - 3.5
   - 3.6
+  - 3.7
+  - 3.8
 addons:
   apt:
     packages:
@@ -22,11 +27,10 @@ install:
   - python setup.py build_ext --inplace
   - eval "$(ssh-agent -s)"
 script:
-  - nosetests
+  - pytest tests
   - flake8 ssh
   - python setup.py sdist
   - cd dist; pip install *; cd ..
-  - cd doc; make html; cd ..
 jobs:
   include:
     - stage: build wheels

Changelog.rst

@@ -1,6 +1,21 @@
 Change Log
 =============
 
+0.4.0
++++++++
+
+Changes
+--------
+
+* Updated error handling code to check for SSH status codes and correctly raise exceptions or return error code with no exception in non-blocking mode.
+* Updated embedded libssh to ``0.9.4``.
+* Added known host session API method implementations.
+
+Packaging
+----------
+
+* Added manylinux 2010 binary wheels.
+
 0.3.0
 ++++++++
 

README.rst

@@ -9,13 +9,18 @@ Bindings for libssh_ C library.
 .. image:: https://img.shields.io/pypi/v/ssh-python.svg
    :target: https://pypi.python.org/pypi/ssh-python
    :alt: Latest Version
+.. image:: https://circleci.com/gh/ParallelSSH/ssh-python/tree/master.svg?style=shield
+   :target: https://circleci.com/gh/ParallelSSH/ssh-python/tree/master
+.. image:: https://img.shields.io/pypi/wheel/ssh-python.svg
+   :target: https://pypi.python.org/pypi/ssh-python
+.. image:: https://img.shields.io/pypi/pyversions/ssh-python.svg
+   :target: https://pypi.python.org/pypi/ssh-python
 
 Installation
 _____________
 
-Currently only installation from source is provided. Binary wheels to follow.
+Binary wheels are provided for Linux, OSX and Windows wheels to follow.
 
-To install from source, run the following:
 
 .. code-block:: shell
 
@@ -31,7 +36,8 @@ Prerequisites
 * OpenSSL *or* gcrypt library and development headers
 * Optionally Zlib library and development headers for compression
 
-``Libssh`` source code is embedded in this project and will be built when installation is triggered per above instructions. Versions of ``libssh`` other than the one embedded in this project are not supported.
+``Libssh`` source code is embedded in this project and will be built when installation is triggered per above instructions.
+Versions of ``libssh`` other than the one embedded in this project are not supported.
 
 
 Quick Start
@@ -48,6 +54,7 @@ _____________
    from ssh.session import Session
    from ssh import options
 
+   # Linux only
    USERNAME = pwd.getpwuid(os.geteuid()).pw_name
    HOST = 'localhost'
 
@@ -79,11 +86,14 @@ _________
 
 The library uses `Cython`_ based native code extensions as wrappers to ``libssh``.
 
-* Thread safe - GIL is released as much as possible
+* Thread safe - GIL released as much as possible
 * Very low overhead thin wrapper
-* Object oriented - memory freed automatically and safely as objects are garbage collected by Python
-* Use Python semantics where applicable, such as context manager and iterator support for opening and reading from channels and SFTP file handles
-* Raise errors as Python exceptions
+* Object oriented
+  * Memory freed automatically and safely as objects are garbage collected by Python
+* Uses Python semantics where applicable
+  * channel/file handle context manager support
+  * channel/file handle iterator support
+* Raises low level C errors as Python exceptions
 
 
 .. _libssh: https://www.libssh.org

_setup_libssh.py

@@ -23,5 +23,5 @@ def build_ssh():
     check_call(['make', '-j%s' % (cpu_count(),)])
     os.chdir('..')
 
-    for src in glob('src/src/libssh.so*'):
+    for src in glob('src/lib/libssh.so*'):
         copy2(src, 'ssh/')

ci/appveyor/build_krb.bat

@@ -0,0 +1,7 @@
+set KRB_INSTALL_DIR=%APPVEYOR_HOME_DIR%/src/lib
+set CPU=AMD64
+setenv /x64 /release
+cd kfw-4.1/src
+nmake
+nmake install
+cd ../..