|
| 1 | +# File Server Protocol Family Setup Script User Guide |
| 2 | + |
| 3 | +## 1. Introduction |
| 4 | + |
| 5 | +This guide provides instructions for using the automated setup scripts to configure test environments for the File Server Protocol Family Test Suite. These scripts automate many of the manual steps described in the [FileServerUserGuide.md](https://github.com/microsoft/WindowsProtocolTestSuites/blob/main/TestSuites/FileServer/docs/FileServerUserGuide.md). |
| 6 | + |
| 7 | +The scripts support three environment configurations: |
| 8 | +- **WORKGROUP** - Simple peer-to-peer environment with two machines |
| 9 | +- **DOMAIN** - Domain environment with three or more machines. Most closely resembles a real world environment containing a Domain Controller |
| 10 | +- **CLUSTER** - Domain environment with failover clustering for high availability testing |
| 11 | + |
| 12 | +**Tip** |
| 13 | + |
| 14 | +To learn more about the common environment in which test cases are run for all **Test Suites**, see the [Protocol Test Framework User Guide](https://github.com/microsoft/ProtocolTestFramework/blob/main/docs/PTFUserGuide.md). |
| 15 | + |
| 16 | + |
| 17 | +## 2. Prerequisites |
| 18 | + |
| 19 | +Before using these scripts, ensure you have: |
| 20 | +- Windows systems with supported operating systems |
| 21 | + - SUT: Windows Server 2012 R2 or later |
| 22 | + - Driver: Operating system that can install .NET 5.0 |
| 23 | + - Domain Controller (if applicable): Windows Server 2012 R2 or later |
| 24 | +- Network connectivity between all machines |
| 25 | +- Administrator access on all machines |
| 26 | +- Sufficient disk space (at least 60 GB per machine) |
| 27 | +- Windows PowerShell 5.1 or later |
| 28 | +- |
| 29 | +### Network Setup |
| 30 | + |
| 31 | +### Workgroup Network Environment |
| 32 | + |
| 33 | +-- **REFER to [FileServerUserGuide.md](https://github.com/microsoft/WindowsProtocolTestSuites/blob/main/TestSuites/FileServer/docs/FileServerUserGuide.md)** -- |
| 34 | + |
| 35 | +### Computer Setup |
| 36 | + |
| 37 | +### Workgroup Environment |
| 38 | +The WORKGROUP environment consists of two test machines as follows: |
| 39 | + |
| 40 | +- Driver computer - System on which the test suites will be installed and run |
| 41 | +- SUT computer - **S**ystem **U**nder **T**est |
| 42 | + |
| 43 | +Before you begin, create your configuration file. This will be used to configure your machines and the test suites. An example is provided in TestSuites\FileServer\Setup\Workgroup\BaseConfig.json |
| 44 | + |
| 45 | +Create Workgroup-Package.zip by running TestSuites\FileServer\Setup\Create-Package.ps1 -Scenario Workgroup -ConfigPath "Path to your\Config.json" |
| 46 | + |
| 47 | +Perform the following steps to set up the **SUT Computer**: |
| 48 | +1. Set up network as described in [Workgroup Network Environment](https://github.com/microsoft/WindowsProtocolTestSuites/blob/main/TestSuites/FileServer/docs/FileServerUserGuide.md#4.1) |
| 49 | +2. Enable Administrator Account, run these scripts using Admin Account |
| 50 | +3. Set Powershell Execution Policy Unrestricted [NOTE] Temporary Unrestricted while I restore signing pipeline |
| 51 | + ``` |
| 52 | + Set-ExecutionPolicy -ExecutionPolicy Unrestricted |
| 53 | + ``` |
| 54 | +4. Copy Workgroup-Package.zip into your SUT |
| 55 | +5. Extract in your working directory |
| 56 | +6. Run Configure_SUT.ps1 |
| 57 | +
|
| 58 | +Perform the following steps to set up the **Driver Computer**: |
| 59 | +1. Set up network as described in [Workgroup Network Environment](https://github.com/microsoft/WindowsProtocolTestSuites/blob/main/TestSuites/FileServer/docs/FileServerUserGuide.md#4.1) |
| 60 | +2. Enable Administrator Account, run these scripts using Admin Account |
| 61 | +3. Set Powershell Execution Policy |
| 62 | +4. Copy Workgroup-Package.zip into your Driver computer |
| 63 | +5. Extract in your working directory |
| 64 | +6. Run Configure_Driver.ps1 |
| 65 | +
|
| 66 | +
|
| 67 | +### Domain Environment |
| 68 | +
|
| 69 | +The DOMAIN environment consists of at least three test machines as follows: |
| 70 | +
|
| 71 | +- Domain Controller - Responds to security authentication requests such as logging in, checking permissions, and so on, within the domain. |
| 72 | +- Driver computer - System on which the test suites will be installed and run |
| 73 | +- SUT computer - **S**ystem **U**nder **T**est |
| 74 | +
|
| 75 | +Before you begin, create your configuration file. This will be used to configure your machines and the test suites. An example is provided in TestSuites\FileServer\Setup\Domain\BaseConfig.json |
| 76 | +
|
| 77 | +Create Domain-Package.zip by running TestSuites\FileServer\Setup\Create-Package.ps1 -Scenario Domain -ConfigPath "Path to your\Config.json" |
| 78 | +
|
| 79 | +
|
| 80 | +Perform the following steps to set up the Domain Controller: |
| 81 | +
|
| 82 | +1. Set up network as described in Domain Network Environment |
| 83 | +2. Set Powershell Execution Policy |
| 84 | +
|
| 85 | + `Set-ExecutionPolicy -ExecutionPolicy Unrestricted` |
| 86 | +
|
| 87 | +3. Copy Domain-Package.zip into your DC |
| 88 | +4. Extract in your working directory |
| 89 | +5. Run Configure_DC.ps1 |
| 90 | +
|
| 91 | +Your computer will restart several times but if configured correctly, will automatically log in and continue in the background. |
| 92 | +
|
| 93 | +Ensure your domain controller is fully set up before setting up the other machines. |
| 94 | +
|
| 95 | +
|
| 96 | +Perform the following steps to set up the SUT Computer: |
| 97 | +
|
| 98 | +1. Set up network as described in Domain Network Environment |
| 99 | +2. Enable Administrator Account, run these scripts using Admin Account |
| 100 | +3. Set Powershell Execution Policy Unrestricted [NOTE] Temporary Unrestricted while I restore signing pipeline |
| 101 | +
|
| 102 | + `Set-ExecutionPolicy -ExecutionPolicy Unrestricted` |
| 103 | +
|
| 104 | +4. Copy Domain-Package.zip into your SUT |
| 105 | +5. Extract in your working directory |
| 106 | +6. Run Configure_SUT.ps1 |
| 107 | +
|
| 108 | +Perform the following steps to set up the Driver Computer: |
| 109 | +
|
| 110 | +1. Set up network as described in Domain Network Environment |
| 111 | +2. Enable Administrator Account, run these scripts using Admin Account |
| 112 | +3. Set Powershell Execution Policy |
| 113 | +4. Copy Domain-Package.zip into your Driver computer |
| 114 | +5. Extract in your working directory |
| 115 | +6. Run Configure_Driver.ps1 |
| 116 | +
|
| 117 | +
|
| 118 | +### Cluster Environment |
| 119 | +
|
| 120 | +The CLUSTER environment consists of the following test machines: |
| 121 | +
|
| 122 | +- Domain Controller - Responds to security authentication requests such as logging in, checking permissions, and so on, within the domain. |
| 123 | +- Driver computer - System on which the test suites will be installed and run |
| 124 | +- SUT computer - **S**ystem **U**nder **T**est |
| 125 | +
|
| 126 | +Before you begin, create your configuration file. This will be used to configure your machines and the test suites. An example is provided in TestSuites\FileServer\Setup\Domain\BaseConfig.json |
| 127 | +
|
| 128 | +Create Domain-Package.zip by running TestSuites\FileServer\Setup\Create-Package.ps1 -Scenario Domain -ConfigPath "Path to your\Config.json" |
| 129 | +
|
| 130 | +
|
| 131 | +Perform the following steps to set up the Domain Controller: |
| 132 | +
|
| 133 | +1. Set up network as described in Domain Network Environment |
| 134 | +2. Set Powershell Execution Policy |
| 135 | +
|
| 136 | + `Set-ExecutionPolicy -ExecutionPolicy Unrestricted` |
| 137 | +
|
| 138 | +3. Copy Domain-Package.zip into your DC |
| 139 | +4. Extract in your working directory |
| 140 | +5. Run Configure_DC.ps1 |
| 141 | +
|
| 142 | +Your computer will restart several times but if configured correctly, will automatically log in and continue in the background. |
| 143 | +
|
| 144 | +Ensure your domain controller is fully set up before setting up the other machines. |
| 145 | +
|
| 146 | +
|
| 147 | +Perform the following steps to set up the SUT Computer: |
| 148 | +
|
| 149 | +1. Set up network as described in Domain Network Environment |
| 150 | +2. Enable Administrator Account, run these scripts using Admin Account |
| 151 | +3. Set Powershell Execution Policy Unrestricted [NOTE] Temporary Unrestricted while I restore signing pipeline |
| 152 | +
|
| 153 | + `Set-ExecutionPolicy -ExecutionPolicy Unrestricted` |
| 154 | +
|
| 155 | +4. Copy Domain-Package.zip into your SUT |
| 156 | +5. Extract in your working directory |
| 157 | +6. Run Configure_SUT.ps1 |
| 158 | +
|
| 159 | +Perform the following steps to set up the Driver Computer: |
| 160 | +
|
| 161 | +1. Set up network as described in Domain Network Environment |
| 162 | +2. Enable Administrator Account, run these scripts using Admin Account |
| 163 | +3. Set Powershell Execution Policy |
| 164 | +4. Copy Domain-Package.zip into your Driver computer |
| 165 | +5. Extract in your working directory |
| 166 | +6. Run Configure_Driver.ps1 |
0 commit comments