Merge release/v4.2.2 into master

CHANGELOG.rst

@@ -1,6 +1,12 @@
 lib_mic_array change log
 ========================
 
+4.2.2
+-----
+
+  * CHANGED: Pin Python package versions
+  * REMOVED: not necessary cpanfile
+
 4.2.1
 -----
 

Jenkinsfile

@@ -1,5 +1,4 @@
-@Library('xmos_jenkins_shared_library@v0.10.0') _
-
+@Library('xmos_jenkins_shared_library@v0.14.2') _
 getApproval()
 
 pipeline {
@@ -27,8 +26,8 @@ pipeline {
     stage('Unit tests') {
       steps {
         dir("${REPO}/tests/unit_tests") {
-          runWaf('.')
           viewEnv() {
+            runWaf('.')
             runPytest()
           }
         }
@@ -38,7 +37,7 @@ pipeline {
       steps {
         dir("${REPO}/legacy_tests") {
           viewEnv() {
-            // Use Pipfile in legacy_tests, not lib_mic_array/Pipfile
+            // Use requirements.txt in legacy_tests, not lib_mic_array/requirements.txt
             installPipfile(true)
             runPython("./runtests.py --junit-output=${REPO}_tests.xml")
           }

legacy_tests/requirements.txt

@@ -0,0 +1,5 @@
+# python_version 2.7
+
+numpy==1.16.6
+scipy==1.2.3
+soundfile==0.10.3.post1

lib_mic_array/module_build_info

@@ -1,4 +1,4 @@
-VERSION = 4.2.1
+VERSION = 4.2.2
 
 DEPENDENT_MODULES = lib_xassert(>=4.0.0) \
                     lib_logging(>=3.0.0) \

python/setup.py

@@ -0,0 +1,30 @@
+# Copyright (c) 2020, XMOS Ltd, All rights reserved
+import setuptools
+
+# Another repository might depend on python code defined in this one.  The
+# procedure to set up a suitable python environment for that repository may
+# pip-install this one as editable using this setup.py file.  To minimise the
+# chance of version conflicts while ensuring a minimal degree of conformity,
+# the 3rd-party modules listed here require the same major version and at
+# least the same minor version as specified in the requirements.txt file.
+# The same modules should appear in the requirements.txt file as given below.
+setuptools.setup(
+    name='lib_mic_array',
+    packages=setuptools.find_packages(),
+    install_requires=[
+        "flake8~=3.8",
+        "matplotlib~=3.3",
+        "numpy~=1.18",
+        "pylint~=2.5",
+        "pytest~=6.0",
+        "pytest-xdist~=1.34",
+        "scipy~=1.4",
+        "lib_logging",
+        "lib_xassert",
+    ],
+
+    dependency_links=[
+        './../lib_logging#egg=lib_logging',
+        './../lib_xassert#egg=lib_xassert',
+    ],
+)

requirements.txt

@@ -0,0 +1,44 @@
+# python_version 3.7.6
+#
+# The parse_version_from_requirements() function in the installPipfile.groovy
+# file of the Jenkins Shared Library uses the python_version comment to set
+# the version of python used.
+
+# Distributed (released) dependencies
+#
+# The python modules listed below specify a known working combination required
+# by the python code in this repository.  The procedure used to set up a
+# suitable python environment for it installs the version of each module in
+# the list.  Using a specific version ensures a controlled infrastructure for
+# development, testing and release of this repository.
+#
+# Another repository might depend on python code defined in this one.  The
+# procedure to set up a suitable python environment for that repository may
+# pip-install this one as editable using this repository's setup.py file.  The
+# same modules should appear in the setup.py list as given below.
+flake8==3.8.3
+matplotlib==3.3.1
+
+# Pin numpy to 1.18.5 due to tensorflow v2.1.1 hard pinning it to that version.
+numpy==1.18.5
+pylint==2.5.3
+pytest==6.0.0
+pytest-xdist==1.34.0
+
+# Pin scipy to 1.4.1 due to tensorflow v2.1.1 hard pinning it to that version.
+scipy==1.4.1
+
+# Development dependencies
+#
+# Each link listed below specifies the path to a setup.py file which are
+# installed in editable mode with '-e $PATH' (without the quotes).
+#
+# If python code in this repository depends on python code under development
+# in another repository, then an entry for that other respository should
+# appear in this list instead of the released dependencies list.
+#
+# If this repository uses the setup functionality (e.g., script entry points)
+# of its own setup.py file, then this list must include an entry for that
+# setup.py file, e.g., '-e .' or '-e ./python' (without the quotes).
+-e ./../lib_logging
+-e ./../lib_xassert

tests/unit_tests/conftest.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2019, XMOS Ltd, All rights reserved
+# Copyright (c) 2018-2020, XMOS Ltd, All rights reserved
 import os.path
 import pytest
 import subprocess
@@ -10,7 +10,7 @@ def pytest_collect_file(parent, path):
     if ((path.ext == ".c" or path.ext == ".xc")
             and (path.basename.startswith("test_")
                  and "_Runner" not in path.basename)):
-        return UnityTestSource(path, parent)
+        return UnityTestSource.from_parent(parent, fspath=path)
 
 
 class UnityTestSource(pytest.File):
@@ -32,13 +32,13 @@ def collect(self):
             test_src_name + '_single_issue.xe')
         test_bin_path_si = os.path.join('bin',
                                         test_bin_name_si)
-        yield UnityTestExecutable(test_bin_path_si, self)
+        yield UnityTestExecutable.from_parent(self, name=test_bin_path_si)
 
         test_bin_name_di = os.path.join(
             test_src_name + '_dual_issue.xe')
         test_bin_path_di = os.path.join('bin',
                                         test_bin_name_di)
-        yield UnityTestExecutable(test_bin_path_di, self)
+        yield UnityTestExecutable.from_parent(self, name=test_bin_path_di)
 
 
 class UnityTestExecutable(pytest.Item):