kindred/create
1
1
Fork 0
Code Issues 53 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Merge pull request #3 from chennes/testsForClassLocator

Browse Source 
Tests for class locator, and fixup
This commit is contained in:
PaddleStroke
2023-03-31 17:37:25 +02:00
committed by GitHub
parent 184147d513 fcfcebea0b
commit 15ee7d1bb2
2 changed files with 153 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
src/Mod/AddonManager/Addon.py
View File

@@ -593,7 +593,7 @@ class Addon:
"The existence of this file prevents FreeCAD from loading this Addon. To re-enable, delete the file."
)
if (self.contains_workbench()):
if self.contains_workbench():
self.disable_workbench()
def enable(self):
@@ -605,7 +605,7 @@ class Addon:
except FileNotFoundError:
pass
if (self.contains_workbench()):
if self.contains_workbench():
self.enable_workbench()
def enable_workbench(self):
@@ -614,7 +614,6 @@ class Addon:
# Remove from the list of disabled.
self.remove_from_disabled_wbs(wbName)
def disable_workbench(self):
pref = fci.ParamGet("User parameter:BaseApp/Preferences/Workbenches")
wbName = self.get_workbench_name()
@@ -628,7 +627,6 @@ class Addon:
pref.SetString("Disabled", disabled_wbs)
# print(f"done disabling : {disabled_wbs} \n")
def desinstall_workbench(self):
pref = fci.ParamGet("User parameter:BaseApp/Preferences/Workbenches")
wbName = self.get_workbench_name()
@@ -649,7 +647,6 @@ class Addon:
# Remove from the list of disabled.
self.remove_from_disabled_wbs(wbName)
def remove_from_disabled_wbs(self, wbName: str):
pref = fci.ParamGet("User parameter:BaseApp/Preferences/Workbenches")
@@ -665,13 +662,15 @@ class Addon:
pref.SetString("Disabled", disabled_wbs)
# print(f"Done enabling {disabled_wbs} \n")
def get_workbench_name(self) -> str:
"""Find the name of the workbench class (ie the name under which it's registered in freecad core)')"""
"""Find the name of the workbench class (ie the name under which it's
registered in freecad core)'"""
wb_name = ""
if self.repo_type == Addon.Kind.PACKAGE:
for wb in self.metadata.content["workbench"]: # we may have more than one wb.
for wb in self.metadata.content[
"workbench"
]: # we may have more than one wb.
if wb_name != "":
wb_name += ","
wb_name += wb.classname
@@ -681,33 +680,38 @@ class Addon:
wb_name = self.name
return wb_name
def try_find_wbname_in_files(self) -> str:
wb_name = ""
filesInDir = []
"""Attempt to locate a line with an addWorkbench command in the workbench's
Python files. If it is directly instantiating a workbench, then we can use
the line to determine classname for this workbench. If it uses a variable,
or if the line doesn't exist at all, an empty string is returned."""
mod_dir = os.path.join(self.mod_directory, self.name)
for root, subdirs, files in os.walk(mod_dir):
for root, _, files in os.walk(mod_dir):
for f in files:
if not os.path.isdir(os.path.join(root, f).replace("\\", "/")):
filesInDir.append(os.path.join(root, f).replace("\\", "/"))
if filesInDir:
for currentfile in filesInDir:
filename, extension = os.path.splitext(currentfile)
if extension == ".py":
# print(f"Current file: {currentfile} ")
try:
with open(os.path.join(root, currentfile), "r") as f:
content = f.read()
m = re.search("Gui.addWorkbench\((\w+)\(\)\)", content)
if m:
wb_name = m.group(1)
break
except Exception as e:
continue
# print(f"Found name {wb_name} \n")
return wb_name
current_file = os.path.join(root, f)
if not os.path.isdir(current_file):
filename, extension = os.path.splitext(current_file)
if extension == ".py":
wb_classname = self._find_classname_in_file(current_file)
print(f"Current file: {current_file} ")
if wb_classname:
print(f"Found name {wb_classname} \n")
return wb_classname
return ""
@staticmethod
def _find_classname_in_file(current_file) -> str:
try:
with open(current_file, "r", encoding="utf-8") as python_file:
content = python_file.read()
search_result = re.search(r"Gui.addWorkbench\s*\(\s*(\w+)\s*\(\s*\)\s*\)", content)
if search_result:
return search_result.group(1)
except OSError:
pass
return ""
# @dataclass(frozen)
class MissingDependencies:
@@ -771,7 +775,9 @@ class MissingDependencies:
translate(
"AddonsInstaller",
"Got an error when trying to import {}",
).format(py_dep) + ":\n" + str(e)
).format(py_dep)
+ ":\n"
+ str(e)
)
self.python_optional = []
@@ -785,7 +791,9 @@ class MissingDependencies:
translate(
"AddonsInstaller",
"Got an error when trying to import {}",
).format(py_dep) + ":\n" + str(e)
).format(py_dep)
+ ":\n"
+ str(e)
)
self.wbs.sort()

117
src/Mod/AddonManager/AddonManagerTest/app/test_addon.py
View File

@@ -20,7 +20,7 @@
# * <https://www.gnu.org/licenses/>. *
# * *
# ***************************************************************************
import tempfile
import unittest
import os
import sys
@@ -32,7 +32,6 @@ from addonmanager_macro import Macro
class TestAddon(unittest.TestCase):
MODULE = "test_addon" # file name without extension
def setUp(self):
@@ -41,7 +40,6 @@ class TestAddon(unittest.TestCase):
)
def test_display_name(self):
# Case 1: No display name set elsewhere: name == display_name
addon = Addon(
"FreeCAD",
@@ -84,7 +82,6 @@ class TestAddon(unittest.TestCase):
self.assertEqual(expected_tags, tags)
def test_contains_functions(self):
# Test package.xml combinations:
# Workbenches
@@ -201,7 +198,6 @@ class TestAddon(unittest.TestCase):
self.assertTrue(addon.__dict__, second_addon.__dict__)
def test_dependency_resolution(self):
addonA = Addon(
"AddonA",
"https://github.com/FreeCAD/FakeAddonA",
@@ -303,3 +299,114 @@ class TestAddon(unittest.TestCase):
"TagC" in addon.tags,
"Found 'TagA' in tags, it should have been excluded by version requirement",
)
def test_try_find_wbname_in_files_empty_dir(self):
with tempfile.TemporaryDirectory() as mod_dir:
# Arrange
test_addon = Addon("test")
test_addon.mod_directory = mod_dir
os.mkdir(os.path.join(mod_dir, test_addon.name))
# Act
wb_name = test_addon.try_find_wbname_in_files()
# Assert
self.assertEqual(wb_name, "")
def test_try_find_wbname_in_files_non_python_ignored(self):
with tempfile.TemporaryDirectory() as mod_dir:
# Arrange
test_addon = Addon("test")
test_addon.mod_directory = mod_dir
base_path = os.path.join(mod_dir, test_addon.name)
os.mkdir(base_path)
file_path = os.path.join(base_path, "test.txt")
with open(file_path, "w", encoding="utf-8") as f:
f.write("Gui.addWorkbench(TestWorkbench())")
# Act
wb_name = test_addon.try_find_wbname_in_files()
# Assert
self.assertEqual(wb_name, "")
def test_try_find_wbname_in_files_simple(self):
with tempfile.TemporaryDirectory() as mod_dir:
# Arrange
test_addon = Addon("test")
test_addon.mod_directory = mod_dir
base_path = os.path.join(mod_dir, test_addon.name)
os.mkdir(base_path)
file_path = os.path.join(base_path, "test.py")
with open(file_path, "w", encoding="utf-8") as f:
f.write("Gui.addWorkbench(TestWorkbench())")
# Act
wb_name = test_addon.try_find_wbname_in_files()
# Assert
self.assertEqual(wb_name, "TestWorkbench")
def test_try_find_wbname_in_files_subdir(self):
with tempfile.TemporaryDirectory() as mod_dir:
# Arrange
test_addon = Addon("test")
test_addon.mod_directory = mod_dir
base_path = os.path.join(mod_dir, test_addon.name)
os.mkdir(base_path)
subdir = os.path.join(base_path, "subdirectory")
os.mkdir(subdir)
file_path = os.path.join(subdir, "test.py")
with open(file_path, "w", encoding="utf-8") as f:
f.write("Gui.addWorkbench(TestWorkbench())")
# Act
wb_name = test_addon.try_find_wbname_in_files()
# Assert
self.assertEqual(wb_name, "TestWorkbench")
def test_try_find_wbname_in_files_variable_used(self):
with tempfile.TemporaryDirectory() as mod_dir:
# Arrange
test_addon = Addon("test")
test_addon.mod_directory = mod_dir
base_path = os.path.join(mod_dir, test_addon.name)
os.mkdir(base_path)
file_path = os.path.join(base_path, "test.py")
with open(file_path, "w", encoding="utf-8") as f:
f.write("Gui.addWorkbench(wb)")
# Act
wb_name = test_addon.try_find_wbname_in_files()
# Assert
self.assertEqual(wb_name, "")
def test_try_find_wbname_in_files_variants(self):
variants = [
"Gui.addWorkbench(TestWorkbench())",
"Gui.addWorkbench (TestWorkbench())",
"Gui.addWorkbench( TestWorkbench() )",
"Gui.addWorkbench(TestWorkbench( ))",
"Gui.addWorkbench( TestWorkbench( ) )",
"Gui.addWorkbench( TestWorkbench ( ) )",
"Gui.addWorkbench ( TestWorkbench ( ) )",
]
for variant in variants:
with self.subTest(variant=variant):
with tempfile.TemporaryDirectory() as mod_dir:
# Arrange
test_addon = Addon("test")
test_addon.mod_directory = mod_dir
base_path = os.path.join(mod_dir, test_addon.name)
os.mkdir(base_path)
file_path = os.path.join(base_path, "test.py")
with open(file_path, "w", encoding="utf-8") as f:
f.write(variant)
# Act
wb_name = test_addon.try_find_wbname_in_files()
# Assert
self.assertEqual(wb_name, "TestWorkbench")