Introduce initial project code standards

Added and applied code standards for both Rust and Python. pre-commit hooks are now available and will be enforced in pull requests.
JacobCallahan · Mar 30, 2024 · 29b5013 · 29b5013
1 parent a4105a8
commit 29b5013
Show file tree

Hide file tree

Showing 12 changed files with 206 additions and 114 deletions.
diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml
@@ -1,4 +1,3 @@
-# This file was initially autogenerated by maturin v1.5.0
 name: Build and Test
 
 on:
@@ -16,7 +15,36 @@ permissions:
   contents: read
 
 jobs:
+  code_checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Run pre-commit checks
+        run: |
+          pip install pre-commit
+          pre-commit run --all-files
+
+  sdist:
+    needs: [code_checks]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-sdist
+          path: dist
+
   linux:
+    needs: [code_checks]
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -34,7 +62,7 @@ jobs:
         with:
           target: ${{ matrix.target }}
           args: --release --out dist --find-interpreter
-          # sccache: 'true'
+          # sccache: 'true'  # Disabled due to issues with sccache on linux
           manylinux: auto
           before-script-linux: |
             # If we're running on rhel centos, install needed packages. thx s3rius!
@@ -49,37 +77,15 @@ jobs:
         with:
           name: wheels-linux-${{ matrix.target }}
           path: dist
-      # - name: Setup Docker
-      #   run: |
-      #     sudo apt-get install apt-transport-https ca-certificates curl software-properties-common
-      #     curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
-      #     sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
-      #     sudo apt-get install docker-ce
       - name: Install and Test
-        if: ${{ startsWith(matrix.target, 'x86_64') }}
         shell: bash
         run: |
           set -e
           pip install .[dev] --find-links dist --force-reinstall
           pytest -v tests/
-      # - name: Install and Test
-      #   if: ${{ !startsWith(matrix.target, 'x86') && matrix.target != 'ppc64' }}
-      #   uses: uraimo/run-on-arch-action@v2.5.0
-      #   with:
-      #     arch: ${{ matrix.target }}
-      #     distro: ubuntu22.04
-      #     githubToken: ${{ github.token }}
-      #     install: |
-      #       apt-get update
-      #       apt-get install -y --no-install-recommends python3 python3-pip
-      #       pip3 install -U pip pytest
-      #     run: |
-      #       set -e
-      #       pip3 install .[dev] --find-links dist --force-reinstall
-      #       pip3 install pytest docker
-      #       pytest -v tests/
 
   windows:
+    needs: [code_checks]
     runs-on: windows-latest
     strategy:
       matrix:
@@ -90,6 +96,12 @@ jobs:
         with:
           python-version: '3.10'
           architecture: ${{ matrix.target }}
+      - name: Set Perl environment variables
+        run: |
+          echo "PERL=$((where.exe perl)[0])" | Out-File -FilePath $env:GITHUB_ENV -Append -Encoding utf8
+          echo "OPENSSL_SRC_PERL=$((where.exe perl)[0])" | Out-File -FilePath $env:GITHUB_ENV -Append -Encoding utf8
+      - name: Remove wincred from docker config 
+        run: sed -i '/wincred/d' ~/.docker/config.json
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
@@ -101,24 +113,25 @@ jobs:
         with:
           name: wheels-windows-${{ matrix.target }}
           path: dist
-      # - name: Set up Docker Buildx
-      #   uses: docker/setup-buildx-action@v3
-      # - name: Install and Test
-      #   if: ${{ !startsWith(matrix.target, 'aarch64') }}
+      - name: Install
+        shell: bash
+        run: pip install .[dev] --find-links dist --force-reinstall
+      # Disabled on windows due to issues with docker
+      # BuildError: no matching manifest for windows/amd64 ... in the manifest list entries
+      # - name: Test
+      #   if: ${{ !startsWith(matrix.target, 'x86') }}
       #   shell: bash
-      #   run: |
-      #     set -e
-      #     pip install .[dev] --find-links dist --force-reinstall
-      #     pip install pytest docker
-      #     pytest -v tests/
+      #   run: pytest -v tests/
 
   macos:
+    needs: [code_checks]
     runs-on: macos-latest
     strategy:
       matrix:
         target: [x86_64, aarch64]
     env:
       OPENSSL_NO_VENDOR: 1
+      DOCKER_HOST: unix:///var/run/docker.sock
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
@@ -137,27 +150,15 @@ jobs:
         with:
           name: wheels-macos-${{ matrix.target }}
           path: dist
-      # - name: Install and Test
-      #   if: ${{ !startsWith(matrix.target, 'aarch64') }}
-      #   shell: bash
+      # - name: setup-docker
       #   run: |
-      #     set -e
-      #     pip install .[dev] --find-links dist --force-reinstall
-      #     pip install pytest docker pexpect
-      #     pytest -v tests/
-
-  sdist:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Build sdist
-        uses: PyO3/maturin-action@v1
-        with:
-          command: sdist
-          args: --out dist
-      - name: Upload sdist
-        uses: actions/upload-artifact@v4
-        with:
-          name: wheels-sdist
-          path: dist
-
+      #     brew install docker
+      #     open --background -a Docker
+      #     while ! docker info &> /dev/null; do sleep 1; done
+      - name: Install
+        shell: bash
+        run: pip install .[dev] --find-links dist --force-reinstall
+      # Disabled on macos due to issues with docker
+      # - name: Test
+      #   shell: bash
+      #   run: pytest -v tests/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,23 @@
+# checks and formatting for rust code
+repos:
+- repo: local
+  hooks:
+    - id: cargo-fmt
+      name: cargo fmt
+      entry: cargo fmt --
+      language: system
+      types: [rust]
+      pass_filenames: false
+- repo: https://github.com/doublify/pre-commit-rust
+  rev: v1.0
+  hooks:
+    - id: clippy
+
+# checks and formatting for python code
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.3.4
+  hooks:
+    - id: ruff-format  # Formatter
+    - id: ruff  # Linter
+      args: [--fix, --exit-non-zero-on-fix]
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # Hussh: SSH for humans.
 [![image](https://img.shields.io/pypi/v/hussh.svg)](https://pypi.python.org/pypi/hussh)
 [![image](https://img.shields.io/pypi/pyversions/hussh.svg)](https://pypi.python.org/pypi/hussh)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/hussh)
 [![Actions status](https://github.com/jacobcallahan/hussh/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/jacobcallahan/hussh/actions)
 
 Hussh (pronounced "hush") is a client-side ssh library that offers low level performance through a high level interface.

diff --git a/benchmarks/bench_fabric.py b/benchmarks/bench_fabric.py
@@ -1,8 +1,9 @@
 import json
-import memray
-import timeit
-from pprint import pprint
 from pathlib import Path
+from pprint import pprint
+import timeit
+
+import memray
 
 results_dict = {}
 
@@ -71,7 +72,7 @@
 pprint(results_dict, sort_dicts=False)
 
 if Path("bench_results.json").exists():
-   results = json.loads(Path("bench_results.json").read_text())
+    results = json.loads(Path("bench_results.json").read_text())
 else:
     results = {}
 results.update({"fabric": results_dict})

diff --git a/benchmarks/bench_hussh.py b/benchmarks/bench_hussh.py
@@ -1,8 +1,9 @@
 import json
-import memray
-import timeit
-from pprint import pprint
 from pathlib import Path
+from pprint import pprint
+import timeit
+
+import memray
 
 results_dict = {}
 
@@ -11,6 +12,7 @@
 with memray.Tracker("memray-bench_hussh.bin"):
     start_time = timeit.default_timer()
     from hussh import Connection
+
     results_dict["import_time"] = f"{(timeit.default_timer() - start_time) * 1000:.2f} ms"
 
     host_info = json.loads(Path("target.json").read_text())
@@ -62,7 +64,7 @@
 pprint(results_dict, sort_dicts=False)
 
 if Path("bench_results.json").exists():
-   results = json.loads(Path("bench_results.json").read_text())
+    results = json.loads(Path("bench_results.json").read_text())
 else:
     results = {}
 results.update({"hussh": results_dict})

diff --git a/benchmarks/bench_paramiko.py b/benchmarks/bench_paramiko.py
@@ -1,8 +1,9 @@
 import json
-import memray
-import timeit
-from pprint import pprint
 from pathlib import Path
+from pprint import pprint
+import timeit
+
+import memray
 
 results_dict = {}
 
@@ -11,6 +12,7 @@
 with memray.Tracker("memray-bench_paramiko.bin"):
     start_time = timeit.default_timer()
     import paramiko
+
     results_dict["import_time"] = f"{(timeit.default_timer() - start_time) * 1000:.2f} ms"
 
     host_info = json.loads(Path("target.json").read_text())
@@ -33,7 +35,6 @@
     result = stdout.read()
     results_dict["cmd_time"] = f"{(timeit.default_timer() - temp_time) * 1000:.2f} ms"
 
-
     # small file (1kb)
     temp_time = timeit.default_timer()
     sftp = ssh.open_sftp()
@@ -73,7 +74,7 @@
 pprint(results_dict, sort_dicts=False)
 
 if Path("bench_results.json").exists():
-   results = json.loads(Path("bench_results.json").read_text())
+    results = json.loads(Path("bench_results.json").read_text())
 else:
     results = {}
 results.update({"paramiko": results_dict})

diff --git a/benchmarks/bench_ssh2-python.py b/benchmarks/bench_ssh2-python.py
@@ -1,8 +1,9 @@
 import json
-import memray
-import timeit
-from pprint import pprint
 from pathlib import Path
+from pprint import pprint
+import timeit
+
+import memray
 
 results_dict = {}
 
@@ -11,8 +12,10 @@
 with memray.Tracker("memray-bench_ssh2-python.bin"):
     start_time = timeit.default_timer()
     import socket
-    from ssh2.session import Session
+
     from ssh2 import sftp
+    from ssh2.session import Session
+
     results_dict["import_time"] = f"{(timeit.default_timer() - start_time) * 1000:.2f} ms"
 
     host_info = json.loads(Path("target.json").read_text())
@@ -50,9 +53,7 @@
         | sftp.LIBSSH2_SFTP_S_IRGRP
         | sftp.LIBSSH2_SFTP_S_IROTH
     )
-    FILE_FLAGS = (
-        sftp.LIBSSH2_FXF_CREAT | sftp.LIBSSH2_FXF_WRITE | sftp.LIBSSH2_FXF_TRUNC
-    )
+    FILE_FLAGS = sftp.LIBSSH2_FXF_CREAT | sftp.LIBSSH2_FXF_WRITE | sftp.LIBSSH2_FXF_TRUNC
     data = Path("1kb.txt").read_bytes()
     sftp_conn = session.sftp_init()
     with sftp_conn.open("/root/1kb.txt", FILE_FLAGS, SFTP_MODE) as f:
@@ -61,7 +62,7 @@
 
     temp_time = timeit.default_timer()
     with sftp_conn.open("/root/1kb.txt", sftp.LIBSSH2_FXF_READ, sftp.LIBSSH2_SFTP_S_IRUSR) as f:
-        read_data= b""
+        read_data = b""
         for _rc, data in f:
             read_data += data
     Path("small.txt").write_bytes(read_data)
@@ -77,7 +78,7 @@
 
     temp_time = timeit.default_timer()
     with sftp_conn.open("/root/14kb.txt", sftp.LIBSSH2_FXF_READ, sftp.LIBSSH2_SFTP_S_IRUSR) as f:
-        read_data= b""
+        read_data = b""
         for _rc, data in f:
             read_data += data
     Path("medium.txt").write_bytes(read_data)
@@ -93,7 +94,7 @@
 
     temp_time = timeit.default_timer()
     with sftp_conn.open("/root/64kb.txt", sftp.LIBSSH2_FXF_READ, sftp.LIBSSH2_SFTP_S_IRUSR) as f:
-        read_data= b""
+        read_data = b""
         for _rc, data in f:
             read_data += data
     Path("large.txt").write_bytes(read_data)
@@ -105,7 +106,7 @@
 pprint(results_dict, sort_dicts=False)
 
 if Path("bench_results.json").exists():
-   results = json.loads(Path("bench_results.json").read_text())
+    results = json.loads(Path("bench_results.json").read_text())
 else:
     results = {}
 results.update({"ssh2-python": results_dict})