diff mbox series

[v7] fat: Add KUnit tests for checksums and timestamps

Message ID 20201028064631.3774908-1-davidgow@google.com
State New
Headers show
Series [v7] fat: Add KUnit tests for checksums and timestamps | expand

Commit Message

David Gow Oct. 28, 2020, 6:46 a.m. UTC
Add some basic sanity-check tests for the fat_checksum() function and
the fat_time_unix2fat() and fat_time_fat2unix() functions. These unit
tests verify these functions return correct output for a number of test
inputs.

These tests were inspored by -- and serve a similar purpose to -- the
timestamp parsing KUnit tests in ext4[1].

Note that, unlike fat_time_unix2fat, fat_time_fat2unix wasn't previously
exported, so this patch exports it as well. This is required for the
case where we're building the fat and fat_test as modules.

[1]:
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/fs/ext4/inode-test.c

Signed-off-by: David Gow <davidgow@google.com>
Acked-by: OGAWA Hirofumi <hirofumi@mail.parknet.co.jp>
---


Changes since v6:
https://lore.kernel.org/linux-kselftest/20201024060558.2556249-1-davidgow@google.com/
- Make CONFIG_FAT_DEFAULT_CODEPAGE depend on FAT_FS, rather than either
  VFAT_FS or MSDOS_FS.
  - This means that FAT_KUNIT_TEST can now also just depend of FAT_FS
- Fix a few warnings that KUnit tool was eating:
  - KUnit's type checking needs a specific cast for the fat_checksum()
    expected results.
  - The time test cases shouldn't be 'const'
  - The fake superblock is now static, as otherwise it increased the
    stack size too much.


Changes since v4/5:
https://lore.kernel.org/linux-kselftest/20201024052047.2526780-1-davidgow@google.com/
- Fix a typo introduced in the Kconfig. It builds now.

Changes since v3:
https://lore.kernel.org/linux-kselftest/20201021061713.1545931-1-davidgow@google.com/
- Update the Kconfig entry to use "depends on" rather than "select", as
  discussed in [2].
- Depend on "MSDOS_FS || VFAT_FS", rather than "FAT_FS", as we need the
  CONFIG_FAT_DEFAULT_CODEPAGE symbol to be defined.

Changes since v2:
https://lore.kernel.org/linux-kselftest/20201020055856.1270482-1-davidgow@google.com/
- Comment that the export for fat_time_fat2unix() function is for KUnit
  tests.

Changes since v1:
https://lore.kernel.org/linux-kselftest/20201017064107.375174-1-davidgow@google.com/
- Now export fat_time_fat2unix() so that the test can access it when
  built as a module.


[2]:
https://lore.kernel.org/linux-ext4/52959e99-4105-3de9-730c-c46894b82bdd@infradead.org/T/#t



 fs/fat/Kconfig    |  14 +++-
 fs/fat/Makefile   |   2 +
 fs/fat/fat_test.c | 196 ++++++++++++++++++++++++++++++++++++++++++++++
 fs/fat/misc.c     |   2 +
 4 files changed, 213 insertions(+), 1 deletion(-)
 create mode 100644 fs/fat/fat_test.c

Comments

kernel test robot Nov. 4, 2020, 4:01 p.m. UTC | #1
Hi David,

I love your patch! Perhaps something to improve:

[auto build test WARNING on linus/master]
[also build test WARNING on v5.10-rc2 next-20201104]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/David-Gow/fat-Add-KUnit-tests-for-checksums-and-timestamps/20201029-062211
base:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git 23859ae44402f4d935b9ee548135dd1e65e2cbf4
config: parisc-randconfig-s031-20201104 (attached as .config)
compiler: hppa-linux-gcc (GCC) 9.3.0
reproduce:
        wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
        chmod +x ~/bin/make.cross
        # apt-get install sparse
        # sparse version: v0.6.3-76-gf680124b-dirty
        # https://github.com/0day-ci/linux/commit/2703274109bdea879973719332569f6754dce440
        git remote add linux-review https://github.com/0day-ci/linux
        git fetch --no-tags linux-review David-Gow/fat-Add-KUnit-tests-for-checksums-and-timestamps/20201029-062211
        git checkout 2703274109bdea879973719332569f6754dce440
        # save the attached .config to linux build tree
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' ARCH=parisc 

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp@intel.com>


"sparse warnings: (new ones prefixed by >>)"
   fs/fat/fat_test.c:38:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:38:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:38:25: sparse:     got int
   fs/fat/fat_test.c:45:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] time @@     got int @@
   fs/fat/fat_test.c:45:25: sparse:     expected restricted __le16 [usertype] time
   fs/fat/fat_test.c:45:25: sparse:     got int
   fs/fat/fat_test.c:46:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:46:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:46:25: sparse:     got int
   fs/fat/fat_test.c:54:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:54:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:54:25: sparse:     got int
   fs/fat/fat_test.c:61:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] time @@     got int @@
   fs/fat/fat_test.c:61:25: sparse:     expected restricted __le16 [usertype] time
   fs/fat/fat_test.c:61:25: sparse:     got int
   fs/fat/fat_test.c:62:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:62:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:62:25: sparse:     got int
   fs/fat/fat_test.c:70:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:70:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:70:25: sparse:     got int
   fs/fat/fat_test.c:78:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:78:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:78:25: sparse:     got int
   fs/fat/fat_test.c:86:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:86:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:86:25: sparse:     got int
   fs/fat/fat_test.c:93:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] time @@     got int @@
   fs/fat/fat_test.c:93:25: sparse:     expected restricted __le16 [usertype] time
   fs/fat/fat_test.c:93:25: sparse:     got int
   fs/fat/fat_test.c:94:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:94:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:94:25: sparse:     got int
   fs/fat/fat_test.c:101:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] time @@     got int @@
   fs/fat/fat_test.c:101:25: sparse:     expected restricted __le16 [usertype] time
   fs/fat/fat_test.c:101:25: sparse:     got int
   fs/fat/fat_test.c:102:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:102:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:102:25: sparse:     got int
   fs/fat/fat_test.c:109:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] time @@     got int @@
   fs/fat/fat_test.c:109:25: sparse:     expected restricted __le16 [usertype] time
   fs/fat/fat_test.c:109:25: sparse:     got int
   fs/fat/fat_test.c:110:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:110:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:110:25: sparse:     got int
   fs/fat/fat_test.c:118:25: sparse: sparse: incorrect type in initializer (different base types) @@     expected restricted __le16 [usertype] date @@     got int @@
   fs/fat/fat_test.c:118:25: sparse:     expected restricted __le16 [usertype] date
   fs/fat/fat_test.c:118:25: sparse:     got int
>> fs/fat/fat_test.c:164:17: sparse: sparse: incorrect type in initializer (different base types) @@     expected long long left_value @@     got restricted __le16 __left @@
   fs/fat/fat_test.c:164:17: sparse:     expected long long left_value
>> fs/fat/fat_test.c:164:17: sparse:     got restricted __le16 __left
   fs/fat/fat_test.c:164:17: sparse: sparse: incorrect type in initializer (different base types) @@     expected long long right_value @@     got restricted __le16 __right @@
   fs/fat/fat_test.c:164:17: sparse:     expected long long right_value
   fs/fat/fat_test.c:164:17: sparse:     got restricted __le16 __right
   fs/fat/fat_test.c:169:17: sparse: sparse: incorrect type in initializer (different base types) @@     expected long long left_value @@     got restricted __le16 __left @@
   fs/fat/fat_test.c:169:17: sparse:     expected long long left_value
   fs/fat/fat_test.c:169:17: sparse:     got restricted __le16 __left
   fs/fat/fat_test.c:169:17: sparse: sparse: incorrect type in initializer (different base types) @@     expected long long right_value @@     got restricted __le16 __right @@
   fs/fat/fat_test.c:169:17: sparse:     expected long long right_value
   fs/fat/fat_test.c:169:17: sparse:     got restricted __le16 __right

vim +164 fs/fat/fat_test.c

   150	
   151	static void fat_time_unix2fat_test(struct kunit *test)
   152	{
   153		static struct msdos_sb_info fake_sb;
   154		int i;
   155		__le16 date, time;
   156		u8 cs;
   157	
   158		for (i = 0; i < ARRAY_SIZE(time_test_cases); ++i) {
   159			fake_sb.options.tz_set = 1;
   160			fake_sb.options.time_offset = time_test_cases[i].time_offset;
   161	
   162			fat_time_unix2fat(&fake_sb, &time_test_cases[i].ts,
   163					  &time, &date, &cs);
 > 164			KUNIT_EXPECT_EQ_MSG(test,
   165					    time_test_cases[i].time,
   166					    time,
   167					    "Time mismatch in case \"%s\"\n",
   168					    time_test_cases[i].name);
   169			KUNIT_EXPECT_EQ_MSG(test,
   170					    time_test_cases[i].date,
   171					    date,
   172					    "Date mismatch in case \"%s\"\n",
   173					    time_test_cases[i].name);
   174			KUNIT_EXPECT_EQ_MSG(test,
   175					    time_test_cases[i].cs,
   176					    cs,
   177					    "Centisecond mismatch in case \"%s\"\n",
   178					    time_test_cases[i].name);
   179		}
   180	}
   181	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org
diff mbox series

Patch

diff --git a/fs/fat/Kconfig b/fs/fat/Kconfig
index 66532a71e8fd..238cc55f84c4 100644
--- a/fs/fat/Kconfig
+++ b/fs/fat/Kconfig
@@ -77,7 +77,7 @@  config VFAT_FS
 
 config FAT_DEFAULT_CODEPAGE
 	int "Default codepage for FAT"
-	depends on MSDOS_FS || VFAT_FS
+	depends on FAT_FS
 	default 437
 	help
 	  This option should be set to the codepage of your FAT filesystems.
@@ -115,3 +115,15 @@  config FAT_DEFAULT_UTF8
 	  Say Y if you use UTF-8 encoding for file names, N otherwise.
 
 	  See <file:Documentation/filesystems/vfat.rst> for more information.
+
+config FAT_KUNIT_TEST
+	tristate "Unit Tests for FAT filesystems" if !KUNIT_ALL_TESTS
+	depends on KUNIT && FAT_FS
+	default KUNIT_ALL_TESTS
+	help
+	  This builds the FAT KUnit tests
+
+	  For more information on KUnit and unit tests in general, please refer
+	  to the KUnit documentation in Documentation/dev-tools/kunit
+
+	  If unsure, say N
diff --git a/fs/fat/Makefile b/fs/fat/Makefile
index 70645ce2f7fc..2b034112690d 100644
--- a/fs/fat/Makefile
+++ b/fs/fat/Makefile
@@ -10,3 +10,5 @@  obj-$(CONFIG_MSDOS_FS) += msdos.o
 fat-y := cache.o dir.o fatent.o file.o inode.o misc.o nfs.o
 vfat-y := namei_vfat.o
 msdos-y := namei_msdos.o
+
+obj-$(CONFIG_FAT_KUNIT_TEST) += fat_test.o
diff --git a/fs/fat/fat_test.c b/fs/fat/fat_test.c
new file mode 100644
index 000000000000..7d3fe928fbe6
--- /dev/null
+++ b/fs/fat/fat_test.c
@@ -0,0 +1,196 @@ 
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * KUnit tests for FAT filesystems.
+ *
+ * Copyright (C) 2020 Google LLC.
+ * Author: David Gow <davidgow@google.com>
+ */
+
+#include <kunit/test.h>
+
+#include "fat.h"
+
+static void fat_checksum_test(struct kunit *test)
+{
+	/* With no extension. */
+	KUNIT_EXPECT_EQ(test, fat_checksum("VMLINUX    "), (u8)44);
+	/* With 3-letter extension. */
+	KUNIT_EXPECT_EQ(test, fat_checksum("README  TXT"), (u8)115);
+	/* With short (1-letter) extension. */
+	KUNIT_EXPECT_EQ(test, fat_checksum("ABCDEFGHA  "), (u8)98);
+}
+
+
+struct fat_timestamp_testcase {
+	const char *name;
+	struct timespec64 ts;
+	__le16 time;
+	__le16 date;
+	u8 cs;
+	int time_offset;
+};
+
+static struct fat_timestamp_testcase time_test_cases[] = {
+	{
+		.name = "Earliest possible UTC (1980-01-01 00:00:00)",
+		.ts = {.tv_sec = 315532800LL, .tv_nsec = 0L},
+		.time = 0,
+		.date = 33,
+		.cs = 0,
+		.time_offset = 0,
+	},
+	{
+		.name = "Latest possible UTC (2107-12-31 23:59:58)",
+		.ts = {.tv_sec = 4354819198LL, .tv_nsec = 0L},
+		.time = 49021,
+		.date = 65439,
+		.cs = 0,
+		.time_offset = 0,
+	},
+	{
+		.name = "Earliest possible (UTC-11) (== 1979-12-31 13:00:00 UTC)",
+		.ts = {.tv_sec = 315493200LL, .tv_nsec = 0L},
+		.time = 0,
+		.date = 33,
+		.cs = 0,
+		.time_offset = 11 * 60,
+	},
+	{
+		.name = "Latest possible (UTC+11) (== 2108-01-01 10:59:58 UTC)",
+		.ts = {.tv_sec = 4354858798LL, .tv_nsec = 0L},
+		.time = 49021,
+		.date = 65439,
+		.cs = 0,
+		.time_offset = -11 * 60,
+	},
+	{
+		.name = "Leap Day / Year (1996-02-29 00:00:00)",
+		.ts = {.tv_sec = 825552000LL, .tv_nsec = 0L},
+		.time = 0,
+		.date = 8285,
+		.cs = 0,
+		.time_offset = 0,
+	},
+	{
+		.name = "Year 2000 is leap year (2000-02-29 00:00:00)",
+		.ts = {.tv_sec = 951782400LL, .tv_nsec = 0L},
+		.time = 0,
+		.date = 10333,
+		.cs = 0,
+		.time_offset = 0,
+	},
+	{
+		.name = "Year 2100 not leap year (2100-03-01 00:00:00)",
+		.ts = {.tv_sec = 4107542400LL, .tv_nsec = 0L},
+		.time = 0,
+		.date = 61537,
+		.cs = 0,
+		.time_offset = 0,
+	},
+	{
+		.name = "Leap year + timezone UTC+1 (== 2004-02-29 00:30:00 UTC)",
+		.ts = {.tv_sec = 1078014600LL, .tv_nsec = 0L},
+		.time = 48064,
+		.date = 12380,
+		.cs = 0,
+		.time_offset = -60,
+	},
+	{
+		.name = "Leap year + timezone UTC-1 (== 2004-02-29 23:30:00 UTC)",
+		.ts = {.tv_sec = 1078097400LL, .tv_nsec = 0L},
+		.time = 960,
+		.date = 12385,
+		.cs = 0,
+		.time_offset = 60,
+	},
+	{
+		.name = "VFAT odd-second resolution (1999-12-31 23:59:59)",
+		.ts = {.tv_sec = 946684799LL, .tv_nsec = 0L},
+		.time = 49021,
+		.date = 10143,
+		.cs = 100,
+		.time_offset = 0,
+	},
+	{
+		.name = "VFAT 10ms resolution (1980-01-01 00:00:00:0010)",
+		.ts = {.tv_sec = 315532800LL, .tv_nsec = 10000000L},
+		.time = 0,
+		.date = 33,
+		.cs = 1,
+		.time_offset = 0,
+	},
+};
+
+static void fat_time_fat2unix_test(struct kunit *test)
+{
+	static struct msdos_sb_info fake_sb;
+	int i;
+	struct timespec64 ts;
+
+	for (i = 0; i < ARRAY_SIZE(time_test_cases); ++i) {
+		fake_sb.options.tz_set = 1;
+		fake_sb.options.time_offset = time_test_cases[i].time_offset;
+
+		fat_time_fat2unix(&fake_sb, &ts,
+				  time_test_cases[i].time,
+				  time_test_cases[i].date,
+				  time_test_cases[i].cs);
+		KUNIT_EXPECT_EQ_MSG(test,
+				    time_test_cases[i].ts.tv_sec,
+				    ts.tv_sec,
+				    "Timestamp mismatch (seconds) in case \"%s\"\n",
+				    time_test_cases[i].name);
+		KUNIT_EXPECT_EQ_MSG(test,
+				    time_test_cases[i].ts.tv_nsec,
+				    ts.tv_nsec,
+				    "Timestamp mismatch (nanoseconds) in case \"%s\"\n",
+				    time_test_cases[i].name);
+	}
+}
+
+static void fat_time_unix2fat_test(struct kunit *test)
+{
+	static struct msdos_sb_info fake_sb;
+	int i;
+	__le16 date, time;
+	u8 cs;
+
+	for (i = 0; i < ARRAY_SIZE(time_test_cases); ++i) {
+		fake_sb.options.tz_set = 1;
+		fake_sb.options.time_offset = time_test_cases[i].time_offset;
+
+		fat_time_unix2fat(&fake_sb, &time_test_cases[i].ts,
+				  &time, &date, &cs);
+		KUNIT_EXPECT_EQ_MSG(test,
+				    time_test_cases[i].time,
+				    time,
+				    "Time mismatch in case \"%s\"\n",
+				    time_test_cases[i].name);
+		KUNIT_EXPECT_EQ_MSG(test,
+				    time_test_cases[i].date,
+				    date,
+				    "Date mismatch in case \"%s\"\n",
+				    time_test_cases[i].name);
+		KUNIT_EXPECT_EQ_MSG(test,
+				    time_test_cases[i].cs,
+				    cs,
+				    "Centisecond mismatch in case \"%s\"\n",
+				    time_test_cases[i].name);
+	}
+}
+
+static struct kunit_case fat_test_cases[] = {
+	KUNIT_CASE(fat_checksum_test),
+	KUNIT_CASE(fat_time_fat2unix_test),
+	KUNIT_CASE(fat_time_unix2fat_test),
+	{},
+};
+
+static struct kunit_suite fat_test_suite = {
+	.name = "fat_test",
+	.test_cases = fat_test_cases,
+};
+
+kunit_test_suites(&fat_test_suite);
+
+MODULE_LICENSE("GPL v2");
diff --git a/fs/fat/misc.c b/fs/fat/misc.c
index f1b2a1fc2a6a..3eabd07b38e2 100644
--- a/fs/fat/misc.c
+++ b/fs/fat/misc.c
@@ -229,6 +229,8 @@  void fat_time_fat2unix(struct msdos_sb_info *sbi, struct timespec64 *ts,
 		ts->tv_nsec = 0;
 	}
 }
+/* Export fat_time_fat2unix() for the fat_test KUnit tests. */
+EXPORT_SYMBOL_GPL(fat_time_fat2unix);
 
 /* Convert linear UNIX date to a FAT time/date pair. */
 void fat_time_unix2fat(struct msdos_sb_info *sbi, struct timespec64 *ts,