Local package source (#169)

* Added support for local package sources. Closes #168. * Updated the regression tests. * Copy packages on a local build. * Localization.
TQLApp · Dec 12, 2023 · b6fe80f · b6fe80f
1 parent 2edf257
commit b6fe80f
Show file tree

Hide file tree

Showing 25 changed files with 185 additions and 22 deletions.
diff --git a/scripts/Local-Build.ps1 b/scripts/Local-Build.ps1
@@ -13,6 +13,15 @@ Function Copy-Output([string]$From, [string]$Target)
     Copy-Item "$Global:Src\$From\bin\Release\net8.0-windows\*" -Destination $Target -Recurse
 }
 
+Function Copy-Packages([string]$Target)
+{
+    Write-Host "Copying NuGet packages"
+
+    [void](New-Item -Type directory $Target)
+
+    Get-ChildItem -Path $Global:Src -Recurse -Filter "*.nupkg" | Copy-Item -Destination $Target -Force
+}
+
 ################################################################################
 # ENTRY POINT
 ################################################################################
@@ -30,3 +39,5 @@ dotnet build -c Release -property:Version=999.0
 
 Copy-Output -From "Tql.App" -Target "$Global:Distrib\App"
 Copy-Output -From "Tql.DebugApp" -Target "$Global:Distrib\DebugApp"
+
+Copy-Packages -Target "$Global:Distrib\Packages"
diff --git a/specs/App - Quick Start/003-JIRA-setup.md b/specs/App - Quick Start/003-JIRA-setup.md
@@ -19,6 +19,8 @@ description: Validate that the quick start tutorial will set you up with JIRA.
 
 ## Successfully setup JIRA
 
+{% include Setup/Local-package-source.md %}
+
 | Action                                                                                        | Expected result                                                          |
 | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
 | Open the app. The quick start window opens.                                                   |                                                                          |

diff --git a/specs/App - Quick Start/004-Azure-DevOps-setup.md b/specs/App - Quick Start/004-Azure-DevOps-setup.md
@@ -20,6 +20,8 @@ description:
 
 ## Successfully setup Azure DevOps
 
+{% include Setup/Local-package-source.md %}
+
 | Action                                                                                        | Expected result                                                          |
 | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
 | Open the app.                                                                                 | The quick start window opens.                                            |

diff --git a/specs/App - Quick Start/005-GitHub-setup.md b/specs/App - Quick Start/005-GitHub-setup.md
@@ -19,6 +19,8 @@ description: Validate that the quick start tutorial will set you up with GitHub.
 
 ## Successfully setup GitHub
 
+{% include Setup/Local-package-source.md %}
+
 | Action                                                                                       | Expected result                                                          |
 | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
 | Open the app.                                                                                | The quick start window must open.                                        |

diff --git a/specs/App - Quick Start/007-Install-secondary-tool.md b/specs/App - Quick Start/007-Install-secondary-tool.md
@@ -17,6 +17,8 @@ description:
 
 ## Setup the quick start tutorial
 
+{% include Setup/Local-package-source.md %}
+
 {% include Setup/App/QuickStart/Reset-quick-start.md %}
 
 | Action                                                                                                                                     | Expected result                                                          |
@@ -35,6 +37,8 @@ description:
 
 ## Configure secondary tool
 
+{% include Setup/Local-package-source.md %}
+
 Validate that you can restart the tutorial, configuring a secondary tool:
 
 | Action                                                                                        | Expected result                                                  |

diff --git a/specs/Plugins - Azure DevOps/001-Installation.md b/specs/Plugins - Azure DevOps/001-Installation.md
@@ -14,6 +14,8 @@ description: Install the Azure DevOps plugin.
 
 ## Installation
 
+{% include Setup/Local-package-source.md %}
+
 | Action                                         | Expected result |
 | ---------------------------------------------- | --------------- |
 | Open the **Configuration** window.             |                 |

diff --git a/specs/Plugins - Azure/001-Installation.md b/specs/Plugins - Azure/001-Installation.md
@@ -14,6 +14,8 @@ description: Install the Azure plugin.
 
 ## Installation
 
+{% include Setup/Local-package-source.md %}
+
 | Action                                      | Expected result |
 | ------------------------------------------- | --------------- |
 | Open the **Configuration** window.          |                 |

diff --git a/specs/Plugins - Confluence/001-Installation.md b/specs/Plugins - Confluence/001-Installation.md
@@ -14,6 +14,8 @@ description: Install the Confluence plugin.
 
 ## Installation
 
+{% include Setup/Local-package-source.md %}
+
 | Action                                       | Expected result |
 | -------------------------------------------- | --------------- |
 | Open the **Configuration** window.           |                 |

diff --git a/specs/Plugins - GitHub/001-Installation.md b/specs/Plugins - GitHub/001-Installation.md
@@ -14,6 +14,8 @@ description: Install the GitHub plugin.
 
 ## Installation
 
+{% include Setup/Local-package-source.md %}
+
 | Action                                      | Expected result |
 | ------------------------------------------- | --------------- |
 | Open the **Configuration** window.          |                 |

diff --git a/specs/Plugins - JIRA/001-Installation.md b/specs/Plugins - JIRA/001-Installation.md
@@ -14,6 +14,8 @@ description: Install the JIRA plugin.
 
 ## Installation
 
+{% include Setup/Local-package-source.md %}
+
 | Action                                      | Expected result |
 | ------------------------------------------- | --------------- |
 | Open the **Configuration** window.          |                 |

diff --git a/specs/Plugins - Microsoft Teams/001-Installation.md b/specs/Plugins - Microsoft Teams/001-Installation.md
@@ -14,6 +14,8 @@ description: Install the Microsoft Teams plugin.
 
 ## Prerequisite
 
+{% include Setup/Local-package-source.md %}
+
 The demo plugin is necessary to get demo people directories.
 
 | Action                                      | Expected result |
@@ -26,6 +28,8 @@ The demo plugin is necessary to get demo people directories.
 
 ## Installation
 
+{% include Setup/Local-package-source.md %}
+
 | Action                                            | Expected result |
 | ------------------------------------------------- | --------------- |
 | Open the **Configuration** window.                |                 |

diff --git a/specs/Plugins - Outlook/001-Installation.md b/specs/Plugins - Outlook/001-Installation.md
@@ -14,6 +14,8 @@ description: Install the Outlook plugin.
 
 ## Installation
 
+{% include Setup/Local-package-source.md %}
+
 | Action                                      | Expected result |
 | ------------------------------------------- | --------------- |
 | Open the **Configuration** window.          |                 |

diff --git a/specs/_includes/Setup/Local-package-source.md b/specs/_includes/Setup/Local-package-source.md
@@ -0,0 +1,4 @@
+**Note:** These steps contain instructions to install a new package. If you have
+a local package source configured, packages from the local source will be marked
+with an orange label "Local". Use those instead of the verified one and accept
+the warning. The remainder of the steps should work as usual.
diff --git a/src/Tql.App/ConfigurationUI/PackageManagerConfigurationDto.cs b/src/Tql.App/ConfigurationUI/PackageManagerConfigurationDto.cs
@@ -70,11 +70,7 @@ public string? Password
 
     public PackageSourceDto()
     {
-        AddProperty(
-            nameof(Url),
-            p => ValidateNotEmpty(p) ?? ValidateUrl(p),
-            CoerceEmptyStringToNull
-        );
+        AddProperty(nameof(Url), ValidateNotEmpty, CoerceEmptyStringToNull);
         AddProperty(nameof(UserName), null, CoerceEmptyStringToNull);
         AddProperty(nameof(Password), null, CoerceEmptyStringToNull);
     }

diff --git a/src/Tql.App/ConfigurationUI/PluginsConfigurationControl.xaml b/src/Tql.App/ConfigurationUI/PluginsConfigurationControl.xaml
@@ -141,9 +141,28 @@
                                             <TextBlock
                                                 Foreground="White"
                                                 FontSize="8pt"
-                                                Margin="0,0,6,0">
-                                                Verified
-                                            </TextBlock>
+                                                Margin="0,0,6,0"
+                                                Text="{x:Static app:Labels.PluginsConfiguration_Verified}" />
+                                        </StackPanel>
+                                    </Border>
+                                    <Border
+                                        Visibility="{Binding IsLocal, Converter={StaticResource B2VConverter}}"
+                                        Background="#f89f49"
+                                        VerticalAlignment="Center"
+                                        CornerRadius="{Binding ActualHeight, RelativeSource={RelativeSource Self}, Converter={StaticResource HeightToRadiusConverter}}"
+                                        Margin="0,0,5,0"
+                                        support:PopoverToolTipUtils.PopoverToolTip="{DynamicResource LocalToolTip}">
+                                        <StackPanel Orientation="Horizontal">
+                                            <Image
+                                                Source="{DynamicResource ResourceKey=Folder}"
+                                                Height="9"
+                                                Width="9"
+                                                Margin="5,0,3,0" />
+                                            <TextBlock
+                                                Foreground="White"
+                                                FontSize="8pt"
+                                                Margin="0,0,6,0"
+                                                Text="{x:Static app:Labels.PluginsConfiguration_Local}" />
                                         </StackPanel>
                                     </Border>
 

diff --git a/src/Tql.App/ConfigurationUI/PluginsConfigurationControl.xaml.cs b/src/Tql.App/ConfigurationUI/PluginsConfigurationControl.xaml.cs
@@ -47,6 +47,11 @@ IUI ui
             "VerifiedToolTip",
             new PopoverToolTip(null, Labels.PluginsConfiguration_VerifiedToolTip)
         );
+        Resources.Add("Folder", Images.Folder);
+        Resources.Add(
+            "LocalToolTip",
+            new PopoverToolTip(null, Labels.PluginsConfiguration_LocalToolTip)
+        );
 
         SetSelectedTab(Tab.Browse);
     }

diff --git a/src/Tql.App/Images.cs b/src/Tql.App/Images.cs
@@ -64,4 +64,5 @@ private static DrawingImage LoadImage(string resourceName, Color? color)
         "Arrow Left.svg",
         Color.FromRgb(20, 79, 162)
     );
+    public static readonly DrawingImage Folder = GetImage("Folder.svg");
 }
diff --git a/src/Tql.App/Labels.Designer.cs b/src/Tql.App/Labels.Designer.cs
diff --git a/src/Tql.App/Labels.nl.resx b/src/Tql.App/Labels.nl.resx
@@ -822,4 +822,16 @@ Do you want to restart TQL to see if this resolves the issue?</comment>
     <value>Bestanden worden opgeschoond…</value>
     <comment>Original: Deleting unused files...</comment>
   </data>
+  <data name="PluginsConfiguration_Local" xml:space="preserve">
+    <value>Lokaal</value>
+    <comment>Original: Local</comment>
+  </data>
+  <data name="PluginsConfiguration_LocalToolTip" xml:space="preserve">
+    <value>De plug-in komt van een lokale pakketbron.</value>
+    <comment>Original: This plugin comes from a local package source.</comment>
+  </data>
+  <data name="PluginsConfiguration_Verified" xml:space="preserve">
+    <value>Geverifieerd</value>
+    <comment>Original: Verified</comment>
+  </data>
 </root>
diff --git a/src/Tql.App/Labels.resx b/src/Tql.App/Labels.resx
@@ -741,4 +741,13 @@ Do you want to restart TQL to see if this resolves the issue?</value>
   <data name="PackageStoreManager_DeletingUnusedFiles" xml:space="preserve">
     <value>Deleting unused files...</value>
   </data>
+  <data name="PluginsConfiguration_Local" xml:space="preserve">
+    <value>Local</value>
+  </data>
+  <data name="PluginsConfiguration_LocalToolTip" xml:space="preserve">
+    <value>This plugin comes from a local package source.</value>
+  </data>
+  <data name="PluginsConfiguration_Verified" xml:space="preserve">
+    <value>Verified</value>
+  </data>
 </root>
diff --git a/src/Tql.App/Resources/Folder.svg b/src/Tql.App/Resources/Folder.svg
diff --git a/src/Tql.App/Services/Packages/NuGet/NuGetClient.cs b/src/Tql.App/Services/Packages/NuGet/NuGetClient.cs
@@ -16,6 +16,8 @@
 
 namespace Tql.App.Services.Packages.NuGet;
 
+using PackageSource = global::NuGet.Configuration.PackageSource;
+
 // Heavily based on https://gist.github.com/cpyfferoen/74092a74b165e85aed5ca1d51973b9d2.
 
 internal class NuGetClient : IDisposable
@@ -48,7 +50,7 @@ ImmutableArray<string> systemPackageIds
 
         foreach (var source in configuration.Sources)
         {
-            var packageSource = new global::NuGet.Configuration.PackageSource(source.Source)
+            var packageSource = new PackageSource(source.Source)
             {
                 Credentials = source.Credentials
             };
@@ -90,7 +92,7 @@ ImmutableArray<string> systemPackageIds
         };
     }
 
-    public async Task<ImmutableArray<IPackageSearchMetadata>> SearchPackages(
+    public async Task<ImmutableArray<NuGetSearchResult>> SearchPackages(
         string nuGetOrgSearchTerm,
         string otherSearchTerm,
         bool includePrerelease,
@@ -99,7 +101,7 @@ public async Task<ImmutableArray<IPackageSearchMetadata>> SearchPackages(
         CancellationToken cancellationToken = default
     )
     {
-        var packages = ImmutableArray.CreateBuilder<IPackageSearchMetadata>();
+        var packages = ImmutableArray.CreateBuilder<NuGetSearchResult>();
 
         foreach (var remoteNuGetFeed in _remoteSourceRepositories)
         {
@@ -117,14 +119,15 @@ public async Task<ImmutableArray<IPackageSearchMetadata>> SearchPackages(
                 };
 
                 packages.AddRange(
-                    await searchResource.SearchAsync(
+                    from package in await searchResource.SearchAsync(
                         searchTerm,
                         searchFilter,
                         0,
                         maxResults,
                         _logger,
                         cancellationToken
                     )
+                    select new NuGetSearchResult(package, remoteNuGetFeed.PackageSource)
                 );
             }
             else
@@ -146,7 +149,9 @@ await searchResource.SearchAsync(
 
                 while (await enumerator.MoveNextAsync())
                 {
-                    packages.Add(enumerator.Current);
+                    packages.Add(
+                        new NuGetSearchResult(enumerator.Current, remoteNuGetFeed.PackageSource)
+                    );
                 }
             }
         }
@@ -397,3 +402,5 @@ public void PackageInstalled(object? sender, PackageIdentityEventArgs e)
         }
     }
 }
+
+internal record NuGetSearchResult(IPackageSearchMetadata Package, PackageSource Source);
diff --git a/src/Tql.App/Services/Packages/Package.cs b/src/Tql.App/Services/Packages/Package.cs
@@ -10,5 +10,6 @@ internal record Package(
     string Authors,
     ImageSource Icon,
     bool IsInstalled,
-    bool IsVerified
+    bool IsVerified,
+    bool IsLocal
 );