Windows Protocol Test Suites

Windows Protocol Test Suites provide interoperability testing against the implementation of Windows open specifications including File Services, Identity Management, Remote Desktop and etc.

Originally developed for in-house testing of the Microsoft Open Specifications, Microsoft Protocol Test Suites have been used extensively during Plugfests and interoperability labs to test against partner implementations. A Test Suite evaluates whether a protocol or protocol family implementation meets certain interoperability requirements. Test Suites do not cover every protocol requirement and in no way certify an implementation, even if all tests pass. However, each test suite provides users with a useful indication of interoperability.

SMB1 Server Test Suite. It covers the requirements documented by [MS-SMB], and those documented by other protocols which are related to [MS-SMB], i.e. [MS-FSCC] and [MS-CIFS].
File Server Family Test Suite. It is designed to test implementations of file server protocol family including [MS-SMB2], [MS-DFSC], [MS-SWN], [MS-FSRVP], [MS-FSA], [MS-RSVD] and [MS-SQOS].
RDP Client Family Test Suite. It provides interoperability testing for client implementation of RDP family protocols including [MS-RDPBCGR], [MS-RDPEDISP], [MS-RDPEDYC], [MS-RDPEGFX], [MS-RDPEGT], [MS-RDPEI], [MS-RDPEMT], [MS-RDPEUDP], [MS-RDPEUSB], [MS-RDPEVOR] and [MS-RDPRFX].
RDP Server Family Test Suite. It provides interoperability testing for server implementation of RDP family protocols including [MS-RDPBCGR], [MS-RDPEDYC] and [MS-RDPEMT].
Kerberos Server Test Suite. It is designed to test server implementations of Kerberos protocols including [MS-KILE], [MS-KKDCP] and [MS-PAC].
SMBD Server Test Suite. It is designed to test the implementations of SMB2&3 direct (RDMA) protocol, as specified in [MS-SMBD] and [MS-SMB2].
Branch Cache Test Suite. It is designed to test the implementations of [MS-PCCRTP], [MS-PCCRR], [MS-PCHC] and [MS-PCCRC] protocol.
AZOD Test Suite. It is designed to test the implementations of [MS-AZOD] protocol.
ADFamily Test Suite. It is designed to test the implementations of the Active Directory protocols including [MS-ADTS], [MS-APDS], [MS-DRSR] [MS-FRS2], [MS-LSAD], [MS-LSAT], [MS-SAMR] and [MS-NRPC].
ADFSPIP Client Test Suite. It is designed to test the implementations of ADFS Proxy and Web Application Proxy integration, as described in [MS-ADFSPIP].
ADOD Test Suite. It is designed to test the implementations of [MS-ADOD] protocol.

Components

Windows Protocol Test Suites contain 4 components:

CommonScripts. Common scripts used by each test suite. Normally they're used to deploy the environment.
ProtocolTestManager. A UI tool to help you configure and run test cases.
ProtoSDK. The protocol library used by each test suite. It provides the data structures of the protocol messages, the methods to encode and decode the messages, the methods to send and receive messages and etc.
TestSuites. All Test Suites code and documents are saved here and categorized by folder representing each test suite.

Prerequisites

The Test Suites are developed and must be installed on a Windows platform. You should install the software listed below based on your testing purpose, including their own dependencies.

Visual Studio 2017 or higher (Visual Studio 2017 Community recommended), installed with these individual components from the installer:

Section	Individual Component in Visual Studio 2017	Individual Component in Visual Studio 2019	Run Windows Protocol Test Suites	Build Windows Protocol Test Suites from source code
.NET	.NET Framework 4.7.1 SDK	.NET Framework 4.7.1 SDK		Required
.NET	.NET Framework 4.7.1 targeting pack	.NET Framework 4.7.1 targeting pack	Required	Required
Compilers, build tools, and runtime	C# and Visual Basic Roslyn compilers	C# and Visual Basic Roslyn compilers		Required
Compilers, build tools, and runtime	VC++ 2017 version 15.9 v14.16 latest v141 tools	MSVC v141 - VS 2017 C++ x64/x86 build tools (v14.16)		Required¹
Compilers, build tools, and runtime	Visual C++ 2017 Redistributable Update	C++ 2019 Redistributable Update	Required¹	Required¹
Debugging and testing	Testing tools core features		Required²	Required²
Developent Activities	Visual Studio C++ core features	C++ core features		Required¹
SDKs, libraries, and frameworks	Windows 10 SDK (10.0.16299.0) for Desktop C++ [x86 and x64]	Windows 10 SDK (10.0.16299.0)		Required¹

Note:

1: This individual component is required by ADFamily, MS-SMBD or Protocol Test Manager which have C++ code.

2: This individual component is installed in Visual Studio 2019 by default.

Spec Explorer 2010 v3.5.3146.0

It is only required if you want to build or run the test suites that contain Model-Based Test cases. If you want to regenerate Model-Based Test cases, you must install Visual Studio 2012.
Protocol Test Framework build 1.0 (build 1.0.7000.0)

You can use a released MSI file or build it from source code.
Enable .NET Framework 3.5.1
1. Turn Windows features on or off
2. Enable .NET Framework 3.5 (includes .NET 2.0 and 3.0)
This is necessary for WiX Toolset.
WiX Toolset v3.14
WiX Toolset Visual Studio 2017 Extension or Wix Toolset Visual Studio 2019 Extension

WiX Toolset components required if you want to build test suites or Protocol Test Manager from source code.
NuGet CLI

It is required if you want to build Protocol Test Manager. Please download nuget.exe into a suitable folder and add that folder to Path environment variable
Microsoft Message Analyzer

It is required if you want to build or run ADFamily, ADOD and AZOD test suites.
Open XML SDK

It is required if you want to build or run ADFamily test suite.
Network Direct DDK

From NetworkDirect_DDK.zip extract ndspi.h and ndstatus.h into project path ProtoSDK\RDMA\include. This is to build SMBD test suite.

You can use the script in InstallPrerequisites folder to automatically download and install these software.

Tips when using the script in InstallPrerequisites folder:

To run the script, open Windows PowerShell, and execute the commands below in the PowerShell Window:

cd WindowsProtocolTestSuites\InstallPrerequisites
.\InstallPrerequisites.ps1

If you meet errors about Execution Policy, make sure you run Windows PowerShell as Administrator, and type the following and enter:

Set-ExecutionPolicy RemoteSigned

You could run the command below to verify if the Execution Policy is correctly set:

Get-ExecutionPolicy

Then rerun the script.

Model-Based Testing

Some test suites use Model-Based Testing:

SMB1 Server Test Suite
File Server Family Test Suite
Kerberos Server Test Suite
SMBD Server Test Suite
BranchCache Server Test Suite
ADFamily Test Suite
ADFSPIP Client Test Suite
AZOD Test Suite
ADOD Test Suite

Build

After you clone a copy of this repo, you can run build.cmd for Protocol Test Manager and each test suite separately after you have installed all the softwares required for build listed in Prerequisites

Build Protocol Test Manager

cd WindowsProtocolTestSuites\ProtocolTestManager
build.cmd

After the build succeeds, the MSI file of Protocol Test Manager should be generated in the folder WindowsProtocolTestSuite\drop\ProtocolTestManager\installer\.

Build a test suite

cd WindowsProtocolTestSuites\TestSuites\MS-SMB\src
build.cmd

After the build succeeds, the MSI file of each test suite should be generated in the folder WindowsProtocolTestSuite\drop\TestSuites\\[TestSuiteName]\deploy\. Take SMB test suite as an example, MS-SMB-TestSuite-ServerEP.msi should be generated in the folder WindowsProtocolTestSuite\drop\TestSuites\MS-SMB\deploy\.

Upgrade from an older version

You can download and install the latest msi of test suites, Protocol Test Manager and Protocol Test Framework to upgrade them to the latest version. Or uninstall the old version and then install the new one.

Run

After the build succeeds, you could set up the test environment, install Protocol Test Manager and install/configure/run the test suite according to its User Guide. Each test suite has its own User Guide in the WindowsProtocolTestSuites\TestSuites\[TestSuiteName]\docs folder. There are two more documents in the same folder:

Technical Document. The Open Specifications documentation for protocols, published by Microsoft. It's the basis of developing Test Suites.
Test Design Spec. It provides information about the test scope and test suite design.

Contribute

You can find contributing guide here.

License

Windows Protocol Test Suites are under the MIT license.

Contact

The following resources are for Windows protocol test suite news, discussion, and support:

View news announcements in Open Specification Windows Protocols Forum.
Discuss test suites issues here on the github.
For Open Specifications Protocols support, contact dochelp@microsoft.com.

Microsoft Open Source Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

bhavesanjay/WindowsProtocolTestSuites