dsw-tdk 3.22.1__tar.gz → 3.24.0__tar.gz

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0}/CHANGELOG.md

@@ -8,6 +8,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 
+## [3.24.0]
+
+Released for version consistency with other DSW tools.
+
+## [3.23.0]
+
+### Changed
+
+- Added support for authentication using API keys
+- Added deprecated warning for username/password authentication
+
 ## [3.22.1]
 
 Released for version consistency with other DSW tools.
@@ -312,3 +323,5 @@ Initial DSW Template Development Kit (versioned as part of the [DSW platform](ht
 [3.21.0]: /../../tree/v3.21.0
 [3.22.0]: /../../tree/v3.22.0
 [3.22.1]: /../../tree/v3.22.1
+[3.23.0]: /../../tree/v3.23.0
+[3.24.0]: /../../tree/v3.24.0

{dsw-tdk-3.22.1/dsw_tdk.egg-info → dsw-tdk-3.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dsw-tdk
-Version: 3.22.1
+Version: 3.24.0
 Summary: Data Stewardship Wizard Template Development Toolkit
 Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
 License: Apache License 2.0
@@ -12,14 +12,12 @@ Classifier: Framework :: AsyncIO
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Utilities
-Requires-Python: <4,>=3.7
+Requires-Python: <4,>=3.9
 Description-Content-Type: text/markdown
 Provides-Extra: test
 License-File: LICENSE

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0}/dsw/tdk/api_client.py

@@ -91,7 +91,7 @@ class DSWAPIClient:
         """
         self.api_url = api_url
         self.token = None
-        self.session = session or aiohttp.ClientSession(connector=aiohttp.TCPConnector(verify_ssl=False))
+        self.session = session or aiohttp.ClientSession(connector=aiohttp.TCPConnector(ssl=False))
 
     @property
     def templates_endpoint(self):
@@ -142,6 +142,10 @@ class DSWAPIClient:
         self.token = body.get('token', None)
         return self.token
 
+    @handle_client_errors
+    async def get_current_user(self) -> dict:
+        return await self._get_json('/users/current')
+
     @handle_client_errors
     async def check_template_exists(self, remote_id: str) -> bool:
         async with self.session.get(f'{self.templates_endpoint}/{remote_id}', headers=self._headers()) as r:

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0}/dsw/tdk/build_info.py

@@ -9,9 +9,9 @@ BuildInfo = namedtuple(
 )
 
 BUILD_INFO = BuildInfo(
-    version='v3.22.1~f58badd',
-    built_at='2023-04-14 12:55:45Z',
-    sha='f58badda4c93b654651aedd46e082f1d756eb2aa',
+    version='v3.24.0~de1a777',
+    built_at='2023-05-31 09:42:09Z',
+    sha='de1a777fb9287f666e161e98200054ae757fa44c',
     branch='HEAD',
-    tag='v3.22.1',
+    tag='v3.24.0',
 )

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0}/dsw/tdk/cli.py

@@ -1,4 +1,6 @@
 import asyncio
+import sys
+
 import click  # type: ignore
 import datetime
 import dotenv
@@ -39,6 +41,11 @@ class ClickPrinter:
     def error(message: str, **kwargs):
         click.secho(message=message, err=True, fg='red', **kwargs)
 
+    @staticmethod
+    def warning(message: str, **kwargs):
+        click.secho('WARNING', fg='yellow', bold=True, nl=False)
+        click.echo(f': {message}')
+
     @staticmethod
     def success(message: str):
         click.secho('SUCCESS', fg='green', bold=True, nl=False)
@@ -171,6 +178,37 @@ class CLIContext:
         self.logger.muted = True
 
 
+class APICredentials:
+
+    def __init__(self, username, password, api_key):
+        self.username = username
+        self.password = password
+        self.api_key = api_key
+
+    def check(self):
+        if self.api_key is not None:
+            return
+        if self.username is not None and self.password is not None:
+            ClickPrinter.warning('Using username/password credentials, '
+                                 'consider switching to API keys.')
+            ClickPrinter.warning('Username/password authentication will be '
+                                 'removed in 3.25 as deprecated.')
+            return False
+        ClickPrinter.failure('Invalid credentials entered! You need to provide '
+                             'either API key or username/password credentials.')
+        sys.exit(1)
+
+    def init_args(self):
+        if self.api_key is not None:
+            return {
+                'api_key': self.api_key,
+            }
+        return {
+            'username': self.username,
+            'password': self.password,
+        }
+
+
 def interact_formats() -> Dict[str, FormatSpec]:
     add_format = click.confirm('Do you want to add a format?', default=True)
     formats = dict()  # type: Dict[str, FormatSpec]
@@ -270,21 +308,25 @@ def new_template(ctx, template_dir, force):
 @click.argument('TEMPLATE-DIR', type=NEW_DIR_TYPE, default=None, required=False)
 @click.option('-s', '--api-server', metavar='API-URL', envvar='DSW_API',
               prompt='URL of DSW API', help='URL of DSW server API.', callback=rectify_url)
-@click.option('-u', '--username', envvar='DSW_USERNAME', prompt='Username', hide_input=False,
-              metavar='EMAIL', help='Admin username (email) for DSW instance.')
-@click.option('-p', '--password', envvar='DSW_PASSWORD', prompt='Email', hide_input=True,
-              metavar='PASSWORD', help='Admin password for DSW instance.')
+@click.option('-u', '--username', envvar='DSW_USERNAME', metavar='EMAIL', default=None,
+              help='Admin username (email) for DSW instance.')
+@click.option('-p', '--password', envvar='DSW_PASSWORD', metavar='PASSWORD', default=None,
+              help='Admin password for DSW instance.')
+@click.option('-k', '--api-key', envvar='DSW_API_KEY', metavar='API-KEY', default=None,
+              help='API key for DSW instance.')
 @click.option('-f', '--force', is_flag=True, help='Overwrite any existing files.')
 @click.pass_context
-def get_template(ctx, api_server, template_id, template_dir, username, password, force):
-    template_dir = template_dir or dir_from_id(template_id)
+def get_template(ctx, api_server, template_id, template_dir, username, password, api_key, force):
+    template_dir = pathlib.Path(template_dir or dir_from_id(template_id))
+    creds = APICredentials(username=username, password=password, api_key=api_key)
+    creds.check()
 
     async def main_routine():
         tdk = TDKCore(logger=ctx.obj.logger)
         template_type = 'unknown'
         zip_data = None
         try:
-            await tdk.init_client(api_url=api_server, username=username, password=password)
+            await tdk.init_client(api_url=api_server, **creds.init_args())
             try:
                 await tdk.load_remote(template_id=template_id)
                 template_type = 'draft'
@@ -295,6 +337,7 @@ def get_template(ctx, api_server, template_id, template_dir, username, password,
         except DSWCommunicationError as e:
             ClickPrinter.error('Could not get template:', bold=True)
             ClickPrinter.error(f'> {e.reason}\n> {e.message}')
+            await tdk.safe_client.close()
             exit(1)
         await tdk.safe_client.safe_close()
         if template_type == 'draft':
@@ -305,6 +348,7 @@ def get_template(ctx, api_server, template_id, template_dir, username, password,
             except Exception as e:
                 ClickPrinter.failure('Could not store template locally')
                 ClickPrinter.error(f'> {e}')
+                await tdk.safe_client.close()
                 exit(1)
         elif template_type == 'bundle' and zip_data is not None:
             try:
@@ -313,6 +357,7 @@ def get_template(ctx, api_server, template_id, template_dir, username, password,
             except Exception as e:
                 ClickPrinter.failure('Could not store template locally')
                 ClickPrinter.error(f'> {e}')
+                await tdk.safe_client.close()
                 exit(1)
         else:
             ClickPrinter.failure(f'{template_id} is not released nor draft of a document template')
@@ -326,15 +371,19 @@ def get_template(ctx, api_server, template_id, template_dir, username, password,
 @click.argument('TEMPLATE-DIR', type=DIR_TYPE, default=CURRENT_DIR, required=False)
 @click.option('-s', '--api-server', metavar='API-URL', envvar='DSW_API',
               prompt='URL of DSW API', help='URL of DSW server API.', callback=rectify_url)
-@click.option('-u', '--username', envvar='DSW_USERNAME', prompt='Username', hide_input=False,
-              metavar='USERNAME', help='Admin username (email address) for DSW instance.')
-@click.option('-p', '--password', envvar='DSW_PASSWORD', prompt='Password', hide_input=True,
-              metavar='PASSWORD', help='Admin password for DSW instance.')
+@click.option('-u', '--username', envvar='DSW_USERNAME', metavar='EMAIL', default=None,
+              help='Admin username (email) for DSW instance.')
+@click.option('-p', '--password', envvar='DSW_PASSWORD', metavar='PASSWORD', default=None,
+              help='Admin password for DSW instance.')
+@click.option('-k', '--api-key', envvar='DSW_API_KEY', metavar='API-KEY', default=None,
+              help='API key for DSW instance.')
 @click.option('-f', '--force', is_flag=True, help='Delete template if already exists.')
 @click.option('-w', '--watch', is_flag=True, help='Enter watch mode to continually upload changes.')
 @click.pass_context
-def put_template(ctx, api_server, template_dir, username, password, force, watch):
+def put_template(ctx, api_server, template_dir, username, password, api_key, force, watch):
     tdk = TDKCore(logger=ctx.obj.logger)
+    creds = APICredentials(username=username, password=password, api_key=api_key)
+    creds.check()
 
     async def watch_callback(changes):
         changes = list(changes)
@@ -350,7 +399,7 @@ def put_template(ctx, api_server, template_dir, username, password, force, watch
     async def main_routine():
         load_local(tdk, template_dir)
         try:
-            await tdk.init_client(api_server, username, password)
+            await tdk.init_client(api_url=api_server, **creds.init_args())
             await tdk.store_remote(force=force)
             ClickPrinter.success(f'Template {tdk.safe_project.safe_template.id} '
                                  f'uploaded to {api_server}')
@@ -409,7 +458,7 @@ def extract_package(ctx, template_package, output, force: bool):
         data = pathlib.Path(template_package).read_bytes()
         tdk.extract_package(
             zip_data=data,
-            template_dir=output,
+            template_dir=pathlib.Path(output),
             force=force,
         )
     except Exception as e:
@@ -422,21 +471,26 @@ def extract_package(ctx, template_package, output, force: bool):
 @main.command(help='List templates from DSW via API.', name='list')
 @click.option('-s', '--api-server', metavar='API-URL', envvar='DSW_API',
               prompt='URL of DSW API', help='URL of DSW server API.', callback=rectify_url)
-@click.option('-u', '--username', envvar='DSW_USERNAME', prompt='Username', hide_input=False,
-              metavar='USERNAME', help='Admin username (email address) for DSW instance.')
-@click.option('-p', '--password', envvar='DSW_PASSWORD', prompt='Password', hide_input=True,
-              metavar='PASSWORD', help='Admin password for DSW instance.')
+@click.option('-u', '--username', envvar='DSW_USERNAME', metavar='EMAIL', default=None,
+              help='Admin username (email) for DSW instance.')
+@click.option('-p', '--password', envvar='DSW_PASSWORD', metavar='PASSWORD', default=None,
+              help='Admin password for DSW instance.')
+@click.option('-k', '--api-key', envvar='DSW_API_KEY', metavar='API-KEY', default=None,
+              help='API key for DSW instance.')
 @click.option('--output-format', default=DEFAULT_LIST_FORMAT,
               metavar='FORMAT', help='Entry format string for printing.')
 @click.option('-r', '--released-only', is_flag=True, help='List only released templates')
 @click.option('-d', '--drafts-only', is_flag=True, help='List only template drafts')
 @click.pass_context
-def list_templates(ctx, api_server, username, password, output_format: str,
+def list_templates(ctx, api_server, username, password, api_key, output_format: str,
                    released_only: bool, drafts_only: bool):
+    creds = APICredentials(username=username, password=password, api_key=api_key)
+    creds.check()
+
     async def main_routine():
         tdk = TDKCore(logger=ctx.obj.logger)
         try:
-            await tdk.init_client(api_server, username, password)
+            await tdk.init_client(api_url=api_server, **creds.init_args())
             if released_only:
                 templates = await tdk.list_remote_templates()
                 for template in templates:
@@ -454,12 +508,13 @@ def list_templates(ctx, api_server, username, password, output_format: str,
                 drafts = await tdk.list_remote_drafts()
                 for template in drafts:
                     click.echo(output_format.format(template=template))
+            await tdk.safe_client.safe_close()
 
         except DSWCommunicationError as e:
             ClickPrinter.failure('Failed to get list of templates')
             ClickPrinter.error(f'> {e.reason}\n> {e.message}')
+            await tdk.safe_client.safe_close()
             exit(1)
-        await tdk.safe_client.safe_close()
 
     loop = asyncio.get_event_loop()
     loop.run_until_complete(main_routine())

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0}/dsw/tdk/consts.py

@@ -3,7 +3,7 @@ import pathspec  # type: ignore
 import re
 
 APP = 'dsw-tdk'
-VERSION = '3.22.0'
+VERSION = '3.24.0'
 METAMODEL_VERSION = 11
 
 REGEX_SEMVER = re.compile(r'^[0-9]+\.[0-9]+\.[0-9]+$')

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0}/dsw/tdk/core.py

@@ -99,12 +99,18 @@ class TDKCore:
             raise RuntimeError('No DSW API client specified')
         return self.client
 
-    async def init_client(self, api_url: str, username: str, password: str):
+    async def init_client(self, api_url: str, username: Optional[str] = None,
+                          password: Optional[str] = None, api_key: Optional[str] = None):
         self.logger.info(f'Connecting to {api_url}')
         self.client = DSWAPIClient(api_url=api_url)
-        await self.client.login(email=username, password=password)
+        if api_key is not None:
+            self.client.token = api_key  # type: ignore
+        if username is not None and password is not None:
+            await self.client.login(email=username, password=password)
         self.remote_version = await self.client.get_api_version()
-        self.logger.info(f'Successfully authenticated as {username}')
+        user = await self.client.get_current_user()
+        self.logger.info(f'Successfully authenticated as {user["firstName"]} '
+                         f'{user["lastName"]} ({user["email"]})')
         self.logger.debug(f'Connected to API version {self.remote_version}')
 
     def prepare_local(self, template_dir):

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0}/dsw/tdk/validation.py

@@ -63,7 +63,7 @@ def _validate_version(field_name: str, value) -> List[ValidationError]:
 
 def _validate_natural(field_name: str, value) -> List[ValidationError]:
     if value is not None and (not isinstance(value, int) or value < 1):
-        return [ValidationError(field_name, 'Field {field_name} must be positive integer')]
+        return [ValidationError(field_name, 'It must be positive integer')]
     return []
 
 
@@ -173,9 +173,7 @@ def _validate_steps(field_name: str, value: List[Step]) -> List[ValidationError]
 FormatValidator = GenericValidator({
     'uuid': [_validate_required, _validate_non_empty],
     'name': [_validate_required, _validate_non_empty],
-    'short_name': [_validate_required, _validate_non_empty],
     'icon': [_validate_required, _validate_non_empty],
-    'color': [_validate_required, _validate_non_empty],
     'steps': [_validate_required, _validate_steps],
 })
 
@@ -198,7 +196,6 @@ TemplateValidator = GenericValidator({
     'name': [_validate_required, _validate_non_empty],
     'description': [_validate_required, _validate_non_empty],
     'readme': [_validate_required, _validate_non_empty],
-    'recommended_package_id': [_validate_package_id],
     'license': [_validate_required, _validate_non_empty],
     'metamodel_version': [_validate_natural],
     'allowed_packages': [_validate_package_filters],

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0/dsw_tdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dsw-tdk
-Version: 3.22.1
+Version: 3.24.0
 Summary: Data Stewardship Wizard Template Development Toolkit
 Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
 License: Apache License 2.0
@@ -12,14 +12,12 @@ Classifier: Framework :: AsyncIO
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Utilities
-Requires-Python: <4,>=3.7
+Requires-Python: <4,>=3.9
 Description-Content-Type: text/markdown
 Provides-Extra: test
 License-File: LICENSE

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0}/dsw_tdk.egg-info/SOURCES.txt

@@ -23,4 +23,11 @@ dsw_tdk.egg-info/entry_points.txt
 dsw_tdk.egg-info/not-zip-safe
 dsw_tdk.egg-info/requires.txt
 dsw_tdk.egg-info/top_level.txt
-tests/test_basic.py
+tests/test_basic.py
+tests/test_cmd_get.py
+tests/test_cmd_list.py
+tests/test_cmd_new.py
+tests/test_cmd_package.py
+tests/test_cmd_put.py
+tests/test_cmd_unpackage.py
+tests/test_cmd_verify.py

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = 'dsw-tdk'
-version = "3.22.1"
+version = "3.24.0"
 description = 'Data Stewardship Wizard Template Development Toolkit'
 readme = 'README.md'
 keywords = ['documents', 'dsw', 'jinja2', 'template', 'toolkit']
@@ -17,15 +17,13 @@ classifiers = [
     'Development Status :: 5 - Production/Stable',
     'License :: OSI Approved :: Apache Software License',
     'Programming Language :: Python',
-    'Programming Language :: Python :: 3.7',
-    'Programming Language :: Python :: 3.8',
     'Programming Language :: Python :: 3.9',
     'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
     'Topic :: Internet :: WWW/HTTP',
     'Topic :: Utilities',
 ]
-requires-python = '>=3.7, <4'
+requires-python = '>=3.9, <4'
 dependencies = [
     'aiohttp',
     'click',

{dsw-tdk-3.22.1 → dsw-tdk-3.24.0}/tests/test_basic.py

@@ -1,6 +1,7 @@
 import pytest
 
 from click.testing import CliRunner
+
 from dsw.tdk import main
 
 
@@ -17,7 +18,7 @@ def test_base_help_works():
 
 
 @pytest.mark.parametrize(
-    'cmd', ['new', 'list', 'get', 'put', 'verify', 'package']
+    'cmd', ['new', 'list', 'get', 'put', 'verify', 'package', 'unpackage']
 )
 def test_command_help_works(cmd):
     runner = CliRunner()

dsw-tdk-3.24.0/tests/test_cmd_get.py

@@ -0,0 +1,76 @@
+import pathlib
+
+import pytest
+import click.testing
+
+from dsw.tdk import main
+
+
+@pytest.mark.vcr
+def test_get_released(tmp_path: pathlib.Path, dsw_env: dict):
+    runner = click.testing.CliRunner()
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        template_dir = root_dir / 'dsw_questionnaire-report_2.8.0'
+        result = runner.invoke(main, args=['get', 'dsw:questionnaire-report:2.8.0'], env=dsw_env)
+        assert result.exit_code == 0
+        assert (template_dir / 'template.json').exists()
+        assert (template_dir / 'README.md').exists()
+
+
+@pytest.mark.vcr
+def test_get_draft(tmp_path: pathlib.Path, dsw_env: dict):
+    runner = click.testing.CliRunner()
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        template_dir = root_dir / 'myorg_questionnaire-report_2.9.0'
+        result = runner.invoke(main, args=['get', 'myorg:questionnaire-report:2.9.0'], env=dsw_env)
+        assert result.exit_code == 0
+        assert (template_dir / 'template.json').exists()
+        assert (template_dir / 'README.md').exists()
+
+
+@pytest.mark.vcr
+def test_get_released_custom_dir(tmp_path: pathlib.Path, dsw_env: dict):
+    runner = click.testing.CliRunner()
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        template_dir = root_dir / 'foo'
+        result = runner.invoke(main, args=['get', 'dsw:questionnaire-report:2.8.0', 'foo'], env=dsw_env)
+        assert result.exit_code == 0
+        assert (template_dir / 'template.json').exists()
+        assert (template_dir / 'README.md').exists()
+
+
+@pytest.mark.vcr
+def test_get_draft_custom_dir(tmp_path: pathlib.Path, dsw_env: dict):
+    runner = click.testing.CliRunner()
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        template_dir = root_dir / 'foo'
+        result = runner.invoke(main, args=['get', 'myorg:questionnaire-report:2.9.0', 'foo'], env=dsw_env)
+        assert result.exit_code == 0
+        assert (template_dir / 'template.json').exists()
+        assert (template_dir / 'README.md').exists()
+
+
+@pytest.mark.vcr
+def test_put_bad_token(dsw_api_url: str):
+    env_vars = {
+        'DSW_API': dsw_api_url,
+        'DSW_API_KEY': 'foo',
+    }
+    runner = click.testing.CliRunner()
+    result = runner.invoke(main, args=['list'], env=env_vars)
+    assert result.exit_code == 1
+
+
+@pytest.mark.vcr
+def test_put_bad_url(dsw_api_key: str):
+    env_vars = {
+        'DSW_API': 'http://localhost:33333',
+        'DSW_API_KEY': dsw_api_key,
+    }
+    runner = click.testing.CliRunner()
+    result = runner.invoke(main, args=['list'], env=env_vars)
+    assert result.exit_code == 1

dsw-tdk-3.24.0/tests/test_cmd_list.py

@@ -0,0 +1,53 @@
+import pytest
+import click.testing
+
+from dsw.tdk import main
+
+
+@pytest.mark.vcr
+def test_list_simple(dsw_env: dict):
+    runner = click.testing.CliRunner()
+    result = runner.invoke(main, args=['list'], env=dsw_env)
+    assert result.exit_code == 0
+    assert 'dsw:questionnaire-report:2.8.0' in result.output
+    assert 'myorg:questionnaire-report:2.9.0' in result.output
+
+
+@pytest.mark.vcr
+def test_list_drafts_only(dsw_env: dict):
+    runner = click.testing.CliRunner()
+    result = runner.invoke(main, args=['list', '-d'], env=dsw_env)
+    assert result.exit_code == 0
+    assert 'dsw:questionnaire-report:2.8.0' not in result.output
+    assert 'myorg:questionnaire-report:2.9.0' in result.output
+
+
+@pytest.mark.vcr
+def test_list_released_only(dsw_env: dict):
+    runner = click.testing.CliRunner()
+    result = runner.invoke(main, args=['list', '-r'], env=dsw_env)
+    assert result.exit_code == 0
+    assert 'dsw:questionnaire-report:2.8.0' in result.output
+    assert 'myorg:questionnaire-report:2.9.0' not in result.output
+
+
+@pytest.mark.vcr
+def test_put_bad_token(dsw_api_url: str):
+    env_vars = {
+        'DSW_API': dsw_api_url,
+        'DSW_API_KEY': 'foo',
+    }
+    runner = click.testing.CliRunner()
+    result = runner.invoke(main, args=['list'], env=env_vars)
+    assert result.exit_code == 1
+
+
+@pytest.mark.vcr
+def test_put_bad_url(dsw_api_key: str):
+    env_vars = {
+        'DSW_API': 'http://localhost:33333',
+        'DSW_API_KEY': dsw_api_key,
+    }
+    runner = click.testing.CliRunner()
+    result = runner.invoke(main, args=['list'], env=env_vars)
+    assert result.exit_code == 1

dsw-tdk-3.24.0/tests/test_cmd_new.py

@@ -0,0 +1,75 @@
+import pathlib
+
+import click.testing
+
+from dsw.tdk import main
+
+
+def test_new_no_dir(tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    inputs = ['Test template', 'dsw', 'test-template', '0.1.0', 'some description', 'CC0',
+              'y', 'HTML', 'html', 'text/html', 'src/template.html.j2', 'n']
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        result = runner.invoke(main, args=['new'], input='\n'.join(inputs))
+        assert not result.exception
+        assert result.exit_code == 0
+        paths = frozenset(map(lambda x: str(x.relative_to(isolated_dir).as_posix()), tmp_path.rglob('*')))
+        assert 'dsw_test-template_0.1.0/template.json' in paths
+        assert 'dsw_test-template_0.1.0/README.md' in paths
+        assert 'dsw_test-template_0.1.0/src' in paths
+        assert 'dsw_test-template_0.1.0/src/template.html.j2' in paths
+
+
+def test_new_dir(tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    inputs = ['Test template', 'dsw', 'test-template', '0.1.0', 'some description', 'CC0',
+              'y', 'HTML', 'html', 'text/html', 'src/template.html.j2', 'n']
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        result = runner.invoke(main, args=['new', 'my-template'], input='\n'.join(inputs))
+        assert not result.exception
+        assert result.exit_code == 0
+        paths = frozenset(map(lambda x: str(x.relative_to(isolated_dir).as_posix()), tmp_path.rglob('*')))
+        assert 'my-template/template.json' in paths
+        assert 'my-template/README.md' in paths
+        assert 'my-template/src' in paths
+        assert 'my-template/src/template.html.j2' in paths
+
+
+def test_new_without_force(tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    inputs = ['Test template', 'dsw', 'test-template', '0.1.0', 'some description', 'CC0',
+              'y', 'HTML', 'html', 'text/html', 'src/template.html.j2', 'n']
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        template_json = root_dir / 'template.json'
+        template_json.write_text('foo', encoding='utf-8')
+
+        result = runner.invoke(main, args=['new', '.'], input='\n'.join(inputs))
+        assert not result.exception
+        assert result.exit_code == 0
+        paths = frozenset(map(lambda x: str(x.relative_to(isolated_dir).as_posix()), tmp_path.rglob('*')))
+        assert 'template.json' in paths
+        assert 'README.md' in paths
+        assert 'src' in paths
+        assert 'src/template.html.j2' in paths
+        assert template_json.read_text(encoding='utf-8') == 'foo'
+
+
+def test_new_with_force(tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    inputs = ['Test template', 'dsw', 'test-template', '0.1.0', 'some description', 'CC0',
+              'y', 'HTML', 'html', 'text/html', 'src/template.html.j2', 'n']
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        template_json = root_dir / 'template.json'
+        template_json.write_text('foo', encoding='utf-8')
+
+        result = runner.invoke(main, args=['new', '--force', '.'], input='\n'.join(inputs))
+        assert not result.exception
+        assert result.exit_code == 0
+        paths = frozenset(map(lambda x: str(x.relative_to(isolated_dir).as_posix()), tmp_path.rglob('*')))
+        assert 'template.json' in paths
+        assert 'README.md' in paths
+        assert 'src' in paths
+        assert 'src/template.html.j2' in paths
+        assert template_json.read_text(encoding='utf-8') != 'foo'

dsw-tdk-3.24.0/tests/test_cmd_package.py

@@ -0,0 +1,57 @@
+import pathlib
+
+import click.testing
+
+from dsw.tdk import main
+
+
+def test_package_ok(fixtures_path: pathlib.Path, tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_example01'
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        zip_file = root_dir / 'my-template.zip'
+
+        result = runner.invoke(main, args=['package', template_path.as_posix(), '-o', 'my-template.zip'])
+        assert result.exit_code == 0
+        assert zip_file.exists() and zip_file.is_file()
+
+
+def test_package_without_force(fixtures_path: pathlib.Path, tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_example01'
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        zip_file = root_dir / 'my-template.zip'
+        zip_file.write_bytes(b'foo')
+
+        result = runner.invoke(main, args=['package', template_path.as_posix(), '-o', 'my-template.zip'])
+        assert result.exit_code == 1
+        assert zip_file.exists() and zip_file.is_file()
+        assert zip_file.read_bytes() == b'foo'
+
+
+def test_package_with_force(fixtures_path: pathlib.Path, tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_example01'
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        zip_file = root_dir / 'my-template.zip'
+        zip_file.write_bytes(b'foo')
+
+        result = runner.invoke(main, args=['package', template_path.as_posix(), '-o', 'my-template.zip', '-f'])
+        assert result.exit_code == 0
+        assert zip_file.exists() and zip_file.is_file()
+        assert zip_file.read_bytes() != b'foo'
+
+
+def test_package_faulty01(fixtures_path: pathlib.Path, tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_faulty01'
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        zip_file = root_dir / 'my-template.zip'
+
+        result = runner.invoke(main, args=['package', template_path.as_posix(), '-o', 'my-template.zip'])
+        assert result.exit_code == 1
+        assert not zip_file.exists()

dsw-tdk-3.24.0/tests/test_cmd_put.py

@@ -0,0 +1,54 @@
+import pathlib
+
+import click.testing
+import pytest
+
+from dsw.tdk import main
+
+
+@pytest.mark.vcr
+def test_put_ok(fixtures_path: pathlib.Path, dsw_env: dict):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_example01'
+    result = runner.invoke(main, args=['put', template_path.as_posix()], env=dsw_env)
+    assert result.exit_code == 0
+
+
+@pytest.mark.vcr
+def test_put_faulty(fixtures_path: pathlib.Path, dsw_env: dict):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_faulty01'
+    result = runner.invoke(main, args=['put', template_path.as_posix()], env=dsw_env)
+    assert result.exit_code == 1
+
+
+@pytest.mark.vcr
+def test_put_published(fixtures_path: pathlib.Path, dsw_env: dict):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_example02'
+    result = runner.invoke(main, args=['put', template_path.as_posix()], env=dsw_env)
+    assert result.exit_code == 1
+
+
+@pytest.mark.vcr
+def test_put_bad_token(fixtures_path: pathlib.Path, dsw_api_url: str):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_example01'
+    env_vars = {
+        'DSW_API': dsw_api_url,
+        'DSW_API_KEY': 'foo',
+    }
+    result = runner.invoke(main, args=['put', template_path.as_posix()], env=env_vars)
+    assert result.exit_code == 1
+
+
+@pytest.mark.vcr
+def test_put_bad_url(fixtures_path: pathlib.Path, dsw_api_key: str):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_example01'
+    env_vars = {
+        'DSW_API': 'http://localhost:33333',
+        'DSW_API_KEY': dsw_api_key,
+    }
+    result = runner.invoke(main, args=['put', template_path.as_posix()], env=env_vars)
+    assert result.exit_code == 1

dsw-tdk-3.24.0/tests/test_cmd_unpackage.py

@@ -0,0 +1,57 @@
+import pathlib
+
+import click.testing
+
+from dsw.tdk import main
+
+
+def test_unpackage_ok(fixtures_path: pathlib.Path, tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    zip_file = fixtures_path / 'my-template.zip'
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        template_dir = root_dir / 'extracted'
+
+        result = runner.invoke(main, args=['unpackage', zip_file.as_posix(), '-o', template_dir.as_posix()])
+        assert result.exit_code == 0
+        assert (template_dir / 'template.json').exists()
+        assert (template_dir / 'README.md').exists()
+
+
+def test_unpackage_without_force(fixtures_path: pathlib.Path, tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    zip_file = fixtures_path / 'my-template.zip'
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        template_dir = root_dir / 'extracted'
+        template_dir.mkdir()
+
+        result = runner.invoke(main, args=['unpackage', zip_file.as_posix(), '-o', template_dir.as_posix()])
+        assert result.exit_code == 1
+        assert not (template_dir / 'template.json').exists()
+        assert not (template_dir / 'README.md').exists()
+
+
+def test_unpackage_with_force(fixtures_path: pathlib.Path, tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    zip_file = fixtures_path / 'my-template.zip'
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        template_dir = root_dir / 'extracted'
+        template_dir.mkdir()
+
+        result = runner.invoke(main, args=['unpackage', zip_file.as_posix(), '-f', '-o', template_dir.as_posix()])
+        assert result.exit_code == 0
+        assert (template_dir / 'template.json').exists()
+        assert (template_dir / 'README.md').exists()
+
+
+def test_unpackage_with_faulty(fixtures_path: pathlib.Path, tmp_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    zip_file = fixtures_path / 'my-template-faulty.zip'
+    with runner.isolated_filesystem(temp_dir=tmp_path) as isolated_dir:
+        root_dir = pathlib.Path(isolated_dir)
+        template_dir = root_dir / 'extracted'
+
+        result = runner.invoke(main, args=['unpackage', zip_file.as_posix(), '-o', template_dir.as_posix()])
+        assert result.exit_code == 1

dsw-tdk-3.24.0/tests/test_cmd_verify.py

@@ -0,0 +1,46 @@
+import pathlib
+
+import click.testing
+
+from dsw.tdk import main
+
+
+def test_verify_ok(fixtures_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_example01'
+    result = runner.invoke(main, args=['verify', template_path.as_posix()])
+    assert result.exit_code == 0
+    assert 'The template is valid!' in result.output
+    assert 'Test template 01' in result.output
+
+
+def test_verify_missing_attrs(fixtures_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_faulty01'
+    result = runner.invoke(main, args=['verify', template_path.as_posix()])
+    assert result.exit_code == 1
+    assert 'Could not load local template' in result.output
+    assert 'Unable to load template using' in result.output
+
+
+def test_verify_no_readme(fixtures_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_faulty02'
+    result = runner.invoke(main, args=['verify', template_path.as_posix()])
+    assert result.exit_code == 1
+    assert 'Could not load local template' in result.output
+    assert 'README file "README.md" cannot be loaded' in result.output
+
+
+def test_verify_invalid(fixtures_path: pathlib.Path):
+    runner = click.testing.CliRunner()
+    template_path = fixtures_path / 'test_faulty03'
+    result = runner.invoke(main, args=['verify', template_path.as_posix()])
+    assert result.exit_code == 0
+    assert 'The template is invalid!' in result.output
+    assert 'template_id: Template ID may contain only letters, numbers, and dash' in result.output
+    assert 'organization_id: Organization ID may contain only letters, numbers, and period' in result.output
+    assert 'version: Version must be in semver format' in result.output
+    assert 'name: Missing but it is required' in result.output
+    assert 'description: Missing but it is required' in result.output
+    assert 'metamodel_version: It must be positive integer' in result.output