From 0516468acba7374e160f78696f999dee689f4eea Mon Sep 17 00:00:00 2001 From: Astitva Date: Sun, 31 Mar 2024 11:25:28 +0530 Subject: [PATCH] Packaging with poetry, Linting changes --- cli/README.md | 0 cli/dtaas.toml | 2 +- cli/poetry.lock | 149 ++++++++++++++++++++++++++++ cli/pyproject.toml | 22 ++++ cli/setup.py | 16 --- cli/src/cmd.py | 23 +++-- cli/src/pkg/{dtaas.py => config.py} | 54 ++++++---- cli/src/pkg/users.py | 102 +++++++++---------- cli/src/pkg/utils.py | 73 +++++++++----- 9 files changed, 313 insertions(+), 128 deletions(-) create mode 100644 cli/README.md create mode 100644 cli/poetry.lock create mode 100644 cli/pyproject.toml delete mode 100644 cli/setup.py rename cli/src/pkg/{dtaas.py => config.py} (71%) diff --git a/cli/README.md b/cli/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/cli/dtaas.toml b/cli/dtaas.toml index d1ed46ac5..b6b62484e 100644 --- a/cli/dtaas.toml +++ b/cli/dtaas.toml @@ -7,7 +7,7 @@ git-repo = "https://github.com/into-cps-association/DTaaS.git" [common] # absolute path to the DTaaS application directory -server-dns = "domain.com" +server-dns = "localhost" path = "/home/astitva/Desktop/yamlstuff" [users] diff --git a/cli/poetry.lock b/cli/poetry.lock new file mode 100644 index 000000000..5e342774f --- /dev/null +++ b/cli/poetry.lock @@ -0,0 +1,149 @@ +# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand. + +[[package]] +name = "click" +version = "8.1.7" +description = "Composable command line interface toolkit" +optional = false +python-versions = ">=3.7" +files = [ + {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"}, + {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"}, +] + +[package.dependencies] +colorama = {version = "*", markers = "platform_system == \"Windows\""} +importlib-metadata = {version = "*", markers = "python_version < \"3.8\""} + +[[package]] +name = "colorama" +version = "0.4.6" +description = "Cross-platform colored terminal text." +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" +files = [ + {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, + {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, +] + +[[package]] +name = "importlib-metadata" +version = "6.7.0" +description = "Read metadata from Python packages" +optional = false +python-versions = ">=3.7" +files = [ + {file = "importlib_metadata-6.7.0-py3-none-any.whl", hash = "sha256:cb52082e659e97afc5dac71e79de97d8681de3aa07ff18578330904a9d18e5b5"}, + {file = "importlib_metadata-6.7.0.tar.gz", hash = "sha256:1aaf550d4f73e5d6783e7acb77aec43d49da8017410afae93822cc9cca98c4d4"}, +] + +[package.dependencies] +typing-extensions = {version = ">=3.6.4", markers = "python_version < \"3.8\""} +zipp = ">=0.5" + +[package.extras] +docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] +perf = ["ipython"] +testing = ["flufl.flake8", "importlib-resources (>=1.3)", "packaging", "pyfakefs", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-mypy (>=0.9.1)", "pytest-perf (>=0.9.2)", "pytest-ruff"] + +[[package]] +name = "pyyaml" +version = "6.0.1" +description = "YAML parser and emitter for Python" +optional = false +python-versions = ">=3.6" +files = [ + {file = "PyYAML-6.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a"}, + {file = "PyYAML-6.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f"}, + {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, + {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, + {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, + {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, + {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, + {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, + {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, + {file = "PyYAML-6.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab"}, + {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, + {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, + {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, + {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, + {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, + {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, + {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, + {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, + {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, + {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, + {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, + {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, + {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd"}, + {file = "PyYAML-6.0.1-cp36-cp36m-win32.whl", hash = "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585"}, + {file = "PyYAML-6.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa"}, + {file = "PyYAML-6.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3"}, + {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27"}, + {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3"}, + {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c"}, + {file = "PyYAML-6.0.1-cp37-cp37m-win32.whl", hash = "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba"}, + {file = "PyYAML-6.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867"}, + {file = "PyYAML-6.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595"}, + {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, + {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, + {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, + {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, + {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, + {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, + {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, + {file = "PyYAML-6.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859"}, + {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, + {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, + {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, + {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, + {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, + {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, + {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, +] + +[[package]] +name = "tomlkit" +version = "0.12.4" +description = "Style preserving TOML library" +optional = false +python-versions = ">=3.7" +files = [ + {file = "tomlkit-0.12.4-py3-none-any.whl", hash = "sha256:5cd82d48a3dd89dee1f9d64420aa20ae65cfbd00668d6f094d7578a78efbb77b"}, + {file = "tomlkit-0.12.4.tar.gz", hash = "sha256:7ca1cfc12232806517a8515047ba66a19369e71edf2439d0f5824f91032b6cc3"}, +] + +[[package]] +name = "typing-extensions" +version = "4.7.1" +description = "Backported and Experimental Type Hints for Python 3.7+" +optional = false +python-versions = ">=3.7" +files = [ + {file = "typing_extensions-4.7.1-py3-none-any.whl", hash = "sha256:440d5dd3af93b060174bf433bccd69b0babc3b15b1a8dca43789fd7f61514b36"}, + {file = "typing_extensions-4.7.1.tar.gz", hash = "sha256:b75ddc264f0ba5615db7ba217daeb99701ad295353c45f9e95963337ceeeffb2"}, +] + +[[package]] +name = "zipp" +version = "3.15.0" +description = "Backport of pathlib-compatible object wrapper for zip files" +optional = false +python-versions = ">=3.7" +files = [ + {file = "zipp-3.15.0-py3-none-any.whl", hash = "sha256:48904fc76a60e542af151aded95726c1a5c34ed43ab4134b597665c86d7ad556"}, + {file = "zipp-3.15.0.tar.gz", hash = "sha256:112929ad649da941c23de50f356a2b5570c954b65150642bccdd66bf194d224b"}, +] + +[package.extras] +docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] +testing = ["big-O", "flake8 (<5)", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-flake8", "pytest-mypy (>=0.9.1)"] + +[metadata] +lock-version = "2.0" +python-versions = "^3.7" +content-hash = "d9dbae57694b550b9a0d5ffd08559ce074423b9a6a6a0539d098dbc80cfb6f9c" diff --git a/cli/pyproject.toml b/cli/pyproject.toml new file mode 100644 index 000000000..a24ffee26 --- /dev/null +++ b/cli/pyproject.toml @@ -0,0 +1,22 @@ +[tool.poetry] +name = "dtaas-cli" +version = "0.1.0" +description = "DTaaS CLI" +authors = ["Astitva Sehgal"] +license = "INTO-CPS-Association" +readme = "README.md" +packages = [{include = "src"}] + +[tool.poetry.dependencies] +python = "^3.7" +PyYAML = "^6.0.1" +click = "^8.1.7" +tomlkit = "^0.12.4" + + +[build-system] +requires = ["poetry-core"] +build-backend = "poetry.core.masonry.api" + +[tool.poetry.scripts] +dtaas = "src.cmd:dtaas" diff --git a/cli/setup.py b/cli/setup.py deleted file mode 100644 index 19dfaa81c..000000000 --- a/cli/setup.py +++ /dev/null @@ -1,16 +0,0 @@ -from setuptools import setup, find_packages - -setup( - name='src', - version='0.1.0', - packages=find_packages(), - include_package_data=True, - install_requires=[ - 'Click', - ], - entry_points={ - 'console_scripts': [ - 'dtaas = src.cmd:dtaas', - ], - }, -) \ No newline at end of file diff --git a/cli/src/cmd.py b/cli/src/cmd.py index 59622ce84..90dca1a16 100644 --- a/cli/src/cmd.py +++ b/cli/src/cmd.py @@ -1,8 +1,9 @@ +""" This file defines all cli entrypoints for dtaas""" + import click #from . import service -from .pkg import dtaas as dtaasPkg +from .pkg import config as configPkg from .pkg import users as userPkg -from .pkg import utils @@ -10,17 +11,17 @@ @click.group() def dtaas(): """all commands to help with Digital Twins as a Service""" - pass + return @dtaas.group() def admin(): "administrative commands for DTaaS" - pass + return @admin.group() def user(): """user management commands""" - pass + return #### user group commands @user.command() @@ -30,10 +31,10 @@ def add(): Specify the list in dtaas.toml [users].add\n """ - configObj = dtaasPkg.Config() + configObj = configPkg.Config() err = userPkg.addUsers(configObj) - if err!=None: + if err is not None: raise click.ClickException("Error while adding users: " + str(err)) click.echo("Users added successfully") @@ -44,9 +45,9 @@ def delete(): Specify the users in dtaas.toml [users].delete\n """ - configObj = dtaasPkg.Config() - + configObj = configPkg.Config() + err = userPkg.deleteUser(configObj) - if err!=None: + if err is not None: raise click.ClickException("Error while deleting users: " + str(err)) - click.echo("User deleted successfully") \ No newline at end of file + click.echo("User deleted successfully") diff --git a/cli/src/pkg/dtaas.py b/cli/src/pkg/config.py similarity index 71% rename from cli/src/pkg/dtaas.py rename to cli/src/pkg/config.py index 484e24bb8..2dd4d670f 100644 --- a/cli/src/pkg/dtaas.py +++ b/cli/src/pkg/config.py @@ -1,72 +1,82 @@ +"""This file supports the DTaaS config class""" + import click from . import utils class Config: - def __init__(self): + """The Config class for DTaaS""" + + def __init__(self): config, err = utils.importToml('dtaas.toml') - if err!=None: + if err is not None: raise click.ClickException("config initialisation failed: "+str(err)) self.data = config - + def getConfig(self): - if self.data!=None: + """Gets the config dictionary""" + if self.data is not None: return self.data,None return None, Exception("Config not initialised") - + def getCommon(self): + """Gets the 'common' section of config """ conf, err = self.getConfig() - if err!=None: + if err is not None: return None, err - + if 'common' not in conf: return None, Exception("Config file error: Missing 'common' tag") return conf['common'], None - + def getUsers(self): + """Gets the 'users' section of config """ conf, err = self.getConfig() - if err!=None: + if err is not None: return None, err - + if 'users' not in conf: return None, Exception("Config file error: Missing 'users' tag") return conf['users'], None - + def getPath(self): + """Gets the 'path' from config.common """ confCommon, err = self.getCommon() - if err!=None: + if err is not None: return None, err - + if 'path' not in confCommon or confCommon['path']=="": - return None, Exception("Config file error: The path for DTaaS directory isn't set in TOML") + return None, Exception("Config file error: DTaaS directory path not set in TOML") return str(confCommon['path']), None - + def getServerDNS(self): + """Gets the 'server-dns' from config.common """ confCommon, err = self.getCommon() - if err!=None: + if err is not None: return None, err - + if 'server-dns' not in confCommon and confCommon['server-dns']=="": return None, Exception("Config file error: The server dns isn't set in TOML") return str(confCommon['server-dns']), None - + def getAddUsersList(self): + """Gets the 'add' list from config.users """ confUsers, err = self.getUsers() - if err!=None: + if err is not None: return None, err if 'add' not in confUsers: return None, Exception("Config file error: No 'add' list in 'users' tag") addUsersList = [ str(username) for username in confUsers['add']] return addUsersList, None - + def getDeleteUsersList(self): + """Gets the 'delete' list from config.users """ confUsers, err = self.getUsers() - if err!=None: + if err is not None: return None, err if 'delete' not in confUsers: return None, Exception("Config file error: No 'delete' list in 'users' tag") deleteUsersList = [str(username) for username in confUsers['delete']] return deleteUsersList, None - \ No newline at end of file diff --git a/cli/src/pkg/users.py b/cli/src/pkg/users.py index 09289572d..f37f72ae1 100644 --- a/cli/src/pkg/users.py +++ b/cli/src/pkg/users.py @@ -1,117 +1,117 @@ +"""This file has functions that handle the user cli commands""" + import subprocess from . import utils -def __getComposeConfig(username, server, DTaaSDirPath): - +def getComposeConfig(username, server, path): + """Makes and returns the config for the user""" + template = {} mapping = { - "${DTAAS_DIR}": DTaaSDirPath, + "${DTAAS_DIR}": path, "${username}" : username, } - + if server==utils.LOCALHOST_SERVER: template, err = utils.importYaml('users.local.yml') - if err!=None: + if err is not None: return err else: template, err = utils.importYaml('users.server.yml') - if err!=None: + if err is not None: return err mapping["${SERVER_DNS}"] = server - - config = utils.replaceAll(template, mapping) - + + config, err = utils.replaceAll(template, mapping) + if err is not None: + return None, err + return config, None -def __addUsersToCompose(users, compose, server, path): +def addUsersToCompose(users, compose, server, path): + """Adds all the users config to the compose dictionary""" + for username in users: - config, err = __getComposeConfig(username, server, path) - if err!=None: + config, err = getComposeConfig(username, server, path) + if err is not None: return err compose['services'][username] = config return None -def __startUserContainers(users): +def startUserContainers(users): + """Starts all the user containers in the 'users' list""" cmd = ["docker compose -f compose.users.yml up -d"] for username in users: cmd.append(username) - - cmdStr = " ".join(cmd) - subprocess.run(cmdStr, shell=True) - return None + cmdStr = " ".join(cmd) + subprocess.run(cmdStr, shell=True, check=False) -def __stopUserContainers(users): +def stopUserContainers(users): + """Stops all the user containers in the 'users' list""" cmd = ["docker compose -f 'compose.users.yml' down"] for username in users: cmd.append(username) - - cmdStr = " ".join(cmd) - subprocess.run(cmdStr, shell=True) - - return None - + cmdStr = " ".join(cmd) + subprocess.run(cmdStr, shell=True, check=False) def addUsers(configObj): - + """add cli command handler""" + compose, err = utils.importYaml('compose.users.yml') - if err!=None: + if err is not None: return err userList, err = configObj.getAddUsersList() - if err!=None: + if err is not None: return err server, err= configObj.getServerDNS() - if err!=None: + if err is not None: return err path, err = configObj.getPath() - if err!=None: + if err is not None: return err if 'version' not in compose: compose['version'] = '3' if 'services' not in compose: compose['services'] = {} - - - err = __addUsersToCompose(userList, compose, server, path) - if err!=None: - return err - err = utils.exportYaml(compose, 'compose.users.yml') - if err!=None: + + err = addUsersToCompose(userList, compose, server, path) + if err is not None: return err - err = __startUserContainers(userList) - if err!=None: + err = utils.exportYaml(compose, 'compose.users.yml') + if err is not None: return err - + + startUserContainers(userList) + return None def deleteUser(configObj): + """delete cli command handler""" compose,err = utils.importYaml('compose.users.yml') - if err!=None: + if err is not None: return err userList, err = configObj.getDeleteUsersList() - if err!=None: - return err - - err = __stopUserContainers(userList) - if err!=None: + if err is not None: return err - + + stopUserContainers(userList) + for username in userList: if 'services' not in compose: - return + return None if username not in compose['services']: - return - + return None del compose['services'][username] err = utils.exportYaml(compose, 'compose.users.yml') - if err!=None: + if err is not None: return err - return None \ No newline at end of file + return None diff --git a/cli/src/pkg/utils.py b/cli/src/pkg/utils.py index c5ed36a93..daae72704 100644 --- a/cli/src/pkg/utils.py +++ b/cli/src/pkg/utils.py @@ -1,48 +1,67 @@ +"This file has generic helper functions and variables for dtaas cli" + import yaml import tomlkit LOCALHOST_SERVER = "localhost" -def importYaml(filename): - config = {} +def importYaml(filename): + """This function is used to import a yaml file safely""" + config = {} try: - with open(filename,'r') as f: - config = yaml.safe_load(f) + with open(filename,'r') as file: + config = yaml.safe_load(file) except FileNotFoundError: return {}, None - except Exception as e: - return None, Exception(f"Error while getting yaml file: {filename}, " + str(e)) - return config if config!=None else {}, None + except Exception as err: + return None, Exception(f"Error while getting yaml file: {filename}, " + str(err)) + return config if config is not None else {}, None def exportYaml(data, filename): + """This function is used to export to a yaml file safely""" try: - with open(filename, 'w') as f: - yaml.safe_dump(data, f, sort_keys=False) - except Exception as e: - return Exception(f"Error while writing yaml to file: {filename}, " + str(e)) + with open(filename, 'w') as file: + yaml.safe_dump(data, file, sort_keys=False) + except Exception as err: + return Exception(f"Error while writing yaml to file: {filename}, " + str(err)) return None def importToml(filename): + """This function is used to import a toml file safely""" try: - with open(filename, 'r') as f: - config = tomlkit.load(f) - except Exception as e: - return None, Exception(f"Error while getting toml file: {filename}, " + str(e)) + with open(filename, 'r') as file: + config = tomlkit.load(file) + except Exception as err: + return None, Exception(f"Error while getting toml file: {filename}, " + str(err)) return config, None def replaceAll(obj, mapping): - if type(obj)==str: + """This function is used to replace all placeholders with values in a nested object""" + if isinstance(obj,str): + for key in mapping: obj = obj.replace(key, mapping[key]) - return obj - if type(obj)==list: - for i in range(len(obj)): - obj[i] = replaceAll(obj[i], mapping) - return obj - if type(obj)==dict: + return obj, None + + if isinstance(obj,list): + + for ind, val in enumerate(obj): + obj[ind], err = replaceAll(val, mapping) + if err is not None: + return None, err + + return obj, None + + if isinstance(obj,dict): + for key in obj: - if type(key)!=str: - return Exception(f"Config substitution failed: Key is not a string") - obj[key]= replaceAll(obj[key], mapping) - return obj - return Exception("Config substition failed: Object format not valid") \ No newline at end of file + if not isinstance(key,str): + return None, Exception("Config substitution failed: Key is not a string") + + obj[key], err = replaceAll(obj[key], mapping) + if err is not None: + return None, err + + return obj, None + + return None, Exception("Config substition failed: Object format not valid")