From 6e50d0cb228f13fa44f01c6dfccf14f5c06fbc2f Mon Sep 17 00:00:00 2001 From: Sven Heidemann Date: Thu, 23 Jun 2022 23:47:29 +0200 Subject: [PATCH] Added tests for publish command --- unittests/unittests_cli/cli_test_suite.py | 12 +-- unittests/unittests_cli/publish_test_case.py | 90 +++++++++++++++++++- unittests/unittests_shared/cli_commands.py | 4 + 3 files changed, 92 insertions(+), 14 deletions(-) diff --git a/unittests/unittests_cli/cli_test_suite.py b/unittests/unittests_cli/cli_test_suite.py index fac4682b..cac0af7d 100644 --- a/unittests/unittests_cli/cli_test_suite.py +++ b/unittests/unittests_cli/cli_test_suite.py @@ -11,6 +11,7 @@ from unittests_cli.constants import PLAYGROUND_PATH from unittests_cli.generate_test_case import GenerateTestCase from unittests_cli.install_test_case import InstallTestCase from unittests_cli.new_test_case import NewTestCase +from unittests_cli.publish_test_case import PublishTestCase from unittests_cli.remove_test_case import RemoveTestCase from unittests_cli.uninstall_test_case import UninstallTestCase from unittests_cli.update_test_case import UpdateTestCase @@ -28,28 +29,19 @@ class CLITestSuite(unittest.TestSuite): # nothing needed GenerateTestCase, NewTestCase, - # compare console output # VersionTestCase, - # project needed - # compare two file states/directory content BuildTestCase, InstallTestCase, - - # compare two file states/directory content - # PublishTestCase, - + PublishTestCase, # check if application was executed properly # RunTestCase, - # check if application was executed properly and file watcher is working # StartTestCase, - UninstallTestCase, # check in project settings if package is updated # UpdateTestCase, - # workspace needed AddTestCase, RemoveTestCase diff --git a/unittests/unittests_cli/publish_test_case.py b/unittests/unittests_cli/publish_test_case.py index bad55d55..7c828ced 100644 --- a/unittests/unittests_cli/publish_test_case.py +++ b/unittests/unittests_cli/publish_test_case.py @@ -1,10 +1,92 @@ +import filecmp +import json +import os +import shutil import unittest +from cpl_core.utils import String + +from unittests_cli.constants import PLAYGROUND_PATH +from unittests_shared.cli_commands import CLICommands + class PublishTestCase(unittest.TestCase): - def setUp(self): - pass + def __init__(self, methodName: str): + unittest.TestCase.__init__(self, methodName) + self._source = 'publish-test-source' + self._project_file = f'src/{String.convert_to_snake_case(self._source)}/{self._source}.json' - def test_equal(self): - pass + def _get_project_settings(self): + with open(os.path.join(os.getcwd(), self._project_file), 'r', encoding='utf-8') as cfg: + # load json + project_json = json.load(cfg) + cfg.close() + + return project_json + + def _save_project_settings(self, settings: dict): + with open(os.path.join(os.getcwd(), self._project_file), 'w', encoding='utf-8') as project_file: + project_file.write(json.dumps(settings, indent=2)) + project_file.close() + + def setUp(self): + os.chdir(os.path.abspath(PLAYGROUND_PATH)) + # create projects + CLICommands.new('console', self._source, '--ab', '--s') + os.chdir(os.path.join(os.getcwd(), self._source)) + + def cleanUp(self): + # remove projects + if not os.path.exists(os.path.abspath(os.path.join(PLAYGROUND_PATH, self._source))): + return + + shutil.rmtree(os.path.abspath(os.path.join(PLAYGROUND_PATH, self._source))) + + def _are_dir_trees_equal(self, dir1, dir2): + """ + found at https://stackoverflow.com/questions/4187564/recursively-compare-two-directories-to-ensure-they-have-the-same-files-and-subdi + + Compare two directories recursively. Files in each directory are + assumed to be equal if their names and contents are equal. + + @param dir1: First directory path + @param dir2: Second directory path + + @return: True if the directory trees are the same and + there were no errors while accessing the directories or files, + False otherwise. + """ + + dirs_cmp = filecmp.dircmp(dir1, dir2) + if len(dirs_cmp.left_only) > 0 or len(dirs_cmp.right_only) > 0 or len(dirs_cmp.funny_files) > 0: + return False + + (_, mismatch, errors) = filecmp.cmpfiles(dir1, dir2, dirs_cmp.common_files, shallow=False) + + if len(mismatch) > 0 or len(errors) > 0: + return False + + for common_dir in dirs_cmp.common_dirs: + new_dir1 = os.path.join(dir1, common_dir) + new_dir2 = os.path.join(dir2, common_dir) + if not self._are_dir_trees_equal(new_dir1, new_dir2): + return False + + return True + + def test_publish(self): + CLICommands.publish() + dist_path = './dist' + setup_path = f'{dist_path}/{self._source}/publish/setup' + full_dist_path = f'{dist_path}/{self._source}/publish/build/lib/{String.convert_to_snake_case(self._source)}' + self.assertTrue(os.path.exists(dist_path)) + self.assertTrue(os.path.exists(setup_path)) + self.assertTrue(os.path.exists(os.path.join(setup_path, f'{self._source}-0.0.0.tar.gz'))) + self.assertTrue(os.path.exists(os.path.join(setup_path, f'{String.convert_to_snake_case(self._source)}-0.0.0-py3-none-any.whl'))) + self.assertTrue(os.path.exists(full_dist_path)) + self.assertFalse(self._are_dir_trees_equal(f'./src/{String.convert_to_snake_case(self._source)}', full_dist_path)) + with open(f'{full_dist_path}/{self._source}.json', 'w') as file: + file.write(json.dumps(self._get_project_settings(), indent=2)) + file.close() + self.assertTrue(self._are_dir_trees_equal(f'./src/{String.convert_to_snake_case(self._source)}', full_dist_path)) diff --git a/unittests/unittests_shared/cli_commands.py b/unittests/unittests_shared/cli_commands.py index e11b1274..e685a73e 100644 --- a/unittests/unittests_shared/cli_commands.py +++ b/unittests/unittests_shared/cli_commands.py @@ -41,6 +41,10 @@ class CLICommands: def new(cls, project_type: str, name: str, *args, output=False): cls._run('new', project_type, name, *args, output=output) + @classmethod + def publish(cls): + cls._run('publish') + @classmethod def remove(cls, project: str): cls._run('remove', project)