[Patch V2] BaseTools: Add python3-distutils Ubuntu package checking

[Patch V2] BaseTools: Add python3-distutils Ubuntu package checking

[Feng, Bob C]

https://bugzilla.tianocore.org/show_bug.cgi?id=1509
V2:
Remove OS/Package specific words. Print the error info which
is from python error message.

Add python3-distutils Ubuntu package checking.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
---
 BaseTools/Tests/RunTests.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/BaseTools/Tests/RunTests.py b/BaseTools/Tests/RunTests.py
index 0dd65632d0..f6d3f43653 100644
--- a/BaseTools/Tests/RunTests.py
+++ b/BaseTools/Tests/RunTests.py
@@ -17,10 +17,22 @@
 #
 import os
 import sys
 import unittest
 
+distutils_exist = True
+try:
+    import distutils.util
+except:
+    distutils_exist = False
+
+if not distutils_exist:
+    print("""
+Python report "No module named 'distutils.uitl'"
+""")
+    sys.exit(-1)
+
 import TestTools
 
 def GetCTestSuite():
     import CToolsTests
     return CToolsTests.TheTestSuite()
-- 
2.20.1.windows.1

Re: [Patch V2] BaseTools: Add python3-distutils Ubuntu package checking

[Philippe Mathieu-Daudé]

On 2/28/19 3:04 AM, Feng, Bob C wrote:
> https://bugzilla.tianocore.org/show_bug.cgi?id=1509
> V2:
> Remove OS/Package specific words. Print the error info which
> is from python error message.
> 
> Add python3-distutils Ubuntu package checking.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Bob Feng <bob.c.feng@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> ---
>  BaseTools/Tests/RunTests.py | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/BaseTools/Tests/RunTests.py b/BaseTools/Tests/RunTests.py
> index 0dd65632d0..f6d3f43653 100644
> --- a/BaseTools/Tests/RunTests.py
> +++ b/BaseTools/Tests/RunTests.py
> @@ -17,10 +17,22 @@
>  #
>  import os
>  import sys
>  import unittest
>  
> +distutils_exist = True

Why this variable? You can achieve the same without adding variables in
the global namespace.

> +try:
> +    import distutils.util
> +except:

I'd restrict that to ImportError, just in case.

> +    distutils_exist = False
> +
> +if not distutils_exist:
> +    print("""
> +Python report "No module named 'distutils.uitl'"

'distutils.util' ;)

> +""")
> +    sys.exit(-1)

Per the sys.exit doc:

  The optional argument arg can be an integer giving the exit status
  (defaulting to zero), or another type of object. If it is an integer,
  zero is considered “successful termination” and any nonzero value is
  considered “abnormal termination” by shells and the like. Most systems
  require it to be in the range 0–127, and produce undefined results
  otherwise.

Can we avoid to use negative return values?

I suggest to simply use this snippet:

  try:
      import distutils.util
  except ImportError as error:
      sys.exit("Python reported: " + error.message)

Note the difference with your patch are:
- no global namespace variable used
- exception not Import related still display stack dump
- the error message is displayed on stderr rather than stdout
- the return value is 1 instead of -1

Regards,

Phil.

>  import TestTools
>  
>  def GetCTestSuite():
>      import CToolsTests
>      return CToolsTests.TheTestSuite()
>