Refactoring and adding unit tests to deployment #5853
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| // Copyright (c) Microsoft Corporation and Contributors. | ||
| // Licensed under the MIT License. | ||
|
|
||
| #include <pch.h> | ||
| #include <DeploymentActivityContext.h> | ||
| #include <PackageDefinitions.h> | ||
| #include <Deployer.h> | ||
| #include <PackageUtilities.h> | ||
| #include <PackageRegistrar.h> | ||
| #include <functional> | ||
|
|
||
| using namespace winrt; | ||
|
|
||
| namespace WindowsAppRuntime::Deployment::Deployer | ||
| { | ||
| // licenseFileSpec: This parameter specifies the file specification (e.g., path and pattern) for the license files to be retrieved. | ||
| // licenseFiles: This is an output parameter that will be populated with the names of the license files found matching the specified file specification. | ||
| HRESULT GetLicenseFiles(const std::wstring& licenseFileSpec, std::vector<std::wstring>& licenseFiles) | ||
| { | ||
| licenseFiles.clear(); | ||
|
|
||
| WIN32_FIND_DATA findFileData{}; | ||
| wil::unique_hfind hfind{ FindFirstFileW(licenseFileSpec.c_str(), &findFileData) }; | ||
| if (!hfind) | ||
| { | ||
| const auto lastError{ GetLastError() }; | ||
| RETURN_HR_IF_MSG(HRESULT_FROM_WIN32(lastError), (lastError != ERROR_FILE_NOT_FOUND) && (lastError != ERROR_PATH_NOT_FOUND), | ||
| "FindFirstFile:%ls", licenseFileSpec.c_str()); | ||
| return S_OK; | ||
| } | ||
| for (;;) | ||
| { | ||
| // Add the license file | ||
| licenseFiles.push_back(findFileData.cFileName); | ||
|
|
||
| // Next! (if any) | ||
| if (!FindNextFileW(hfind.get(), &findFileData)) | ||
| { | ||
| const auto lastError{ GetLastError() }; | ||
| RETURN_HR_IF(HRESULT_FROM_WIN32(lastError), lastError != ERROR_NO_MORE_FILES); | ||
| break; | ||
| } | ||
| } | ||
| return S_OK; | ||
| } | ||
|
|
||
| HRESULT InstallLicenses( | ||
| const std::vector<std::wstring>& licenseFiles, | ||
| std::filesystem::path licensePath, | ||
| ILicenseInstaller& licenseInstaller, | ||
| ::WindowsAppRuntime::Deployment::Activity::Context& initializeActivityContext | ||
| ) | ||
| { | ||
| initializeActivityContext.SetInstallStage(::WindowsAppRuntime::Deployment::Activity::DeploymentStage::InstallLicense); | ||
|
|
||
| // Deploy the licenses (if any) | ||
| for (const auto& licenseFileName : licenseFiles) | ||
| { | ||
| // Install the license file | ||
| auto licenseFileFullName{ licensePath }; | ||
| licenseFileFullName /= licenseFileName; | ||
|
|
||
| // initializeActivityContext.Reset(); --> Why are we reseting here? It clears out all the info. | ||
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| initializeActivityContext.SetCurrentResourceId(licenseFileFullName); | ||
|
|
||
| RETURN_IF_FAILED_MSG(licenseInstaller.InstallLicenseFile(licenseFileFullName.c_str()), | ||
| "LicenseFile:%ls", licenseFileFullName.c_str()); | ||
| } | ||
| return S_OK; | ||
| } | ||
|
|
||
| std::vector<DeploymentPackageArguments> GetDeploymentPackageArguments( | ||
| const std::wstring& frameworkPackageFullName, | ||
| ::WindowsAppRuntime::Deployment::Activity::Context& initializeActivityContext, | ||
| const std::function<std::wstring(const std::wstring&)>& getPackagePathFunc) | ||
| { | ||
| initializeActivityContext.Reset(); | ||
| initializeActivityContext.SetInstallStage(::WindowsAppRuntime::Deployment::Activity::DeploymentStage::GetPackagePath); | ||
|
|
||
| std::vector<DeploymentPackageArguments> deploymentPackageArguments; | ||
|
|
||
| const auto frameworkPath{ std::filesystem::path(getPackagePathFunc(frameworkPackageFullName)) }; | ||
| for (auto package : winrt::Microsoft::Windows::ApplicationModel::WindowsAppRuntime::implementation::c_targetPackages) | ||
| { | ||
| auto isSingleton{ CompareStringOrdinal(package.identifier.c_str(), -1, WINDOWSAPPRUNTIME_PACKAGE_SUBTYPENAME_SINGLETON, -1, TRUE) == CSTR_EQUAL }; | ||
|
|
||
| std::filesystem::path packagePath{}; | ||
|
|
||
| // If there is exisiting target package version higher than that of framework current version package, then re-register it. | ||
| // Otherwise, deploy the target msix package from the current framework package version. | ||
| auto existingPackageIfHigherVersion = winrt::Microsoft::Windows::ApplicationModel::WindowsAppRuntime::implementation::g_existingTargetPackagesIfHigherVersion.find(package.identifier); | ||
| auto useExistingPackageIfHigherVersion { existingPackageIfHigherVersion != winrt::Microsoft::Windows::ApplicationModel::WindowsAppRuntime::implementation::g_existingTargetPackagesIfHigherVersion.end() }; | ||
| if (useExistingPackageIfHigherVersion) | ||
| { | ||
| packagePath = std::filesystem::path(getPackagePathFunc(existingPackageIfHigherVersion->second)); | ||
| packagePath /= WINDOWSAPPRUNTIME_PACKAGE_MANIFEST_FILE; | ||
| } | ||
| else | ||
| { | ||
| packagePath = frameworkPath; | ||
| packagePath /= WINDOWSAPPRUNTIME_FRAMEWORK_PACKAGE_FOLDER; | ||
| packagePath /= package.identifier + WINDOWSAPPRUNTIME_FRAMEWORK_PACKAGE_FILE_EXTENSION; | ||
| } | ||
|
|
||
| deploymentPackageArguments.push_back(DeploymentPackageArguments{ package.identifier, packagePath, useExistingPackageIfHigherVersion, isSingleton }); | ||
| } | ||
|
|
||
| return deploymentPackageArguments; | ||
| } | ||
|
|
||
| HRESULT DeployPackages( | ||
| const std::vector<DeploymentPackageArguments>& deploymentPackageArguments, | ||
| const bool forceDeployment, | ||
| ::WindowsAppRuntime::Deployment::Activity::Context& initializeActivity, | ||
| const std::function<HRESULT()>& startupNotificationsLongRunningPlatformFunc | ||
| ) | ||
| { | ||
| for (auto package : deploymentPackageArguments) | ||
| { | ||
| initializeActivity.Reset(); | ||
| initializeActivity.SetInstallStage(::WindowsAppRuntime::Deployment::Activity::DeploymentStage::AddPackage); | ||
| initializeActivity.SetCurrentResourceId(package.packageIdentifier); | ||
| if (package.useExistingPackageIfHigherVersion) | ||
| { | ||
| initializeActivity.SetUseExistingPackageIfHigherVersion(); | ||
| } | ||
|
|
||
| // If the current application has runFullTrust capability, then Deploy the target package in a Breakaway process. | ||
| // Otherwise, call PackageManager API to deploy the target package. | ||
| // The Singleton package will always set true for forceDeployment and the running process will be terminated to update the package. | ||
| if (initializeActivity.GetIsFullTrustPackage()) | ||
| { | ||
|
|
||
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| RETURN_IF_FAILED(::WindowsAppRuntime::Deployment::PackageRegistrar::AddOrRegisterPackageInBreakAwayProcess( | ||
| package.packagePath, | ||
| package.useExistingPackageIfHigherVersion, | ||
| forceDeployment || package.isSingleton, | ||
| initializeActivity, | ||
| ::WindowsAppRuntime::Deployment::PackageRegistrar::GenerateDeploymentAgentPath() | ||
| )); | ||
| } | ||
| else | ||
| { | ||
| auto packageManager = winrt::Windows::Management::Deployment::PackageManager{}; | ||
| RETURN_IF_FAILED(::WindowsAppRuntime::Deployment::PackageRegistrar::AddOrRegisterPackage( | ||
| package.packagePath, | ||
| package.useExistingPackageIfHigherVersion, | ||
| forceDeployment || package.isSingleton, | ||
| packageManager, | ||
| initializeActivity | ||
| )); | ||
| } | ||
|
|
||
| // Always restart Push Notifications Long Running Platform when Singleton package is processed and installed. | ||
| if (package.isSingleton) | ||
| { | ||
| // wil callback is set up to log telemetry events for Push Notifications LRP. | ||
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| LOG_IF_FAILED_MSG(startupNotificationsLongRunningPlatformFunc(), "Restarting Notifications LRP failed in all 3 attempts."); | ||
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
|
|
||
| return S_OK; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| // Copyright (c) Microsoft Corporation and Contributors. | ||
| // Licensed under the MIT License. | ||
| #pragma once | ||
|
|
||
| #include <string> | ||
| #include <filesystem> | ||
| #include <vector> | ||
| #include <functional> | ||
| #include <DeploymentActivityContext.h> | ||
|
|
||
| namespace WindowsAppRuntime::Deployment::Deployer | ||
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| { | ||
| // Structure to hold deployment package arguments | ||
| struct DeploymentPackageArguments | ||
| { | ||
| const std::wstring packageIdentifier; | ||
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| const std::filesystem::path packagePath; | ||
| const bool useExistingPackageIfHigherVersion; | ||
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| const bool isSingleton; | ||
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| }; | ||
|
|
||
| // Proxy/Wrapper for license installer. Open possibility to add more methods if needed. | ||
| struct ILicenseInstaller | ||
| { | ||
| virtual HRESULT InstallLicenseFile(const std::wstring& licenseFilename) = 0; | ||
|
||
| }; | ||
|
|
||
| // Get license files from the specified path pattern | ||
| HRESULT GetLicenseFiles(const std::wstring& licenseFileSpec, std::vector<std::wstring>& licenseFiles); | ||
|
|
||
| // Install license files | ||
| HRESULT InstallLicenses( | ||
| const std::vector<std::wstring>& licenseFiles, | ||
| std::filesystem::path licensePath, | ||
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ILicenseInstaller& licenseInstaller, | ||
| ::WindowsAppRuntime::Deployment::Activity::Context& initializeActivityContext); | ||
|
|
||
| // Get deployment package arguments | ||
| std::vector<DeploymentPackageArguments> GetDeploymentPackageArguments( | ||
| const std::wstring& frameworkPackageFullName, | ||
| ::WindowsAppRuntime::Deployment::Activity::Context& initializeActivityContext, | ||
| const std::function<std::wstring(const std::wstring&)>& getPackagePathFunc); | ||
|
|
||
| // Package deployment | ||
| HRESULT DeployPackages( | ||
| const std::vector<DeploymentPackageArguments>& deploymentPackageArguments, | ||
| const bool forceDeployment, | ||
| ::WindowsAppRuntime::Deployment::Activity::Context& initializeActivity, | ||
| const std::function<HRESULT()>& startupNotificationsLongRunningPlatformFunc); | ||
| } | ||
guimafelipe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.