Initial release #1

CameronSWilliamson · 2024-08-05T22:47:50Z

Adding the following functions:

Get-YTIssue
Get-YTProject
Invoke-YTRestMethod
New-YTIssue
New-YTProject
New-YTSession

splatteredbits · 2024-08-22T18:33:40Z

Tests/Get-YTProject.Tests.ps1

+    It 'returns one project' {
+        GivenProject -ShortName 'GYTP1' -Name 'Get-YTProject Test Project' -Leader 'admin'
+        WhenGettingProject -ProjectShortName 'DEMO'
+        ThenProjectsReturned -GreaterThanEqual 1


I would combine the two ThenProject* functions into a single ThenReturns function:

ThenReturns -Count 2 ThenReturns -ProjectWithShortName 'DEMO'

Don't use GreaterThanEqual. Use an exact count. If you use greater than or equal to, if the API returns more than expected, tests will still pass.

splatteredbits · 2024-08-22T18:33:51Z

Tests/Get-YTProject.Tests.ps1

+    It 'return all projects' {
+        WhenGettingProject
+        ThenProjectsReturned -GreaterThanEqual 2
+        ThenProjectWithShortName -ShortName 'DEMO'


Assert both projects that get returned.

Tests/Invoke-YTRestMethod.Tests.ps1

splatteredbits · 2024-08-22T18:36:37Z

Tests/New-YTIssue.Tests.ps1

+    }
+
+    It 'should create a new issue' {
+        GivenSummary 'First YTAutomation Issue'


Remove tall these Given functions. Given functions should, in general, be used to setup the state of the system. These are better as parameters on WhenCreatingIssue.

WhenCreatingIssue -WithSummary '' -WithDescription '' -InProject ''

splatteredbits · 2024-08-22T18:37:47Z

Tests/New-YTIssue.Tests.ps1

+        GivenDescription 'This is the first issue created by the YouTrackAutomation module.'
+        GivenProjectShortName 'NYTI'
+        WhenCreatingIssue
+        ThenIssue


Add parameter users have to pass to assert the issue:

ThenIssue -Created -WithSummary '' -WithDescription '' -InProject ''

ThenIssue should make a call to YouTrack to get the issue.

splatteredbits · 2024-08-22T19:01:06Z

YouTrackAutomation/Functions/New-YTIssue.ps1

+
+        # The project that the issue will be created in. This should be the short name of the project.
+        [Parameter(Mandatory)]
+        [String] $Project,


We want to make as few web requests as possible, so either change this to ProjectID or allow users to pass a project object, short name, or ID. For the second object, change its type to Object then create a Resolve-YTProject function that handles that:

if ($Project | Get-Member -Name 'id') { return $Project.id } if ($Project -is [int] -or $Project -match '^\d+$' ) { return Get-YTProject -Session $Session -ID $Project } if ($Project -is [String]) { return Get-YTProject -Session $Session -ShortName $Project } Write-Error "Failed to resolve project ""${Project}"": expected an object with an `id` property, an integer ID, or a project short name."

YouTrackAutomation/Functions/New-YTProject.ps1

splatteredbits · 2024-08-22T19:03:43Z

YouTrackAutomation/Functions/New-YTProject.ps1

+
+    if ($Template)
+    {
+        $fields += "&template=$Template"


Encode $Template.

YouTrackAutomation/Functions/New-YTProject.ps1

splatteredbits · 2024-08-22T19:04:16Z

YouTrackAutomation/YouTrackAutomation.psd1

@@ -18,7 +18,7 @@
    RootModule = 'YouTrackAutomation.psm1'

    # Version number of this module.
-    ModuleVersion = '0.0.0'
+    ModuleVersion = '0.1.0'


…hods

…and parameters for all functions

splatteredbits · 2025-01-09T19:22:49Z

whiskey.yml

@@ -73,6 +74,10 @@ Build:
 - PublishPowerShellModule:
    Path: YouTrackAutomation

+- PowerShell:


Call reset.ps1 instead.

But consider removing? Do we really need to clean up on the build server? The VM we're using is going to get reaped by AppVeyor...

splatteredbits · 2025-01-09T19:26:32Z

init.ps1

+    Invoke-WebRequest -Uri "https://download-cdn.jetbrains.com/charisma/youtrack-${YouTrackVersion}.zip" -OutFile $archivePath
+}
+
+$dataArchivePath = Join-Path -Path $PSScriptRoot -ChildPath 'ytconfig.zip'


Check these files into source loose, not as a ZIP file. If/when we ever need to update them, we'll have to unzip this file, update them, then zip the file back up again. It makes it hard to see what changed with the config and why.

Ideally, we just commit the files we change/care about to get YT running/working.

splatteredbits · 2025-01-09T19:27:31Z

init.ps1

@@ -6,6 +7,9 @@ Gets your computer ready to develop the YouTrackAutomation module.
 The init.ps1 script makes the configuraion changes necessary to get your computer ready to develop for the
 YouTrackAutomation module. It:

+* Installs YouTrack to the current folder from an pre-configured YouTrack instance.


splatteredbits · 2025-01-09T19:28:40Z

init.ps1

@@ -6,6 +7,9 @@ Gets your computer ready to develop the YouTrackAutomation module.
 The init.ps1 script makes the configuraion changes necessary to get your computer ready to develop for the
 YouTrackAutomation module. It:

+* Installs YouTrack to the current folder from an pre-configured YouTrack instance.
+* Configures the YouTrack instance to use the default port of 8080 and listen on 'localhost'.
+* Sets up the default user account with the username 'admin' and password 'admin'.


Is there any way to generate a random password? Typically, I'll save the password to a .password file that gets ignored by source control.

It doesn't look to me like that is possible. I'll keep looking though.

YouTrackAutomation/en-US/about_YouTrackAutomation.help.txt

splatteredbits · 2025-01-09T21:24:49Z

YouTrackAutomation/Functions/Get-YTIssue.ps1

+    Gets an issue from YouTrack.
+
+    .DESCRIPTION
+    The `Get-YTIssue` function gets an issue from YouTrack using the issue ID or issue key. The function returns the


splatteredbits · 2025-01-09T21:25:56Z

YouTrackAutomation/Functions/Get-YTIssue.ps1

+        $fields += ",$($AdditionalField -join ',')"
+    }
+
+    $fields = [Uri]::EscapeUriString($fields)


Should be [Uri]::EscapeDataString($fields).

splatteredbits · 2025-01-09T21:26:26Z

YouTrackAutomation/Functions/New-YTProject.ps1

+        [String] $Template,
+
+        # Additional fields to include in the response.
+        [String[]] $AdditionalFields


Lint: parameter names should be singular.

splatteredbits · 2025-01-09T21:28:39Z

Tests/YouTrackAutomationTestHelper/YouTrackAutomationTestHelper.psm1

+$apiToken = 'perm:YWRtaW4=.NDctMA==.MskXiizMXwymP1Kfm21iR14len99jp'
+$apiUrl = 'http://localhost:8080'
+
+function Remove-AllProjects


Rename to Clear-Project.

Tests/Invoke-YTRestMethod.Tests.ps1

…an issue

splatteredbits · 2025-01-24T23:56:32Z

Please automate the download and updating of the YouTrackConfig directory. It should not be getting checked into source.

splatteredbits · 2025-01-24T23:53:16Z

YouTrackAutomation/Functions/Get-YTIssue.ps1

+    Gets an issue from YouTrack.
+
+    .DESCRIPTION
+    The `Get-YTIssue` function gets an issue from YouTrack using the issue ID or issue key. The function returns the


This still needs to get done.

splatteredbits · 2025-01-24T23:53:32Z

YouTrackAutomation/Functions/Get-YTProject.ps1

+        $fields += ",$($AdditionalField -join ',')"
+    }
+
+    $fields = [Uri]::EscapeUriString($fields)


This still needs to change.

splatteredbits · 2025-01-24T23:53:43Z

YouTrackAutomation/Functions/Invoke-YTRestMethod.ps1

+    Invokes a REST method in YouTrack.
+
+    .DESCRIPTION
+    The `Invoke-YTRestMethod` function invokes a REST method in YouTrack using the provided session object. Pass in the


splatteredbits · 2025-01-24T23:54:05Z

YouTrackAutomation/Functions/New-YTProject.ps1

+
+    if ($Template)
+    {
+        $fields += "&template=$Template"


splatteredbits · 2025-01-24T23:54:14Z

YouTrackAutomation/Functions/New-YTProject.ps1

+        $fields += "&template=$Template"
+    }
+
+    $fields = [Uri]::EscapeUriString($fields)


splatteredbits · 2025-01-24T23:54:44Z

YouTrackAutomation/Functions/Resolve-YTProject.ps1

+    The `Resolve-YTProjectId` function takes in a project, project short name, or project id and returns the project id
+    associated with the project provided.
+
+    .EXAMPLE


Function name in examples is wrong.

splatteredbits · 2025-01-24T23:55:18Z

YouTrackAutomation/Functions/Resolve-YTProject.ps1

+    .EXAMPLE
+    Resolve-YTProject.ps1 -Session $session -Project $project
+
+    Demonstrates resolving the project id for the project with a project object.


CameronSWilliamson added 15 commits July 15, 2024 11:58

Adding dynamic fetching for .NET library dependencies.

f8768f1

Adding New-YTSession function that creates a session object.

cc5cd34

Adding automated setup for YouTrack

508ae23

Moving automation to python to make it easier on appveyor

182bf56

Providing zipped YouTrack instance for testing

7095cbb

Ending Youtrack process on build servers

ae989f8

Adding support for Unix operating systems

90436aa

Removing all dll dependencies

1ffe7c3

Updating init to use ytconfig.zip and download youtrack from the website

6318490

Adding Invoke-YTRestMethod function

ef6f213

Adding Get-YTIssue function

a7d7e6d

Adding get project and new project functions

b3e3aa1

Adding New-YTIssue function and unittests

0884e6c

Fixing failing tests

46dcf80

Ready for first release

1866c5f

splatteredbits requested changes Aug 22, 2024

View reviewed changes

CameronSWilliamson added 5 commits January 6, 2025 13:53

Adding Remove-YTProject function

4a15b62

Removing all projects before each test suite

aea8cb2

Adding test that makes a real request

97110c4

Adding support for error descriptions when invoking youtrack rest met…

ef243a3

…hods

Adding Remove-AllProjects helper function and updating documentation …

c5ad7a8

…and parameters for all functions

CameronSWilliamson requested a review from splatteredbits January 9, 2025 18:36

splatteredbits requested changes Jan 9, 2025

View reviewed changes

CameronSWilliamson and others added 3 commits January 9, 2025 13:58

Adding function to get IDs for custom fields and to get the state of …

5b5a418

…an issue

Adding support for getting an issue's custom fields.

4cd3f22

Check in YouTrack config as loose files instead of a zip.

0f1c7c3

KhoiKy force-pushed the feature/basic-functions branch from c01364c to 0f1c7c3 Compare January 24, 2025 16:47

Rename test helper function to Clear-Project.

4532698

KhoiKy force-pushed the feature/basic-functions branch from c21f75c to 4532698 Compare January 24, 2025 17:31

Use EscapeDataString instead of EscapeUriString.

b43813d

KhoiKy added 2 commits January 24, 2025 10:20

Parameter name should be singular.

b25e25f

Update module's help.txt

f7ceb28

KhoiKy force-pushed the feature/basic-functions branch from ebae5fa to f7ceb28 Compare January 24, 2025 19:14

Update tests so that they don't mock invoking of rest methods.

b69a854

KhoiKy requested a review from splatteredbits January 24, 2025 23:07

splatteredbits requested changes Jan 24, 2025

View reviewed changes

Improve documentation on functions.

3f058e7

KhoiKy force-pushed the feature/basic-functions branch from 0e41434 to 3f058e7 Compare January 25, 2025 00:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial release #1

Initial release #1

CameronSWilliamson commented Aug 5, 2024

splatteredbits Aug 22, 2024

splatteredbits Aug 22, 2024

splatteredbits Aug 22, 2024

splatteredbits Aug 22, 2024

splatteredbits Aug 22, 2024

splatteredbits Aug 22, 2024

splatteredbits Aug 22, 2024 •

edited

Loading

splatteredbits Jan 24, 2025

splatteredbits Aug 22, 2024

splatteredbits Jan 9, 2025

splatteredbits Jan 9, 2025

splatteredbits Jan 9, 2025

splatteredbits Jan 9, 2025

splatteredbits Jan 9, 2025

CameronSWilliamson Jan 17, 2025

splatteredbits Jan 9, 2025

splatteredbits Jan 9, 2025

splatteredbits Jan 9, 2025

splatteredbits Jan 9, 2025

splatteredbits commented Jan 24, 2025

splatteredbits Jan 24, 2025

splatteredbits Jan 24, 2025

splatteredbits Jan 24, 2025

splatteredbits Jan 24, 2025

splatteredbits Jan 24, 2025

splatteredbits Jan 24, 2025

splatteredbits Jan 24, 2025

Initial release #1

Are you sure you want to change the base?

Initial release #1

Conversation

CameronSWilliamson commented Aug 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

splatteredbits Aug 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

splatteredbits commented Jan 24, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

splatteredbits Aug 22, 2024 •

edited

Loading