Skip to content

Commit

Permalink
Add Install, Update, Uninstall support
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasNieto committed Mar 24, 2024
1 parent bdf7820 commit 490f7ed
Show file tree
Hide file tree
Showing 9 changed files with 375 additions and 5 deletions.
126 changes: 126 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
name: CI

defaults:
run:
shell: pwsh

on:
push:
branches: [ main ]

pull_request:
branches: [ main ]

release:
types: [ published ]

jobs:
Build:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v3

- name: .NET Build
run: dotnet build --configuration Release

- name: Create module
run: |
New-Item module -ItemType Directory
$settings = Import-PowerShellDataFile ./BuildSettings.psd1
Copy-Item @settings
- name: Upload module
uses: actions/upload-artifact@v3
with:
name: module
path: ./module/

Test:
needs: Build
runs-on: windows-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v3

- name: Download module
uses: actions/download-artifact@v3
with:
name: module
path: C:\Users\runneradmin\Documents\PowerShell\Modules\AnyPackage.DotNet.Tool\

- name: Install AnyPackage module
run: Install-Module AnyPackage -Force -AllowClobber

- name: Test with Pester
run: |
$ht = Import-PowerShellDataFile PesterSettings.psd1
$config = New-PesterConfiguration $ht
Invoke-Pester -Configuration $config
Sign:
needs: Test
if: github.event_name == 'release' && github.event.action == 'published'
runs-on: windows-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v3

- name: Download module
uses: actions/download-artifact@v3
with:
name: module
path: module

- name: Import certificate
env:
CERTIFICATE_BASE64: ${{ secrets.CERTIFICATE_BASE64 }}
CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }}
CERTIFICATE_PASSWORD_KEY_BASE64: ${{ secrets.CERTIFICATE_PASSWORD_KEY_BASE64 }}
run: |
[convert]::FromBase64String($env:CERTIFICATE_BASE64) | Set-Content -Path cert.pfx -AsByteStream
$key = [convert]::FromBase64String($env:CERTIFICATE_PASSWORD_KEY_BASE64)
$password = ConvertTo-SecureString $env:CERTIFICATE_PASSWORD -Key $key
Import-PfxCertificate cert.pfx -Password $password -CertStoreLocation Cert:\CurrentUser\My
- name: Sign files
run: |
$config = Import-PowerShellDataFile SignSettings.psd1
$config['Certificate'] = Get-ChildItem Cert:\CurrentUser\My -CodeSigningCert
Set-Location .\module
Set-AuthenticodeSignature @config
- name: Create and sign catalog file
run: |
$config = Import-PowerShellDataFile SignSettings.psd1
$config['FilePath'] = 'AnyPackage.DotNet.Tool.cat'
$config['Certificate'] = Get-ChildItem Cert:\CurrentUser\My -CodeSigningCert
Set-Location .\module
New-FileCatalog $config['FilePath'] -CatalogVersion 2
Set-AuthenticodeSignature @config
- name: Upload module
uses: actions/upload-artifact@v3
with:
name: module-signed
path: ./module/

Publish:
needs: Sign
if: github.event_name == 'release' && github.event.action == 'published'
runs-on: ubuntu-latest
steps:

- name: Download module
uses: actions/download-artifact@v3
with:
name: module-signed
path: '~/.local/share/powershell/Modules/AnyPackage.DotNet.Tool'

- name: Install AnyPackage module
run: Install-Module AnyPackage -Force -AllowClobber

- name: Publish Module
env:
NUGET_KEY: ${{ secrets.NUGET_KEY }}
run: Publish-Module -Name AnyPackage.DotNet.Tool -NuGetApiKey $env:NUGET_KEY
40 changes: 40 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: "CodeQL"

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
schedule:
- cron: '32 19 * * 5'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
matrix:
language: [ 'csharp' ]

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}

- name: Autobuild
uses: github/codeql-action/autobuild@v2

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{matrix.language}}"
7 changes: 7 additions & 0 deletions BuildSettings.psd1
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@{
Path = @(
'./src/code/bin/Release/netstandard2.0/AnyPackage.DotNet.ToolProvider.dll',
'./src/AnyPackage.DotNet.Tool.psd1'
)
Destination = './module'
}
88 changes: 83 additions & 5 deletions src/code/AnyPackage.DotNet.ToolProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
namespace AnyPackage.Provider.DotNet
{
[PackageProvider(".NET Tool")]
public class ToolProvider : PackageProvider, IFindPackage, IGetPackage
public class ToolProvider : PackageProvider, IFindPackage, IGetPackage, IInstallPackage, IUpdatePackage, IUninstallPackage
{
public void FindPackage(PackageRequest request)
{
Expand Down Expand Up @@ -50,7 +50,7 @@ public void FindPackage(PackageRequest request)
if (!first)
{
dictionary["Versions"] = versions;
WritePackage(request, dictionary, versions);
WritePackageVersions(request, dictionary, versions);
}

first = false;
Expand Down Expand Up @@ -78,7 +78,7 @@ public void FindPackage(PackageRequest request)
if (!first)
{
dictionary["Versions"] = versions;
WritePackage(request, dictionary, versions);
WritePackageVersions(request, dictionary, versions);
}
}

Expand All @@ -96,7 +96,7 @@ public void GetPackage(PackageRequest request)

while ((line = reader.ReadLine()) is not null)
{
var match = Regex.Match(line, @"^(?<Name>\S+)\s+(?<Version>\d\\S+)\s+(?<Commands>.+)$");
var match = Regex.Match(line, @"^(?<Name>\S+)\s+(?<Version>\d\S+)\s+(?<Commands>.+)$");

if (match.Success && request.IsMatch(match.Groups["Name"].Value, match.Groups["Version"].Value))
{
Expand All @@ -113,7 +113,85 @@ public void GetPackage(PackageRequest request)
}
}

private void WritePackage(PackageRequest request, Dictionary<string, object> dictionary, Dictionary<PackageVersion, long> versions)
public void InstallPackage(PackageRequest request)
{
var args = $"tool install {request.Name} --global";

if (request.Version is not null)
{
args += $" --version {request.Version}";
}

if (request.Prerelease)
{
args += " --prerelease";
}

InvokeDotNet(request, args);
}

public void UninstallPackage(PackageRequest request)
{
var args = $"tool uninstall {request.Name} --global";
InvokeDotNet(request, args);
}

public void UpdatePackage(PackageRequest request)
{
var args = $"tool update {request.Name} --global";

if (request.Version is not null)
{
args += $" --version {request.Version}";
}

if (request.Prerelease)
{
args += " --prerelease";
}

InvokeDotNet(request, args);
}

private void InvokeDotNet(PackageRequest request, string args)
{
request.WriteVerbose($"Calling 'dotnet {args}'");

using var process = new Process();
process.StartInfo.Arguments = args;
process.StartInfo.FileName = "dotnet";
process.StartInfo.CreateNoWindow = true;
process.StartInfo.RedirectStandardOutput = true;
process.StartInfo.RedirectStandardError = true;
process.Start();
process.WaitForExit();

var output = process.StandardOutput.ReadToEnd();
var error = process.StandardError.ReadToEnd();

if (output.Length > 0)
{
request.WriteVerbose(output);
}

if (Regex.IsMatch(error, "could not be found"))
{
return;
}
else if (error.Length > 0)
{
throw new PackageProviderException(error);
}

var match = Regex.Match(output, @"Tool '(?<Name>\S+)'.+version '(?<Version>\S+)'");
var package = new PackageInfo(match.Groups["Name"].Value,
match.Groups["Version"].Value,
ProviderInfo);

request.WritePackage(package);
}

private void WritePackageVersions(PackageRequest request, Dictionary<string, object> dictionary, Dictionary<PackageVersion, long> versions)
{
foreach (var version in versions.Keys)
{
Expand Down
32 changes: 32 additions & 0 deletions test/Find-Package.Tests.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#Requires -Modules AnyPackage.DotNet.Tool

Describe Find-Package {
Context 'with -Prerelease parameter' {
It 'should return prerelease versions' {
Find-Package -Name PowerShell -Prerelease -WarningAction SilentlyContinue |
Select-Object -ExpandProperty Version |
Where-Object IsPrerelease -eq $true |
Should -Not -BeNullOrEmpty
}
}

Context 'with -Name parameter' {
It 'single name' {
Find-Package -Name powershell |
Should -Not -BeNullOrEmpty
}

It 'multiple names' {
Find-Package -Name powershell, microsoft.dotnet-interactive |
Select-Object -Property Name -Unique |
Should -HaveCount 2
}
}

Context 'with -Version parameter' {
It 'should return value' {
Find-Package -Name powershell -Version 7.4.1 |
Should -Not -BeNullOrEmpty
}
}
}
27 changes: 27 additions & 0 deletions test/Get-Package.Tests.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#Requires -Modules AnyPackage.DotNet.Tool

Describe Get-Package {
BeforeAll {
dotnet tool install powerprepare.app --global
dotnet tool install ib --global
}

AfterAll {
dotnet tool uninstall powerprepare.app --global
dotnet tool uninstall ib --global
}

Context 'with no parameters' {
It 'should return results' {
Get-Package |
Should -Not -BeNullOrEmpty
}
}

Context 'with -Name parameter' {
It 'should return powerprepare.app' {
Get-Package -Name powerprepare.app |
Should -Not -BeNullOrEmpty
}
}
}
21 changes: 21 additions & 0 deletions test/Install-Package.Tests.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#Requires -Modules AnyPackage.DotNet.Tool

Describe Install-Package {
AfterEach {
dotnet tool uninstall powerprepare.app --global
}

Context 'with -Name parameter' {
It 'should install' {
{ Install-Package -Name powerprepare.app } |
Should -Not -Throw
}
}

Context 'with -Version parameter' {
It 'should install' {
{ Install-Package -Name powerprepare.app -Version '1.0.1' -ErrorAction Stop } |
Should -Not -Throw
}
}
}
14 changes: 14 additions & 0 deletions test/Uninstall-Package.Tests.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#Requires -Modules AnyPackage.DotNet.Tool

Describe Uninstall-Package {
BeforeEach {
dotnet tool install powerprepare.app --global
}

Context 'with -Name parameter' {
It 'should uninstall' {
{ Uninstall-Package -Name powerprepare.app } |
Should -Not -Throw
}
}
}
Loading

0 comments on commit 490f7ed

Please sign in to comment.