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] $AdditionalField
+        )
+
+        $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' -AdditionalField $additionalFields
+        ThenIssueHasField -Field 'comments'
+    }
+}

Tests/Get-YTProject.Tests.ps1

@@ -0,0 +1,96 @@
+Set-StrictMode -Version 'Latest'
+
+BeforeAll {
+    Set-StrictMode -Version 'Latest'
+
+    & (Join-Path -Path $PSScriptRoot -ChildPath 'Initialize-Test.ps1' -Resolve)
+
+    Clear-Project -Wait
+
+    function GivenProject
+    {
+        [CmdletBinding()]
+        param(
+            [String] $ShortName = 'GYTP1',
+            [String] $Name = 'Get-YTProject Test Project',
+            [String] $Leader = 'admin'
+        )
+
+        $script:projectShortName = $ShortName
+        New-YTProject -Session $script:session -ShortName $ShortName -Name $Name -Leader $Leader -Description 'This is a test project.'
+    }
+
+    function WhenGettingProject
+    {
+        [CmdletBinding()]
+        param(
+            [String] $ShortName,
+            [String] $AdditionalField
+        )
+
+        $script:result = Get-YTProject -Session $script:session @PSBoundParameters
+    }
+
+    function ThenReturns
+    {
+        [CmdletBinding()]
+        param(
+            [int] $Count,
+            [String[]] $ProjectWithShortName,
+            [String] $ProjectWithField
+        )
+
+        if ($Count)
+        {
+            $script:result | Should -Not -BeNullOrEmpty
+            if (Get-Member -Name Length -InputObject $script:result -ErrorAction SilentlyContinue)
+            {
+                $script:result.Length | Should -Be $Count
+            }
+            $idCount =
+                $script:result |
+                ForEach-Object { $_.id }  |
+                Select-Object -Unique |
+                Measure-Object |
+                Select-Object -ExpandProperty Count
+            $script:result | Should -HaveCount $idCount
+        }
+
+        if ($ProjectWithField)
+        {
+            $script:result.$ProjectWithField | Should -Not -BeNullOrEmpty
+        }
+
+        if ($ProjectWithShortName)
+        {
+            $script:result |
+                ForEach-Object { $_.shortName} |
+                Where-Object { $_ -in $ProjectWithShortName } |
+                Should -Not -BeNullOrEmpty
+        }
+    }
+}
+
+Describe 'Get-YTProject' {
+    BeforeEach {
+        $script:session = New-YTSession -Url $apiUrl -ApiToken $apiToken
+        $script:result = $null
+    }
+
+    It 'returns one project' {
+        GivenProject -ShortName 'GYTP1' -Name 'Get-YTProject Test Project' -Leader 'admin'
+        WhenGettingProject -ShortName 'GYTP1'
+        ThenReturns -Count 1 -ProjectWithShortName 'GYTP1'
+    }
+
+    It 'return all projects' {
+        GivenProject -ShortName 'GYTP2' -Name 'Get-YTProject Test Project' -Leader 'admin'
+        WhenGettingProject
+        ThenReturns -Count 2 -ProjectWithShortName 'GYTP1', 'GYTP2'
+    }
+
+    It 'should support additional fields' {
+        WhenGettingProject -ShortName 'GYTP1' -AdditionalField 'description'
+        ThenReturns -Count 2 -ProjectWithField 'description'
+    }
+}

Tests/Invoke-YTRestMethod.Tests.ps1

@@ -0,0 +1,48 @@
+Set-StrictMode -Version 'Latest'
+
+BeforeAll {
+    Set-StrictMode -Version 'Latest'
+
+    & (Join-Path -Path $PSScriptRoot -ChildPath 'Initialize-Test.ps1' -Resolve)
+}
+
+Describe 'Invoke-YTRestMethod' {
+    BeforeEach {
+        $script:session = New-YTSession -Url $apiUrl -ApiToken $apiToken
+    }
+
+    It 'should always make GET requests' {
+        $res = Invoke-YTRestMethod -Session $script:session -Name 'users/me' -Method Get
+        $res.id | Should -Not -BeNullOrEmpty
+        $res.'$type' | Should -Be 'Me'
+        $res = Invoke-YTRestMethod -Session $script:session -Name 'users/me' -Method Get -WhatIf
+        $res.id | Should -Not -BeNullOrEmpty
+        $res.'$type' | Should -Be 'Me'
+    }
+
+    It 'should not make POST requests with WhatIf' {
+        Clear-Project -Wait
+        New-YTProject -Session $script:session -Name 'Invoke-YTRestMethod' -ShortName 'IYTRM' -Leader 'admin'
+        $project = Invoke-YTRestMethod -Session $script:session -Name 'admin/projects?fields=id,name,shortName'
+        $issue = New-YTIssue -Session $script:session -Project $project -Summary 'Test Ticket' -Description 'This is a test ticket.'
+
+        # Should update issue summary
+        $res = Invoke-YTRestMethod -Session $script:session -Name "issues/$($issue.id)" -Body @{summary = "New Title"} -Method Post
+        $res | Should -Not -BeNullOrEmpty
+        $res.id | Should -Be $issue.id
+        $issue = Get-YTIssue -Session $script:session -IssueId $issue.id
+        $issue.summary | Should -Be "New Title"
+
+        # Should not update issue summary
+        Invoke-YTRestMethod -Session $script:session -Name "issues/$($issue.id)" -Body @{summary = "Another Title"} -Method Post -WhatIf
+        $issue = Get-YTIssue -Session $script:session -IssueId $issue.id
+        $issue.summary | Should -Be "New Title"
+    }
+
+    It 'should get projects' {
+        Clear-Project -Wait
+        New-YTProject -Session $script:session -Name 'Invoke-YTRestMethod' -ShortName 'IYTRM' -Leader 'admin'
+        $project = Invoke-YTRestMethod -Session $script:session -Name 'admin/projects?fields=id,name,shortName'
+        $project | Should -HaveCount 1
+    }
+}

Tests/New-YTIssue.Tests.ps1

@@ -0,0 +1,80 @@
+Set-StrictMode -Version 'Latest'
+
+BeforeAll {
+    Set-StrictMode -Version 'Latest'
+    & (Join-Path -Path $PSScriptRoot -ChildPath 'Initialize-Test.ps1' -Resolve)
+
+    $script:session = New-YTSession -Url $apiUrl -ApiToken $apiToken
+    Clear-Project -Wait
+
+    New-YTProject -Session $script:session -Leader 'admin' -Name 'New-YTIssue' -ShortName 'NYTI' -ErrorAction Stop | Out-Null
+
+    function WhenCreatingIssue
+    {
+        param(
+            [String] $WithSummary,
+            [String] $WithDescription,
+            [String] $InProject
+        )
+
+        $splat = @{}
+
+        if ($WithSummary)
+        {
+            $splat['Summary'] = $WithSummary
+        }
+
+        if ($WithDescription)
+        {
+            $splat['Description'] = $WithDescription
+        }
+
+        if ($InProject)
+        {
+            $splat['Project'] = $InProject
+        }
+
+
+        $script:result = New-YTIssue -Session $script:session @splat
+    }
+
+    function ThenIssue
+    {
+        [CmdletBinding()]
+        param(
+            [String] $Summary,
+            [String] $Description,
+            [String] $Project
+        )
+
+        $script:result.idReadable | Should -Not -BeNullOrEmpty
+        $issue = Get-YTIssue -Session $script:session -IssueId $script:result.idReadable
+
+        $issue.summary | Should -Be $Summary
+        $issue.project.shortName | Should -Be $Project
+        $issue.description | Should -Be $Description
+        $issue.reporter.name | Should -Be 'admin'
+    }
+}
+
+Describe 'New-YTIssue' {
+    BeforeEach {
+        $script:summary = $null
+        $script:description = $null
+        $script:project = $null
+    }
+
+    It 'should create a new issue' {
+        WhenCreatingIssue -WithSummary 'First YTAutomation Issue' -WithDescription 'This is the first issue created by the YouTrackAutomation module.' -InProject 'NYTI'
+        ThenIssue -Summary 'First YTAutomation Issue' -Description 'This is the first issue created by the YouTrackAutomation module.' -Project 'NYTI'
+    }
+
+    It 'should allow issues with the same summary and description' {
+        WhenCreatingIssue -WithSummary 'same summary' -WithDescription 'same description' -InProject 'NYTI'
+        ThenIssue -Summary 'same summary' -Description 'same description' -Project 'NYTI'
+        $initialIssueId = $script:result.idReadable
+        WhenCreatingIssue -WithSummary 'same summary' -WithDescription 'same description' -InProject 'NYTI'
+        ThenIssue -Summary 'same summary' -Description 'same description' -Project 'NYTI'
+        $script:result.idReadable | Should -Not -Be $initialIssueId
+    }
+}