Skip to content

feat(github): add function to clear item values in GitHub project #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rulasg merged 12 commits into from
Aug 3, 2025
Merged

feat(github): add function to clear item values in GitHub project #133

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1155ba7
feat(github): add function to clear item values in GitHub project
rulasg Jul 29, 2025
80e1dc8
test(project_items_staged): add GitHub_ClearProjectV2ItemFieldValue t…
rulasg Aug 3, 2025
7525616
refactor(project_database_Async.ps1): remove duplicated Sync-Project …
rulasg Aug 3, 2025
c5c51a7
feat(project_database): add command alias for clearing GitHub project…
rulasg Aug 3, 2025
d1ebca9
feat(invokeCommand): add async mock call functions for JSON and stand…
rulasg Aug 3, 2025
32da7eb
test(project_items_staged): add async test for clearing project item …
rulasg Aug 3, 2025
ccb08b5
fix: remove trailing whitespace (PSAvoidTrailingWhitespace)
rulasg Aug 3, 2025
ef3a4a4
fix: correct Write-Information parameter usage (PSUseCmdletCorrectly)
rulasg Aug 3, 2025
11e3a9e
fix: correct null comparison order (PSPossibleIncorrectComparisonWith…
rulasg Aug 3, 2025
f74947f
fix(PSProvideCommentHelp): add comment help to exported functions
rulasg Aug 3, 2025
3a82acf
fix(PSProvideCommentHelp): add comment help to more exported functions
rulasg Aug 3, 2025
c3f28a8
fix(powershell.yml): update upload-sarif action to version 3
rulasg Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion Test/include/invokeCommand.mock.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,19 @@ function MockCall{
Set-InvokeCommandMock -Alias $command -Command "Get-MockFileContent -filename $filename"
}

function MockCallAsync{
param(
[Parameter(Position=0)][string] $command,
[Parameter(Position=1)][string] $filename
)

Assert-MockFileNotfound $fileName

$moduleTest = $PSScriptRoot | Split-Path -Parent | Convert-Path

Set-InvokeCommandMock -Alias $command -Command "Import-Module $moduleTest ; Get-MockFileContent -filename $filename"
}

function MockCallJson{
param(
[Parameter(Position=0)][string] $command,
Expand All @@ -69,6 +82,20 @@ function MockCallJson{
Set-InvokeCommandMock -Alias $command -Command "Get-MockFileContentJson -filename $filename"
}

function MockCallJsonAsync{
param(
[Parameter(Position=0)][string] $command,
[Parameter(Position=1)][string] $filename

)

Assert-MockFileNotfound $fileName

$moduleTest = $PSScriptRoot | Split-Path -Parent | Convert-Path

Set-InvokeCommandMock -Alias $command -Command "Import-Module $moduleTest ; Get-MockFileContentJson -filename $filename"
}

function Get-MockFileFullPath{
param(
[parameter(Mandatory,Position=0)][string] $fileName
Expand Down Expand Up @@ -130,7 +157,6 @@ function MockCallToObject{
Set-Variable -Name $varName -Value $OutObject -Scope Global

Set-InvokeCommandMock -Alias $command -Command "(Get-Variable -Name $varName -Scope Global).Value"

}

function MockCallToNull{
Expand Down
117 changes: 117 additions & 0 deletions Test/private/mocks/clearProjectV2ItemFieldValue.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
{
"data": {
"updateProjectV2ItemFieldValue": {
"projectV2Item": {
"content": {
"__typename": "DraftIssue",
"id": "DI_lADOBCrGTM4ActQazgFYYPQ",
"body": "",
"title": "kk text"
},
"id": "PVTI_lADOBCrGTM4ActQazgMuXXc",
"fieldValues": {
"nodes": [
{
"__typename": "ProjectV2ItemFieldUserValue",
"users": {
"nodes": [
{
"login": "rulasg"
}
]
},
"field": {
"__typename": "ProjectV2Field",
"id": "PVTF_lADOBCrGTM4ActQazgSkYnA",
"name": "Assignees",
"dataType": "ASSIGNEES"
}
},
{
"__typename": "ProjectV2ItemFieldTextValue",
"text": "kk text",
"field": {
"__typename": "ProjectV2Field",
"id": "PVTF_lADOBCrGTM4ActQazgSkYm8",
"name": "Title",
"dataType": "TITLE"
}
},
{
"__typename": "ProjectV2ItemFieldSingleSelectValue",
"name": "Todo",
"field": {
"__typename": "ProjectV2SingleSelectField",
"id": "PVTSSF_lADOBCrGTM4ActQazgSkYnE",
"name": "Status",
"dataType": "SINGLE_SELECT",
"options": [
{
"id": "f75ad846",
"name": "Todo"
},
{
"id": "47fc9ee4",
"name": "In Progress"
},
{
"id": "98236657",
"name": "Done"
}
]
}
},
{
"__typename": "ProjectV2ItemFieldSingleSelectValue",
"name": "Nice⭐️",
"field": {
"__typename": "ProjectV2SingleSelectField",
"id": "PVTSSF_lADOBCrGTM4ActQazgSl5ME",
"name": "Severity",
"dataType": "SINGLE_SELECT",
"options": [
{
"id": "2d190e20",
"name": "Critical⭐️⭐️⭐️⭐️"
},
{
"id": "94d0bf94",
"name": "Important⭐️⭐️⭐️"
},
{
"id": "ea848251",
"name": "Needed⭐️⭐️"
},
{
"id": "c99f6d55",
"name": "Nice⭐️"
}
]
}
},
{
"__typename": "ProjectV2ItemFieldNumberValue",
"number": 8.0,
"field": {
"__typename": "ProjectV2Field",
"id": "PVTF_lADOBCrGTM4ActQazgSl5WM",
"name": "UserStories",
"dataType": "NUMBER"
}
},
{
"__typename": "ProjectV2ItemFieldNumberValue",
"number": 666.0,
"field": {
"__typename": "ProjectV2Field",
"id": "PVTF_lADOBCrGTM4ActQazgSkglc",
"name": "TimeTracker",
"dataType": "NUMBER"
}
}
]
}
}
}
}
}
113 changes: 113 additions & 0 deletions Test/public/project_items_staged.test.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,59 @@
Assert-AreEqual -Expected $fileTitleValue2 -Presented $item2.$fieldTitle2
}

function Test_CommitProjectItemsStaged_SUCCESS_Emptyfield{
Reset-InvokeCommandMock
Mock_DatabaseRoot

$Owner = "SomeOrg" ; $ProjectNumber = 164

# Item id 10
# Name Value
# ---- -----
# id PVTI_lADOBCrGTM4ActQazgMuXXc
# number
# Severity Nice⭐️
# Status Todo
# TimeTracker 890
# Comment This
# body some content in body
# Assignees rulasg
# UserStories 8
# Title A draft in the project
# Priority 🥵High
# url
# type DraftIssue

$itemId1 = "PVTI_lADOBCrGTM4ActQazgMuXXc"
$fieldComment1 = "Comment"
Comment thread Fixed
$fieldPriority1 = "Priority"
Comment thread Fixed

# Edit-ProjectItem will call Get-Project with SkipItems
# This test is to confirm the sync works with the project and items
# Cache the project with items
MockCall_GitHubOrgProjectWithFields -Owner $owner -ProjectNumber $projectNumber -FileName 'projectV2.json'
$null = Get-Project -Owner $Owner -ProjectNumber $ProjectNumber

MockCallJson -FileName 'updateProjectV2ItemFieldValue.json' -Command 'Invoke-GitHubClearItemValues -ProjectId PVT_kwDOBCrGTM4ActQa -ItemId PVTI_lADOBCrGTM4ActQazgMuXXc -FieldId PVTF_lADOBCrGTM4ActQazgSl5GU'
MockCallJson -FileName 'updateProjectV2ItemFieldValue.json' -Command 'Invoke-GitHubClearItemValues -ProjectId PVT_kwDOBCrGTM4ActQa -ItemId PVTI_lADOBCrGTM4ActQazgMuXXc -FieldId PVTSSF_lADOBCrGTM4ActQazgSl5LY'

Edit-ProjectItem -Owner $owner -ProjectNumber $projectNumber $itemId1 $fieldComment1 ""
Edit-ProjectItem -Owner $owner -ProjectNumber $projectNumber $itemId1 $fieldPriority1 ""

$result = Sync-ProjectItemStaged -Owner $Owner -ProjectNumber $ProjectNumber

# Return true
Assert-IsTrue -Condition $result

# Staged list is empty
$staged = Get-ProjectItemStaged -Owner $Owner -ProjectNumber $ProjectNumber
Assert-IsNull -Object $staged

$item1 = Get-ProjectItem -Owner $Owner -ProjectNumber $ProjectNumber -ItemId $itemId1
Assert-StringIsNullOrEmpty -Presented $item1.$fieldComment1
Assert-StringIsNullOrEmpty -Presented $item1.$fieldPriority1
}

function Test_CommitProjectItemsStagedAsync_SUCCESS{
Reset-InvokeCommandMock
Mock_DatabaseRoot
Expand Down Expand Up @@ -339,4 +392,64 @@

Assert-NotImplemented

}

function Test_Sync_ProjectDatabaseAsync_ClearValues{
Reset-InvokeCommandMock
Mock_DatabaseRoot

$Owner = "SomeOrg" ; $ProjectNumber = 164

$moduleRootPath = $PSScriptRoot | Split-Path -Parent | Split-Path -Parent | Convert-Path

$projectId = "PVT_kwDOBCrGTM4ActQa"
$itemId1 = "PVTI_lADOBCrGTM4ActQazgMuXXc"
$fieldComment1 = "Comment" ; $fieldComment1Id = "PVTF_lADOBCrGTM4ActQazgSl5GU"
$fieldPriority1 = "Priority" ; $fieldPriority1Id ="PVTSSF_lADOBCrGTM4ActQazgSl5LY"

# Edit-ProjectItem will call Get-Project with SkipItems
# This test is to confirm the sync works with the project and items
# Cache the project with items
MockCall_GitHubOrgProjectWithFields -Owner $owner -ProjectNumber $projectNumber -FileName 'projectV2.json'
$null = Get-Project -Owner $Owner -ProjectNumber $ProjectNumber

# Mock clear command for empty comment field (using async alias)
$clearCommand = 'Import-Module {projecthelper} ; Invoke-GitHubClearItemValues -ProjectId {ProjectId} -ItemId {ItemId} -FieldId {FieldId}'
$clearCommand = $clearCommand -replace '{projecthelper}', $moduleRootPath
$clearCommand = $clearCommand -replace '{ProjectId}', $projectId
$clearCommand = $clearCommand -replace '{ItemId}', $itemId1
$clearCommand = $clearCommand -replace '{FieldId}', $fieldComment1Id
MockCallJsonAsync -Command $clearCommand -FileName "clearProjectV2ItemFieldValue.json"

# Mock clear command for empty priority field (using async alias)
$clearCommand = 'Import-Module {projecthelper} ; Invoke-GitHubClearItemValues -ProjectId {ProjectId} -ItemId {ItemId} -FieldId {FieldId}'
$clearCommand = $clearCommand -replace '{projecthelper}', $moduleRootPath
$clearCommand = $clearCommand -replace '{ProjectId}', $projectId
$clearCommand = $clearCommand -replace '{ItemId}', $itemId1
$clearCommand = $clearCommand -replace '{FieldId}', $fieldPriority1Id
MockCallJsonAsync -Command $clearCommand -FileName "clearProjectV2ItemFieldValue.json"

# Stage the values - clear comment (empty string) and update title
Edit-ProjectItem -Owner $owner -ProjectNumber $projectNumber $itemId1 $fieldComment1 ""
Edit-ProjectItem -Owner $owner -ProjectNumber $projectNumber $itemId1 $fieldPriority1 ""

Start-MyTranscript
$result = Sync-ProjectItemStagedAsync -Owner $Owner -ProjectNumber $ProjectNumber -SyncBatchSize 2
$transcript = Stop-MyTranscript

Check warning

Code scanning / PSScriptAnalyzer

The variable 'transcript' is assigned but never used. Warning

The variable 'transcript' is assigned but never used.

# Return true
Assert-IsTrue -Condition $result

# Verify clear and update commands were called by checking mock invocations
# The transcript should show both operations

# Staged list should be empty after successful sync
$staged = Get-ProjectItemStaged -Owner $Owner -ProjectNumber $ProjectNumber
Assert-IsNull -Object $staged

# Verify the values in the database
$item1 = Get-ProjectItem -Owner $Owner -ProjectNumber $ProjectNumber -ItemId $itemId1
Assert-StringIsNullOrEmpty -Presented $item1.$fieldComment1
Assert-StringIsNullOrEmpty -Presented $item1.$fieldPriority1

}
59 changes: 6 additions & 53 deletions private/projectDatabase/project_database_Async.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Set-MyInvokeCommandAlias -Alias GitHub_UpdateProjectV2ItemFieldValueAsync -Command 'Import-Module {projecthelper} ; Invoke-GitHubUpdateItemValues -ProjectId {projectid} -ItemId {itemid} -FieldId {fieldid} -Value "{value}" -Type {type}'
Set-MyInvokeCommandAlias -Alias GitHub_ClearProjectV2ItemFieldValueAsync -Command 'Import-Module {projecthelper} ; Invoke-GitHubClearItemValues -ProjectId {projectid} -ItemId {itemid} -FieldId {fieldid}'

function Sync-ProjectDatabaseAsync{
[CmdletBinding(SupportsShouldProcess)]
Expand Down Expand Up @@ -136,7 +137,11 @@ function Sync-ProjectAsync{

"Calling to save [$projectId/$itemId/$fieldId ($type) = $value ]" | Write-MyHost

$job = Start-MyJob -Command GitHub_UpdateProjectV2ItemFieldValueAsync -Parameters $params
if([string]::IsNullOrWhiteSpace($value)){
$job = Start-MyJob -Command GitHub_ClearProjectV2ItemFieldValueAsync -Parameters $params
} else {
$job = Start-MyJob -Command GitHub_UpdateProjectV2ItemFieldValueAsync -Parameters $params
}

$call = [PSCustomObject]@{
job = $job
Expand Down Expand Up @@ -210,56 +215,4 @@ function Waiting($Calls){

"" | Write-MyHost
"Completed [$completed] Failed [$failed]" | Write-MyHost
}

function Sync-Project{
[CmdletBinding()]
param(
[Parameter(Position = 0)][object]$Database
)

$db = $Database

foreach($idemId in $db.Staged.Keys){
foreach($fieldId in $db.Staged.$idemId.Keys){

# Get actual value on the database
$fieldName = $db.fields.$fieldId.name

# Skip if database has already the same value as staged
if($db.items.$itemId.$fieldName -eq $db.Staged.$itemId.$fieldId.Value){
"Skipping [$itemId/$fieldName] as actual value is the same as staged value [$actualValue]" | Write-MyHost
continue
}

$project_id = $db.ProjectId
$item_id = $idemId
$field_id = $fieldId
$value = $db.Staged.$idemId.$fieldId.Value
$type = ConvertTo-UpdateType $db.Staged.$idemId.$fieldId.Field.dataType

$params = @{
projectid = $project_id
itemid = $item_id
fieldid = $field_id
value = $value
type = $type
}

"Saving [$project_id/$item_id/$field_id ($type) = $value ]" | Write-MyHost

$result = Invoke-MyCommand -Command GitHub_UpdateProjectV2ItemFieldValue -Parameters $params

if ($null -eq $result) {
"Updating Project Item Field [$item_id/$field_id/$value]" | Write-MyError
return $null
}

# update database with change
$db.items.$item_id.$fieldName = $value

}
}

return $db
}
7 changes: 6 additions & 1 deletion private/projectDatabase/project_database_Sync.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

Set-MyInvokeCommandAlias -Alias GitHub_UpdateProjectV2ItemFieldValue -Command 'Invoke-GitHubUpdateItemValues -ProjectId {projectid} -ItemId {itemid} -FieldId {fieldid} -Value "{value}" -Type {type}'
Set-MyInvokeCommandAlias -Alias GitHub_ClearProjectV2ItemFieldValue -Command 'Invoke-GitHubClearItemValues -ProjectId {projectid} -ItemId {itemid} -FieldId {fieldid}'

function Sync-ProjectDatabase{
[CmdletBinding(SupportsShouldProcess)]
Expand Down Expand Up @@ -102,7 +103,11 @@ function Sync-Project{

"Saving [$project_id/$item_id/$field_id ($type) = $value ] ..." | Write-MyHost -NoNewLine

$result = Invoke-MyCommand -Command GitHub_UpdateProjectV2ItemFieldValue -Parameters $params
if([string]::IsNullOrWhiteSpace($value)){
$result = Invoke-MyCommand -Command GitHub_ClearProjectV2ItemFieldValue -Parameters $params
} else {
$result = Invoke-MyCommand -Command GitHub_UpdateProjectV2ItemFieldValue -Parameters $params
}

if ($null -eq $result) {
"FAILED !!" | Write-MyHost
Expand Down
Loading
Loading