Bring python packages into the mbed-os source (#192)

* Initial import of python packages

* Move tests to subfolder, use tests in generate_configuration.cmake

* Bring python packages into the source tree instead of needing to be installed separately

* Use python3

* Just use distro default python

* Install all the requirements with apt-get

* unittests is part of Python now

* Add appdirs, set python version

* Add some missing dependencies

* Add more packages

* Add requirements.apt.txt files, fix relative paths with scancode_evaluate.py

* Fix return code handling for license scan errors

* ok let's try that again, also improve error output from scancode evaluate

* Add missing license headers

Author: Jamie Smith

.github/workflows/basic_checks.yml

@@ -25,8 +25,11 @@ jobs:
       - 
         name: install dependencies
         shell: bash
+        # TODO scancode 32.0 introduced significant breaking changes to the license
+        # detection output format: https://github.com/nexB/scancode-toolkit/releases/tag/v32.0.0
+        # Need to update Mbed's scripts for the new format.
         run: |
-          pip install -U scancode-toolkit "click>=7,<8"
+          pip install -U "scancode-toolkit<32.0" "click>=7,<8"
 
       - 
         name: license check 
@@ -43,10 +46,14 @@ jobs:
             | while read file; do cp --parents "${file}" SCANCODE; done
           ls SCANCODE
           scancode -l --json-pp scancode.json SCANCODE
-          python ./tools/test/ci/scancode-evaluate.py scancode.json || true
-          cat scancode-evaluate.log
-          COUNT=$(cat scancode-evaluate.log | grep 'File:' | grep -v 'SPDX' | wc -l) || true
-          if [ $COUNT = 0 ]; then
+          cd tools/python
+          
+          # Run the evaluation script, which may fail, and save its exit code.
+          EVALUATE_EXITCODE=0
+          python -m scancode_evaluate.scancode_evaluate ../../scancode.json || EVALUATE_EXITCODE=$?
+          
+          cat scancode_evaluate.log
+          if [ "$EVALUATE_EXITCODE" = 0 ]; then
             echo "License check OK";
             true;
           else
@@ -158,25 +165,18 @@ jobs:
         name: Checkout repo
         uses: actions/checkout@v3
 
-
-      - uses: actions/setup-python@v2
-        with:
-          python-version: '3.7'
-
       -
         name: install dependencies
         run: |
-          pip install -r tools/requirements.txt 
-          pip install -r tools/test/requirements.txt
+          xargs sudo apt-get install -y < tools/requirements.apt.txt
+          xargs sudo apt-get install -y < tools/python/python_tests/requirements.apt.txt
 
       -
-        name: pytest
+        name: Python Tests
         run: |
-          set -x
-          coverage run -a -m pytest tools/test
-          python tools/test/pylint.py
-          coverage run -a tools/project.py -S | sed -n '/^Total/p'
-          coverage html
+          cd tools/python
+          ./run_python_tests.sh
+
 
   pin-validation:
     runs-on: ubuntu-latest

.gitignore

@@ -31,7 +31,7 @@ venv/
 *.egg
 *.egg-info
 dist
-build
+/build
 eggs
 parts
 bin

tools/cmake/app.cmake

@@ -15,7 +15,7 @@ find_package(Python3 REQUIRED COMPONENTS Interpreter)
 include(CheckPythonPackage)
 
 # Check python packages
-set(PYTHON_PACKAGES_TO_CHECK intelhex prettytable future jinja2 mbed_tools)
+set(PYTHON_PACKAGES_TO_CHECK intelhex prettytable future jinja2)
 foreach(PACKAGE_NAME ${PYTHON_PACKAGES_TO_CHECK})
     string(TOUPPER ${PACKAGE_NAME} PACKAGE_NAME_UCASE) # Ucase name needed for CMake variable
     string(TOLOWER ${PACKAGE_NAME} PACKAGE_NAME_LCASE) # Lcase name needed for import statement

tools/cmake/mbed-run-greentea-test.in.cmake

@@ -18,6 +18,6 @@ message("Executing: mbedhtrun ${MBEDHTRUN_ARGS_FOR_DISPLAY}")
 
 # Note: For this command, we need to survive mbedhtrun not being on the PATH, so we import the package and call the main function using "python -c"
 execute_process(
-	COMMAND @Python3_EXECUTABLE@ -c "import mbed_host_tests.mbedhtrun; exit(mbed_host_tests.mbedhtrun.main())" ${MBEDHTRUN_ARGS}
-	WORKING_DIRECTORY "@CMAKE_CURRENT_BINARY_DIR@"
+	COMMAND @Python3_EXECUTABLE@ -m mbed_host_tests.mbedhtrun ${MBEDHTRUN_ARGS}
+	WORKING_DIRECTORY "@mbed-os_SOURCE_DIR@/tools/python"
 	COMMAND_ERROR_IS_FATAL ANY)

tools/cmake/mbed_generate_configuration.cmake

@@ -103,7 +103,7 @@ if(MBED_NEED_TO_RECONFIGURE)
 
     execute_process(
         COMMAND ${MBEDTOOLS_CONFIGURE_COMMAND}
-        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/../python
         RESULT_VARIABLE MBEDTOOLS_CONFIGURE_RESULT
         OUTPUT_VARIABLE MBEDTOOLS_CONFIGURE_OUTPUT
         ERROR_VARIABLE MBEDTOOLS_CONFIGURE_ERROR_OUTPUT

tools/cmake/mbed_target_functions.cmake

@@ -53,11 +53,11 @@ function(mbed_generate_map_file target)
         TARGET
             ${target}
         POST_BUILD
-        COMMAND ${Python3_EXECUTABLE} ${mbed-os_SOURCE_DIR}/tools/memap.py 
+        COMMAND ${Python3_EXECUTABLE} -m memap.memap
             -t ${MBED_TOOLCHAIN} ${CMAKE_CURRENT_BINARY_DIR}/${target}${CMAKE_EXECUTABLE_SUFFIX}.map 
             --depth ${MBED_MEMAP_DEPTH} 
         WORKING_DIRECTORY
-            ${CMAKE_CURRENT_BINARY_DIR}
+			${mbed-os_SOURCE_DIR}/tools/python
     )
 
     # generate json file
@@ -66,13 +66,13 @@ function(mbed_generate_map_file target)
             TARGET
                 ${target}
             POST_BUILD
-            COMMAND ${Python3_EXECUTABLE} ${mbed-os_SOURCE_DIR}/tools/memap.py 
+            COMMAND ${Python3_EXECUTABLE} -m memap.memap
             -t ${MBED_TOOLCHAIN} ${CMAKE_CURRENT_BINARY_DIR}/${target}${CMAKE_EXECUTABLE_SUFFIX}.map 
             --depth ${MBED_MEMAP_DEPTH} 
             -e json
             -o ${CMAKE_CURRENT_BINARY_DIR}/${target}${CMAKE_EXECUTABLE_SUFFIX}.memmap.json
             WORKING_DIRECTORY
-                ${CMAKE_CURRENT_BINARY_DIR}
+			    ${mbed-os_SOURCE_DIR}/tools/python
     )
     endif()
 
@@ -82,13 +82,13 @@ function(mbed_generate_map_file target)
             TARGET
                 ${target}
             POST_BUILD
-            COMMAND ${Python3_EXECUTABLE} ${mbed-os_SOURCE_DIR}/tools/memap.py 
+            COMMAND ${Python3_EXECUTABLE} -m memap.memap
             -t ${MBED_TOOLCHAIN} ${CMAKE_CURRENT_BINARY_DIR}/${target}${CMAKE_EXECUTABLE_SUFFIX}.map 
             --depth ${MBED_MEMAP_DEPTH} 
             -e html
             -o ${CMAKE_CURRENT_BINARY_DIR}/${target}${CMAKE_EXECUTABLE_SUFFIX}.memmap.html
             WORKING_DIRECTORY
-                ${CMAKE_CURRENT_BINARY_DIR}
+			    ${mbed-os_SOURCE_DIR}/tools/python
     )
     endif()
 endfunction()

tools/cmake/upload_methods/UploadMethodMBED.cmake

@@ -7,8 +7,7 @@
 set(UPLOAD_SUPPORTS_DEBUG FALSE)
 
 ### Check if upload method can be enabled on this machine
-check_python_package(mbed_os_tools HAVE_MBED_OS_TOOLS)
-set(UPLOAD_MBED_FOUND ${HAVE_MBED_OS_TOOLS})
+set(UPLOAD_MBED_FOUND ${Python3_FOUND})
 
 if(NOT DEFINED MBED_RESET_BAUDRATE)
 	set(MBED_RESET_BAUDRATE 9600)
@@ -20,11 +19,14 @@ set(MBED_TARGET_UID "" CACHE STRING "UID of mbed target to upload to if there ar
 function(gen_upload_target TARGET_NAME BIN_FILE)
 
 	add_custom_target(flash-${TARGET_NAME}
-		COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/install_bin_file.py
-		${BIN_FILE}
-		${MBED_TARGET}
-		${MBED_RESET_BAUDRATE}
-		${MBED_TARGET_UID})
+		COMMAND ${Python3_EXECUTABLE} -m install_bin_file
+			${BIN_FILE}
+			${MBED_TARGET}
+			${MBED_RESET_BAUDRATE}
+			${MBED_TARGET_UID}
+		WORKING_DIRECTORY
+			${mbed-os_SOURCE_DIR}/tools/python
+		VERBATIM)
 
 	add_dependencies(flash-${TARGET_NAME} ${TARGET_NAME})
 

tools/python/.gitignore

@@ -0,0 +1,5 @@
+# Python coverage database
+.coverage
+
+# Coverage report
+htmlcov/

tools/python/LICENSE

@@ -0,0 +1,174 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

tools/python/__init__.py

@@ -0,0 +1,4 @@
+#
+# Copyright (c) 2020-2023 Arm Limited and Contributors. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#