[LNT] Python 3 support: stable profile getFunctions output

[thopre]

Summary

lnt profile getFunctions output depends on the iteration order of a
dictionary, which is an implementation detail up to Python 3.6
(included). The test tests/lnttool/Profile.py is thus unstable accross
architectures and Python versions. This commit adds a --sortkeys option
to the getFunctions command to sort the keys in the dictionary when
dumping it into json, thus allowing stable results of
tests/lnttool/Profile.py by using this option.

[thopre]

Ping?

[hubert.reinterpretcast]

LGTM.

lnt/lnttool/main.py

def command_top_level_counters(input):
     """print the whole-profile counter values"""
     import json
     import lnt.testing.profile.profile as profile
     print(json.dumps(profile.Profile.fromFile(input).getTopLevelCounters()))
 
 
 @action_profile.command("getFunctions")
 @click.argument("input", type=click.Path(exists=True))
-def command_get_functions(input):
[e-mail]("--sortkeys", is_flag=True)
+def command_get_functions(input, sortkeys):
     """print the functions in a profile"""
     import json
     import lnt.testing.profile.profile as profile
-    print(json.dumps(profile.Profile.fromFile(input).getFunctions()))
+    print(json.dumps(profile.Profile.fromFile(input).getFunctions(),
+                     sort_keys=sortkeys))
 
 
 @action_profile.command("getCodeForFunction")
 @click.argument("input", type=click.Path(exists=True))
 @click.argument('fn')
 def command_code_for_function(input, fn):
     """print the code/instruction for a function"""
     import json

tests/lnttool/Profile.py

 # RUN: lnt profile getVersion %S/Inputs/test.lntprof | FileCheck --check-prefix=CHECK-GETVERSION %s
 # CHECK-GETVERSION: 1
 
 # RUN: lnt profile getTopLevelCounters %S/Inputs/test.lntprof | FileCheck --check-prefix=CHECK-GETTLC %s
 # CHECK-GETTLC: {"cycles": 12345.0, "branch-misses": 200.0}
 
-# RUN: lnt profile getFunctions %S/Inputs/test.lntprof | FileCheck --check-prefix=CHECK-GETFUNCTIONS %s
-# CHECK-GETFUNCTIONS: {"fn1": {"length": 2, "counters": {"cycles": 45.0, "branch-misses": 10.0}}}
+# RUN: lnt profile getFunctions --sortkeys %S/Inputs/test.lntprof | FileCheck --check-prefix=CHECK-GETFUNCTIONS %s
+# CHECK-GETFUNCTIONS: {"fn1": {"counters": {"branch-misses": 10.0, "cycles": 45.0}, "length": 2}}
 
 # RUN: lnt profile getCodeForFunction %S/Inputs/test.lntprof fn1 | FileCheck --check-prefix=CHECK-GETFN1 %s
 # CHECK-GETFN1: [{}, 1048576, "add r0, r0, r0"], [{"cycles": 100.0}, 1048580, "sub r1, r0, r0"]]
 
 # RUN: mkdir -p %t
 # RUN: rm -rf %t/non_existing_output.lnt
 # RUN: lnt profile upgrade %S/Inputs/test.lntprof %t/non_existing_output.lnt
 # RUN: cat %t/non_existing_output.lnt