Create SandboxTest script #827

felipecrs · 2020-05-22T22:24:38Z

PS: check this comment if you want to use it before it gets merged.

Description

A new PowerShell script to test the installation of any Manifest in Windows Sandbox.

Usage

$ Get-Help .\Tools\SandboxTest.ps1
SandboxTest.ps1 [[-Manifest] <string>] [[-Script] <scriptblock>] [-MapFolder <string>] [<CommonParameters>]

Examples

$ .\Tools\SandboxTest.ps1 .\Tools\SandboxTest.ps1 .\manifests\GitHub\cli\0.10.1.yaml { gh --version }
--> Validating Manifest
Manifest validation succeeded.

--> Downloading dependencies

--> Starting Windows Sandbox, and:
    - Mounting the following directories:
      - C:\Users\felip\AppData\Local\Temp\SandboxTest as read-only
      - C:\Users\felip\Repos\winget-pkgs as read-and-write
    - Installing WinGet
    - Installing the Manifest .\manifests\GitHub\cli\0.10.1.yaml
    - Refreshing environment variables
    - Running the following script:

{
 gh --version
}

A GIF is worth a thousand words.

To-do list

Download winget .Appx files on the fly, including the dependencies such as the VCLibs (and remove them from git, of course)
Validate Manifest file with winget validate before pushing to Sandbox test
Install winget in Sandbox
Run winget install -m with the provided manifest file in Sandbox
Add ability to run the custom script as the last step in Sandbox
Automatically refresh the environment variables after installing the Manifest
Close Windows Sandbox automatically if needed
Provide a way to specify which folder to mount, default is the current

Fixes microsoft/winget-cli#253, despite personally I would love to see this integrated into winget-cli itself, so at least users would not need to clone the repository before testing.

Microsoft Reviewers: Open in CodeFlow

felipecrs · 2020-05-22T22:49:32Z

I need help with the winget validate, it always returns 0 as status code so I'm not sure how can I catch errors in it. Does anyone have any suggestions?

felipecrs · 2020-05-23T00:58:18Z

I also need to know where I can get the VCLibs and VCLibsUWP .Appx files, which need to be installed as dependencies for the DesktopAppInstaller. Does anyone know?

I tried the .Appx provided by this package, but they are not up-to-date and does not meet the requirements for the DesktopAppInstaller.

…o sandbox-test

chausner · 2020-05-23T18:25:36Z

Very cool. Thanks for sharing this prototype script!

I need help with the winget validate, it always returns 0 as status code so I'm not sure how can I catch errors in it. Does anyone have any suggestions?

Good point. winget validate should indeed exit with a non-zero error code if validation fails (I created issue microsoft/winget-cli#312). For now, you could just parse the output and look for the string "Manifest validation succeeded.".

chausner · 2020-05-23T18:53:46Z

I also need to know where I can get the VCLibs and VCLibsUWP .Appx files, which need to be installed as dependencies for the DesktopAppInstaller. Does anyone know?

I tried the .Appx provided by this package, but they are not up-to-date and does not meet the requirements for the DesktopAppInstaller.

People wanting to install Windows Terminal outside of the Store have run into the same issue. An up-to-date version of the dependencies is available in the Store: https://www.microsoft.com/store/productId/9NBLGGH4RV3K

Unfortunately, there does not seem to be a way to automate its installation. A manual workaround is described here.

felipecrs · 2020-05-23T21:49:39Z

Good point. winget validate should indeed exit with a non-zero error code if validation fails (I created issue microsoft/winget-cli#312). For now, you could just parse the output and look for the string "Manifest validation succeeded.".

Good idea! I did it.

felipecrs · 2020-05-23T21:58:26Z

People wanting to install Windows Terminal outside of the Store have run into the same issue. An up-to-date version of the dependencies is available in the Store: https://www.microsoft.com/store/productId/9NBLGGH4RV3K

I used https://store.rg-adguard.net/ to download the .Appx from the Store. However, despite the links for the .Appx are directly from Microsoft, they expire, so we can't use them for downloading.

We can still upload these two .Appx somewhere, such as in GitHub releases, but I don't know if this is allowed or not.

Unfortunately, there does not seem to be a way to automate its installation. A manual workaround is described here.

I had read this before, but I didn't get what was the manual workaround.

It seems that the Windows Terminal installer now ships the dependencies builtin, and if that's true, this could solve the problem. But an open point is that someone said the installer just tells the Store to download the dependencies automatically, if that's the case this wouldn't help since the Windows Sandbox doesn't have access to the Store.

…o sandbox-test

chausner · 2020-05-24T22:33:52Z

I also need to know where I can get the VCLibs and VCLibsUWP .Appx files, which need to be installed as dependencies for the DesktopAppInstaller. Does anyone know?

Since the script requires winget to be installed, those VCLibs dependencies should also be guaranteed to be present on the host system. I tried building the appx files from C:\ProgramFiles\WindowsApps\Microsoft.VCLibs.. by simply zipping the folders but for some reason the resulting appx files become corrupt. Even taking a valid appx, unzipping and zipping it again, makes them corrupt. Still trying to figure out why.

felipecrs · 2020-05-24T22:37:02Z

@chausner Right. But did you tried with the files in this PR? The binaries are in the branch until I solve that.

chausner · 2020-05-24T22:40:57Z

@chausner Right. But did you tried with the files in this PR? The binaries are in the branch until I solve that.

Yes, the current solution works fine (apart from this minor issue https://github.com/felipecassiors/winget-pkgs/pull/1). I was just checking if there is an alternative way to obtain the dependencies.

The dash character in -ExecutionPolicy was a special character which broke the command.

felipecrs · 2020-05-28T00:17:34Z

@chausner Can you please take a look now? I removed the binaries from the branch, and now the script is able to download them if needed.

The only thing missing now is the URLs for the VCLibs dependencies (not a problem if we can upload them to somewhere).

felipecrs · 2020-05-28T00:43:06Z

This PR is ready for review. And it's already usable.

Tools/SandboxTest.ps1

felipecrs · 2021-02-05T15:05:57Z

@Xeevis this is intended, we just rely on the status code returned by winget here. Providing a way to not fail on warnings would be a new CLI switch for winget itself, consider opening an Issue there if you think it's good.

felipecrs · 2021-02-05T15:08:16Z

I'll think about adding a switch to skip the validation, though. For now, you can do something like:

.\SandboxTest.ps1 { winget install -m 10.0.9.yaml }

As long as 10.0.9.yaml is in the current folder.

denelon · 2021-04-27T00:39:04Z

@felipecrs have you been able to confirm if this works for the current version of the client with the new manifest schema? I see this PR has been open for a long time. It might be time to consider merging this one :)

felipecrs · 2021-04-27T00:46:51Z

I'm going to try soon, @denelon.

…o sandbox-test

…ix manifest as folder

felipecrs · 2021-04-27T16:49:57Z

@denelon

Added -SkipManifestValidation (Create SandboxTest script #827 (comment))
Fix TLS issues with Invoke-WebRequest and GitHub API.
Fix checksum file name convention in the winget-cli GitHub releases
Fix issues with PowerShell 7 in my tests
Remove the unneeded VCLibs dependency which was using my own URL (yay!)
Add compatibility with the new manifest schema (folders instead of files)

I think it's good to merge!

denelon · 2021-04-27T17:15:31Z

@felipecrs how did you remove the dependency?

I'll ask one of the engineers to give this a review :)

felipecrs · 2021-04-27T18:08:49Z

how did you remove the dependency?

@denelon, well, it seems that the newest version of winget-cli does not depend on that specific appx anymore, I simply removed it, and it's working still.

palenshus · 2021-04-30T23:03:09Z

README.md

+
+Just provide the path to manifest as parameter:
+```powershell
+.\Tools\SandboxTest.ps1 <path-to-manifest>


I kept passing the manifest version file itself and validation kept failing, took me a while to realize this parameter expects the manifest version directory. I'd clarify that here and in the param help

@palenshus Well, my goal was to support the two kinds of manifests to keep backwards compatibility (it was files previously). Since you said you're not from the winget-cli team, it may be better to ask them about it.

@denelon, any suggestion?

If yet we decide to keep accepting both files and folders, the help can be surely enhanced to clarify that.

If you have a singleton manifest you can point to the file, but the directory option works for both cases.

I see, I was only trying it on multi-file schemas. I'd just make it take a directory in both cases for consistency. Winget will validate the directory and ensure that if the manifestType is singleton, then there's only the one file in there

Tools/SandboxTest.ps1

palenshus · 2021-04-30T23:06:06Z

Tools/SandboxTest.ps1

+if (-Not $SkipManifestValidation -And -Not [String]::IsNullOrWhiteSpace($Manifest)) {
+  Write-Host '--> Validating Manifest'
+
+  if (-Not (Test-Path -Path $Manifest)) {


I believe this should have -PathType Container now too?

Depends on the other conversation also.

palenshus · 2021-05-01T02:59:24Z

Tools/SandboxTest.ps1

+
+Param(
+  [Parameter(Position = 0, HelpMessage = "The Manifest to install in the Sandbox.")]
+  [String] $Manifest,


Shouldn't this be declared mandatory?

The purpose of the script is to be flexible. Some times you just want to open sandbox, have winget installed, the current folder mounted and mess with it freely, this allows:

> .\Tools\SandboxTest.ps1 # works > .\Tools\SandboxTest.ps1 -Script { winget install git; Update-Environment; git --version } # also works, no manifest

I see, I didn't realize that was an intended purpose, makes sense

palenshus · 2021-05-01T03:00:06Z

Tools/SandboxTest.ps1

+
+Get-ChildItem $tempFolder -Recurse -Exclude $dependencies.fileName | Remove-Item -Force -Recurse
+
+if (-Not [String]::IsNullOrWhiteSpace($Manifest)) {


Aside from making this mandatory in the params, I'd check this once up top and fail out if it's whitespace, then you don't have to keep checking it

Also depends on the other conversation, I guess.

Leaving manifest optional is fine

Tools/SandboxTest.ps1

palenshus · 2021-05-01T03:13:42Z

Tools/SandboxTest.ps1

+
+# Create Bootstrap script
+
+# See: https://stackoverflow.com/a/14382047/12156188


I'd rename this for a little more clarity. Maybe Update-EnvironmentVariables?

Also, this implementation seems a little less fraught to me? https://stackoverflow.com/a/22670892/892770

Update-EnvironmentVariables

Well, it's really a long string, especially if you consider that it will be typed manually. But that's how PowerShell is, I agree with this change.

Also, this implementation seems a little less fraught to me? https://stackoverflow.com/a/22670892/892770

Definitely. I don't know why I picked the first one, but I'll try and if it works I'll switch.

palenshus · 2021-05-01T03:14:32Z

Tools/SandboxTest.ps1

+
+
+
+


Why so much whitespace?

Because of this (the progress bar stays on the screen even after the completion):

One option would be to hide the progress bar though, but I just wanted to make the script as transparent as possible. I even though about turning on the PowerShell debug feature to output each command being runned, but it turned out to be too noisy.

What do you think?

Gotcha, keep it then no prob

palenshus · 2021-05-01T03:20:39Z

Very cool, this is super impressive! Just got a few comments here and there

felipecrs

Thank you so much for the comments, I'll work on them, but a few I still require some inputs.

palenshus

Looks good to me

The library dependencies have been removed.

Create SandboxTest script

f7ec04d

felipecrs changed the title ~~Create SandboxTest script~~ [WIP] Create SandboxTest script May 22, 2020

felipecrs added 2 commits May 22, 2020 19:39

Add missing appx dependencies

da8548d

Clear temp folder

e8ca1c4

felipecrs mentioned this pull request May 22, 2020

Test in Windows Sandbox microsoft/winget-cli#253

Closed

Merge branch 'master' of https://github.com/microsoft/winget-pkgs int…

ee50cb8

…o sandbox-test

felipecrs mentioned this pull request May 23, 2020

Add Android Studio #843

Closed

chausner mentioned this pull request May 23, 2020

winget should return a non-zero exit code if manifest validation fails microsoft/winget-cli#312

Closed

Validate manifest before pushing to sandbox

eea0fe4

Merge branch 'master' of https://github.com/microsoft/winget-pkgs int…

8efaeac

…o sandbox-test

chausner and others added 2 commits May 24, 2020 21:36

Fix invalid character in Sandbox.ps1

8f90038

The dash character in -ExecutionPolicy was a special character which broke the command.

Download dependencies on the fly

ef769c5

felipecrs changed the title ~~[WIP] Create SandboxTest script~~ Create SandboxTest script May 28, 2020

felipecrs added 2 commits May 27, 2020 21:11

remove vscode launch file

22c6233

Add newline in gitignore

42e8651

Fix when there is no temp folder

d72fcac

felipecrs added 2 commits May 27, 2020 21:54

Add Test in Sandbox to README

c3a12a0

Add some comments and enhance some messages

c825b3e

chausner reviewed May 28, 2020

View reviewed changes

Tools/SandboxTest.ps1 Outdated Show resolved Hide resolved

denelon added the Needs: Attention label Apr 27, 2021

Merge branch 'master' of https://github.com/microsoft/winget-pkgs int…

b607189

…o sandbox-test

ghost removed the Needs: Attention label Apr 27, 2021

felipecrs added 3 commits April 27, 2021 10:32

Add -SkipManifestValidation switch and fix checksum

cb06ad1

Fix TLS issues, handle PowerShell 7, remove unneeded VCLibs dep and f…

498374a

…ix manifest as folder

Restore file/folder check for manifest

76b44aa

Change checksum output filename

25df74c

palenshus suggested changes May 1, 2021

View reviewed changes

ghost added the Needs: author feedback label May 1, 2021

felipecrs commented May 1, 2021

View reviewed changes

ghost added Needs: Attention and removed Needs: author feedback labels May 1, 2021

Update Update-EnvironmentVariables function

ac75e09

palenshus reviewed May 3, 2021

View reviewed changes

denelon approved these changes May 3, 2021

View reviewed changes

denelon merged commit 9619e1a into microsoft:master May 3, 2021

felipecrs deleted the sandbox-test branch May 4, 2021 03:30

felipecrs mentioned this pull request Feb 16, 2022

Improve --include-unknown message microsoft/winget-cli#1946

Merged

2 tasks


		Get-ChildItem $tempFolder -Recurse -Exclude $dependencies.fileName \| Remove-Item -Force -Recurse

		if (-Not [String]::IsNullOrWhiteSpace($Manifest)) {


		# Create Bootstrap script

		# See: https://stackoverflow.com/a/14382047/12156188

Create SandboxTest script #827

Create SandboxTest script #827

Conversation

felipecrs commented May 22, 2020 • edited Loading

Description

Usage

Examples

To-do list

Microsoft Reviewers: Open in CodeFlow

felipecrs commented May 22, 2020

felipecrs commented May 23, 2020

chausner commented May 23, 2020 • edited Loading

chausner commented May 23, 2020

felipecrs commented May 23, 2020

felipecrs commented May 23, 2020 • edited Loading

chausner commented May 24, 2020

felipecrs commented May 24, 2020

chausner commented May 24, 2020

felipecrs commented May 28, 2020

felipecrs commented May 28, 2020 • edited Loading

felipecrs commented Feb 5, 2021

felipecrs commented Feb 5, 2021 • edited Loading

denelon commented Apr 27, 2021

felipecrs commented Apr 27, 2021

felipecrs commented Apr 27, 2021

denelon commented Apr 27, 2021

felipecrs commented Apr 27, 2021

Choose a reason for hiding this comment

felipecrs May 1, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

felipecrs May 1, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

palenshus commented May 1, 2021

felipecrs left a comment • edited Loading

Choose a reason for hiding this comment

palenshus left a comment

Choose a reason for hiding this comment

felipecrs commented May 22, 2020 •

edited

Loading

chausner commented May 23, 2020 •

edited

Loading

felipecrs commented May 23, 2020 •

edited

Loading

felipecrs commented May 28, 2020 •

edited

Loading

felipecrs commented Feb 5, 2021 •

edited

Loading

felipecrs May 1, 2021 •

edited

Loading

felipecrs May 1, 2021 •

edited

Loading

felipecrs left a comment •

edited

Loading