From 3d9fc467eff316cb647e9b5f33c48a65f4069302 Mon Sep 17 00:00:00 2001
From: Bill Zissimopoulos <billziss@navimatics.com>
Date: Sat, 16 Nov 2019 07:26:07 +0000
Subject: [PATCH] tools: build.bat: winfsp-tests zip file

---
 tools/build.bat            | 11 +++++--
 tst/winfsp-tests/README.md | 64 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 72 insertions(+), 3 deletions(-)
 create mode 100644 tst/winfsp-tests/README.md

diff --git a/tools/build.bat b/tools/build.bat
index 31031ba9..1db42212 100755
--- a/tools/build.bat
+++ b/tools/build.bat
@@ -83,11 +83,11 @@ for %%f in (build\%Configuration%\winfsp-*.msi) do (
 
 if not %signfail%==0 echo SIGNING FAILED! The product has been successfully built, but not signed.
 
+for %%f in (build\%Configuration%\winfsp-*.msi) do set Version=%%~nf
+set Version=!Version:winfsp-=!
+
 where /q choco.exe
 if %ERRORLEVEL% equ 0 (
-    for %%f in (build\%Configuration%\winfsp-*.msi) do set Version=%%~nf
-    set Version=!Version:winfsp-=!
-
     copy ..\choco\* build\%Configuration%
     copy ..\choco\LICENSE.TXT /B + ..\..\License.txt /B build\%Configuration%\LICENSE.txt /B
     certutil -hashfile build\%Configuration%\winfsp-!Version!.msi SHA256 >>build\%Configuration%\VERIFICATION.txt
@@ -95,6 +95,11 @@ if %ERRORLEVEL% equ 0 (
     if errorlevel 1 goto fail
 )
 
+pushd build\%Configuration%
+powershell -command "Compress-Archive -Path winfsp-tests-*.exe,..\..\..\..\License.txt,..\..\..\..\tst\winfsp-tests\README.md -DestinationPath winfsp-tests-!Version!.zip"
+if errorlevel 1 goto fail
+popd
+
 exit /b 0
 
 :fail
diff --git a/tst/winfsp-tests/README.md b/tst/winfsp-tests/README.md
new file mode 100644
index 00000000..568ffde1
--- /dev/null
+++ b/tst/winfsp-tests/README.md
@@ -0,0 +1,64 @@
+## WINFSP-TESTS
+
+Winfsp-tests is a file system test suite that is used to test WinFsp and the file systems that ship with it. It is not intended for use by end users. If you have downloaded winfsp-tests, you likely wanted to download the WinFsp installer instead (i.e. the file that is named `winfsp-VERSION.msi`).
+
+**WINFSP-TESTS IS UNSUPPORTED SOFTWARE. IT MAY CRASH OR LOCK UP YOUR COMPUTER, CREATE ZOMBIE/UNKILLABLE PROCESSES OR CORRUPT YOUR DATA. DO NOT USE UNLESS YOU KNOW WHAT YOU ARE DOING. DO NOT POST BUGS/ISSUES/QUESTIONS AGAINST WINFSP-TESTS UNLESS YOU ALSO POST THE FIX. YOU HAVE BEEN WARNED!**
+
+## USAGE
+
+Winfsp-tests has two different test modes: a default internal mode in which it runs its tests against an embedded copy of MEMFS and an external mode in which it runs its tests against the file system in the current directory.
+
+Unless you are doing WinFsp development there should never be a need to run winfsp-tests in the default internal mode. However the external mode can be useful to test third party file systems that do not ship with WinFsp.
+
+To run winfsp-tests in external mode, you must use the `--external` command line option. I also recommend using the `--resilient` command line option, to have winfsp-tests improve test flakiness by retrying failed operations.
+
+```
+> winfsp-tests-x64 --external --resilient
+create_test............................ OK 0.00s
+create_fileattr_test................... OK 0.00s
+...
+--- COMPLETE ---
+```
+
+Specific tests to be run may be specified. For example, to run all tests that start with `rename`:
+
+```
+> winfsp-tests-x64 --external --resilient rename*
+rename_test............................ OK 0.01s
+rename_open_test....................... OK 0.00s
+...
+--- COMPLETE ---
+```
+
+To exclude a test or tests use the `-` prefix. For example, to run all `create` tests, except the `create_fileattr_test`:
+
+```
+> winfsp-tests-x64 --external --resilient create* -create_fileattr_test
+create_test............................ OK 0.05s
+create_readonlydir_test................ OK 0.01s
+...
+--- COMPLETE ---
+```
+
+By default only regular tests are run. To include optional or long running tests use the `+` prefix. For example, to run all tests use `+*`; to run oplock tests use `+oplock*`:
+
+```
+> winfsp-tests-x64 --external --resilient +oplock*
+oplock_level1_test..................... OK 1.26s
+oplock_level2_test..................... OK 2.46s
+...
+--- COMPLETE ---
+```
+
+To list tests without running them use the `--list` option:
+
+```
+> winfsp-tests-x64 --external --resilient --list +oplock*
+oplock_level1_test
+oplock_level2_test
+...
+```
+
+If a test fails the test suite stops immediately with an assertion failure. There is no additional explanation of the problem and you have to study the winfsp-tests source code to understand the failure and determine a fix for your file system. Additionally there may be garbage files remaining in the file system as winfsp-tests does not cleanup after itself.
+
+**NOTE**: Some tests require Administrator privileges in order to run.
\ No newline at end of file