portforward 0.6.2__tar.gz → 0.7.1__tar.gz

{portforward-0.6.2 → portforward-0.7.1}/.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       matrix:
         target: [x86_64, x86, aarch64]
-        version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+        version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
@@ -45,7 +45,7 @@ jobs:
     strategy:
       matrix:
         target: [x64, x86]
-        version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+        version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
@@ -69,7 +69,7 @@ jobs:
     strategy:
       matrix:
         target: [x86_64, aarch64]
-        version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+        version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4

{portforward-0.6.2 → portforward-0.7.1}/Cargo.lock

@@ -1,6 +1,6 @@
 # This file is automatically @generated by Cargo.
 # It is not intended for manual editing.
-version = 3
+version = 4
 
 [[package]]
 name = "ahash"
@@ -1142,7 +1142,7 @@ checksum = "6ac9a59f73473f1b8d852421e59e64809f025994837ef743615c6d0c5b305160"
 
 [[package]]
 name = "portforward"
-version = "0.6.2"
+version = "0.7.1"
 dependencies = [
  "anyhow",
  "env_logger",

{portforward-0.6.2 → portforward-0.7.1}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "portforward"
-version = "0.6.2"
+version = "0.7.1"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -28,7 +28,7 @@ log = "0.4.17"
 env_logger = "0.10.0"
 # tokio
 tokio = { version = "1.27.0", features = ["full"] }
-tokio-util = "0.7.0"
+tokio-util = "0.7.1"
 tokio-stream = { version = "0.1.9", features = ["net"] }
 # k8s
 kube = { version = "^0.81.0", default-features = false, features = ["admission"] }

{portforward-0.6.2 → portforward-0.7.1}/HISTORY.rst

@@ -2,6 +2,15 @@
 History
 =======
 
+0.7.1 (2024-12-15)
+------------------
+* Allow "/" in strings
+* Drop support for Python 3.8
+
+0.7.0 (2024-10-18)
+------------------
+* Allow binding to a local random free port
+
 0.6.2 (2024-06-19)
 ------------------
 * Allow defining binding ip

{portforward-0.6.2 → portforward-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: portforward
-Version: 0.6.2
+Version: 0.7.1
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -64,11 +64,11 @@ Wheels are available for:
 
 with Python versions:
 
-* 3.8
 * 3.9
 * 3.10
 * 3.11
 * 3.12
+* 3.13
 
 **Requirements for installation from source**
 

{portforward-0.6.2 → portforward-0.7.1}/README.rst

@@ -40,11 +40,11 @@ Wheels are available for:
 
 with Python versions:
 
-* 3.8
 * 3.9
 * 3.10
 * 3.11
 * 3.12
+* 3.13
 
 **Requirements for installation from source**
 

{portforward-0.6.2 → portforward-0.7.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "portforward"
-version = "0.6.2"
+version = "0.7.1"
 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.2"
+current_version = "0.7.1"
 tag = true
 commit = true
 

{portforward-0.6.2 → portforward-0.7.1}/python/portforward/__init__.py

@@ -2,7 +2,7 @@
 Easy Kubernetes Port-Forward For Python
 """
 
-__version__ = "0.6.2"
+__version__ = "0.7.1"
 
 import asyncio
 import contextlib
@@ -57,7 +57,7 @@ def forward(
 
     :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
@@ -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."""
@@ -158,11 +163,12 @@ class AsyncPortForwarder:
         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.bind_address,
@@ -193,14 +199,11 @@ def _validate_str(arg_name, arg) -> str:
     if len(arg) == 0:
         raise ValueError(f"{arg_name} cannot be an empty str")
 
-    if "/" in arg:
-        raise ValueError(f"{arg_name} contains illegal character '/'")
-
     return arg
 
 
 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")
 
@@ -247,7 +250,4 @@ def _kube_context(context):
     if not isinstance(context, str):
         raise ValueError(f"kube_context={context} is not a valid str")
 
-    if "/" in context:
-        raise ValueError("kube_context contains illegal character '/'")
-
     return context

{portforward-0.6.2 → portforward-0.7.1}/src/portforward.rs

@@ -34,9 +34,10 @@ pub struct ForwardConfig {
     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?;
@@ -58,6 +59,7 @@ pub async fn forward(config: ForwardConfig) -> anyhow::Result<String> {
 
     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,
@@ -68,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(

{portforward-0.6.2 → portforward-0.7.1}/tests/test_portforward.py

@@ -124,18 +124,43 @@ 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",
     [
         # Namespace
         ("", "web", 9000, 80),
-        ("/test", "web", 9000, 80),
         (1337, "web", 9000, 80),
         (None, "web", 9000, 80),
         # Pod name
         ("test", "", 9000, 80),
-        ("test", "web/", 9000, 80),
         ("test", 1337, 9000, 80),
         ("test", None, 9000, 80),
         # From port