Merge pull request #1401 from sechkova/dirs-and-names

Experimental client: renaming

Author: Jussi Kukkonen

tests/test_metadata_bundle.py

@@ -8,7 +8,7 @@
 
 from tuf import exceptions
 from tuf.api.metadata import Metadata
-from tuf.client_rework.metadata_bundle import MetadataBundle
+from tuf.ngclient._internal.metadata_bundle import MetadataBundle
 
 from tests import utils
 

tests/test_updater_rework.py renamed to tests/test_updater_ng.py

@@ -28,10 +28,10 @@
 import tuf.log
 import tuf.repository_tool as repo_tool
 import tuf.unittest_toolbox as unittest_toolbox
-import tuf.client_rework.updater_rework as updater
 
 from tests import utils
 from tuf.api import metadata
+from tuf import ngclient
 
 import securesystemslib
 
@@ -116,7 +116,7 @@ def setUp(self):
     targets_url = f"{url_prefix}/targets/"
     # Creating a repository instance.  The test cases will use this client
     # updater to refresh metadata, fetch target files, etc.
-    self.repository_updater = updater.Updater(self.client_directory,
+    self.repository_updater = ngclient.Updater(self.client_directory,
                                               metadata_url,
                                               targets_url)
 

tox.ini

@@ -16,7 +16,7 @@ changedir = tests
 commands =
     python --version
     python -m coverage run aggregate_tests.py
-    python -m coverage report -m --fail-under 90
+    python -m coverage report -m --fail-under 97 --omit "{toxinidir}/tuf/ngclient/*"
 
 deps =
     -r{toxinidir}/requirements-test.txt
@@ -42,15 +42,12 @@ commands =
 commands =
     # Use different configs for new (tuf/api/*) and legacy code
     # TODO: configure black and isort args in pyproject.toml (see #1161)
-    black --check --diff --line-length 80 {toxinidir}/tuf/api
-    black --check --diff --line-length 80 {toxinidir}/tuf/client_rework
-    isort --check --diff --line-length 80 --profile black -p tuf {toxinidir}/tuf/api
-    isort --check --diff --line-length 80 --profile black -p tuf {toxinidir}/tuf/client_rework
-    pylint {toxinidir}/tuf/api --rcfile={toxinidir}/tuf/api/pylintrc
-    pylint {toxinidir}/tuf/client_rework --rcfile={toxinidir}/tuf/api/pylintrc
+    black --check --diff --line-length 80 {toxinidir}/tuf/api {toxinidir}/tuf/ngclient
+    isort --check --diff --line-length 80 --profile black -p tuf {toxinidir}/tuf/api {toxinidir}/tuf/ngclient
+    pylint {toxinidir}/tuf/api {toxinidir}/tuf/ngclient --rcfile={toxinidir}/tuf/api/pylintrc
 
     # NOTE: Contrary to what the pylint docs suggest, ignoring full paths does
     # work, unfortunately each subdirectory has to be ignored explicitly.
-    pylint {toxinidir}/tuf --ignore={toxinidir}/tuf/api,{toxinidir}/tuf/api/serialization,{toxinidir}/tuf/client_rework
+    pylint {toxinidir}/tuf --ignore={toxinidir}/tuf/api,{toxinidir}/tuf/api/serialization,{toxinidir}/tuf/ngclient,{toxinidir}/tuf/ngclient/_internal
 
     bandit -r {toxinidir}/tuf

tuf/client_rework/README.md renamed to tuf/ngclient/README.md

@@ -0,0 +1,8 @@
+# Copyright New York University and the TUF contributors
+# SPDX-License-Identifier: MIT OR Apache-2.0
+
+"""TUF client public API
+"""
+
+from tuf.ngclient.fetcher import FetcherInterface
+from tuf.ngclient.updater import Updater

tuf/ngclient/__init__.py

@@ -15,7 +15,7 @@
 
 import tuf
 from tuf import exceptions, settings
-from tuf.client_rework.fetcher import FetcherInterface
+from tuf.ngclient.fetcher import FetcherInterface
 
 # Globals
 logger = logging.getLogger(__name__)

tuf/client_rework/__init__.py renamed to tuf/ngclient/_internal/__init__.py

@@ -18,8 +18,8 @@
 from securesystemslib import util as sslib_util
 
 from tuf import exceptions
-from tuf.client.fetcher import FetcherInterface
-from tuf.client_rework import download, metadata_bundle, requests_fetcher
+from tuf.ngclient._internal import download, metadata_bundle, requests_fetcher
+from tuf.ngclient.fetcher import FetcherInterface
 
 # Globals
 MAX_ROOT_ROTATIONS = 32