From 50df6f37340b3401d98f61dc6c76fd8c0cae7254 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mart=C3=AD=20Bol=C3=ADvar?= <marti.bolivar@nordicsemi.no>
Date: Wed, 6 Nov 2019 09:08:31 -0800
Subject: [PATCH] scripts: runners: sort runner lists
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This should help avoid merge conflicts in the future.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
---
 scripts/west_commands/runners/__init__.py   |  9 ++++----
 scripts/west_commands/tests/test_imports.py | 24 +++++++++++++++++----
 2 files changed, 25 insertions(+), 8 deletions(-)

diff --git a/scripts/west_commands/runners/__init__.py b/scripts/west_commands/runners/__init__.py
index feb39ad64cb..7fbb3302ae1 100644
--- a/scripts/west_commands/runners/__init__.py
+++ b/scripts/west_commands/runners/__init__.py
@@ -10,24 +10,25 @@ from runners.core import ZephyrBinaryRunner, MissingProgram
 
 # Explicitly silence the unused import warning.
 # flake8: noqa: F401
+# Keep this list sorted by runner name.
 from runners import arc
+from runners import blackmagicprobe
 from runners import bossac
 from runners import dediprog
 from runners import dfu
 from runners import esp32
 from runners import hifive1
+from runners import intel_s1000
 from runners import jlink
+from runners import misc
 from runners import nios2
 from runners import nrfjprog
 from runners import nsim
 from runners import openocd
 from runners import pyocd
 from runners import qemu
-from runners import xtensa
-from runners import intel_s1000
-from runners import blackmagicprobe
 from runners import stm32flash
-from runners import misc
+from runners import xtensa
 
 def get_runner_cls(runner):
     '''Get a runner's class object, given its name.'''
diff --git a/scripts/west_commands/tests/test_imports.py b/scripts/west_commands/tests/test_imports.py
index 2fcc1bc2b33..46683abc4ec 100644
--- a/scripts/west_commands/tests/test_imports.py
+++ b/scripts/west_commands/tests/test_imports.py
@@ -12,8 +12,24 @@ def test_runner_imports():
     # tree-wide refactorings for runners that don't have their own
     # test suites.
     runner_names = set(r.name() for r in ZephyrBinaryRunner.get_runners())
-    expected = set(('arc-nsim', 'bossac', 'dfu-util', 'em-starterkit', 'esp32',
-                    'hifive1', 'jlink', 'nios2', 'nrfjprog', 'openocd', 'pyocd',
-                    'qemu', 'xtensa', 'intel_s1000', 'blackmagicprobe',
-                    'dediprog', 'stm32flash', 'misc-flasher'))
+
+    # Please keep this sorted alphabetically.
+    expected = set(('arc-nsim',
+                    'blackmagicprobe',
+                    'bossac',
+                    'dediprog',
+                    'dfu-util',
+                    'em-starterkit',
+                    'esp32',
+                    'hifive1',
+                    'intel_s1000',
+                    'jlink',
+                    'misc-flasher',
+                    'nios2',
+                    'nrfjprog',
+                    'openocd',
+                    'pyocd',
+                    'qemu',
+                    'stm32flash',
+                    'xtensa'))
     assert runner_names == expected