Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added script to convert the module to a script #26

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added script to convert the module to a script #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
536684e
Added script to convert the module to a script
c-wilkinson Apr 20, 2020
1a33a99
Merge pull request #1 from microsoft/master
c-wilkinson Apr 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Folding In Sandbox/Module/Private/GetFAH.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ function GetFAH
$installer_url = 'https://download.foldingathome.org/releases/public/release/fah-installer/windows-10-32bit/';

# Use regex to get the latest version from the FAH website.
$version = ((Invoke-WebRequest -Uri $installer_url -UseBasicParsing).Links | Where-Object {$_.href -match '^v\d+([.]\d+)?'} | ForEach-Object {[float]($_.href -replace '[^.\d]', '')} | Measure-Object -Max).Maximum;
$version = ((Invoke-WebRequest -Uri $installer_url -UseBasicParsing).Links | Where-Object {$_.href -match '^v\d+([.]\d+)?'} | ForEach-Object {($_.href -replace '[^.\d]', '')} | Measure-Object -Max).Maximum;
$installer = "$($installer_url)v$($version)/latest.exe";
$installer_size =(Invoke-WebRequest $installer -Method Head -UseBasicParsing).Headers.'Content-Length';
Write-Verbose "Using FAH v$version.";
Expand Down
34 changes: 34 additions & 0 deletions Folding In Sandbox/generate_script_from_module.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
cls
# Get file name for "sample" script
$FileName = "$PSScriptRoot\install_folding_sandbox_on_host.ps1"
if (Test-Path $FileName)
{
Remove-Item $FileName
}

# Stick requires in the sample script
Add-Content $FileName "#Requires -RunAsAdministrator`r`n";

# Grab the contents of the public function for the module - this assumes we're only going to have
# a single entry point for the module. If this changes, we'll need to revist this
$publicScript = (Get-Content "$PSScriptRoot\Module\Public\Start.ps1" -Raw).Replace("#Requires -RunAsAdministrator","").Replace("function Start","");
# Ugly way to find the parameter definitions for the top of the script
$startParameters = $publicScript.Substring($publicScript.IndexOf("[cmdletbinding()]"));
$scriptContents = ($startParameters -split "\)\n");
Add-Content $FileName $scriptContents[0];
Add-Content $FileName ")";

# Grab the contents of each of the private functions for the module and stick them in the sample script file
Get-ChildItem "$PSScriptRoot\Module\Private" -Filter *.ps1 |
Foreach-Object {
Add-Content $FileName (Get-Content $_.FullName -Raw).Replace("#Requires -RunAsAdministrator","");
}

$finalScriptContent = "";
for ($i=1; $i -le $scriptContents.Length; $i++)
{
$finalScriptContent += $scriptContents[$i];
$finalScriptContent += ")";
}

Add-Content $FileName $finalScriptContent.Substring(0, $finalScriptContent.Length-3);
310 changes: 209 additions & 101 deletions Folding In Sandbox/install_folding_sandbox_on_host.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,70 +1,33 @@
#Requires -RunAsAdministrator
#Requires -RunAsAdministrator

#For a custom username, add -username <your username> to the command execution
param(
[string]$username = 'wsandbox_anon',
[string]$team = '251561'
[cmdletbinding()]
param(
[Parameter(Mandatory=$false)][string]$username='wsandbox_anon',
[Parameter(Mandatory=$false)][string]$team='251561'

)
$ProgressPreference = 'SilentlyContinue' #Progress bar makes things way slower

# Ensure that virtualization is enbaled in BIOS.
Write-Output 'Verifying that virtualization is enabled in BIOS...'
if ((Get-CimInstance Win32_ComputerSystem).VirtualizationFirmwareEnabled -eq $false) {
Write-Output 'ERROR: Please Enable Virtualization capabilities in your BIOS settings...'
exit
}

# Ensure that virtualization is enbaled in Windows 10.
Write-Output 'Verifying that virtualization is enabled in Windows 10...'
if ((Get-CimInstance Win32_ComputerSystem).HypervisorPresent -eq $false) {
Write-Output 'ERROR: Please Enable Hyper-V in your Control Panel->Programs and Features->Turn Windows features on or off'
exit
}

# Determine if Windows Sandbox is enabled.
try{
Write-Output 'Checking to see if Windows Sandbox is installed...'
If ((Get-WindowsOptionalFeature -FeatureName 'Containers-DisposableClientVM' -Online).State -ne 'Enabled') {
Write-Output 'Windows Sandbox is not installed, attempting to install it (may require reboot)...'
if ((Enable-WindowsOptionalFeature -FeatureName 'Containers-DisposableClientVM' -All -Online -NoRestart).RestartNeeded) {
Write-Output 'Please reboot to finish installing Windows Sandbox, then re-run this script...'
exit
}
} else {
Write-Output 'Windows Sandbox already installed.'
}
}catch{
Write-Output 'ERROR: Please Enable Virtualization capabilities in your BIOS settings ,then re-run this script...'
exit
}

# Download the latest version of FAH.
Write-Output 'Checking for latest version of foldingathome...'
$installer_url = 'https://download.foldingathome.org/releases/public/release/fah-installer/windows-10-32bit/'

# Use regex to get the latest version from the FAH website.
$version = ((Invoke-WebRequest -Uri $installer_url -UseBasicParsing).Links | Where-Object {$_.href -match '^v\d+([.]\d+)?'} | ForEach-Object {($_.href -replace '[^.\d]', '')} | Measure-Object -Max).Maximum
$installer = "$($installer_url)v$($version)/latest.exe"
$installer_size =(Invoke-WebRequest $installer -Method Head -UseBasicParsing).Headers.'Content-Length'
Write-Output "Using FAH v$version."

# Check if the installer is present, download otherwise.
$working_dir = "$env:USERPROFILE\fah_conf"
$install_fname = 'folding_installer.exe'
If (!(test-path "$working_dir\$install_fname") -or (Get-ChildItem "$working_dir\$install_fname").Length -ne $installer_size ) {
Remove-Item "$working_dir\$install_fname" -Force -ErrorAction SilentlyContinue
Write-Output "Downloading latest folding executable: $working_dir\$install_fname"
Write-Output "Saving to $working_dir\$install_fname..."
New-Item -ItemType Directory -Force -Path $working_dir | Out-Null
Invoke-WebRequest -Uri $installer -OutFile "$working_dir\$install_fname"
}

# Create the FAH configuration file with the Windows Sandbox FAH team #251561.
Write-Output 'Creating init command...'
$conf_file = 'fah_sandbox_conf.xml'
Write-Output "Saved Folding@Home configuration file to $working_dir\$conf_file"
New-Item -Force -Path "$working_dir\$conf_file" -ItemType File
Set-Content -Path "$working_dir\$conf_file" -Value @"
function CreateFAHConf
{
<#
.SYNOPSIS
Create the FAH configuration file
.DESCRIPTION
Creates the configuration file used to run FAH
.EXAMPLE
C:\> CreateFAHConf -team '251561';
#>
[cmdletbinding()]
param(
[Parameter(Mandatory=$true)][string]$username,
[Parameter(Mandatory=$true)][string]$team
)
Write-Verbose 'Creating init command...';
$working_dir = "$env:USERPROFILE\fah_conf";
$conf_file = 'fah_sandbox_conf.xml';
Write-Verbose "Saved Folding@Home configuration file to $working_dir\$conf_file";
New-Item -Force -Path "$working_dir\$conf_file" -ItemType File | Out-Null;
Set-Content -Path "$working_dir\$conf_file" -Value @"
<config>
<user v='$username'/>
<team v='$team'/>
Expand All @@ -75,31 +38,41 @@ Set-Content -Path "$working_dir\$conf_file" -Value @"
<gpu v='true'/>
<open-web-control v='true'/>
</config>
"@
"@;
}


function CreateLogonScript
{
<#
Create the script that runs at logon. This script:
1. Starts the installer
2. Creates a volatile working directory
3. Copies the config into the working directory
4. Sets the firewall policies to let FAH run
5. Starts the FAH client
#>
Write-Output 'Creating init command...'
$logon_cmd = "$working_dir\init.cmd"
$wdg_install_dir = 'C:\users\wdagutilityaccount\desktop\fah_conf'
$wdg_working_dir = 'C:\users\wdagutilityaccount\desktop\fah_working_dir'
Write-Output "Saved logon script to $logon_cmd, this will be run upon starting Sandbox."
New-Item -Force -Path $logon_cmd -ItemType File
Set-Content -Path $logon_cmd -Value @"
.SYNOPSIS
Create the script that runs at logon
.DESCRIPTION
This script:
1. Starts the installer
2. Creates a volatile working directory
3. Copies the config into the working directory
4. Sets the firewall policies to let FAH run
5. Starts the FAH client
.EXAMPLE
C:\> CreateLogonScript;
#>
Write-Verbose 'Creating init command...'
$working_dir = "$env:USERPROFILE\fah_conf";
$conf_file = 'fah_sandbox_conf.xml';
$install_fname = 'folding_installer.exe';
$logon_cmd = "$working_dir\init.cmd"
$wdg_install_dir = 'C:\users\wdagutilityaccount\desktop\fah_conf'
$wdg_working_dir = 'C:\users\wdagutilityaccount\desktop\fah_working_dir'
Write-Verbose "Saved logon script to $logon_cmd, this will be run upon starting Sandbox."
New-Item -Force -Path $logon_cmd -ItemType File | Out-Null;
Set-Content -Path $logon_cmd -Value @"
start $wdg_install_dir\$install_fname /S
goto WAITLOOP

:WAITLOOP
if exist "C:\Program Files (x86)\FAHClient\FAHClient.exe" goto INSTALLCOMPLETE
ping -n 6 127.0.0.1 > nul
goto WAITLOOP

:INSTALLCOMPLETE
mkdir $wdg_working_dir
cd $wdg_working_dir
Expand All @@ -108,27 +81,162 @@ copy $wdg_install_dir\$conf_file $wdg_working_dir
netsh advfirewall firewall Add rule name="FAHClient" program="C:\Program Files (x86)\FAHClient\FAHClient.exe" action=allow dir=out
netsh advfirewall firewall Add rule name="FAHClient" program="C:\Program Files (x86)\FAHClient\FAHClient.exe" action=allow dir=in
start C:\"Program Files (x86)"\FAHClient\FAHClient.exe --config $wdg_working_dir\$conf_file
"@
"@;

# Create the Sandbox configuration file with the new working dir & LogonCommand.
$sandbox_conf = "$working_dir\fah_sandbox.wsb"
Write-Output "Creating sandbox configuration file to $sandbox_conf"
New-Item -Force -Path $sandbox_conf -ItemType File
Set-Content -Path $sandbox_conf -Value @"
# Create the Sandbox configuration file with the new working dir & LogonCommand.
$sandbox_conf = "$working_dir\fah_sandbox.wsb";
Write-Verbose "Creating sandbox configuration file to $sandbox_conf";
New-Item -Force -Path $sandbox_conf -ItemType File | Out-Null;
Set-Content -Path $sandbox_conf -Value @"
<Configuration>
<VGpu>Enable</VGpu>
<MappedFolders>
<MappedFolder>
<HostFolder>$working_dir</HostFolder>
<ReadOnly>true</ReadOnly>
</MappedFolder>
</MappedFolders>
<LogonCommand>
<Command>$wdg_install_dir\init.cmd</Command>
</LogonCommand>
<VGpu>Enable</VGpu>
<MappedFolders>
<MappedFolder>
<HostFolder>$working_dir</HostFolder>
<ReadOnly>true</ReadOnly>
</MappedFolder>
</MappedFolders>
<LogonCommand>
<Command>$wdg_install_dir\init.cmd</Command>
</LogonCommand>
</Configuration>
"@
"@;
}


function GetFAH
{
<#
.SYNOPSIS
Download the latest version of FAH
.DESCRIPTION
Check if the installer is present, download otherwise
.EXAMPLE
C:\> GetFAH;
#>
Write-Verbose 'Checking for latest version of foldingathome...';
$installer_url = 'https://download.foldingathome.org/releases/public/release/fah-installer/windows-10-32bit/';

# Use regex to get the latest version from the FAH website.
$version = ((Invoke-WebRequest -Uri $installer_url -UseBasicParsing).Links | Where-Object {$_.href -match '^v\d+([.]\d+)?'} | ForEach-Object {($_.href -replace '[^.\d]', '')} | Measure-Object -Max).Maximum;
$installer = "$($installer_url)v$($version)/latest.exe";
$installer_size =(Invoke-WebRequest $installer -Method Head -UseBasicParsing).Headers.'Content-Length';
Write-Verbose "Using FAH v$version.";

# Check if the installer is present, download otherwise.
$working_dir = "$env:USERPROFILE\fah_conf";
$install_fname = 'folding_installer.exe';
if (!(test-path "$working_dir\$install_fname") -or (Get-ChildItem "$working_dir\$install_fname").Length -ne $installer_size )
{
Remove-Item "$working_dir\$install_fname" -Force -ErrorAction SilentlyContinue;
Write-Verbose "Downloading latest folding executable: $working_dir\$install_fname";
Write-Verbose "Saving to $working_dir\$install_fname...";
New-Item -ItemType Directory -Force -Path $working_dir | Out-Null;
Invoke-WebRequest -Uri $installer -OutFile "$working_dir\$install_fname";
}
}


function VerifyBios
{
<#
.SYNOPSIS
Check BIOS
.DESCRIPTION
This function is used to ensure that virtualization is enbaled in BIOS.
.EXAMPLE
C:\> VerifyBios;
#>
[cmdletbinding()]
[OutputType([bool])]
param ()
# Ensure that virtualization is enbaled in BIOS.
Write-Output 'Verifying that virtualization is enabled in BIOS...'
if ((Get-CimInstance Win32_ComputerSystem).VirtualizationFirmwareEnabled -eq $false) {
Write-Output 'ERROR: Please Enable Virtualization capabilities in your BIOS settings...'
return $false
}

# Ensure that virtualization is enbaled in Windows 10.
Write-Output 'Verifying that virtualization is enabled in Windows 10...'
if ((Get-CimInstance Win32_ComputerSystem).HypervisorPresent -eq $false) {
Write-Output 'ERROR: Please Enable Hyper-V in your Control Panel->Programs and Features->Turn Windows features on or off'
return $false
}

return $true;
}

function VerifySandbox
{
<#
.SYNOPSIS
Check Windows Feature is enabled
.DESCRIPTION
This function is used to ensure that Windows Sandbox has been enabled
.EXAMPLE
C:\> VerifySandbox;
#>
[cmdletbinding()]
[OutputType([bool])]
param ()
Write-Verbose 'Checking to see if Windows Sandbox is installed...';
try
{
If ((Get-WindowsOptionalFeature -FeatureName 'Containers-DisposableClientVM' -Online).State -ne 'Enabled')
{
Write-Verbose 'Windows Sandbox is not installed, attempting to install it (may require reboot)...';
if ((Enable-WindowsOptionalFeature -FeatureName 'Containers-DisposableClientVM' -All -Online -NoRestart).RestartNeeded)
{
Write-Verbose 'Please reboot to finish installing Windows Sandbox, then re-run this script...'
return $false;
}

return $true;
}
else
{
Write-Verbose 'Windows Sandbox already installed.';
return $true;
}
}
catch
{
Write-Error 'ERROR: Please Enable Virtualization capabilities in your BIOS settings ,then re-run this script...';
return $false;
}
}
try
{
Write-Verbose 'Start process';
$ProgressPreference = 'SilentlyContinue'; #Progress bar makes things way slower
Write-Output 'Verify host system...';
$bios = VerifyBios;
if (-not $bios -or $bios -eq $false) {
throw 'ERROR: Please Enable Virtualization capabilities in your BIOS settings...';
}

$sandbox = VerifySandbox;
if (-not $sandbox -or $sandbox -eq $false) {
throw 'Please reboot to finish installing Windows Sandbox, then re-run this script...';
}

Write-Output 'Setup configuration...';
GetFAH;
CreateFAHConf -username $username -team $team;
CreateLogonScript;
$config = "$env:USERPROFILE\fah_conf\fah_sandbox.wsb";
Write-Verbose "Start-Process 'C:\WINDOWS\system32\WindowsSandbox.exe' -ArgumentList '$config';";
$proc = Start-Process 'C:\WINDOWS\system32\WindowsSandbox.exe' -ArgumentList $config;
do
{
start-sleep -Milliseconds 500;
}
until ($proc.HasExited);
}
catch
{
$ErrorMessage = $_.Exception.Message;
Write-Error $ErrorMessage;
}

# For convenience, start the Sandbox.
Write-Output 'Starting sandbox...'
Start-Process 'C:\WINDOWS\system32\WindowsSandbox.exe' -ArgumentList $sandbox_conf