From 5381ac0fcc4db3c574d28ee0b0886ce430548161 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20K=C4=99pie=C5=84?= <michal@isc.org>
Date: Tue, 30 Jul 2019 21:08:40 +0200
Subject: [PATCH] Unify header ordering in unit tests

Make sure all unit tests include headers in a similar order:

 1. Three headers which must be included before <cmocka.h>.
 2. System headers.
 3. UNIT_TESTING definition, followed by the <cmocka.h> header.
 4. libisc headers.
 5. Headers from other BIND libraries.
 6. Local headers.

Also make sure header file names are sorted alphabetically within each
block of #include directives.
---
 lib/dns/tests/dh_test.c            |  5 +++--
 lib/dns/tests/dst_test.c           |  5 ++---
 lib/dns/tests/master_test.c        |  3 +--
 lib/dns/tests/rbt_serialize_test.c | 14 +++++++-------
 lib/dns/tests/resolver_test.c      |  3 +--
 lib/dns/tests/result_test.c        |  3 ++-
 lib/dns/tests/sigs_test.c          | 13 ++++++-------
 lib/dns/tests/tsig_test.c          |  3 +--
 lib/isc/tests/aes_test.c           |  4 ++--
 lib/isc/tests/crc64_test.c         |  2 +-
 lib/isc/tests/errno_test.c         |  5 +++--
 lib/isc/tests/hash_test.c          |  5 ++---
 lib/isc/tests/netaddr_test.c       |  2 +-
 lib/isc/tests/regex_test.c         |  6 +++---
 lib/isc/tests/result_test.c        |  3 ++-
 lib/isc/tests/taskpool_test.c      |  1 -
 lib/isccc/tests/result_test.c      |  3 ++-
 lib/ns/tests/listenlist_test.c     |  5 +----
 lib/ns/tests/notify_test.c         |  5 +----
 lib/ns/tests/plugin_test.c         |  7 +++----
 lib/ns/tests/query_test.c          |  5 ++---
 21 files changed, 46 insertions(+), 56 deletions(-)

diff --git a/lib/dns/tests/dh_test.c b/lib/dns/tests/dh_test.c
index 6893aee1a6..fde5416bd2 100644
--- a/lib/dns/tests/dh_test.c
+++ b/lib/dns/tests/dh_test.c
@@ -26,11 +26,12 @@
 #include <isc/util.h>
 #include <isc/string.h>
 
-#include <pk11/site.h>
-
 #include <dns/name.h>
+
 #include <dst/result.h>
 
+#include <pk11/site.h>
+
 #include "../dst_internal.h"
 
 #include "dnstest.h"
diff --git a/lib/dns/tests/dst_test.c b/lib/dns/tests/dst_test.c
index 0abe214520..08c02c2ea2 100644
--- a/lib/dns/tests/dst_test.c
+++ b/lib/dns/tests/dst_test.c
@@ -23,13 +23,12 @@
 #define UNIT_TESTING
 #include <cmocka.h>
 
-#include <isc/util.h>
-
 #include <isc/file.h>
 #include <isc/hex.h>
-#include <isc/util.h>
 #include <isc/stdio.h>
 #include <isc/string.h>
+#include <isc/util.h>
+#include <isc/util.h>
 
 #include <dst/dst.h>
 #include <dst/result.h>
diff --git a/lib/dns/tests/master_test.c b/lib/dns/tests/master_test.c
index cbf55f4942..85ef0f0008 100644
--- a/lib/dns/tests/master_test.c
+++ b/lib/dns/tests/master_test.c
@@ -24,10 +24,9 @@
 #define UNIT_TESTING
 #include <cmocka.h>
 
-#include <isc/util.h>
-
 #include <isc/print.h>
 #include <isc/string.h>
+#include <isc/util.h>
 
 #include <dns/cache.h>
 #include <dns/callbacks.h>
diff --git a/lib/dns/tests/rbt_serialize_test.c b/lib/dns/tests/rbt_serialize_test.c
index b4cd765e39..af450b2f3d 100644
--- a/lib/dns/tests/rbt_serialize_test.c
+++ b/lib/dns/tests/rbt_serialize_test.c
@@ -25,12 +25,6 @@
 #define UNIT_TESTING
 #include <cmocka.h>
 
-#include <dns/rbt.h>
-#include <dns/fixedname.h>
-#include <dns/result.h>
-#include <dns/compress.h>
-#include "dnstest.h"
-
 #include <isc/app.h>
 #include <isc/buffer.h>
 #include <isc/commandline.h>
@@ -40,19 +34,25 @@
 #include <isc/os.h>
 #include <isc/print.h>
 #include <isc/random.h>
-#include <isc/string.h>
 #include <isc/socket.h>
 #include <isc/stdio.h>
+#include <isc/string.h>
 #include <isc/task.h>
 #include <isc/timer.h>
 #include <isc/util.h>
 
+#include <dns/compress.h>
+#include <dns/fixedname.h>
 #include <dns/log.h>
 #include <dns/name.h>
+#include <dns/rbt.h>
+#include <dns/result.h>
 #include <dns/result.h>
 
 #include <dst/dst.h>
 
+#include "dnstest.h"
+
 #ifndef MAP_FILE
 #define MAP_FILE 0
 #endif
diff --git a/lib/dns/tests/resolver_test.c b/lib/dns/tests/resolver_test.c
index 3d34e9fd4f..a9476ca1e7 100644
--- a/lib/dns/tests/resolver_test.c
+++ b/lib/dns/tests/resolver_test.c
@@ -22,14 +22,13 @@
 #define UNIT_TESTING
 #include <cmocka.h>
 
-#include <isc/util.h>
-
 #include <isc/app.h>
 #include <isc/buffer.h>
 #include <isc/print.h>
 #include <isc/socket.h>
 #include <isc/task.h>
 #include <isc/timer.h>
+#include <isc/util.h>
 
 #include <dns/dispatch.h>
 #include <dns/name.h>
diff --git a/lib/dns/tests/result_test.c b/lib/dns/tests/result_test.c
index 813eb746ab..4a24128de5 100644
--- a/lib/dns/tests/result_test.c
+++ b/lib/dns/tests/result_test.c
@@ -13,8 +13,9 @@
 
 #include <stdarg.h>
 #include <stddef.h>
-#include <stdlib.h>
 #include <setjmp.h>
+
+#include <stdlib.h>
 #include <string.h>
 
 #define UNIT_TESTING
diff --git a/lib/dns/tests/sigs_test.c b/lib/dns/tests/sigs_test.c
index 45e68def58..78f267e0a6 100644
--- a/lib/dns/tests/sigs_test.c
+++ b/lib/dns/tests/sigs_test.c
@@ -23,6 +23,12 @@
 #define UNIT_TESTING
 #include <cmocka.h>
 
+#include <isc/buffer.h>
+#include <isc/list.h>
+#include <isc/region.h>
+#include <isc/result.h>
+#include <isc/stdtime.h>
+#include <isc/types.h>
 #include <isc/util.h>
 
 #include <dns/db.h>
@@ -39,13 +45,6 @@
 
 #include <dst/dst.h>
 
-#include <isc/buffer.h>
-#include <isc/list.h>
-#include <isc/region.h>
-#include <isc/stdtime.h>
-#include <isc/result.h>
-#include <isc/types.h>
-
 #include "../zone_p.h"
 
 #include "dnstest.h"
diff --git a/lib/dns/tests/tsig_test.c b/lib/dns/tests/tsig_test.c
index c489fcfeff..ff14d2de42 100644
--- a/lib/dns/tests/tsig_test.c
+++ b/lib/dns/tests/tsig_test.c
@@ -23,10 +23,9 @@
 #define UNIT_TESTING
 #include <cmocka.h>
 
-#include <isc/util.h>
-
 #include <isc/mem.h>
 #include <isc/print.h>
+#include <isc/util.h>
 
 #include <dns/rdatalist.h>
 #include <dns/rdataset.h>
diff --git a/lib/isc/tests/aes_test.c b/lib/isc/tests/aes_test.c
index 20795fee9f..a5653ec9a6 100644
--- a/lib/isc/tests/aes_test.c
+++ b/lib/isc/tests/aes_test.c
@@ -11,12 +11,12 @@
 
 #if HAVE_CMOCKA
 
-#include <setjmp.h>
 #include <stdarg.h>
 #include <stddef.h>
-#include <stdlib.h>
+#include <setjmp.h>
 
 #include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
 
 #define UNIT_TESTING
diff --git a/lib/isc/tests/crc64_test.c b/lib/isc/tests/crc64_test.c
index 2a0a040fcb..8d1ca7ea0a 100644
--- a/lib/isc/tests/crc64_test.c
+++ b/lib/isc/tests/crc64_test.c
@@ -16,8 +16,8 @@
 #include <stdarg.h>
 #include <stddef.h>
 #include <setjmp.h>
-#include <stdlib.h>
 
+#include <stdlib.h>
 #include <string.h>
 
 #define UNIT_TESTING
diff --git a/lib/isc/tests/errno_test.c b/lib/isc/tests/errno_test.c
index b17937e815..5d62a954d9 100644
--- a/lib/isc/tests/errno_test.c
+++ b/lib/isc/tests/errno_test.c
@@ -11,12 +11,13 @@
 
 #if HAVE_CMOCKA
 
-#include <setjmp.h>
 #include <stdarg.h>
 #include <stddef.h>
-#include <stdlib.h>
+#include <setjmp.h>
 
+#include <stdlib.h>
 #include <string.h>
+
 #include <sys/errno.h>
 
 #define UNIT_TESTING
diff --git a/lib/isc/tests/hash_test.c b/lib/isc/tests/hash_test.c
index cb6830b373..813a8a65ff 100644
--- a/lib/isc/tests/hash_test.c
+++ b/lib/isc/tests/hash_test.c
@@ -27,11 +27,10 @@
 #include <isc/buffer.h>
 #include <isc/hash.h>
 #include <isc/hex.h>
-#include <isc/region.h>
-
-#include <isc/util.h>
 #include <isc/print.h>
+#include <isc/region.h>
 #include <isc/string.h>
+#include <isc/util.h>
 
 #include <pk11/site.h>
 
diff --git a/lib/isc/tests/netaddr_test.c b/lib/isc/tests/netaddr_test.c
index 2a2ddcfd7c..419c837dd3 100644
--- a/lib/isc/tests/netaddr_test.c
+++ b/lib/isc/tests/netaddr_test.c
@@ -13,11 +13,11 @@
 
 #include <stdarg.h>
 #include <stddef.h>
-#include <stdlib.h>
 #include <setjmp.h>
 
 #include <stdbool.h>
 #include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
 
 #define UNIT_TESTING
diff --git a/lib/isc/tests/regex_test.c b/lib/isc/tests/regex_test.c
index 4502be07f9..a09e2dbae9 100644
--- a/lib/isc/tests/regex_test.c
+++ b/lib/isc/tests/regex_test.c
@@ -20,13 +20,13 @@
 #include <string.h>
 #include <unistd.h>
 
-#define UNIT_TESTING
-#include <cmocka.h>
-
 #ifdef HAVE_REGEX_H
 #include <regex.h>
 #endif
 
+#define UNIT_TESTING
+#include <cmocka.h>
+
 #include <isc/commandline.h>
 #include <isc/regex.h>
 #include <isc/print.h>
diff --git a/lib/isc/tests/result_test.c b/lib/isc/tests/result_test.c
index 9be8cb5b78..20bf6101af 100644
--- a/lib/isc/tests/result_test.c
+++ b/lib/isc/tests/result_test.c
@@ -13,8 +13,9 @@
 
 #include <stdarg.h>
 #include <stddef.h>
-#include <stdlib.h>
 #include <setjmp.h>
+
+#include <stdlib.h>
 #include <string.h>
 
 #define UNIT_TESTING
diff --git a/lib/isc/tests/taskpool_test.c b/lib/isc/tests/taskpool_test.c
index a7453d96e8..0dfdc0b93e 100644
--- a/lib/isc/tests/taskpool_test.c
+++ b/lib/isc/tests/taskpool_test.c
@@ -27,7 +27,6 @@
 #include <isc/taskpool.h>
 #include <isc/util.h>
 
-
 #include "isctest.h"
 
 static int
diff --git a/lib/isccc/tests/result_test.c b/lib/isccc/tests/result_test.c
index a18c958446..ce960ed5b5 100644
--- a/lib/isccc/tests/result_test.c
+++ b/lib/isccc/tests/result_test.c
@@ -13,8 +13,9 @@
 
 #include <stdarg.h>
 #include <stddef.h>
-#include <stdlib.h>
 #include <setjmp.h>
+
+#include <stdlib.h>
 #include <string.h>
 
 #define UNIT_TESTING
diff --git a/lib/ns/tests/listenlist_test.c b/lib/ns/tests/listenlist_test.c
index 5d4fd8763e..32466d1e0c 100644
--- a/lib/ns/tests/listenlist_test.c
+++ b/lib/ns/tests/listenlist_test.c
@@ -16,11 +16,8 @@
 #include <setjmp.h>
 
 #include <sched.h> /* IWYU pragma: keep */
-#include <stdlib.h>
-
-#include <isc/util.h>
-
 #include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
 
diff --git a/lib/ns/tests/notify_test.c b/lib/ns/tests/notify_test.c
index 1094c26391..8cae165209 100644
--- a/lib/ns/tests/notify_test.c
+++ b/lib/ns/tests/notify_test.c
@@ -16,11 +16,8 @@
 #include <setjmp.h>
 
 #include <sched.h> /* IWYU pragma: keep */
-#include <stdlib.h>
-
-#include <isc/util.h>
-
 #include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
 
diff --git a/lib/ns/tests/plugin_test.c b/lib/ns/tests/plugin_test.c
index de910a9bd9..91627b6826 100644
--- a/lib/ns/tests/plugin_test.c
+++ b/lib/ns/tests/plugin_test.c
@@ -15,16 +15,15 @@
 #include <stddef.h>
 #include <setjmp.h>
 
+#include <limits.h>
 #include <sched.h> /* IWYU pragma: keep */
+#include <stdbool.h>
 #include <stdlib.h>
+#include <string.h>
 
 #define UNIT_TESTING
 #include <cmocka.h>
 
-#include <limits.h>
-#include <stdbool.h>
-#include <string.h>
-
 #include <isc/mem.h>
 #include <isc/platform.h>
 #include <isc/result.h>
diff --git a/lib/ns/tests/query_test.c b/lib/ns/tests/query_test.c
index bcbeecc167..415de2a887 100644
--- a/lib/ns/tests/query_test.c
+++ b/lib/ns/tests/query_test.c
@@ -15,8 +15,6 @@
 #include <stddef.h>
 #include <setjmp.h>
 
-#include <isc/util.h>
-
 #include <inttypes.h>
 #include <sched.h> /* IWYU pragma: keep */
 #include <stdbool.h>
@@ -26,13 +24,14 @@
 #define UNIT_TESTING
 #include <cmocka.h>
 
+#include <isc/util.h>
+
 #include <dns/badcache.h>
 #include <dns/view.h>
 
 #include <ns/client.h>
 #include <ns/hooks.h>
 #include <ns/query.h>
-#include <isc/util.h>
 
 #include "nstest.h"