8a95d0e6e8
* Addon Manager: Refactor utilities tests to remove filesystem use * Addon Manager: Move process_date_string_to_python_datetime to utilities Also add unit tests and modify the exception type * Addon Manager: Add tests for other date separators * Addon Manager: Refactor to reduce duplication * Addon Manager: add explanation of why the function exists * Addon Manager: use exception chaining * Addon Manager: Remove unused test files
288 lines
12 KiB
Python
288 lines
12 KiB
Python
# SPDX-License-Identifier: LGPL-2.1-or-later
|
|
# ***************************************************************************
|
|
# * *
|
|
# * Copyright (c) 2022-2023 FreeCAD Project Association *
|
|
# * *
|
|
# * This file is part of FreeCAD. *
|
|
# * *
|
|
# * FreeCAD is free software: you can redistribute it and/or modify it *
|
|
# * under the terms of the GNU Lesser General Public License as *
|
|
# * published by the Free Software Foundation, either version 2.1 of the *
|
|
# * License, or (at your option) any later version. *
|
|
# * *
|
|
# * FreeCAD is distributed in the hope that it will be useful, but *
|
|
# * WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
|
|
# * Lesser General Public License for more details. *
|
|
# * *
|
|
# * You should have received a copy of the GNU Lesser General Public *
|
|
# * License along with FreeCAD. If not, see *
|
|
# * <https://www.gnu.org/licenses/>. *
|
|
# * *
|
|
# ***************************************************************************
|
|
|
|
from datetime import datetime
|
|
import unittest
|
|
from unittest.mock import MagicMock, patch, mock_open
|
|
import os
|
|
import sys
|
|
import subprocess
|
|
|
|
try:
|
|
import FreeCAD
|
|
except ImportError:
|
|
FreeCAD = None
|
|
|
|
sys.path.append("../..")
|
|
|
|
from AddonManagerTest.app.mocks import MockAddon as Addon
|
|
|
|
from addonmanager_utilities import (
|
|
get_assigned_string_literal,
|
|
get_macro_version_from_file,
|
|
get_readme_url,
|
|
process_date_string_to_python_datetime,
|
|
recognized_git_location,
|
|
run_interruptable_subprocess,
|
|
)
|
|
|
|
|
|
class TestUtilities(unittest.TestCase):
|
|
|
|
MODULE = "test_utilities" # file name without extension
|
|
|
|
@classmethod
|
|
def tearDownClass(cls):
|
|
try:
|
|
os.remove("AM_INSTALLATION_DIGEST.txt")
|
|
except FileNotFoundError:
|
|
pass
|
|
|
|
def test_recognized_git_location(self):
|
|
recognized_urls = [
|
|
"https://github.com/FreeCAD/FreeCAD",
|
|
"https://gitlab.com/freecad/FreeCAD",
|
|
"https://framagit.org/freecad/FreeCAD",
|
|
"https://salsa.debian.org/science-team/freecad",
|
|
]
|
|
for url in recognized_urls:
|
|
repo = Addon("Test Repo", url, "Addon.Status.NOT_INSTALLED", "branch")
|
|
self.assertTrue(recognized_git_location(repo), f"{url} was unexpectedly not recognized")
|
|
|
|
unrecognized_urls = [
|
|
"https://google.com",
|
|
"https://freecad.org",
|
|
"https://not.quite.github.com/FreeCAD/FreeCAD",
|
|
"https://github.com.malware.com/",
|
|
]
|
|
for url in unrecognized_urls:
|
|
repo = Addon("Test Repo", url, "Addon.Status.NOT_INSTALLED", "branch")
|
|
self.assertFalse(recognized_git_location(repo), f"{url} was unexpectedly recognized")
|
|
|
|
def test_get_readme_url(self):
|
|
github_urls = [
|
|
"https://github.com/FreeCAD/FreeCAD",
|
|
]
|
|
gitlab_urls = [
|
|
"https://gitlab.com/freecad/FreeCAD",
|
|
"https://framagit.org/freecad/FreeCAD",
|
|
"https://salsa.debian.org/science-team/freecad",
|
|
"https://unknown.location/and/path",
|
|
]
|
|
|
|
# GitHub and Gitlab have two different schemes for file URLs: unrecognized URLs are
|
|
# presumed to be local instances of a GitLab server. Note that in neither case does this
|
|
# take into account the redirects that are used to actually fetch the data.
|
|
|
|
for url in github_urls:
|
|
branch = "branchname"
|
|
expected_result = f"{url}/raw/{branch}/README.md"
|
|
repo = Addon("Test Repo", url, "Addon.Status.NOT_INSTALLED", branch)
|
|
actual_result = get_readme_url(repo)
|
|
self.assertEqual(actual_result, expected_result)
|
|
|
|
for url in gitlab_urls:
|
|
branch = "branchname"
|
|
expected_result = f"{url}/-/raw/{branch}/README.md"
|
|
repo = Addon("Test Repo", url, "Addon.Status.NOT_INSTALLED", branch)
|
|
actual_result = get_readme_url(repo)
|
|
self.assertEqual(actual_result, expected_result)
|
|
|
|
def test_get_assigned_string_literal(self):
|
|
good_lines = [
|
|
["my_var = 'Single-quoted literal'", "Single-quoted literal"],
|
|
['my_var = "Double-quoted literal"', "Double-quoted literal"],
|
|
["my_var = \t 'Extra whitespace'", "Extra whitespace"],
|
|
["my_var = 42", "42"],
|
|
["my_var = 1.23", "1.23"],
|
|
]
|
|
for line in good_lines:
|
|
result = get_assigned_string_literal(line[0])
|
|
self.assertEqual(result, line[1])
|
|
|
|
bad_lines = [
|
|
"my_var = __date__",
|
|
"my_var 'No equals sign'",
|
|
"my_var = 'Unmatched quotes\"",
|
|
"my_var = No quotes at all",
|
|
"my_var = 1.2.3",
|
|
]
|
|
for line in bad_lines:
|
|
result = get_assigned_string_literal(line)
|
|
self.assertIsNone(result)
|
|
|
|
def test_get_macro_version_from_file_good_metadata(self):
|
|
good_metadata = """__Version__ = "1.2.3" """
|
|
with patch("builtins.open", new_callable=mock_open, read_data=good_metadata):
|
|
version = get_macro_version_from_file("mocked_file.FCStd")
|
|
self.assertEqual(version, "1.2.3")
|
|
|
|
def test_get_macro_version_from_file_missing_quotes(self):
|
|
bad_metadata = """__Version__ = 1.2.3 """ # No quotes
|
|
with patch("builtins.open", new_callable=mock_open, read_data=bad_metadata):
|
|
version = get_macro_version_from_file("mocked_file.FCStd")
|
|
self.assertEqual(version, "", "Bad version did not yield empty string")
|
|
|
|
def test_get_macro_version_from_file_no_version(self):
|
|
good_metadata = ""
|
|
with patch("builtins.open", new_callable=mock_open, read_data=good_metadata):
|
|
version = get_macro_version_from_file("mocked_file.FCStd")
|
|
self.assertEqual(version, "", "Missing version did not yield empty string")
|
|
|
|
@patch("subprocess.Popen")
|
|
def test_run_interruptable_subprocess_success_instant_return(self, mock_popen):
|
|
mock_process = MagicMock()
|
|
mock_process.communicate.return_value = ("Mocked stdout", "Mocked stderr")
|
|
mock_process.returncode = 0
|
|
mock_popen.return_value = mock_process
|
|
|
|
completed_process = run_interruptable_subprocess(["arg0", "arg1"])
|
|
|
|
self.assertEqual(completed_process.returncode, 0)
|
|
self.assertEqual(completed_process.stdout, "Mocked stdout")
|
|
self.assertEqual(completed_process.stderr, "Mocked stderr")
|
|
|
|
@patch("subprocess.Popen")
|
|
def test_run_interruptable_subprocess_returns_nonzero(self, mock_popen):
|
|
mock_process = MagicMock()
|
|
mock_process.communicate.return_value = ("Mocked stdout", "Mocked stderr")
|
|
mock_process.returncode = 1
|
|
mock_popen.return_value = mock_process
|
|
|
|
with self.assertRaises(subprocess.CalledProcessError):
|
|
run_interruptable_subprocess(["arg0", "arg1"])
|
|
|
|
@patch("subprocess.Popen")
|
|
def test_run_interruptable_subprocess_timeout_five_times(self, mock_popen):
|
|
"""Five times is below the limit for an error to be raised"""
|
|
|
|
def raises_first_five_times(timeout):
|
|
raises_first_five_times.counter += 1
|
|
if raises_first_five_times.counter <= 5:
|
|
raise subprocess.TimeoutExpired("Test", timeout)
|
|
return "Mocked stdout", None
|
|
|
|
raises_first_five_times.counter = 0
|
|
|
|
mock_process = MagicMock()
|
|
mock_process.communicate = raises_first_five_times
|
|
mock_process.returncode = 0
|
|
mock_popen.return_value = mock_process
|
|
|
|
result = run_interruptable_subprocess(["arg0", "arg1"], 10)
|
|
|
|
self.assertEqual(result.returncode, 0)
|
|
|
|
@patch("subprocess.Popen")
|
|
def test_run_interruptable_subprocess_timeout_exceeded(self, mock_popen):
|
|
"""Exceeding the set timeout gives a CalledProcessError exception"""
|
|
|
|
def raises_one_time(timeout=0):
|
|
if not raises_one_time.raised:
|
|
raises_one_time.raised = True
|
|
raise subprocess.TimeoutExpired("Test", timeout)
|
|
return "Mocked stdout", None
|
|
|
|
raises_one_time.raised = False
|
|
|
|
def fake_time():
|
|
"""Time that advances by one second every time it is called"""
|
|
fake_time.time += 1.0
|
|
return fake_time.time
|
|
|
|
fake_time.time = 0.0
|
|
|
|
mock_process = MagicMock()
|
|
mock_process.communicate = raises_one_time
|
|
raises_one_time.mock_access = mock_process
|
|
mock_process.returncode = None
|
|
mock_popen.return_value = mock_process
|
|
|
|
with self.assertRaises(subprocess.CalledProcessError):
|
|
with patch("time.time", fake_time):
|
|
run_interruptable_subprocess(["arg0", "arg1"], 0.1)
|
|
|
|
def test_process_date_string_to_python_datetime_non_numeric(self):
|
|
with self.assertRaises(ValueError):
|
|
process_date_string_to_python_datetime("TwentyTwentyFour-January-ThirtyFirst")
|
|
|
|
def test_process_date_string_to_python_datetime_year_first(self):
|
|
result = process_date_string_to_python_datetime("2024-01-31")
|
|
expected_result = datetime(2024, 1, 31, 0, 0)
|
|
self.assertEqual(result, expected_result)
|
|
|
|
def test_process_date_string_to_python_datetime_day_first(self):
|
|
result = process_date_string_to_python_datetime("31-01-2024")
|
|
expected_result = datetime(2024, 1, 31, 0, 0)
|
|
self.assertEqual(result, expected_result)
|
|
|
|
def test_process_date_string_to_python_datetime_month_first(self):
|
|
result = process_date_string_to_python_datetime("01-31-2024")
|
|
expected_result = datetime(2024, 1, 31, 0, 0)
|
|
self.assertEqual(result, expected_result)
|
|
|
|
def test_process_date_string_to_python_datetime_ambiguous(self):
|
|
"""In the ambiguous case, the code should assume that the date is in the DD-MM-YYYY format."""
|
|
result = process_date_string_to_python_datetime("01-12-2024")
|
|
expected_result = datetime(2024, 12, 1, 0, 0)
|
|
self.assertEqual(result, expected_result)
|
|
|
|
def test_process_date_string_to_python_datetime_invalid_date(self):
|
|
with self.assertRaises(ValueError):
|
|
process_date_string_to_python_datetime("13-31-2024")
|
|
|
|
def test_process_date_string_to_python_datetime_too_many_components(self):
|
|
with self.assertRaises(ValueError):
|
|
process_date_string_to_python_datetime("01-01-31-2024")
|
|
|
|
def test_process_date_string_to_python_datetime_too_few_components(self):
|
|
"""Month-Year-only dates are not supported"""
|
|
with self.assertRaises(ValueError):
|
|
process_date_string_to_python_datetime("01-2024")
|
|
|
|
def test_process_date_string_to_python_datetime_unrecognizable(self):
|
|
"""Two-digit years are not supported"""
|
|
with self.assertRaises(ValueError):
|
|
process_date_string_to_python_datetime("01-02-24")
|
|
|
|
def test_process_date_string_to_python_datetime_valid_separators(self):
|
|
"""Four individual separators are supported, plus any combination of multiple of those separators"""
|
|
valid_separators = [" ", ".", "/", "-", " - ", " / ", "--"]
|
|
for separator in valid_separators:
|
|
with self.subTest(separator=separator):
|
|
result = process_date_string_to_python_datetime(f"2024{separator}01{separator}31")
|
|
expected_result = datetime(2024, 1, 31, 0, 0)
|
|
self.assertEqual(result, expected_result)
|
|
|
|
def test_process_date_string_to_python_datetime_invalid_separators(self):
|
|
"""Only the four separators [ ./-] are supported: ensure others fail"""
|
|
invalid_separators = ["a", "\\", "|", "'", ";", "*", " \\ "]
|
|
for separator in invalid_separators:
|
|
with self.subTest(separator=separator):
|
|
with self.assertRaises(ValueError):
|
|
process_date_string_to_python_datetime(f"2024{separator}01{separator}31")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|