Merge branch 'main' into release/1.1

Author: RobPasMue

src/ansys/tools/repo_sync/__init__.py

@@ -5,7 +5,7 @@
 
 try:
     import importlib.metadata as importlib_metadata
-except ModuleNotFoundError:
+except ModuleNotFoundError:  # pragma: no cover
     import importlib_metadata
 
 __version__ = importlib_metadata.version("ansys-tools-repo-sync")

src/ansys/tools/repo_sync/repo_sync.py

@@ -110,7 +110,7 @@ def synchronize(
     Returns
     -------
     Union[str, None]
-        Pull request URL. In case of dry-run, ``None`` is returned.
+        Pull request URL. In case of dry-run or no files modified, ``None`` is returned.
 
     """
     # New branch name and PR title
@@ -178,8 +178,14 @@ def synchronize(
 
         # Get a list of the files modified
         output = repo.git.diff("--compact-summary", f"{branch_checked_out}", f"{new_branch_name}")
-        print(">>> Summary of modified files...")
-        print(output)
+
+        # If output is empty, avoid creating PR
+        if not output:
+            print(">>> No files to sync... Ignoring PR request.")
+            return None
+        else:
+            print(">>> Summary of modified files...")
+            print(output)
 
         pull_request = None
         if not dry_run:

tests/assets/manifest_no_files.txt

@@ -0,0 +1 @@
+*.xyz

tests/test_sync.py

@@ -1,7 +1,6 @@
 import os
 import shutil
 import subprocess
-import tempfile
 
 import pytest
 
@@ -56,6 +55,59 @@ def test_synchronize():
             cleanup_remote_repo(owner, repository, result)
 
 
+def test_synchronize_to_existing_pr():
+    """Test synchronization tool (when PR already exists)."""
+
+    # Define your test data here
+    owner = "ansys"
+    repository = "ansys-tools-repo-sync"
+    from_dir = os.path.join(ASSETS_DIRECTORY, "ansys")
+    to_dir = "src/ansys"
+    manifest = os.path.join(ASSETS_DIRECTORY, "manifest.txt")
+
+    # Call the function
+    result = None
+    try:
+        result = synchronize(
+            owner=owner,
+            repository=repository,
+            token=TOKEN,
+            from_dir=from_dir,
+            to_dir=to_dir,
+            include_manifest=manifest,
+            skip_ci=True,
+        )
+
+        # Assertions or validations
+        assert f"https://github.com/ansys/ansys-tools-repo-sync/pull/" in result
+
+        # Call the function again - and check that the PR already exists.
+        result_pr_already_exists = synchronize(
+            owner=owner,
+            repository=repository,
+            token=TOKEN,
+            from_dir=from_dir,
+            to_dir=to_dir,
+            include_manifest=manifest,
+            skip_ci=True,
+        )
+
+        # Verify the PR is the same
+        assert result_pr_already_exists == result
+
+        # Check that the proper modified files have been added
+        list_of_files = ["src/ansys/api/test/v0/hello_world.py", "src/ansys/api/test/v0/test.proto"]
+        assert check_files_in_pr(owner, repository, result, list_of_files)
+
+    except Exception as err:
+        raise err
+    finally:
+        if result:
+            cleanup_remote_repo(owner, repository, result)
+        if result_pr_already_exists and result != result_pr_already_exists:
+            cleanup_remote_repo(owner, result_pr_already_exists, result)
+
+
 def test_synchronize_with_only_proto_manifest():
     """Test synchronization tool (with manifest)."""
 
@@ -94,6 +146,40 @@ def test_synchronize_with_only_proto_manifest():
             cleanup_remote_repo(owner, repository, result)
 
 
+def test_synchronize_no_sync_needed():
+    """Test synchronization tool (with manifest referring to non-existing files)."""
+
+    # Define your test data here
+    owner = "ansys"
+    repository = "ansys-tools-repo-sync"
+    from_dir = os.path.join(ASSETS_DIRECTORY, "ansys")
+    to_dir = "src/ansys"
+    manifest = os.path.join(ASSETS_DIRECTORY, "manifest_no_files.txt")
+
+    # Call the function
+    result = None
+    try:
+        result = synchronize(
+            owner=owner,
+            repository=repository,
+            token=TOKEN,
+            from_dir=from_dir,
+            to_dir=to_dir,
+            include_manifest=manifest,
+            skip_ci=True,
+            random_branch_name=True,
+        )
+
+        # Assertions or validations
+        assert result is None
+
+    except Exception as err:
+        raise err
+    finally:
+        if result:
+            cleanup_remote_repo(owner, repository, result)
+
+
 def test_synchronize_with_cleanup_and_dry_run(capsys):
     """
     Test synchronization tool (with --clean-to-dir flag).
@@ -140,14 +226,13 @@ def test_synchronize_with_cleanup_and_dry_run(capsys):
 
 
 @pytest.mark.skipif(SKIP_LOCALLY, reason="Only runs on workflow")
-def test_synchronize_from_cli():
+def test_synchronize_from_cli(tmpdir):
     """Test synchronization tool (without manifest) from CLI."""
 
     # Define a temp directory and copy assets in it
-    temp_dir = tempfile.TemporaryDirectory(prefix="repo_clone_cli_")
     shutil.copytree(
         ASSETS_DIRECTORY,
-        temp_dir.name,
+        tmpdir,
         dirs_exist_ok=True,
     )
 
@@ -184,7 +269,7 @@ def test_synchronize_from_cli():
         ],
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
-        cwd=temp_dir.name,
+        cwd=tmpdir,
     )
 
     # Check output info
@@ -204,14 +289,13 @@ def test_synchronize_from_cli():
 
 
 @pytest.mark.skipif(SKIP_LOCALLY, reason="Only runs on workflow")
-def test_synchronize_with_only_proto_manifest_from_cli():
+def test_synchronize_with_only_proto_manifest_from_cli(tmpdir):
     """Test synchronization tool (with manifest) from CLI."""
 
     # Define a temp directory and copy assets in it
-    temp_dir = tempfile.TemporaryDirectory(prefix="repo_clone_cli_")
     shutil.copytree(
         ASSETS_DIRECTORY,
-        temp_dir.name,
+        tmpdir,
         dirs_exist_ok=True,
     )
 
@@ -248,7 +332,7 @@ def test_synchronize_with_only_proto_manifest_from_cli():
         ],
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
-        cwd=temp_dir.name,
+        cwd=tmpdir,
     )
 
     # Check output info
@@ -268,7 +352,7 @@ def test_synchronize_with_only_proto_manifest_from_cli():
 
 
 @pytest.mark.skipif(SKIP_LOCALLY, reason="Only runs on workflow")
-def test_synchronize_with_cleanup_cli():
+def test_synchronize_with_cleanup_cli(tmpdir):
     """
     Test synchronization tool (with --clean-to-dir flag) from CLI.
 
@@ -279,10 +363,9 @@ def test_synchronize_with_cleanup_cli():
     """
 
     # Define a temp directory and copy assets in it
-    temp_dir = tempfile.TemporaryDirectory(prefix="repo_clone_cli_")
     shutil.copytree(
         ASSETS_DIRECTORY,
-        temp_dir.name,
+        tmpdir,
         dirs_exist_ok=True,
     )
 
@@ -321,7 +404,7 @@ def test_synchronize_with_cleanup_cli():
         ],
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
-        cwd=temp_dir.name,
+        cwd=tmpdir,
     )
 
     # Check output info
@@ -338,3 +421,62 @@ def test_synchronize_with_cleanup_cli():
     assert "src/ansys/tools/repo_sync/__init__.py" in captured
     assert "src/ansys/tools/repo_sync/__main__.py" in captured
     assert "src/ansys/tools/repo_sync/repo_sync.py" in captured
+
+
+@pytest.mark.skipif(SKIP_LOCALLY, reason="Only runs on workflow")
+def test_synchronize_with_no_sync_cli(tmpdir):
+    """Test synchronization tool (with no files needed to be synced) from CLI."""
+
+    # Define a temp directory and copy assets in it
+    shutil.copytree(
+        ASSETS_DIRECTORY,
+        tmpdir,
+        dirs_exist_ok=True,
+    )
+
+    # Requires installing project
+    subprocess.run(
+        [
+            "pip",
+            "install",
+            ".",
+        ],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        cwd=ROOT_PATH,
+    )
+
+    # Call CLI tool
+    completed_process = subprocess.run(
+        [
+            "repo-sync",
+            "--token",
+            TOKEN,
+            "--owner",
+            "ansys",
+            "--repository",
+            "ansys-tools-repo-sync",
+            "--from-dir",
+            "ansys",
+            "--to-dir",
+            "src/ansys",
+            "--include-manifest",
+            "manifest_no_files.txt",
+            "--skip-ci",
+            "--random-branch-name",
+        ],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        cwd=tmpdir,
+    )
+
+    # Check output info
+    print(completed_process.returncode)
+    print(completed_process.stdout)
+    print(completed_process.stderr)
+
+    # Check stdout
+    captured = completed_process.stdout.decode()
+
+    # Search for the modified files
+    assert ">>> No files to sync... Ignoring PR request." in captured