From 523c66a62a619e6aa9f30070173ea33edfb5e328 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sun, 29 Dec 2024 18:01:20 -0800 Subject: Rename "bundle id" concept to "bundle code" The "bundle id" always had more in common with the PackageCode from the Windows Installer. With the introduction of an actual Id attribute on the Bundle element, there is potential for confusion, so there is finally real motivation to rename "bundle id" to "bundle code". --- .../ForTestingUseOnlyBurnBackendExtension.cs | 2 +- .../ForTestingUseOnlyCompiler.cs | 10 ++++----- .../Symbols/ForTestingUseOnlyBundleSymbol.cs | 10 ++++----- .../BafRelatedBundleVariableTesting.cpp | 8 ++++---- .../MultipleBundlePackagesWithRemoteBundle.wxs | 4 ++-- .../TestData/DependencyTests/BundleF/BundleF.wxs | 24 +++++++++++----------- .../BundleF_AddOnA/BundleF_AddOnA.wxs | 2 +- .../BundleF_AddOnB/BundleF_AddOnB.wxs | 2 +- .../BundleF_PatchAv1_0_1/BundleF_PatchAv1_0_1.wxs | 2 +- .../BundleF_PatchAv1_0_2/BundleF_PatchAv1_0_2.wxs | 2 +- .../DependencyTests/BundleFv2/BundleFv2.wxs | 2 +- .../TestData/DependencyTests/BundleJ/BundleJ.wxs | 2 +- .../BundleJ_Patch/BundleJ_Patch.wxs | 2 +- src/test/burn/WixTestTools/BundleVerifier.cs | 12 +++++------ 14 files changed, 42 insertions(+), 42 deletions(-) (limited to 'src/test') diff --git a/src/test/burn/ForTestingUseOnlyExtension/ForTestingUseOnlyBurnBackendExtension.cs b/src/test/burn/ForTestingUseOnlyExtension/ForTestingUseOnlyBurnBackendExtension.cs index fff23274..cb97984f 100644 --- a/src/test/burn/ForTestingUseOnlyExtension/ForTestingUseOnlyBurnBackendExtension.cs +++ b/src/test/burn/ForTestingUseOnlyExtension/ForTestingUseOnlyBurnBackendExtension.cs @@ -37,7 +37,7 @@ namespace ForTestingUseOnly } var bundleSymbol = section.Symbols.OfType().Single(); - bundleSymbol.ProviderKey = bundleSymbol.BundleId = forTestingUseOnlyBundleSymbol.BundleId; + bundleSymbol.ProviderKey = bundleSymbol.BundleCode = forTestingUseOnlyBundleSymbol.BundleCode; } } } diff --git a/src/test/burn/ForTestingUseOnlyExtension/ForTestingUseOnlyCompiler.cs b/src/test/burn/ForTestingUseOnlyExtension/ForTestingUseOnlyCompiler.cs index 4963c941..f6ff7f87 100644 --- a/src/test/burn/ForTestingUseOnlyExtension/ForTestingUseOnlyCompiler.cs +++ b/src/test/burn/ForTestingUseOnlyExtension/ForTestingUseOnlyCompiler.cs @@ -32,7 +32,7 @@ namespace ForTestingUseOnly private void ParseForTestingUseOnlyBundleElement(Intermediate intermediate, IntermediateSection section, XElement element) { var sourceLineNumbers = this.ParseHelper.GetSourceLineNumbers(element); - string bundleId = null; + string bundleCode = null; foreach (var attrib in element.Attributes()) { @@ -41,7 +41,7 @@ namespace ForTestingUseOnly switch (attrib.Name.LocalName) { case "Id": - bundleId = this.ParseHelper.GetAttributeValue(sourceLineNumbers, attrib); + bundleCode = this.ParseHelper.GetAttributeValue(sourceLineNumbers, attrib); break; default: this.ParseHelper.UnexpectedAttribute(element, attrib); @@ -54,13 +54,13 @@ namespace ForTestingUseOnly } } - if (null == bundleId) + if (null == bundleCode) { this.Messaging.Write(ErrorMessages.ExpectedAttribute(sourceLineNumbers, element.Name.LocalName, "Id")); } else { - bundleId = Guid.Parse(bundleId).ToString("B").ToUpperInvariant(); + bundleCode = Guid.Parse(bundleCode).ToString("B").ToUpperInvariant(); } this.ParseHelper.ParseForExtensionElements(this.Context.Extensions, intermediate, section, element); @@ -69,7 +69,7 @@ namespace ForTestingUseOnly { section.AddSymbol(new ForTestingUseOnlyBundleSymbol(sourceLineNumbers, new Identifier(AccessModifier.Global, "ForTestingUseOnlyBundle")) { - BundleId = bundleId, + BundleCode = bundleCode, }); } } diff --git a/src/test/burn/ForTestingUseOnlyExtension/Symbols/ForTestingUseOnlyBundleSymbol.cs b/src/test/burn/ForTestingUseOnlyExtension/Symbols/ForTestingUseOnlyBundleSymbol.cs index a17dfe31..6cf9dabb 100644 --- a/src/test/burn/ForTestingUseOnlyExtension/Symbols/ForTestingUseOnlyBundleSymbol.cs +++ b/src/test/burn/ForTestingUseOnlyExtension/Symbols/ForTestingUseOnlyBundleSymbol.cs @@ -11,7 +11,7 @@ namespace ForTestingUseOnly ForTestingUseOnlySymbolDefinitionType.ForTestingUseOnlyBundle.ToString(), new[] { - new IntermediateFieldDefinition(nameof(ForTestingUseOnlyBundleSymbolFields.BundleId), IntermediateFieldType.String), + new IntermediateFieldDefinition(nameof(ForTestingUseOnlyBundleSymbolFields.BundleCode), IntermediateFieldType.String), }, typeof(ForTestingUseOnlyBundleSymbol)); } @@ -23,7 +23,7 @@ namespace ForTestingUseOnly.Symbols public enum ForTestingUseOnlyBundleSymbolFields { - BundleId, + BundleCode, } public class ForTestingUseOnlyBundleSymbol : IntermediateSymbol @@ -38,10 +38,10 @@ namespace ForTestingUseOnly.Symbols public IntermediateField this[ForTestingUseOnlyBundleSymbolFields index] => this.Fields[(int)index]; - public string BundleId + public string BundleCode { - get => this.Fields[(int)ForTestingUseOnlyBundleSymbolFields.BundleId].AsString(); - set => this.Set((int)ForTestingUseOnlyBundleSymbolFields.BundleId, value); + get => this.Fields[(int)ForTestingUseOnlyBundleSymbolFields.BundleCode].AsString(); + set => this.Set((int)ForTestingUseOnlyBundleSymbolFields.BundleCode, value); } } } diff --git a/src/test/burn/TestData/BAFunctionsTests/BafRelatedBundleVariableTesting/BafRelatedBundleVariableTesting.cpp b/src/test/burn/TestData/BAFunctionsTests/BafRelatedBundleVariableTesting/BafRelatedBundleVariableTesting.cpp index ba559b05..e65ac5ca 100644 --- a/src/test/burn/TestData/BAFunctionsTests/BafRelatedBundleVariableTesting/BafRelatedBundleVariableTesting.cpp +++ b/src/test/burn/TestData/BAFunctionsTests/BafRelatedBundleVariableTesting/BafRelatedBundleVariableTesting.cpp @@ -14,7 +14,7 @@ public: // IBAFunctions public: //IBootstrapperApplication virtual STDMETHODIMP OnDetectRelatedBundle( - __in_z LPCWSTR wzBundleId, + __in_z LPCWSTR wzBundleCode, __in BOOTSTRAPPER_RELATION_TYPE relationType, __in_z LPCWSTR wzBundleTag, __in BOOL fPerMachine, @@ -27,15 +27,15 @@ public: //IBootstrapperApplication HRESULT hr = S_OK; LPWSTR wzValue = NULL; - hr = BalGetRelatedBundleVariable(wzBundleId, STRING_VARIABLE, &wzValue); + hr = BalGetRelatedBundleVariable(wzBundleCode, STRING_VARIABLE, &wzValue); BalLog(BOOTSTRAPPER_LOG_LEVEL_STANDARD, "Retrieved related bundle variable with BAFunctions: AString = %ws, Error: 0x%x", wzValue, hr); - hr = BalGetRelatedBundleVariable(wzBundleId, NUMBER_VARIABLE, &wzValue); + hr = BalGetRelatedBundleVariable(wzBundleCode, NUMBER_VARIABLE, &wzValue); BalLog(BOOTSTRAPPER_LOG_LEVEL_STANDARD, "Retrieved related bundle variable with BAFunctions: ANumber = %ws, Error: 0x%x", wzValue, hr); - hr = __super::OnDetectRelatedBundle(wzBundleId, relationType, wzBundleTag, fPerMachine, wzVersion, fMissingFromCache, pfCancel); + hr = __super::OnDetectRelatedBundle(wzBundleCode, relationType, wzBundleTag, fPerMachine, wzVersion, fMissingFromCache, pfCancel); ReleaseStr(wzValue); return hr; diff --git a/src/test/burn/TestData/BundlePackageTests/MultipleBundlePackagesWithRemoteBundle/MultipleBundlePackagesWithRemoteBundle.wxs b/src/test/burn/TestData/BundlePackageTests/MultipleBundlePackagesWithRemoteBundle/MultipleBundlePackagesWithRemoteBundle.wxs index a0f42ee9..0d05700f 100644 --- a/src/test/burn/TestData/BundlePackageTests/MultipleBundlePackagesWithRemoteBundle/MultipleBundlePackagesWithRemoteBundle.wxs +++ b/src/test/burn/TestData/BundlePackageTests/MultipleBundlePackagesWithRemoteBundle/MultipleBundlePackagesWithRemoteBundle.wxs @@ -6,13 +6,13 @@ - + - + diff --git a/src/test/burn/TestData/DependencyTests/BundleF/BundleF.wxs b/src/test/burn/TestData/DependencyTests/BundleF/BundleF.wxs index cfeda6c4..51d6c508 100644 --- a/src/test/burn/TestData/DependencyTests/BundleF/BundleF.wxs +++ b/src/test/burn/TestData/DependencyTests/BundleF/BundleF.wxs @@ -3,18 +3,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + diff --git a/src/test/burn/TestData/DependencyTests/BundleF_AddOnA/BundleF_AddOnA.wxs b/src/test/burn/TestData/DependencyTests/BundleF_AddOnA/BundleF_AddOnA.wxs index 78c5493d..a808b124 100644 --- a/src/test/burn/TestData/DependencyTests/BundleF_AddOnA/BundleF_AddOnA.wxs +++ b/src/test/burn/TestData/DependencyTests/BundleF_AddOnA/BundleF_AddOnA.wxs @@ -5,7 +5,7 @@ - + diff --git a/src/test/burn/TestData/DependencyTests/BundleF_AddOnB/BundleF_AddOnB.wxs b/src/test/burn/TestData/DependencyTests/BundleF_AddOnB/BundleF_AddOnB.wxs index 5da954ea..24379a56 100644 --- a/src/test/burn/TestData/DependencyTests/BundleF_AddOnB/BundleF_AddOnB.wxs +++ b/src/test/burn/TestData/DependencyTests/BundleF_AddOnB/BundleF_AddOnB.wxs @@ -5,7 +5,7 @@ - + diff --git a/src/test/burn/TestData/DependencyTests/BundleF_PatchAv1_0_1/BundleF_PatchAv1_0_1.wxs b/src/test/burn/TestData/DependencyTests/BundleF_PatchAv1_0_1/BundleF_PatchAv1_0_1.wxs index e23c9f88..6458fc08 100644 --- a/src/test/burn/TestData/DependencyTests/BundleF_PatchAv1_0_1/BundleF_PatchAv1_0_1.wxs +++ b/src/test/burn/TestData/DependencyTests/BundleF_PatchAv1_0_1/BundleF_PatchAv1_0_1.wxs @@ -2,7 +2,7 @@ - + diff --git a/src/test/burn/TestData/DependencyTests/BundleF_PatchAv1_0_2/BundleF_PatchAv1_0_2.wxs b/src/test/burn/TestData/DependencyTests/BundleF_PatchAv1_0_2/BundleF_PatchAv1_0_2.wxs index b1f60b31..495798b5 100644 --- a/src/test/burn/TestData/DependencyTests/BundleF_PatchAv1_0_2/BundleF_PatchAv1_0_2.wxs +++ b/src/test/burn/TestData/DependencyTests/BundleF_PatchAv1_0_2/BundleF_PatchAv1_0_2.wxs @@ -2,7 +2,7 @@ - + diff --git a/src/test/burn/TestData/DependencyTests/BundleFv2/BundleFv2.wxs b/src/test/burn/TestData/DependencyTests/BundleFv2/BundleFv2.wxs index 509047d6..5dfff3e8 100644 --- a/src/test/burn/TestData/DependencyTests/BundleFv2/BundleFv2.wxs +++ b/src/test/burn/TestData/DependencyTests/BundleFv2/BundleFv2.wxs @@ -2,7 +2,7 @@ - + diff --git a/src/test/burn/TestData/DependencyTests/BundleJ/BundleJ.wxs b/src/test/burn/TestData/DependencyTests/BundleJ/BundleJ.wxs index 5207be28..febf46ea 100644 --- a/src/test/burn/TestData/DependencyTests/BundleJ/BundleJ.wxs +++ b/src/test/burn/TestData/DependencyTests/BundleJ/BundleJ.wxs @@ -2,7 +2,7 @@ - + diff --git a/src/test/burn/TestData/DependencyTests/BundleJ_Patch/BundleJ_Patch.wxs b/src/test/burn/TestData/DependencyTests/BundleJ_Patch/BundleJ_Patch.wxs index 3af7bbf2..889fdfbc 100644 --- a/src/test/burn/TestData/DependencyTests/BundleJ_Patch/BundleJ_Patch.wxs +++ b/src/test/burn/TestData/DependencyTests/BundleJ_Patch/BundleJ_Patch.wxs @@ -4,7 +4,7 @@ - + diff --git a/src/test/burn/WixTestTools/BundleVerifier.cs b/src/test/burn/WixTestTools/BundleVerifier.cs index b750c80c..da61d96e 100644 --- a/src/test/burn/WixTestTools/BundleVerifier.cs +++ b/src/test/burn/WixTestTools/BundleVerifier.cs @@ -62,7 +62,7 @@ namespace WixTestTools public string GetExpectedCachedBundlePath() { var bundleSymbol = this.GetBundleSymbol(); - var cachePath = this.GetPackageCachePathForCacheId(bundleSymbol.BundleId, bundleSymbol.PerMachine); + var cachePath = this.GetPackageCachePathForCacheId(bundleSymbol.BundleCode, bundleSymbol.PerMachine); return Path.Combine(cachePath, Path.GetFileName(this.Bundle)); } @@ -107,14 +107,14 @@ namespace WixTestTools { var bundleSymbol = this.GetBundleSymbol(); var x64 = bundleSymbol.Platform != Platform.X86; - var bundleId = bundleSymbol.BundleId; + var bundleCode = bundleSymbol.BundleCode; if (bundleSymbol.PerMachine) { - return BundleRegistration.TryGetPerMachineBundleRegistrationById(bundleId, x64, out registration); + return BundleRegistration.TryGetPerMachineBundleRegistrationById(bundleCode, x64, out registration); } else { - return BundleRegistration.TryGetPerUserBundleRegistrationById(bundleId, out registration); + return BundleRegistration.TryGetPerUserBundleRegistrationById(bundleCode, out registration); } } @@ -141,8 +141,8 @@ namespace WixTestTools public void VerifyUnregisteredAndRemovedFromPackageCache(string cachedBundlePath) { - Assert.False(this.TryGetRegistration(out _)); - Assert.False(File.Exists(cachedBundlePath)); + Assert.False(this.TryGetRegistration(out _), $"Bundle cached at '{cachedBundlePath}' should not still be registered."); + Assert.False(File.Exists(cachedBundlePath), $"Cached bundle should have been removed from package cache at '{cachedBundlePath}'."); } public void RemovePackageFromCache(string packageId) -- cgit v1.2.3-55-g6feb