Merge branch 'rename_type_prop' of https://github.com/anmenaga/DSC-New into rename_type_prop

Author: Andrew

.cargo/config.toml

@@ -5,9 +5,16 @@ registry-auth = true
 [registries]
 powershell = { index = "sparse+https://pkgs.dev.azure.com/powershell/PowerShell/_packaging/powershell/Cargo/index/" }
 
+[registry]
+global-credential-providers = ["cargo:token"]
+
 # Enable Control Flow Guard (needed for OneBranch's post-build analysis).
 [target.x86_64-pc-windows-msvc]
 rustflags = ["-Ccontrol-flow-guard", "-Ctarget-feature=+crt-static", "-Clink-args=/DYNAMICBASE /CETCOMPAT"]
 
 [target.aarch64-windows-msvc]
 rustflags = ["-Ccontrol-flow-guard", "-Ctarget-feature=+crt-static", "-Clink-args=/DYNAMICBASE"]
+
+# The following is only needed for release builds
+[source.crates-io]
+replace-with = "powershell"

.pipelines/DSC-Official.yml

@@ -141,13 +141,7 @@ extends:
             ob_restore_phase: true
         - pwsh: |
             Set-Location "$(Build.SourcesDirectory)/DSC"
-            Write-Host "Use 'powershell' CFS"
-            Add-Content -Path "./.cargo/config.toml" -Value '[source.crates-io]'
-            Add-Content -Path "./.cargo/config.toml" -Value 'replace-with = "powershell"'
-            Add-Content -Path "./.cargo/config.toml" -Value '[registry]'
-            Add-Content -Path "./.cargo/config.toml" -Value 'global-credential-providers = ["cargo:token"]'
-
-            ./build.ps1 -Release -Architecture $(buildName) -SkipLinkCheck
+            ./build.ps1 -Release -Architecture $(buildName) -SkipLinkCheck -UseCFS
           displayName: 'Build $(buildName)'
           env:
             ob_restore_phase: true
@@ -279,13 +273,7 @@ extends:
           env:
             ob_restore_phase: true
         - pwsh: |
-            Write-Host "Use 'powershell' CFS"
-            Add-Content -Path "./.cargo/config.toml" -Value '[source.crates-io]'
-            Add-Content -Path "./.cargo/config.toml" -Value 'replace-with = "powershell"'
-            Add-Content -Path "./.cargo/config.toml" -Value '[registry]'
-            Add-Content -Path "./.cargo/config.toml" -Value 'global-credential-providers = ["cargo:token"]'
-
-            ./build.ps1 -Release -Architecture x86_64-unknown-linux-gnu
+            ./build.ps1 -Release -Architecture x86_64-unknown-linux-gnu -UseCFS
             ./build.ps1 -PackageType tgz -Architecture x86_64-unknown-linux-gnu -Release
             Copy-Item ./bin/*.tar.gz "$(ob_outputDirectory)"
           displayName: 'Build x86_64-unknown-linux-gnu'
@@ -325,13 +313,7 @@ extends:
           env:
             ob_restore_phase: true
         - pwsh: |
-            Write-Host "Use 'powershell' CFS"
-            Add-Content -Path "./.cargo/config.toml" -Value '[source.crates-io]'
-            Add-Content -Path "./.cargo/config.toml" -Value 'replace-with = "powershell"'
-            Add-Content -Path "./.cargo/config.toml" -Value '[registry]'
-            Add-Content -Path "./.cargo/config.toml" -Value 'global-credential-providers = ["cargo:token"]'
-
-            ./build.ps1 -Release -Architecture aarch64-unknown-linux-gnu
+            ./build.ps1 -Release -Architecture aarch64-unknown-linux-gnu -UseCFS
             ./build.ps1 -PackageType tgz -Architecture aarch64-unknown-linux-gnu -Release
             Copy-Item ./bin/*.tar.gz "$(ob_outputDirectory)"
           displayName: 'Build aarch64-unknown-linux-gnu'
@@ -379,18 +361,7 @@ extends:
           env:
             ob_restore_phase: true
         - pwsh: |
-            Write-Host "Use 'powershell' CFS"
-            Add-Content -Path "./.cargo/config.toml" -Value '[source.crates-io]'
-            Add-Content -Path "./.cargo/config.toml" -Value 'replace-with = "powershell"'
-            Add-Content -Path "./.cargo/config.toml" -Value '[registry]'
-            Add-Content -Path "./.cargo/config.toml" -Value 'global-credential-providers = ["cargo:token"]'
-
-            $c = get-content "./.cargo/config.toml" | Out-String
-            Write-Host $c
-
-            $env:CARGO_HTTP_DEBUG=true
-            $env:CARGO_LOG='network=trace'
-            ./build.ps1 -Release -Architecture $(buildName)
+            ./build.ps1 -Release -Architecture $(buildName) -UseCFS
             ./build.ps1 -PackageType tgz -Architecture $(buildName) -Release
             Copy-Item ./bin/*.tar.gz "$(ob_outputDirectory)"
             Write-Host "##vso[artifact.upload containerfolder=release;artifactname=release]$(ob_outputDirectory)/DSC-$(PackageVersion)-$(buildName).tar.gz"

archive/registry/.cargo/config.toml

@@ -7,12 +7,13 @@ param(
     $architecture = 'current',
     [switch]$Clippy,
     [switch]$SkipBuild,
-    [ValidateSet('msix','msixbundle','tgz','zip')]
+    [ValidateSet('msix','msix-private','msixbundle','tgz','zip')]
     $packageType,
     [switch]$Test,
     [switch]$GetPackageVersion,
     [switch]$SkipLinkCheck,
-    [switch]$UseX64MakeAppx
+    [switch]$UseX64MakeAppx,
+    [switch]$UseCFS
 )
 
 if ($GetPackageVersion) {
@@ -171,6 +172,17 @@ if (!$SkipBuild) {
     }
     New-Item -ItemType Directory $target -ErrorAction Ignore > $null
 
+    if (!$UseCFS) {
+        # this will override the config.toml
+        Write-Host "Setting CARGO_SOURCE_crates-io_REPLACE_WITH to 'crates-io'"
+        ${env:CARGO_SOURCE_crates-io_REPLACE_WITH} = 'CRATESIO'
+        $env:CARGO_REGISTRIES_CRATESIO_INDEX = 'sparse+https://index.crates.io/'
+    } else {
+        Write-Host "Using CFS for cargo source replacement"
+        ${env:CARGO_SOURCE_crates-io_REPLACE_WITH} = $null
+        $env:CARGO_REGISTRIES_CRATESIO_INDEX = $null
+    }
+
     # make sure dependencies are built first so clippy runs correctly
     $windows_projects = @("pal", "registry", "reboot_pending", "wmi-adapter")
 
@@ -240,6 +252,7 @@ if (!$SkipBuild) {
 
             if ($LASTEXITCODE -ne 0) {
                 $failed = $true
+                break
             }
 
             $binary = Split-Path $project -Leaf
@@ -424,7 +437,7 @@ if ($packageType -eq 'msixbundle') {
     $msixPath = Join-Path $PSScriptRoot 'bin' 'msix'
     & $makeappx bundle /d $msixPath /p "$PSScriptRoot\bin\$packageName.msixbundle"
     return
-} elseif ($packageType -eq 'msix') {
+} elseif ($packageType -eq 'msix' -or $packageType -eq 'msix-private') {
     if (!$IsWindows) {
         throw "MSIX is only supported on Windows"
     }
@@ -433,21 +446,34 @@ if ($packageType -eq 'msixbundle') {
         throw 'MSIX requires a specific architecture'
     }
 
+    $isPrivate = $packageType -eq 'msix-private'
+
     $makeappx = Find-MakeAppx
     $makepri = Get-Item (Join-Path $makeappx.Directory "makepri.exe") -ErrorAction Stop
     $displayName = "DesiredStateConfiguration"
     $isPreview = $productVersion -like '*-*'
     $productName = "DesiredStateConfiguration"
     if ($isPreview) {
         Write-Verbose -Verbose "Preview version detected"
-        $productName += "-Preview"
+        if ($isPrivate) {
+            $productName += "-Private"
+        }
+        else {
+            $productName += "-Preview"
+        }
         # save preview number
         $previewNumber = $productVersion -replace '.*?-[a-z]+\.([0-9]+)', '$1'
         # remove label from version
         $productVersion = $productVersion.Split('-')[0]
         # replace revision number with preview number
         $productVersion = $productVersion -replace '(\d+)$', "$previewNumber.0"
-        $displayName += "-Preview"
+
+        if ($isPrivate) {
+            $displayName += "-Private"
+        }
+        else {
+            $displayName += "-Preview"
+        }
     }
     Write-Verbose -Verbose "Product version is $productVersion"
     $arch = if ($architecture -eq 'aarch64-pc-windows-msvc') { 'arm64' } else { 'x64' }
@@ -519,7 +545,7 @@ if ($packageType -eq 'msixbundle') {
         throw "Failed to create msix package"
     }
 
-    Write-Host -ForegroundColor Green "`nMSIX package is created at $packageName.msix"
+    Write-Host -ForegroundColor Green "`nMSIX package is created at $packageName"
 } elseif ($packageType -eq 'zip') {
     $zipTarget = Join-Path $PSScriptRoot 'bin' $architecture 'zip'
     if (Test-Path $zipTarget) {

build.ps1

@@ -26,6 +26,9 @@ fn main() {
     #[cfg(debug_assertions)]
     check_debug();
 
+    #[cfg(windows)]
+    check_store();
+
     if ctrlc::set_handler(ctrlc_handler).is_err() {
         error!("Error: Failed to set Ctrl-C handler");
     }
@@ -156,3 +159,38 @@ fn check_debug() {
         }
     }
 }
+
+// Check if the dsc binary parent process is WinStore.App or Exploerer.exe
+#[cfg(windows)]
+fn check_store() {
+    let message = r"
+DSC.exe is a command-line tool and cannot be run directly from the Windows Store or Explorer.
+Visit https://aka.ms/dscv3-docs for more information on how to use DSC.exe.
+
+Press any key to close this window
+";
+    let sys = System::new_with_specifics(RefreshKind::new().with_processes(ProcessRefreshKind::new()));
+    // get current process
+    let Ok(current_pid) = get_current_pid() else {
+        return;
+    };
+
+    // get parent process
+    let Some(current_process) = sys.process(current_pid) else {
+        return;
+    };
+    let Some(parent_process_pid) = current_process.parent() else {
+        return;
+    };
+    let Some(parent_process) = sys.process(parent_process_pid) else {
+        return;
+    };
+
+    // MS Store runs app using `sihost.exe`
+    if parent_process.name().to_lowercase() == "sihost.exe" || parent_process.name().to_lowercase() == "explorer.exe"{
+        eprintln!("{message}");
+        // wait for keypress
+        let _ = io::stdin().read(&mut [0u8]).unwrap();
+        exit(util::EXIT_INVALID_ARGS);
+    }
+}

dsc/.cargo/config.toml

@@ -43,6 +43,14 @@ Describe 'WindowsPowerShell adapter resource tests' {
         $res.actualState.result.properties.DestinationPath | Should -Be "$testFile"
     }
 
+    It 'Set works on Binary "File" resource' -Skip:(!$IsWindows){
+
+        $testFile = "$testdrive\test.txt"
+        $r = '{"DestinationPath":"' + $testFile.replace('\','\\') + '", type: File, contents: HelloWorld, Ensure: present}' | dsc resource set -r 'PSDesiredStateConfiguration/File'
+        $LASTEXITCODE | Should -Be 0
+        Get-Content -Raw -Path $testFile | Should -Be "HelloWorld"
+    }
+
     It 'Get works on traditional "Script" resource' -Skip:(!$IsWindows){
 
         $testFile = "$testdrive\test.txt"

dsc/src/main.rs

@@ -355,15 +355,15 @@ function Invoke-DscOperation {
                     $invokeResult = Invoke-DscResource -Method $Operation -ModuleName $cachedDscResourceInfo.ModuleName -Name $cachedDscResourceInfo.Name -Property $property
 
                     if ($invokeResult.GetType().Name -eq 'Hashtable') {
-                        $invokeResult.keys | ForEach-Object -Begin { $getDscResult = @{} } -Process { $getDscResult[$_] = $invokeResult.$_ }
+                        $invokeResult.keys | ForEach-Object -Begin { $ResultProperties = @{} } -Process { $ResultProperties[$_] = $invokeResult.$_ }
                     }
                     else {
                         # the object returned by WMI is a CIM instance with a lot of additional data. only return DSC properties
-                        $invokeResult.psobject.Properties.name | Where-Object { 'CimClass', 'CimInstanceProperties', 'CimSystemProperties' -notcontains $_ } | ForEach-Object -Begin { $getDscResult = @{} } -Process { $getDscResult[$_] = $invokeResult.$_ }
+                        $invokeResult.psobject.Properties.name | Where-Object { 'CimClass', 'CimInstanceProperties', 'CimSystemProperties' -notcontains $_ } | ForEach-Object -Begin { $ResultProperties = @{} } -Process { $ResultProperties[$_] = $invokeResult.$_ }
                     }
 
                     # set the properties of the OUTPUT object from the result of Get-TargetResource
-                    $addToActualState.properties = $getDscResult
+                    $addToActualState.properties = $ResultProperties
                 }
                 catch {
                     'ERROR: ' + $_.Exception.Message | Write-DscTrace
@@ -422,21 +422,19 @@ function Invoke-DscOperation {
 
                 # morph the INPUT object into a hashtable named "property" for the cmdlet Invoke-DscResource
                 $DesiredState.properties.psobject.properties | ForEach-Object -Begin { $property = @{} } -Process { $property[$_.Name] = $_.Value }
-
                 # using the cmdlet from PSDesiredStateConfiguration module in Windows
                 try {
-                    $getResult = $PSDesiredStateConfiguration.invoke({ param($Name, $Property) Invoke-DscResource -Name $Name -Method Get -ModuleName @{ModuleName = 'PSDesiredStateConfiguration'; ModuleVersion = '1.1' } -Property $Property -ErrorAction Stop }, $cachedDscResourceInfo.Name, $property )
-
-                    if ($getResult.GetType().Name -eq 'Hashtable') {
-                        $getResult.keys | ForEach-Object -Begin { $getDscResult = @{} } -Process { $getDscResult[$_] = $getResult.$_ }
+                    $invokeResult = Invoke-DscResource -Method $Operation -ModuleName $cachedDscResourceInfo.ModuleName -Name $cachedDscResourceInfo.Name -Property $property
+                    if ($invokeResult.GetType().Name -eq 'Hashtable') {
+                        $invokeResult.keys | ForEach-Object -Begin { $ResultProperties = @{} } -Process { $ResultProperties[$_] = $invokeResult.$_ }
                     }
                     else {
                         # the object returned by WMI is a CIM instance with a lot of additional data. only return DSC properties
-                        $getResult.psobject.Properties.name | Where-Object { 'CimClass', 'CimInstanceProperties', 'CimSystemProperties' -notcontains $_ } | ForEach-Object -Begin { $getDscResult = @{} } -Process { $getDscResult[$_] = $getResult.$_ }
+                        $invokeResult.psobject.Properties.name | Where-Object { 'CimClass', 'CimInstanceProperties', 'CimSystemProperties' -notcontains $_ } | ForEach-Object -Begin { $ResultProperties = @{} } -Process { $ResultProperties[$_] = $invokeResult.$_ }
                     }
 
                     # set the properties of the OUTPUT object from the result of Get-TargetResource
-                    $addToActualState.properties = $getDscResult
+                    $addToActualState.properties = $ResultProperties
                 }
                 catch {
                     'ERROR: ' + $_.Exception.Message | Write-DscTrace