PySide Tools: Deploy Tool Tests

- test --dry-run in different scenarios for widgets and qml
  In this particular case, running --dry-run is equivalent to mocking
  Nuitka because the output command is the command run by Nuitka
- tests the contents on config file for widgets and qml deployments

Task-number: PYSIDE-1612
Change-Id: I4624bdc71f9ccd027147ca10a942037d6c43fbfc
Reviewed-by: Christian Tismer <tismer@stackless.com>
(cherry picked from commit dc992c359d96c9018c03b6b631e41bd37186a438)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>

2 files changed, 184 insertions, 0 deletions

diff --git a/sources/pyside6/tests/tools/pyside6-deploy/CMakeLists.txt b/sources/pyside6/tests/tools/pyside6-deploy/CMakeLists.txt
new file mode 100644
index 000000000..7f010fbd6
--- /dev/null
+++ b/sources/pyside6/tests/tools/pyside6-deploy/CMakeLists.txt
@@ -0,0 +1 @@
+PYSIDE_TEST(test_pyside6_deploy.py)
diff --git a/sources/pyside6/tests/tools/pyside6-deploy/test_pyside6_deploy.py b/sources/pyside6/tests/tools/pyside6-deploy/test_pyside6_deploy.py
new file mode 100644
index 000000000..28bc50ffe
--- /dev/null
+++ b/sources/pyside6/tests/tools/pyside6-deploy/test_pyside6_deploy.py
@@ -0,0 +1,183 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
+
+import unittest
+import tempfile
+import shutil
+import sys
+import os
+import subprocess
+import importlib
+from pathlib import Path
+from configparser import ConfigParser
+
+
+def execute(args):
+    output = subprocess.check_output(args=args).decode("utf-8")
+    return output
+
+
+class ConfigFile:
+    def __init__(self, config_file: Path) -> None:
+        self.config_file = config_file
+        self.parser = ConfigParser(comment_prefixes="/", allow_no_value=True)
+        self.parser.read(self.config_file)
+
+    def get_value(self, section: str, key: str):
+        return str(self.parser.get(section, key))
+
+
+class TestPySide6Deploy(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.pyside_root = Path(__file__).parents[5].resolve()
+        example_root = cls.pyside_root / "examples"
+        example_widgets = example_root / "widgets" / "widgets" / "tetrix"
+        example_qml = example_root / "qml" / "editingmodel"
+        cls.temp_dir = tempfile.mkdtemp()
+        cls.temp_example_widgets = Path(
+            shutil.copytree(example_widgets, Path(cls.temp_dir) / "tetrix")
+        ).resolve()
+        cls.temp_example_qml = Path(
+            shutil.copytree(example_qml, Path(cls.temp_dir) / "editingmodel")
+        ).resolve()
+        cls.deploy_tool = cls.pyside_root / "sources" / "pyside-tools" / "deploy.py"
+        cls.pydeploy_run_cmd = [sys.executable, os.fspath(cls.deploy_tool), "--dry-run"]
+        cls.current_dir = Path.cwd()
+        cls.linux_onefile_icon = (
+            cls.pyside_root / "sources" / "pyside-tools" / "deploy" / "pyside_icon.jpg"
+        )
+
+        # required for comparing long strings
+        cls.maxDiff = None
+
+    def setUpWidgets(self):
+        os.chdir(self.temp_example_widgets)
+        self.main_file = self.temp_example_widgets / "tetrix.py"
+        self.deployment_files = self.temp_example_widgets / "deployment"
+        self.expected_run_cmd = (
+            f"{sys.executable} -m nuitka {str(self.main_file)} --follow-imports --onefile"
+            f" --enable-plugin=pyside6 --output-dir={str(self.deployment_files)} --quiet"
+        )
+        if sys.platform.startswith("linux"):
+            self.expected_run_cmd +=  f" --linux-onefile-icon={str(self.linux_onefile_icon)}"
+        self.config_file = self.temp_example_widgets / "pysidedeploy.spec"
+
+    def testWidgetDryRun(self):
+        # Checking for dry run commands is equivalent to mocking the
+        # subprocess.check_call() in commands.py as the the dry run command
+        # is the command being run.
+        self.setUpWidgets()
+        extra_args = [self.main_file]
+        cmd = self.pydeploy_run_cmd + extra_args
+        original_output = execute(args=cmd)
+        self.assertEqual(str(original_output.strip()), self.expected_run_cmd)
+        os.remove(self.config_file)
+
+    def testWidgetConfigFile(self):
+        # includes both dry run and config_file tests
+
+        self.setUpWidgets()
+        # init
+        extra_args = [self.main_file, "--init"]
+        cmd = self.pydeploy_run_cmd.copy()
+        cmd.remove("--dry-run")
+        cmd.extend(extra_args)
+        init_result = execute(args=cmd)
+        self.assertEqual(init_result, "")
+
+        # test with config
+        config_path = self.temp_example_widgets / "pysidedeploy.spec"
+        extra_args = ["-c", os.fspath(config_path)]
+        cmd = self.pydeploy_run_cmd + extra_args
+        original_outputs = execute(args=cmd)
+        original_outputs = original_outputs.splitlines()
+
+        self.assertEqual(
+            original_outputs[0].strip(), f"Using existing config file {str(config_path)}"
+        )
+        self.assertEqual(str(original_outputs[1].strip()), self.expected_run_cmd)
+
+        # test config file contents
+        config_obj =  ConfigFile(config_file=self.config_file)
+        self.assertEqual(config_obj.get_value("app", "input_file"), "tetrix.py")
+        self.assertEqual(config_obj.get_value("app", "project_dir"), ".")
+        self.assertEqual(config_obj.get_value("app", "exec_directory"), ".")
+        self.assertEqual(
+            config_obj.get_value("python", "packages"), "nuitka,ordered_set,zstandard"
+        )
+        self.assertEqual(config_obj.get_value("qt", "qml_files"), "")
+        self.assertEqual(config_obj.get_value("nuitka", "extra_args"), "--quiet")
+
+        os.remove(self.config_file)
+
+    def setUpQml(self):
+        os.chdir(self.temp_example_qml)
+        self.main_file = self.temp_example_qml / "main.py"
+        self.deployment_files = self.temp_example_qml / "deployment"
+        self.first_qml_file = "main.qml"
+        self.second_qml_file = "MovingRectangle.qml"
+        self.expected_run_cmd = (
+            f"{sys.executable} -m nuitka {str(self.main_file)} --follow-imports --onefile"
+            f" --enable-plugin=pyside6 --output-dir={str(self.deployment_files)} --quiet"
+            f" --include-qt-plugins=all"
+            f" --include-data-files={str(self.temp_example_qml / self.first_qml_file)}="
+            f"./main.qml --include-data-files="
+            f"{str(self.temp_example_qml /self.second_qml_file)}=./MovingRectangle.qml"
+        )
+
+        if sys.platform.startswith("linux"):
+            self.expected_run_cmd +=  f" --linux-onefile-icon={str(self.linux_onefile_icon)}"
+        self.config_file = self.temp_example_qml / "pysidedeploy.spec"
+
+    def testQmlConfigFile(self):
+        self.setUpQml()
+
+        # create config file
+        extra_args = [self.main_file, "--init"]
+        cmd = self.pydeploy_run_cmd.copy()
+        cmd.remove("--dry-run")
+        cmd.extend(extra_args)
+        init_result = execute(args=cmd)
+        self.assertEqual(init_result, "")
+
+        # test config file contents
+        config_obj = ConfigFile(config_file=self.config_file)
+        self.assertEqual(config_obj.get_value("app", "input_file"), "main.py")
+        self.assertEqual(config_obj.get_value("app", "project_dir"), ".")
+        self.assertEqual(config_obj.get_value("app", "exec_directory"), ".")
+        self.assertEqual(
+            config_obj.get_value("python", "packages"), "nuitka,ordered_set,zstandard"
+        )
+        self.assertEqual(
+            config_obj.get_value("qt", "qml_files"), "main.qml,MovingRectangle.qml"
+        )
+        self.assertEqual(config_obj.get_value("nuitka", "extra_args"), "--quiet")
+        os.remove(self.config_file)
+
+    def testQmlDryRun(self):
+        self.setUpQml()
+        extra_args = [self.main_file]
+        cmd = self.pydeploy_run_cmd + extra_args
+        original_output = execute(args=cmd)
+        self.assertEqual(str(original_output.strip()), self.expected_run_cmd)
+        os.remove(self.config_file)
+
+    def testMainFileDryRun(self):
+        self.setUpQml()
+        cmd = self.pydeploy_run_cmd
+        original_output = execute(args=cmd)
+        self.assertEqual(str(original_output.strip()), self.expected_run_cmd)
+        os.remove(self.config_file)
+
+    def tearDown(self) -> None:
+        super().tearDown()
+        os.chdir(self.current_dir)
+
+    @classmethod
+    def tearDownClass(cls) -> None:
+        shutil.rmtree(Path(cls.temp_dir))
+
+
+if __name__ == "__main__":
+    unittest.main()