kop-cli 0.2.0b2__tar.gz → 0.3.0__tar.gz

kop_cli-0.3.0/CHANGELOG.md

@@ -0,0 +1,11 @@
+## New Features
+
+- Transfer files beteewn local and pod
+
+## Bug fixes
+
+- fixed Kubernetes Client v36.0.0 where the read_namespaced_pod_log function did not support the watch parameter.
+
+## Docs
+
+- Update on the introduction and usage of transfer files

{kop_cli-0.2.0b2 → kop_cli-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kop-cli
-Version: 0.2.0b2
+Version: 0.3.0
 Summary: Terminal-based kubernetes operation platform
 Author-email: vegaoqiang <vegaoqiang@gmail.com>
 License-Expression: Apache-2.0
@@ -26,9 +26,9 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: System :: Systems Administration
 Classifier: Topic :: Terminals
 Requires-Python: >=3.9
-Requires-Dist: kubernetes>=33.1.0
+Requires-Dist: kubernetes==33.1.0
 Requires-Dist: pyte
-Requires-Dist: textual>=8.1.1
+Requires-Dist: textual==8.2.7
 Requires-Dist: tree-sitter-bash
 Requires-Dist: tree-sitter-json
 Requires-Dist: tree-sitter-yaml
@@ -112,7 +112,7 @@ In this mode, the file path and kubeconfig validity are verified, and after vali
 
 ## Operations and Shortcuts
 See demo video:
-[![Watch the demo](https://img.youtube.com/vi/sEXl9UQQxVc/maxresdefault.jpg)](https://www.youtube.com/watch?v=sEXl9UQQxVc)
+[![Watch the demo](https://img.youtube.com/vi/6L1jOtYvKYg/maxresdefault.jpg)](https://www.youtube.com/watch?v=6L1jOtYvKYg)
 
 Please refer to the [Documentation](https://vegaoqiang.github.io/kop/) for more detailed usage instructions.
 

{kop_cli-0.2.0b2 → kop_cli-0.3.0}/README.md

@@ -72,7 +72,7 @@ In this mode, the file path and kubeconfig validity are verified, and after vali
 
 ## Operations and Shortcuts
 See demo video:
-[![Watch the demo](https://img.youtube.com/vi/sEXl9UQQxVc/maxresdefault.jpg)](https://www.youtube.com/watch?v=sEXl9UQQxVc)
+[![Watch the demo](https://img.youtube.com/vi/6L1jOtYvKYg/maxresdefault.jpg)](https://www.youtube.com/watch?v=6L1jOtYvKYg)
 
 Please refer to the [Documentation](https://vegaoqiang.github.io/kop/) for more detailed usage instructions.
 

{kop_cli-0.2.0b2 → kop_cli-0.3.0}/docs/guide/Pods.md

@@ -10,6 +10,7 @@ Available shortcuts for Pod-related operations are shown in the Footer area at t
 | `c` | Create Pods |
 | `d` | Delete Pod |
 | `e` | Edit Pod |
+| `t` | Transfer files |
 | `f` | Port Forward |
 | `l` | Pod Logs |
 | `n` | Next Page |
@@ -84,6 +85,23 @@ Edits the Pod YAML configuration and submits changes.
 - If an update fails, adjust based on the error message and retry.
 - `Edit Pod` opens in the `Action Workspace`.
 
+### Transfer Files
+Transfer files allows users to transfer files between their local machine and their pod.
+
+> The `Transfer files` function requires the container to contain the `tar` utility; otherwise, it will not be able to transfer directories and only supports transferring single files.
+
+**Steps:**
+
+1. In the left navigation, move the cursor to `Pods` or enter the `Pods` resource page.
+2. Move the cursor to the target pod
+3. Press the `t` key to open the Transfer dialog box.(If your pod contains multiple containers, please select one container.)
+4. In the `Transfer` dialog box, select the source file and destination path for this transfer.
+5. Click the `Transfer` button to start the transfer.
+
+![transfer files](../images/guide/transfer.png)
+
+> `Transfer` supports custom target filenames
+
 ### Port Forward
 Forwards a local port to a Pod port so you can access container services from your machine.
 

{kop_cli-0.2.0b2 → kop_cli-0.3.0}/docs/index.md

@@ -7,7 +7,7 @@ hide:
 
 `kop` is a terminal-based (TUI) Kubernetes operations platform. Its goal is to provide an interactive experience similar to desktop cluster management tools, but fully within the terminal command line, aiming to solve the problem of conveniently operating Kubernetes clusters when no desktop environment is available.
 
-<iframe width="100%" height="350" src="https://www.youtube.com/embed/sEXl9UQQxVc?si=_EpzjW_I_nV4pofR" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+<iframe width="560" height="315" src="https://www.youtube.com/embed/6L1jOtYvKYg?si=jduCsuOJI_GG6xNe" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
 
 ## Why kop
 

{kop_cli-0.2.0b2 → kop_cli-0.3.0}/docs/tutorial.md

@@ -61,6 +61,12 @@ Below the header is action tabs; you can use `Ctrl+[`  or `ctrl+]` to switch bet
 
 The middle section shows the current action workspace. Below are the keyboard shortcuts for actions within the workspace.
 
+## Transfer Files
+Transfer files allows users to transfer files between their local machine and their pod.
+
+![transfer files](images/guide/transfer.png)
+
+Please see the usage instructions: [Transfer Files](guide/Pods.md#transfer-files)
 
 ## Theme
 Kop uses Textual to build its user interface and includes multiple modern themes. Press `Ctrl+P` in Kop will directly bring up the theme list, allowing you to select any theme.

{kop_cli-0.2.0b2 → kop_cli-0.3.0}/pyproject.toml

@@ -39,8 +39,8 @@ classifiers = [
 ]
 
 dependencies = [
-    "kubernetes>=33.1.0",
-    "textual>=8.1.1",
+    "kubernetes==33.1.0",
+    "textual==8.2.7",
     "tree-sitter-yaml",
     "tree-sitter-bash",
     "tree-sitter-json",

kop_cli-0.3.0/src/kop/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "0.3.0"
+__git_commit__ = ""

{kop_cli-0.2.0b2 → kop_cli-0.3.0}/src/kop/controllers/handler.py

@@ -20,6 +20,7 @@ from kop.widgets.Modals import (
     NodeShellLoading,
     NodeShellFailed,
 )
+from kop.widgets.Transfer import FileTransferModal
 from kubernetes import client
 from typing import Optional
 from kop.provider.logs import PodLogs
@@ -572,6 +573,31 @@ class PodActionHandler(BaseActionHandlerMixin):
             callback=forward_callback,
         )
 
+    @staticmethod
+    def transfer(action, resource: PodViewModel, app):
+        if resource.status != "Running":
+            app.notify("Pod is not running", severity="error")
+            return
+
+        def open_transfer(container_name: str) -> None:
+            app.push_screen(
+                FileTransferModal(
+                    api_client=app.endpoint.api_client,
+                    pod_name=resource.name,
+                    namespace=resource.namespace,
+                    container_name=container_name,
+                )
+            )
+
+        if len(resource.containers) == 1:
+            container_obj = resource.containers[0].lazy_clean()
+            open_transfer(container_name=container_obj.name)
+        else:
+            app.push_screen(
+                Option([cs.lazy_clean().name for cs in resource.containers], action=action.name),
+                callback=open_transfer,
+            )
+
     @staticmethod
     def delete(action, resource: PodViewModel, app):
         def delete_callback(resource) -> None:

{kop_cli-0.2.0b2 → kop_cli-0.3.0}/src/kop/factory.py

@@ -280,6 +280,12 @@ class PodFacotry(BaseFactory):
                     tooltip="Pod logs", 
                     action="log", 
                     key="l"),
+        ActionModel(name="transfer",
+                    label="Transfer",
+                    variant="default",
+                    tooltip="Transfer files",
+                    action="transfer",
+                    key="t"),
         ActionModel(name="forward",
                     label="Forward",
                     variant="default",

{kop_cli-0.2.0b2 → kop_cli-0.3.0}/src/kop/provider/logs.py

@@ -3,10 +3,39 @@ import threading
 import json
 import re
 from typing import Optional
-from kubernetes import watch
 from kubernetes.client import CoreV1Api
 
 
+class PodLogStream:
+    def __init__(self, response) -> None:
+        self.response = response
+        self._stopped = False
+        self._lock = threading.Lock()
+
+    def stop(self) -> None:
+        with self._lock:
+            if self._stopped:
+                return
+            self._stopped = True
+            response = self.response
+
+        close = getattr(response, "close", None)
+        if callable(close):
+            close()
+        release_conn = getattr(response, "release_conn", None)
+        if callable(release_conn):
+            release_conn()
+
+    def __iter__(self):
+        stream = getattr(self.response, "stream", None)
+        if callable(stream):
+            yield from stream(decode_content=True)
+            return
+        data = getattr(self.response, "data", None)
+        if data:
+            yield data
+
+
 
 
 class PodLogs:
@@ -53,17 +82,17 @@ class PodLogs:
             )
 
     def watch_logs(self, timestamps: Optional[bool] = None, tail_lines: Optional[int] = 100):
-        self.w = w = watch.Watch()
+        response = self.core_api.read_namespaced_pod_log(
+            **self._log_params(timestamps=timestamps, follow=True, tail_lines=tail_lines),
+            _preload_content=False,
+        )
+        self.w = log_stream = PodLogStream(response)
         try:
-            for line in w.stream(
-                self.core_api.read_namespaced_pod_log,
-                **self._log_params(timestamps=timestamps, follow=True, tail_lines=tail_lines),
-            ):
+            for line in log_stream:
                 yield line
         finally:
-            if w:
-                w.stop()
-                self.w = None
+            log_stream.stop()
+            self.w = None
             
 
 class LogController:
@@ -93,7 +122,15 @@ class LogController:
     def stop(self, wait: bool = True, timeout: float = 0.5) -> None:
         self._stop_event.set()
         if self.pod_logs.w:
-            self.pod_logs.w.stop()
+            stream = self.pod_logs.w
+            if wait:
+                stream.stop()
+            else:
+                threading.Thread(
+                    target=stream.stop,
+                    daemon=True,
+                    name="pod-log-stream-stop",
+                ).start()
         if wait and self._thread and self._thread.is_alive():
             self._thread.join(timeout=timeout)
 

kop_cli-0.3.0/src/kop/provider/transfer.py

@@ -0,0 +1,325 @@
+import io
+import os
+import shlex
+import tarfile
+from dataclasses import dataclass
+from pathlib import Path, PurePosixPath
+from tempfile import TemporaryFile
+from typing import Literal, Optional
+
+from kubernetes.client import ApiClient, CoreV1Api
+from kubernetes.stream import stream
+
+
+EndpointKind = Literal["local", "pod"]
+
+
+@dataclass(frozen=True)
+class TransferEndpoint:
+    kind: EndpointKind
+    path: Path | PurePosixPath
+    is_dir: bool
+    container: Optional[str] = None
+
+    @property
+    def display(self) -> str:
+        return f"{self.kind}:{self.path}"
+
+    @property
+    def name(self) -> str:
+        name = self.path.name
+        return name or str(self.path)
+
+
+@dataclass(frozen=True)
+class PodFileEntry:
+    path: PurePosixPath
+    is_dir: bool
+
+    @property
+    def label(self) -> str:
+        """
+        self.path == self.path.parent is possible when path is root "/"
+        """
+        suffix = "/" if self.is_dir and self.path != self.path.parent else ""
+        return f"{self.path.name or '/'}{suffix}"
+
+
+class PodFileSystem:
+    def __init__(
+        self,
+        api_client: ApiClient,
+        pod_name: str,
+        namespace: str,
+        container_name: Optional[str] = None,
+    ) -> None:
+        self.core_api = CoreV1Api(api_client=api_client)
+        self.pod_name = pod_name
+        self.namespace = namespace
+        self.container_name = container_name
+
+    def list_dir(self, path: PurePosixPath | str) -> list[PodFileEntry]:
+        pod_path = PurePosixPath(str(path) or "/")
+        quoted_path = shlex.quote(str(pod_path))
+        script = (
+            f"p={quoted_path}; "
+            'if [ ! -d "$p" ]; then echo "not a directory: $p" >&2; exit 2; fi; '
+            'for entry in "$p"/* "$p"/.[!.]* "$p"/..?*; do '
+            '[ -e "$entry" ] || continue; '
+            'name=${entry##*/}; '
+            'if [ -d "$entry" ]; then printf "d\\t%s\\n" "$name"; '
+            'else printf "f\\t%s\\n" "$name"; fi; '
+            "done"
+        )
+        output = self._exec(["sh", "-c", script])
+        entries: list[PodFileEntry] = []
+        for line in output.splitlines():
+            if "\t" not in line:
+                continue
+            kind, name = line.split("\t", 1)
+            if not name or name in {".", ".."}:
+                continue
+            entries.append(PodFileEntry(path=pod_path / name, is_dir=kind == "d"))
+        entries.sort(key=lambda item: (not item.is_dir, item.path.name.lower()))
+        return entries
+
+    def _exec(self, command: list[str]) -> str:
+        return stream(
+            self.core_api.connect_get_namespaced_pod_exec,
+            self.pod_name,
+            self.namespace,
+            command=command,
+            container=self.container_name,
+            stderr=True,
+            stdin=False,
+            stdout=True,
+            tty=False,
+            _preload_content=True,
+        )
+
+
+class PodFileTransfer:
+    def __init__(
+        self,
+        api_client: ApiClient,
+        pod_name: str,
+        namespace: str,
+        container_name: Optional[str] = None,
+    ) -> None:
+        self.core_api = CoreV1Api(api_client=api_client)
+        self.pod_name = pod_name
+        self.namespace = namespace
+        self.container_name = container_name
+        self._command_cache: dict[str, bool] = {}
+
+    def upload(self, source: Path, dest_dir: PurePosixPath, dest_name: str) -> None:
+        if not source.exists():
+            raise FileNotFoundError(str(source))
+        if not dest_name:
+            raise ValueError("Destination name is required")
+
+        if not self.has_command("tar"):
+            self._upload_file_with_cat(source, dest_dir, dest_name)
+            return
+        self._upload_with_tar(source, dest_dir, dest_name)
+
+    def download(
+        self,
+        source: PurePosixPath,
+        dest_dir: Path,
+        dest_name: str,
+        source_is_dir: bool = False,
+    ) -> None:
+        if not dest_name:
+            raise ValueError("Destination name is required")
+        if not self.has_command("tar"):
+            if source_is_dir:
+                raise RuntimeError("Directory download requires tar in the container")
+            self._download_file_with_cat(source, dest_dir, dest_name)
+            return
+        self._download_with_tar(source, dest_dir, dest_name)
+
+    def has_command(self, command: str) -> bool:
+        if command in self._command_cache:
+            return self._command_cache[command]
+        quoted = shlex.quote(command)
+        output = stream(
+            self.core_api.connect_get_namespaced_pod_exec,
+            self.pod_name,
+            self.namespace,
+            command=["sh", "-c", f"command -v {quoted} >/dev/null 2>&1 && echo yes || echo no"],
+            container=self.container_name,
+            stderr=False,
+            stdin=False,
+            stdout=True,
+            tty=False,
+            _preload_content=True,
+        )
+        available = str(output).strip() == "yes"
+        self._command_cache[command] = available
+        return available
+
+    def _upload_with_tar(self, source: Path, dest_dir: PurePosixPath, dest_name: str) -> None:
+        quoted_dir = shlex.quote(str(dest_dir))
+        command = ["sh", "-c", f"mkdir -p {quoted_dir} && tar xf - -C {quoted_dir}"]
+        resp = self._open_exec(command, stdin=True)
+        try:
+            with TemporaryFile() as archive:
+                with tarfile.open(fileobj=archive, mode="w") as tar:
+                    tar.add(source, arcname=dest_name, recursive=True)
+                archive.seek(0)
+                while True:
+                    chunk = archive.read(1024 * 256)
+                    if not chunk:
+                        break
+                    resp.write_stdin(chunk)
+            resp.write_stdin(b"")
+            self._drain_response(resp)
+        finally:
+            resp.close()
+
+    def _upload_file_with_cat(self, source: Path, dest_dir: PurePosixPath, dest_name: str) -> None:
+        if source.is_dir():
+            raise RuntimeError("Directory upload requires tar in the container")
+
+        dest_path = dest_dir / dest_name
+        quoted_dir = shlex.quote(str(dest_dir))
+        quoted_dest = shlex.quote(str(dest_path))
+        command = ["sh", "-c", f"mkdir -p {quoted_dir} && cat > {quoted_dest}"]
+        resp = self._open_exec(command, stdin=True)
+        try:
+            with source.open("rb") as source_file:
+                while True:
+                    chunk = source_file.read(1024 * 256)
+                    if not chunk:
+                        break
+                    resp.write_stdin(chunk)
+            self._drain_response(resp)
+        finally:
+            resp.close()
+
+    def _download_with_tar(self, source: PurePosixPath, dest_dir: Path, dest_name: str) -> None:
+        dest_dir.mkdir(parents=True, exist_ok=True)
+        parent = str(source.parent) if str(source.parent) else "/"
+        source_name = source.name or "."
+        command = [
+            "sh",
+            "-c",
+            f"tar cf - -C {shlex.quote(parent)} {shlex.quote(source_name)}",
+        ]
+        resp = self._open_exec(command, stdin=False)
+        try:
+            archive_data = io.BytesIO()
+            empty_reads = 0
+            while resp.is_open():
+                resp.update(timeout=1)
+                stdout = resp.read_channel(1, timeout=0)
+                if stdout:
+                    if isinstance(stdout, str):
+                        stdout = stdout.encode()
+                    archive_data.write(stdout)
+                    empty_reads = 0
+                stderr = resp.read_channel(2, timeout=0)
+                if stderr:
+                    raise RuntimeError(self._channel_text(stderr).strip())
+                if not stdout:
+                    empty_reads += 1
+                if empty_reads >= 3:
+                    break
+            archive_data.seek(0)
+            with tarfile.open(fileobj=archive_data, mode="r:*") as tar:
+                self._safe_extract(tar, dest_dir)
+            extracted = dest_dir / source_name
+            target = dest_dir / dest_name
+            if extracted != target and extracted.exists():
+                if target.exists():
+                    raise FileExistsError(str(target))
+                os.replace(extracted, target)
+        finally:
+            resp.close()
+
+    def _download_file_with_cat(self, source: PurePosixPath, dest_dir: Path, dest_name: str) -> None:
+        dest_dir.mkdir(parents=True, exist_ok=True)
+        target = dest_dir / dest_name
+        command = ["sh", "-c", f"cat {shlex.quote(str(source))}"]
+        resp = self._open_exec(command, stdin=False)
+        try:
+            data = self._read_stdout_response(resp)
+            target.write_bytes(data)
+        finally:
+            resp.close()
+
+    def _open_exec(self, command: list[str], stdin: bool):
+        return stream(
+            self.core_api.connect_get_namespaced_pod_exec,
+            self.pod_name,
+            self.namespace,
+            command=command,
+            container=self.container_name,
+            stderr=True,
+            stdin=stdin,
+            stdout=True,
+            tty=False,
+            binary=True,
+            _preload_content=False,
+        )
+
+    def _drain_response(self, resp) -> None:
+        errors: list[str] = []
+        empty_reads = 0
+        while resp.is_open():
+            resp.update(timeout=1)
+            stderr = resp.read_channel(2, timeout=0)
+            if stderr:
+                errors.append(self._channel_text(stderr))
+            stdout = resp.read_channel(1, timeout=0)
+            if stderr or stdout:
+                empty_reads = 0
+            else:
+                empty_reads += 1
+            if empty_reads >= 3:
+                break
+        if errors:
+            raise RuntimeError("".join(errors).strip())
+
+    def _read_stdout_response(self, resp) -> bytes:
+        output = io.BytesIO()
+        errors: list[str] = []
+        empty_reads = 0
+        while resp.is_open():
+            resp.update(timeout=1)
+            stdout = resp.read_channel(1, timeout=0)
+            if stdout:
+                if isinstance(stdout, str):
+                    stdout = stdout.encode()
+                output.write(stdout)
+                empty_reads = 0
+            stderr = resp.read_channel(2, timeout=0)
+            if stderr:
+                errors.append(self._channel_text(stderr))
+                empty_reads = 0
+            if not stdout and not stderr:
+                empty_reads += 1
+            if empty_reads >= 3:
+                break
+        if errors:
+            raise RuntimeError("".join(errors).strip())
+        return output.getvalue()
+
+    def _channel_text(self, value: bytes | str) -> str:
+        if isinstance(value, bytes):
+            return value.decode("utf-8", "replace")
+        return value
+
+    def _safe_extract(self, tar: tarfile.TarFile, dest_dir: Path) -> None:
+        """
+        Extracts a tar file to the specified destination directory while 
+          preventing path traversal attacks and local file or directory were
+          overwritten by downloaded files
+        """
+        base = dest_dir.resolve()
+        for member in tar.getmembers():
+            target = (dest_dir / member.name).resolve()
+            if base not in target.parents and target != base:
+                raise RuntimeError(f"Unsafe tar path: {member.name}")
+        tar.extractall(dest_dir)

{kop_cli-0.2.0b2 → kop_cli-0.3.0}/src/kop/widgets/Modals.py

@@ -567,7 +567,7 @@ class ActionPortForward(ModalScreen):
         #remote_port_select {
             width: 100%;
         }
-        #cancel, #start, #stop {
+        #cancel-forward, #start-forward, #stop-forward {
             width: 100%;
         }
         #action_buttons {
@@ -620,9 +620,9 @@ class ActionPortForward(ModalScreen):
             Select(options=port_options, value=initial_value, allow_blank=False, id="remote_port_select"),
             Label("Open in Browser"),
             Switch(id="open_in_browser", value=True),
-            Grid(Button("Cancel", variant="error", id="cancel"),
-                 Button("Stop", variant="warning", id="stop", disabled=True),
-                 Button("Start", variant="primary", id="start", disabled=False),
+            Grid(Button("Cancel", variant="error", id="cancel-forward"),
+                 Button("Stop", variant="warning", id="stop-forward", disabled=True),
+                 Button("Start", variant="primary", id="start-forward", disabled=False),
                  id="action_buttons",
                  ),
             id="dialog",
@@ -642,14 +642,14 @@ class ActionPortForward(ModalScreen):
     def action_start(self) -> None:
         self.on_start_press()
 
-    @on(Button.Pressed, "#cancel")
+    @on(Button.Pressed, "#cancel-forward")
     def on_cancel_press(self, event: Button.Pressed) -> None:
         self.app.pop_screen()
 
     def _update_action_buttons(self) -> None:
         remote_port_select = self.query_one("#remote_port_select", Select)
-        start_btn = self.query_one("#start", Button)
-        stop_btn = self.query_one("#stop", Button)
+        start_btn = self.query_one("#start-forward", Button)
+        stop_btn = self.query_one("#stop-forward", Button)
         selected = remote_port_select.value
         if selected == Select.NULL:
             start_btn.disabled = True
@@ -660,7 +660,7 @@ class ActionPortForward(ModalScreen):
         start_btn.disabled = is_forwarded or not self._is_local_port_valid()
         stop_btn.disabled = not is_forwarded
 
-    @on(Button.Pressed, "#start")
+    @on(Button.Pressed, "#start-forward")
     def on_start_press(self) -> None:
         local_port_input = self.query_one("#local_port", Input)
         open_in_browser = self.query_one("#open_in_browser", Switch).value
@@ -689,7 +689,7 @@ class ActionPortForward(ModalScreen):
             }
         )
 
-    @on(Button.Pressed, "#stop")
+    @on(Button.Pressed, "#stop-forward")
     def on_stop_press(self) -> None:
         remote_port_select = self.query_one("#remote_port_select", Select)
         selected = remote_port_select.value
@@ -721,7 +721,7 @@ class ActionPortForward(ModalScreen):
 
     @on(Input.Submitted, "#local_port")
     def submit_local_port(self) -> None:
-        if not self.query_one("#start", Button).disabled:
+        if not self.query_one("#start-forward", Button).disabled:
             self.on_start_press()