dfsync 0.4.7__tar.gz → 0.4.9__tar.gz

{dfsync-0.4.7 → dfsync-0.4.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dfsync
-Version: 0.4.7
+Version: 0.4.9
 Summary: 
 Author: Mihai Balint
 Author-email: balint.mihai@gmail.com
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: black (==23.7.0)
+Requires-Dist: black (==24.3.0)
 Requires-Dist: click (>=8,<9)
 Requires-Dist: click-default-group (>=1.2.2,<2.0.0)
 Requires-Dist: gitpython (>=3.1.14,<4.0.0)

{dfsync-0.4.7 → dfsync-0.4.9}/dfsync/distribution.py

@@ -1,5 +1,10 @@
+import click
 import json
+import subprocess
+import sys
 import urllib.request
+from typing import Optional
+
 from dfsync.lib import ControlledThreadedOperation
 
 
@@ -8,14 +13,14 @@ def get_package_version(package_name):
         from importlib.metadata import version
 
         return version(package_name)
-    except:
+    except Exception:
         pass
 
     try:
         import pkg_resources
 
         return pkg_resources.get_distribution(package_name).version
-    except:
+    except Exception:
         pass
 
     return None
@@ -41,7 +46,7 @@ def get_latest_version():
             raise ValueError("No version visible on github")
 
         return versions[0]
-    except Exception as e:
+    except Exception:
         return get_installed_version()
 
 
@@ -52,7 +57,7 @@ def parse_version(version_str):
     for part in version_str.split("."):
         try:
             parsed_version.append(int(part))
-        except:
+        except Exception:
             parsed_version.append(part)
     return parsed_version
 
@@ -80,15 +85,52 @@ class AsyncVersionChecker(ControlledThreadedOperation):
         self.installed = get_installed_version()
         self.latest = get_latest_version()
         self.installed_is_older = is_older_version(self.installed, self.latest)
+        self._is_install_editable = is_installed_in_editable_mode("dfsync")
         self._cta_count = 0
         self.stop()
 
     @property
-    def should_emit_upgrade_warning(self):
+    def should_emit_update_warning(self):
         return self.is_completed and self.installed_is_older and self._cta_count < 1
 
-    def set_emitted_upgrade_warning(self):
+    def set_emitted_update_warning(self):
         self._cta_count += 1
 
-    def get_upgrade_warning(self):
-        return f"dfsync ver. {self.latest} is available, please upgrade! ({self.installed} is installed)"
+    def get_update_warning(self):
+        if self._is_install_editable:
+            return f"dfsync ver. {self.latest} is available, please update! ({self.installed} is installed)"
+        else:
+            return f"dfsync ver. {self.latest} is available ({self.installed} is installed), please update using `dfsync self-update`"
+
+
+def _read_editable_location_from_pip_show_output(out: str) -> Optional[str]:
+    editable_label = "Editable project location: "
+    site_packages_label = "site-packages"
+    site_packages_lines = []
+
+    for line in out.split("\n"):
+        if line.startswith("Location: "):
+            continue
+        if line.startswith(editable_label):
+            return line[len(editable_label) :].strip()
+        if site_packages_label in line:
+            site_packages_lines.append(line)
+
+    return "UNKNOWN-EDITABLE-LOCATION" if len(site_packages_lines) > 0 else None
+
+
+def is_installed_in_editable_mode(package_name: str) -> bool:
+    try:
+        out = subprocess.check_output([sys.executable, "-m", "pip", "show", "-f", package_name]).decode()
+        editable_location = _read_editable_location_from_pip_show_output(out)
+        return editable_location is not None
+    except Exception:
+        return False
+
+
+def update_package(package_name: str):
+    click.echo(f"Running {sys.executable} -m pip install --upgrade {package_name}")
+    try:
+        subprocess.check_call([sys.executable, "-m", "pip", "install", "--upgrade", package_name])
+    except Exception as e:
+        click.echo(f"Failed to update {package_name}: {e}")

{dfsync-0.4.7 → dfsync-0.4.9}/dfsync/filters.py

@@ -1,4 +1,5 @@
-import black, fnmatch
+import black
+import fnmatch
 import os.path
 import git.exc
 import subprocess
@@ -111,6 +112,10 @@ class UntrackedGitFilesFilter(LoggingFilter):
         self._repos = {}
         self._is_repo_initialized = {}
         self._untracked_and_ignored_files = {}
+        self._should_filter_untracked_files = True
+
+    def set_should_filter_untracked_files(self, should_filter_untracked_files: bool = True):
+        self._should_filter_untracked_files = should_filter_untracked_files
 
     def get_untracked_and_ignored_files(self):
         flat_files = []
@@ -175,13 +180,17 @@ class UntrackedGitFilesFilter(LoggingFilter):
             self._ignore(src_file_path, "GIT repo internals")
             return True
 
-        for rel_file_path in repo.untracked_files:
-            abs_file_path = os.path.join(repo.working_dir, rel_file_path)
-            if src_abs_path == abs_file_path:
-                self._ignore(src_file_path, "Untracked GIT file")
-                return True
+        if self._should_filter_untracked_files and self._is_untracked_file(repo, src_abs_path):
+            self._ignore(src_file_path, "Untracked GIT file")
+            return True
+
         return False
 
+    def _is_untracked_file(self, repo, src_abs_path):
+        return any(
+            src_abs_path == os.path.join(repo.working_dir, rel_file_path) for rel_file_path in repo.untracked_files
+        )
+
 
 USER_FILTERS = [EmacsBufferFilter(), PythonBlackFilter()]
 GIT_FILTER = UntrackedGitFilesFilter()
@@ -215,3 +224,7 @@ def add_user_filter(f: LoggingFilter):
 
 def add_user_ignored_patterns_filter(patterns: [str]):
     add_user_filter(UserConfigFilter(patterns))
+
+
+def set_ignore_untracked_files(should_ignore_untracked_files: bool):
+    GIT_FILTER.set_should_filter_untracked_files(should_ignore_untracked_files)

{dfsync-0.4.7 → dfsync-0.4.9}/dfsync/kube_credentials.py

@@ -77,14 +77,16 @@ def update_local_kube_config(new_kube_credentials):
     credentials_yaml = yaml.dump(credentials)
     with open(f"{LOCAL_CREDENTIALS_FILE}.new", "w") as f:
         f.write(credentials_yaml)
+    os.chmod(f"{LOCAL_CREDENTIALS_FILE}.new", 0o600)
 
     if os.path.isfile(LOCAL_CREDENTIALS_FILE):
         if os.path.isfile(f"{LOCAL_CREDENTIALS_FILE}.old"):
             os.remove(f"{LOCAL_CREDENTIALS_FILE}.old")
         os.rename(f"{LOCAL_CREDENTIALS_FILE}", f"{LOCAL_CREDENTIALS_FILE}.old")
+        os.chmod(f"{LOCAL_CREDENTIALS_FILE}.old", 0o600)
 
     os.rename(f"{LOCAL_CREDENTIALS_FILE}.new", f"{LOCAL_CREDENTIALS_FILE}")
-
+    os.chmod(LOCAL_CREDENTIALS_FILE, 0o600)
     return credentials_yaml
 
 

{dfsync-0.4.7 → dfsync-0.4.9}/dfsync/monitor.py

@@ -12,9 +12,16 @@ from functools import partial
 from watchdog.observers import Observer
 from watchdog.events import FileSystemEventHandler
 
+import dfsync.filters as filters
 from dfsync.backends import rsync_backend, kube_backend
-from dfsync.distribution import get_installed_version, get_latest_version, is_older_version, AsyncVersionChecker
-from dfsync.filters import add_user_ignored_patterns_filter, ALL_FILTERS
+from dfsync.distribution import (
+    get_installed_version,
+    get_latest_version,
+    is_older_version,
+    AsyncVersionChecker,
+    is_installed_in_editable_mode,
+    update_package,
+)
 from dfsync.config import read_config
 from dfsync.char_ui import KeyController
 from dfsync.kube_credentials import contextualize_kube_credentials, update_local_kube_config, normalized_k8s_url
@@ -47,7 +54,7 @@ class FileChangedEventHandler(ControlledThreadedOperation, FileSystemEventHandle
         **kwargs,
     ):
         super().__init__()
-        self.filters = [*ALL_FILTERS]
+        self.filters = [*filters.ALL_FILTERS]
 
         self.backend = backend
         self.backend_options = kwargs
@@ -253,12 +260,50 @@ def main():
 
 @main.command()
 def version():
+    """
+    Print the currently installed version
+    """
+    _version()
+
+
+def _version():
     installed_version = get_installed_version()
     click.echo(f"{installed_version}")
 
     latest_version = get_latest_version()
-    if is_older_version(installed_version, latest_version):
-        click.echo(f"Latest version is {latest_version}, please upgrade!")
+    if not is_older_version(installed_version, latest_version):
+        return
+    elif is_installed_in_editable_mode("dfsync"):
+        click.echo(f"Latest version is {latest_version}, please update!")
+    else:
+        click.echo(f"Latest version is {latest_version}, please update using `dfsync self-update`")
+
+
+@main.command(name="help", context_settings=dict(ignore_unknown_options=True))
+@click.option("--help", is_flag=True, default=False, hidden=True)
+def help(help):
+    """
+    Print the usage/help for dfsync
+    """
+    with click.Context(sync, info_name="dfsync") as ctx:
+        click.echo(sync.get_help(ctx))
+
+
+@main.command()
+def self_update():
+    """
+    Update dfsync to the latest version published on pypi
+    """
+    latest_version = get_latest_version()
+    installed_version = get_installed_version()
+    if not is_older_version(installed_version, latest_version):
+        click.echo(f"The latest version is already installed: {installed_version}")
+        return
+    elif is_installed_in_editable_mode("dfsync"):
+        click.echo("dfsync is installed in editable mode, please update manually")
+        return
+    else:
+        update_package("dfsync")
 
 
 @main.command()
@@ -278,11 +323,15 @@ def import_kube_host(kube_host=None, credentials=None):
 @main.command()
 @click.argument("source", nargs=-1)
 @click.argument("destination", default="", nargs=1)
-@click.option("--supervisor/--no-supervisor", default=False, help="Try to install supervisor in container", type=bool)
+@click.option("--supervisor", is_flag=True, default=False, help="Try to install supervisor in container")
 @click.option("--kube-host", default=None, help="Kubernetes api host server address/hostname", type=str)
 @click.option("--pod-timeout", default=30, help="Pod reconfiguration timeout (default is 30 seconds)", type=int)
 @click.option("--full-sync/--no-full-sync", default=True, help="On startup, sync all files to destination", type=bool)
-def sync(source, destination, supervisor, kube_host, pod_timeout, full_sync):
+@click.option("--version", is_flag=True, default=False, help="Print the currently installed version")
+@click.option(
+    "--sync-git-untracked", is_flag=True, default=False, help="Sync git-untracked files instead of ignoring them"
+)
+def sync(source, destination, supervisor, kube_host, pod_timeout, full_sync, version, sync_git_untracked):
     """
     Watches a folder for changes and propagates all file changes to a destination.
 
@@ -322,7 +371,14 @@ def sync(source, destination, supervisor, kube_host, pod_timeout, full_sync):
 
     paths = ["."] if len(source) == 0 else source
     config = read_config(destination, *paths)
-    add_user_ignored_patterns_filter(config.ignore_files)
+    filters.add_user_ignored_patterns_filter(config.ignore_files)
+
+    if sync_git_untracked:
+        filters.set_ignore_untracked_files(False)
+
+    if version:
+        _version()
+        return
 
     destination_dir = destination
     if len(source) == 0 and config.destination and not has_destination_optics(destination):
@@ -419,9 +475,9 @@ def sync(source, destination, supervisor, kube_host, pod_timeout, full_sync):
                     no_errors = False
                     break
             with controller.getch_lock():
-                if checker.should_emit_upgrade_warning:
-                    checker.set_emitted_upgrade_warning()
-                    click.echo(checker.get_upgrade_warning())
+                if checker.should_emit_update_warning:
+                    checker.set_emitted_update_warning()
+                    click.echo(checker.get_update_warning())
             controller.raise_exceptions()
 
     except KeyboardInterrupt:

{dfsync-0.4.7 → dfsync-0.4.9}/dfsync/test_dfsync.py

@@ -3,10 +3,6 @@ from tempfile import NamedTemporaryFile
 from dfsync.filters import EmacsBufferFilter, UntrackedGitFilesFilter
 
 
-def test_version():
-    assert False, "Test version not implemented"
-
-
 def test_emacs_buffer_filter():
     emacs = EmacsBufferFilter()
 

dfsync-0.4.9/dfsync/test_distribution.py

@@ -0,0 +1,30 @@
+import pytest
+from dfsync.distribution import is_installed_in_editable_mode, get_package_version, update_package
+
+
+def test_is_installed_in_editable_mode():
+    assert is_installed_in_editable_mode("dfsync") is True
+
+
+def test_is_installed_in_editable_mode_missing_package():
+    assert is_installed_in_editable_mode("does-not-exist") is False
+
+
+def test_is_installed_in_editable_mode_required_and_installed_package():
+    assert pytest is not None, "pytest must be installed"
+    assert is_installed_in_editable_mode("pytest") is False
+
+    assert is_installed_in_editable_mode("click") is False
+
+
+def test_update_package():
+    tqdm_version = get_package_version("tqdm")
+
+    update_package("tqdm==4.66.2")
+    assert get_package_version("tqdm") == "4.66.2"
+
+    update_package("tqdm==4.66.0")
+    assert get_package_version("tqdm") == "4.66.0"
+
+    update_package(f"tqdm=={tqdm_version}")
+    assert get_package_version("tqdm") == tqdm_version

{dfsync-0.4.7 → dfsync-0.4.9}/dfsync/test_kube_credentials.py

@@ -1,6 +1,7 @@
+import os
 import pytest
-import yaml
 import tempfile
+import yaml
 
 from dfsync.kube_credentials import update_local_kube_config, normalized_k8s_url
 
@@ -12,7 +13,7 @@ def mock_kube_credentials(mocker):
         return temp.name
 
 
-def test_update_missing_kube_config(mock_kube_credentials):
+def test_update_missing_kube_config_and_check_permissions(mock_kube_credentials):
     new_kube_credentials = {
         "clusters": [{"cluster": {"server": "test_server"}, "name": "test_cluster"}],
         "contexts": [{"context": {"cluster": "test_cluster", "user": "test_user"}, "name": "test_context"}],
@@ -23,6 +24,9 @@ def test_update_missing_kube_config(mock_kube_credentials):
     assert "test_context" in result
     assert "test_user" in result
 
+    # Check file permissions
+    assert oct(os.stat(mock_kube_credentials).st_mode)[-3:] == "600"
+
 
 def test_update_empty_kube_config(mock_kube_credentials):
     with open(mock_kube_credentials, "wb") as f:
@@ -53,6 +57,15 @@ def test_update_empty_kube_config(mock_kube_credentials):
         assert credentials["users"][0]["user"]["username"] == "test_username"
         assert credentials["users"][0]["user"]["password"] == "test_password"
 
+    # Verify that the old file was saved
+    with open(f"{mock_kube_credentials}.old", "r") as f:
+        credentials = yaml.safe_load(f)
+        assert credentials == empty_config
+
+    # Check file permissions for both old and new config file
+    assert oct(os.stat(mock_kube_credentials).st_mode)[-3:] == "600"
+    assert oct(os.stat(f"{mock_kube_credentials}.old").st_mode)[-3:] == "600"
+
 
 def test_update_existing_kube_config(mock_kube_credentials):
     with open(mock_kube_credentials, "wb") as f:
@@ -103,5 +116,5 @@ def test_normalized_k8s_url():
     assert normalized_k8s_url("192.168.0.123:6443") == "https://192.168.0.123:6443"
     with pytest.raises(ValueError):
         normalized_k8s_url("")
-    with pytest.raises(ValueError):
-        normalized_k8s_url(None)
+
+    assert normalized_k8s_url(None) is None

{dfsync-0.4.7 → dfsync-0.4.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dfsync"
-version = "0.4.7"
+version = "0.4.9"
 description = ""
 authors = ["Mihai Balint <balint.mihai@gmail.com>"]
 
@@ -14,7 +14,7 @@ toml = "^0.10.2"
 tenacity = "^8.0.1"
 click-default-group = "^1.2.2"
 paramiko = {version = "^3.2.0", extras = ["invoke"]}
-black = "23.7.0"
+black = "24.3.0"
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.4"
@@ -23,6 +23,7 @@ ipython = "^8"
 ipdb = "^0.13"
 flake8 = "^4.0.1"
 pycodestyle = "^2.8.0"
+tqdm = "4.66.0"
 
 [tool.black]
 line-length = 120