GitHub Action to Compare Dependencies

.github/workflows/sync_native_dependency.yml

@@ -0,0 +1,27 @@
+name: Compare Dependency Constraints
+on:
+  pull_request:
+    branches:
+      - master
+jobs:
+  compare_dependency_constraints_script:
+    runs-on: ubuntu-latest
+    if: github.repository == 'demisto/dockerFiles'
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.11"
+      - name: Install dependencies with pipenv
+        run: |
+          python -m pip install --upgrade pip
+          pip install pipenv
+          pipenv install
+      - name: Run compare_dependency_constraints Script.
+        run: |
+          ls
+          echo "==== $(date): Starting environment setup... ===="
+          cd "$GITHUB_WORKSPACE"
+          echo "==== $(date): Running chceking Native dependency ===="
+          pipenv run python utils/compare_dependency_constraints.py

docker/py3-native/pyproject.toml

@@ -45,7 +45,7 @@ parse-emails = "*"
 slack-sdk = {extras = ["optional"], version = "*"}
 pyjwt = {extras = ["crypto"],version = "*"}
 google-api-python-client = "*"
-exchangelib = ">=5.4.1"
+exchangelib = ">=5.4.0"
 requests-oauthlib = "*"
 oauthlib = {extras = ["signedtoken"], version = "*"}
 requests-ntlm = "==1.1.0"

utils/compare_dependency_constraints.py

@@ -3,6 +3,7 @@
 from typing import Any, NamedTuple
 import requests
 import toml
+import sys
 
 DOCKER_FOLDER = Path(__file__).parent.parent / "docker"
 NATIVE_IMAGE = "py3-native"
@@ -49,8 +50,25 @@ class Discrepancy(NamedTuple):
     in_native: str | None = None
 
     def __str__(self) -> str:
-        return f"{self.dependency}: {self.in_image or 'missing'} in {self.image}, {self.in_native or 'missing'} in native"
+        return f"{self.dependency}: {self.in_image or 'missing'} in {self.image} image, {self.in_native or 'missing'} in Native image"
 
+def find_library_line_number(lib_name: str, file_path: Path):
+    """
+    Searches for a library in the pyproject.toml or Pipfile file and returns the line number where it is found.
+
+    Parameters:
+    - lib_name: The name of the library to search for.
+    - file_path: The directory containing the pyproject.toml or Pipfile.
+
+    Returns:
+    - The line number containing the library name, or None if the library is not found.
+    """
+    with file_path.open('r') as file:
+        for line_number, line in enumerate(file, start=1):  # Start counting from line 1
+            if lib_name in line:
+                return line_number
+
+    return None
 
 def compare_constraints(images_contained_in_native: list[str]):
     native_constraints = (
@@ -59,9 +77,8 @@ def compare_constraints(images_contained_in_native: list[str]):
         | parse_constraints(NATIVE_IMAGE)
     )
     native_constraint_keys = set(native_constraints.keys())
-
+    discrepancies: list[Discrepancy] = []
     for image in images_contained_in_native:
-        discrepancies: list[Discrepancy] = []
 
         constraints = parse_constraints(image)
         constraint_keys = set(constraints.keys())
@@ -93,8 +110,18 @@ def compare_constraints(images_contained_in_native: list[str]):
             )
         )
 
-        for discrepancy in discrepancies:
-            print(str(discrepancy))
+    for discrepancy in discrepancies:
+        file_pyproject_path = DOCKER_FOLDER / f"{discrepancy.image}/pyproject.toml"
+        if file_pyproject_path.exists():
+            file_path = file_pyproject_path
+        else:
+            file_path = DOCKER_FOLDER / f"{discrepancy.image}/Pipfile"
+        line_number = find_library_line_number(discrepancy.dependency, file_path)
+
+        print(
+            f"::error file={file_path},line={line_number},endLine={line_number},title=Native Image Discrepancy::{discrepancy}"
+        )
+    return int(bool(discrepancies))
 
 
 def load_native_image_conf() -> list[str]:
@@ -106,4 +133,5 @@ def load_native_image_conf() -> list[str]:
     )["native_images"]["native:candidate"]["supported_docker_images"]
 
 
-compare_constraints(load_native_image_conf())
+if __name__ == "__main__":
+    sys.exit(compare_constraints(load_native_image_conf()))