Merged PR 5894274: Update FileServer test design spec docs

## Pull Request Checklist ### General - [ ] Are all regression test passed? - [ ] Are there any test cases that will expose unfixed TDIs or Windows bugs? ### New Test Case - [ ] Have Design Spec and User Guide been updated? - [ ] Can all the test cases be loaded and executed by PTM & PTMCli? - [ ] Can the related changes support multiple platform(Windows, Linux, MacOS)? ### SDK Changes - [ ] Are all related test suites Regression passed? Update FileServer test design spec docs Related work items: #32325654
microsoft · Apr 7, 2021 · 106620e · 106620e
1 parent 282eb15
commit 106620e
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 36 deletions.
diff --git a/TestSuites/FileServer/docs/Auth_ServerTestDesignSpecification.md b/TestSuites/FileServer/docs/Auth_ServerTestDesignSpecification.md
@@ -1,6 +1,6 @@
 # AUTH  Protocol Server Test Design Specification 
 
-##Contents
+## Contents
 * [Contents](#_Toc427487690)
 * [Summary](#_Toc427487691)
 * [Test Scope](#_Toc427487692)
@@ -520,7 +520,7 @@ In Share Permission Check scenario, different DACLs will be applied to SMB share
 
 #### <a name="_Toc427487704"/>Preconditions
 
-#####Domain Users
+##### Domain Users
 
 | User Name| SID| Member Of| Attributes| 
 | -------------| -------------| -------------| ------------- |
@@ -532,7 +532,7 @@ In Share Permission Check scenario, different DACLs will be applied to SMB share
 | @0o2^w@w^-t%abwos31| | |  | 
 | | | Domain Users| | 
 
-#####Domain Groups
+##### Domain Groups
 
 | User Name| SID| Member Of| Attributes| 
 | -------------| -------------| -------------| ------------- |
@@ -541,7 +541,7 @@ In Share Permission Check scenario, different DACLs will be applied to SMB share
 
 * SID may be different in your environment.
 
-#####Share(s)
+##### Share(s)
 If MS-SRVS is supported by SUT, test suite can dynamically set Share Permissions using MS-SRVS. One share need to be exposed, named AzShare by default. Folder (NTFS) permission should be set to allow everyone to access it.
 Otherwise, 6 shares (AzShare01, …, AzShare06) are required. Share Permissions should be set respectively according to the Security Descriptor in each of the following tables. Folder (NTFS) permission should be set to allow everyone to access it.
 
@@ -621,15 +621,15 @@ In Folder Permission Check scenario, different DACLs will be applied to a shared
 
 #### <a name="_Toc427487709"/>Preconditions
 
-#####Domain Users
+##### Domain Users
 
 | User Name| SID| Member Of| Attributes| 
 | -------------| -------------| -------------| ------------- |
 | AzUser01| S-1-5-21-465464611-2451339954-1855217765-1106| AzGroup01|  | 
 | | | Domain Users| | 
 
 
-#####Domain Groups
+##### Domain Groups
 
 | User Name| SID| Member Of| Attributes| 
 | -------------| -------------| -------------| ------------- |
@@ -639,7 +639,7 @@ In Folder Permission Check scenario, different DACLs will be applied to a shared
 
 * SID may be different in your environment.
 
-#####Share(s)
+##### Share(s)
 One share need to be exposed, named AzFolder by default. Share Permission should be set to allow everyone to access it. Domain Admins should be granted Full Access permission to the folder.
 SMB2 SET_INFO is required to run these cases.
 
@@ -710,14 +710,14 @@ In File Permission Check scenario, files with different DACLs will be created in
 
 
 
-#####Domain Users
+##### Domain Users
 
 | User Name| SID| Member Of| Attributes| 
 | -------------| -------------| -------------| ------------- |
 | AzUser01| S-1-5-21-465464611-2451339954-1855217765-1106| AzGroup01|  | 
 | | | Domain Users| | 
 
-#####Domain Groups
+##### Domain Groups
 
 | User Name| SID| Member Of| Attributes| 
 | -------------| -------------| -------------| ------------- |
@@ -726,7 +726,7 @@ In File Permission Check scenario, files with different DACLs will be created in
 
 * SID may be different in your environment.
 
-#####Share(s)
+##### Share(s)
 One share need to be exposed, named AzFile by default. Share permission should be set to allow everyone accessing it. Domain Admins should be granted Full Access permission to the folder.
 SMB2 SET_INFO is required to run these cases.
 
@@ -799,7 +799,7 @@ In Claim-Based Access Control scenario, different Central Access Policies (CAPs)
 
 #### <a name="_Toc427487718"/>Preconditions
 
-#####Domain Users
+##### Domain Users
 
 | User Name| SID| Member Of| Attributes| 
 | -------------| -------------| -------------| ------------- |
@@ -824,7 +824,7 @@ In Claim-Based Access Control scenario, different Central Access Policies (CAPs)
 | noclaimuser| S-1-5-21-465464611-2451339954-1855217765-1607| Domain Users|  | 
 
 
-#####Domain Groups
+##### Domain Groups
 
 | User Name| SID| Member Of| Attributes| 
 | -------------| -------------| -------------| ------------- |
@@ -836,7 +836,7 @@ In Claim-Based Access Control scenario, different Central Access Policies (CAPs)
 
 * SID may be different in your environment.
 
-#####Claims
+##### Claims
 
 | Display Name| ID| Value Type| Comments| 
 | -------------| -------------| -------------| ------------- |
@@ -845,9 +845,9 @@ In Claim-Based Access Control scenario, different Central Access Policies (CAPs)
 
 
 
-#####Central Access Rules (CARs)
+##### Central Access Rules (CARs)
 
-######CountryCodeAnyOf156Or840
+###### CountryCodeAnyOf156Or840
 
 
 Target Resources: All Resources
@@ -858,7 +858,7 @@ Current Permissions:
 
 
 
-######CountryCodeEquals156AndITDepartmentRule
+###### CountryCodeEquals156AndITDepartmentRule
 
 
 Target Resources: All Resources
@@ -871,7 +871,7 @@ Current Permissions:
 
 
 
-######CountryCodeEquals156OrITDepartmentRule
+###### CountryCodeEquals156OrITDepartmentRule
 
 
 Target Resources: All Resources
@@ -882,7 +882,7 @@ Current Permissions:
 
 
 
-######CountryCodeEquals156Rule
+###### CountryCodeEquals156Rule
 
 
 Target Resources: All Resources
@@ -893,7 +893,7 @@ Current Permissions:
 
 
 
-######CountryCodeGreaterThan392Rule
+###### CountryCodeGreaterThan392Rule
 
 
 Target Resources: All Resources
@@ -904,7 +904,7 @@ Current Permissions:
 
 
 
-######CountryCodeGreaterThanOrEquals392Rule
+###### CountryCodeGreaterThanOrEquals392Rule
 
 
 Target Resources: All Resources
@@ -915,7 +915,7 @@ Current Permissions:
 
 
 
-######CountryCodeLessThan392Rule
+###### CountryCodeLessThan392Rule
 
 
 Target Resources: All Resources
@@ -926,7 +926,7 @@ Current Permissions:
 
 
 
-######CountryCodeLessThanOrEquals392Rule
+###### CountryCodeLessThanOrEquals392Rule
 
 
 Target Resources: All Resources
@@ -937,7 +937,7 @@ Current Permissions:
 
 
 
-######CountryCodeNotAnyOf156Or840Rule
+###### CountryCodeNotAnyOf156Or840Rule
 
 
 Target Resources: All Resources
@@ -948,7 +948,7 @@ Current Permissions:
 
 
 
-######CountryCodeNotEquals156Rule
+###### CountryCodeNotEquals156Rule
 
 
 Target Resources: All Resources
@@ -958,7 +958,7 @@ Current Permissions:
 ![image16](./image/Auth_ServerTestDesignSpecification/image16.png)
 
 
-#####Central Access Policies (CAPs)
+##### Central Access Policies (CAPs)
 
 
 | Name| Member Central Access Rules| 
@@ -978,11 +978,11 @@ Current Permissions:
 | CountryCodeEquals156OrITGroupPolicy| CountryCodeEquals156OrITGroupRule| 
 
 
-#####Share(s)
+##### Share(s)
 One share need to be exposed, named AzCBAC by default. Share Permission and Folder Permission should all be set to allow everyone to access it.
 SMB2 SET_INFO is required to run these cases.
 
-#####BVT cases
+##### BVT cases
 
 | &#32;| &#32;| &#32;| &#32;| &#32; |
 | -------------| -------------| -------------| -------------| ------------- |
@@ -994,7 +994,7 @@ SMB2 SET_INFO is required to run these cases.
 
 
 
-#####Other traditional cases
+##### Other traditional cases
 
 | &#32;| &#32;| &#32;| &#32;| &#32; |
 | -------------| -------------| -------------| -------------| ------------- |

diff --git a/TestSuites/FileServer/docs/FileServerTestDesignSpecification.md b/TestSuites/FileServer/docs/FileServerTestDesignSpecification.md
@@ -1,4 +1,4 @@
-#File Server Protocol Family Server Test Design Specification 
+# File Server Protocol Family Server Test Design Specification 
 
 ## Content
 

diff --git a/TestSuites/FileServer/docs/MS-FSA_ServerTestDesignSpecification.md b/TestSuites/FileServer/docs/MS-FSA_ServerTestDesignSpecification.md
@@ -23,7 +23,7 @@
         * [FileInfo_IsShortNameSupported](#FileInfo_IsShortNameSupported)
         * [FileInfo_FileIdInformationSupported](#FileInfo_FileIdInformationSupported)
         * [FileInfo_FileAccessInformationSupported](#FileInfo_FileAccessInformationSupported)
-        * [FileInfo_Set_FileBasicInformation](#FileInfo_Set_FileBasicInformation)
+        * [FileInfo_SetFileBasicInformationSupported](#FileInfo_SetFileBasicInformationSupported)
         * [FileInfo_CreationTime](#FileInfo_CreationTime)
     * [Scenarios for FileSystemInformation](#Scenarios-for-FileSystemInformation)
         * [FsInfo_FileFsAttributeInformation](#FsInfo_FileFsAttributeInformation)
@@ -57,7 +57,7 @@
         * [AlternateDataStream_FsControl](#AlternateDataStream_FsControl)
     * [Scenarios for Create and Query Directory](#Scenarios-for-Create-And-Query-Directory)
         * [Query Directory](#Scenario-QueryDirectory)
-    * [Scenarios for File and Directory Leasing](#Scenarios-for-File-And-Directory-Leasing)
+    * [Scenarios for File and Directory Leasing](#Test-cases-for-File-And-Directory-Leasing)
         * [CompareLeaseKeys](#CompareLeaseKeys)
     * [Other Scenarios](#Other-Scenarios)
         * [CreateFile_InvalidStreamName](#Scenario-CreateFile_InvalidStreamName)
@@ -110,16 +110,16 @@
             * [FileInfo_Query_FileNormalizedNameInfo_Dir](#FileInfo_Query_FileNormalizedNameInfo_Dir)
         * [FileAccessInformation](#FileAccessInformation)
             * [FileInfo_Query_FileAccessInformation_DataSuffix](#FileInfo_Query_FileAccessInformation_DataSuffix)
+        * [FileAlignmentInformation](#FileAlignmentInformation)
+            * [FileInfo_Query_FileAlignmentInformation](#FileInfo_Query_FileAlignmentInformation)
         * [FileAlternateNameInformation](#FileAlternateNameInformation)
             * [FileInfo_Query_FileAlternateNameInformation](#FileInfo_Query_FileAlternateNameInformation)
         * [FileInternalInformation](#FileInternalInformation)
             * [FileInfo_Query_FileInternalInformation](#FileInfo_Query_FileInternalInformation)
-        * [FilePositionInformation](#FilePositionInformation)
-            * [FileInfo_Query_FilePositionInformation](#FileInfo_Query_FilePositionInformation)
         * [FileModeInformation](#FileModeInformation)
             * [FileInfo_Query_FileModeInformation](#FileInfo_Query_FileModeInformation)
-        * [FileAlignmentInformation](#FileAlignmentInformation)
-            * [FileInfo_Query_FileAlignmentInformation](#FileInfo_Query_FileAlignmentInformation)
+        * [FilePositionInformation](#FilePositionInformation)
+            * [FileInfo_Query_FilePositionInformation](#FileInfo_Query_FilePositionInformation)
         * [FileBasicInformation](#FileBasicInformation)
             * [FileInfo_Set_FileBasicInformation_File_Negative](#FileInfo_Set_FileBasicInformation_File_Negative)
             * [FileInfo_Set_FileBasicInformation_Dir_Negative](#FileInfo_Set_FileBasicInformation_Dir_Negative)
@@ -176,7 +176,7 @@
             * [FsCtl_Set_Sparse_File_IsSparseFileSupported](#FsCtl_Set_Sparse_File_IsSparseFileSupported)
             * [FsCtl_Set_Sparse_Dir_IsSparseFileSupported](#FsCtl_Set_Sparse_Dir_IsSparseFileSupported)
         * [IsZeroDataSupported](#IsZeroDataSupported)
-            * [FsCtl_Set_ZeroData_File_IsZeroDataSupported](#FsCtl_Set_ZeroData_File_IsSetZeroDataSupported)
+            * [FsCtl_Set_ZeroData_File_IsZeroDataSupported](#FsCtl_Set_ZeroData_File_IsZeroDataSupported)
             * [FsCtl_Set_ZeroData_Dir_IsZeroDataSupported](#FsCtl_Set_ZeroData_Dir_IsZeroDataSupported)
         * [IsDuplicateExtentsToFileExSupported](#IsDuplicateExtentsToFileExSupported)
             * [BVT_FsCtl_DuplicateExtentsToFileEx_IsBasicSupported](#BVT_FsCtl_DuplicateExtentsToFileEx_IsBasicSupported)
@@ -1773,6 +1773,8 @@ There are 343 test cases in total:
 | | QueryInfo with FileInfoClass.FileAccessInformation|
 | | Verify server responses accordingly.|
 
+#### <a name="FileAlignmentInformation"/>FileAlignmentInformation
+
 ##### <a name="FileInfo_Query_FileAlignmentInformation"/>FileInfo_Query_FileAlignmentInformation
 
 | &#32;| &#32; |
@@ -1782,6 +1784,8 @@ There are 343 test cases in total:
 | | QueryInfo with FileInfoClass.FileAlignmentInformation|
 | | Verify server returned status and returned AlignmentRequirement and bytecount accordingly.|
 
+#### <a name="FileAlternateNameInformation"/>FileAlternateNameInformation
+
 ##### <a name="FileInfo_Query_FileAlternateNameInformation"/>FileInfo_Query_FileAlternateNameInformation
 
 | &#32;| &#32; |
@@ -1791,6 +1795,8 @@ There are 343 test cases in total:
 | | QueryInfo with FileInfoClass.FileAlternateNameInformation|
 | | Verify server returned status and altername accordingly.|
 
+#### <a name="FileInternalInformation"/>FileInternalInformation
+
 ##### <a name="FileInfo_Query_FileInternalInformation"/>FileInfo_Query_FileInternalInformation
 
 | &#32;| &#32; |
@@ -1800,6 +1806,8 @@ There are 343 test cases in total:
 | | QueryInfo with FileInfoClass.FileInternalInformation|
 | | Verify server returned status accordingly.|
 
+#### <a name="FileModeInformation"/>FileModeInformation
+
 ##### <a name="FileInfo_Query_FileModeInformation"/>FileInfo_Query_FileModeInformation
 
 | &#32;| &#32; |
@@ -1809,6 +1817,8 @@ There are 343 test cases in total:
 | | QueryInfo with FileInfoClass.FileModeInformation|
 | | Verify server returned status and verify the mode of FileModeInformation accordingly.|
 
+#### <a name="FilePositionInformation"/>FilePositionInformation
+
 ##### <a name="FileInfo_Query_FilePositionInformation"/>FileInfo_Query_FilePositionInformation
 
 | &#32;| &#32; |
@@ -4010,6 +4020,7 @@ There are 343 test cases in total:
 ##### <a name="CreateDirectory_InvalidColon"/>CreateDirectory_InvalidColon
 
 | &#32;| &#32; |
+| -------------| ------------- |
 | Description| Try to create a directory with invalid colon and expect failure.|
 | | Test environment: NTFS, ReFS, FAT32|
 | Message Sequence| Create a directory file with invalid colon|
@@ -4018,6 +4029,7 @@ There are 343 test cases in total:
 ##### <a name="CreateFile_InvalidColon"/>CreateFile_InvalidColon
 
 | &#32;| &#32; |
+| -------------| ------------- |
 | Description| Try to create a data with invalid colon and expect failure.|
 | | Test environment: NTFS, ReFS, FAT32|
 | Message Sequence| Create a data file with invalid colon|
@@ -4028,6 +4040,7 @@ There are 343 test cases in total:
 ##### <a name="CreateDirectory_EndWithBackSlash"/>CreateDirectory_EndWithBackSlash
 
 | &#32;| &#32; |
+| -------------| ------------- |
 | Description| Try to create a directory end with backslash and expect success.|
 | | Test environment: NTFS, ReFS, FAT32|
 | Message Sequence| Create a directory end with with backslash.|
@@ -4036,6 +4049,7 @@ There are 343 test cases in total:
 ##### <a name="CreateFile_EndWithInvalidBackSlash"/>CreateFile_EndWithInvalidBackSlash
 
 | &#32;| &#32; |
+| -------------| ------------- |
 | Description| Try to create a file end with invalid backslash and expect failure.|
 | | Test environment: NTFS, ReFS, FAT32|
 | Message Sequence| Create a data file end with invalid backslash.|
@@ -4044,6 +4058,7 @@ There are 343 test cases in total:
 ##### <a name="CreateFile_WithDoubleBackSlashInMiddle"/>CreateFile_WithDoubleBackSlashInMiddle
 
 | &#32;| &#32; |
+| -------------| ------------- |
 | Description| Try to create a file with double backslash in the middle and expect failure.|
 | | Test environment: NTFS, ReFS, FAT32|
 | Message Sequence| Create a file with double backslash in the middle.|