portforward 0.6.1__tar.gz → 0.7.0__tar.gz

portforward-0.7.0/.github/workflows/release.yml

@@ -0,0 +1,120 @@
+# This file is autogenerated by maturin v0.14.17
+# To update, run
+#
+#    maturin generate-ci github
+#
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+  # pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  linux:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target: [x86_64, x86, aarch64]
+        version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.version }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+          manylinux: auto
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: dist
+
+  windows:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        target: [x64, x86]
+        version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.version }}
+          architecture: ${{ matrix.target }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: dist
+
+  macos:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        target: [x86_64, aarch64]
+        version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.version }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: dist
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    if: "startsWith(github.ref, 'refs/tags/')"
+    needs: [linux, windows, macos, sdist]
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: wheels
+      - name: Publish to PyPI
+        uses: PyO3/maturin-action@v1
+        env:
+          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        with:
+          command: upload
+          args: --skip-existing *

{portforward-0.6.1 → portforward-0.7.0}/.readthedocs.yml

@@ -1,5 +1,10 @@
 version: 2
 
+build:
+    os: "ubuntu-22.04"
+    tools:
+        python: "3.10"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
     configuration: docs/conf.py
@@ -10,6 +15,5 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-    version: "3.8"
     install:
         - requirements: requirements-dev.txt

{portforward-0.6.1 → portforward-0.7.0}/Cargo.lock

@@ -1142,7 +1142,7 @@ checksum = "6ac9a59f73473f1b8d852421e59e64809f025994837ef743615c6d0c5b305160"
 
 [[package]]
 name = "portforward"
-version = "0.6.1"
+version = "0.7.0"
 dependencies = [
  "anyhow",
  "env_logger",

{portforward-0.6.1 → portforward-0.7.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "portforward"
-version = "0.6.1"
+version = "0.7.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

{portforward-0.6.1 → portforward-0.7.0}/HISTORY.rst

@@ -2,6 +2,18 @@
 History
 =======
 
+0.7.0 (2024-10-18)
+------------------
+* Allow binding to a local random free port
+
+0.6.2 (2024-06-19)
+------------------
+* Allow defining binding ip
+
+0.6.1 (2024-01-25)
+------------------
+* Fixed wrong logger setup
+
 0.6.0 (2023-06-13)
 ------------------
 * Rewrite native part in Rust with support of Py03 and maturin

{portforward-0.6.1 → portforward-0.7.0}/Makefile

@@ -66,36 +66,36 @@ servedocs: docs ## compile the docs watching for changes
 
 release-linux: clean ## creates and release linux wheels
 	mkdir -p dist
-	docker run --rm -v $(PWD):/io ghcr.io/pyo3/maturin build --release -i python3.7 --out dist --strip
 	docker run --rm -v $(PWD):/io ghcr.io/pyo3/maturin build --release -i python3.8 --out dist --strip
 	docker run --rm -v $(PWD):/io ghcr.io/pyo3/maturin build --release -i python3.9 --out dist --strip
 	docker run --rm -v $(PWD):/io ghcr.io/pyo3/maturin build --release -i python3.10 --out dist --strip
 	docker run --rm -v $(PWD):/io ghcr.io/pyo3/maturin build --release -i python3.11 --out dist --strip
+	docker run --rm -v $(PWD):/io ghcr.io/pyo3/maturin build --release -i python3.12 --out dist --strip
 
 	maturin sdist --out dist
 
 	twine upload dist/*
 
 release-macos: clean ## creates and release macos wheels
-	maturin build --release --target aarch64-apple-darwin --zig -i python3.7 --out dist --strip
 	maturin build --release --target aarch64-apple-darwin --zig -i python3.8 --out dist --strip
 	maturin build --release --target aarch64-apple-darwin --zig -i python3.9 --out dist --strip
 	maturin build --release --target aarch64-apple-darwin --zig -i python3.10 --out dist --strip
 	maturin build --release --target aarch64-apple-darwin --zig -i python3.11 --out dist --strip
+	maturin build --release --target aarch64-apple-darwin --zig -i python3.12 --out dist --strip
 
-	maturin build --release -i python3.7 --out dist --strip
 	maturin build --release -i python3.8 --out dist --strip
 	maturin build --release -i python3.9 --out dist --strip
 	maturin build --release -i python3.10 --out dist --strip
 	maturin build --release -i python3.11 --out dist --strip
+	maturin build --release -i python3.12 --out dist --strip
 
 	twine upload dist/*
 
 release-windows: clean ## creates and release window wheels
-	maturin build --release -i python37 --out dist --strip
 	maturin build --release -i python38 --out dist --strip
 	maturin build --release -i python39 --out dist --strip
 	maturin build --release -i python310 --out dist --strip
 	maturin build --release -i python311 --out dist --strip
+	maturin build --release -i python312 --out dist --strip
 
 	twine upload dist/*

{portforward-0.6.1 → portforward-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: portforward
-Version: 0.6.1
+Version: 0.7.0
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -19,8 +19,8 @@ License: MIT License
 Requires-Python: >=3.7
 Description-Content-Type: text/x-rst; charset=UTF-8
 Project-URL: Documentation, https://portforward.readthedocs.io
-Project-URL: Repository, https://github.com/pytogo/portforward.git
 Project-URL: Changelog, https://github.com/pytogo/portforward/blob/main/HISTORY.rst
+Project-URL: Repository, https://github.com/pytogo/portforward.git
 
 ===========
 portforward
@@ -58,22 +58,17 @@ Installation
 
 Wheels are available for:
 
-* Windows
-* MacOS X
-* Linux
+* Windows (architectures: x64, x86)
+* MacOS X (architectures: x86_64, aarch64)
+* Linux (architectures: x86_64, x86, aarch64)
 
 with Python versions:
 
-* 3.7
 * 3.8
 * 3.9
 * 3.10
 * 3.11
-
-and architectures:
-
-* x84_64
-* arm64 (known as M1/Apple Chip - MacOS only)
+* 3.12
 
 **Requirements for installation from source**
 

{portforward-0.6.1 → portforward-0.7.0}/README.rst

@@ -34,22 +34,17 @@ Installation
 
 Wheels are available for:
 
-* Windows
-* MacOS X
-* Linux
+* Windows (architectures: x64, x86)
+* MacOS X (architectures: x86_64, aarch64)
+* Linux (architectures: x86_64, x86, aarch64)
 
 with Python versions:
 
-* 3.7
 * 3.8
 * 3.9
 * 3.10
 * 3.11
-
-and architectures:
-
-* x84_64
-* arm64 (known as M1/Apple Chip - MacOS only)
+* 3.12
 
 **Requirements for installation from source**
 

{portforward-0.6.1 → portforward-0.7.0}/docs/modules.rst

@@ -1,4 +1,4 @@
-portforward-go
+portforward
 ==============
 
 .. toctree::

{portforward-0.6.1 → portforward-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "portforward"
-version = "0.6.1"
+version = "0.7.0"
 authors = [{ name = "Sebastian Ziemann", email = "corka149@mailbox.org" }]
 description = "Easy Kubernetes Port-Forward For Python"
 readme = "README.rst"
@@ -34,7 +34,7 @@ module-name = "portforward._portforward"
 python-source = "python"
 
 [tool.bumpversion]
-current_version = "0.6.1"
+current_version = "0.7.0"
 tag = true
 commit = true
 

{portforward-0.6.1 → portforward-0.7.0}/python/portforward/__init__.py

@@ -2,14 +2,15 @@
 Easy Kubernetes Port-Forward For Python
 """
 
-__version__ = "0.6.1"
+__version__ = "0.7.0"
 
 import asyncio
 import contextlib
+import ipaddress
 import os
 from enum import Enum
 from pathlib import Path
-from typing import Generator, Optional
+from typing import Generator, Optional, Union
 
 from portforward import _portforward
 
@@ -36,6 +37,7 @@ def forward(
     waiting: float = 0.1,
     log_level: LogLevel = LogLevel.INFO,
     kube_context: str = "",
+    bind_ip: Union[ipaddress.IPv4Address, ipaddress.IPv6Address, str, None] = None,
 ) -> Generator["PortForwarder", None, None]:
     """
     Connects to a **pod or service** and tunnels traffic from a local port to
@@ -52,21 +54,16 @@ def forward(
         >>> import portforward
         >>> with portforward.forward("test", "web-svc", 9000, 80):
         >>>     # Do work
-        >>>
-        >>> # Or without context manager
-        >>>
-        >>> forwarder = portforward.forward("test", "some-pod", 9000, 80)
-        >>> # Do work
-        >>> forwarder.stop()
 
     :param namespace: Target namespace
     :param pod_or_service: Name of target Pod or service
-    :param from_port: Local port
+    :param from_port: Local port, or 0 to use any free port
     :param to_port: Port inside the pod
     :param config_path: Path for loading kube config
     :param waiting: Delay in seconds
     :param log_level: Level of logging
     :param kube_context: Target kubernetes context (fallback is current context)
+    :param bind_ip: To which IP shall the portforward be bind
     :return: forwarder to manual stop the forwarding
     """
 
@@ -79,6 +76,7 @@ def forward(
         waiting,
         log_level,
         kube_context,
+        bind_ip,
     )
 
     try:
@@ -107,6 +105,7 @@ class PortForwarder:
         waiting: float = 0.1,
         log_level: LogLevel = LogLevel.INFO,
         kube_context: str = "",
+        bind_ip: Union[ipaddress.IPv4Address, ipaddress.IPv6Address, str, None] = None,
     ) -> None:
         self._async_forwarder = AsyncPortForwarder(
             namespace,
@@ -117,6 +116,7 @@ class PortForwarder:
             waiting,
             log_level,
             kube_context,
+            bind_ip,
         )
 
     def forward(self):
@@ -129,6 +129,11 @@ class PortForwarder:
     def is_stopped(self):
         return self._async_forwarder.is_stopped
 
+    @property
+    def from_port(self):
+        """The local port that was actually used for the portforward."""
+        return self._async_forwarder.from_port
+
 
 class AsyncPortForwarder:
     """Use the same args as the `portforward.forward` method."""
@@ -143,10 +148,10 @@ class AsyncPortForwarder:
         waiting: float = 0.1,
         log_level: LogLevel = LogLevel.INFO,
         kube_context: str = "",
+        bind_ip: Union[ipaddress.IPv4Address, ipaddress.IPv6Address, str, None] = None,
     ) -> None:
         self.namespace: str = _validate_str("namespace", namespace)
         self.pod_or_service: str = _validate_str("pod_or_service", pod_or_service)
-        self.from_port: int = _validate_port("from_port", from_port)
         self.to_port: int = _validate_port("to_port", to_port)
         self.log_level: LogLevel = _validate_log(log_level)
         self.waiting: float = waiting
@@ -154,14 +159,19 @@ class AsyncPortForwarder:
         self.config_path: str = _config_path(config_path)
         self.kube_context: str = _kube_context(kube_context)
 
+        _validate_port("from_port", from_port)
+        bind_ip = _validate_ip_address(bind_ip)
+
         self.actual_pod_name: str = ""
+        self.from_port: int = 0
         self._is_stopped: bool = False
+        self.bind_address: str = f"{bind_ip}:{from_port}"
 
     async def forward(self):
-        self.actual_pod_name = await _portforward.forward(
+        (self.actual_pod_name, self.from_port) = await _portforward.forward(
             self.namespace,
             self.pod_or_service,
-            self.from_port,
+            self.bind_address,
             self.to_port,
             self.config_path,
             self.log_level.value,
@@ -196,7 +206,7 @@ def _validate_str(arg_name, arg) -> str:
 
 
 def _validate_port(arg_name, arg) -> int:
-    in_range = arg and 0 < arg < 65536
+    in_range = arg is not None and 0 <= arg < 65536
     if arg is None or not isinstance(arg, int) or not in_range:
         raise ValueError(f"{arg_name}={arg} is not a valid port")
 
@@ -210,6 +220,18 @@ def _validate_log(log_level):
     return log_level
 
 
+def _validate_ip_address(ip_address):
+    if not ip_address:
+        return "127.0.0.1"
+
+    if isinstance(ip_address, ipaddress.IPv4Address) or isinstance(
+        ip_address, ipaddress.IPv4Address
+    ):
+        return str(ip_address)
+
+    return str(ipaddress.ip_address(ip_address))
+
+
 def _config_path(config_path_arg) -> str:
     if config_path_arg and not isinstance(config_path_arg, str):
         raise ValueError(f"config_path={config_path_arg} is not a valid str")

{portforward-0.6.1 → portforward-0.7.0}/python/portforward/_portforward.pyi

@@ -5,7 +5,7 @@ Rust native module / Python C Extension
 async def forward(
     namespace: str,
     pod_or_service: str,
-    from_port: int,
+    bind_address: str,
     to_port: int,
     config_path: str,
     log_level: int,

{portforward-0.6.1 → portforward-0.7.0}/src/lib.rs

@@ -9,7 +9,7 @@ fn forward(
     py: Python<'_>,
     namespace: String,
     pod_or_service: String,
-    from_port: u16,
+    bind_address: String,
     to_port: u16,
     config_path: String,
     log_level: u64,
@@ -20,7 +20,7 @@ fn forward(
     let config = portforward::ForwardConfig::builder()
         .namespace(namespace)
         .pod_or_service(pod_or_service)
-        .from_port(from_port)
+        .bind_address(bind_address)
         .to_port(to_port)
         .config_path(config_path)
         .kube_context(kube_context)

{portforward-0.6.1 → portforward-0.7.0}/src/portforward.rs

@@ -14,6 +14,7 @@ use log::*;
 use once_cell::sync::Lazy;
 use std::net::SocketAddr;
 use std::{collections::HashMap, path::Path};
+use std::str::FromStr;
 use tokio::{
     io::{AsyncRead, AsyncWrite},
     net::TcpListener,
@@ -27,15 +28,16 @@ use typed_builder::TypedBuilder;
 pub struct ForwardConfig {
     namespace: String,
     pod_or_service: String,
-    from_port: u16,
+    bind_address: String,
     to_port: u16,
     config_path: String,
     kube_context: String,
 }
 
-/// Creates a connection to a pod. It returns the actual pod name for the portforward.
+/// Creates a connection to a pod. It returns a `(pod_name, from_port)` tuple
+/// with the actual pod name and local port used for the portforward.
 /// It differs from `pod_or_service` when `pod_or_service` represents a service.
-pub async fn forward(config: ForwardConfig) -> anyhow::Result<String> {
+pub async fn forward(config: ForwardConfig) -> anyhow::Result<(String, u16)> {
     debug!("{:?}", config);
 
     let client_config = load_config(&config.config_path, &config.kube_context).await?;
@@ -55,8 +57,9 @@ pub async fn forward(config: ForwardConfig) -> anyhow::Result<String> {
 
     PORTFORWARD_REGISTRY.register(&q_name, forwarding).await;
 
-    let addr = SocketAddr::from(([127, 0, 0, 1], config.from_port));
+    let addr = SocketAddr::from_str(&config.bind_address).with_context(move || config.bind_address)?;
     let tcp_listener = TcpListener::bind(addr).await?;
+    let from_port = tcp_listener.local_addr()?.port();
     let forward_task = setup_forward_task(
         tcp_listener,
         rx,
@@ -67,7 +70,7 @@ pub async fn forward(config: ForwardConfig) -> anyhow::Result<String> {
 
     tokio::spawn(forward_task);
 
-    return Ok(q_name.pod_name);
+    return Ok((q_name.pod_name, from_port));
 }
 
 async fn load_config(
@@ -80,7 +83,7 @@ async fn load_config(
         return Ok(incluster_config);
     }
 
-    let kube_config = kube::config::Kubeconfig::read_from(config_path.clone())?;
+    let kube_config = kube::config::Kubeconfig::read_from(config_path)?;
     let mut options = kube::config::KubeConfigOptions::default();
 
     // "" is the sign for using default context

{portforward-0.6.1 → portforward-0.7.0}/tests/test_portforward.py

@@ -124,6 +124,33 @@ def test_service_portforward_with_success(kind_cluster: KindCluster):
         response: requests.Response = requests.get(url_2)
         pytest.fail("Portforward should be closed after leaving the context manager")
 
+def test_portforward_from_port_zero_assigns_port(kind_cluster: KindCluster):
+    # Arrange
+    _create_test_resources(kind_cluster)
+
+    pod_name = "test-pod"
+    config = str(kind_cluster.kubeconfig_path.absolute())
+
+    local_port = 0  # from port
+    pod_port = 3000  # to port
+
+    pf = portforward.forward(
+        TEST_NAMESPACE,
+        pod_name,
+        local_port,
+        pod_port,
+        config_path=config,
+        kube_context=TEST_CONTEXT,
+    )
+
+    # Act & Assert
+    with pf as forwarder:
+        assert not forwarder.is_stopped()
+        assert forwarder.from_port != 0
+        url = f"http://localhost:{forwarder.from_port}/ping"
+        response: requests.Response = requests.get(url)
+        assert response.status_code == 200
+
 
 @pytest.mark.parametrize(
     "namespace,pod,from_port,to_port",
@@ -160,11 +187,23 @@ def test_forward_invalid_parameter(namespace, pod, from_port, to_port):
             pytest.fail("Should raise error before")
 
 
+def test_validate_ip_address():
+    namespace = "test_ns"
+    pod = "test_pod"
+    from_port = 9000
+    to_port = 10000
+    bind_ip = "not-an-ip-adress"
+
+    with pytest.raises(ValueError):
+        with portforward.forward(namespace, pod, from_port, to_port, bind_ip=bind_ip):
+            pytest.fail("Should raise error before")
+
+
 def test_forward_raise_error():
     """Tests the conversion of the C extension error into the Python Error"""
 
     # Arrange
-    namespace = "test" + str(uuid.uuid4())  # Should never exists
+    namespace = "test" + str(uuid.uuid4())  # Should never exist
     pod = "web"
     from_ = 9000
     to = 80