reset project (#51)

acabarbaye · web-flow · commit f3ecd2671a48 · 2020-04-29T18:10:56.000+01:00
flake8 fixes
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -4,7 +4,7 @@
 A detailed description of what is being reported. Please include steps to reproduce the problem.
 
 Things to consider sharing:
-- What version of the package is being used (pip show mbed-targets)?
+- What version of the package is being used (pip show mbed-tools-ci-scripts)?
 - What is the host platform and version (e.g. macOS 10.15.2, Windows 10, Ubuntu 18.04 LTS)?
 -->
 
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -80,6 +80,12 @@ Run static analysis (note that no output means all is well):
 flake8
 ```
 
+Perform static type check:
+
+```bash
+mypy -p mbed_tools_ci_scripts
+```
+
 ## Documenting code
 
 Inclusion of docstrings is needed in all areas of the code for Flake8 
diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
 # Mbed Tools CI Scripts
 
-![Package](https://img.shields.io/badge/Package-mbed--tools--ci--scripts-lightgrey)
-[![Documentation](https://img.shields.io/badge/Documentation-GitHub_Pages-blue)](https://armmbed.github.io/mbed-tools-ci-scripts)
-[![PyPI](https://img.shields.io/pypi/v/mbed-tools-ci-scripts)](https://pypi.org/project/mbed-tools-ci-scripts/)
+![Package](https://badgen.net/badge/Package/mbed-tools-ci-scripts/grey)
+[![Documentation](https://badgen.net/badge/Documentation/GitHub%20Pages/blue?icon=github)](https://armmbed.github.io/mbed-tools-ci-scripts)
+[![PyPI](https://badgen.net/pypi/v/mbed-tools-ci-scripts)](https://pypi.org/project/mbed-tools-ci-scripts/)
 [![PyPI - Status](https://img.shields.io/pypi/status/mbed-tools-ci-scripts)](https://pypi.org/project/mbed-tools-ci-scripts/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mbed-tools-ci-scripts)](https://pypi.org/project/mbed-tools-ci-scripts/)
 
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/ARMmbed/mbed-tools-ci-scripts/blob/master/LICENSE)
+[![License](https://badgen.net/pypi/license/mbed-tools-ci-scripts)](https://github.com/ARMmbed/mbed-tools-ci-scripts/blob/master/LICENSE)
 [![Compliance](https://badgen.net/badge/License%20Report/compliant/green?icon=libraries)](https://armmbed.github.io/mbed-tools-ci-scripts/third_party_IP_report.html)
 
-[![Build Status](https://dev.azure.com/mbed-tools/mbed-tools-ci-scripts/_apis/build/status/Build%20and%20Release?branchName=master&stageName=CI%20Checkpoint)](https://dev.azure.com/mbed-tools/mbed-tools-ci/_build/latest?definitionId=3&branchName=master)
+[![Build Status](https://dev.azure.com/mbed-tools/mbed-tools-ci-scripts/_apis/build/status/Build%20and%20Release?branchName=master&stageName=CI%20Checkpoint)](https://dev.azure.com/mbed-tools/mbed-tools-ci-scripts/_build/latest?definitionId=8&branchName=master)
 [![Test Coverage](https://codecov.io/gh/ARMmbed/mbed-tools-ci-scripts/branch/master/graph/badge.svg)](https://codecov.io/gh/ARMmbed/mbed-tools-ci-scripts)
 [![Maintainability](https://api.codeclimate.com/v1/badges/41301e959f22986b7b2b/maintainability)](https://codeclimate.com/github/ARMmbed/mbed-tools-ci-scripts/maintainability)
 
diff --git a/azure-pipelines/build-release.yml b/azure-pipelines/build-release.yml
@@ -34,6 +34,11 @@ stages:
             Linux_Py_3_7:
               python.version: '3.7'
               vmImageName: ubuntu-latest
+              uploadCoverage: "false"
+
+            Linux_Py_3_8:
+              python.version: '3.8'
+              vmImageName: ubuntu-latest
               uploadCoverage: "true"
 
             Windows_Py_3_6:
@@ -46,6 +51,11 @@ stages:
               vmImageName: windows-latest
               uploadCoverage: "false"
 
+            Windows_Py_3_8:
+              python.version: '3.8'
+              vmImageName: windows-latest
+              uploadCoverage: "false"
+
             macOS_Py_3_6:
               python.version: '3.6'
               vmImageName: macOS-latest
@@ -55,6 +65,12 @@ stages:
               python.version: '3.7'
               vmImageName: macOS-latest
               uploadCoverage: "false"
+
+            macOS_Py_3_8:
+              python.version: '3.8'
+              vmImageName: macOS-latest
+              uploadCoverage: "false"
+
         pool:
           vmImage: $(vmImageName)
 
diff --git a/mbed_tools_ci_scripts/spdx_report/spdx_document.py b/mbed_tools_ci_scripts/spdx_report/spdx_document.py
@@ -74,7 +74,7 @@ def document_namespace(self) -> str:
     def _generate_namespace(self) -> str:
         """Generates a document namespace."""
         if self._is_dependency:
-            url_base = f"http://spdx.org/spdxdocs"
+            url_base = "http://spdx.org/spdxdocs"
             uuid = generate_uuid_based_on_str(self.document_name)
             return f"{url_base}/{self.document_name}-{uuid}"
         return get_project_namespace(self._project_config, self.document_name)
diff --git a/mbed_tools_ci_scripts/spdx_report/spdx_helpers.py b/mbed_tools_ci_scripts/spdx_report/spdx_helpers.py
@@ -91,7 +91,7 @@ def get_project_namespace(project_config_path: Path, document_name: str) -> str:
     """Determines the project namespace from configuration."""
     with open(str(project_config_path), "r", encoding="utf8") as f:
         config = toml.load(f).get(THIRD_PARTY_CONFIG_NAMESPACE, dict())
-    protocol = f"http://"
+    protocol = "http://"
     path_part = f'{config.get("CreatorWebsite")}/{config.get("PathToSpdx")}'
     name_part = f'{document_name}-{config.get("UUID")}'
     return f"{protocol}{path_part}/{name_part}"
diff --git a/mbed_tools_ci_scripts/tag_and_release.py b/mbed_tools_ci_scripts/tag_and_release.py
@@ -93,11 +93,11 @@ def _update_repository(mode: CommitType, is_new_version: bool, version: str, cur
     with ProjectTempClone(desired_branch_name=current_branch) as git:
         git.configure_for_github()
         time_str = datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M")
-        commit_message = f"🚀 releasing version {version} @ {time_str}" if is_new_version else f"📰 Automatic changes ⚙"
+        commit_message = f"🚀 releasing version {version} @ {time_str}" if is_new_version else "📰 Automatic changes ⚙"
         if mode == CommitType.RELEASE:
             _commit_release_changes(git, version, commit_message)
         if is_new_version:
-            logger.info(f"Tagging commit")
+            logger.info("Tagging commit")
             git.create_tag(version, message=f"release {version}")
             git.force_push_tag()
 
diff --git a/mbed_tools_ci_scripts/utils/third_party_licences.py b/mbed_tools_ci_scripts/utils/third_party_licences.py
@@ -129,8 +129,12 @@ def get_licences_from_pattern(self, licence_descriptor_pattern: Pattern) -> Opti
         self.load()
         if not self._licence_store or not self._licence_list:
             return None
-        matching_licences = [l for l in self._licence_list if licence_descriptor_pattern.match(l)]
-        return [cast(Licence, self._licence_store.get(l)) for l in matching_licences] if matching_licences else None
+        matching_licences = [licence for licence in self._licence_list if licence_descriptor_pattern.match(licence)]
+        return (
+            [cast(Licence, self._licence_store.get(licence)) for licence in matching_licences]
+            if matching_licences
+            else None
+        )
 
     def get_licence(self, licence_descriptor: Optional[str]) -> Optional[Licence]:
         """Determines the licence based on a string descriptor e.g. Apache 2."""
@@ -218,8 +222,8 @@ def determine_licences_not_in_list(licence_expression: str, licence_list: Iterat
 def determine_whether_licence_expression_is_compliant(licence_expression: str, licence_list: list) -> bool:
     """Checks whether an expression is compliant with a list of licences."""
     licensing_util = Licensing()
-    for l in licence_list:
-        if licensing_util.contains(licence_expression, l):
+    for licence in licence_list:
+        if licensing_util.contains(licence_expression, licence):
             return True
     return False
 
@@ -231,9 +235,9 @@ def _is_expression_or(licence_expression: str) -> bool:
 
 def is_licence_accepted(licence_expression: str) -> bool:
     """Determines whether the licence expressed is valid with regards to project's accepted licences."""
-    authorised_licences = [l.identifier for l in get_allowed_opensource_licences()]
+    authorised_licences = [licence.identifier for licence in get_allowed_opensource_licences()]
     is_or = _is_expression_or(licence_expression)
-    if bool([l for l in determine_licences_not_in_list(licence_expression, iter(authorised_licences))]):
+    if bool([licence for licence in determine_licences_not_in_list(licence_expression, iter(authorised_licences))]):
         return (
             determine_whether_licence_expression_is_compliant(licence_expression, authorised_licences)
             if is_or
diff --git a/news/20200429.bugfix b/news/20200429.bugfix
@@ -0,0 +1 @@
+Tested on Python 3.8.
diff --git a/news/20200429.misc b/news/20200429.misc
@@ -0,0 +1 @@
+Reset project's structure with latest template.
diff --git a/setup.py b/setup.py
@@ -32,6 +32,7 @@
         "Programming Language :: Python :: 3 :: Only",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
         "Topic :: Software Development :: Build Tools",
         "Topic :: Software Development :: Embedded Systems",
     ],
@@ -48,7 +49,7 @@
             f"generate-spdx={SOURCE_DIR}.report_third_party_ip:main",
         ],
     },
-    keywords="Arm Mbed OS MbedOS Tools CI Scripts",
+    keywords="Arm Mbed OS MbedOS Tools CI Scripts Automation",
     include_package_data=True,
     install_requires=[
         "gitpython",
diff --git a/tests/assert_news/test_news_file_validation.py b/tests/assert_news/test_news_file_validation.py
@@ -38,7 +38,7 @@ def test_raises_if_file_is_empty(self):
             with self.assertRaises(ValueError) as cm:
                 NewsFileValidator(file_path).validate_file_contents()
 
-            expected_error_message = f'Empty news file "bar.txt".'
+            expected_error_message = 'Empty news file "bar.txt".'
             self.assertEqual(str(cm.exception), expected_error_message)
 
     def test_raises_if_file_has_too_many_lines(self):
@@ -49,7 +49,7 @@ def test_raises_if_file_has_too_many_lines(self):
             with self.assertRaises(ValueError) as cm:
                 NewsFileValidator(file_path).validate_file_contents()
 
-            expected_error_message = f'News file "baz.txt" contains more than one line.'
+            expected_error_message = 'News file "baz.txt" contains more than one line.'
             self.assertEqual(str(cm.exception), expected_error_message)
 
     def test_does_nothing_if_file_has_valid_contents(self):
diff --git a/tests/licensing/test_opensource_licences.py b/tests/licensing/test_opensource_licences.py
@@ -75,7 +75,7 @@ def test_licences_parse(self):
             ],
         }
 
-        parsed_licences = [l for l in iter_licenses(licences)]
+        parsed_licences = [licence for licence in iter_licenses(licences)]
         self.assertIsNotNone(parsed_licences)
         self.assertEqual(len(parsed_licences), 2)
         self.assertIn(APACHE2_LICENCE, parsed_licences)
@@ -91,7 +91,7 @@ def test_cleanse_licence_descriptor(self):
 
     def test_get_licence(self):
         licences = OpenSourceLicences()
-        for l in [
+        for licence in [
             "Apache 2.0",
             "Apache Licence, Version 2.0",
             "The Apache License, Version 2.0",
@@ -103,7 +103,7 @@ def test_get_licence(self):
             "Apache-2",
             "Apache-2.0",
         ]:
-            self.assertEqual(APACHE2_LICENCE, licences.get_licence(l))
+            self.assertEqual(APACHE2_LICENCE, licences.get_licence(licence))
 
     def test_licences_evaluation(self):
         self.assertEqual(
@@ -125,13 +125,24 @@ def test_cleanse_licence_expression(self):
 
     def test_licences_not_in_list(self):
         self.assertEqual(
-            [l for l in determine_licences_not_in_list("Apache-2.0 AND (BSD OR MIT)", ["Apache-2.0", "MIT", "BSD"])], []
+            [
+                licence
+                for licence in determine_licences_not_in_list(
+                    "Apache-2.0 AND (BSD OR MIT)", ["Apache-2.0", "MIT", "BSD"]
+                )
+            ],
+            [],
         )
         self.assertEqual(
-            [l for l in determine_licences_not_in_list("Apache-2.0 AND (BSD OR MIT)", ["Apache-2.0", "MIT"])], ["BSD"]
+            [
+                licence
+                for licence in determine_licences_not_in_list("Apache-2.0 AND (BSD OR MIT)", ["Apache-2.0", "MIT"])
+            ],
+            ["BSD"],
         )
         self.assertEqual(
-            [l for l in determine_licences_not_in_list("Apache-2.0 AND (BSD OR MIT)", [])], ["Apache-2.0", "BSD", "MIT"]
+            [licence for licence in determine_licences_not_in_list("Apache-2.0 AND (BSD OR MIT)", [])],
+            ["Apache-2.0", "BSD", "MIT"],
         )
 
     def test_if_licence_accepted(self):
@@ -142,10 +153,12 @@ def test_if_licence_accepted(self):
 
     def test_allowed_opensource_licences_from_string(self):
         self.assertIn(APACHE2_LICENCE, determine_allowed_opensource_licences_from_string("Apache 2"))
-        self.assertEqual(len([l for l in determine_allowed_opensource_licences_from_string("Apache 2")]), 1)
-        self.assertGreater(len([l for l in determine_allowed_opensource_licences_from_string("Apache*")]), 1)
-        self.assertEqual(len([l for l in determine_allowed_opensource_licences_from_string("BSD")]), 1)
-        self.assertGreater(len([l for l in determine_allowed_opensource_licences_from_string("BSD*")]), 1)
+        self.assertEqual(len([licence for licence in determine_allowed_opensource_licences_from_string("Apache 2")]), 1)
+        self.assertGreater(
+            len([licence for licence in determine_allowed_opensource_licences_from_string("Apache*")]), 1
+        )
+        self.assertEqual(len([licence for licence in determine_allowed_opensource_licences_from_string("BSD")]), 1)
+        self.assertGreater(len([licence for licence in determine_allowed_opensource_licences_from_string("BSD*")]), 1)
 
     def test_allowed_third_party_licences(self):
         self.assertIn(APACHE2_LICENCE, get_allowed_opensource_licences())

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Reset project's structure with latest template.`