forked from FreeCAD/FreeCAD
-
Notifications
You must be signed in to change notification settings - Fork 2
FAKE DO NOT USE #29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
FAKE DO NOT USE #29
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
189 changes: 189 additions & 0 deletions
189
.github/workflows/actions/additionalChecks/added_dependency.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| # SPDX-License-Identifier: LGPL-2.1-or-later | ||
|
|
||
| """Script to parse git diff output and determine if any new C++ dependencies were added between FreeCAD modules.""" | ||
|
|
||
| import os | ||
| import re | ||
| import sys | ||
|
|
||
| KNOWN_MODULES = [ | ||
| "app", | ||
| "base", | ||
| "gui", | ||
| "addonmanager", | ||
| "assembly", | ||
| "bim", | ||
| "cam", | ||
| "cloud", | ||
| "draft", | ||
| "fem", | ||
| "help", | ||
| "idf", | ||
| "import", | ||
| "inspection", | ||
| "jtreader", | ||
| "material", | ||
| "measure", | ||
| "mesh", | ||
| "meshpart", | ||
| "openscad", | ||
| "part", | ||
| "partdesign", | ||
| "plot", | ||
| "points", | ||
| "reverseengineering", | ||
| "robot", | ||
| "sandbox", | ||
| "show", | ||
| "sketcher", | ||
| "spreadsheet", | ||
| "start", | ||
| "surface", | ||
| "techdraw", | ||
| "templatepymod", | ||
| "test", | ||
| "tux", | ||
| "web", | ||
| ] | ||
|
|
||
|
|
||
| def parse_diff_by_file(diff_content: str): | ||
| """ | ||
| Parse git diff output and return a dictionary mapping filenames to their diffs. | ||
|
|
||
| Returns: | ||
| dict: {filename: diff_chunk} | ||
| """ | ||
| file_diffs = {} | ||
| current_file = None | ||
| current_chunk = [] | ||
|
|
||
| lines = diff_content.split("\n") | ||
|
|
||
| for line in lines: | ||
| if line.startswith("diff --git"): | ||
| if current_file and current_chunk: | ||
| file_diffs[current_file] = "\n".join(current_chunk) | ||
|
|
||
| match = re.search(r"diff --git a/(.*?) b/", line) | ||
| if match: | ||
| current_file = match.group(1) | ||
| current_chunk = [line] | ||
| else: | ||
| current_file = None | ||
| current_chunk = [] | ||
| elif current_file is not None: | ||
| current_chunk.append(line) | ||
|
|
||
| if current_file and current_chunk: | ||
| file_diffs[current_file] = "\n".join(current_chunk) | ||
|
|
||
| return file_diffs | ||
|
|
||
|
|
||
| def check_module_compatibility( | ||
| file_module: str, included_file_module: str, intermodule_dependencies: dict[str, list[str]] | ||
| ) -> bool: | ||
| if file_module == included_file_module: | ||
| return True | ||
| if file_module not in KNOWN_MODULES or included_file_module not in KNOWN_MODULES: | ||
| return True # We are only checking compatibility between modules *in FreeCAD* | ||
| if file_module in intermodule_dependencies: | ||
| return included_file_module in intermodule_dependencies[file_module] | ||
| else: | ||
| return False | ||
|
|
||
|
|
||
| def load_intermodule_dependencies(cmake_file_path: str) -> dict[str, list[str]]: | ||
| """FreeCAD already has a file that defines the known dependencies between modules. The basic rule is that no NEW | ||
| dependencies can be added (without extensive discussion with the core developers). This function loads that file | ||
| and parses it such that we can use it to check if a new dependency was added.""" | ||
| dependencies = {} | ||
|
|
||
| if not os.path.exists(cmake_file_path): | ||
| print(f"ERROR: {cmake_file_path} not found", file=sys.stderr) | ||
| exit(1) | ||
|
|
||
| with open(cmake_file_path, "r") as f: | ||
| content = f.read() | ||
|
|
||
| pattern = r"REQUIRES_MODS\(\s*(\w+)((?:\s+\w+)*)\s*\)" | ||
| matches = re.finditer(pattern, content) | ||
| for match in matches: | ||
| dependent = match.group(1) | ||
| prerequisites = match.group(2).split() | ||
| module_name = dependent.replace("BUILD", "").replace("_", "").lower() | ||
| prereq_names = [p.replace("BUILD", "").replace("_", "").lower() for p in prerequisites] | ||
| dependencies[module_name] = prereq_names | ||
|
|
||
| print() | ||
| print("Recognized intermodule dependencies") | ||
| print("-----------------------------------") | ||
| for module, deps in dependencies.items(): | ||
| print(f"{module} depends on: {', '.join(deps)}") | ||
| print() | ||
|
|
||
| return dependencies | ||
|
|
||
|
|
||
| def check_file_dependencies( | ||
| file: str, diff: str, intermodule_dependencies: dict[str, list[str]] | ||
| ) -> bool: | ||
| """Returns true if the dependencies are OK, or false if they are not.""" | ||
| file_module = file.split("/")[1] # src/Gui, etc. | ||
| if file_module == "Mod": | ||
| file_module = file.split("/")[2] # src/Mod/Part, etc. | ||
| diff_lines = diff.split("\n") | ||
| failed = False | ||
| for line in diff_lines: | ||
| if file.endswith(".h") or file.endswith(".cpp"): | ||
| include_file = (m := re.search(r'^\+\s*#include\s*[<"]([^>"]+)[>"]', line)) and m.group( | ||
| 1 | ||
| ) | ||
| if include_file: | ||
| include_file_module = include_file.split("/")[0] | ||
| if include_file_module == "Mod": | ||
| include_file_module = include_file.split("/")[1] | ||
| else: | ||
| include_file_module = None | ||
| elif file.endswith(".py") or file.endswith(".pyi"): | ||
| include_file_module = ( | ||
| m := re.search( | ||
| r"^\+\s*(?:from\s+([\w.]+)\s+)?import\s+([\w.]+(?:\s+as\s+\w+)?(?:\s*,\s*[\w.]+(?:\s+as\s+\w+)?)*)", | ||
| line, | ||
| ) | ||
| ) and (m.group(1) or m.group(2)) | ||
| else: | ||
| return True | ||
| if not include_file_module: | ||
| continue | ||
| compatibility = check_module_compatibility( | ||
| file_module.lower(), include_file_module.lower(), intermodule_dependencies | ||
| ) | ||
|
|
||
| if not compatibility: | ||
| print( | ||
| f" 👉 {file_module} added a new dependency on {include_file_module}", | ||
| file=sys.stderr, | ||
| ) | ||
| failed = True | ||
| return not failed | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| dependencies = load_intermodule_dependencies( | ||
| "cMake/FreeCAD_Helpers/CheckIntermoduleDependencies.cmake" | ||
| ) | ||
| piped_diff = sys.stdin.read() | ||
| file_diffs = parse_diff_by_file(piped_diff) | ||
| failed_files = [] | ||
| for file, diff in file_diffs.items(): | ||
| print(f"Checking changed file {file} for dependency violations...") | ||
| if not check_file_dependencies(file, diff, dependencies): | ||
| print(f" ❌ ERROR: Dependency violation found in {file}") | ||
| failed_files.append(file) | ||
| else: | ||
| print(f" ✅ No problems found in {file}") | ||
| if failed_files: | ||
| sys.exit(1) | ||
| sys.exit(0) |
17 changes: 17 additions & 0 deletions
17
.github/workflows/actions/additionalChecks/added_dependency.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # SPDX-License-Identifier: LGPL-2.1-or-later | ||
|
|
||
| name: Check for added dependencies | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| jobs: | ||
| check_added_dependencies: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v6 | ||
| - name: Check for added C++ header file dependencies | ||
| run: | | ||
| git fetch origin ${{ github.base_ref }}:${{ github.base_ref }} | ||
| git diff | python3 .github/workflows/actions/additionalChecks/added_dependency.py |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check notice
Code scanning / CodeQL
Unused import Note
Copilot Autofix
AI 2 months ago
To fix the problem, remove the unused import statement
import Draftfrom line 31. This change should be carried out insrc/Mod/CAM/Path/Geom.py. No other modifications are necessary, and no new methods or imports are required. Simply delete the line to resolve the unused import warning.