Initial release

.gitignore

@@ -5,3 +5,6 @@
 /YouTrackAutomation/LICENSE.txt
 /YouTrackAutomation/NOTICE.txt
 /YouTrackAutomation/README.md
+/YouTrackAutomation/Bin
+/packages
+/youtrack-2024.2.37269

README.md

@@ -1,6 +1,6 @@
 # Overview
 
-The "YouTrackAutomation" module...
+The "YouTrackAutomation" module is a PowerShell module built to interface with the YouTrack REST API.
 
 # System Requirements
 
@@ -24,3 +24,17 @@ Import-Module -Name '.\YouTrackAutomation'
 ```
 
 # Commands
+
+## Creating a new session
+
+All commands require a `session` object in order to call them. Create a new session object using the `New-YTSession`
+command.
+
+## Interacting With API
+
+* `Get-YTIssue`
+* `Get-YTProject`
+* `Invoke-YTRestMethod`
+* `New-YTIssue`
+* `New-YTProject`
+* `New-YTSession`

Tests/Get-YTIssue.Tests.ps1

@@ -0,0 +1,66 @@
+Set-StrictMode -Version 'Latest'
+
+BeforeAll {
+    Set-StrictMode -Version 'Latest'
+
+    & (Join-Path -Path $PSScriptRoot -ChildPath 'Initialize-Test.ps1' -Resolve)
+
+    function WhenGettingIssue
+    {
+        [CmdletBinding()]
+        param(
+            [Parameter(Mandatory)]
+            [String] $IssueId,
+            [String] $AdditionalFields
+        )
+
+        $script:result = Get-YTIssue -Session $session @PSBoundParameters
+    }
+
+    function ThenIssueHasValue
+    {
+        [CmdletBinding()]
+        param(
+            [String] $Field,
+            [String] $Value
+        )
+
+        $script:result.$Field | Should -Be $Value
+    }
+
+    function ThenIssueHasField
+    {
+        [CmdletBinding()]
+        param(
+            [String] $Field
+        )
+
+        $script:result.$Field | Should -Not -BeNullOrEmpty
+    }
+}
+
+Describe 'Get-YTIssue' {
+    BeforeEach {
+        $script:session = New-YTSession -Url $apiUrl -ApiToken $apiToken
+    }
+
+    It 'should return an issue using the ''jira id''' {
+        WhenGettingIssue -IssueId '3-4'
+        ThenIssueHasValue -Field 'idReadable' -Value 'DEMO-5'
+        ThenIssueHasValue -Field 'id' -Value '3-4'
+        ThenIssueHasValue -Field 'summary' -Value 'First steps for project administrators'
+    }
+
+    It 'should return an issue using the ''issue key''' {
+        WhenGettingIssue -IssueId 'DEMO-1'
+        ThenIssueHasValue -Field 'id' -Value '3-0'
+        ThenIssueHasValue -Field 'idReadable' -Value 'DEMO-1'
+        ThenIssueHasValue -Field 'summary' -Value 'Launch YouTrack'
+    }
+
+    It 'should support additional fields' {
+        $additionalFields = 'comments(id,author(name),text,created,updated)'
+        WhenGettingIssue -IssueId 'DEMO-1' -AdditionalFields $additionalFields
+        ThenIssueHasField -Field 'comments'
+    }
+}

Tests/Get-YTProject.Tests.ps1

@@ -0,0 +1,99 @@
+Set-StrictMode -Version 'Latest'
+
+BeforeAll {
+    Set-StrictMode -Version 'Latest'
+
+    & (Join-Path -Path $PSScriptRoot -ChildPath 'Initialize-Test.ps1' -Resolve)
+
+    function GivenProject
+    {
+        [CmdletBinding()]
+        param(
+            [String] $ShortName = 'GYTP1',
+            [String] $Name = 'Get-YTProject Test Project',
+            [String] $Leader = 'admin'
+        )
+
+        New-YTProject -Session $script:session -ShortName $ShortName -Name $Name -Leader $Leader -Description 'This is a test project.'
+    }
+
+    function WhenGettingProject
+    {
+        [CmdletBinding()]
+        param(
+            [String] $ProjectShortName,
+            [String] $AdditionalFields
+        )
+
+        $script:result = Get-YTProject -Session $script:session @PSBoundParameters
+    }
+
+    function ThenProjectHasField
+    {
+        [CmdletBinding()]
+        param(
+            [String] $Field
+        )
+
+        $script:result.$Field | Should -Not -BeNullOrEmpty
+    }
+
+    function ThenProjectsReturned
+    {
+        [CmdletBinding()]
+        param(
+            [Int] $GreaterThanEqual = 1
+
+        )
+        $script:result | Should -Not -BeNullOrEmpty
+        if (Get-Member -Name Length -InputObject $script:result -ErrorAction SilentlyContinue)
+        {
+            $script:result.Length | Should -BeGreaterOrEqual $GreaterThanEqual
+        }
+        $idCount =
+            $script:result |
+            ForEach-Object { $_.id }  |
+            Select-Object -Unique |
+            Measure-Object |
+            Select-Object -ExpandProperty Count
+        $script:result | Should -HaveCount $idCount
+    }
+
+    function ThenProjectWithShortName
+    {
+        [CmdletBinding()]
+        param(
+            [String] $ShortName
+        )
+
+        $script:result |
+            ForEach-Object { $_.shortName} |
+            Where-Object { $_ -eq $ShortName } |
+            Should -Not -BeNullOrEmpty
+    }
+}
+
+Describe 'Get-YTIssue' {
+    BeforeEach {
+        $script:session = New-YTSession -Url $apiUrl -ApiToken $apiToken
+    }
+
+    It 'returns one project' {
+        GivenProject -ShortName 'GYTP1' -Name 'Get-YTProject Test Project' -Leader 'admin'
+        WhenGettingProject -ProjectShortName 'DEMO'
+        ThenProjectsReturned -GreaterThanEqual 1
+        ThenProjectWithShortName -ShortName 'DEMO'
+    }
+
+    It 'return all projects' {
+        WhenGettingProject
+        ThenProjectsReturned -GreaterThanEqual 2
+        ThenProjectWithShortName -ShortName 'DEMO'
+    }
+
+    It 'should support additional fields' {
+        WhenGettingProject -AdditionalFields 'description'
+        ThenProjectsReturned -GreaterThanEqual 2
+        $script:result | Where-Object {$_.shortName -eq 'GYTP1'} | ForEach-Object { $_.description } | Should -Not -BeNullOrEmpty
+    }
+}

Tests/Invoke-YTRestMethod.Tests.ps1

@@ -0,0 +1,75 @@
+Set-StrictMode -Version 'Latest'
+
+BeforeAll {
+    Set-StrictMode -Version 'Latest'
+
+    & (Join-Path -Path $PSScriptRoot -ChildPath 'Initialize-Test.ps1' -Resolve)
+
+    function MockIrm
+    {
+        param(
+            [Object] $MockWith,
+            [scriptblock] $ParameterFilter
+        )
+
+        $splat = @{}
+        if ($ParameterFilter)
+        {
+            $splat['ParameterFilter'] = $ParameterFilter
+        }
+
+        if ($MockWith)
+        {
+            $splat['MockWith'] = $MockWith
+        }
+
+
+        Mock -CommandName 'Invoke-RestMethod' -ModuleName 'YouTrackAutomation' @splat
+    }
+
+    function ThenRestMethodInvoked
+    {
+        param(
+            [int] $Times = 1,
+            [scriptblock] $ParameterFilter
+        )
+
+        $splat = @{}
+        if ($ParameterFilter)
+        {
+            $splat['ParameterFilter'] = $ParameterFilter
+        }
+
+        Should -Invoke 'Invoke-RestMethod' -ModuleName 'YouTrackAutomation' -Times $Times @splat
+    }
+
+    function ThenRestMethodNotInvoked
+    {
+        Should -Not -Invoke 'Invoke-RestMethod' -ModuleName 'YouTrackAutomation'
+    }
+}
+
+Describe 'Invoke-YTRestMethod' {
+    BeforeEach {
+        $script:session = New-YTSession -Url $apiUrl -ApiToken $apiToken
+    }
+
+    It 'should always make GET requests' {
+        MockIrm -MockWith { 'get-request' }
+        $res = Invoke-YTRestMethod -Session $script:session -Name 'wikis' -Method Get
+        $res | Should -Be 'get-request'
+        $res = Invoke-YTRestMethod -Session $script:session -Name 'wikis' -Method Get -WhatIf
+        $res | Should -Be 'get-request'
+        ThenRestMethodInvoked -Times 2
+
+    }
+
+    It 'should not make PUT requests with WhatIf' {
+        MockIrm -MockWith { 'put-request' }
+        $res = Invoke-YTRestMethod -Session $script:session -Name 'wikis' -Method Put
+        $res | Should -Be 'put-request'
+        $res = Invoke-YTRestMethod -Session $script:session -Name 'wikis' -Method Put -WhatIf
+        $res | Should -BeNullOrEmpty
+        ThenRestMethodInvoked -Times 1
+    }
+}