From 3c20ab296a70f4a1424c11e4192af74d838dd1c1 Mon Sep 17 00:00:00 2001 From: Sven Heidemann Date: Fri, 2 Dec 2022 17:48:35 +0100 Subject: [PATCH] Added --dev flag to cpl run & start #124 --- src/cpl_cli/command/run_service.py | 17 +++++++++++- .../live_server/live_server_service.py | 23 ++++++++++++++-- src/cpl_cli/startup_argument_extension.py | 6 +++-- .../general/src/general/arguments/__init__.py | 26 +++++++++++++++++++ .../custom/general/src/general/db/__init__.py | 7 ++--- tests/custom/general/src/general/general.json | 8 +++--- unittests/unittests_cli/run_test_case.py | 7 ++--- unittests/unittests_shared/cli_commands.py | 10 ++++--- 8 files changed, 84 insertions(+), 20 deletions(-) diff --git a/src/cpl_cli/command/run_service.py b/src/cpl_cli/command/run_service.py index 7aa4e456..92583f95 100644 --- a/src/cpl_cli/command/run_service.py +++ b/src/cpl_cli/command/run_service.py @@ -8,6 +8,7 @@ from cpl_cli.configuration import WorkspaceSettings from cpl_cli.configuration.build_settings import BuildSettings from cpl_cli.configuration.project_settings import ProjectSettings from cpl_cli.live_server.start_executable import StartExecutable +from cpl_cli.publish import PublisherService from cpl_core.configuration import ConfigurationABC from cpl_core.console.console import Console from cpl_core.dependency_injection import ServiceProviderABC @@ -22,7 +23,8 @@ class RunService(CommandABC): services: ServiceProviderABC, project_settings: ProjectSettings, build_settings: BuildSettings, - workspace: WorkspaceSettings + workspace: WorkspaceSettings, + publisher: PublisherService, ): """ Service for the CLI command start @@ -41,8 +43,10 @@ class RunService(CommandABC): self._project_settings = project_settings self._build_settings = build_settings self._workspace = workspace + self._publisher = publisher self._src_dir = os.path.join(self._env.working_directory, self._build_settings.source_path) + self._is_dev = False @property def help_message(self) -> str: @@ -80,16 +84,27 @@ class RunService(CommandABC): self._src_dir = os.path.dirname(json_file) + def _build(self): + if self._is_dev: + return + self._publisher.build() + def execute(self, args: list[str]): """ Entry point of command :param args: :return: """ + if 'dev' in args: + self._is_dev = True + args.remove('dev') + if len(args) >= 1: self._set_project_by_args(args[0]) args.remove(args[0]) + self._build() + start_service = StartExecutable(self._env, self._build_settings) start_service.run(args, self._project_settings.python_executable, self._src_dir, output=False) Console.write_line() diff --git a/src/cpl_cli/live_server/live_server_service.py b/src/cpl_cli/live_server/live_server_service.py index e9bb40b6..c51c9c58 100644 --- a/src/cpl_cli/live_server/live_server_service.py +++ b/src/cpl_cli/live_server/live_server_service.py @@ -6,6 +6,7 @@ import psutil as psutil from watchdog.events import FileSystemEventHandler from watchdog.observers import Observer +from cpl_cli.publish import PublisherService from cpl_core.console.console import Console from cpl_core.environment.application_environment_abc import ApplicationEnvironmentABC from cpl_cli.configuration.build_settings import BuildSettings @@ -15,8 +16,13 @@ from cpl_cli.live_server.live_server_thread import LiveServerThread class LiveServerService(FileSystemEventHandler): - def __init__(self, env: ApplicationEnvironmentABC, project_settings: ProjectSettings, - build_settings: BuildSettings): + def __init__( + self, + env: ApplicationEnvironmentABC, + project_settings: ProjectSettings, + build_settings: BuildSettings, + publisher: PublisherService, + ): """ Service for the live development server :param env: @@ -28,12 +34,14 @@ class LiveServerService(FileSystemEventHandler): self._env = env self._project_settings = project_settings self._build_settings = build_settings + self._publisher = publisher self._src_dir = os.path.join(self._env.working_directory, self._build_settings.source_path) self._ls_thread = None self._observer = None self._args: list[str] = [] + self._is_dev = False def _start_observer(self): """ @@ -87,6 +95,11 @@ class LiveServerService(FileSystemEventHandler): self._ls_thread.join() Console.close() + def _build(self): + if self._is_dev: + return + self._publisher.build() + def start(self, args: list[str]): """ Starts the CPL live development server @@ -97,6 +110,12 @@ class LiveServerService(FileSystemEventHandler): Console.error('Project has no entry point.') return + if 'dev' in args: + self._is_dev = True + args.remove('dev') + + self._build() + self._args = args Console.write_line('** CPL live development server is running **') self._start() diff --git a/src/cpl_cli/startup_argument_extension.py b/src/cpl_cli/startup_argument_extension.py index de57d9c3..16bd5449 100644 --- a/src/cpl_cli/startup_argument_extension.py +++ b/src/cpl_cli/startup_argument_extension.py @@ -60,8 +60,10 @@ class StartupArgumentExtension(StartupExtensionABC): config.create_console_argument(ArgumentTypeEnum.Executable, '', 'publish', ['p', 'P'], PublishService, True, validators=[ProjectValidator]) config.create_console_argument(ArgumentTypeEnum.Executable, '', 'remove', ['r', 'R'], RemoveService, True, validators=[WorkspaceValidator]) \ .add_console_argument(ArgumentTypeEnum.Flag, '--', 'simulate', ['s', 'S']) - config.create_console_argument(ArgumentTypeEnum.Executable, '', 'run', [], RunService, True, validators=[ProjectValidator]) - config.create_console_argument(ArgumentTypeEnum.Executable, '', 'start', ['s', 'S'], StartService, True, validators=[ProjectValidator]) + config.create_console_argument(ArgumentTypeEnum.Executable, '', 'run', [], RunService, True, validators=[ProjectValidator]) \ + .add_console_argument(ArgumentTypeEnum.Flag, '--', 'dev', ['d', 'D']) + config.create_console_argument(ArgumentTypeEnum.Executable, '', 'start', ['s', 'S'], StartService, True, validators=[ProjectValidator]) \ + .add_console_argument(ArgumentTypeEnum.Flag, '--', 'dev', ['d', 'D']) config.create_console_argument(ArgumentTypeEnum.Executable, '', 'uninstall', ['ui', 'UI'], UninstallService, True, validators=[ProjectValidator]) \ .add_console_argument(ArgumentTypeEnum.Flag, '--', 'dev', ['d', 'D']) \ .add_console_argument(ArgumentTypeEnum.Flag, '--', 'virtual', ['v', 'V']) \ diff --git a/tests/custom/general/src/general/arguments/__init__.py b/tests/custom/general/src/general/arguments/__init__.py index e69de29b..a1515376 100644 --- a/tests/custom/general/src/general/arguments/__init__.py +++ b/tests/custom/general/src/general/arguments/__init__.py @@ -0,0 +1,26 @@ +# -*- coding: utf-8 -*- + +""" +general sh-edraft Common Python library +~~~~~~~~~~~~~~~~~~~ + +sh-edraft Common Python library + +:copyright: (c) 2020 - 2021 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'general.arguments' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' +__version__ = '2021.4.1' + +from collections import namedtuple + + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major='2021', minor='04', micro='01') diff --git a/tests/custom/general/src/general/db/__init__.py b/tests/custom/general/src/general/db/__init__.py index 746ca0b0..099d021f 100644 --- a/tests/custom/general/src/general/db/__init__.py +++ b/tests/custom/general/src/general/db/__init__.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +general sh-edraft Common Python library ~~~~~~~~~~~~~~~~~~~ sh-edraft Common Python library @@ -11,7 +11,7 @@ sh-edraft Common Python library """ -__title__ = 'tests.db' +__title__ = 'general.db' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' @@ -19,7 +19,8 @@ __version__ = '2021.4.1' from collections import namedtuple + # imports: VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major=2021, minor=4, micro=1) +version_info = VersionInfo(major='2021', minor='04', micro='01') diff --git a/tests/custom/general/src/general/general.json b/tests/custom/general/src/general/general.json index 0bf4dded..aa7ce5d7 100644 --- a/tests/custom/general/src/general/general.json +++ b/tests/custom/general/src/general/general.json @@ -16,12 +16,12 @@ "LicenseName": "MIT", "LicenseDescription": "MIT, see LICENSE for more details.", "Dependencies": [ - "cpl-core==2022.10rc2", - "cpl-translation==2022.10rc2", - "cpl-query==2022.10rc2" + "cpl-core==2022.10.0.post9", + "cpl-translation==2022.10.0.post2", + "cpl-query==2022.10.0.post2" ], "DevDependencies": [ - "cpl-cli==2022.10.rc2" + "cpl-cli==2022.10" ], "PythonVersion": ">=3.10", "PythonPath": { diff --git a/unittests/unittests_cli/run_test_case.py b/unittests/unittests_cli/run_test_case.py index 23841a79..eeaf05b5 100644 --- a/unittests/unittests_cli/run_test_case.py +++ b/unittests/unittests_cli/run_test_case.py @@ -46,9 +46,6 @@ class RunTestCase(CommandTestCase): project_file.close() def setUp(self): - if not os.path.exists(PLAYGROUND_PATH): - os.makedirs(PLAYGROUND_PATH) - os.chdir(PLAYGROUND_PATH) # create projects CLICommands.new('console', self._source, '--ab', '--s') @@ -60,7 +57,7 @@ class RunTestCase(CommandTestCase): file.close() def test_run(self): - CLICommands.run() + CLICommands.run(is_dev=True, output=True) settings = self._get_appsettings() self.assertNotEqual(settings, {}) self.assertIn('RunTest', settings) @@ -72,7 +69,7 @@ class RunTestCase(CommandTestCase): def test_run_by_project(self): os.chdir(os.path.join(os.getcwd())) - CLICommands.run(self._source) + CLICommands.run(self._source, is_dev=True) settings = self._get_appsettings() self.assertNotEqual(settings, {}) self.assertIn('RunTest', settings) diff --git a/unittests/unittests_shared/cli_commands.py b/unittests/unittests_shared/cli_commands.py index eb0f2f1f..3d2b0442 100644 --- a/unittests/unittests_shared/cli_commands.py +++ b/unittests/unittests_shared/cli_commands.py @@ -65,11 +65,15 @@ class CLICommands: cls._run('remove', project, output=output) @classmethod - def run(cls, project: str = None, output=False): + def run(cls, project: str = None, is_dev=False, output=False): + dev = '' + if is_dev: + dev = '--dev' + if project is None: - cls._run('run', output=output) + cls._run('run', dev, output=output) return - cls._run('run', project, output=output) + cls._run('run', project, dev, output=output) @classmethod def start(cls, output=False):