mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-02-05 10:50:24 +01:00
Compare commits
16 Commits
issue/2977
...
issue/4536
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bc0a0c6e0b | ||
|
|
8d9de117b9 | ||
|
|
42a7213644 | ||
|
|
27ba536872 | ||
|
|
18efa0559c | ||
|
|
b3e7c9d227 | ||
|
|
49cc504d94 | ||
|
|
18c6d6b0f3 | ||
|
|
4d1f92199c | ||
|
|
dca532cf4b | ||
|
|
b5991642f8 | ||
|
|
84b39a9edc | ||
|
|
67d96b0a13 | ||
|
|
c5d4f992c1 | ||
|
|
11b406feee | ||
|
|
256af8f6e0 |
63
.github/actions/spell-check/allow/zoomit.txt
vendored
Normal file
63
.github/actions/spell-check/allow/zoomit.txt
vendored
Normal file
@@ -0,0 +1,63 @@
|
||||
acq
|
||||
APPLYTOSUBMENUS
|
||||
AUDCLNT
|
||||
bitmaps
|
||||
BUFFERFLAGS
|
||||
centiseconds
|
||||
Ctl
|
||||
CTLCOLOR
|
||||
CTLCOLORBTN
|
||||
CTLCOLORDLG
|
||||
CTLCOLOREDIT
|
||||
CTLCOLORLISTBOX
|
||||
CTrim
|
||||
DFCS
|
||||
dlg
|
||||
dlu
|
||||
DONTCARE
|
||||
DRAWITEM
|
||||
DRAWITEMSTRUCT
|
||||
DWLP
|
||||
EDITCONTROL
|
||||
ENABLEHOOK
|
||||
FDE
|
||||
GETCHANNELRECT
|
||||
GETCHECK
|
||||
GETTHUMBRECT
|
||||
GIFs
|
||||
HTBOTTOMRIGHT
|
||||
HTHEME
|
||||
KSDATAFORMAT
|
||||
LEFTNOWORDWRAP
|
||||
letterbox
|
||||
lld
|
||||
logfont
|
||||
lround
|
||||
MENUINFO
|
||||
mic
|
||||
MMRESULT
|
||||
OWNERDRAW
|
||||
PBGRA
|
||||
pfdc
|
||||
playhead
|
||||
pwfx
|
||||
quantums
|
||||
REFKNOWNFOLDERID
|
||||
reposted
|
||||
SCROLLSIZEGRIP
|
||||
SETDEFID
|
||||
SETRECT
|
||||
SHAREMODE
|
||||
SHAREVIOLATION
|
||||
STREAMFLAGS
|
||||
submix
|
||||
tci
|
||||
TEXTMETRIC
|
||||
tme
|
||||
TRACKMOUSEEVENT
|
||||
Unadvise
|
||||
WASAPI
|
||||
WAVEFORMATEX
|
||||
WAVEFORMATEXTENSIBLE
|
||||
wil
|
||||
WMU
|
||||
1
.github/actions/spell-check/excludes.txt
vendored
1
.github/actions/spell-check/excludes.txt
vendored
@@ -101,6 +101,7 @@
|
||||
^doc/devdocs/akaLinks\.md$
|
||||
^NOTICE\.md$
|
||||
^src/common/CalculatorEngineCommon/exprtk\.hpp$
|
||||
^src/common/UnitTests-CommonUtils/
|
||||
^src/common/ManagedCommon/ColorFormatHelper\.cs$
|
||||
^src/common/notifications/BackgroundActivatorDLL/cpp\.hint$
|
||||
^src/common/sysinternals/Eula/
|
||||
|
||||
108
.github/actions/spell-check/expect.txt
vendored
108
.github/actions/spell-check/expect.txt
vendored
@@ -11,6 +11,7 @@ ACCESSDENIED
|
||||
ACCESSTOKEN
|
||||
acfs
|
||||
ACIE
|
||||
ACR
|
||||
AClient
|
||||
AColumn
|
||||
acrt
|
||||
@@ -44,6 +45,7 @@ ALLCHILDREN
|
||||
ALLINPUT
|
||||
Allman
|
||||
Allmodule
|
||||
ALLNOISE
|
||||
ALLOWUNDO
|
||||
ALLVIEW
|
||||
ALPHATYPE
|
||||
@@ -57,7 +59,6 @@ AOC
|
||||
aocfnapldcnfbofgmbbllojgocaelgdd
|
||||
AOklab
|
||||
aot
|
||||
APARTMENTTHREADED
|
||||
APeriod
|
||||
apicontract
|
||||
apidl
|
||||
@@ -95,6 +96,7 @@ asf
|
||||
Ashcraft
|
||||
AShortcut
|
||||
ASingle
|
||||
ASUS
|
||||
ASSOCCHANGED
|
||||
ASSOCF
|
||||
ASSOCSTR
|
||||
@@ -104,6 +106,7 @@ atl
|
||||
ATRIOX
|
||||
aumid
|
||||
authenticode
|
||||
AUO
|
||||
AUTOBUDDY
|
||||
AUTOCHECKBOX
|
||||
AUTOHIDE
|
||||
@@ -121,6 +124,10 @@ azureaiinference
|
||||
azureinference
|
||||
azureopenai
|
||||
backticks
|
||||
Backlight
|
||||
Badflags
|
||||
Badmode
|
||||
Badparam
|
||||
bbwe
|
||||
BCIE
|
||||
bck
|
||||
@@ -129,6 +136,7 @@ bezelled
|
||||
bhid
|
||||
BIF
|
||||
bigbar
|
||||
BIGGERSIZEOK
|
||||
bigobj
|
||||
binlog
|
||||
binres
|
||||
@@ -193,6 +201,7 @@ Carlseibert
|
||||
CAtl
|
||||
caub
|
||||
CBN
|
||||
Cds
|
||||
cch
|
||||
CCHDEVICENAME
|
||||
CCHFORMNAME
|
||||
@@ -212,6 +221,7 @@ checkmarks
|
||||
CHILDACTIVATE
|
||||
CHILDWINDOW
|
||||
CHOOSEFONT
|
||||
Chunghwa
|
||||
CIBUILD
|
||||
cidl
|
||||
CIELCh
|
||||
@@ -226,7 +236,7 @@ claude
|
||||
CLEARTYPE
|
||||
clickable
|
||||
clickonce
|
||||
CLIENTEDGE
|
||||
clientedge
|
||||
clientid
|
||||
clientside
|
||||
CLIPBOARDUPDATE
|
||||
@@ -238,6 +248,7 @@ CLSCTX
|
||||
clsids
|
||||
Clusion
|
||||
cmder
|
||||
CMN
|
||||
CMDNOTFOUNDMODULEINTERFACE
|
||||
cmdpal
|
||||
CMIC
|
||||
@@ -292,6 +303,7 @@ Corpor
|
||||
cotaskmem
|
||||
COULDNOT
|
||||
countof
|
||||
Cowait
|
||||
covrun
|
||||
cpcontrols
|
||||
cph
|
||||
@@ -310,11 +322,14 @@ CRECT
|
||||
CRH
|
||||
critsec
|
||||
cropandlock
|
||||
crt
|
||||
CROPTOSQUARE
|
||||
Crossdevice
|
||||
csdevkit
|
||||
CSearch
|
||||
CSettings
|
||||
cso
|
||||
CSOT
|
||||
CSRW
|
||||
CStyle
|
||||
cswin
|
||||
@@ -357,11 +372,14 @@ DBPROPIDSET
|
||||
DBPROPSET
|
||||
DBT
|
||||
DCBA
|
||||
DCapabilities
|
||||
DCOM
|
||||
DComposition
|
||||
DCR
|
||||
ddc
|
||||
DDEIf
|
||||
Deact
|
||||
debouncer
|
||||
debugbreak
|
||||
decryptor
|
||||
Dedup
|
||||
@@ -379,6 +397,7 @@ DEFAULTTOPRIMARY
|
||||
DEFERERASE
|
||||
DEFPUSHBUTTON
|
||||
deinitialization
|
||||
DELA
|
||||
DELETEDKEYIMAGE
|
||||
DELETESCANS
|
||||
DEMOTYPE
|
||||
@@ -413,18 +432,20 @@ DISABLEASACTIONKEY
|
||||
DISABLENOSCROLL
|
||||
diskmgmt
|
||||
DISPLAYCHANGE
|
||||
DISPLAYCONFIG
|
||||
displayconfig
|
||||
DISPLAYFLAGS
|
||||
DISPLAYFREQUENCY
|
||||
displayname
|
||||
DISPLAYORIENTATION
|
||||
diu
|
||||
divyan
|
||||
Dlg
|
||||
DLGFRAME
|
||||
DLGMODALFRAME
|
||||
dlgmodalframe
|
||||
dlib
|
||||
dllhost
|
||||
dllmain
|
||||
Dmdo
|
||||
DNLEN
|
||||
DONOTROUND
|
||||
DONTVALIDATEPATH
|
||||
@@ -434,6 +455,7 @@ downsampling
|
||||
downscale
|
||||
DPICHANGED
|
||||
DPIs
|
||||
DPMS
|
||||
DPSAPI
|
||||
DQTAT
|
||||
DQTYPE
|
||||
@@ -471,15 +493,19 @@ DWMWINDOWMAXIMIZEDCHANGE
|
||||
DWORDLONG
|
||||
dworigin
|
||||
dwrite
|
||||
Dxva
|
||||
dxgi
|
||||
eab
|
||||
EAccess
|
||||
easeofaccess
|
||||
ecount
|
||||
Edid
|
||||
edid
|
||||
EDITKEYBOARD
|
||||
EDITSHORTCUTS
|
||||
EDITTEXT
|
||||
EFile
|
||||
EInvalid
|
||||
eep
|
||||
eku
|
||||
emojis
|
||||
ENABLEDELAYEDEXPANSION
|
||||
@@ -489,14 +515,15 @@ ENABLETEMPLATE
|
||||
encodedlaunch
|
||||
encryptor
|
||||
ENDSESSION
|
||||
ENot
|
||||
ENSUREVISIBLE
|
||||
ENTERSIZEMOVE
|
||||
ENTRYW
|
||||
ENU
|
||||
environmentvariables
|
||||
EOAC
|
||||
EPO
|
||||
epu
|
||||
EProvider
|
||||
ERASEBKGND
|
||||
EREOF
|
||||
EResize
|
||||
@@ -550,6 +577,7 @@ fdx
|
||||
FErase
|
||||
fesf
|
||||
FFFF
|
||||
FFh
|
||||
Figma
|
||||
FILEEXPLORER
|
||||
fileexploreraddons
|
||||
@@ -592,6 +620,7 @@ formatetc
|
||||
FORPARSING
|
||||
foundrylocal
|
||||
FRAMECHANGED
|
||||
Framechanged
|
||||
FRestore
|
||||
frm
|
||||
FROMTOUCH
|
||||
@@ -635,6 +664,7 @@ GMEM
|
||||
GNumber
|
||||
googleai
|
||||
googlegemini
|
||||
Gotchas
|
||||
gpedit
|
||||
gpo
|
||||
GPOCA
|
||||
@@ -647,13 +677,13 @@ GSM
|
||||
gtm
|
||||
guiddata
|
||||
GUITHREADINFO
|
||||
Gotcha
|
||||
Gotchas
|
||||
GValue
|
||||
gwl
|
||||
GWLP
|
||||
GWLSTYLE
|
||||
hangeul
|
||||
Hann
|
||||
Hantai
|
||||
Hanzi
|
||||
Hardlines
|
||||
hardlinks
|
||||
@@ -712,6 +742,7 @@ HKPD
|
||||
HKU
|
||||
HMD
|
||||
hmenu
|
||||
HMON
|
||||
hmodule
|
||||
hmonitor
|
||||
homies
|
||||
@@ -729,6 +760,7 @@ hotkeys
|
||||
hotlight
|
||||
hotspot
|
||||
HPAINTBUFFER
|
||||
HPhysical
|
||||
HRAWINPUT
|
||||
hredraw
|
||||
hres
|
||||
@@ -739,6 +771,7 @@ hsb
|
||||
HSCROLL
|
||||
hsi
|
||||
HSpeed
|
||||
HSync
|
||||
HTCLIENT
|
||||
hthumbnail
|
||||
HTOUCHINPUT
|
||||
@@ -748,6 +781,7 @@ HVal
|
||||
HValue
|
||||
Hvci
|
||||
hwb
|
||||
HWP
|
||||
HWHEEL
|
||||
HWINEVENTHOOK
|
||||
hwnd
|
||||
@@ -761,6 +795,7 @@ IAI
|
||||
icf
|
||||
ICONERROR
|
||||
ICONLOCATION
|
||||
ICONONLY
|
||||
IDCANCEL
|
||||
IDD
|
||||
idk
|
||||
@@ -804,6 +839,7 @@ INITTOLOGFONTSTRUCT
|
||||
INLINEPREFIX
|
||||
inlines
|
||||
Inno
|
||||
Innolux
|
||||
INPC
|
||||
inproc
|
||||
INPUTHARDWARE
|
||||
@@ -845,6 +881,7 @@ istep
|
||||
ith
|
||||
ITHUMBNAIL
|
||||
IUI
|
||||
IVO
|
||||
IUWP
|
||||
IWIC
|
||||
jeli
|
||||
@@ -858,6 +895,7 @@ jpnime
|
||||
Jsons
|
||||
jsonval
|
||||
jxr
|
||||
Kantai
|
||||
keybd
|
||||
KEYBDDATA
|
||||
KEYBDINPUT
|
||||
@@ -879,6 +917,7 @@ KILLFOCUS
|
||||
killrunner
|
||||
kmph
|
||||
kvp
|
||||
KVM
|
||||
Kybd
|
||||
LARGEICON
|
||||
lastcodeanalysissucceeded
|
||||
@@ -894,12 +933,15 @@ Lclean
|
||||
Ldone
|
||||
Ldr
|
||||
LEFTALIGN
|
||||
leftclick
|
||||
LEFTSCROLLBAR
|
||||
LEFTTEXT
|
||||
leftclick
|
||||
LError
|
||||
LEVELID
|
||||
LExit
|
||||
Lenovo
|
||||
LGD
|
||||
LFU
|
||||
lhwnd
|
||||
LIBFUZZER
|
||||
LIBID
|
||||
@@ -1004,6 +1046,7 @@ MAPTOSAMESHORTCUT
|
||||
MAPVK
|
||||
MARKDOWNPREVIEWHANDLERCPP
|
||||
MAXIMIZEBOX
|
||||
Maximizebox
|
||||
MAXSHORTCUTSIZE
|
||||
maxversiontested
|
||||
mber
|
||||
@@ -1016,12 +1059,14 @@ MDL
|
||||
mdtext
|
||||
mdtxt
|
||||
mdwn
|
||||
mccs
|
||||
meme
|
||||
memicmp
|
||||
MENUITEMINFO
|
||||
MENUITEMINFOW
|
||||
MERGECOPY
|
||||
MERGEPAINT
|
||||
Metacharacter
|
||||
metadatamatters
|
||||
Metadatas
|
||||
metafile
|
||||
@@ -1036,6 +1081,7 @@ mikeclayton
|
||||
mindaro
|
||||
Minimizable
|
||||
MINIMIZEBOX
|
||||
Minimizebox
|
||||
MINIMIZEEND
|
||||
MINIMIZESTART
|
||||
MINMAXINFO
|
||||
@@ -1071,7 +1117,8 @@ mouseutils
|
||||
MOVESIZEEND
|
||||
MOVESIZESTART
|
||||
MRM
|
||||
MRT
|
||||
Mrt
|
||||
mrt
|
||||
mru
|
||||
MSAL
|
||||
msc
|
||||
@@ -1097,6 +1144,7 @@ Mso
|
||||
msrc
|
||||
msstore
|
||||
mstsc
|
||||
mswhql
|
||||
msvcp
|
||||
MT
|
||||
MTND
|
||||
@@ -1114,6 +1162,7 @@ MYICON
|
||||
myorg
|
||||
myrepo
|
||||
NAMECHANGE
|
||||
Nanjing
|
||||
namespaceanddescendants
|
||||
nao
|
||||
NCACTIVATE
|
||||
@@ -1182,6 +1231,7 @@ NOMCX
|
||||
NOMINMAX
|
||||
NOMIRRORBITMAP
|
||||
NOMOVE
|
||||
Nomove
|
||||
NONANTIALIASED
|
||||
nonclient
|
||||
NONCLIENTMETRICSW
|
||||
@@ -1203,6 +1253,7 @@ NORMALUSER
|
||||
NOSEARCH
|
||||
NOSENDCHANGING
|
||||
NOSIZE
|
||||
Nosize
|
||||
NOTHOUSANDS
|
||||
NOTICKS
|
||||
NOTIFICATIONSDLL
|
||||
@@ -1210,9 +1261,11 @@ NOTIFYICONDATA
|
||||
NOTIFYICONDATAW
|
||||
NOTIMPL
|
||||
NOTOPMOST
|
||||
Notopmost
|
||||
NOTRACK
|
||||
NOTSRCCOPY
|
||||
NOTSRCERASE
|
||||
Notupdated
|
||||
notwindows
|
||||
NOTXORPEN
|
||||
nowarn
|
||||
@@ -1256,6 +1309,7 @@ opensource
|
||||
openurl
|
||||
openxmlformats
|
||||
OPTIMIZEFORINVOKE
|
||||
Optronics
|
||||
ORPHANEDDIALOGTITLE
|
||||
ORSCANS
|
||||
oss
|
||||
@@ -1291,6 +1345,7 @@ PATINVERT
|
||||
PATPAINT
|
||||
pbc
|
||||
pbi
|
||||
PBP
|
||||
PBlob
|
||||
pbrush
|
||||
pcb
|
||||
@@ -1305,6 +1360,7 @@ PDBs
|
||||
PDEVMODE
|
||||
pdisp
|
||||
PDLL
|
||||
pdmodels
|
||||
pdo
|
||||
pdto
|
||||
pdtobj
|
||||
@@ -1327,6 +1383,7 @@ pguid
|
||||
phbm
|
||||
phbmp
|
||||
phicon
|
||||
PHL
|
||||
Photoshop
|
||||
phwnd
|
||||
pici
|
||||
@@ -1359,6 +1416,8 @@ Popups
|
||||
POPUPWINDOW
|
||||
POSITIONITEM
|
||||
POWERBROADCAST
|
||||
powerdisplay
|
||||
POWERDISPLAYMODULEINTERFACE
|
||||
POWERRENAMECONTEXTMENU
|
||||
powerrenameinput
|
||||
POWERRENAMETEST
|
||||
@@ -1413,6 +1472,7 @@ projectname
|
||||
PROPERTYKEY
|
||||
Propset
|
||||
PROPVARIANT
|
||||
prot
|
||||
PRTL
|
||||
prvpane
|
||||
psapi
|
||||
@@ -1440,12 +1500,16 @@ PTOKEN
|
||||
PToy
|
||||
ptstr
|
||||
pui
|
||||
pvct
|
||||
PWAs
|
||||
pwcs
|
||||
PWSTR
|
||||
pwsz
|
||||
pwtd
|
||||
Qdc
|
||||
QDC
|
||||
qdc
|
||||
QDS
|
||||
qit
|
||||
QITAB
|
||||
QITABENT
|
||||
@@ -1489,7 +1553,9 @@ regfile
|
||||
REGISTERCLASSFAILED
|
||||
REGISTRYHEADER
|
||||
REGISTRYPREVIEWEXT
|
||||
registryroot
|
||||
regkey
|
||||
regroot
|
||||
regsvr
|
||||
REINSTALLMODE
|
||||
releaseblog
|
||||
@@ -1534,7 +1600,6 @@ riid
|
||||
RKey
|
||||
RNumber
|
||||
rollups
|
||||
ROOTOWNER
|
||||
rop
|
||||
ROUNDSMALL
|
||||
ROWSETEXT
|
||||
@@ -1667,6 +1732,7 @@ sigdn
|
||||
Signedness
|
||||
SIGNINGSCENARIO
|
||||
signtool
|
||||
SIIGBF
|
||||
SINGLEKEY
|
||||
sipolicy
|
||||
SIZEBOX
|
||||
@@ -1731,6 +1797,7 @@ STARTUPINFOW
|
||||
startupscreen
|
||||
STATFLAG
|
||||
STATICEDGE
|
||||
Staticedge
|
||||
staticmethod
|
||||
STATSTG
|
||||
stdafx
|
||||
@@ -1767,6 +1834,7 @@ subkeys
|
||||
sublang
|
||||
SUBMODULEUPDATE
|
||||
subresource
|
||||
swp
|
||||
Superbar
|
||||
sut
|
||||
svchost
|
||||
@@ -1775,7 +1843,8 @@ SVGIO
|
||||
svgz
|
||||
SVSI
|
||||
SWFO
|
||||
swp
|
||||
SWP
|
||||
Swp
|
||||
SWPNOSIZE
|
||||
SWPNOZORDER
|
||||
SWRESTORE
|
||||
@@ -1835,7 +1904,9 @@ THEMECHANGED
|
||||
themeresources
|
||||
THH
|
||||
THICKFRAME
|
||||
Thickframe
|
||||
THISCOMPONENT
|
||||
Tianma
|
||||
throughs
|
||||
TILEDWINDOW
|
||||
TILLSON
|
||||
@@ -1916,13 +1987,13 @@ UNLEN
|
||||
UNORM
|
||||
unremapped
|
||||
Unsubscribes
|
||||
unsubscribes
|
||||
unvirtualized
|
||||
unwide
|
||||
unzoom
|
||||
UOffset
|
||||
UOI
|
||||
UPDATENOW
|
||||
UPDATEREGISTRY
|
||||
updown
|
||||
UPGRADINGPRODUCTCODE
|
||||
upscaling
|
||||
@@ -1949,6 +2020,8 @@ vcamp
|
||||
vcenter
|
||||
vcgtq
|
||||
VCINSTALLDIR
|
||||
vcp
|
||||
vcpname
|
||||
Vcpkg
|
||||
VCRT
|
||||
vcruntime
|
||||
@@ -1961,6 +2034,8 @@ VERIFYCONTEXT
|
||||
VERSIONINFO
|
||||
VERTRES
|
||||
VERTSIZE
|
||||
VESA
|
||||
vesa
|
||||
VFT
|
||||
vget
|
||||
vgetq
|
||||
@@ -1992,6 +2067,7 @@ VSM
|
||||
vso
|
||||
vsonline
|
||||
VSpeed
|
||||
VSync
|
||||
vstemplate
|
||||
vstest
|
||||
VSTHRD
|
||||
@@ -2033,7 +2109,7 @@ winapi
|
||||
winappsdk
|
||||
windir
|
||||
WINDOWCREATED
|
||||
WINDOWEDGE
|
||||
windowedge
|
||||
WINDOWINFO
|
||||
WINDOWNAME
|
||||
WINDOWPLACEMENT
|
||||
@@ -2057,12 +2133,12 @@ WINL
|
||||
winlogon
|
||||
winmd
|
||||
winml
|
||||
WINNT
|
||||
winres
|
||||
winrt
|
||||
winsdk
|
||||
winsta
|
||||
WINTHRESHOLD
|
||||
WINNT
|
||||
WINVER
|
||||
winxamlmanager
|
||||
withinrafael
|
||||
@@ -2074,6 +2150,7 @@ WKSG
|
||||
Wlkr
|
||||
wmain
|
||||
Wman
|
||||
wmi
|
||||
WMI
|
||||
WMICIM
|
||||
wmimgmt
|
||||
@@ -2086,6 +2163,7 @@ WNDCLASSEX
|
||||
WNDCLASSEXW
|
||||
WNDCLASSW
|
||||
WNDPROC
|
||||
Wndproc
|
||||
wnode
|
||||
wom
|
||||
WORKSPACESEDITOR
|
||||
|
||||
13
.github/actions/spell-check/patterns.txt
vendored
13
.github/actions/spell-check/patterns.txt
vendored
@@ -274,5 +274,18 @@ St&yle
|
||||
# 0x6f677548 is user name but user folder causes a flag
|
||||
\bx6f677548\b
|
||||
|
||||
# Windows API constants and hardware interface terms
|
||||
\bCOINIT[_A-Z]*\b
|
||||
\bEOAC[_A-Z]*\b
|
||||
\b(?:RPC_C_AUTHN_)?WINNT\b
|
||||
\bUPDATEREGISTRY\b
|
||||
\b(?:CDS_)?UPDATEREGISTRY\b
|
||||
|
||||
# Display interface terms (HDMI, DVI, DisplayPort)
|
||||
\b(?:HDMI|DVI|DisplayPort)(?:-\d+)?\b
|
||||
|
||||
# 2D Region struct names
|
||||
\bDisplayConfig2?D?Region\b
|
||||
|
||||
# Microsoft Store URLs and product IDs
|
||||
ms-windows-store://\S+
|
||||
|
||||
21
.github/skills/issue-fix/LICENSE.txt
vendored
21
.github/skills/issue-fix/LICENSE.txt
vendored
@@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) Microsoft Corporation.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
130
.github/skills/issue-fix/SKILL.md
vendored
130
.github/skills/issue-fix/SKILL.md
vendored
@@ -1,130 +0,0 @@
|
||||
---
|
||||
name: issue-fix
|
||||
description: Automatically fix GitHub issues using AI-assisted code generation. Use when asked to fix an issue, implement a feature from an issue, auto-fix an issue, apply implementation plan, create code changes for an issue, or resolve a GitHub issue. Creates isolated git worktree and applies AI-generated fixes based on the implementation plan.
|
||||
license: Complete terms in LICENSE.txt
|
||||
---
|
||||
|
||||
# Issue Fix Skill
|
||||
|
||||
Automatically fix GitHub issues by creating isolated worktrees and applying AI-generated code changes based on implementation plans.
|
||||
|
||||
## Skill Contents
|
||||
|
||||
This skill is **self-contained** with all required resources:
|
||||
|
||||
```
|
||||
.github/skills/issue-fix/
|
||||
├── SKILL.md # This file
|
||||
├── LICENSE.txt # MIT License
|
||||
├── scripts/
|
||||
│ └── Start-IssueAutoFix.ps1 # Main fix script
|
||||
└── references/
|
||||
└── fix-issue.prompt.md # Full AI prompt template
|
||||
```
|
||||
|
||||
## Output Directory
|
||||
|
||||
Worktrees are created at the drive root level:
|
||||
|
||||
```
|
||||
Q:/PowerToys-xxxx/ # Worktree for issue (xxxx = short hash)
|
||||
├── Generated Files/
|
||||
│ └── issueReview/
|
||||
│ └── <issue-number>/ # Copied from main repo
|
||||
│ ├── overview.md
|
||||
│ └── implementation-plan.md
|
||||
└── <normal repo structure>
|
||||
```
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
- Fix a specific GitHub issue automatically
|
||||
- Implement a feature described in an issue
|
||||
- Apply an existing implementation plan
|
||||
- Create code changes for an issue
|
||||
- Auto-fix high-confidence issues
|
||||
- Resolve issues that have been reviewed
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- GitHub CLI (`gh`) installed and authenticated
|
||||
- Issue must be reviewed first (use `issue-review` skill)
|
||||
- PowerShell 7+ for running scripts
|
||||
- Copilot CLI or Claude CLI installed
|
||||
|
||||
## Required Variables
|
||||
|
||||
⚠️ **Before starting**, confirm `{{IssueNumber}}` with the user. If not provided, **ASK**: "What issue number should I fix?"
|
||||
|
||||
| Variable | Description | Example |
|
||||
|----------|-------------|---------|
|
||||
| `{{IssueNumber}}` | GitHub issue number to fix | `44044` |
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1: Ensure Issue is Reviewed
|
||||
|
||||
If not already reviewed, use the `issue-review` skill first.
|
||||
|
||||
### Step 2: Run Auto-Fix
|
||||
|
||||
Execute the fix script (use paths relative to this skill folder):
|
||||
|
||||
```powershell
|
||||
# From repo root
|
||||
.github/skills/issue-fix/scripts/Start-IssueAutoFix.ps1 -IssueNumber {{IssueNumber}} -CLIType copilot
|
||||
```
|
||||
|
||||
This will:
|
||||
1. Create a new git worktree with branch `issue/{{IssueNumber}}`
|
||||
2. Copy the review files to the worktree
|
||||
3. Launch Copilot CLI to implement the fix
|
||||
4. Build and verify the changes
|
||||
|
||||
### Step 3: Verify Changes
|
||||
|
||||
Navigate to the worktree and review:
|
||||
|
||||
```powershell
|
||||
# List worktrees
|
||||
git worktree list
|
||||
|
||||
# Check changes in the worktree
|
||||
cd Q:/PowerToys-xxxx
|
||||
git diff
|
||||
git status
|
||||
```
|
||||
|
||||
## CLI Options
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `-IssueNumber` | Issue to fix | Required |
|
||||
| `-CLIType` | AI CLI to use: `copilot` or `claude` | `copilot` |
|
||||
| `-Force` | Skip confirmation prompts | `false` |
|
||||
|
||||
## Batch Fix
|
||||
|
||||
To fix multiple issues:
|
||||
|
||||
```powershell
|
||||
.github/skills/issue-fix/scripts/Start-IssueAutoFix.ps1 -IssueNumbers 44044, 32950 -CLIType copilot -Force
|
||||
```
|
||||
|
||||
## After Fixing
|
||||
|
||||
Once the fix is complete, use the `submit-pr` skill to create a PR.
|
||||
|
||||
## AI Prompt Reference
|
||||
|
||||
For manual AI invocation, the full prompt is at:
|
||||
- `references/fix-issue.prompt.md` (relative to this skill folder)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Problem | Solution |
|
||||
|---------|----------|
|
||||
| Worktree already exists | Use existing worktree or delete with `git worktree remove <path>` |
|
||||
| No implementation plan | Use `issue-review` skill first |
|
||||
| Build failures | Check build logs, may need manual intervention |
|
||||
| CLI not found | Install Copilot CLI |
|
||||
@@ -1,72 +0,0 @@
|
||||
---
|
||||
agent: 'agent'
|
||||
description: 'Execute the fix for a GitHub issue using the previously generated implementation plan'
|
||||
---
|
||||
|
||||
# Fix GitHub Issue
|
||||
|
||||
## Dependencies
|
||||
Source review prompt (for generating the implementation plan if missing):
|
||||
- .github/prompts/review-issue.prompt.md
|
||||
|
||||
Required plan file (single source of truth):
|
||||
- Generated Files/issueReview/{{issue_number}}/implementation-plan.md
|
||||
|
||||
## Dependency Handling
|
||||
1) If `implementation-plan.md` exists → proceed.
|
||||
2) If missing → run the review prompt:
|
||||
- Invoke: `.github/prompts/review-issue.prompt.md`
|
||||
- Pass: `issue_number={{issue_number}}`
|
||||
- Then re-check for `implementation-plan.md`.
|
||||
3) If still missing → stop and generate:
|
||||
- `Generated Files/issueFix/{{issue_number}}/manual-steps.md` containing:
|
||||
“implementation-plan.md not found; please run .github/prompts/review-issue.prompt.md for #{{issue_number}}.”
|
||||
|
||||
# GOAL
|
||||
For **#{{issue_number}}**:
|
||||
- Use implementation-plan.md as the single authority.
|
||||
- Apply code and test changes directly in the repository.
|
||||
- Produce a PR-ready description.
|
||||
|
||||
# OUTPUT FILES
|
||||
1) Generated Files/issueFix/{{issue_number}}/pr-description.md
|
||||
2) Generated Files/issueFix/{{issue_number}}/manual-steps.md # only if human interaction or external setup is required
|
||||
|
||||
# EXECUTION RULES
|
||||
1) Read implementation-plan.md and execute:
|
||||
- Layers & Files → edit/create as listed
|
||||
- Pattern Choices → follow repository conventions
|
||||
- Fundamentals (perf, security, compatibility, accessibility)
|
||||
- Logging & Exceptions
|
||||
- Telemetry (only if explicitly included in the plan)
|
||||
- Risks & Mitigations
|
||||
- Tests to Add
|
||||
2) Locate affected files via `rg` or `git grep`.
|
||||
3) Add/update tests to enforce the fixed behavior.
|
||||
4) If any ambiguity exists, add:
|
||||
// TODO(Human input needed): <clarification needed>
|
||||
5) Verify locally: build & tests run successfully.
|
||||
|
||||
# pr-description.md should include:
|
||||
- Title: `Fix: <short summary> (#{{issue_number}})`
|
||||
- What changed and why the fix works
|
||||
- Files or modules touched
|
||||
- Risks & mitigations (implemented)
|
||||
- Tests added/updated and how to run them
|
||||
- Telemetry behavior (if applicable)
|
||||
- Validation / reproduction steps
|
||||
- `Closes #{{issue_number}}`
|
||||
|
||||
# manual-steps.md (only if needed)
|
||||
- List required human actions: secrets, config, approvals, missing info, or code comments requiring human decisions.
|
||||
|
||||
# IMPORTANT
|
||||
- Apply code and tests directly; do not produce patch files.
|
||||
- Follow implementation-plan.md as the source of truth.
|
||||
- Insert comments for human review where a decision or input is required.
|
||||
- Use repository conventions and deterministic, minimal changes.
|
||||
|
||||
# FINALIZE
|
||||
- Write pr-description.md
|
||||
- Write manual-steps.md only if needed
|
||||
- Print concise success message or note items requiring human interaction
|
||||
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"mcpServers": {
|
||||
"github-artifacts": {
|
||||
"command": "cmd",
|
||||
"args": ["/c", "for /f %i in ('git rev-parse --show-toplevel') do node %i/tools/mcp/github-artifacts/launch.js"],
|
||||
"tools": ["*"]
|
||||
}
|
||||
}
|
||||
}
|
||||
643
.github/skills/issue-fix/scripts/IssueReviewLib.ps1
vendored
643
.github/skills/issue-fix/scripts/IssueReviewLib.ps1
vendored
@@ -1,643 +0,0 @@
|
||||
# IssueReviewLib.ps1 - Helpers for issue auto-fix workflow
|
||||
# Part of the PowerToys GitHub Copilot/Claude Code issue review system
|
||||
# This is a trimmed version with only what issue-fix needs
|
||||
|
||||
#region Console Output Helpers
|
||||
function Info { param([string]$Message) Write-Host $Message -ForegroundColor Cyan }
|
||||
function Warn { param([string]$Message) Write-Host $Message -ForegroundColor Yellow }
|
||||
function Err { param([string]$Message) Write-Host $Message -ForegroundColor Red }
|
||||
function Success { param([string]$Message) Write-Host $Message -ForegroundColor Green }
|
||||
#endregion
|
||||
|
||||
#region Repository Helpers
|
||||
function Get-RepoRoot {
|
||||
$root = git rev-parse --show-toplevel 2>$null
|
||||
if (-not $root) { throw 'Not inside a git repository.' }
|
||||
return (Resolve-Path $root).Path
|
||||
}
|
||||
|
||||
function Get-GeneratedFilesPath {
|
||||
param([string]$RepoRoot)
|
||||
return Join-Path $RepoRoot 'Generated Files'
|
||||
}
|
||||
|
||||
function Get-IssueReviewPath {
|
||||
param(
|
||||
[string]$RepoRoot,
|
||||
[int]$IssueNumber
|
||||
)
|
||||
$genFiles = Get-GeneratedFilesPath -RepoRoot $RepoRoot
|
||||
return Join-Path $genFiles "issueReview/$IssueNumber"
|
||||
}
|
||||
|
||||
function Ensure-DirectoryExists {
|
||||
param([string]$Path)
|
||||
if (-not (Test-Path $Path)) {
|
||||
New-Item -ItemType Directory -Path $Path -Force | Out-Null
|
||||
}
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region CLI Detection
|
||||
function Get-AvailableCLI {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Detect which AI CLI is available: GitHub Copilot CLI or Claude Code.
|
||||
#>
|
||||
|
||||
# Check for standalone GitHub Copilot CLI
|
||||
$copilotCLI = Get-Command 'copilot' -ErrorAction SilentlyContinue
|
||||
if ($copilotCLI) {
|
||||
return @{ Name = 'GitHub Copilot CLI'; Command = 'copilot'; Type = 'copilot' }
|
||||
}
|
||||
|
||||
# Check for Claude Code CLI
|
||||
$claudeCode = Get-Command 'claude' -ErrorAction SilentlyContinue
|
||||
if ($claudeCode) {
|
||||
return @{ Name = 'Claude Code CLI'; Command = 'claude'; Type = 'claude' }
|
||||
}
|
||||
|
||||
# Check for GitHub Copilot CLI via gh extension
|
||||
$ghCopilot = Get-Command 'gh' -ErrorAction SilentlyContinue
|
||||
if ($ghCopilot) {
|
||||
$copilotCheck = gh extension list 2>&1 | Select-String -Pattern 'copilot'
|
||||
if ($copilotCheck) {
|
||||
return @{ Name = 'GitHub Copilot CLI (gh extension)'; Command = 'gh'; Type = 'gh-copilot' }
|
||||
}
|
||||
}
|
||||
|
||||
# Check for VS Code CLI
|
||||
$code = Get-Command 'code' -ErrorAction SilentlyContinue
|
||||
if ($code) {
|
||||
return @{ Name = 'VS Code (Copilot Chat)'; Command = 'code'; Type = 'vscode' }
|
||||
}
|
||||
|
||||
return $null
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Issue Review Results Helpers
|
||||
function Get-IssueReviewResult {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Check if an issue has been reviewed and get its results.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$IssueNumber,
|
||||
[Parameter(Mandatory)]
|
||||
[string]$RepoRoot
|
||||
)
|
||||
|
||||
$reviewPath = Get-IssueReviewPath -RepoRoot $RepoRoot -IssueNumber $IssueNumber
|
||||
|
||||
$result = @{
|
||||
IssueNumber = $IssueNumber
|
||||
Path = $reviewPath
|
||||
HasOverview = $false
|
||||
HasImplementationPlan = $false
|
||||
OverviewPath = $null
|
||||
ImplementationPlanPath = $null
|
||||
}
|
||||
|
||||
$overviewPath = Join-Path $reviewPath 'overview.md'
|
||||
$implPlanPath = Join-Path $reviewPath 'implementation-plan.md'
|
||||
|
||||
if (Test-Path $overviewPath) {
|
||||
$result.HasOverview = $true
|
||||
$result.OverviewPath = $overviewPath
|
||||
}
|
||||
|
||||
if (Test-Path $implPlanPath) {
|
||||
$result.HasImplementationPlan = $true
|
||||
$result.ImplementationPlanPath = $implPlanPath
|
||||
}
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
function Get-HighConfidenceIssues {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Find issues with high confidence for auto-fix based on review results.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[string]$RepoRoot,
|
||||
[int]$MinFeasibilityScore = 70,
|
||||
[int]$MinClarityScore = 60,
|
||||
[int]$MaxEffortDays = 2,
|
||||
[int[]]$FilterIssueNumbers = @()
|
||||
)
|
||||
|
||||
$genFiles = Get-GeneratedFilesPath -RepoRoot $RepoRoot
|
||||
$reviewDir = Join-Path $genFiles 'issueReview'
|
||||
|
||||
if (-not (Test-Path $reviewDir)) {
|
||||
return @()
|
||||
}
|
||||
|
||||
$highConfidence = @()
|
||||
|
||||
Get-ChildItem -Path $reviewDir -Directory | ForEach-Object {
|
||||
$issueNum = [int]$_.Name
|
||||
|
||||
if ($FilterIssueNumbers.Count -gt 0 -and $issueNum -notin $FilterIssueNumbers) {
|
||||
return
|
||||
}
|
||||
|
||||
$overviewPath = Join-Path $_.FullName 'overview.md'
|
||||
$implPlanPath = Join-Path $_.FullName 'implementation-plan.md'
|
||||
|
||||
if (-not (Test-Path $overviewPath) -or -not (Test-Path $implPlanPath)) {
|
||||
return
|
||||
}
|
||||
|
||||
$overview = Get-Content $overviewPath -Raw
|
||||
|
||||
$feasibility = 0
|
||||
$clarity = 0
|
||||
$effortDays = 999
|
||||
|
||||
if ($overview -match 'Technical Feasibility[^\d]*(\d+)/100') {
|
||||
$feasibility = [int]$Matches[1]
|
||||
}
|
||||
if ($overview -match 'Requirement Clarity[^\d]*(\d+)/100') {
|
||||
$clarity = [int]$Matches[1]
|
||||
}
|
||||
if ($overview -match 'Effort Estimate[^|]*\|\s*[\d.]+(?:-(\d+))?\s*days?') {
|
||||
if ($Matches[1]) {
|
||||
$effortDays = [int]$Matches[1]
|
||||
} elseif ($overview -match 'Effort Estimate[^|]*\|\s*(\d+)\s*days?') {
|
||||
$effortDays = [int]$Matches[1]
|
||||
}
|
||||
}
|
||||
if ($overview -match 'Effort Estimate[^|]*\|[^|]*\|\s*(XS|S)\b') {
|
||||
if ($Matches[1] -eq 'XS') { $effortDays = 1 } else { $effortDays = 2 }
|
||||
} elseif ($overview -match 'Effort Estimate[^|]*\|[^|]*\(XS\)') {
|
||||
$effortDays = 1
|
||||
} elseif ($overview -match 'Effort Estimate[^|]*\|[^|]*\(S\)') {
|
||||
$effortDays = 2
|
||||
}
|
||||
|
||||
if ($feasibility -ge $MinFeasibilityScore -and
|
||||
$clarity -ge $MinClarityScore -and
|
||||
$effortDays -le $MaxEffortDays) {
|
||||
|
||||
$highConfidence += @{
|
||||
IssueNumber = $issueNum
|
||||
FeasibilityScore = $feasibility
|
||||
ClarityScore = $clarity
|
||||
EffortDays = $effortDays
|
||||
OverviewPath = $overviewPath
|
||||
ImplementationPlanPath = $implPlanPath
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $highConfidence | Sort-Object -Property FeasibilityScore -Descending
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Release & PR Status Helpers
|
||||
function Get-PRReleaseStatus {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Check if a PR has been merged and released.
|
||||
.DESCRIPTION
|
||||
Queries GitHub to determine:
|
||||
1. If the PR is merged
|
||||
2. What release (if any) contains the merge commit
|
||||
.OUTPUTS
|
||||
@{
|
||||
PRNumber = <int>
|
||||
IsMerged = $true | $false
|
||||
MergeCommit = <commit sha or $null>
|
||||
ReleasedIn = <version string or $null> # e.g., "v0.90.0"
|
||||
IsReleased = $true | $false
|
||||
}
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$PRNumber,
|
||||
[string]$Repo = 'microsoft/PowerToys'
|
||||
)
|
||||
|
||||
$result = @{
|
||||
PRNumber = $PRNumber
|
||||
IsMerged = $false
|
||||
MergeCommit = $null
|
||||
ReleasedIn = $null
|
||||
IsReleased = $false
|
||||
}
|
||||
|
||||
try {
|
||||
# Get PR details from GitHub
|
||||
$prJson = gh pr view $PRNumber --repo $Repo --json state,mergeCommit,mergedAt 2>$null
|
||||
if (-not $prJson) {
|
||||
return $result
|
||||
}
|
||||
|
||||
$pr = $prJson | ConvertFrom-Json
|
||||
|
||||
if ($pr.state -eq 'MERGED' -and $pr.mergeCommit) {
|
||||
$result.IsMerged = $true
|
||||
$result.MergeCommit = $pr.mergeCommit.oid
|
||||
|
||||
# Check which release tags contain this commit
|
||||
# Use git tag --contains to find tags that include the merge commit
|
||||
$tags = git tag --contains $result.MergeCommit 2>$null
|
||||
|
||||
if ($tags) {
|
||||
# Filter to release tags (v0.XX.X pattern) and get the earliest one
|
||||
$releaseTags = $tags | Where-Object { $_ -match '^v\d+\.\d+\.\d+$' } | Sort-Object
|
||||
if ($releaseTags) {
|
||||
$result.ReleasedIn = $releaseTags | Select-Object -First 1
|
||||
$result.IsReleased = $true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
catch {
|
||||
# Silently fail - will return default "not merged" status
|
||||
}
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
function Get-LatestRelease {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Get the latest release version of PowerToys.
|
||||
#>
|
||||
param(
|
||||
[string]$Repo = 'microsoft/PowerToys'
|
||||
)
|
||||
|
||||
try {
|
||||
$releaseJson = gh release view --repo $Repo --json tagName 2>$null
|
||||
if ($releaseJson) {
|
||||
$release = $releaseJson | ConvertFrom-Json
|
||||
return $release.tagName
|
||||
}
|
||||
}
|
||||
catch {
|
||||
# Fallback: try to get from git tags
|
||||
$latestTag = git describe --tags --abbrev=0 2>$null
|
||||
if ($latestTag) {
|
||||
return $latestTag
|
||||
}
|
||||
}
|
||||
return $null
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Implementation Plan Analysis
|
||||
function Get-ImplementationPlanStatus {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Parse implementation-plan.md to determine the recommended action.
|
||||
.DESCRIPTION
|
||||
Reads the implementation plan and extracts the status/recommendation.
|
||||
For "already resolved" issues, also checks if the fix has been released.
|
||||
Returns an object indicating what action should be taken.
|
||||
.OUTPUTS
|
||||
@{
|
||||
Status = 'AlreadyResolved' | 'FixedButUnreleased' | 'NeedsClarification' | 'Duplicate' | 'WontFix' | 'ReadyToImplement' | 'Unknown'
|
||||
Action = 'CloseIssue' | 'AddComment' | 'LinkDuplicate' | 'ImplementFix' | 'Skip'
|
||||
Reason = <string explaining why>
|
||||
RelatedPR = <PR number if already fixed>
|
||||
ReleasedIn = <version if released, e.g., "v0.90.0">
|
||||
DuplicateOf = <issue number if duplicate>
|
||||
CommentText = <suggested comment if applicable>
|
||||
}
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[string]$ImplementationPlanPath,
|
||||
[switch]$SkipReleaseCheck
|
||||
)
|
||||
|
||||
$result = @{
|
||||
Status = 'Unknown'
|
||||
Action = 'Skip'
|
||||
Reason = 'Could not determine status from implementation plan'
|
||||
RelatedPR = $null
|
||||
ReleasedIn = $null
|
||||
DuplicateOf = $null
|
||||
CommentText = $null
|
||||
}
|
||||
|
||||
if (-not (Test-Path $ImplementationPlanPath)) {
|
||||
$result.Reason = 'Implementation plan file not found'
|
||||
return $result
|
||||
}
|
||||
|
||||
$content = Get-Content $ImplementationPlanPath -Raw
|
||||
|
||||
# Check for ALREADY RESOLVED status
|
||||
if ($content -match '(?i)STATUS:\s*ALREADY\s+RESOLVED' -or
|
||||
$content -match '(?i)⚠️\s*STATUS:\s*ALREADY\s+RESOLVED' -or
|
||||
$content -match '(?i)This issue has been fixed by' -or
|
||||
$content -match '(?i)No implementation work is needed') {
|
||||
|
||||
# Try to extract the PR number
|
||||
$prNumber = $null
|
||||
if ($content -match '\[PR #(\d+)\]' -or $content -match 'PR #(\d+)' -or $content -match '/pull/(\d+)') {
|
||||
$prNumber = [int]$Matches[1]
|
||||
$result.RelatedPR = $prNumber
|
||||
}
|
||||
|
||||
# Check if the fix has been released
|
||||
if ($prNumber -and -not $SkipReleaseCheck) {
|
||||
$prStatus = Get-PRReleaseStatus -PRNumber $prNumber
|
||||
|
||||
if ($prStatus.IsReleased) {
|
||||
# Fix is released - safe to close
|
||||
$result.Status = 'AlreadyResolved'
|
||||
$result.Action = 'CloseIssue'
|
||||
$result.ReleasedIn = $prStatus.ReleasedIn
|
||||
$result.Reason = "Issue fixed by PR #$prNumber, released in $($prStatus.ReleasedIn)"
|
||||
$result.CommentText = @"
|
||||
This issue has been fixed by PR #$prNumber and is available in **$($prStatus.ReleasedIn)**.
|
||||
|
||||
Please update to the latest version. If you're still experiencing this issue after updating, please reopen with additional details.
|
||||
"@
|
||||
}
|
||||
elseif ($prStatus.IsMerged) {
|
||||
# PR merged but not yet released - add comment but don't close
|
||||
$result.Status = 'FixedButUnreleased'
|
||||
$result.Action = 'AddComment'
|
||||
$result.Reason = "Issue fixed by PR #$prNumber, but not yet released"
|
||||
$result.CommentText = @"
|
||||
This issue has been fixed by PR #$prNumber, which has been merged but **not yet released**.
|
||||
|
||||
The fix will be available in the next PowerToys release. You can:
|
||||
- Wait for the next official release
|
||||
- Build from source to get the fix immediately
|
||||
|
||||
We'll close this issue once the fix is released.
|
||||
"@
|
||||
}
|
||||
else {
|
||||
# PR exists but not merged - treat as ready to implement (PR might have been reverted)
|
||||
$result.Status = 'ReadyToImplement'
|
||||
$result.Action = 'ImplementFix'
|
||||
$result.Reason = "PR #$prNumber exists but is not merged - may need reimplementation"
|
||||
}
|
||||
}
|
||||
elseif ($prNumber) {
|
||||
# Skip release check requested or no PR number - assume it's resolved
|
||||
$result.Status = 'AlreadyResolved'
|
||||
$result.Action = 'CloseIssue'
|
||||
$result.Reason = 'Issue has already been fixed'
|
||||
$result.CommentText = "This issue has been fixed by PR #$prNumber. Closing as resolved."
|
||||
}
|
||||
else {
|
||||
# No PR number found - just mark as resolved with generic message
|
||||
$result.Status = 'AlreadyResolved'
|
||||
$result.Action = 'CloseIssue'
|
||||
$result.Reason = 'Issue appears to have been resolved'
|
||||
$result.CommentText = "Based on analysis, this issue appears to have already been resolved. Please verify and reopen if the issue persists."
|
||||
}
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
# Check for DUPLICATE status
|
||||
if ($content -match '(?i)STATUS:\s*DUPLICATE' -or
|
||||
$content -match '(?i)This is a duplicate of' -or
|
||||
$content -match '(?i)duplicate of #(\d+)') {
|
||||
|
||||
$result.Status = 'Duplicate'
|
||||
$result.Action = 'LinkDuplicate'
|
||||
$result.Reason = 'Issue is a duplicate'
|
||||
|
||||
# Try to extract the duplicate issue number
|
||||
if ($content -match 'duplicate of #(\d+)' -or $content -match '#(\d+)') {
|
||||
$result.DuplicateOf = [int]$Matches[1]
|
||||
$result.CommentText = "This appears to be a duplicate of #$($result.DuplicateOf)."
|
||||
}
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
# Check for NEEDS CLARIFICATION status
|
||||
if ($content -match '(?i)STATUS:\s*NEEDS?\s+CLARIFICATION' -or
|
||||
$content -match '(?i)STATUS:\s*NEEDS?\s+MORE\s+INFO' -or
|
||||
$content -match '(?i)cannot proceed without' -or
|
||||
$content -match '(?i)need(?:s)? more information') {
|
||||
|
||||
$result.Status = 'NeedsClarification'
|
||||
$result.Action = 'AddComment'
|
||||
$result.Reason = 'Issue needs more information from reporter'
|
||||
|
||||
# Try to extract what information is needed
|
||||
if ($content -match '(?i)(?:need(?:s)?|require(?:s)?|missing)[:\s]+([^\n]+)') {
|
||||
$result.CommentText = "Additional information is needed to proceed with this issue: $($Matches[1].Trim())"
|
||||
} else {
|
||||
$result.CommentText = "Could you please provide more details about this issue? Specifically, steps to reproduce and expected vs actual behavior would help."
|
||||
}
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
# Check for WONT FIX / NOT FEASIBLE status
|
||||
if ($content -match '(?i)STATUS:\s*(?:WONT?\s+FIX|NOT\s+FEASIBLE|REJECTED)' -or
|
||||
$content -match '(?i)(?:not|cannot be) (?:feasible|implemented)' -or
|
||||
$content -match '(?i)recommend(?:ed)?\s+(?:to\s+)?close') {
|
||||
|
||||
$result.Status = 'WontFix'
|
||||
$result.Action = 'AddComment'
|
||||
$result.Reason = 'Issue is not feasible or recommended to close'
|
||||
|
||||
# Try to extract the reason
|
||||
if ($content -match '(?i)(?:because|reason|due to)[:\s]+([^\n]+)') {
|
||||
$result.CommentText = "After analysis, this issue cannot be implemented: $($Matches[1].Trim())"
|
||||
}
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
# Check for external dependency / blocked status
|
||||
if ($content -match '(?i)STATUS:\s*BLOCKED' -or
|
||||
$content -match '(?i)blocked by' -or
|
||||
$content -match '(?i)depends on external' -or
|
||||
$content -match '(?i)waiting for upstream') {
|
||||
|
||||
$result.Status = 'Blocked'
|
||||
$result.Action = 'AddComment'
|
||||
$result.Reason = 'Issue is blocked by external dependency'
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
# Check for READY TO IMPLEMENT (positive signals)
|
||||
if ($content -match '(?i)## \d+\)\s*Task Breakdown' -or
|
||||
$content -match '(?i)implementation steps' -or
|
||||
$content -match '(?i)## Layers & Files' -or
|
||||
($content -match '(?i)Feasibility' -and $content -notmatch '(?i)not\s+feasible')) {
|
||||
|
||||
$result.Status = 'ReadyToImplement'
|
||||
$result.Action = 'ImplementFix'
|
||||
$result.Reason = 'Implementation plan is ready'
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
# Default: if we have a detailed plan, assume it's ready
|
||||
if ($content.Length -gt 500 -and $content -match '(?i)##') {
|
||||
$result.Status = 'ReadyToImplement'
|
||||
$result.Action = 'ImplementFix'
|
||||
$result.Reason = 'Implementation plan appears complete'
|
||||
}
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
function Invoke-ImplementationPlanAction {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Execute the recommended action from the implementation plan analysis.
|
||||
.DESCRIPTION
|
||||
Based on the status from Get-ImplementationPlanStatus, takes appropriate action:
|
||||
- CloseIssue: Closes the issue with a comment
|
||||
- AddComment: Adds a comment to the issue
|
||||
- LinkDuplicate: Marks as duplicate
|
||||
- ImplementFix: Returns $true to indicate code fix should proceed
|
||||
- Skip: Returns $false
|
||||
.OUTPUTS
|
||||
@{
|
||||
ActionTaken = <string describing what was done>
|
||||
ShouldProceedWithFix = $true | $false
|
||||
Success = $true | $false
|
||||
}
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$IssueNumber,
|
||||
[Parameter(Mandatory)]
|
||||
[hashtable]$PlanStatus,
|
||||
[switch]$DryRun
|
||||
)
|
||||
|
||||
$result = @{
|
||||
ActionTaken = 'None'
|
||||
ShouldProceedWithFix = $false
|
||||
Success = $true
|
||||
}
|
||||
|
||||
switch ($PlanStatus.Action) {
|
||||
'ImplementFix' {
|
||||
$result.ActionTaken = 'Proceeding with code fix'
|
||||
$result.ShouldProceedWithFix = $true
|
||||
Info "[Issue #$IssueNumber] Status: $($PlanStatus.Status) - $($PlanStatus.Reason)"
|
||||
}
|
||||
|
||||
'CloseIssue' {
|
||||
$result.ActionTaken = "Closing issue: $($PlanStatus.Reason)"
|
||||
Info "[Issue #$IssueNumber] $($PlanStatus.Status): $($PlanStatus.Reason)"
|
||||
|
||||
if (-not $DryRun) {
|
||||
$comment = $PlanStatus.CommentText
|
||||
if (-not $comment) {
|
||||
$comment = "Closing based on automated analysis: $($PlanStatus.Reason)"
|
||||
}
|
||||
|
||||
try {
|
||||
# Add comment explaining closure
|
||||
gh issue comment $IssueNumber --body $comment 2>&1 | Out-Null
|
||||
|
||||
# Close the issue
|
||||
if ($PlanStatus.RelatedPR) {
|
||||
gh issue close $IssueNumber --reason "completed" --comment "Resolved by PR #$($PlanStatus.RelatedPR)" 2>&1 | Out-Null
|
||||
} else {
|
||||
gh issue close $IssueNumber --reason "completed" 2>&1 | Out-Null
|
||||
}
|
||||
|
||||
Success "[Issue #$IssueNumber] ✓ Closed with comment"
|
||||
}
|
||||
catch {
|
||||
Err "[Issue #$IssueNumber] Failed to close: $($_.Exception.Message)"
|
||||
$result.Success = $false
|
||||
}
|
||||
} else {
|
||||
Info "[Issue #$IssueNumber] (DryRun) Would close with: $($PlanStatus.CommentText)"
|
||||
}
|
||||
}
|
||||
|
||||
'AddComment' {
|
||||
$result.ActionTaken = "Adding comment: $($PlanStatus.Reason)"
|
||||
Info "[Issue #$IssueNumber] $($PlanStatus.Status): $($PlanStatus.Reason)"
|
||||
|
||||
if (-not $DryRun -and $PlanStatus.CommentText) {
|
||||
try {
|
||||
gh issue comment $IssueNumber --body $PlanStatus.CommentText 2>&1 | Out-Null
|
||||
Success "[Issue #$IssueNumber] ✓ Comment added"
|
||||
}
|
||||
catch {
|
||||
Err "[Issue #$IssueNumber] Failed to add comment: $($_.Exception.Message)"
|
||||
$result.Success = $false
|
||||
}
|
||||
} else {
|
||||
Info "[Issue #$IssueNumber] (DryRun) Would comment: $($PlanStatus.CommentText)"
|
||||
}
|
||||
}
|
||||
|
||||
'LinkDuplicate' {
|
||||
$result.ActionTaken = "Marking as duplicate of #$($PlanStatus.DuplicateOf)"
|
||||
Info "[Issue #$IssueNumber] Duplicate of #$($PlanStatus.DuplicateOf)"
|
||||
|
||||
if (-not $DryRun -and $PlanStatus.DuplicateOf) {
|
||||
try {
|
||||
gh issue close $IssueNumber --reason "not_planned" --comment "Closing as duplicate of #$($PlanStatus.DuplicateOf)" 2>&1 | Out-Null
|
||||
Success "[Issue #$IssueNumber] ✓ Closed as duplicate"
|
||||
}
|
||||
catch {
|
||||
Err "[Issue #$IssueNumber] Failed to close as duplicate: $($_.Exception.Message)"
|
||||
$result.Success = $false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
'Skip' {
|
||||
$result.ActionTaken = "Skipped: $($PlanStatus.Reason)"
|
||||
Warn "[Issue #$IssueNumber] Skipping: $($PlanStatus.Reason)"
|
||||
}
|
||||
}
|
||||
|
||||
return $result
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Worktree Integration
|
||||
function Copy-IssueReviewToWorktree {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Copy the Generated Files for an issue to a worktree.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$IssueNumber,
|
||||
[Parameter(Mandatory)]
|
||||
[string]$SourceRepoRoot,
|
||||
[Parameter(Mandatory)]
|
||||
[string]$WorktreePath
|
||||
)
|
||||
|
||||
$sourceReviewPath = Get-IssueReviewPath -RepoRoot $SourceRepoRoot -IssueNumber $IssueNumber
|
||||
$destReviewPath = Get-IssueReviewPath -RepoRoot $WorktreePath -IssueNumber $IssueNumber
|
||||
|
||||
if (-not (Test-Path $sourceReviewPath)) {
|
||||
throw "Issue review files not found at: $sourceReviewPath"
|
||||
}
|
||||
|
||||
Ensure-DirectoryExists -Path $destReviewPath
|
||||
|
||||
Copy-Item -Path "$sourceReviewPath\*" -Destination $destReviewPath -Recurse -Force
|
||||
|
||||
Info "Copied issue review files to: $destReviewPath"
|
||||
|
||||
return $destReviewPath
|
||||
}
|
||||
#endregion
|
||||
@@ -1,530 +0,0 @@
|
||||
<#!
|
||||
.SYNOPSIS
|
||||
Auto-fix high-confidence issues using worktrees and AI CLI.
|
||||
|
||||
.DESCRIPTION
|
||||
Finds issues with high confidence scores from the review results, creates worktrees
|
||||
for each, copies the Generated Files, and kicks off the FixIssue agent to implement fixes.
|
||||
|
||||
.PARAMETER IssueNumber
|
||||
Specific issue number to fix. If not specified, finds high-confidence issues automatically.
|
||||
|
||||
.PARAMETER MinFeasibilityScore
|
||||
Minimum Technical Feasibility score (0-100). Default: 70.
|
||||
|
||||
.PARAMETER MinClarityScore
|
||||
Minimum Requirement Clarity score (0-100). Default: 60.
|
||||
|
||||
.PARAMETER MaxEffortDays
|
||||
Maximum effort estimate in days. Default: 2 (Small fixes).
|
||||
|
||||
.PARAMETER MaxParallel
|
||||
Maximum parallel fix jobs. Default: 5 (worktrees are resource-intensive).
|
||||
|
||||
.PARAMETER CLIType
|
||||
AI CLI to use: claude, gh-copilot, or vscode. Auto-detected if not specified.
|
||||
|
||||
.PARAMETER DryRun
|
||||
List issues without starting fixes.
|
||||
|
||||
.PARAMETER SkipWorktree
|
||||
Fix in the current repository instead of creating worktrees (useful for single issue).
|
||||
|
||||
.PARAMETER VSCodeProfile
|
||||
VS Code profile to use when opening worktrees. Default: Default.
|
||||
|
||||
.PARAMETER AutoCommit
|
||||
Automatically commit changes after successful fix.
|
||||
|
||||
.PARAMETER CreatePR
|
||||
Automatically create a pull request after successful fix.
|
||||
|
||||
.EXAMPLE
|
||||
# Fix a specific issue
|
||||
./Start-IssueAutoFix.ps1 -IssueNumber 12345
|
||||
|
||||
.EXAMPLE
|
||||
# Find and fix all high-confidence issues (dry run)
|
||||
./Start-IssueAutoFix.ps1 -DryRun
|
||||
|
||||
.EXAMPLE
|
||||
# Fix issues with very high confidence
|
||||
./Start-IssueAutoFix.ps1 -MinFeasibilityScore 80 -MinClarityScore 70 -MaxEffortDays 1
|
||||
|
||||
.EXAMPLE
|
||||
# Fix single issue in current repo (no worktree)
|
||||
./Start-IssueAutoFix.ps1 -IssueNumber 12345 -SkipWorktree
|
||||
|
||||
.NOTES
|
||||
Prerequisites:
|
||||
- Run Start-BulkIssueReview.ps1 first to generate review files
|
||||
- GitHub CLI (gh) authenticated
|
||||
- Claude Code CLI or VS Code with Copilot
|
||||
|
||||
Results:
|
||||
- Worktrees created at ../<RepoName>-<hash>/
|
||||
- Generated Files copied to each worktree
|
||||
- Fix agent invoked in each worktree
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[int]$IssueNumber,
|
||||
|
||||
[int]$MinFeasibilityScore = 70,
|
||||
|
||||
[int]$MinClarityScore = 60,
|
||||
|
||||
[int]$MaxEffortDays = 2,
|
||||
|
||||
[int]$MaxParallel = 5,
|
||||
|
||||
[ValidateSet('claude', 'copilot', 'gh-copilot', 'vscode', 'auto')]
|
||||
[string]$CLIType = 'auto',
|
||||
|
||||
[switch]$DryRun,
|
||||
|
||||
[switch]$SkipWorktree,
|
||||
|
||||
[Alias('Profile')]
|
||||
[string]$VSCodeProfile = 'Default',
|
||||
|
||||
[switch]$AutoCommit,
|
||||
|
||||
[switch]$CreatePR,
|
||||
|
||||
[switch]$Force,
|
||||
|
||||
[switch]$Help
|
||||
)
|
||||
|
||||
# Load libraries
|
||||
$scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
|
||||
. "$scriptDir/IssueReviewLib.ps1"
|
||||
|
||||
# Load worktree library from tools/build
|
||||
$repoRoot = Get-RepoRoot
|
||||
$worktreeLib = Join-Path $repoRoot 'tools/build/WorktreeLib.ps1'
|
||||
if (Test-Path $worktreeLib) {
|
||||
. $worktreeLib
|
||||
}
|
||||
|
||||
# Show help
|
||||
if ($Help) {
|
||||
Get-Help $MyInvocation.MyCommand.Path -Full
|
||||
return
|
||||
}
|
||||
|
||||
function Start-IssueFixInWorktree {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Analyze implementation plan and either take action or create worktree for fix.
|
||||
.DESCRIPTION
|
||||
First analyzes the implementation plan to determine if:
|
||||
- Issue is already resolved (close it)
|
||||
- Issue needs clarification (add comment)
|
||||
- Issue is a duplicate (close as duplicate)
|
||||
- Issue is ready to implement (create worktree and fix)
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$IssueNumber,
|
||||
[Parameter(Mandatory)]
|
||||
[string]$SourceRepoRoot,
|
||||
[string]$CLIType = 'claude',
|
||||
[string]$VSCodeProfile = 'Default',
|
||||
[switch]$SkipWorktree,
|
||||
[switch]$DryRun
|
||||
)
|
||||
|
||||
$issueReviewPath = Get-IssueReviewPath -RepoRoot $SourceRepoRoot -IssueNumber $IssueNumber
|
||||
$overviewPath = Join-Path $issueReviewPath 'overview.md'
|
||||
$implPlanPath = Join-Path $issueReviewPath 'implementation-plan.md'
|
||||
|
||||
# Verify review files exist
|
||||
if (-not (Test-Path $overviewPath)) {
|
||||
throw "No overview.md found for issue #$IssueNumber. Run Start-BulkIssueReview.ps1 first."
|
||||
}
|
||||
if (-not (Test-Path $implPlanPath)) {
|
||||
throw "No implementation-plan.md found for issue #$IssueNumber. Run Start-BulkIssueReview.ps1 first."
|
||||
}
|
||||
|
||||
# =====================================
|
||||
# STEP 1: Analyze the implementation plan
|
||||
# =====================================
|
||||
Info "Analyzing implementation plan for issue #$IssueNumber..."
|
||||
$planStatus = Get-ImplementationPlanStatus -ImplementationPlanPath $implPlanPath
|
||||
|
||||
# =====================================
|
||||
# STEP 2: Execute the recommended action
|
||||
# =====================================
|
||||
$actionResult = Invoke-ImplementationPlanAction -IssueNumber $IssueNumber -PlanStatus $planStatus -DryRun:$DryRun
|
||||
|
||||
# If we shouldn't proceed with fix, return early
|
||||
if (-not $actionResult.ShouldProceedWithFix) {
|
||||
return @{
|
||||
IssueNumber = $IssueNumber
|
||||
WorktreePath = $null
|
||||
Success = $actionResult.Success
|
||||
ActionTaken = $actionResult.ActionTaken
|
||||
SkippedCodeFix = $true
|
||||
}
|
||||
}
|
||||
|
||||
# =====================================
|
||||
# STEP 3: Proceed with code fix
|
||||
# =====================================
|
||||
|
||||
$workingDir = $SourceRepoRoot
|
||||
|
||||
if (-not $SkipWorktree) {
|
||||
# Use the simplified New-WorktreeFromIssue.cmd which only needs issue number
|
||||
$worktreeCmd = Join-Path $SourceRepoRoot 'tools/build/New-WorktreeFromIssue.cmd'
|
||||
|
||||
Info "Creating worktree for issue #$IssueNumber..."
|
||||
|
||||
# Call the cmd script with issue number and -NoVSCode for automation
|
||||
& cmd /c $worktreeCmd $IssueNumber -NoVSCode
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
throw "Failed to create worktree for issue #$IssueNumber"
|
||||
}
|
||||
|
||||
# Find the created worktree
|
||||
$entries = Get-WorktreeEntries
|
||||
$worktreeEntry = $entries | Where-Object { $_.Branch -like "issue/$IssueNumber*" } | Select-Object -First 1
|
||||
|
||||
if (-not $worktreeEntry) {
|
||||
throw "Failed to find worktree for issue #$IssueNumber"
|
||||
}
|
||||
|
||||
$workingDir = $worktreeEntry.Path
|
||||
Info "Worktree created at: $workingDir"
|
||||
|
||||
# Copy Generated Files to worktree
|
||||
Info "Copying review files to worktree..."
|
||||
$destReviewPath = Copy-IssueReviewToWorktree -IssueNumber $IssueNumber -SourceRepoRoot $SourceRepoRoot -WorktreePath $workingDir
|
||||
Info "Review files copied to: $destReviewPath"
|
||||
|
||||
# Copy .github/skills folder to worktree (needed for MCP config)
|
||||
$sourceSkillsPath = Join-Path $SourceRepoRoot '.github/skills'
|
||||
$destSkillsPath = Join-Path $workingDir '.github/skills'
|
||||
if (Test-Path $sourceSkillsPath) {
|
||||
$destGithubPath = Join-Path $workingDir '.github'
|
||||
if (-not (Test-Path $destGithubPath)) {
|
||||
New-Item -ItemType Directory -Path $destGithubPath -Force | Out-Null
|
||||
}
|
||||
Copy-Item -Path $sourceSkillsPath -Destination $destGithubPath -Recurse -Force
|
||||
Info "Copied .github/skills to worktree"
|
||||
}
|
||||
}
|
||||
|
||||
# Build the prompt for the fix agent
|
||||
$prompt = @"
|
||||
You are the FixIssue agent. Fix GitHub issue #$IssueNumber.
|
||||
|
||||
The implementation plan is at: Generated Files/issueReview/$IssueNumber/implementation-plan.md
|
||||
The overview is at: Generated Files/issueReview/$IssueNumber/overview.md
|
||||
|
||||
Follow the implementation plan exactly. Build and verify after each change.
|
||||
"@
|
||||
|
||||
# Start the fix agent
|
||||
Info "Starting fix agent for issue #$IssueNumber in $workingDir..."
|
||||
|
||||
# MCP config for github-artifacts tools (relative to repo root)
|
||||
$mcpConfig = '@.github/skills/issue-fix/references/mcp-config.json'
|
||||
|
||||
switch ($CLIType) {
|
||||
'copilot' {
|
||||
# GitHub Copilot CLI (standalone copilot command)
|
||||
# -p: Non-interactive prompt mode (exits after completion)
|
||||
# --yolo: Enable all permissions for automated execution
|
||||
# -s: Silent mode - output only agent response
|
||||
# --additional-mcp-config: Load github-artifacts MCP for image/attachment analysis
|
||||
$copilotArgs = @(
|
||||
'--additional-mcp-config', $mcpConfig,
|
||||
'-p', $prompt,
|
||||
'--yolo',
|
||||
'-s'
|
||||
)
|
||||
Info "Running: copilot $($copilotArgs -join ' ')"
|
||||
Push-Location $workingDir
|
||||
try {
|
||||
& copilot @copilotArgs
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
Warn "Copilot exited with code $LASTEXITCODE"
|
||||
}
|
||||
} finally {
|
||||
Pop-Location
|
||||
}
|
||||
}
|
||||
'claude' {
|
||||
$claudeArgs = @(
|
||||
'--print',
|
||||
'--dangerously-skip-permissions',
|
||||
'--prompt', $prompt
|
||||
)
|
||||
Start-Process -FilePath 'claude' -ArgumentList $claudeArgs -WorkingDirectory $workingDir -Wait -NoNewWindow
|
||||
}
|
||||
'gh-copilot' {
|
||||
# Use GitHub Copilot CLI via gh extension
|
||||
# gh copilot suggest requires interactive mode, so we open VS Code with the prompt
|
||||
Info "GitHub Copilot CLI detected. Opening VS Code with prompt..."
|
||||
|
||||
# Create a prompt file in the worktree for easy access
|
||||
$promptFile = Join-Path $workingDir "Generated Files/issueReview/$IssueNumber/fix-prompt.md"
|
||||
$promptContent = @"
|
||||
# Fix Issue #$IssueNumber
|
||||
|
||||
## Instructions
|
||||
|
||||
$prompt
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Read the implementation plan: ``Generated Files/issueReview/$IssueNumber/implementation-plan.md``
|
||||
2. Read the overview: ``Generated Files/issueReview/$IssueNumber/overview.md``
|
||||
3. Follow the plan step by step
|
||||
4. Build and test after each change
|
||||
"@
|
||||
Set-Content -Path $promptFile -Value $promptContent -Force
|
||||
|
||||
# Open VS Code with the worktree
|
||||
code --new-window $workingDir --profile $VSCodeProfile
|
||||
Info "VS Code opened at $workingDir"
|
||||
Info "Prompt file created at: $promptFile"
|
||||
Info "Use GitHub Copilot in VS Code to implement the fix."
|
||||
}
|
||||
'vscode' {
|
||||
# Open VS Code and let user manually trigger the fix
|
||||
code --new-window $workingDir --profile $VSCodeProfile
|
||||
Info "VS Code opened at $workingDir. Use Copilot to implement the fix."
|
||||
}
|
||||
default {
|
||||
Warn "CLI type '$CLIType' not fully supported for auto-fix. Opening VS Code..."
|
||||
code --new-window $workingDir --profile $VSCodeProfile
|
||||
}
|
||||
}
|
||||
|
||||
# Check if any changes were actually made
|
||||
$hasChanges = $false
|
||||
Push-Location $workingDir
|
||||
try {
|
||||
$uncommitted = git status --porcelain 2>$null
|
||||
$commitsAhead = git rev-list main..HEAD --count 2>$null
|
||||
if ($uncommitted -or ($commitsAhead -gt 0)) {
|
||||
$hasChanges = $true
|
||||
}
|
||||
} finally {
|
||||
Pop-Location
|
||||
}
|
||||
|
||||
return @{
|
||||
IssueNumber = $IssueNumber
|
||||
WorktreePath = $workingDir
|
||||
Success = $true
|
||||
ActionTaken = 'CodeFixAttempted'
|
||||
SkippedCodeFix = $false
|
||||
HasChanges = $hasChanges
|
||||
}
|
||||
}
|
||||
|
||||
#region Main Script
|
||||
try {
|
||||
Info "Repository root: $repoRoot"
|
||||
|
||||
# Detect or validate CLI
|
||||
if ($CLIType -eq 'auto') {
|
||||
$cli = Get-AvailableCLI
|
||||
if ($cli) {
|
||||
$CLIType = $cli.Type
|
||||
Info "Auto-detected CLI: $($cli.Name)"
|
||||
} else {
|
||||
$CLIType = 'vscode'
|
||||
Info "No CLI detected, will use VS Code"
|
||||
}
|
||||
}
|
||||
|
||||
# Find issues to fix
|
||||
$issuesToFix = @()
|
||||
|
||||
if ($IssueNumber) {
|
||||
# Single issue specified
|
||||
$reviewResult = Get-IssueReviewResult -IssueNumber $IssueNumber -RepoRoot $repoRoot
|
||||
if (-not $reviewResult.HasOverview -or -not $reviewResult.HasImplementationPlan) {
|
||||
throw "Issue #$IssueNumber does not have review files. Run Start-BulkIssueReview.ps1 first."
|
||||
}
|
||||
$issuesToFix += @{
|
||||
IssueNumber = $IssueNumber
|
||||
OverviewPath = $reviewResult.OverviewPath
|
||||
ImplementationPlanPath = $reviewResult.ImplementationPlanPath
|
||||
}
|
||||
} else {
|
||||
# Find high-confidence issues
|
||||
Info "`nSearching for high-confidence issues..."
|
||||
Info " Min Feasibility Score: $MinFeasibilityScore"
|
||||
Info " Min Clarity Score: $MinClarityScore"
|
||||
Info " Max Effort: $MaxEffortDays days"
|
||||
|
||||
$highConfidence = Get-HighConfidenceIssues `
|
||||
-RepoRoot $repoRoot `
|
||||
-MinFeasibilityScore $MinFeasibilityScore `
|
||||
-MinClarityScore $MinClarityScore `
|
||||
-MaxEffortDays $MaxEffortDays
|
||||
|
||||
if ($highConfidence.Count -eq 0) {
|
||||
Warn "No high-confidence issues found matching criteria."
|
||||
Info "Try lowering the score thresholds or increasing MaxEffortDays."
|
||||
return
|
||||
}
|
||||
|
||||
$issuesToFix = $highConfidence
|
||||
}
|
||||
|
||||
Info "`nIssues ready for auto-fix: $($issuesToFix.Count)"
|
||||
Info ("-" * 80)
|
||||
foreach ($issue in $issuesToFix) {
|
||||
$scores = ""
|
||||
if ($issue.FeasibilityScore) {
|
||||
$scores = " [Feasibility: $($issue.FeasibilityScore), Clarity: $($issue.ClarityScore), Effort: $($issue.EffortDays)d]"
|
||||
}
|
||||
Info ("#{0,-6}{1}" -f $issue.IssueNumber, $scores)
|
||||
}
|
||||
Info ("-" * 80)
|
||||
|
||||
# In DryRun mode, still analyze plans but don't take action
|
||||
if ($DryRun) {
|
||||
Info "`nAnalyzing implementation plans (dry run)..."
|
||||
foreach ($issue in $issuesToFix) {
|
||||
$implPlanPath = Join-Path (Get-IssueReviewPath -RepoRoot $repoRoot -IssueNumber $issue.IssueNumber) 'implementation-plan.md'
|
||||
if (Test-Path $implPlanPath) {
|
||||
$planStatus = Get-ImplementationPlanStatus -ImplementationPlanPath $implPlanPath
|
||||
$color = switch ($planStatus.Action) {
|
||||
'ImplementFix' { 'Green' }
|
||||
'CloseIssue' { 'Yellow' }
|
||||
'AddComment' { 'Cyan' }
|
||||
'LinkDuplicate' { 'Magenta' }
|
||||
default { 'Gray' }
|
||||
}
|
||||
Write-Host (" #{0,-6} [{1,-20}] -> {2}" -f $issue.IssueNumber, $planStatus.Status, $planStatus.Action) -ForegroundColor $color
|
||||
if ($planStatus.RelatedPR) {
|
||||
$prInfo = "PR #$($planStatus.RelatedPR)"
|
||||
if ($planStatus.ReleasedIn) {
|
||||
$prInfo += " (released in $($planStatus.ReleasedIn))"
|
||||
} elseif ($planStatus.Status -eq 'FixedButUnreleased') {
|
||||
$prInfo += " (merged, awaiting release)"
|
||||
}
|
||||
Write-Host " $prInfo" -ForegroundColor DarkGray
|
||||
}
|
||||
if ($planStatus.DuplicateOf) {
|
||||
Write-Host " Duplicate of #$($planStatus.DuplicateOf)" -ForegroundColor DarkGray
|
||||
}
|
||||
}
|
||||
}
|
||||
Warn "`nDry run mode - no actions taken."
|
||||
return
|
||||
}
|
||||
|
||||
# Confirm before proceeding (skip if -Force)
|
||||
if (-not $Force) {
|
||||
$confirm = Read-Host "`nProceed with fixing $($issuesToFix.Count) issues? (y/N)"
|
||||
if ($confirm -notmatch '^[yY]') {
|
||||
Info "Cancelled."
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
# Process issues
|
||||
$results = @{
|
||||
Succeeded = @()
|
||||
Failed = @()
|
||||
AlreadyResolved = @()
|
||||
AwaitingRelease = @()
|
||||
NeedsClarification = @()
|
||||
Duplicates = @()
|
||||
NoChanges = @()
|
||||
}
|
||||
|
||||
foreach ($issue in $issuesToFix) {
|
||||
try {
|
||||
Info "`n" + ("=" * 60)
|
||||
Info "PROCESSING ISSUE #$($issue.IssueNumber)"
|
||||
Info ("=" * 60)
|
||||
|
||||
$result = Start-IssueFixInWorktree `
|
||||
-IssueNumber $issue.IssueNumber `
|
||||
-SourceRepoRoot $repoRoot `
|
||||
-CLIType $CLIType `
|
||||
-VSCodeProfile $VSCodeProfile `
|
||||
-SkipWorktree:$SkipWorktree `
|
||||
-DryRun:$DryRun
|
||||
|
||||
if ($result.SkippedCodeFix) {
|
||||
# Action was taken but no code fix (e.g., closed issue, added comment)
|
||||
switch -Wildcard ($result.ActionTaken) {
|
||||
'*Closing*' { $results.AlreadyResolved += $issue.IssueNumber }
|
||||
'*clarification*' { $results.NeedsClarification += $issue.IssueNumber }
|
||||
'*duplicate*' { $results.Duplicates += $issue.IssueNumber }
|
||||
'*merged*awaiting*' { $results.AwaitingRelease += $issue.IssueNumber }
|
||||
'*merged but not yet released*' { $results.AwaitingRelease += $issue.IssueNumber }
|
||||
default { $results.Succeeded += $issue.IssueNumber }
|
||||
}
|
||||
Success "✓ Issue #$($issue.IssueNumber) handled: $($result.ActionTaken)"
|
||||
}
|
||||
elseif ($result.HasChanges) {
|
||||
$results.Succeeded += $issue.IssueNumber
|
||||
Success "✓ Issue #$($issue.IssueNumber) fix completed with changes"
|
||||
}
|
||||
else {
|
||||
$results.NoChanges += $issue.IssueNumber
|
||||
Warn "⚠ Issue #$($issue.IssueNumber) fix ran but no code changes were made"
|
||||
}
|
||||
}
|
||||
catch {
|
||||
Err "✗ Issue #$($issue.IssueNumber) failed: $($_.Exception.Message)"
|
||||
$results.Failed += $issue.IssueNumber
|
||||
}
|
||||
}
|
||||
|
||||
# Summary
|
||||
Info "`n" + ("=" * 80)
|
||||
Info "AUTO-FIX COMPLETE"
|
||||
Info ("=" * 80)
|
||||
Info "Total issues: $($issuesToFix.Count)"
|
||||
if ($results.Succeeded.Count -gt 0) {
|
||||
Success "Code fixes: $($results.Succeeded.Count)"
|
||||
}
|
||||
if ($results.AlreadyResolved.Count -gt 0) {
|
||||
Success "Already resolved: $($results.AlreadyResolved.Count) (issues closed)"
|
||||
}
|
||||
if ($results.AwaitingRelease.Count -gt 0) {
|
||||
Info "Awaiting release: $($results.AwaitingRelease.Count) (fix merged, pending release)"
|
||||
}
|
||||
if ($results.NeedsClarification.Count -gt 0) {
|
||||
Warn "Need clarification: $($results.NeedsClarification.Count) (comments added)"
|
||||
}
|
||||
if ($results.Duplicates.Count -gt 0) {
|
||||
Warn "Duplicates: $($results.Duplicates.Count) (issues closed)"
|
||||
}
|
||||
if ($results.NoChanges.Count -gt 0) {
|
||||
Warn "No changes made: $($results.NoChanges.Count)"
|
||||
}
|
||||
if ($results.Failed.Count -gt 0) {
|
||||
Err "Failed: $($results.Failed.Count)"
|
||||
Err "Failed issues: $($results.Failed -join ', ')"
|
||||
}
|
||||
Info ("=" * 80)
|
||||
|
||||
if (-not $SkipWorktree -and ($results.Succeeded.Count -gt 0 -or $results.NoChanges.Count -gt 0)) {
|
||||
Info "`nWorktrees created. Use 'git worktree list' to see all worktrees."
|
||||
Info "To clean up: Delete-Worktree.ps1 -Branch issue/<number>"
|
||||
}
|
||||
|
||||
return $results
|
||||
}
|
||||
catch {
|
||||
Err "Error: $($_.Exception.Message)"
|
||||
exit 1
|
||||
}
|
||||
#endregion
|
||||
21
.github/skills/issue-review/LICENSE.txt
vendored
21
.github/skills/issue-review/LICENSE.txt
vendored
@@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) Microsoft Corporation.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
114
.github/skills/issue-review/SKILL.md
vendored
114
.github/skills/issue-review/SKILL.md
vendored
@@ -1,114 +0,0 @@
|
||||
---
|
||||
name: issue-review
|
||||
description: Analyze GitHub issues for feasibility and implementation planning. Use when asked to review an issue, analyze if an issue is fixable, evaluate issue complexity, create implementation plan for an issue, triage issues, assess technical feasibility, or estimate effort for an issue. Outputs structured analysis including feasibility score, clarity score, effort estimate, and detailed implementation plan.
|
||||
license: Complete terms in LICENSE.txt
|
||||
---
|
||||
|
||||
# Issue Review Skill
|
||||
|
||||
Analyze GitHub issues to determine technical feasibility, requirement clarity, and create detailed implementation plans for PowerToys.
|
||||
|
||||
## Skill Contents
|
||||
|
||||
This skill is **self-contained** with all required resources:
|
||||
|
||||
```
|
||||
.github/skills/issue-review/
|
||||
├── SKILL.md # This file
|
||||
├── LICENSE.txt # MIT License
|
||||
├── scripts/
|
||||
│ ├── IssueReviewLib.ps1 # Shared library functions
|
||||
│ └── Start-BulkIssueReview.ps1 # Main review script
|
||||
└── references/
|
||||
└── review-issue.prompt.md # Full AI prompt template
|
||||
```
|
||||
|
||||
## Output Directory
|
||||
|
||||
All generated artifacts are placed under `Generated Files/issueReview/<issue-number>/` at the repository root (gitignored).
|
||||
|
||||
```
|
||||
Generated Files/issueReview/
|
||||
└── <issue-number>/
|
||||
├── overview.md # High-level assessment with scores
|
||||
├── implementation-plan.md # Detailed step-by-step fix plan
|
||||
└── _raw-issue.json # Cached issue data from GitHub
|
||||
```
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
- Review a specific GitHub issue for feasibility
|
||||
- Analyze whether an issue can be fixed by AI
|
||||
- Create an implementation plan for an issue
|
||||
- Triage issues by complexity and clarity
|
||||
- Estimate effort for fixing an issue
|
||||
- Evaluate technical requirements of an issue
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- GitHub CLI (`gh`) installed and authenticated
|
||||
- PowerShell 7+ for running scripts
|
||||
|
||||
## Required Variables
|
||||
|
||||
⚠️ **Before starting**, confirm `{{IssueNumber}}` with the user. If not provided, **ASK**: "What issue number should I review?"
|
||||
|
||||
| Variable | Description | Example |
|
||||
|----------|-------------|---------|
|
||||
| `{{IssueNumber}}` | GitHub issue number to analyze | `44044` |
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1: Run Issue Review
|
||||
|
||||
Execute the review script (use paths relative to this skill folder):
|
||||
|
||||
```powershell
|
||||
# From repo root
|
||||
.github/skills/issue-review/scripts/Start-BulkIssueReview.ps1 -IssueNumber {{IssueNumber}}
|
||||
```
|
||||
|
||||
This will:
|
||||
1. Fetch issue details from GitHub
|
||||
2. Analyze the codebase for relevant files
|
||||
3. Generate `overview.md` with feasibility assessment
|
||||
4. Generate `implementation-plan.md` with detailed steps
|
||||
|
||||
### Step 2: Review Output
|
||||
|
||||
Check the generated files at `Generated Files/issueReview/{{IssueNumber}}/`:
|
||||
|
||||
| File | Contains |
|
||||
|------|----------|
|
||||
| `overview.md` | Feasibility score (0-100), Clarity score (0-100), Effort estimate, Risk assessment |
|
||||
| `implementation-plan.md` | Step-by-step implementation with file paths, code snippets, test requirements |
|
||||
|
||||
### Step 3: Interpret Scores
|
||||
|
||||
| Score Range | Interpretation |
|
||||
|-------------|----------------|
|
||||
| 80-100 | High confidence - straightforward fix |
|
||||
| 60-79 | Medium confidence - some complexity |
|
||||
| 40-59 | Low confidence - significant challenges |
|
||||
| 0-39 | Very low - may need human intervention |
|
||||
|
||||
## Batch Review
|
||||
|
||||
To review multiple issues at once:
|
||||
|
||||
```powershell
|
||||
.github/skills/issue-review/scripts/Start-BulkIssueReview.ps1 -IssueNumbers 44044, 32950, 45029
|
||||
```
|
||||
|
||||
## AI Prompt Reference
|
||||
|
||||
For manual AI invocation, the full prompt is at:
|
||||
- `references/review-issue.prompt.md` (relative to this skill folder)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Problem | Solution |
|
||||
|---------|----------|
|
||||
| Issue not found | Verify issue number exists: `gh issue view {{IssueNumber}}` |
|
||||
| No implementation plan | Issue may be unclear - check `overview.md` for clarity score |
|
||||
| Script errors | Ensure you're in the PowerToys repo root |
|
||||
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"mcpServers": {
|
||||
"github-artifacts": {
|
||||
"command": "cmd",
|
||||
"args": ["/c", "for /f %i in ('git rev-parse --show-toplevel') do node %i/tools/mcp/github-artifacts/launch.js"],
|
||||
"tools": ["*"]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,165 +0,0 @@
|
||||
---
|
||||
agent: 'agent'
|
||||
description: 'Review a GitHub issue, score it (0-100), and generate an implementation plan'
|
||||
---
|
||||
|
||||
# Review GitHub Issue
|
||||
|
||||
## Goal
|
||||
For **#{{issue_number}}** produce:
|
||||
1) `Generated Files/issueReview/{{issue_number}}/overview.md`
|
||||
2) `Generated Files/issueReview/{{issue_number}}/implementation-plan.md`
|
||||
|
||||
## Inputs
|
||||
Figure out required inputs {{issue_number}} from the invocation context; if anything is missing, ask for the value or note it as a gap.
|
||||
|
||||
# CONTEXT (brief)
|
||||
Ground evidence using `gh issue view {{issue_number}} --json number,title,body,author,createdAt,updatedAt,state,labels,milestone,reactions,comments,linkedPullRequests`, download images via MCP `github_issue_images` to better understand the issue context. Finally, use MCP `github_issue_attachments` to download logs with parameter `extractFolder` as `Generated Files/issueReview/{{issue_number}}/logs`, and analyze the downloaded logs if available to identify relevant issues. Locate the source code in the current workspace (use `rg`/`git grep` as needed). Link related issues and PRs.
|
||||
|
||||
## When to call MCP tools
|
||||
If the following MCP "github-artifacts" tools are available in the environment, use them:
|
||||
- `github_issue_images`: use when the issue/PR likely contains screenshots or other visual evidence (UI bugs, glitches, design problems).
|
||||
- `github_issue_attachments`: use when the issue/PR mentions attached ZIPs (PowerToysReport_*.zip, logs.zip, debug.zip) or asks to analyze logs/diagnostics. Always provide `extractFolder` as `Generated Files/issueReview/{{issue_number}}/logs`
|
||||
|
||||
If these tools are not available (not listed by the runtime), start the MCP server "github-artifacts" first.
|
||||
|
||||
# OVERVIEW.MD
|
||||
## Summary
|
||||
Issue, state, milestone, labels. **Signals**: 👍/❤️/👎, comment count, last activity, linked PRs.
|
||||
|
||||
## At-a-Glance Score Table
|
||||
Present all ratings in a compact table for quick scanning:
|
||||
|
||||
| Dimension | Score | Assessment | Key Drivers |
|
||||
|-----------|-------|------------|-------------|
|
||||
| **A) Business Importance** | X/100 | Low/Medium/High | Top 2 factors with scores |
|
||||
| **B) Community Excitement** | X/100 | Low/Medium/High | Top 2 factors with scores |
|
||||
| **C) Technical Feasibility** | X/100 | Low/Medium/High | Top 2 factors with scores |
|
||||
| **D) Requirement Clarity** | X/100 | Low/Medium/High | Top 2 factors with scores |
|
||||
| **Overall Priority** | X/100 | Low/Medium/High/Critical | Average or weighted summary |
|
||||
| **Effort Estimate** | X days (T-shirt) | XS/S/M/L/XL/XXL/Epic | Type: bug/feature/chore |
|
||||
| **Similar Issues Found** | X open, Y closed | — | Quick reference to related work |
|
||||
| **Potential Assignees** | @username, @username | — | Top contributors to module |
|
||||
|
||||
**Assessment bands**: 0-25 Low, 26-50 Medium, 51-75 High, 76-100 Critical
|
||||
|
||||
## Ratings (0–100) — add evidence & short rationale
|
||||
### A) Business Importance
|
||||
- Labels (priority/security/regression): **≤35**
|
||||
- Milestone/roadmap: **≤25**
|
||||
- Customer/contract impact: **≤20**
|
||||
- Unblocks/platform leverage: **≤20**
|
||||
### B) Community Excitement
|
||||
- 👍+❤️ normalized: **≤45**
|
||||
- Comment volume & unique participants: **≤25**
|
||||
- Recent activity (≤30d): **≤15**
|
||||
- Duplicates/related issues: **≤15**
|
||||
### C) Technical Feasibility
|
||||
- Contained surface/clear seams: **≤30**
|
||||
- Existing patterns/utilities: **≤25**
|
||||
- Risk (perf/sec/compat) manageable: **≤25**
|
||||
- Testability & CI support: **≤20**
|
||||
### D) Requirement Clarity
|
||||
- Behavior/repro/constraints: **≤60**
|
||||
- Non-functionals (perf/sec/i18n/a11y): **≤25**
|
||||
- Decision owners/acceptance signals: **≤15**
|
||||
|
||||
## Effort
|
||||
Days + **T-shirt** (XS 0.5–1d, S 1–2, M 2–4, L 4–7, XL 7–14, XXL 14–30, Epic >30).
|
||||
Type/level: bug/feature/chore/docs/refactor/test-only; severity/value tier.
|
||||
|
||||
## Suggested Actions
|
||||
Provide actionable recommendations for issue triage and assignment:
|
||||
|
||||
### A) Requirement Clarification (if Clarity score <50)
|
||||
**When Requirement Clarity (Dimension D) is Medium or Low:**
|
||||
- Identify specific gaps in issue description: missing repro steps, unclear expected behavior, undefined acceptance criteria, missing non-functional requirements
|
||||
- Draft 3-5 clarifying questions to post as issue comment
|
||||
- Suggest additional information needed: screenshots, logs, environment details, OS version, PowerToys version, error messages
|
||||
- If behavior is ambiguous, propose 2-3 interpretation scenarios and ask reporter to confirm
|
||||
- Example questions:
|
||||
- "Can you provide exact steps to reproduce this issue?"
|
||||
- "What is the expected behavior vs. what you're actually seeing?"
|
||||
- "Does this happen on Windows 10, 11, or both?"
|
||||
- "Can you attach a screenshot or screen recording?"
|
||||
|
||||
### B) Correct Label Suggestions
|
||||
- Analyze issue type, module, and severity to suggest missing or incorrect labels
|
||||
- Recommend labels from: `Issue-Bug`, `Issue-Feature`, `Issue-Docs`, `Issue-Task`, `Priority-High`, `Priority-Medium`, `Priority-Low`, `Needs-Triage`, `Needs-Author-Feedback`, `Product-<ModuleName>`, etc.
|
||||
- If Requirement Clarity is low (<50), add `Needs-Author-Feedback` label
|
||||
- If current labels are incorrect or incomplete, provide specific label changes with rationale
|
||||
|
||||
### C) Find Similar Issues & Past Fixes
|
||||
- Search for similar issues using `gh issue list --search "keywords" --state all --json number,title,state,closedAt`
|
||||
- Identify patterns: duplicate issues, related bugs, or similar feature requests
|
||||
- For closed issues, find linked PRs that fixed them: check `linkedPullRequests` in issue data
|
||||
- Provide 3-5 examples of similar issues with format: `#<number> - <title> (closed by PR #<pr>)` or `(still open)`
|
||||
|
||||
### D) Identify Subject Matter Experts
|
||||
- Use git blame/log to find who fixed similar issues in the past
|
||||
- Search for PR authors who touched relevant files: `git log --all --format='%aN' -- <file_paths> | sort | uniq -c | sort -rn | head -5`
|
||||
- Check issue/PR history for frequent contributors to the affected module
|
||||
- Suggest 2-3 potential assignees with context: `@<username> - <reason>` (e.g., "fixed similar rendering bug in #12345", "maintains FancyZones module")
|
||||
|
||||
### E) Semantic Search for Related Work
|
||||
- Use semantic_search tool to find similar issues, code patterns, or past discussions
|
||||
- Search queries should include: issue keywords, module names, error messages, feature descriptions
|
||||
- Cross-reference semantic results with GitHub issue search for comprehensive coverage
|
||||
|
||||
**Output format for Suggested Actions section in overview.md:**
|
||||
```markdown
|
||||
## Suggested Actions
|
||||
|
||||
### Clarifying Questions (if Clarity <50)
|
||||
Post these questions as issue comment to gather missing information:
|
||||
1. <question>
|
||||
2. <question>
|
||||
3. <question>
|
||||
|
||||
**Recommended label**: `Needs-Author-Feedback`
|
||||
|
||||
### Label Recommendations
|
||||
- Add: `<label>` - <reason>
|
||||
- Remove: `<label>` - <reason>
|
||||
- Current labels are appropriate ✓
|
||||
|
||||
### Similar Issues Found
|
||||
1. #<number> - <title> (<state>, closed by PR #<pr> on <date>)
|
||||
2. #<number> - <title> (<state>)
|
||||
...
|
||||
|
||||
### Potential Assignees
|
||||
- @<username> - <reason>
|
||||
- @<username> - <reason>
|
||||
|
||||
### Related Code/Discussions
|
||||
- <semantic search findings>
|
||||
```
|
||||
|
||||
# IMPLEMENTATION-PLAN.MD
|
||||
1) **Problem Framing** — restate problem; current vs expected; scope boundaries.
|
||||
2) **Layers & Files** — layers (UI/domain/data/infra/build). For each, list **files/dirs to modify** and **new files** (exact paths + why). Prefer repo patterns; cite examples/PRs.
|
||||
3) **Pattern Choices** — reuse existing; if new, justify trade-offs & transition.
|
||||
4) **Fundamentals** (brief plan or N/A + reason):
|
||||
- Performance (hot paths, allocs, caching/streaming)
|
||||
- Security (validation, authN/Z, secrets, SSRF/XSS/CSRF)
|
||||
- G11N/L10N (resources, number/date, pluralization)
|
||||
- Compatibility (public APIs, formats, OS/runtime/toolchain)
|
||||
- Extensibility (DI seams, options/flags, plugin points)
|
||||
- Accessibility (roles, labels, focus, keyboard, contrast)
|
||||
- SOLID & repo conventions (naming, folders, dependency direction)
|
||||
5) **Logging & Exception Handling**
|
||||
- Where to log; levels; structured fields; correlation/traces.
|
||||
- What to catch vs rethrow; retries/backoff; user-visible errors.
|
||||
- **Privacy**: never log secrets/PII; redaction policy.
|
||||
6) **Telemetry (optional — business metrics only)**
|
||||
- Events/metrics (name, when, props); success signal; privacy/sampling; dashboards/alerts.
|
||||
7) **Risks & Mitigations** — flags/canary/shadow-write/config guards.
|
||||
8) **Task Breakdown (agent-ready)** — table (leave a blank line before the header so Markdown renders correctly):
|
||||
|
||||
| Task | Intent | Files/Areas | Steps | Tests (brief) | Owner (Agent/Human) | Human interaction needed? (why) |
|
||||
|---|---|---|---|---|---|---|
|
||||
|
||||
9) **Tests to Add (only)**
|
||||
- **Unit**: targets, cases (success/edge/error), mocks/fixtures, path, notes.
|
||||
- **UI** (if applicable): flows, locator strategy, env/data/flags, path, flake mitigation.
|
||||
@@ -1,731 +0,0 @@
|
||||
# IssueReviewLib.ps1 - Shared helpers for bulk issue review automation
|
||||
# Part of the PowerToys GitHub Copilot/Claude Code issue review system
|
||||
|
||||
#region Console Output Helpers
|
||||
function Info { param([string]$Message) Write-Host $Message -ForegroundColor Cyan }
|
||||
function Warn { param([string]$Message) Write-Host $Message -ForegroundColor Yellow }
|
||||
function Err { param([string]$Message) Write-Host $Message -ForegroundColor Red }
|
||||
function Success { param([string]$Message) Write-Host $Message -ForegroundColor Green }
|
||||
#endregion
|
||||
|
||||
#region Repository Helpers
|
||||
function Get-RepoRoot {
|
||||
$root = git rev-parse --show-toplevel 2>$null
|
||||
if (-not $root) { throw 'Not inside a git repository.' }
|
||||
return (Resolve-Path $root).Path
|
||||
}
|
||||
|
||||
function Get-GeneratedFilesPath {
|
||||
param([string]$RepoRoot)
|
||||
return Join-Path $RepoRoot 'Generated Files'
|
||||
}
|
||||
|
||||
function Get-IssueReviewPath {
|
||||
param(
|
||||
[string]$RepoRoot,
|
||||
[int]$IssueNumber
|
||||
)
|
||||
$genFiles = Get-GeneratedFilesPath -RepoRoot $RepoRoot
|
||||
return Join-Path $genFiles "issueReview/$IssueNumber"
|
||||
}
|
||||
|
||||
function Get-IssueTitleFromOverview {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Extract issue title from existing overview.md file.
|
||||
.DESCRIPTION
|
||||
Parses the overview.md to get the issue title without requiring GitHub CLI.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[string]$OverviewPath
|
||||
)
|
||||
|
||||
if (-not (Test-Path $OverviewPath)) {
|
||||
return $null
|
||||
}
|
||||
|
||||
$content = Get-Content $OverviewPath -Raw
|
||||
|
||||
# Try to match title from Summary table: | **Title** | <title> |
|
||||
if ($content -match '\*\*Title\*\*\s*\|\s*([^|]+)\s*\|') {
|
||||
return $Matches[1].Trim()
|
||||
}
|
||||
|
||||
# Try to match from header: # Issue #XXXX: <title>
|
||||
if ($content -match '# Issue #\d+[:\s]+(.+)$' ) {
|
||||
return $Matches[1].Trim()
|
||||
}
|
||||
|
||||
# Try to match: # Issue #XXXX Review: <title>
|
||||
if ($content -match '# Issue #\d+ Review[:\s]+(.+)$') {
|
||||
return $Matches[1].Trim()
|
||||
}
|
||||
|
||||
return $null
|
||||
}
|
||||
|
||||
function Ensure-DirectoryExists {
|
||||
param([string]$Path)
|
||||
if (-not (Test-Path $Path)) {
|
||||
New-Item -ItemType Directory -Path $Path -Force | Out-Null
|
||||
}
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region GitHub Issue Query Helpers
|
||||
function Get-GitHubIssues {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Query GitHub issues by label, state, and sort order.
|
||||
.PARAMETER Labels
|
||||
Comma-separated list of labels to filter by (e.g., "bug,help wanted").
|
||||
.PARAMETER State
|
||||
Issue state: open, closed, or all. Default: open.
|
||||
.PARAMETER Sort
|
||||
Sort field: created, updated, comments, reactions. Default: created.
|
||||
.PARAMETER Order
|
||||
Sort order: asc or desc. Default: desc.
|
||||
.PARAMETER Limit
|
||||
Maximum number of issues to return. Default: 100.
|
||||
.PARAMETER Repository
|
||||
Repository in owner/repo format. Default: microsoft/PowerToys.
|
||||
#>
|
||||
param(
|
||||
[string]$Labels,
|
||||
[ValidateSet('open', 'closed', 'all')]
|
||||
[string]$State = 'open',
|
||||
[ValidateSet('created', 'updated', 'comments', 'reactions')]
|
||||
[string]$Sort = 'created',
|
||||
[ValidateSet('asc', 'desc')]
|
||||
[string]$Order = 'desc',
|
||||
[int]$Limit = 100,
|
||||
[string]$Repository = 'microsoft/PowerToys'
|
||||
)
|
||||
|
||||
$ghArgs = @('issue', 'list', '--repo', $Repository, '--state', $State, '--limit', $Limit)
|
||||
|
||||
if ($Labels) {
|
||||
foreach ($label in ($Labels -split ',')) {
|
||||
$ghArgs += @('--label', $label.Trim())
|
||||
}
|
||||
}
|
||||
|
||||
# Build JSON fields (use reactionGroups instead of reactions)
|
||||
$jsonFields = 'number,title,state,labels,createdAt,updatedAt,author,reactionGroups,comments'
|
||||
$ghArgs += @('--json', $jsonFields)
|
||||
|
||||
Info "Querying issues: gh $($ghArgs -join ' ')"
|
||||
$result = & gh @ghArgs 2>&1
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
throw "Failed to query issues: $result"
|
||||
}
|
||||
|
||||
$issues = $result | ConvertFrom-Json
|
||||
|
||||
# Sort by reactions if requested (gh CLI doesn't support this natively)
|
||||
if ($Sort -eq 'reactions') {
|
||||
$issues = $issues | ForEach-Object {
|
||||
# reactionGroups is an array of {content, users} - sum up user counts
|
||||
$totalReactions = ($_.reactionGroups | ForEach-Object { $_.users.totalCount } | Measure-Object -Sum).Sum
|
||||
if (-not $totalReactions) { $totalReactions = 0 }
|
||||
$_ | Add-Member -NotePropertyName 'totalReactions' -NotePropertyValue $totalReactions -PassThru
|
||||
}
|
||||
if ($Order -eq 'desc') {
|
||||
$issues = $issues | Sort-Object -Property totalReactions -Descending
|
||||
} else {
|
||||
$issues = $issues | Sort-Object -Property totalReactions
|
||||
}
|
||||
}
|
||||
|
||||
return $issues
|
||||
}
|
||||
|
||||
function Get-IssueDetails {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Get detailed information about a specific issue.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$IssueNumber,
|
||||
[string]$Repository = 'microsoft/PowerToys'
|
||||
)
|
||||
|
||||
$jsonFields = 'number,title,body,state,labels,createdAt,updatedAt,author,reactions,comments,linkedPullRequests,milestone'
|
||||
$result = gh issue view $IssueNumber --repo $Repository --json $jsonFields 2>&1
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
throw "Failed to get issue #$IssueNumber`: $result"
|
||||
}
|
||||
|
||||
return $result | ConvertFrom-Json
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region CLI Detection and Execution
|
||||
function Get-AvailableCLI {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Detect which AI CLI is available: GitHub Copilot CLI or Claude Code.
|
||||
.OUTPUTS
|
||||
Returns object with: Name, Command, PromptArg
|
||||
#>
|
||||
|
||||
# Check for standalone GitHub Copilot CLI (copilot command)
|
||||
$copilotCLI = Get-Command 'copilot' -ErrorAction SilentlyContinue
|
||||
if ($copilotCLI) {
|
||||
return @{
|
||||
Name = 'GitHub Copilot CLI'
|
||||
Command = 'copilot'
|
||||
Args = @('-p') # Non-interactive prompt mode
|
||||
Type = 'copilot'
|
||||
}
|
||||
}
|
||||
|
||||
# Check for Claude Code CLI
|
||||
$claudeCode = Get-Command 'claude' -ErrorAction SilentlyContinue
|
||||
if ($claudeCode) {
|
||||
return @{
|
||||
Name = 'Claude Code CLI'
|
||||
Command = 'claude'
|
||||
Args = @()
|
||||
Type = 'claude'
|
||||
}
|
||||
}
|
||||
|
||||
# Check for GitHub Copilot CLI via gh extension
|
||||
$ghCopilot = Get-Command 'gh' -ErrorAction SilentlyContinue
|
||||
if ($ghCopilot) {
|
||||
$copilotCheck = gh extension list 2>&1 | Select-String -Pattern 'copilot'
|
||||
if ($copilotCheck) {
|
||||
return @{
|
||||
Name = 'GitHub Copilot CLI (gh extension)'
|
||||
Command = 'gh'
|
||||
Args = @('copilot', 'suggest')
|
||||
Type = 'gh-copilot'
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Check for VS Code CLI with Copilot
|
||||
$code = Get-Command 'code' -ErrorAction SilentlyContinue
|
||||
if ($code) {
|
||||
return @{
|
||||
Name = 'VS Code (Copilot Chat)'
|
||||
Command = 'code'
|
||||
Args = @()
|
||||
Type = 'vscode'
|
||||
}
|
||||
}
|
||||
|
||||
return $null
|
||||
}
|
||||
|
||||
function Invoke-AIReview {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Invoke AI CLI to review a single issue.
|
||||
.PARAMETER IssueNumber
|
||||
The issue number to review.
|
||||
.PARAMETER RepoRoot
|
||||
Repository root path.
|
||||
.PARAMETER CLIType
|
||||
CLI type: 'claude', 'copilot', 'gh-copilot', or 'vscode'.
|
||||
.PARAMETER WorkingDirectory
|
||||
Working directory for the CLI command.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$IssueNumber,
|
||||
[Parameter(Mandatory)]
|
||||
[string]$RepoRoot,
|
||||
[ValidateSet('claude', 'copilot', 'gh-copilot', 'vscode')]
|
||||
[string]$CLIType = 'copilot',
|
||||
[string]$WorkingDirectory
|
||||
)
|
||||
|
||||
if (-not $WorkingDirectory) {
|
||||
$WorkingDirectory = $RepoRoot
|
||||
}
|
||||
|
||||
$promptFile = Join-Path $RepoRoot '.github/prompts/review-issue.prompt.md'
|
||||
if (-not (Test-Path $promptFile)) {
|
||||
throw "Prompt file not found: $promptFile"
|
||||
}
|
||||
|
||||
# Prepare the prompt with issue number substitution
|
||||
$promptContent = Get-Content $promptFile -Raw
|
||||
$promptContent = $promptContent -replace '\{\{issue_number\}\}', $IssueNumber
|
||||
|
||||
# Create temp prompt file
|
||||
$tempPromptDir = Join-Path $env:TEMP "issue-review-$IssueNumber"
|
||||
Ensure-DirectoryExists -Path $tempPromptDir
|
||||
$tempPromptFile = Join-Path $tempPromptDir "prompt.md"
|
||||
$promptContent | Set-Content -Path $tempPromptFile -Encoding UTF8
|
||||
|
||||
# Build the prompt text for CLI
|
||||
$promptText = "Review GitHub issue #$IssueNumber following the template in .github/prompts/review-issue.prompt.md. Generate overview.md and implementation-plan.md in 'Generated Files/issueReview/$IssueNumber/'"
|
||||
|
||||
switch ($CLIType) {
|
||||
'copilot' {
|
||||
# GitHub Copilot CLI (standalone copilot command)
|
||||
# Use --yolo for full permissions (--allow-all-tools --allow-all-paths --allow-all-urls)
|
||||
# Use -s (silent) for cleaner output in batch mode
|
||||
# Enable ALL GitHub MCP tools (issues, PRs, repos, etc.) + github-artifacts for images/attachments
|
||||
# MCP config path relative to repo root for github-artifacts tools
|
||||
$mcpConfig = '@.github/skills/issue-review/references/mcp-config.json'
|
||||
$args = @(
|
||||
'--additional-mcp-config', $mcpConfig, # Load github-artifacts MCP for image/attachment analysis
|
||||
'-p', $promptText, # Non-interactive prompt mode (exits after completion)
|
||||
'--yolo', # Enable all permissions for automated execution
|
||||
'-s', # Silent mode - output only agent response
|
||||
'--enable-all-github-mcp-tools', # Enable ALL GitHub MCP tools (issues, PRs, search, etc.)
|
||||
'--allow-tool', 'github-artifacts' # Also enable our custom github-artifacts MCP
|
||||
)
|
||||
|
||||
return @{
|
||||
Command = 'copilot'
|
||||
Arguments = $args
|
||||
WorkingDirectory = $WorkingDirectory
|
||||
IssueNumber = $IssueNumber
|
||||
}
|
||||
}
|
||||
'claude' {
|
||||
# Claude Code CLI
|
||||
$args = @(
|
||||
'--print', # Non-interactive mode
|
||||
'--dangerously-skip-permissions',
|
||||
'--prompt', $promptText
|
||||
)
|
||||
|
||||
return @{
|
||||
Command = 'claude'
|
||||
Arguments = $args
|
||||
WorkingDirectory = $WorkingDirectory
|
||||
IssueNumber = $IssueNumber
|
||||
}
|
||||
}
|
||||
'gh-copilot' {
|
||||
# GitHub Copilot CLI via gh
|
||||
$args = @(
|
||||
'copilot', 'suggest',
|
||||
'-t', 'shell',
|
||||
"Review GitHub issue #$IssueNumber and generate analysis files"
|
||||
)
|
||||
|
||||
return @{
|
||||
Command = 'gh'
|
||||
Arguments = $args
|
||||
WorkingDirectory = $WorkingDirectory
|
||||
IssueNumber = $IssueNumber
|
||||
}
|
||||
}
|
||||
'vscode' {
|
||||
# VS Code with Copilot - open with prompt
|
||||
$args = @(
|
||||
'--new-window',
|
||||
$WorkingDirectory,
|
||||
'--goto', $tempPromptFile
|
||||
)
|
||||
|
||||
return @{
|
||||
Command = 'code'
|
||||
Arguments = $args
|
||||
WorkingDirectory = $WorkingDirectory
|
||||
IssueNumber = $IssueNumber
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Parallel Job Management
|
||||
function Start-ParallelIssueReviews {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Start parallel issue reviews with throttling.
|
||||
.PARAMETER Issues
|
||||
Array of issue objects to review.
|
||||
.PARAMETER MaxParallel
|
||||
Maximum number of parallel jobs. Default: 20.
|
||||
.PARAMETER CLIType
|
||||
CLI type to use for reviews.
|
||||
.PARAMETER RepoRoot
|
||||
Repository root path.
|
||||
.PARAMETER TimeoutMinutes
|
||||
Timeout per issue in minutes. Default: 30.
|
||||
.PARAMETER MaxRetries
|
||||
Maximum number of retries for failed issues. Default: 2.
|
||||
.PARAMETER RetryDelaySeconds
|
||||
Delay between retries in seconds. Default: 10.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[array]$Issues,
|
||||
[int]$MaxParallel = 20,
|
||||
[ValidateSet('claude', 'copilot', 'gh-copilot', 'vscode')]
|
||||
[string]$CLIType = 'copilot',
|
||||
[Parameter(Mandatory)]
|
||||
[string]$RepoRoot,
|
||||
[int]$TimeoutMinutes = 30,
|
||||
[int]$MaxRetries = 2,
|
||||
[int]$RetryDelaySeconds = 10
|
||||
)
|
||||
|
||||
$totalIssues = $Issues.Count
|
||||
$completed = 0
|
||||
$failed = @()
|
||||
$succeeded = @()
|
||||
$retryQueue = [System.Collections.Queue]::new()
|
||||
|
||||
Info "Starting parallel review of $totalIssues issues (max $MaxParallel concurrent, $MaxRetries retries)"
|
||||
|
||||
# Use PowerShell jobs for parallelization
|
||||
$jobs = @()
|
||||
$issueQueue = [System.Collections.Queue]::new($Issues)
|
||||
|
||||
while ($issueQueue.Count -gt 0 -or $jobs.Count -gt 0 -or $retryQueue.Count -gt 0) {
|
||||
# Process retry queue when main queue is empty
|
||||
if ($issueQueue.Count -eq 0 -and $retryQueue.Count -gt 0 -and $jobs.Count -lt $MaxParallel) {
|
||||
$retryItem = $retryQueue.Dequeue()
|
||||
Warn "🔄 Retrying issue #$($retryItem.IssueNumber) (attempt $($retryItem.Attempt + 1)/$($MaxRetries + 1))"
|
||||
Start-Sleep -Seconds $RetryDelaySeconds
|
||||
$issueQueue.Enqueue(@{ number = $retryItem.IssueNumber; _retryAttempt = $retryItem.Attempt + 1 })
|
||||
}
|
||||
|
||||
# Start new jobs up to MaxParallel
|
||||
while ($jobs.Count -lt $MaxParallel -and $issueQueue.Count -gt 0) {
|
||||
$issue = $issueQueue.Dequeue()
|
||||
$issueNum = $issue.number
|
||||
$retryAttempt = if ($issue._retryAttempt) { $issue._retryAttempt } else { 0 }
|
||||
|
||||
$attemptInfo = if ($retryAttempt -gt 0) { " (retry $retryAttempt)" } else { "" }
|
||||
Info "Starting review for issue #$issueNum$attemptInfo ($($totalIssues - $issueQueue.Count)/$totalIssues)"
|
||||
|
||||
$job = Start-Job -Name "Issue-$issueNum" -ScriptBlock {
|
||||
param($IssueNumber, $RepoRoot, $CLIType)
|
||||
|
||||
Set-Location $RepoRoot
|
||||
|
||||
# Import the library in the job context
|
||||
. "$RepoRoot/.github/review-tools/IssueReviewLib.ps1"
|
||||
|
||||
try {
|
||||
$reviewCmd = Invoke-AIReview -IssueNumber $IssueNumber -RepoRoot $RepoRoot -CLIType $CLIType
|
||||
|
||||
# Execute the command using invocation operator (works for .ps1 scripts and executables)
|
||||
Set-Location $reviewCmd.WorkingDirectory
|
||||
$argList = $reviewCmd.Arguments
|
||||
|
||||
# Capture both stdout and stderr for better error reporting
|
||||
$output = & $reviewCmd.Command @argList 2>&1
|
||||
$exitCode = $LASTEXITCODE
|
||||
|
||||
# Get last 20 lines of output for error context
|
||||
$outputLines = $output | Out-String
|
||||
$lastLines = ($outputLines -split "`n" | Select-Object -Last 20) -join "`n"
|
||||
|
||||
# Check if output files were created (success indicator)
|
||||
$overviewPath = Join-Path $RepoRoot "Generated Files/issueReview/$IssueNumber/overview.md"
|
||||
$implPlanPath = Join-Path $RepoRoot "Generated Files/issueReview/$IssueNumber/implementation-plan.md"
|
||||
$filesCreated = (Test-Path $overviewPath) -and (Test-Path $implPlanPath)
|
||||
|
||||
return @{
|
||||
IssueNumber = $IssueNumber
|
||||
Success = ($exitCode -eq 0) -or $filesCreated
|
||||
ExitCode = $exitCode
|
||||
FilesCreated = $filesCreated
|
||||
Output = $lastLines
|
||||
Error = if ($exitCode -ne 0 -and -not $filesCreated) { "Exit code: $exitCode`n$lastLines" } else { $null }
|
||||
}
|
||||
}
|
||||
catch {
|
||||
return @{
|
||||
IssueNumber = $IssueNumber
|
||||
Success = $false
|
||||
ExitCode = -1
|
||||
FilesCreated = $false
|
||||
Output = $null
|
||||
Error = $_.Exception.Message
|
||||
}
|
||||
}
|
||||
} -ArgumentList $issueNum, $RepoRoot, $CLIType
|
||||
|
||||
$jobs += @{
|
||||
Job = $job
|
||||
IssueNumber = $issueNum
|
||||
StartTime = Get-Date
|
||||
RetryAttempt = $retryAttempt
|
||||
}
|
||||
}
|
||||
|
||||
# Check for completed jobs
|
||||
$completedJobs = @()
|
||||
foreach ($jobInfo in $jobs) {
|
||||
$job = $jobInfo.Job
|
||||
$issueNum = $jobInfo.IssueNumber
|
||||
$startTime = $jobInfo.StartTime
|
||||
$retryAttempt = $jobInfo.RetryAttempt
|
||||
|
||||
if ($job.State -eq 'Completed') {
|
||||
$result = Receive-Job -Job $job
|
||||
Remove-Job -Job $job -Force
|
||||
|
||||
if ($result.Success) {
|
||||
Success "✓ Issue #$issueNum completed (files created: $($result.FilesCreated))"
|
||||
$succeeded += $issueNum
|
||||
$completed++
|
||||
} else {
|
||||
# Check if we should retry
|
||||
if ($retryAttempt -lt $MaxRetries) {
|
||||
$errorPreview = if ($result.Error) { ($result.Error -split "`n" | Select-Object -First 3) -join " | " } else { "Unknown error" }
|
||||
Warn "⚠ Issue #$issueNum failed (will retry): $errorPreview"
|
||||
$retryQueue.Enqueue(@{ IssueNumber = $issueNum; Attempt = $retryAttempt; LastError = $result.Error })
|
||||
} else {
|
||||
$errorMsg = if ($result.Error) { $result.Error } else { "Exit code: $($result.ExitCode)" }
|
||||
Err "✗ Issue #$issueNum failed after $($retryAttempt + 1) attempts:"
|
||||
Err " Error: $errorMsg"
|
||||
$failed += @{ IssueNumber = $issueNum; Error = $errorMsg; Attempts = $retryAttempt + 1 }
|
||||
$completed++
|
||||
}
|
||||
}
|
||||
$completedJobs += $jobInfo
|
||||
}
|
||||
elseif ($job.State -eq 'Failed') {
|
||||
$jobError = $job.ChildJobs[0].JobStateInfo.Reason.Message
|
||||
Remove-Job -Job $job -Force
|
||||
|
||||
if ($retryAttempt -lt $MaxRetries) {
|
||||
Warn "⚠ Issue #$issueNum job crashed (will retry): $jobError"
|
||||
$retryQueue.Enqueue(@{ IssueNumber = $issueNum; Attempt = $retryAttempt; LastError = $jobError })
|
||||
} else {
|
||||
Err "✗ Issue #$issueNum job failed after $($retryAttempt + 1) attempts: $jobError"
|
||||
$failed += @{ IssueNumber = $issueNum; Error = $jobError; Attempts = $retryAttempt + 1 }
|
||||
$completed++
|
||||
}
|
||||
$completedJobs += $jobInfo
|
||||
}
|
||||
elseif ((Get-Date) - $startTime -gt [TimeSpan]::FromMinutes($TimeoutMinutes)) {
|
||||
Stop-Job -Job $job -ErrorAction SilentlyContinue
|
||||
Remove-Job -Job $job -Force
|
||||
|
||||
if ($retryAttempt -lt $MaxRetries) {
|
||||
Warn "⏱ Issue #$issueNum timed out after $TimeoutMinutes min (will retry)"
|
||||
$retryQueue.Enqueue(@{ IssueNumber = $issueNum; Attempt = $retryAttempt; LastError = "Timeout after $TimeoutMinutes minutes" })
|
||||
} else {
|
||||
Err "⏱ Issue #$issueNum timed out after $($retryAttempt + 1) attempts"
|
||||
$failed += @{ IssueNumber = $issueNum; Error = "Timeout after $TimeoutMinutes minutes"; Attempts = $retryAttempt + 1 }
|
||||
$completed++
|
||||
}
|
||||
$completedJobs += $jobInfo
|
||||
}
|
||||
}
|
||||
|
||||
# Remove completed jobs from active list
|
||||
$jobs = $jobs | Where-Object { $_ -notin $completedJobs }
|
||||
|
||||
# Brief pause to avoid tight loop
|
||||
if ($jobs.Count -gt 0) {
|
||||
Start-Sleep -Seconds 2
|
||||
}
|
||||
}
|
||||
|
||||
# Extract just issue numbers for the failed list
|
||||
$failedNumbers = $failed | ForEach-Object { $_.IssueNumber }
|
||||
|
||||
return @{
|
||||
Total = $totalIssues
|
||||
Succeeded = $succeeded
|
||||
Failed = $failedNumbers
|
||||
FailedDetails = $failed
|
||||
}
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Issue Review Results Helpers
|
||||
function Get-IssueReviewResult {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Check if an issue has been reviewed and get its results.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$IssueNumber,
|
||||
[Parameter(Mandatory)]
|
||||
[string]$RepoRoot
|
||||
)
|
||||
|
||||
$reviewPath = Get-IssueReviewPath -RepoRoot $RepoRoot -IssueNumber $IssueNumber
|
||||
|
||||
$result = @{
|
||||
IssueNumber = $IssueNumber
|
||||
Path = $reviewPath
|
||||
HasOverview = $false
|
||||
HasImplementationPlan = $false
|
||||
OverviewPath = $null
|
||||
ImplementationPlanPath = $null
|
||||
}
|
||||
|
||||
$overviewPath = Join-Path $reviewPath 'overview.md'
|
||||
$implPlanPath = Join-Path $reviewPath 'implementation-plan.md'
|
||||
|
||||
if (Test-Path $overviewPath) {
|
||||
$result.HasOverview = $true
|
||||
$result.OverviewPath = $overviewPath
|
||||
}
|
||||
|
||||
if (Test-Path $implPlanPath) {
|
||||
$result.HasImplementationPlan = $true
|
||||
$result.ImplementationPlanPath = $implPlanPath
|
||||
}
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
function Get-HighConfidenceIssues {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Find issues with high confidence for auto-fix based on review results.
|
||||
.PARAMETER RepoRoot
|
||||
Repository root path.
|
||||
.PARAMETER MinFeasibilityScore
|
||||
Minimum Technical Feasibility score (0-100). Default: 70.
|
||||
.PARAMETER MinClarityScore
|
||||
Minimum Requirement Clarity score (0-100). Default: 60.
|
||||
.PARAMETER MaxEffortDays
|
||||
Maximum effort estimate in days. Default: 2 (S = Small).
|
||||
.PARAMETER FilterIssueNumbers
|
||||
Optional array of issue numbers to filter to. If specified, only these issues are considered.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[string]$RepoRoot,
|
||||
[int]$MinFeasibilityScore = 70,
|
||||
[int]$MinClarityScore = 60,
|
||||
[int]$MaxEffortDays = 2,
|
||||
[int[]]$FilterIssueNumbers = @()
|
||||
)
|
||||
|
||||
$genFiles = Get-GeneratedFilesPath -RepoRoot $RepoRoot
|
||||
$reviewDir = Join-Path $genFiles 'issueReview'
|
||||
|
||||
if (-not (Test-Path $reviewDir)) {
|
||||
return @()
|
||||
}
|
||||
|
||||
$highConfidence = @()
|
||||
|
||||
Get-ChildItem -Path $reviewDir -Directory | ForEach-Object {
|
||||
$issueNum = [int]$_.Name
|
||||
|
||||
# Skip if filter is specified and this issue is not in the filter list
|
||||
if ($FilterIssueNumbers.Count -gt 0 -and $issueNum -notin $FilterIssueNumbers) {
|
||||
return
|
||||
}
|
||||
|
||||
$overviewPath = Join-Path $_.FullName 'overview.md'
|
||||
$implPlanPath = Join-Path $_.FullName 'implementation-plan.md'
|
||||
|
||||
if (-not (Test-Path $overviewPath) -or -not (Test-Path $implPlanPath)) {
|
||||
return
|
||||
}
|
||||
|
||||
# Parse overview.md to extract scores
|
||||
$overview = Get-Content $overviewPath -Raw
|
||||
|
||||
# Extract scores using regex (looking for score table or inline scores)
|
||||
$feasibility = 0
|
||||
$clarity = 0
|
||||
$effortDays = 999
|
||||
|
||||
# Try to extract from At-a-Glance Score Table
|
||||
if ($overview -match 'Technical Feasibility[^\d]*(\d+)/100') {
|
||||
$feasibility = [int]$Matches[1]
|
||||
}
|
||||
if ($overview -match 'Requirement Clarity[^\d]*(\d+)/100') {
|
||||
$clarity = [int]$Matches[1]
|
||||
}
|
||||
# Match effort formats like "0.5-1 day", "1-2 days", "2-3 days" - extract the upper bound
|
||||
if ($overview -match 'Effort Estimate[^|]*\|\s*[\d.]+(?:-(\d+))?\s*days?') {
|
||||
if ($Matches[1]) {
|
||||
$effortDays = [int]$Matches[1]
|
||||
} elseif ($overview -match 'Effort Estimate[^|]*\|\s*(\d+)\s*days?') {
|
||||
$effortDays = [int]$Matches[1]
|
||||
}
|
||||
}
|
||||
# Also check for XS/S sizing in the table (e.g., "| XS |" or "| S |" or "(XS)" or "(S)")
|
||||
if ($overview -match 'Effort Estimate[^|]*\|[^|]*\|\s*(XS|S)\b') {
|
||||
# XS = 1 day, S = 2 days
|
||||
if ($Matches[1] -eq 'XS') {
|
||||
$effortDays = 1
|
||||
} else {
|
||||
$effortDays = 2
|
||||
}
|
||||
} elseif ($overview -match 'Effort Estimate[^|]*\|[^|]*\(XS\)') {
|
||||
$effortDays = 1
|
||||
} elseif ($overview -match 'Effort Estimate[^|]*\|[^|]*\(S\)') {
|
||||
$effortDays = 2
|
||||
}
|
||||
|
||||
if ($feasibility -ge $MinFeasibilityScore -and
|
||||
$clarity -ge $MinClarityScore -and
|
||||
$effortDays -le $MaxEffortDays) {
|
||||
|
||||
$highConfidence += @{
|
||||
IssueNumber = $issueNum
|
||||
FeasibilityScore = $feasibility
|
||||
ClarityScore = $clarity
|
||||
EffortDays = $effortDays
|
||||
OverviewPath = $overviewPath
|
||||
ImplementationPlanPath = $implPlanPath
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $highConfidence | Sort-Object -Property FeasibilityScore -Descending
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Worktree Integration
|
||||
function Copy-IssueReviewToWorktree {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Copy the Generated Files for an issue to a worktree.
|
||||
.PARAMETER IssueNumber
|
||||
The issue number.
|
||||
.PARAMETER SourceRepoRoot
|
||||
Source repository root (main repo).
|
||||
.PARAMETER WorktreePath
|
||||
Destination worktree path.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$IssueNumber,
|
||||
[Parameter(Mandatory)]
|
||||
[string]$SourceRepoRoot,
|
||||
[Parameter(Mandatory)]
|
||||
[string]$WorktreePath
|
||||
)
|
||||
|
||||
$sourceReviewPath = Get-IssueReviewPath -RepoRoot $SourceRepoRoot -IssueNumber $IssueNumber
|
||||
$destReviewPath = Get-IssueReviewPath -RepoRoot $WorktreePath -IssueNumber $IssueNumber
|
||||
|
||||
if (-not (Test-Path $sourceReviewPath)) {
|
||||
throw "Issue review files not found at: $sourceReviewPath"
|
||||
}
|
||||
|
||||
Ensure-DirectoryExists -Path $destReviewPath
|
||||
|
||||
# Copy all files from the issue review folder
|
||||
Copy-Item -Path "$sourceReviewPath\*" -Destination $destReviewPath -Recurse -Force
|
||||
|
||||
Info "Copied issue review files to: $destReviewPath"
|
||||
|
||||
return $destReviewPath
|
||||
}
|
||||
#endregion
|
||||
|
||||
# Note: This script is dot-sourced, not imported as a module.
|
||||
# All functions above are available after: . "path/to/IssueReviewLib.ps1"
|
||||
@@ -1,238 +0,0 @@
|
||||
<#!
|
||||
.SYNOPSIS
|
||||
Bulk review GitHub issues using AI CLI (Claude Code or GitHub Copilot).
|
||||
|
||||
.DESCRIPTION
|
||||
Queries GitHub issues by labels, state, and sort order, then kicks off parallel
|
||||
AI-powered reviews for each issue. Results are stored in Generated Files/issueReview/<number>/.
|
||||
|
||||
.PARAMETER Labels
|
||||
Comma-separated list of labels to filter issues (e.g., "bug,help wanted").
|
||||
|
||||
.PARAMETER State
|
||||
Issue state: open, closed, or all. Default: open.
|
||||
|
||||
.PARAMETER Sort
|
||||
Sort field: created, updated, comments, reactions. Default: created.
|
||||
|
||||
.PARAMETER Order
|
||||
Sort order: asc or desc. Default: desc.
|
||||
|
||||
.PARAMETER Limit
|
||||
Maximum number of issues to process. Default: 100.
|
||||
|
||||
.PARAMETER MaxParallel
|
||||
Maximum parallel review jobs. Default: 20.
|
||||
|
||||
.PARAMETER CLIType
|
||||
AI CLI to use: claude, gh-copilot, or vscode. Auto-detected if not specified.
|
||||
|
||||
.PARAMETER DryRun
|
||||
List issues without starting reviews.
|
||||
|
||||
.PARAMETER SkipExisting
|
||||
Skip issues that already have review files.
|
||||
|
||||
.PARAMETER Repository
|
||||
Repository in owner/repo format. Default: microsoft/PowerToys.
|
||||
|
||||
.PARAMETER TimeoutMinutes
|
||||
Timeout per issue review in minutes. Default: 30.
|
||||
|
||||
.EXAMPLE
|
||||
# Review all open bugs sorted by reactions
|
||||
./Start-BulkIssueReview.ps1 -Labels "bug" -Sort reactions -Order desc
|
||||
|
||||
.EXAMPLE
|
||||
# Dry run to see which issues would be reviewed
|
||||
./Start-BulkIssueReview.ps1 -Labels "help wanted" -DryRun
|
||||
|
||||
.EXAMPLE
|
||||
# Review top 50 issues with Claude Code, max 10 parallel
|
||||
./Start-BulkIssueReview.ps1 -Labels "Issue-Bug" -Limit 50 -MaxParallel 10 -CLIType claude
|
||||
|
||||
.EXAMPLE
|
||||
# Skip already-reviewed issues
|
||||
./Start-BulkIssueReview.ps1 -Labels "Issue-Feature" -SkipExisting
|
||||
|
||||
.NOTES
|
||||
Requires: GitHub CLI (gh) authenticated, and either Claude Code CLI or VS Code with Copilot.
|
||||
Results: Generated Files/issueReview/<issue_number>/overview.md and implementation-plan.md
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[Parameter(Position = 0)]
|
||||
[string]$Labels,
|
||||
|
||||
[ValidateSet('open', 'closed', 'all')]
|
||||
[string]$State = 'open',
|
||||
|
||||
[ValidateSet('created', 'updated', 'comments', 'reactions')]
|
||||
[string]$Sort = 'created',
|
||||
|
||||
[ValidateSet('asc', 'desc')]
|
||||
[string]$Order = 'desc',
|
||||
|
||||
[int]$Limit = 1000,
|
||||
|
||||
[int]$MaxParallel = 20,
|
||||
|
||||
[ValidateSet('claude', 'copilot', 'gh-copilot', 'vscode', 'auto')]
|
||||
[string]$CLIType = 'auto',
|
||||
|
||||
[switch]$DryRun,
|
||||
|
||||
[switch]$SkipExisting,
|
||||
|
||||
[string]$Repository = 'microsoft/PowerToys',
|
||||
|
||||
[int]$TimeoutMinutes = 30,
|
||||
|
||||
[int]$MaxRetries = 2,
|
||||
|
||||
[int]$RetryDelaySeconds = 10,
|
||||
|
||||
[switch]$Force,
|
||||
|
||||
[switch]$Help
|
||||
)
|
||||
|
||||
# Load library
|
||||
$scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
|
||||
. "$scriptDir/IssueReviewLib.ps1"
|
||||
|
||||
# Show help
|
||||
if ($Help) {
|
||||
Get-Help $MyInvocation.MyCommand.Path -Full
|
||||
return
|
||||
}
|
||||
|
||||
#region Main Script
|
||||
try {
|
||||
# Get repo root
|
||||
$repoRoot = Get-RepoRoot
|
||||
Info "Repository root: $repoRoot"
|
||||
|
||||
# Detect or validate CLI
|
||||
if ($CLIType -eq 'auto') {
|
||||
$cli = Get-AvailableCLI
|
||||
if (-not $cli) {
|
||||
throw "No AI CLI found. Please install Claude Code CLI or GitHub Copilot CLI extension."
|
||||
}
|
||||
$CLIType = $cli.Type
|
||||
Info "Auto-detected CLI: $($cli.Name)"
|
||||
}
|
||||
|
||||
# Query issues
|
||||
Info "`nQuerying issues with filters:"
|
||||
Info " Labels: $(if ($Labels) { $Labels } else { '(none)' })"
|
||||
Info " State: $State"
|
||||
Info " Sort: $Sort $Order"
|
||||
Info " Limit: $Limit"
|
||||
|
||||
$issues = Get-GitHubIssues -Labels $Labels -State $State -Sort $Sort -Order $Order -Limit $Limit -Repository $Repository
|
||||
|
||||
if ($issues.Count -eq 0) {
|
||||
Warn "No issues found matching the criteria."
|
||||
return
|
||||
}
|
||||
|
||||
Info "`nFound $($issues.Count) issues"
|
||||
|
||||
# Filter out existing reviews if requested
|
||||
if ($SkipExisting) {
|
||||
$originalCount = $issues.Count
|
||||
$issues = $issues | Where-Object {
|
||||
$result = Get-IssueReviewResult -IssueNumber $_.number -RepoRoot $repoRoot
|
||||
-not ($result.HasOverview -and $result.HasImplementationPlan)
|
||||
}
|
||||
$skipped = $originalCount - $issues.Count
|
||||
if ($skipped -gt 0) {
|
||||
Info "Skipping $skipped issues with existing reviews"
|
||||
}
|
||||
}
|
||||
|
||||
if ($issues.Count -eq 0) {
|
||||
Warn "All issues already have reviews. Nothing to do."
|
||||
return
|
||||
}
|
||||
|
||||
# Display issue list
|
||||
Info "`nIssues to review:"
|
||||
Info ("-" * 80)
|
||||
foreach ($issue in $issues) {
|
||||
$labels = ($issue.labels | ForEach-Object { $_.name }) -join ', '
|
||||
$reactions = if ($issue.reactions) { $issue.reactions.totalCount } else { 0 }
|
||||
Info ("#{0,-6} {1,-50} [👍{2}] [{3}]" -f $issue.number, ($issue.title.Substring(0, [Math]::Min(50, $issue.title.Length))), $reactions, $labels)
|
||||
}
|
||||
Info ("-" * 80)
|
||||
|
||||
if ($DryRun) {
|
||||
Warn "`nDry run mode - no reviews started."
|
||||
Info "Would review $($issues.Count) issues with CLI: $CLIType"
|
||||
return
|
||||
}
|
||||
|
||||
# Confirm before proceeding (skip if -Force)
|
||||
if (-not $Force) {
|
||||
$confirm = Read-Host "`nProceed with reviewing $($issues.Count) issues using $CLIType? (y/N)"
|
||||
if ($confirm -notmatch '^[yY]') {
|
||||
Info "Cancelled."
|
||||
return
|
||||
}
|
||||
} else {
|
||||
Info "`nProceeding with $($issues.Count) issues (Force mode)"
|
||||
}
|
||||
|
||||
# Create output directory
|
||||
$genFiles = Get-GeneratedFilesPath -RepoRoot $repoRoot
|
||||
Ensure-DirectoryExists -Path (Join-Path $genFiles 'issueReview')
|
||||
|
||||
# Start parallel reviews
|
||||
Info "`nStarting bulk review..."
|
||||
Info " Max retries: $MaxRetries (delay: ${RetryDelaySeconds}s)"
|
||||
$startTime = Get-Date
|
||||
|
||||
$results = Start-ParallelIssueReviews `
|
||||
-Issues $issues `
|
||||
-MaxParallel $MaxParallel `
|
||||
-CLIType $CLIType `
|
||||
-RepoRoot $repoRoot `
|
||||
-TimeoutMinutes $TimeoutMinutes `
|
||||
-MaxRetries $MaxRetries `
|
||||
-RetryDelaySeconds $RetryDelaySeconds
|
||||
|
||||
$duration = (Get-Date) - $startTime
|
||||
|
||||
# Summary
|
||||
Info "`n" + ("=" * 80)
|
||||
Info "BULK REVIEW COMPLETE"
|
||||
Info ("=" * 80)
|
||||
Info "Total issues: $($results.Total)"
|
||||
Success "Succeeded: $($results.Succeeded.Count)"
|
||||
if ($results.Failed.Count -gt 0) {
|
||||
Err "Failed: $($results.Failed.Count)"
|
||||
Err "Failed issues: $($results.Failed -join ', ')"
|
||||
Info ""
|
||||
Info "Failed Issue Details:"
|
||||
Info ("-" * 40)
|
||||
foreach ($failedItem in $results.FailedDetails) {
|
||||
Err " #$($failedItem.IssueNumber) (attempts: $($failedItem.Attempts)):"
|
||||
$errorLines = ($failedItem.Error -split "`n" | Select-Object -First 5) -join "`n "
|
||||
Err " $errorLines"
|
||||
}
|
||||
Info ("-" * 40)
|
||||
}
|
||||
Info "Duration: $($duration.ToString('hh\:mm\:ss'))"
|
||||
Info "Output: $genFiles/issueReview/"
|
||||
Info ("=" * 80)
|
||||
|
||||
# Return results for pipeline
|
||||
return $results
|
||||
}
|
||||
catch {
|
||||
Err "Error: $($_.Exception.Message)"
|
||||
exit 1
|
||||
}
|
||||
#endregion
|
||||
21
.github/skills/issue-to-pr-cycle/LICENSE.txt
vendored
21
.github/skills/issue-to-pr-cycle/LICENSE.txt
vendored
@@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) Microsoft Corporation.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
136
.github/skills/issue-to-pr-cycle/SKILL.md
vendored
136
.github/skills/issue-to-pr-cycle/SKILL.md
vendored
@@ -1,136 +0,0 @@
|
||||
---
|
||||
name: issue-to-pr-cycle
|
||||
description: End-to-end automation from issue analysis to PR creation and review. Use when asked to fix multiple issues automatically, run full issue cycle, batch process issues, automate issue resolution, create PRs for high-confidence issues, or process issues end-to-end. Orchestrates issue review, auto-fix, PR submission, and PR review in parallel batches.
|
||||
license: Complete terms in LICENSE.txt
|
||||
---
|
||||
|
||||
# Issue-to-PR Full Cycle Skill
|
||||
|
||||
Orchestrate the complete workflow from issue analysis to PR creation and review. Processes multiple issues in parallel with configurable confidence thresholds.
|
||||
|
||||
## Skill Contents
|
||||
|
||||
This skill is **self-contained** with all required resources:
|
||||
|
||||
```
|
||||
.github/skills/issue-to-pr-cycle/
|
||||
├── SKILL.md # This file
|
||||
├── LICENSE.txt # MIT License
|
||||
└── scripts/
|
||||
└── Start-FullIssueCycle.ps1 # Main orchestration script
|
||||
```
|
||||
|
||||
**Note**: This skill orchestrates other skills via their PowerShell scripts:
|
||||
- `issue-review` skill scripts
|
||||
- `issue-fix` skill scripts
|
||||
- `submit-pr` skill scripts
|
||||
- `pr-review` skill scripts
|
||||
|
||||
## Output
|
||||
|
||||
The skill produces:
|
||||
1. Issue review files in `Generated Files/issueReview/<issue-number>/`
|
||||
2. Git worktrees with fixes at `Q:/PowerToys-xxxx/`
|
||||
3. Pull requests on GitHub
|
||||
4. PR review files in `Generated Files/prReview/<pr-number>/`
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
- Process multiple issues end-to-end automatically
|
||||
- Batch fix high-confidence issues
|
||||
- Run full automation cycle for triaged issues
|
||||
- Create PRs for multiple reviewed issues
|
||||
- Automate issue-to-PR workflow
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- GitHub CLI (`gh`) installed and authenticated
|
||||
- Copilot CLI or Claude CLI installed
|
||||
- PowerShell 7+ for running scripts
|
||||
- Issues already reviewed (have `Generated Files/issueReview/` data)
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Option 1: Dry Run First
|
||||
|
||||
See what would be processed without making changes:
|
||||
|
||||
```powershell
|
||||
# From repo root
|
||||
.github/skills/issue-to-pr-cycle/scripts/Start-FullIssueCycle.ps1 `
|
||||
-MinFeasibilityScore 70 `
|
||||
-MinClarityScore 70 `
|
||||
-MaxEffortDays 10 `
|
||||
-SkipExisting `
|
||||
-DryRun
|
||||
```
|
||||
|
||||
### Option 2: Run Full Cycle
|
||||
|
||||
Process all matching issues:
|
||||
|
||||
```powershell
|
||||
.github/skills/issue-to-pr-cycle/scripts/Start-FullIssueCycle.ps1 `
|
||||
-MinFeasibilityScore 70 `
|
||||
-MinClarityScore 70 `
|
||||
-MaxEffortDays 10 `
|
||||
-SkipExisting `
|
||||
-CLIType copilot `
|
||||
-Force
|
||||
```
|
||||
|
||||
## CLI Options
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `-MinFeasibilityScore` | Minimum technical feasibility score (0-100) | `70` |
|
||||
| `-MinClarityScore` | Minimum requirement clarity score (0-100) | `70` |
|
||||
| `-MaxEffortDays` | Maximum effort estimate in days | `10` |
|
||||
| `-ExcludeIssues` | Array of issue numbers to skip | `@()` |
|
||||
| `-SkipExisting` | Skip issues that already have PRs | `false` |
|
||||
| `-CLIType` | AI CLI to use: `copilot` or `claude` | `copilot` |
|
||||
| `-FixThrottleLimit` | Parallel limit for fix phase | `5` |
|
||||
| `-PRThrottleLimit` | Parallel limit for PR phase | `5` |
|
||||
| `-ReviewThrottleLimit` | Parallel limit for review phase | `3` |
|
||||
| `-DryRun` | Show what would be done | `false` |
|
||||
| `-Force` | Skip confirmation prompts | `false` |
|
||||
|
||||
## Workflow Phases
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ PHASE 1: Auto-Fix Issues (Parallel) │
|
||||
│ Uses: issue-fix skill scripts │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
↓
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ PHASE 2: Submit PRs (Parallel) │
|
||||
│ Uses: submit-pr skill scripts │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
↓
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ PHASE 3: Review PRs (Parallel) │
|
||||
│ Uses: pr-review skill scripts │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
## Related Skills
|
||||
|
||||
This skill orchestrates (via PowerShell, not skill-to-skill):
|
||||
|
||||
| Skill | Script Location | Purpose |
|
||||
|-------|-----------------|---------|
|
||||
| `issue-review` | `.github/skills/issue-review/scripts/` | Analyze issues |
|
||||
| `issue-fix` | `.github/skills/issue-fix/scripts/` | Create fixes |
|
||||
| `submit-pr` | `.github/skills/submit-pr/scripts/` | Create PRs |
|
||||
| `pr-review` | `.github/skills/pr-review/scripts/` | Review PRs |
|
||||
|
||||
You can use each skill independently for finer control.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Problem | Solution |
|
||||
|---------|----------|
|
||||
| No issues found | Lower score thresholds or run more issue reviews |
|
||||
| All issues skipped | Remove `-SkipExisting` or check for existing PRs |
|
||||
| Parallel failures | Reduce throttle limits |
|
||||
@@ -1,123 +0,0 @@
|
||||
# IssueReviewLib.ps1 - Helpers for full issue-to-PR cycle workflow
|
||||
# Part of the PowerToys GitHub Copilot/Claude Code issue review system
|
||||
# This is a trimmed version with only what issue-to-pr-cycle needs
|
||||
|
||||
#region Console Output Helpers
|
||||
function Info { param([string]$Message) Write-Host $Message -ForegroundColor Cyan }
|
||||
function Warn { param([string]$Message) Write-Host $Message -ForegroundColor Yellow }
|
||||
function Err { param([string]$Message) Write-Host $Message -ForegroundColor Red }
|
||||
function Success { param([string]$Message) Write-Host $Message -ForegroundColor Green }
|
||||
#endregion
|
||||
|
||||
#region Repository Helpers
|
||||
function Get-RepoRoot {
|
||||
$root = git rev-parse --show-toplevel 2>$null
|
||||
if (-not $root) { throw 'Not inside a git repository.' }
|
||||
return (Resolve-Path $root).Path
|
||||
}
|
||||
|
||||
function Get-GeneratedFilesPath {
|
||||
param([string]$RepoRoot)
|
||||
return Join-Path $RepoRoot 'Generated Files'
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Issue Review Results Helpers
|
||||
function Get-HighConfidenceIssues {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Find issues with high confidence for auto-fix based on review results.
|
||||
.PARAMETER RepoRoot
|
||||
Repository root path.
|
||||
.PARAMETER MinFeasibilityScore
|
||||
Minimum Technical Feasibility score (0-100). Default: 70.
|
||||
.PARAMETER MinClarityScore
|
||||
Minimum Requirement Clarity score (0-100). Default: 60.
|
||||
.PARAMETER MaxEffortDays
|
||||
Maximum effort estimate in days. Default: 2 (S = Small).
|
||||
.PARAMETER FilterIssueNumbers
|
||||
Optional array of issue numbers to filter to. If specified, only these issues are considered.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[string]$RepoRoot,
|
||||
[int]$MinFeasibilityScore = 70,
|
||||
[int]$MinClarityScore = 60,
|
||||
[int]$MaxEffortDays = 2,
|
||||
[int[]]$FilterIssueNumbers = @()
|
||||
)
|
||||
|
||||
$genFiles = Get-GeneratedFilesPath -RepoRoot $RepoRoot
|
||||
$reviewDir = Join-Path $genFiles 'issueReview'
|
||||
|
||||
if (-not (Test-Path $reviewDir)) {
|
||||
return @()
|
||||
}
|
||||
|
||||
$highConfidence = @()
|
||||
|
||||
Get-ChildItem -Path $reviewDir -Directory | ForEach-Object {
|
||||
$issueNum = [int]$_.Name
|
||||
|
||||
# Skip if filter is specified and this issue is not in the filter list
|
||||
if ($FilterIssueNumbers.Count -gt 0 -and $issueNum -notin $FilterIssueNumbers) {
|
||||
return
|
||||
}
|
||||
|
||||
$overviewPath = Join-Path $_.FullName 'overview.md'
|
||||
$implPlanPath = Join-Path $_.FullName 'implementation-plan.md'
|
||||
|
||||
if (-not (Test-Path $overviewPath) -or -not (Test-Path $implPlanPath)) {
|
||||
return
|
||||
}
|
||||
|
||||
# Parse overview.md to extract scores
|
||||
$overview = Get-Content $overviewPath -Raw
|
||||
|
||||
# Extract scores using regex (looking for score table or inline scores)
|
||||
$feasibility = 0
|
||||
$clarity = 0
|
||||
$effortDays = 999
|
||||
|
||||
# Try to extract from At-a-Glance Score Table
|
||||
if ($overview -match 'Technical Feasibility[^\d]*(\d+)/100') {
|
||||
$feasibility = [int]$Matches[1]
|
||||
}
|
||||
if ($overview -match 'Requirement Clarity[^\d]*(\d+)/100') {
|
||||
$clarity = [int]$Matches[1]
|
||||
}
|
||||
# Match effort formats like "0.5-1 day", "1-2 days", "2-3 days" - extract the upper bound
|
||||
if ($overview -match 'Effort Estimate[^|]*\|\s*[\d.]+(?:-(\d+))?\s*days?') {
|
||||
if ($Matches[1]) {
|
||||
$effortDays = [int]$Matches[1]
|
||||
} elseif ($overview -match 'Effort Estimate[^|]*\|\s*(\d+)\s*days?') {
|
||||
$effortDays = [int]$Matches[1]
|
||||
}
|
||||
}
|
||||
# Also check for XS/S sizing in the table
|
||||
if ($overview -match 'Effort Estimate[^|]*\|[^|]*\|\s*(XS|S)\b') {
|
||||
if ($Matches[1] -eq 'XS') { $effortDays = 1 } else { $effortDays = 2 }
|
||||
} elseif ($overview -match 'Effort Estimate[^|]*\|[^|]*\(XS\)') {
|
||||
$effortDays = 1
|
||||
} elseif ($overview -match 'Effort Estimate[^|]*\|[^|]*\(S\)') {
|
||||
$effortDays = 2
|
||||
}
|
||||
|
||||
if ($feasibility -ge $MinFeasibilityScore -and
|
||||
$clarity -ge $MinClarityScore -and
|
||||
$effortDays -le $MaxEffortDays) {
|
||||
|
||||
$highConfidence += @{
|
||||
IssueNumber = $issueNum
|
||||
FeasibilityScore = $feasibility
|
||||
ClarityScore = $clarity
|
||||
EffortDays = $effortDays
|
||||
OverviewPath = $overviewPath
|
||||
ImplementationPlanPath = $implPlanPath
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $highConfidence | Sort-Object -Property FeasibilityScore -Descending
|
||||
}
|
||||
#endregion
|
||||
@@ -1,478 +0,0 @@
|
||||
<#!
|
||||
.SYNOPSIS
|
||||
Run the complete issue-to-PR cycle: fix issues, create PRs, review, and fix comments.
|
||||
|
||||
.DESCRIPTION
|
||||
Orchestrates the full workflow:
|
||||
1. Find high-confidence issues matching criteria
|
||||
2. Create worktrees and run auto-fix for each issue
|
||||
3. Commit changes and create PRs
|
||||
4. Run PR review workflow (assign Copilot, review, fix comments)
|
||||
|
||||
.PARAMETER MinFeasibilityScore
|
||||
Minimum Technical Feasibility score. Default: 70.
|
||||
|
||||
.PARAMETER MinClarityScore
|
||||
Minimum Requirement Clarity score. Default: 70.
|
||||
|
||||
.PARAMETER MaxEffortDays
|
||||
Maximum effort in days. Default: 10.
|
||||
|
||||
.PARAMETER ExcludeIssues
|
||||
Array of issue numbers to exclude (already processed).
|
||||
|
||||
.PARAMETER CLIType
|
||||
AI CLI to use: copilot or claude. Default: copilot.
|
||||
|
||||
.PARAMETER DryRun
|
||||
Show what would be done without executing.
|
||||
|
||||
.PARAMETER SkipExisting
|
||||
Skip issues that already have worktrees or PRs.
|
||||
|
||||
.EXAMPLE
|
||||
./Start-FullIssueCycle.ps1 -MinFeasibilityScore 70 -MinClarityScore 70 -MaxEffortDays 10
|
||||
|
||||
.EXAMPLE
|
||||
./Start-FullIssueCycle.ps1 -ExcludeIssues 44044,45029,32950,35703,44480 -DryRun
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[string]$Labels = '',
|
||||
[int]$Limit = 500, # GitHub API max is 1000, default to 500 to get most issues
|
||||
[int]$MinFeasibilityScore = 70,
|
||||
[int]$MinClarityScore = 70,
|
||||
[int]$MaxEffortDays = 10,
|
||||
[int[]]$ExcludeIssues = @(),
|
||||
[ValidateSet('copilot', 'claude')]
|
||||
[string]$CLIType = 'copilot',
|
||||
[int]$FixThrottleLimit = 5,
|
||||
[int]$PRThrottleLimit = 5,
|
||||
[int]$ReviewThrottleLimit = 3,
|
||||
[switch]$DryRun,
|
||||
[switch]$SkipExisting,
|
||||
[switch]$SkipReview,
|
||||
[switch]$Force,
|
||||
[switch]$Help
|
||||
)
|
||||
|
||||
$scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
|
||||
$skillsDir = Split-Path -Parent (Split-Path -Parent $scriptDir) # .github/skills
|
||||
. (Join-Path $scriptDir 'IssueReviewLib.ps1')
|
||||
|
||||
# Paths to other skills' scripts
|
||||
$issueFixScript = Join-Path $skillsDir 'issue-fix/scripts/Start-IssueAutoFix.ps1'
|
||||
$submitPRScript = Join-Path $skillsDir 'submit-pr/scripts/Submit-IssueFixes.ps1'
|
||||
$prReviewScript = Join-Path $skillsDir 'pr-review/scripts/Start-PRReviewWorkflow.ps1'
|
||||
|
||||
$repoRoot = Get-RepoRoot
|
||||
$worktreeLib = Join-Path $repoRoot 'tools/build/WorktreeLib.ps1'
|
||||
if (Test-Path $worktreeLib) {
|
||||
. $worktreeLib
|
||||
}
|
||||
|
||||
if ($Help) {
|
||||
Get-Help $MyInvocation.MyCommand.Path -Full
|
||||
return
|
||||
}
|
||||
|
||||
#region Helper Functions
|
||||
function Get-ExistingIssuePRs {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Get ALL issues that already have PRs (open, closed, or merged) - checking GitHub directly.
|
||||
#>
|
||||
param(
|
||||
[int[]]$IssueNumbers
|
||||
)
|
||||
|
||||
$existingPRs = @{}
|
||||
|
||||
foreach ($issueNum in $IssueNumbers) {
|
||||
# Check if there's a PR that mentions this issue (any state: open, closed, merged)
|
||||
$prs = gh pr list --search "fixes #$issueNum OR closes #$issueNum OR resolves #$issueNum" --state all --json number,url,headRefName,state 2>$null | ConvertFrom-Json
|
||||
if ($prs -and $prs.Count -gt 0) {
|
||||
$existingPRs[$issueNum] = @{
|
||||
PRNumber = $prs[0].number
|
||||
PRUrl = $prs[0].url
|
||||
Branch = $prs[0].headRefName
|
||||
State = $prs[0].state
|
||||
}
|
||||
continue
|
||||
}
|
||||
|
||||
# Also check for branch pattern issue/<number>* (any state)
|
||||
$branchPrs = gh pr list --head "issue/$issueNum" --state all --json number,url,headRefName,state 2>$null | ConvertFrom-Json
|
||||
if (-not $branchPrs -or $branchPrs.Count -eq 0) {
|
||||
# Try with wildcard search via gh api
|
||||
$branchPrs = gh pr list --state all --json number,url,headRefName,state 2>$null | ConvertFrom-Json | Where-Object { $_.headRefName -like "issue/$issueNum*" }
|
||||
}
|
||||
if ($branchPrs -and $branchPrs.Count -gt 0) {
|
||||
$existingPRs[$issueNum] = @{
|
||||
PRNumber = $branchPrs[0].number
|
||||
PRUrl = $branchPrs[0].url
|
||||
Branch = $branchPrs[0].headRefName
|
||||
State = $branchPrs[0].state
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $existingPRs
|
||||
}
|
||||
|
||||
function Get-ExistingWorktrees {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Get issues that already have worktrees.
|
||||
#>
|
||||
$existingWorktrees = @{}
|
||||
$worktrees = Get-WorktreeEntries | Where-Object { $_.Branch -like 'issue/*' }
|
||||
|
||||
foreach ($wt in $worktrees) {
|
||||
if ($wt.Branch -match 'issue/(\d+)') {
|
||||
$issueNum = [int]$Matches[1]
|
||||
$existingWorktrees[$issueNum] = $wt.Path
|
||||
}
|
||||
}
|
||||
|
||||
return $existingWorktrees
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Main Script
|
||||
try {
|
||||
$startTime = Get-Date
|
||||
|
||||
Info "=" * 80
|
||||
Info "FULL ISSUE-TO-PR CYCLE"
|
||||
Info "=" * 80
|
||||
Info "Repository root: $repoRoot"
|
||||
Info "CLI type: $CLIType"
|
||||
if ($Labels) {
|
||||
Info "Labels filter: $Labels"
|
||||
}
|
||||
Info "Criteria: Feasibility >= $MinFeasibilityScore, Clarity >= $MinClarityScore, Effort <= $MaxEffortDays days"
|
||||
|
||||
# Step 0: Review issues first (if labels specified and not skipping review)
|
||||
if ($Labels -and -not $SkipReview) {
|
||||
Info "`n" + ("=" * 60)
|
||||
Info "STEP 0: Reviewing issues with label '$Labels'"
|
||||
Info ("=" * 60)
|
||||
|
||||
$reviewScript = Join-Path $scriptDir '../../issue-review/scripts/Start-BulkIssueReview.ps1'
|
||||
if (Test-Path $reviewScript) {
|
||||
$reviewArgs = @{
|
||||
Labels = $Labels
|
||||
Limit = $Limit
|
||||
CLIType = $CLIType
|
||||
Force = $Force
|
||||
}
|
||||
if ($DryRun) {
|
||||
Info "[DRY RUN] Would run: Start-BulkIssueReview.ps1 -Labels '$Labels' -Limit $Limit -CLIType $CLIType -Force"
|
||||
} else {
|
||||
Info "Running bulk issue review..."
|
||||
& $reviewScript @reviewArgs
|
||||
}
|
||||
} else {
|
||||
Warn "Review script not found at: $reviewScript"
|
||||
Warn "Proceeding with existing review data..."
|
||||
}
|
||||
}
|
||||
|
||||
# Step 1: Find high-confidence issues
|
||||
Info "`n" + ("=" * 60)
|
||||
Info "STEP 1: Finding high-confidence issues"
|
||||
Info ("=" * 60)
|
||||
|
||||
# If labels specified, get the list of issue numbers with that label first
|
||||
# This ensures we ONLY look at issues with the specified label, not all reviewed issues
|
||||
$filterIssueNumbers = @()
|
||||
if ($Labels) {
|
||||
Info "Fetching issues with label '$Labels' from GitHub..."
|
||||
$labeledIssues = gh issue list --repo microsoft/PowerToys --label "$Labels" --state open --limit $Limit --json number 2>$null | ConvertFrom-Json
|
||||
$filterIssueNumbers = @($labeledIssues | ForEach-Object { $_.number })
|
||||
Info "Found $($filterIssueNumbers.Count) issues with label '$Labels'"
|
||||
}
|
||||
|
||||
$highConfidence = Get-HighConfidenceIssues `
|
||||
-RepoRoot $repoRoot `
|
||||
-MinFeasibilityScore $MinFeasibilityScore `
|
||||
-MinClarityScore $MinClarityScore `
|
||||
-MaxEffortDays $MaxEffortDays `
|
||||
-FilterIssueNumbers $filterIssueNumbers
|
||||
|
||||
Info "Found $($highConfidence.Count) high-confidence issues matching criteria"
|
||||
|
||||
if ($highConfidence.Count -eq 0) {
|
||||
Warn "No issues found matching criteria."
|
||||
return
|
||||
}
|
||||
|
||||
# Get issue numbers for checking
|
||||
$issueNumbers = $highConfidence | ForEach-Object { $_.IssueNumber }
|
||||
|
||||
# Get existing PRs to skip (check GitHub directly)
|
||||
Info "Checking for existing PRs..."
|
||||
$existingPRs = Get-ExistingIssuePRs -IssueNumbers $issueNumbers
|
||||
Info "Found $($existingPRs.Count) issues with existing PRs"
|
||||
|
||||
# Filter out excluded issues and those with existing PRs
|
||||
$issuesToProcess = $highConfidence | Where-Object {
|
||||
$issueNum = $_.IssueNumber
|
||||
$excluded = $issueNum -in $ExcludeIssues
|
||||
$hasPR = $existingPRs.ContainsKey($issueNum)
|
||||
|
||||
if ($excluded) {
|
||||
Info " Excluding #$issueNum (in exclude list)"
|
||||
}
|
||||
if ($hasPR -and $SkipExisting) {
|
||||
$prState = $existingPRs[$issueNum].State
|
||||
Info " Skipping #$issueNum (has $prState PR #$($existingPRs[$issueNum].PRNumber))"
|
||||
}
|
||||
|
||||
-not $excluded -and (-not $hasPR -or -not $SkipExisting)
|
||||
}
|
||||
|
||||
if ($issuesToProcess.Count -eq 0) {
|
||||
Warn "No new issues to process after filtering."
|
||||
return
|
||||
}
|
||||
|
||||
Info "`nIssues to process: $($issuesToProcess.Count)"
|
||||
Info ("-" * 80)
|
||||
foreach ($issue in $issuesToProcess) {
|
||||
$prInfo = if ($existingPRs.ContainsKey($issue.IssueNumber)) {
|
||||
$state = $existingPRs[$issue.IssueNumber].State
|
||||
" [has $state PR #$($existingPRs[$issue.IssueNumber].PRNumber)]"
|
||||
} else { "" }
|
||||
Info ("#{0,-6} [F:{1}, C:{2}, E:{3}d]{4}" -f $issue.IssueNumber, $issue.FeasibilityScore, $issue.ClarityScore, $issue.EffortDays, $prInfo)
|
||||
}
|
||||
Info ("-" * 80)
|
||||
|
||||
if ($DryRun) {
|
||||
Warn "`nDry run mode - showing what would be done:"
|
||||
Info " 1. Create worktrees for $($issuesToProcess.Count) issues (parallel)"
|
||||
Info " 2. Run Copilot auto-fix in each worktree (parallel)"
|
||||
Info " 3. Commit and create PRs (parallel)"
|
||||
Info " 4. Run PR review workflow (parallel)"
|
||||
return
|
||||
}
|
||||
|
||||
# Confirm
|
||||
if (-not $Force) {
|
||||
$confirm = Read-Host "`nProceed with full cycle for $($issuesToProcess.Count) issues? (y/N)"
|
||||
if ($confirm -notmatch '^[yY]') {
|
||||
Info "Cancelled."
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
# Track results
|
||||
$results = @{
|
||||
FixSucceeded = [System.Collections.Concurrent.ConcurrentBag[object]]::new()
|
||||
FixFailed = [System.Collections.Concurrent.ConcurrentBag[object]]::new()
|
||||
PRCreated = [System.Collections.Concurrent.ConcurrentBag[object]]::new()
|
||||
PRFailed = [System.Collections.Concurrent.ConcurrentBag[object]]::new()
|
||||
PRSkipped = [System.Collections.Concurrent.ConcurrentBag[object]]::new()
|
||||
ReviewSucceeded = [System.Collections.Concurrent.ConcurrentBag[object]]::new()
|
||||
ReviewFailed = [System.Collections.Concurrent.ConcurrentBag[object]]::new()
|
||||
}
|
||||
|
||||
# ========================================
|
||||
# PHASE 1: Create worktrees and fix issues (PARALLEL)
|
||||
# ========================================
|
||||
Info "`n" + ("=" * 60)
|
||||
Info "PHASE 1: Auto-Fix Issues (Parallel)"
|
||||
Info ("=" * 60)
|
||||
|
||||
$issuesNeedingFix = $issuesToProcess | Where-Object { -not $existingPRs.ContainsKey($_.IssueNumber) }
|
||||
$issuesWithPR = $issuesToProcess | Where-Object { $existingPRs.ContainsKey($_.IssueNumber) }
|
||||
|
||||
Info "Issues needing fix: $($issuesNeedingFix.Count)"
|
||||
Info "Issues with existing PR (skip to review): $($issuesWithPR.Count)"
|
||||
|
||||
if ($issuesNeedingFix.Count -gt 0) {
|
||||
$issuesNeedingFix | ForEach-Object -ThrottleLimit $FixThrottleLimit -Parallel {
|
||||
$issue = $_
|
||||
$issueNum = $issue.IssueNumber
|
||||
$issueFixScript = $using:issueFixScript
|
||||
$CLIType = $using:CLIType
|
||||
$results = $using:results
|
||||
|
||||
try {
|
||||
Write-Host "[Issue #$issueNum] Starting auto-fix..." -ForegroundColor Cyan
|
||||
& $issueFixScript -IssueNumber $issueNum -CLIType $CLIType -Force 2>&1 | Out-Null
|
||||
$results.FixSucceeded.Add($issueNum)
|
||||
Write-Host "[Issue #$issueNum] ✓ Fix completed" -ForegroundColor Green
|
||||
}
|
||||
catch {
|
||||
$results.FixFailed.Add(@{ IssueNumber = $issueNum; Error = $_.Exception.Message })
|
||||
Write-Host "[Issue #$issueNum] ✗ Fix failed: $($_.Exception.Message)" -ForegroundColor Red
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Info "`nPhase 1 complete: $($results.FixSucceeded.Count) succeeded, $($results.FixFailed.Count) failed"
|
||||
|
||||
# ========================================
|
||||
# PHASE 2: Commit and create PRs (PARALLEL)
|
||||
# ========================================
|
||||
Info "`n" + ("=" * 60)
|
||||
Info "PHASE 2: Submit PRs (Parallel)"
|
||||
Info ("=" * 60)
|
||||
|
||||
$fixedIssues = $results.FixSucceeded.ToArray()
|
||||
|
||||
if ($fixedIssues.Count -gt 0) {
|
||||
$fixedIssues | ForEach-Object -ThrottleLimit $PRThrottleLimit -Parallel {
|
||||
$issueNum = $_
|
||||
$submitPRScript = $using:submitPRScript
|
||||
$CLIType = $using:CLIType
|
||||
$results = $using:results
|
||||
|
||||
try {
|
||||
Write-Host "[Issue #$issueNum] Creating PR..." -ForegroundColor Cyan
|
||||
$submitResult = & $submitPRScript -IssueNumbers $issueNum -CLIType $CLIType -Force 2>&1
|
||||
|
||||
# Parse output to find PR URL
|
||||
$prUrl = $null
|
||||
$prNum = 0
|
||||
|
||||
if ($submitResult -match 'https://github.com/[^/]+/[^/]+/pull/(\d+)') {
|
||||
$prUrl = $Matches[0]
|
||||
$prNum = [int]$Matches[1]
|
||||
}
|
||||
|
||||
if ($prNum -gt 0) {
|
||||
$results.PRCreated.Add(@{ IssueNumber = $issueNum; PRNumber = $prNum; PRUrl = $prUrl })
|
||||
Write-Host "[Issue #$issueNum] ✓ PR #$prNum created" -ForegroundColor Green
|
||||
} else {
|
||||
# Check if PR was already created
|
||||
$existingPr = gh pr list --head "issue/$issueNum" --state open --json number,url 2>$null | ConvertFrom-Json
|
||||
if ($existingPr -and $existingPr.Count -gt 0) {
|
||||
$results.PRSkipped.Add(@{ IssueNumber = $issueNum; PRNumber = $existingPr[0].number; PRUrl = $existingPr[0].url; Reason = "Already exists" })
|
||||
Write-Host "[Issue #$issueNum] PR already exists: #$($existingPr[0].number)" -ForegroundColor Yellow
|
||||
} else {
|
||||
$results.PRFailed.Add(@{ IssueNumber = $issueNum; Error = "No PR created" })
|
||||
Write-Host "[Issue #$issueNum] ✗ PR creation failed" -ForegroundColor Red
|
||||
}
|
||||
}
|
||||
}
|
||||
catch {
|
||||
$results.PRFailed.Add(@{ IssueNumber = $issueNum; Error = $_.Exception.Message })
|
||||
Write-Host "[Issue #$issueNum] ✗ PR failed: $($_.Exception.Message)" -ForegroundColor Red
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Info "`nPhase 2 complete: $($results.PRCreated.Count) created, $($results.PRSkipped.Count) skipped, $($results.PRFailed.Count) failed"
|
||||
|
||||
# ========================================
|
||||
# PHASE 3: Review PRs (PARALLEL)
|
||||
# ========================================
|
||||
Info "`n" + ("=" * 60)
|
||||
Info "PHASE 3: Review PRs (Parallel)"
|
||||
Info ("=" * 60)
|
||||
|
||||
# Collect all PRs to review (newly created + existing)
|
||||
$prsToReview = @()
|
||||
|
||||
foreach ($pr in $results.PRCreated.ToArray()) {
|
||||
$prsToReview += @{ IssueNumber = $pr.IssueNumber; PRNumber = $pr.PRNumber }
|
||||
}
|
||||
foreach ($pr in $results.PRSkipped.ToArray()) {
|
||||
$prsToReview += @{ IssueNumber = $pr.IssueNumber; PRNumber = $pr.PRNumber }
|
||||
}
|
||||
foreach ($issue in $issuesWithPR) {
|
||||
$prInfo = $existingPRs[$issue.IssueNumber]
|
||||
$prsToReview += @{ IssueNumber = $issue.IssueNumber; PRNumber = $prInfo.PRNumber }
|
||||
}
|
||||
|
||||
Info "PRs to review: $($prsToReview.Count)"
|
||||
|
||||
if ($prsToReview.Count -gt 0) {
|
||||
$prsToReview | ForEach-Object -ThrottleLimit $ReviewThrottleLimit -Parallel {
|
||||
$pr = $_
|
||||
$issueNum = $pr.IssueNumber
|
||||
$prNum = $pr.PRNumber
|
||||
$prReviewScript = $using:prReviewScript
|
||||
$CLIType = $using:CLIType
|
||||
$results = $using:results
|
||||
|
||||
try {
|
||||
Write-Host "[PR #$prNum] Starting review workflow..." -ForegroundColor Cyan
|
||||
& $prReviewScript -PRNumbers $prNum -CLIType $CLIType -Force 2>&1 | Out-Null
|
||||
$results.ReviewSucceeded.Add(@{ IssueNumber = $issueNum; PRNumber = $prNum })
|
||||
Write-Host "[PR #$prNum] ✓ Review completed" -ForegroundColor Green
|
||||
}
|
||||
catch {
|
||||
$results.ReviewFailed.Add(@{ IssueNumber = $issueNum; PRNumber = $prNum; Error = $_.Exception.Message })
|
||||
Write-Host "[PR #$prNum] ✗ Review failed: $($_.Exception.Message)" -ForegroundColor Red
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Info "`nPhase 3 complete: $($results.ReviewSucceeded.Count) succeeded, $($results.ReviewFailed.Count) failed"
|
||||
|
||||
# Final Summary
|
||||
$duration = (Get-Date) - $startTime
|
||||
|
||||
Info "`n" + ("=" * 80)
|
||||
Info "FULL CYCLE COMPLETE"
|
||||
Info ("=" * 80)
|
||||
Info "Duration: $($duration.ToString('hh\:mm\:ss'))"
|
||||
Info ""
|
||||
Info "Issues processed: $($issuesToProcess.Count)"
|
||||
Success "Fixes succeeded: $($results.FixSucceeded.Count)"
|
||||
if ($results.FixFailed.Count -gt 0) {
|
||||
Err "Fixes failed: $($results.FixFailed.Count)"
|
||||
}
|
||||
Success "PRs created: $($results.PRCreated.Count)"
|
||||
if ($results.PRSkipped.Count -gt 0) {
|
||||
Warn "PRs skipped: $($results.PRSkipped.Count) (already existed)"
|
||||
}
|
||||
if ($results.PRFailed.Count -gt 0) {
|
||||
Err "PRs failed: $($results.PRFailed.Count)"
|
||||
}
|
||||
Success "Reviews completed: $($results.ReviewSucceeded.Count)"
|
||||
if ($results.ReviewFailed.Count -gt 0) {
|
||||
Err "Reviews failed: $($results.ReviewFailed.Count)"
|
||||
}
|
||||
|
||||
Info ""
|
||||
Info "Summary by issue:"
|
||||
foreach ($issue in $issuesToProcess) {
|
||||
$issueNum = $issue.IssueNumber
|
||||
$prInfo = $results.PRCreated.ToArray() | Where-Object { $_.IssueNumber -eq $issueNum } | Select-Object -First 1
|
||||
if (-not $prInfo) {
|
||||
$prInfo = $results.PRSkipped.ToArray() | Where-Object { $_.IssueNumber -eq $issueNum } | Select-Object -First 1
|
||||
}
|
||||
if (-not $prInfo -and $existingPRs.ContainsKey($issueNum)) {
|
||||
$prInfo = @{ PRNumber = $existingPRs[$issueNum].PRNumber }
|
||||
}
|
||||
|
||||
$prNum = if ($prInfo) { "PR #$($prInfo.PRNumber)" } else { "No PR" }
|
||||
$fixStatus = if ($results.FixSucceeded.ToArray() -contains $issueNum) { "✓" } elseif ($results.FixFailed.ToArray().IssueNumber -contains $issueNum) { "✗" } else { "-" }
|
||||
$reviewStatus = if ($results.ReviewSucceeded.ToArray().IssueNumber -contains $issueNum -or $results.ReviewSucceeded.ToArray().PRNumber -contains $prInfo.PRNumber) { "✓" } else { "-" }
|
||||
|
||||
Info (" Issue #{0,-6} [{1}Fix] [{2}Review] -> {3}" -f $issueNum, $fixStatus, $reviewStatus, $prNum)
|
||||
}
|
||||
|
||||
Info ("=" * 80)
|
||||
|
||||
return @{
|
||||
FixSucceeded = $results.FixSucceeded.ToArray()
|
||||
FixFailed = $results.FixFailed.ToArray()
|
||||
PRCreated = $results.PRCreated.ToArray()
|
||||
PRSkipped = $results.PRSkipped.ToArray()
|
||||
PRFailed = $results.PRFailed.ToArray()
|
||||
ReviewSucceeded = $results.ReviewSucceeded.ToArray()
|
||||
ReviewFailed = $results.ReviewFailed.ToArray()
|
||||
}
|
||||
}
|
||||
catch {
|
||||
Err "Error: $($_.Exception.Message)"
|
||||
exit 1
|
||||
}
|
||||
#endregion
|
||||
21
.github/skills/pr-review/LICENSE.txt
vendored
21
.github/skills/pr-review/LICENSE.txt
vendored
@@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) Microsoft Corporation.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
121
.github/skills/pr-review/SKILL.md
vendored
121
.github/skills/pr-review/SKILL.md
vendored
@@ -1,121 +0,0 @@
|
||||
---
|
||||
name: pr-review
|
||||
description: Comprehensive pull request review with multi-step analysis and comment posting. Use when asked to review a PR, analyze pull request changes, check PR for issues, post review comments, validate PR quality, run code review on a PR, or audit pull request. Generates 13 review step files covering functionality, security, performance, accessibility, and more.
|
||||
license: Complete terms in LICENSE.txt
|
||||
---
|
||||
|
||||
# PR Review Skill
|
||||
|
||||
Perform comprehensive pull request reviews with multi-step analysis covering functionality, security, performance, accessibility, localization, and more.
|
||||
|
||||
## Skill Contents
|
||||
|
||||
This skill is **self-contained** with all required resources:
|
||||
|
||||
```
|
||||
.github/skills/pr-review/
|
||||
├── SKILL.md # This file
|
||||
├── LICENSE.txt # MIT License
|
||||
├── scripts/
|
||||
│ ├── Start-PRReviewWorkflow.ps1 # Main review script
|
||||
│ ├── Get-GitHubPrFilePatch.ps1 # Fetch PR file diffs
|
||||
│ ├── Get-GitHubRawFile.ps1 # Download repo files
|
||||
│ ├── Get-PrIncrementalChanges.ps1 # Detect incremental changes
|
||||
│ └── Test-IncrementalReview.ps1 # Test incremental detection
|
||||
└── references/
|
||||
├── review-pr.prompt.md # Full review prompt
|
||||
└── fix-pr-active-comments.prompt.md # Comment fix prompt
|
||||
```
|
||||
|
||||
## Output Directory
|
||||
|
||||
All generated artifacts are placed under `Generated Files/prReview/<pr-number>/` at the repository root (gitignored).
|
||||
|
||||
```
|
||||
Generated Files/prReview/
|
||||
└── <pr-number>/
|
||||
├── 00-OVERVIEW.md # Summary with all findings
|
||||
├── 01-functionality.md # Functional correctness
|
||||
├── 02-compatibility.md # Breaking changes, versioning
|
||||
├── 03-performance.md # Performance implications
|
||||
├── 04-accessibility.md # A11y compliance
|
||||
├── 05-security.md # Security concerns
|
||||
├── 06-localization.md # L10n readiness
|
||||
├── 07-globalization.md # G11n considerations
|
||||
├── 08-extensibility.md # API/extension points
|
||||
├── 09-solid-design.md # SOLID principles
|
||||
├── 10-repo-patterns.md # PowerToys conventions
|
||||
├── 11-docs-automation.md # Documentation coverage
|
||||
├── 12-code-comments.md # Code comment quality
|
||||
└── 13-copilot-guidance.md # (if applicable)
|
||||
```
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
- Review a specific pull request
|
||||
- Analyze PR changes for quality issues
|
||||
- Post review comments on a PR
|
||||
- Validate PR against PowerToys standards
|
||||
- Run comprehensive code review
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- GitHub CLI (`gh`) installed and authenticated
|
||||
- PowerShell 7+ for running scripts
|
||||
- GitHub MCP configured (for posting comments)
|
||||
|
||||
## Required Variables
|
||||
|
||||
⚠️ **Before starting**, confirm `{{PRNumber}}` with the user. If not provided, **ASK**: "What PR number should I review?"
|
||||
|
||||
| Variable | Description | Example |
|
||||
|----------|-------------|---------|
|
||||
| `{{PRNumber}}` | Pull request number to review | `45234` |
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1: Run PR Review
|
||||
|
||||
Execute the review workflow (use paths relative to this skill folder):
|
||||
|
||||
```powershell
|
||||
# From repo root
|
||||
.github/skills/pr-review/scripts/Start-PRReviewWorkflow.ps1 -PRNumbers {{PRNumber}} -CLIType copilot
|
||||
```
|
||||
|
||||
This will:
|
||||
1. Optionally assign GitHub Copilot as reviewer
|
||||
2. Fetch PR diff and changed files
|
||||
3. Generate 13 review step files
|
||||
4. Post findings as review comments
|
||||
|
||||
### Step 2: Review Output
|
||||
|
||||
Check the generated files at `Generated Files/prReview/{{PRNumber}}/`
|
||||
|
||||
## CLI Options
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `-PRNumbers` | PR number(s) to review | From worktrees |
|
||||
| `-CLIType` | AI CLI to use: `copilot` or `claude` | `copilot` |
|
||||
| `-MinSeverity` | Min severity to post: `high`, `medium`, `low`, `info` | `medium` |
|
||||
| `-SkipAssign` | Skip assigning Copilot as reviewer | `false` |
|
||||
| `-SkipReview` | Skip the review step | `false` |
|
||||
| `-SkipFix` | Skip the fix step | `false` |
|
||||
| `-MaxParallel` | Maximum parallel jobs | `3` |
|
||||
| `-Force` | Skip confirmation prompts | `false` |
|
||||
|
||||
## AI Prompt References
|
||||
|
||||
For manual AI invocation, prompts are at:
|
||||
- `references/review-pr.prompt.md` - Full review instructions
|
||||
- `references/fix-pr-active-comments.prompt.md` - Comment fix instructions
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Problem | Solution |
|
||||
|---------|----------|
|
||||
| PR not found | Verify PR number: `gh pr view {{PRNumber}}` |
|
||||
| Review incomplete | Check `_copilot-review.log` for errors |
|
||||
| Comments not posted | Ensure GitHub MCP is configured |
|
||||
@@ -1,70 +0,0 @@
|
||||
---
|
||||
description: 'Fix active pull request comments with scoped changes'
|
||||
name: 'fix-pr-active-comments'
|
||||
agent: 'agent'
|
||||
argument-hint: 'PR number or active PR URL'
|
||||
---
|
||||
|
||||
# Fix Active PR Comments
|
||||
|
||||
## Mission
|
||||
Resolve active pull request comments by applying only simple fixes. For complex refactors, write a plan instead of changing code.
|
||||
|
||||
## Scope & Preconditions
|
||||
- You must have an active pull request context or a provided PR number.
|
||||
- Only implement simple changes. Do not implement large refactors.
|
||||
- If required context is missing, request it and stop.
|
||||
|
||||
## Inputs
|
||||
- Required: ${input:pr_number:PR number or URL}
|
||||
- Optional: ${input:comment_scope:files or areas to focus on}
|
||||
- Optional: ${input:fixing_guidelines:additional fixing guidelines from the user}
|
||||
|
||||
## Workflow
|
||||
1. Locate all active (unresolved) PR review comments for the given PR.
|
||||
2. For each comment, classify the change scope:
|
||||
- Simple change: limited edits, localized fix, low risk, no broad redesign.
|
||||
- Large refactor: multi-file redesign, architecture change, or risky behavior change.
|
||||
3. For each large refactor request:
|
||||
- Do not modify code.
|
||||
- Write a planning document to Generated Files/prReview/${input:pr_number}/fixPlan/.
|
||||
4. For each simple change request:
|
||||
- Implement the fix with minimal edits.
|
||||
- Run quick checks if needed.
|
||||
- Commit and push the change.
|
||||
5. For comments that seem invalid, unclear, or not applicable (even if simple):
|
||||
- Do not change code.
|
||||
- Add the item to a summary table in Generated Files/prReview/${input:pr_number}/fixPlan/overview.md.
|
||||
- Consult back to the end user in a friendly, polite tone.
|
||||
6. Respond to each comment that you fixed:
|
||||
- Reply in the active conversation.
|
||||
- Use a polite or friendly tone.
|
||||
- Keep the response under 200 words.
|
||||
- Resolve the comment after replying.
|
||||
|
||||
## Output Expectations
|
||||
- Simple fixes: code changes committed and pushed.
|
||||
- Large refactors: a plan file saved to Generated Files/prReview/${input:pr_number}/fixPlan/.
|
||||
- Invalid or unclear comments: captured in Generated Files/prReview/${input:pr_number}/fixPlan/overview.md.
|
||||
- Each fixed comment has a reply under 200 words and is resolved.
|
||||
|
||||
## Plan File Template
|
||||
Use this template for each large refactor item:
|
||||
|
||||
# Fix Plan: <short title>
|
||||
|
||||
## Context
|
||||
- Comment link:
|
||||
- Impacted areas:
|
||||
|
||||
## Overview Table Template
|
||||
Use this table in Generated Files/prReview/${input:pr_number}/fixPlan/overview.md:
|
||||
|
||||
| Comment link | Summary | Reason not applied | Suggested follow-up |
|
||||
| --- | --- | --- | --- |
|
||||
| | | | |
|
||||
|
||||
## Quality Assurance
|
||||
- Verify plan file path exists.
|
||||
- Ensure no code changes were made for large refactor items.
|
||||
- Confirm replies are under 200 words and comments are resolved.
|
||||
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"mcpServers": {
|
||||
"github-artifacts": {
|
||||
"command": "cmd",
|
||||
"args": ["/c", "for /f %i in ('git rev-parse --show-toplevel') do node %i/tools/mcp/github-artifacts/launch.js"],
|
||||
"tools": ["*"]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,198 +0,0 @@
|
||||
---
|
||||
agent: 'agent'
|
||||
description: 'Perform a comprehensive PR review with per-step Markdown and machine-readable outputs'
|
||||
---
|
||||
|
||||
# Review Pull Request
|
||||
|
||||
**Goal**: Given `{{pr_number}}`, run a *one-topic-per-step* review. Write files to `Generated Files/prReview/{{pr_number}}/` (replace `{{pr_number}}` with the integer). Emit machine‑readable blocks for a GitHub MCP to post review comments.
|
||||
|
||||
## PR selection
|
||||
Resolve the target PR using these fallbacks in order:
|
||||
1. Parse the invocation text for an explicit identifier (first integer following patterns such as a leading hash and digits or the text `PR:` followed by digits).
|
||||
2. If no PR is found yet, locate the newest `Generated Files/prReview/_batch/batch-overview-*.md` file (highest timestamp in filename, fallback newest mtime) and take the first entry in its `## PRs` list whose review folder is missing `00-OVERVIEW.md` or contains `__error.flag`.
|
||||
3. If the batch file has no pending PRs, query assignments with `gh pr list --assignee @me --state open --json number,updatedAt --limit 20` and pick the most recently updated PR that does not already have a completed review folder.
|
||||
4. If still unknown, run `gh pr view --json number` in the current branch and use that result when it is unambiguous.
|
||||
5. If every step above fails, prompt the user for a PR number before proceeding.
|
||||
|
||||
## Fetch PR data with `gh`
|
||||
- `gh pr view {{pr_number}} --json number,baseRefName,headRefName,baseRefOid,headRefOid,changedFiles,files`
|
||||
- `gh api repos/:owner/:repo/pulls/{{pr_number}}/files?per_page=250` # patches for line mapping
|
||||
|
||||
### Incremental review workflow
|
||||
1. **Check for existing review**: Read `Generated Files/prReview/{{pr_number}}/00-OVERVIEW.md`
|
||||
2. **Extract state**: Parse `Last reviewed SHA:` from review metadata section
|
||||
3. **Detect changes**: Run `Get-PrIncrementalChanges.ps1 -PullRequestNumber {{pr_number}} -LastReviewedCommitSha {{sha}}`
|
||||
4. **Analyze result**:
|
||||
- `NeedFullReview: true` → Review all files in the PR
|
||||
- `NeedFullReview: false` and `IsIncremental: true` → Review only files in `ChangedFiles` array
|
||||
- `ChangedFiles` is empty → No changes, skip review (update iteration history with "No changes since last review")
|
||||
5. **Apply smart filtering**: Use the file patterns in smart step filtering table to skip irrelevant steps
|
||||
6. **Update metadata**: After completing review, save current `headRefOid` as `Last reviewed SHA:` in `00-OVERVIEW.md`
|
||||
|
||||
### Reusable PowerShell scripts
|
||||
Scripts live in `.github/review-tools/` to avoid repeated manual approvals during PR reviews:
|
||||
|
||||
| Script | Usage |
|
||||
| --- | --- |
|
||||
| `.github/review-tools/Get-GitHubRawFile.ps1` | Download a repository file at a given ref, optionally with line numbers. |
|
||||
| `.github/review-tools/Get-GitHubPrFilePatch.ps1` | Fetch the unified diff for a specific file within a pull request via `gh api`. |
|
||||
| `.github/review-tools/Get-PrIncrementalChanges.ps1` | Compare last reviewed SHA with current PR head to identify incremental changes. Returns JSON with changed files, new commits, and whether full review is needed. |
|
||||
| `.github/review-tools/Test-IncrementalReview.ps1` | Test helper to preview incremental review detection for a PR. Use before running full review to see what changed. |
|
||||
|
||||
Always prefer these scripts (or new ones added under `.github/review-tools/`) over raw `gh api` or similar shell commands so the review flow does not trigger interactive approval prompts.
|
||||
|
||||
## Output files
|
||||
Folder: `Generated Files/prReview/{{pr_number}}/`
|
||||
Files: `00-OVERVIEW.md`, `01-functionality.md`, `02-compatibility.md`, `03-performance.md`, `04-accessibility.md`, `05-security.md`, `06-localization.md`, `07-globalization.md`, `08-extensibility.md`, `09-solid-design.md`, `10-repo-patterns.md`, `11-docs-automation.md`, `12-code-comments.md`, `13-copilot-guidance.md` *(only if guidance md exists).*
|
||||
- **Write-after-step rule:** Immediately after completing each TODO step, persist that step's markdown file before proceeding to the next. Generate `00-OVERVIEW.md` only after every step file has been refreshed for the current run.
|
||||
|
||||
## Iteration management
|
||||
- Determine the current review iteration by reading `00-OVERVIEW.md` (look for `Review iteration:`). If missing, assume iteration `1`.
|
||||
- Extract the last reviewed SHA from `00-OVERVIEW.md` (look for `Last reviewed SHA:` in the review metadata section). If missing, this is iteration 1.
|
||||
- **Incremental review detection**:
|
||||
1. Call `.github/review-tools/Get-PrIncrementalChanges.ps1 -PullRequestNumber {{pr_number}} -LastReviewedCommitSha {{last_sha}}` to get delta analysis.
|
||||
2. Parse the JSON result to determine if incremental review is possible (`IsIncremental: true`, `NeedFullReview: false`).
|
||||
3. If force-push detected or first review, proceed with full review of all changed files.
|
||||
4. If incremental, review only the files listed in `ChangedFiles` array and apply smart step filtering (see below).
|
||||
- Increment the iteration for each review run and propagate the new value to all step files and the overview.
|
||||
- Preserve prior iteration notes by keeping/expanding an `## Iteration history` section in each markdown file, appending the newest summary under `### Iteration <N>`.
|
||||
- Summaries should capture key deltas since the previous iteration so reruns can pick up context quickly.
|
||||
- **After review completion**, update `Last reviewed SHA:` in `00-OVERVIEW.md` with the current `headRefOid` and update the timestamp.
|
||||
|
||||
### Smart step filtering (incremental reviews only)
|
||||
When performing incremental review, skip steps that are irrelevant based on changed file types:
|
||||
|
||||
| File pattern | Required steps | Skippable steps |
|
||||
| --- | --- | --- |
|
||||
| `**/*.cs`, `**/*.cpp`, `**/*.h` | Functionality, Compatibility, Performance, Security, SOLID, Repo patterns, Code comments | (depends on files) |
|
||||
| `**/*.resx`, `**/Resources/*.xaml` | Localization, Globalization | Most others |
|
||||
| `**/*.md` (docs) | Docs & automation | Most others (unless copilot guidance) |
|
||||
| `**/*copilot*.md`, `.github/prompts/*.md` | Copilot guidance, Docs & automation | Most others |
|
||||
| `**/*.csproj`, `**/*.vcxproj`, `**/packages.config` | Compatibility, Security, Repo patterns | Localization, Globalization, Accessibility |
|
||||
| `**/UI/**`, `**/*View.xaml` | Accessibility, Localization | Performance (unless perf-sensitive controls) |
|
||||
|
||||
**Default**: If uncertain or files span multiple categories, run all applicable steps. When in doubt, be conservative and review more rather than less.
|
||||
|
||||
## TODO steps (one concern each)
|
||||
1) Functionality
|
||||
2) Compatibility
|
||||
3) Performance
|
||||
4) Accessibility
|
||||
5) Security
|
||||
6) Localization
|
||||
7) Globalization
|
||||
8) Extensibility
|
||||
9) SOLID principles
|
||||
10) Repo patterns
|
||||
11) Docs & automation coverage for the changes
|
||||
12) Code comments
|
||||
13) Copilot guidance (conditional): if changed folders contain `*copilot*.md` or `.github/prompts/*.md`, review diffs **against** that guidance and write `13-copilot-guidance.md` (omit if none).
|
||||
|
||||
## Per-step file template (use verbatim)
|
||||
```md
|
||||
# <STEP TITLE>
|
||||
**PR:** (populate with PR identifier) — Base:<baseRefName> Head:<headRefName>
|
||||
**Review iteration:** ITERATION
|
||||
|
||||
## Iteration history
|
||||
- Maintain subsections titled `### Iteration N` in reverse chronological order (append the latest at the top) with 2–4 bullet highlights.
|
||||
|
||||
### Iteration ITERATION
|
||||
- <Latest key point 1>
|
||||
- <Latest key point 2>
|
||||
|
||||
## Checks executed
|
||||
- List the concrete checks for *this step only* (5–10 bullets).
|
||||
|
||||
## Findings
|
||||
(If none, write **None**. Defaults have one or more blocks:)
|
||||
|
||||
```mcp-review-comment
|
||||
{"file":"relative/path.ext","start_line":123,"end_line":125,"severity":"high|medium|low|info","tags":["<step-slug>","pr-tag-here"],"related_files":["optional/other/file1"],"body":"Problem → Why it matters → Concrete fix. If spans multiple files, name them here."}
|
||||
```
|
||||
Use the second tag to encode the PR number.
|
||||
|
||||
```
|
||||
## Overview file (`00-OVERVIEW.md`) template
|
||||
```md
|
||||
# PR Review Overview — (populate with PR identifier)
|
||||
**Review iteration:** ITERATION
|
||||
**Changed files:** <n> | **High severity issues:** <count>
|
||||
|
||||
## Review metadata
|
||||
**Last reviewed SHA:** <headRefOid from gh pr view>
|
||||
**Last review timestamp:** <ISO8601 timestamp>
|
||||
**Review mode:** <Full|Incremental (N files changed since iteration X)>
|
||||
**Base ref:** <baseRefName>
|
||||
**Head ref:** <headRefName>
|
||||
|
||||
## Step results
|
||||
Write lines like: `01 Functionality — <OK|Issues|Skipped> (see 01-functionality.md)` … through step 13.
|
||||
Mark steps as "Skipped" when using incremental review smart filtering.
|
||||
|
||||
## Iteration history
|
||||
- Maintain subsections titled `### Iteration N` mirroring the per-step convention with concise deltas and cross-links to the relevant step files.
|
||||
- For incremental reviews, list the specific files that changed and which commits were added.
|
||||
```
|
||||
|
||||
## Line numbers & multi‑file issues
|
||||
- Map head‑side lines from `patch` hunks (`@@ -a,b +c,d @@` → new lines `+c..+c+d-1`).
|
||||
- For cross‑file issues: set the primary `"file"`, list others in `"related_files"`, and name them in `"body"`.
|
||||
|
||||
## Posting (for MCP)
|
||||
- Parse all ```mcp-review-comment``` blocks across step files and post as PR review comments.
|
||||
- If posting isn’t available, still write all files.
|
||||
|
||||
## Constraint
|
||||
Read/analyze only; don't modify code. Keep comments small, specific, and fix‑oriented.
|
||||
|
||||
**Testing**: Use `.github/review-tools/Test-IncrementalReview.ps1 -PullRequestNumber 42374` to preview incremental detection before running full review.
|
||||
|
||||
## Scratch cache for large PRs
|
||||
|
||||
Create a local scratch workspace to progressively summarize diffs and reload state across runs.
|
||||
|
||||
### Paths
|
||||
- Root: `Generated Files/prReview/{{pr_number}}/__tmp/`
|
||||
- Files:
|
||||
- `index.jsonl` — append-only JSON Lines index of artifacts.
|
||||
- `todo-queue.json` — pending items (files/chunks/steps).
|
||||
- `rollup-<step>-v<N>.md` — iterative per-step aggregates.
|
||||
- `file-<hash>.txt` — optional saved chunk text (when needed).
|
||||
|
||||
### JSON schema (per line in `index.jsonl`)
|
||||
```json
|
||||
{"type":"chunk|summary|issue|crosslink",
|
||||
"path":"relative/file.ext","chunk_id":"f-12","step":"functionality|compatibility|...",
|
||||
"base_sha":"...", "head_sha":"...", "range":[start,end], "version":1,
|
||||
"notes":"short text or key:value map", "created_utc":"ISO8601"}
|
||||
```
|
||||
|
||||
### Phases (stateful; resume-safe)
|
||||
0. **Discover** PR + SHAs: `gh pr view <PR> --json baseRefName,headRefName,baseRefOid,headRefOid,files`.
|
||||
1. **Chunk** each changed file (head): split into ~300–600 LOC or ~4k chars; stable `chunk_id` = hash(path+start).
|
||||
- Save `chunk` records. Optionally write `file-<hash>.txt` for expensive chunks.
|
||||
2. **Summarize** per chunk: intent, APIs, risks per TODO step; emit `summary` records (≤600 tokens each).
|
||||
3. **Issues**: convert findings to machine-readable blocks and emit `issue` records (later rendered to step MD).
|
||||
4. **Rollups**: build/update `rollup-<step>-v<N>.md` from `summary`+`issue`. Keep prior versions.
|
||||
5. **Finalize**: write per-step files + `00-OVERVIEW.md` from rollups. Post comments via MCP if available.
|
||||
|
||||
### Re-use & token limits
|
||||
- Always **reload** `index.jsonl` first; skip chunks with same `head_sha` and `range`.
|
||||
- **Incremental review optimization**: When `Get-PrIncrementalChanges.ps1` returns a subset of changed files, load only chunks from those files. Reuse existing chunks/summaries for unchanged files.
|
||||
- Prefer re-summarizing only changed chunks; merge chunk summaries → file summaries → step rollups.
|
||||
- When context is tight, load only the minimal chunk text (or its saved `file-<hash>.txt`) needed for a comment.
|
||||
|
||||
### Original vs diff
|
||||
- Fetch base content when needed: prefer `git show <baseRefName>:<path>`; fallback `gh api repos/:owner/:repo/contents/<path>?ref=<base_sha>` (base64).
|
||||
- Use patch hunks from `gh api .../pulls/<PR>/files` to compute **head** line numbers.
|
||||
|
||||
### Queue-driven loop
|
||||
- Seed `todo-queue.json` with all changed files.
|
||||
- Process: chunk → summarize → detect issues → roll up.
|
||||
- Append to `index.jsonl` after each step; never rewrite previous lines (append-only).
|
||||
|
||||
### Hygiene
|
||||
- `__tmp/` is implementation detail; do not include in final artifacts.
|
||||
- It is safe to delete to force a clean pass; the next run rebuilds it.
|
||||
@@ -1,79 +0,0 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Retrieves the unified diff patch for a specific file in a GitHub pull request.
|
||||
|
||||
.DESCRIPTION
|
||||
This script fetches the patch content (unified diff format) for a specified file
|
||||
within a pull request. It uses the GitHub CLI (gh) to query the GitHub API and
|
||||
retrieve file change information.
|
||||
|
||||
.PARAMETER PullRequestNumber
|
||||
The pull request number to query.
|
||||
|
||||
.PARAMETER FilePath
|
||||
The relative path to the file in the repository (e.g., "src/modules/main.cpp").
|
||||
|
||||
.PARAMETER RepositoryOwner
|
||||
The GitHub repository owner. Defaults to "microsoft".
|
||||
|
||||
.PARAMETER RepositoryName
|
||||
The GitHub repository name. Defaults to "PowerToys".
|
||||
|
||||
.EXAMPLE
|
||||
.\Get-GitHubPrFilePatch.ps1 -PullRequestNumber 42374 -FilePath "src/modules/cmdpal/main.cpp"
|
||||
Retrieves the patch for main.cpp in PR #42374.
|
||||
|
||||
.EXAMPLE
|
||||
.\Get-GitHubPrFilePatch.ps1 -PullRequestNumber 42374 -FilePath "README.md" -RepositoryOwner "myorg" -RepositoryName "myrepo"
|
||||
Retrieves the patch from a different repository.
|
||||
|
||||
.NOTES
|
||||
Requires GitHub CLI (gh) to be installed and authenticated.
|
||||
Run 'gh auth login' if not already authenticated.
|
||||
|
||||
.LINK
|
||||
https://cli.github.com/
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[Parameter(Mandatory = $true, HelpMessage = "Pull request number")]
|
||||
[int]$PullRequestNumber,
|
||||
|
||||
[Parameter(Mandatory = $true, HelpMessage = "Relative path to the file in the repository")]
|
||||
[string]$FilePath,
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Repository owner")]
|
||||
[string]$RepositoryOwner = "microsoft",
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Repository name")]
|
||||
[string]$RepositoryName = "PowerToys"
|
||||
)
|
||||
|
||||
# Construct GitHub API path for pull request files
|
||||
$apiPath = "repos/$RepositoryOwner/$RepositoryName/pulls/$PullRequestNumber/files?per_page=250"
|
||||
|
||||
# Query GitHub API to get all files in the pull request
|
||||
try {
|
||||
$pullRequestFiles = gh api $apiPath | ConvertFrom-Json
|
||||
} catch {
|
||||
Write-Error "Failed to query GitHub API for PR #$PullRequestNumber. Ensure gh CLI is authenticated. Details: $_"
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Find the matching file in the pull request
|
||||
$matchedFile = $pullRequestFiles | Where-Object { $_.filename -eq $FilePath }
|
||||
|
||||
if (-not $matchedFile) {
|
||||
Write-Error "File '$FilePath' not found in PR #$PullRequestNumber."
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Check if patch content exists
|
||||
if (-not $matchedFile.patch) {
|
||||
Write-Warning "File '$FilePath' has no patch content (possibly binary or too large)."
|
||||
return
|
||||
}
|
||||
|
||||
# Output the patch content
|
||||
$matchedFile.patch
|
||||
@@ -1,91 +0,0 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Downloads and displays the content of a file from a GitHub repository at a specific git reference.
|
||||
|
||||
.DESCRIPTION
|
||||
This script fetches the raw content of a file from a GitHub repository using GitHub's raw content API.
|
||||
It can optionally display line numbers and supports any valid git reference (branch, tag, or commit SHA).
|
||||
|
||||
.PARAMETER FilePath
|
||||
The relative path to the file in the repository (e.g., "src/modules/main.cpp").
|
||||
|
||||
.PARAMETER GitReference
|
||||
The git reference (branch name, tag, or commit SHA) to fetch the file from. Defaults to "main".
|
||||
|
||||
.PARAMETER RepositoryOwner
|
||||
The GitHub repository owner. Defaults to "microsoft".
|
||||
|
||||
.PARAMETER RepositoryName
|
||||
The GitHub repository name. Defaults to "PowerToys".
|
||||
|
||||
.PARAMETER ShowLineNumbers
|
||||
When specified, displays line numbers before each line of content.
|
||||
|
||||
.PARAMETER StartLineNumber
|
||||
The starting line number to use when ShowLineNumbers is enabled. Defaults to 1.
|
||||
|
||||
.EXAMPLE
|
||||
.\Get-GitHubRawFile.ps1 -FilePath "README.md" -GitReference "main"
|
||||
Downloads and displays the README.md file from the main branch.
|
||||
|
||||
.EXAMPLE
|
||||
.\Get-GitHubRawFile.ps1 -FilePath "src/runner/main.cpp" -GitReference "dev/feature-branch" -ShowLineNumbers
|
||||
Downloads main.cpp from a feature branch and displays it with line numbers.
|
||||
|
||||
.EXAMPLE
|
||||
.\Get-GitHubRawFile.ps1 -FilePath "LICENSE" -GitReference "abc123def" -ShowLineNumbers -StartLineNumber 10
|
||||
Downloads the LICENSE file from a specific commit and displays it with line numbers starting at 10.
|
||||
|
||||
.NOTES
|
||||
Requires internet connectivity to access GitHub's raw content API.
|
||||
Does not require GitHub CLI authentication for public repositories.
|
||||
|
||||
.LINK
|
||||
https://docs.github.com/en/rest/repos/contents
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[Parameter(Mandatory = $true, HelpMessage = "Relative path to the file in the repository")]
|
||||
[string]$FilePath,
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Git reference (branch, tag, or commit SHA)")]
|
||||
[string]$GitReference = "main",
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Repository owner")]
|
||||
[string]$RepositoryOwner = "microsoft",
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Repository name")]
|
||||
[string]$RepositoryName = "PowerToys",
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Display line numbers before each line")]
|
||||
[switch]$ShowLineNumbers,
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Starting line number for display")]
|
||||
[int]$StartLineNumber = 1
|
||||
)
|
||||
|
||||
# Construct the raw content URL
|
||||
$rawContentUrl = "https://raw.githubusercontent.com/$RepositoryOwner/$RepositoryName/$GitReference/$FilePath"
|
||||
|
||||
# Fetch the file content from GitHub
|
||||
try {
|
||||
$response = Invoke-WebRequest -UseBasicParsing -Uri $rawContentUrl
|
||||
} catch {
|
||||
Write-Error "Failed to fetch file from $rawContentUrl. Details: $_"
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Split content into individual lines
|
||||
$contentLines = $response.Content -split "`n"
|
||||
|
||||
# Display the content with or without line numbers
|
||||
if ($ShowLineNumbers) {
|
||||
$currentLineNumber = $StartLineNumber
|
||||
foreach ($line in $contentLines) {
|
||||
Write-Output ("{0:d4}: {1}" -f $currentLineNumber, $line)
|
||||
$currentLineNumber++
|
||||
}
|
||||
} else {
|
||||
$contentLines | ForEach-Object { Write-Output $_ }
|
||||
}
|
||||
@@ -1,173 +0,0 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Detects changes between the last reviewed commit and current head of a pull request.
|
||||
|
||||
.DESCRIPTION
|
||||
This script compares a previously reviewed commit SHA with the current head of a pull request
|
||||
to determine what has changed. It helps enable incremental reviews by identifying new commits
|
||||
and modified files since the last review iteration.
|
||||
|
||||
The script handles several scenarios:
|
||||
- First review (no previous SHA provided)
|
||||
- No changes (current SHA matches last reviewed SHA)
|
||||
- Force-push detected (last reviewed SHA no longer in history)
|
||||
- Incremental changes (new commits added since last review)
|
||||
|
||||
.PARAMETER PullRequestNumber
|
||||
The pull request number to analyze.
|
||||
|
||||
.PARAMETER LastReviewedCommitSha
|
||||
The commit SHA that was last reviewed. If omitted, this is treated as a first review.
|
||||
|
||||
.PARAMETER RepositoryOwner
|
||||
The GitHub repository owner. Defaults to "microsoft".
|
||||
|
||||
.PARAMETER RepositoryName
|
||||
The GitHub repository name. Defaults to "PowerToys".
|
||||
|
||||
.OUTPUTS
|
||||
JSON object containing:
|
||||
- PullRequestNumber: The PR number being analyzed
|
||||
- CurrentHeadSha: The current head commit SHA
|
||||
- LastReviewedSha: The last reviewed commit SHA (if provided)
|
||||
- BaseRefName: Base branch name
|
||||
- HeadRefName: Head branch name
|
||||
- IsIncremental: Boolean indicating if incremental review is possible
|
||||
- NeedFullReview: Boolean indicating if a full review is required
|
||||
- ChangedFiles: Array of files that changed (filename, status, additions, deletions)
|
||||
- NewCommits: Array of commits added since last review (sha, message, author, date)
|
||||
- Summary: Human-readable description of changes
|
||||
|
||||
.EXAMPLE
|
||||
.\Get-PrIncrementalChanges.ps1 -PullRequestNumber 42374
|
||||
Analyzes PR #42374 with no previous review (first review scenario).
|
||||
|
||||
.EXAMPLE
|
||||
.\Get-PrIncrementalChanges.ps1 -PullRequestNumber 42374 -LastReviewedCommitSha "abc123def456"
|
||||
Compares current PR state against the last reviewed commit to identify incremental changes.
|
||||
|
||||
.EXAMPLE
|
||||
$changes = .\Get-PrIncrementalChanges.ps1 -PullRequestNumber 42374 -LastReviewedCommitSha "abc123" | ConvertFrom-Json
|
||||
if ($changes.IsIncremental) { Write-Host "Can perform incremental review" }
|
||||
Captures the output as a PowerShell object for further processing.
|
||||
|
||||
.NOTES
|
||||
Requires GitHub CLI (gh) to be installed and authenticated.
|
||||
Run 'gh auth login' if not already authenticated.
|
||||
|
||||
.LINK
|
||||
https://cli.github.com/
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[Parameter(Mandatory = $true, HelpMessage = "Pull request number")]
|
||||
[int]$PullRequestNumber,
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Commit SHA that was last reviewed")]
|
||||
[string]$LastReviewedCommitSha,
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Repository owner")]
|
||||
[string]$RepositoryOwner = "microsoft",
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Repository name")]
|
||||
[string]$RepositoryName = "PowerToys"
|
||||
)
|
||||
|
||||
# Fetch current pull request state from GitHub
|
||||
try {
|
||||
$pullRequestData = gh pr view $PullRequestNumber --json headRefOid,headRefName,baseRefName,baseRefOid | ConvertFrom-Json
|
||||
} catch {
|
||||
Write-Error "Failed to fetch PR #$PullRequestNumber details. Details: $_"
|
||||
exit 1
|
||||
}
|
||||
|
||||
$currentHeadSha = $pullRequestData.headRefOid
|
||||
$baseRefName = $pullRequestData.baseRefName
|
||||
$headRefName = $pullRequestData.headRefName
|
||||
|
||||
# Initialize result object
|
||||
$analysisResult = @{
|
||||
PullRequestNumber = $PullRequestNumber
|
||||
CurrentHeadSha = $currentHeadSha
|
||||
BaseRefName = $baseRefName
|
||||
HeadRefName = $headRefName
|
||||
LastReviewedSha = $LastReviewedCommitSha
|
||||
IsIncremental = $false
|
||||
NeedFullReview = $true
|
||||
ChangedFiles = @()
|
||||
NewCommits = @()
|
||||
Summary = ""
|
||||
}
|
||||
|
||||
# Scenario 1: First review (no previous SHA provided)
|
||||
if ([string]::IsNullOrWhiteSpace($LastReviewedCommitSha)) {
|
||||
$analysisResult.Summary = "Initial review - no previous iteration found"
|
||||
$analysisResult.NeedFullReview = $true
|
||||
return $analysisResult | ConvertTo-Json -Depth 10
|
||||
}
|
||||
|
||||
# Scenario 2: No changes since last review
|
||||
if ($currentHeadSha -eq $LastReviewedCommitSha) {
|
||||
$analysisResult.Summary = "No changes since last review (SHA: $currentHeadSha)"
|
||||
$analysisResult.NeedFullReview = $false
|
||||
$analysisResult.IsIncremental = $true
|
||||
return $analysisResult | ConvertTo-Json -Depth 10
|
||||
}
|
||||
|
||||
# Scenario 3: Check for force-push (last reviewed SHA no longer exists in history)
|
||||
try {
|
||||
$null = gh api "repos/$RepositoryOwner/$RepositoryName/commits/$LastReviewedCommitSha" 2>&1
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
# SHA not found - likely force-push or branch rewrite
|
||||
$analysisResult.Summary = "Force-push detected - last reviewed SHA $LastReviewedCommitSha no longer exists. Full review required."
|
||||
$analysisResult.NeedFullReview = $true
|
||||
return $analysisResult | ConvertTo-Json -Depth 10
|
||||
}
|
||||
} catch {
|
||||
$analysisResult.Summary = "Cannot verify last reviewed SHA $LastReviewedCommitSha - assuming force-push. Full review required."
|
||||
$analysisResult.NeedFullReview = $true
|
||||
return $analysisResult | ConvertTo-Json -Depth 10
|
||||
}
|
||||
|
||||
# Scenario 4: Get incremental changes between last reviewed SHA and current head
|
||||
try {
|
||||
$compareApiPath = "repos/$RepositoryOwner/$RepositoryName/compare/$LastReviewedCommitSha...$currentHeadSha"
|
||||
$comparisonData = gh api $compareApiPath | ConvertFrom-Json
|
||||
|
||||
# Extract new commits information
|
||||
$analysisResult.NewCommits = $comparisonData.commits | ForEach-Object {
|
||||
@{
|
||||
Sha = $_.sha.Substring(0, 7)
|
||||
Message = $_.commit.message.Split("`n")[0] # First line only
|
||||
Author = $_.commit.author.name
|
||||
Date = $_.commit.author.date
|
||||
}
|
||||
}
|
||||
|
||||
# Extract changed files information
|
||||
$analysisResult.ChangedFiles = $comparisonData.files | ForEach-Object {
|
||||
@{
|
||||
Filename = $_.filename
|
||||
Status = $_.status # added, modified, removed, renamed
|
||||
Additions = $_.additions
|
||||
Deletions = $_.deletions
|
||||
Changes = $_.changes
|
||||
}
|
||||
}
|
||||
|
||||
$fileCount = $analysisResult.ChangedFiles.Count
|
||||
$commitCount = $analysisResult.NewCommits.Count
|
||||
|
||||
$analysisResult.IsIncremental = $true
|
||||
$analysisResult.NeedFullReview = $false
|
||||
$analysisResult.Summary = "Incremental review: $commitCount new commit(s), $fileCount file(s) changed since SHA $($LastReviewedCommitSha.Substring(0, 7))"
|
||||
|
||||
} catch {
|
||||
Write-Error "Failed to compare commits. Details: $_"
|
||||
$analysisResult.Summary = "Error comparing commits - defaulting to full review"
|
||||
$analysisResult.NeedFullReview = $true
|
||||
}
|
||||
|
||||
# Return the analysis result as JSON
|
||||
return $analysisResult | ConvertTo-Json -Depth 10
|
||||
@@ -1,18 +0,0 @@
|
||||
# IssueReviewLib.ps1 - Minimal helpers for PR review workflow
|
||||
# Part of the PowerToys GitHub Copilot/Claude Code issue review system
|
||||
# This is a trimmed version - pr-review only needs console helpers and repo root
|
||||
|
||||
#region Console Output Helpers
|
||||
function Info { param([string]$Message) Write-Host $Message -ForegroundColor Cyan }
|
||||
function Warn { param([string]$Message) Write-Host $Message -ForegroundColor Yellow }
|
||||
function Err { param([string]$Message) Write-Host $Message -ForegroundColor Red }
|
||||
function Success { param([string]$Message) Write-Host $Message -ForegroundColor Green }
|
||||
#endregion
|
||||
|
||||
#region Repository Helpers
|
||||
function Get-RepoRoot {
|
||||
$root = git rev-parse --show-toplevel 2>$null
|
||||
if (-not $root) { throw 'Not inside a git repository.' }
|
||||
return (Resolve-Path $root).Path
|
||||
}
|
||||
#endregion
|
||||
@@ -1,541 +0,0 @@
|
||||
<#!
|
||||
.SYNOPSIS
|
||||
Review and fix PRs in parallel using GitHub Copilot and MCP.
|
||||
|
||||
.DESCRIPTION
|
||||
For each PR (from worktrees or specified), runs in parallel:
|
||||
1. Assigns GitHub Copilot as reviewer via GitHub MCP
|
||||
2. Runs review-pr.prompt.md to generate review and post comments
|
||||
3. Runs fix-pr-active-comments.prompt.md to fix issues
|
||||
|
||||
.PARAMETER PRNumbers
|
||||
Array of PR numbers to process. If not specified, finds PRs from issue worktrees.
|
||||
|
||||
.PARAMETER SkipAssign
|
||||
Skip assigning Copilot as reviewer.
|
||||
|
||||
.PARAMETER SkipReview
|
||||
Skip the review step.
|
||||
|
||||
.PARAMETER SkipFix
|
||||
Skip the fix step.
|
||||
|
||||
.PARAMETER MinSeverity
|
||||
Minimum severity to post as PR comments: high, medium, low, info. Default: medium.
|
||||
|
||||
.PARAMETER MaxParallel
|
||||
Maximum parallel jobs. Default: 3.
|
||||
|
||||
.PARAMETER DryRun
|
||||
Show what would be done without executing.
|
||||
|
||||
.PARAMETER CLIType
|
||||
AI CLI to use: copilot or claude. Default: copilot.
|
||||
|
||||
.EXAMPLE
|
||||
# Process all PRs from issue worktrees
|
||||
./Start-PRReviewWorkflow.ps1
|
||||
|
||||
.EXAMPLE
|
||||
# Process specific PRs
|
||||
./Start-PRReviewWorkflow.ps1 -PRNumbers 45234, 45235
|
||||
|
||||
.EXAMPLE
|
||||
# Only review, don't fix
|
||||
./Start-PRReviewWorkflow.ps1 -SkipFix
|
||||
|
||||
.EXAMPLE
|
||||
# Dry run
|
||||
./Start-PRReviewWorkflow.ps1 -DryRun
|
||||
|
||||
.NOTES
|
||||
Prerequisites:
|
||||
- GitHub CLI (gh) authenticated
|
||||
- Copilot CLI installed
|
||||
- GitHub MCP configured for posting comments
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[int[]]$PRNumbers,
|
||||
|
||||
[switch]$SkipAssign,
|
||||
|
||||
[switch]$SkipReview,
|
||||
|
||||
[switch]$SkipFix,
|
||||
|
||||
[ValidateSet('high', 'medium', 'low', 'info')]
|
||||
[string]$MinSeverity = 'medium',
|
||||
|
||||
[int]$MaxParallel = 3,
|
||||
|
||||
[switch]$DryRun,
|
||||
|
||||
[ValidateSet('copilot', 'claude')]
|
||||
[string]$CLIType = 'copilot',
|
||||
|
||||
[switch]$Force,
|
||||
|
||||
[switch]$Help
|
||||
)
|
||||
|
||||
# Load libraries
|
||||
$scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
|
||||
. "$scriptDir/IssueReviewLib.ps1"
|
||||
|
||||
# Load worktree library
|
||||
$repoRoot = Get-RepoRoot
|
||||
$worktreeLib = Join-Path $repoRoot 'tools/build/WorktreeLib.ps1'
|
||||
if (Test-Path $worktreeLib) {
|
||||
. $worktreeLib
|
||||
}
|
||||
|
||||
if ($Help) {
|
||||
Get-Help $MyInvocation.MyCommand.Path -Full
|
||||
return
|
||||
}
|
||||
|
||||
function Get-PRsFromWorktrees {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Get PR numbers from issue worktrees by checking for open PRs on each branch.
|
||||
#>
|
||||
$worktrees = Get-WorktreeEntries | Where-Object { $_.Branch -like 'issue/*' }
|
||||
$prs = @()
|
||||
|
||||
foreach ($wt in $worktrees) {
|
||||
$prInfo = gh pr list --head $wt.Branch --json number,url --state open 2>$null | ConvertFrom-Json
|
||||
if ($prInfo -and $prInfo.Count -gt 0) {
|
||||
$prs += @{
|
||||
PRNumber = $prInfo[0].number
|
||||
PRUrl = $prInfo[0].url
|
||||
Branch = $wt.Branch
|
||||
WorktreePath = $wt.Path
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $prs
|
||||
}
|
||||
|
||||
function Invoke-AssignCopilotReviewer {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Assign GitHub Copilot as a reviewer to the PR using GitHub MCP.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$PRNumber,
|
||||
[string]$CLIType = 'copilot',
|
||||
[switch]$DryRun
|
||||
)
|
||||
|
||||
if ($DryRun) {
|
||||
Info " [DRY RUN] Would request Copilot review for PR #$PRNumber"
|
||||
return $true
|
||||
}
|
||||
|
||||
# Use a prompt that instructs Copilot to use GitHub MCP to assign Copilot as reviewer
|
||||
$prompt = @"
|
||||
Use the GitHub MCP to request a review from GitHub Copilot for PR #$PRNumber.
|
||||
|
||||
Steps:
|
||||
1. Use the GitHub MCP tool to add "Copilot" as a reviewer to pull request #$PRNumber in the microsoft/PowerToys repository
|
||||
2. This should add Copilot to the "Reviewers" section of the PR
|
||||
|
||||
If GitHub MCP is not available, report that and skip this step.
|
||||
"@
|
||||
|
||||
# MCP config for github-artifacts tools (relative to repo root)
|
||||
$mcpConfig = '@.github/skills/pr-review/references/mcp-config.json'
|
||||
|
||||
try {
|
||||
Info " Requesting Copilot review via GitHub MCP..."
|
||||
|
||||
switch ($CLIType) {
|
||||
'copilot' {
|
||||
& copilot --additional-mcp-config $mcpConfig -p $prompt --yolo -s 2>&1 | Out-Null
|
||||
}
|
||||
'claude' {
|
||||
& claude --print --dangerously-skip-permissions --prompt $prompt 2>&1 | Out-Null
|
||||
}
|
||||
}
|
||||
|
||||
return $true
|
||||
}
|
||||
catch {
|
||||
Warn " Could not assign Copilot reviewer: $($_.Exception.Message)"
|
||||
return $false
|
||||
}
|
||||
}
|
||||
|
||||
function Invoke-PRReview {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Run review-pr.prompt.md using Copilot CLI.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$PRNumber,
|
||||
[string]$CLIType = 'copilot',
|
||||
[string]$MinSeverity = 'medium',
|
||||
[switch]$DryRun
|
||||
)
|
||||
|
||||
# Simple prompt - let the prompt file define all the details
|
||||
$prompt = @"
|
||||
Follow exactly what at .github/prompts/review-pr.prompt.md to do with PR #$PRNumber.
|
||||
Post findings with severity >= $MinSeverity as PR review comments via GitHub MCP.
|
||||
"@
|
||||
|
||||
if ($DryRun) {
|
||||
Info " [DRY RUN] Would run PR review for #$PRNumber"
|
||||
return @{ Success = $true; ReviewPath = "Generated Files/prReview/$PRNumber" }
|
||||
}
|
||||
|
||||
$reviewPath = Join-Path $repoRoot "Generated Files/prReview/$PRNumber"
|
||||
|
||||
# Ensure the review directory exists
|
||||
if (-not (Test-Path $reviewPath)) {
|
||||
New-Item -ItemType Directory -Path $reviewPath -Force | Out-Null
|
||||
}
|
||||
|
||||
# MCP config for github-artifacts tools (relative to repo root)
|
||||
$mcpConfig = '@.github/skills/pr-review/references/mcp-config.json'
|
||||
|
||||
Push-Location $repoRoot
|
||||
try {
|
||||
switch ($CLIType) {
|
||||
'copilot' {
|
||||
Info " Running Copilot review (this may take several minutes)..."
|
||||
$output = & copilot --additional-mcp-config $mcpConfig -p $prompt --yolo 2>&1
|
||||
# Log output for debugging
|
||||
$logFile = Join-Path $reviewPath "_copilot-review.log"
|
||||
$output | Out-File -FilePath $logFile -Force
|
||||
}
|
||||
'claude' {
|
||||
Info " Running Claude review (this may take several minutes)..."
|
||||
$output = & claude --print --dangerously-skip-permissions --prompt $prompt 2>&1
|
||||
$logFile = Join-Path $reviewPath "_claude-review.log"
|
||||
$output | Out-File -FilePath $logFile -Force
|
||||
}
|
||||
}
|
||||
|
||||
# Check if review files were created (at minimum, check for multiple step files)
|
||||
$overviewPath = Join-Path $reviewPath '00-OVERVIEW.md'
|
||||
$stepFiles = Get-ChildItem -Path $reviewPath -Filter "*.md" -ErrorAction SilentlyContinue
|
||||
$stepCount = ($stepFiles | Where-Object { $_.Name -match '^\d{2}-' }).Count
|
||||
|
||||
if ($stepCount -ge 5) {
|
||||
return @{ Success = $true; ReviewPath = $reviewPath; StepFilesCreated = $stepCount }
|
||||
} elseif (Test-Path $overviewPath) {
|
||||
Warn " Only overview created, step files may be incomplete ($stepCount step files)"
|
||||
return @{ Success = $true; ReviewPath = $reviewPath; StepFilesCreated = $stepCount; Partial = $true }
|
||||
} else {
|
||||
return @{ Success = $false; Error = "Review files not created (found $stepCount step files)" }
|
||||
}
|
||||
}
|
||||
catch {
|
||||
return @{ Success = $false; Error = $_.Exception.Message }
|
||||
}
|
||||
finally {
|
||||
Pop-Location
|
||||
}
|
||||
}
|
||||
|
||||
function Invoke-FixPRComments {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Run fix-pr-active-comments.prompt.md to fix issues.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$PRNumber,
|
||||
[string]$WorktreePath,
|
||||
[string]$CLIType = 'copilot',
|
||||
[switch]$DryRun
|
||||
)
|
||||
|
||||
# Simple prompt - let the prompt file define all the details
|
||||
$prompt = "Follow .github/prompts/fix-pr-active-comments.prompt.md for PR #$PRNumber."
|
||||
|
||||
if ($DryRun) {
|
||||
Info " [DRY RUN] Would fix PR comments for #$PRNumber"
|
||||
return @{ Success = $true }
|
||||
}
|
||||
|
||||
$workDir = if ($WorktreePath -and (Test-Path $WorktreePath)) { $WorktreePath } else { $repoRoot }
|
||||
|
||||
# MCP config for github-artifacts tools (relative to repo root)
|
||||
$mcpConfig = '@.github/skills/pr-review/references/mcp-config.json'
|
||||
|
||||
Push-Location $workDir
|
||||
try {
|
||||
switch ($CLIType) {
|
||||
'copilot' {
|
||||
Info " Running Copilot to fix comments..."
|
||||
$output = & copilot --additional-mcp-config $mcpConfig -p $prompt --yolo 2>&1
|
||||
# Log output for debugging
|
||||
$logPath = Join-Path $repoRoot "Generated Files/prReview/$PRNumber"
|
||||
if (-not (Test-Path $logPath)) {
|
||||
New-Item -ItemType Directory -Path $logPath -Force | Out-Null
|
||||
}
|
||||
$logFile = Join-Path $logPath "_copilot-fix.log"
|
||||
$output | Out-File -FilePath $logFile -Force
|
||||
}
|
||||
'claude' {
|
||||
Info " Running Claude to fix comments..."
|
||||
$output = & claude --print --dangerously-skip-permissions --prompt $prompt 2>&1
|
||||
$logPath = Join-Path $repoRoot "Generated Files/prReview/$PRNumber"
|
||||
if (-not (Test-Path $logPath)) {
|
||||
New-Item -ItemType Directory -Path $logPath -Force | Out-Null
|
||||
}
|
||||
$logFile = Join-Path $logPath "_claude-fix.log"
|
||||
$output | Out-File -FilePath $logFile -Force
|
||||
}
|
||||
}
|
||||
|
||||
return @{ Success = $true }
|
||||
}
|
||||
catch {
|
||||
return @{ Success = $false; Error = $_.Exception.Message }
|
||||
}
|
||||
finally {
|
||||
Pop-Location
|
||||
}
|
||||
}
|
||||
|
||||
function Start-PRWorkflowJob {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Process a single PR through the workflow.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$PRNumber,
|
||||
[string]$WorktreePath,
|
||||
[string]$CLIType = 'copilot',
|
||||
[string]$MinSeverity = 'medium',
|
||||
[switch]$SkipAssign,
|
||||
[switch]$SkipReview,
|
||||
[switch]$SkipFix,
|
||||
[switch]$DryRun
|
||||
)
|
||||
|
||||
$result = @{
|
||||
PRNumber = $PRNumber
|
||||
AssignResult = $null
|
||||
ReviewResult = $null
|
||||
FixResult = $null
|
||||
Success = $true
|
||||
}
|
||||
|
||||
# Step 1: Assign Copilot as reviewer
|
||||
if (-not $SkipAssign) {
|
||||
Info " Step 1: Assigning Copilot reviewer..."
|
||||
$result.AssignResult = Invoke-AssignCopilotReviewer -PRNumber $PRNumber -CLIType $CLIType -DryRun:$DryRun
|
||||
if (-not $result.AssignResult) {
|
||||
Warn " Assignment step had issues (continuing...)"
|
||||
}
|
||||
} else {
|
||||
Info " Step 1: Skipped (assign)"
|
||||
}
|
||||
|
||||
# Step 2: Run PR review
|
||||
if (-not $SkipReview) {
|
||||
Info " Step 2: Running PR review..."
|
||||
$result.ReviewResult = Invoke-PRReview -PRNumber $PRNumber -CLIType $CLIType -MinSeverity $MinSeverity -DryRun:$DryRun
|
||||
if (-not $result.ReviewResult.Success) {
|
||||
Warn " Review step failed: $($result.ReviewResult.Error)"
|
||||
$result.Success = $false
|
||||
} else {
|
||||
$stepInfo = if ($result.ReviewResult.StepFilesCreated) { " ($($result.ReviewResult.StepFilesCreated) step files)" } else { "" }
|
||||
$partialInfo = if ($result.ReviewResult.Partial) { " [PARTIAL]" } else { "" }
|
||||
Success " Review completed: $($result.ReviewResult.ReviewPath)$stepInfo$partialInfo"
|
||||
}
|
||||
} else {
|
||||
Info " Step 2: Skipped (review)"
|
||||
}
|
||||
|
||||
# Step 3: Fix PR comments
|
||||
if (-not $SkipFix) {
|
||||
Info " Step 3: Fixing PR comments..."
|
||||
$result.FixResult = Invoke-FixPRComments -PRNumber $PRNumber -WorktreePath $WorktreePath -CLIType $CLIType -DryRun:$DryRun
|
||||
if (-not $result.FixResult.Success) {
|
||||
Warn " Fix step failed: $($result.FixResult.Error)"
|
||||
$result.Success = $false
|
||||
} else {
|
||||
Success " Fix step completed"
|
||||
}
|
||||
} else {
|
||||
Info " Step 3: Skipped (fix)"
|
||||
}
|
||||
|
||||
return $result
|
||||
}
|
||||
|
||||
#region Main Script
|
||||
try {
|
||||
Info "Repository root: $repoRoot"
|
||||
Info "CLI type: $CLIType"
|
||||
Info "Min severity for comments: $MinSeverity"
|
||||
Info "Max parallel: $MaxParallel"
|
||||
|
||||
# Determine PRs to process
|
||||
$prsToProcess = @()
|
||||
|
||||
if ($PRNumbers -and $PRNumbers.Count -gt 0) {
|
||||
# Use specified PR numbers
|
||||
foreach ($prNum in $PRNumbers) {
|
||||
$prInfo = gh pr view $prNum --json number,url,headRefName 2>$null | ConvertFrom-Json
|
||||
if ($prInfo) {
|
||||
# Try to find matching worktree
|
||||
$wt = Get-WorktreeEntries | Where-Object { $_.Branch -eq $prInfo.headRefName } | Select-Object -First 1
|
||||
$prsToProcess += @{
|
||||
PRNumber = $prInfo.number
|
||||
PRUrl = $prInfo.url
|
||||
Branch = $prInfo.headRefName
|
||||
WorktreePath = if ($wt) { $wt.Path } else { $repoRoot }
|
||||
}
|
||||
} else {
|
||||
Warn "PR #$prNum not found"
|
||||
}
|
||||
}
|
||||
} else {
|
||||
# Get PRs from worktrees
|
||||
Info "`nFinding PRs from issue worktrees..."
|
||||
$prsToProcess = Get-PRsFromWorktrees
|
||||
}
|
||||
|
||||
if ($prsToProcess.Count -eq 0) {
|
||||
Warn "No PRs found to process."
|
||||
return
|
||||
}
|
||||
|
||||
# Display PRs
|
||||
Info "`nPRs to process:"
|
||||
Info ("-" * 80)
|
||||
foreach ($pr in $prsToProcess) {
|
||||
Info (" #{0,-6} {1}" -f $pr.PRNumber, $pr.PRUrl)
|
||||
}
|
||||
Info ("-" * 80)
|
||||
|
||||
if ($DryRun) {
|
||||
Warn "`nDry run mode - no changes will be made."
|
||||
}
|
||||
|
||||
# Confirm
|
||||
if (-not $Force -and -not $DryRun) {
|
||||
$stepsDesc = @()
|
||||
if (-not $SkipAssign) { $stepsDesc += "assign Copilot" }
|
||||
if (-not $SkipReview) { $stepsDesc += "review" }
|
||||
if (-not $SkipFix) { $stepsDesc += "fix comments" }
|
||||
|
||||
$confirm = Read-Host "`nProceed with $($prsToProcess.Count) PRs ($($stepsDesc -join ', '))? (y/N)"
|
||||
if ($confirm -notmatch '^[yY]') {
|
||||
Info "Cancelled."
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
# Process PRs (using jobs for parallelization)
|
||||
$results = @{
|
||||
Success = @()
|
||||
Failed = @()
|
||||
}
|
||||
|
||||
if ($MaxParallel -gt 1 -and $prsToProcess.Count -gt 1) {
|
||||
# Parallel processing using PowerShell jobs
|
||||
Info "`nStarting parallel processing (max $MaxParallel concurrent)..."
|
||||
|
||||
$jobs = @()
|
||||
$prQueue = [System.Collections.Queue]::new($prsToProcess)
|
||||
|
||||
while ($prQueue.Count -gt 0 -or $jobs.Count -gt 0) {
|
||||
# Start new jobs up to MaxParallel
|
||||
while ($jobs.Count -lt $MaxParallel -and $prQueue.Count -gt 0) {
|
||||
$pr = $prQueue.Dequeue()
|
||||
|
||||
Info "`n" + ("=" * 60)
|
||||
Info "PROCESSING PR #$($pr.PRNumber)"
|
||||
Info ("=" * 60)
|
||||
|
||||
# For simplicity, process sequentially within each PR but PRs in parallel
|
||||
# Since copilot CLI might have issues with true parallel execution
|
||||
$jobResult = Start-PRWorkflowJob `
|
||||
-PRNumber $pr.PRNumber `
|
||||
-WorktreePath $pr.WorktreePath `
|
||||
-CLIType $CLIType `
|
||||
-MinSeverity $MinSeverity `
|
||||
-SkipAssign:$SkipAssign `
|
||||
-SkipReview:$SkipReview `
|
||||
-SkipFix:$SkipFix `
|
||||
-DryRun:$DryRun
|
||||
|
||||
if ($jobResult.Success) {
|
||||
$results.Success += $jobResult
|
||||
Success "✓ PR #$($pr.PRNumber) workflow completed"
|
||||
} else {
|
||||
$results.Failed += $jobResult
|
||||
Err "✗ PR #$($pr.PRNumber) workflow had failures"
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
# Sequential processing
|
||||
foreach ($pr in $prsToProcess) {
|
||||
Info "`n" + ("=" * 60)
|
||||
Info "PROCESSING PR #$($pr.PRNumber)"
|
||||
Info ("=" * 60)
|
||||
|
||||
$jobResult = Start-PRWorkflowJob `
|
||||
-PRNumber $pr.PRNumber `
|
||||
-WorktreePath $pr.WorktreePath `
|
||||
-CLIType $CLIType `
|
||||
-MinSeverity $MinSeverity `
|
||||
-SkipAssign:$SkipAssign `
|
||||
-SkipReview:$SkipReview `
|
||||
-SkipFix:$SkipFix `
|
||||
-DryRun:$DryRun
|
||||
|
||||
if ($jobResult.Success) {
|
||||
$results.Success += $jobResult
|
||||
Success "✓ PR #$($pr.PRNumber) workflow completed"
|
||||
} else {
|
||||
$results.Failed += $jobResult
|
||||
Err "✗ PR #$($pr.PRNumber) workflow had failures"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Summary
|
||||
Info "`n" + ("=" * 80)
|
||||
Info "PR REVIEW WORKFLOW COMPLETE"
|
||||
Info ("=" * 80)
|
||||
Info "Total PRs: $($prsToProcess.Count)"
|
||||
|
||||
if ($results.Success.Count -gt 0) {
|
||||
Success "Succeeded: $($results.Success.Count)"
|
||||
foreach ($r in $results.Success) {
|
||||
Success " PR #$($r.PRNumber)"
|
||||
}
|
||||
}
|
||||
|
||||
if ($results.Failed.Count -gt 0) {
|
||||
Err "Had issues: $($results.Failed.Count)"
|
||||
foreach ($r in $results.Failed) {
|
||||
Err " PR #$($r.PRNumber)"
|
||||
}
|
||||
}
|
||||
|
||||
Info "`nReview files location: Generated Files/prReview/<PR_NUMBER>/"
|
||||
Info ("=" * 80)
|
||||
|
||||
return $results
|
||||
}
|
||||
catch {
|
||||
Err "Error: $($_.Exception.Message)"
|
||||
exit 1
|
||||
}
|
||||
#endregion
|
||||
@@ -1,170 +0,0 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Tests and previews incremental review detection for a pull request.
|
||||
|
||||
.DESCRIPTION
|
||||
This helper script validates the incremental review detection logic by analyzing an existing
|
||||
PR review folder. It reads the last reviewed SHA from the overview file, compares it with
|
||||
the current PR state, and displays detailed information about what has changed.
|
||||
|
||||
This is useful for:
|
||||
- Testing the incremental review system before running a full review
|
||||
- Understanding what changed since the last review iteration
|
||||
- Verifying that review metadata was properly recorded
|
||||
|
||||
.PARAMETER PullRequestNumber
|
||||
The pull request number to test incremental review detection for.
|
||||
|
||||
.PARAMETER RepositoryOwner
|
||||
The GitHub repository owner. Defaults to "microsoft".
|
||||
|
||||
.PARAMETER RepositoryName
|
||||
The GitHub repository name. Defaults to "PowerToys".
|
||||
|
||||
.OUTPUTS
|
||||
Colored console output displaying:
|
||||
- Current and last reviewed commit SHAs
|
||||
- Whether incremental review is possible
|
||||
- List of new commits since last review
|
||||
- List of changed files with status indicators
|
||||
- Recommended review strategy
|
||||
|
||||
.EXAMPLE
|
||||
.\Test-IncrementalReview.ps1 -PullRequestNumber 42374
|
||||
Tests incremental review detection for PR #42374.
|
||||
|
||||
.EXAMPLE
|
||||
.\Test-IncrementalReview.ps1 -PullRequestNumber 42374 -RepositoryOwner "myorg" -RepositoryName "myrepo"
|
||||
Tests incremental review for a PR in a different repository.
|
||||
|
||||
.NOTES
|
||||
Requires GitHub CLI (gh) to be installed and authenticated.
|
||||
Run 'gh auth login' if not already authenticated.
|
||||
|
||||
Prerequisites:
|
||||
- PR review folder must exist at "Generated Files\prReview\{PRNumber}"
|
||||
- 00-OVERVIEW.md must exist in the review folder
|
||||
- For incremental detection, overview must contain "Last reviewed SHA" metadata
|
||||
|
||||
.LINK
|
||||
https://cli.github.com/
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[Parameter(Mandatory = $true, HelpMessage = "Pull request number to test")]
|
||||
[int]$PullRequestNumber,
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Repository owner")]
|
||||
[string]$RepositoryOwner = "microsoft",
|
||||
|
||||
[Parameter(Mandatory = $false, HelpMessage = "Repository name")]
|
||||
[string]$RepositoryName = "PowerToys"
|
||||
)
|
||||
|
||||
# Resolve paths to review folder and overview file
|
||||
$repositoryRoot = Split-Path (Split-Path $PSScriptRoot -Parent) -Parent
|
||||
$reviewFolderPath = Join-Path $repositoryRoot "Generated Files\prReview\$PullRequestNumber"
|
||||
$overviewFilePath = Join-Path $reviewFolderPath "00-OVERVIEW.md"
|
||||
|
||||
Write-Host "=== Testing Incremental Review for PR #$PullRequestNumber ===" -ForegroundColor Cyan
|
||||
Write-Host ""
|
||||
|
||||
# Check if review folder exists
|
||||
if (-not (Test-Path $reviewFolderPath)) {
|
||||
Write-Host "❌ Review folder not found: $reviewFolderPath" -ForegroundColor Red
|
||||
Write-Host "This appears to be a new review (iteration 1)" -ForegroundColor Yellow
|
||||
exit 0
|
||||
}
|
||||
|
||||
# Check if overview file exists
|
||||
if (-not (Test-Path $overviewFilePath)) {
|
||||
Write-Host "❌ Overview file not found: $overviewFilePath" -ForegroundColor Red
|
||||
Write-Host "This appears to be an incomplete review" -ForegroundColor Yellow
|
||||
exit 0
|
||||
}
|
||||
|
||||
# Read overview file and extract last reviewed SHA
|
||||
Write-Host "📄 Reading overview file..." -ForegroundColor Green
|
||||
$overviewFileContent = Get-Content $overviewFilePath -Raw
|
||||
|
||||
if ($overviewFileContent -match '\*\*Last reviewed SHA:\*\*\s+(\w+)') {
|
||||
$lastReviewedSha = $Matches[1]
|
||||
Write-Host "✅ Found last reviewed SHA: $lastReviewedSha" -ForegroundColor Green
|
||||
} else {
|
||||
Write-Host "⚠️ No 'Last reviewed SHA' found in overview - this may be an old format" -ForegroundColor Yellow
|
||||
Write-Host "Proceeding without incremental detection (full review will be needed)" -ForegroundColor Yellow
|
||||
exit 0
|
||||
}
|
||||
|
||||
Write-Host ""
|
||||
Write-Host "🔍 Running incremental change detection..." -ForegroundColor Cyan
|
||||
|
||||
# Call the incremental changes detection script
|
||||
$incrementalChangesScriptPath = Join-Path $PSScriptRoot "Get-PrIncrementalChanges.ps1"
|
||||
if (-not (Test-Path $incrementalChangesScriptPath)) {
|
||||
Write-Host "❌ Script not found: $incrementalChangesScriptPath" -ForegroundColor Red
|
||||
exit 1
|
||||
}
|
||||
|
||||
try {
|
||||
$analysisResult = & $incrementalChangesScriptPath `
|
||||
-PullRequestNumber $PullRequestNumber `
|
||||
-LastReviewedCommitSha $lastReviewedSha `
|
||||
-RepositoryOwner $RepositoryOwner `
|
||||
-RepositoryName $RepositoryName | ConvertFrom-Json
|
||||
|
||||
# Display analysis results
|
||||
Write-Host ""
|
||||
Write-Host "=== Incremental Review Analysis ===" -ForegroundColor Cyan
|
||||
Write-Host "Current HEAD SHA: $($analysisResult.CurrentHeadSha)" -ForegroundColor White
|
||||
Write-Host "Last reviewed SHA: $($analysisResult.LastReviewedSha)" -ForegroundColor White
|
||||
Write-Host "Base branch: $($analysisResult.BaseRefName)" -ForegroundColor White
|
||||
Write-Host "Head branch: $($analysisResult.HeadRefName)" -ForegroundColor White
|
||||
Write-Host ""
|
||||
Write-Host "Is incremental? $($analysisResult.IsIncremental)" -ForegroundColor $(if ($analysisResult.IsIncremental) { "Green" } else { "Yellow" })
|
||||
Write-Host "Need full review? $($analysisResult.NeedFullReview)" -ForegroundColor $(if ($analysisResult.NeedFullReview) { "Yellow" } else { "Green" })
|
||||
Write-Host ""
|
||||
Write-Host "Summary: $($analysisResult.Summary)" -ForegroundColor Cyan
|
||||
Write-Host ""
|
||||
|
||||
# Display new commits if any
|
||||
if ($analysisResult.NewCommits -and $analysisResult.NewCommits.Count -gt 0) {
|
||||
Write-Host "📝 New commits ($($analysisResult.NewCommits.Count)):" -ForegroundColor Green
|
||||
foreach ($commit in $analysisResult.NewCommits) {
|
||||
Write-Host " - $($commit.Sha): $($commit.Message)" -ForegroundColor Gray
|
||||
}
|
||||
Write-Host ""
|
||||
}
|
||||
|
||||
# Display changed files if any
|
||||
if ($analysisResult.ChangedFiles -and $analysisResult.ChangedFiles.Count -gt 0) {
|
||||
Write-Host "📁 Changed files ($($analysisResult.ChangedFiles.Count)):" -ForegroundColor Green
|
||||
foreach ($file in $analysisResult.ChangedFiles) {
|
||||
$statusDisplayColor = switch ($file.Status) {
|
||||
"added" { "Green" }
|
||||
"removed" { "Red" }
|
||||
"modified" { "Yellow" }
|
||||
"renamed" { "Cyan" }
|
||||
default { "White" }
|
||||
}
|
||||
Write-Host " - [$($file.Status)] $($file.Filename) (+$($file.Additions)/-$($file.Deletions))" -ForegroundColor $statusDisplayColor
|
||||
}
|
||||
Write-Host ""
|
||||
}
|
||||
|
||||
# Suggest review strategy based on analysis
|
||||
Write-Host "=== Recommended Review Strategy ===" -ForegroundColor Cyan
|
||||
if ($analysisResult.NeedFullReview) {
|
||||
Write-Host "🔄 Full review recommended" -ForegroundColor Yellow
|
||||
} elseif ($analysisResult.IsIncremental -and ($analysisResult.ChangedFiles.Count -eq 0)) {
|
||||
Write-Host "✅ No changes detected - no review needed" -ForegroundColor Green
|
||||
} elseif ($analysisResult.IsIncremental) {
|
||||
Write-Host "⚡ Incremental review possible - review only changed files" -ForegroundColor Green
|
||||
Write-Host "💡 Consider applying smart step filtering based on file types" -ForegroundColor Cyan
|
||||
}
|
||||
|
||||
} catch {
|
||||
Write-Host "❌ Error running incremental change detection: $_" -ForegroundColor Red
|
||||
exit 1
|
||||
}
|
||||
21
.github/skills/submit-pr/LICENSE.txt
vendored
21
.github/skills/submit-pr/LICENSE.txt
vendored
@@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) Microsoft Corporation.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
126
.github/skills/submit-pr/SKILL.md
vendored
126
.github/skills/submit-pr/SKILL.md
vendored
@@ -1,126 +0,0 @@
|
||||
---
|
||||
name: submit-pr
|
||||
description: Commit changes and create pull requests for fixed issues. Use when asked to create a PR, submit changes, commit fixes, push changes for an issue, create pull request from worktree, or finalize issue fix. Generates AI-assisted commit messages and PR descriptions following PowerToys conventions.
|
||||
license: Complete terms in LICENSE.txt
|
||||
---
|
||||
|
||||
# Submit PR Skill
|
||||
|
||||
Commit changes from issue worktrees and create pull requests with AI-generated titles and descriptions following PowerToys conventions.
|
||||
|
||||
## Skill Contents
|
||||
|
||||
This skill is **self-contained** with all required resources:
|
||||
|
||||
```
|
||||
.github/skills/submit-pr/
|
||||
├── SKILL.md # This file
|
||||
├── LICENSE.txt # MIT License
|
||||
├── scripts/
|
||||
│ └── Submit-IssueFixes.ps1 # Main submit script
|
||||
└── references/
|
||||
├── create-commit-title.prompt.md # Commit title rules
|
||||
└── create-pr-summary.prompt.md # PR description template
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
PRs are created on GitHub with:
|
||||
- Conventional commit title (e.g., `fix(fancyzones): resolve editor crash on multi-monitor`)
|
||||
- Description following `.github/pull_request_template.md`
|
||||
- Auto-linked to the original issue via `Fixes #{{IssueNumber}}`
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
- Create a PR for a fixed issue
|
||||
- Commit and push changes from a worktree
|
||||
- Submit changes after using `issue-fix` skill
|
||||
- Generate PR title and description
|
||||
- Finalize an issue fix with a pull request
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- GitHub CLI (`gh`) installed and authenticated
|
||||
- Changes made in an issue worktree (from `issue-fix` skill)
|
||||
- PowerShell 7+ for running scripts
|
||||
|
||||
## Required Variables
|
||||
|
||||
| Variable | Description | Example |
|
||||
|----------|-------------|---------|
|
||||
| `{{IssueNumber}}` | Issue number(s) to submit | `44044` or `44044, 32950` |
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1: Verify Changes Exist
|
||||
|
||||
Check that the worktree has uncommitted or unpushed changes:
|
||||
|
||||
```powershell
|
||||
# List issue worktrees
|
||||
git worktree list | Select-String "issue/"
|
||||
|
||||
# Check status in a worktree
|
||||
cd Q:/PowerToys-xxxx
|
||||
git status
|
||||
```
|
||||
|
||||
### Step 2: Submit PR
|
||||
|
||||
Execute the submit script (use paths relative to this skill folder):
|
||||
|
||||
```powershell
|
||||
# From repo root
|
||||
.github/skills/submit-pr/scripts/Submit-IssueFixes.ps1 -IssueNumbers {{IssueNumber}} -CLIType copilot
|
||||
```
|
||||
|
||||
This will:
|
||||
1. Generate a commit title using AI (following conventional commits)
|
||||
2. Stage and commit all changes
|
||||
3. Push the branch to origin
|
||||
4. Generate a PR description using AI
|
||||
5. Create the PR on GitHub
|
||||
|
||||
### Step 3: Review Created PR
|
||||
|
||||
The script outputs the PR URL. Review it on GitHub.
|
||||
|
||||
## CLI Options
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `-IssueNumbers` | Issue number(s) to submit | All worktrees |
|
||||
| `-CLIType` | AI CLI to use: `copilot`, `claude`, or `manual` | `copilot` |
|
||||
| `-TargetBranch` | Base branch for PR | `main` |
|
||||
| `-Draft` | Create as draft PR | `false` |
|
||||
| `-Force` | Skip confirmation prompts | `false` |
|
||||
| `-DryRun` | Show what would be done | `false` |
|
||||
|
||||
## PR Title Format
|
||||
|
||||
Titles follow conventional commits (see `references/create-commit-title.prompt.md`):
|
||||
|
||||
```
|
||||
<type>(<scope>): <description>
|
||||
```
|
||||
|
||||
| Type | When to use |
|
||||
|------|-------------|
|
||||
| `fix` | Bug fixes |
|
||||
| `feat` | New features |
|
||||
| `docs` | Documentation only |
|
||||
| `refactor` | Code restructuring |
|
||||
|
||||
## AI Prompt References
|
||||
|
||||
For manual AI invocation, prompts are at:
|
||||
- `references/create-commit-title.prompt.md` - Commit title generation
|
||||
- `references/create-pr-summary.prompt.md` - PR description generation
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Problem | Solution |
|
||||
|---------|----------|
|
||||
| No changes to commit | Verify fix was applied, check `git status` |
|
||||
| PR already exists | Script will skip and report existing PR URL |
|
||||
| Push rejected | Pull latest changes or force push with `--force-with-lease` |
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
agent: 'agent'
|
||||
description: 'Generate an 80-character git commit title for the local diff'
|
||||
---
|
||||
|
||||
# Generate Commit Title
|
||||
|
||||
## Purpose
|
||||
Provide a single-line, ready-to-paste git commit title (<= 80 characters) that reflects the most important local changes since `HEAD`.
|
||||
|
||||
## Input to collect
|
||||
- Run exactly one command to view the local diff:
|
||||
```@terminal
|
||||
git diff HEAD
|
||||
```
|
||||
|
||||
## How to decide the title
|
||||
1. From the diff, find the dominant area (e.g., `src/modules/*`, `doc/devdocs/**`) and the change type (bug fix, docs update, config tweak).
|
||||
2. Draft an imperative, plain-ASCII title that:
|
||||
- Mentions the primary component when obvious (e.g., `FancyZones:` or `Docs:`)
|
||||
- Stays within 80 characters and has no trailing punctuation
|
||||
|
||||
## Final output
|
||||
- Reply with only the commit title on a single line—no extra text.
|
||||
|
||||
## PR title convention (when asked)
|
||||
Use Conventional Commits style:
|
||||
|
||||
`<type>(<scope>): <summary>`
|
||||
|
||||
**Allowed types**
|
||||
- feat, fix, docs, refactor, perf, test, build, ci, chore
|
||||
|
||||
**Scope rules**
|
||||
- Use a short, PowerToys-focused scope (one word preferred). Common scopes:
|
||||
- Core: `runner`, `settings-ui`, `common`, `docs`, `build`, `ci`, `installer`, `gpo`, `dsc`
|
||||
- Modules: `fancyzones`, `powerrename`, `awake`, `colorpicker`, `imageresizer`, `keyboardmanager`, `mouseutils`, `peek`, `hosts`, `file-locksmith`, `screen-ruler`, `text-extractor`, `cropandlock`, `paste`, `powerlauncher`
|
||||
- If unclear, pick the closest module or subsystem; omit only if unavoidable
|
||||
|
||||
**Summary rules**
|
||||
- Imperative, present tense (“add”, “update”, “remove”, “fix”)
|
||||
- Keep it <= 72 characters when possible; be specific, avoid “misc changes”
|
||||
|
||||
**Examples**
|
||||
- `feat(fancyzones): add canvas template duplication`
|
||||
- `fix(mouseutils): guard crosshair toggle when dpi info missing`
|
||||
- `docs(runner): document tray icon states`
|
||||
- `build(installer): align wix v5 suffix flag`
|
||||
- `ci(ci): cache pipeline artifacts for x64`
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
agent: 'agent'
|
||||
description: 'Generate a PowerToys-ready pull request description from the local diff'
|
||||
---
|
||||
|
||||
# Generate PR Summary
|
||||
|
||||
**Goal:** Produce a ready-to-paste PR title and description that follows PowerToys conventions by comparing the current branch against a user-selected target branch.
|
||||
|
||||
**Repo guardrails:**
|
||||
- Treat `.github/pull_request_template.md` as the single source of truth; load it at runtime instead of embedding hardcoded content in this prompt.
|
||||
- Preserve section order from the template but only surface checklist lines that are relevant for the detected changes, filling them with `[x]`/`[ ]` as appropriate.
|
||||
- Cite touched paths with inline backticks, matching the guidance in `.github/copilot-instructions.md`.
|
||||
- Call out test coverage explicitly: list automated tests run (unit/UI) or state why they are not applicable.
|
||||
|
||||
**Workflow:**
|
||||
1. Determine the target branch from user context; default to `main` when no branch is supplied.
|
||||
2. Run `git status --short` once to surface uncommitted files that may influence the summary.
|
||||
3. Run `git diff <target-branch>...HEAD` a single time to review the detailed changes. Only when confidence stays low dig deeper with focused calls such as `git diff <target-branch>...HEAD -- <path>`.
|
||||
4. From the diff, capture impacted areas, key file changes, behavioral risks, migrations, and noteworthy edge cases.
|
||||
5. Confirm validation: list tests executed with results or state why tests were skipped in line with repo guidance.
|
||||
6. Load `.github/pull_request_template.md`, mirror its section order, and populate it with the gathered facts. Include only relevant checklist entries, marking them `[x]/[ ]` and noting any intentional omissions as "N/A".
|
||||
7. Present the filled template inside a fenced ```markdown code block with no extra commentary so it is ready to paste into a PR, clearly flagging any placeholders that still need user input.
|
||||
8. Prepend the PR title above the filled template, applying the Conventional Commit type/scope rules from `.github/prompts/create-commit-title.prompt.md`; pick the dominant component from the diff and keep the title concise and imperative.
|
||||
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"mcpServers": {
|
||||
"github-artifacts": {
|
||||
"command": "cmd",
|
||||
"args": ["/c", "for /f %i in ('git rev-parse --show-toplevel') do node %i/tools/mcp/github-artifacts/launch.js"],
|
||||
"tools": ["*"]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
# IssueReviewLib.ps1 - Minimal helpers for PR submission workflow
|
||||
# Part of the PowerToys GitHub Copilot/Claude Code issue review system
|
||||
# This is a trimmed version - submit-pr only needs console helpers and repo root
|
||||
|
||||
#region Console Output Helpers
|
||||
function Info { param([string]$Message) Write-Host $Message -ForegroundColor Cyan }
|
||||
function Warn { param([string]$Message) Write-Host $Message -ForegroundColor Yellow }
|
||||
function Err { param([string]$Message) Write-Host $Message -ForegroundColor Red }
|
||||
function Success { param([string]$Message) Write-Host $Message -ForegroundColor Green }
|
||||
#endregion
|
||||
|
||||
#region Repository Helpers
|
||||
function Get-RepoRoot {
|
||||
$root = git rev-parse --show-toplevel 2>$null
|
||||
if (-not $root) { throw 'Not inside a git repository.' }
|
||||
return (Resolve-Path $root).Path
|
||||
}
|
||||
#endregion
|
||||
@@ -1,559 +0,0 @@
|
||||
<#!
|
||||
.SYNOPSIS
|
||||
Commit and create PRs for completed issue fixes in worktrees.
|
||||
|
||||
.DESCRIPTION
|
||||
For each specified issue (or all issue worktrees), commits changes using AI-generated
|
||||
commit messages and creates PRs with AI-generated summaries, linking to the original issue.
|
||||
|
||||
.PARAMETER IssueNumbers
|
||||
Array of issue numbers to submit. If not specified, processes all issue/* worktrees.
|
||||
|
||||
.PARAMETER DryRun
|
||||
Show what would be done without actually committing or creating PRs.
|
||||
|
||||
.PARAMETER SkipCommit
|
||||
Skip the commit step (assume changes are already committed).
|
||||
|
||||
.PARAMETER SkipPush
|
||||
Skip pushing to remote (useful for testing).
|
||||
|
||||
.PARAMETER TargetBranch
|
||||
Target branch for the PR. Default: main.
|
||||
|
||||
.PARAMETER CLIType
|
||||
AI CLI to use for generating messages: copilot, claude, or manual. Default: copilot.
|
||||
|
||||
.PARAMETER Draft
|
||||
Create PRs as drafts.
|
||||
|
||||
.EXAMPLE
|
||||
# Submit all issue worktrees
|
||||
./Submit-IssueFixes.ps1
|
||||
|
||||
.EXAMPLE
|
||||
# Submit specific issues
|
||||
./Submit-IssueFixes.ps1 -IssueNumbers 44044, 44480
|
||||
|
||||
.EXAMPLE
|
||||
# Dry run to see what would happen
|
||||
./Submit-IssueFixes.ps1 -DryRun
|
||||
|
||||
.EXAMPLE
|
||||
# Create draft PRs
|
||||
./Submit-IssueFixes.ps1 -Draft
|
||||
|
||||
.NOTES
|
||||
Prerequisites:
|
||||
- Worktrees created by Start-IssueAutoFix.ps1
|
||||
- Changes made in the worktrees
|
||||
- GitHub CLI (gh) authenticated
|
||||
- Copilot CLI or Claude Code CLI
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[int[]]$IssueNumbers,
|
||||
|
||||
[switch]$DryRun,
|
||||
|
||||
[switch]$SkipCommit,
|
||||
|
||||
[switch]$SkipPush,
|
||||
|
||||
[string]$TargetBranch = 'main',
|
||||
|
||||
[ValidateSet('copilot', 'claude', 'manual')]
|
||||
[string]$CLIType = 'copilot',
|
||||
|
||||
[switch]$Draft,
|
||||
|
||||
[switch]$Force,
|
||||
|
||||
[switch]$Help
|
||||
)
|
||||
|
||||
# Load libraries
|
||||
$scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
|
||||
. "$scriptDir/IssueReviewLib.ps1"
|
||||
|
||||
# Load worktree library
|
||||
$repoRoot = Get-RepoRoot
|
||||
$worktreeLib = Join-Path $repoRoot 'tools/build/WorktreeLib.ps1'
|
||||
if (Test-Path $worktreeLib) {
|
||||
. $worktreeLib
|
||||
}
|
||||
|
||||
if ($Help) {
|
||||
Get-Help $MyInvocation.MyCommand.Path -Full
|
||||
return
|
||||
}
|
||||
|
||||
function Get-AIGeneratedCommitTitle {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Generate commit title using AI CLI with create-commit-title prompt.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[string]$WorktreePath,
|
||||
[string]$CLIType = 'copilot'
|
||||
)
|
||||
|
||||
$promptFile = Join-Path $repoRoot '.github/prompts/create-commit-title.prompt.md'
|
||||
if (-not (Test-Path $promptFile)) {
|
||||
throw "Prompt file not found: $promptFile"
|
||||
}
|
||||
|
||||
$prompt = "Follow the instructions in .github/prompts/create-commit-title.prompt.md to generate a commit title for the current changes. Output ONLY the commit title, nothing else."
|
||||
|
||||
# MCP config for github-artifacts tools (relative to repo root)
|
||||
$mcpConfig = '@.github/skills/submit-pr/references/mcp-config.json'
|
||||
|
||||
Push-Location $WorktreePath
|
||||
try {
|
||||
switch ($CLIType) {
|
||||
'copilot' {
|
||||
$result = & copilot --additional-mcp-config $mcpConfig -p $prompt --yolo -s 2>&1
|
||||
# Extract just the title line (last non-empty line that looks like a title)
|
||||
$lines = $result -split "`n" | Where-Object { $_.Trim() -and $_ -notmatch '^\s*```' -and $_ -notmatch '^\s*#' }
|
||||
$title = $lines | Select-Object -Last 1
|
||||
return $title.Trim()
|
||||
}
|
||||
'claude' {
|
||||
$result = & claude --print --dangerously-skip-permissions --prompt $prompt 2>&1
|
||||
$lines = $result -split "`n" | Where-Object { $_.Trim() -and $_ -notmatch '^\s*```' }
|
||||
$title = $lines | Select-Object -Last 1
|
||||
return $title.Trim()
|
||||
}
|
||||
'manual' {
|
||||
# Show diff and ask user for title
|
||||
git diff HEAD --stat
|
||||
return Read-Host "Enter commit title"
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
Pop-Location
|
||||
}
|
||||
}
|
||||
|
||||
function Get-AIGeneratedPRSummary {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Generate PR summary using AI CLI with create-pr-summary prompt.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[string]$WorktreePath,
|
||||
[Parameter(Mandatory)]
|
||||
[int]$IssueNumber,
|
||||
[string]$TargetBranch = 'main',
|
||||
[string]$CLIType = 'copilot'
|
||||
)
|
||||
|
||||
$prompt = @"
|
||||
Follow the instructions in .github/prompts/create-pr-summary.prompt.md to generate a PR summary.
|
||||
Target branch: $TargetBranch
|
||||
This PR fixes issue #$IssueNumber.
|
||||
|
||||
IMPORTANT:
|
||||
1. Output the PR title on the first line
|
||||
2. Then output the PR body in markdown format
|
||||
3. Make sure to include "Fixes #$IssueNumber" in the body to auto-link the issue
|
||||
"@
|
||||
|
||||
# MCP config for github-artifacts tools (relative to repo root)
|
||||
$mcpConfig = '@.github/skills/submit-pr/references/mcp-config.json'
|
||||
|
||||
Push-Location $WorktreePath
|
||||
try {
|
||||
switch ($CLIType) {
|
||||
'copilot' {
|
||||
$result = & copilot --additional-mcp-config $mcpConfig -p $prompt --yolo -s 2>&1
|
||||
return $result -join "`n"
|
||||
}
|
||||
'claude' {
|
||||
$result = & claude --print --dangerously-skip-permissions --prompt $prompt 2>&1
|
||||
return $result -join "`n"
|
||||
}
|
||||
'manual' {
|
||||
git diff "$TargetBranch...HEAD" --stat
|
||||
$title = Read-Host "Enter PR title"
|
||||
$body = Read-Host "Enter PR body (or press Enter for default)"
|
||||
if (-not $body) {
|
||||
$body = "Fixes #$IssueNumber"
|
||||
}
|
||||
return "$title`n`n$body"
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
Pop-Location
|
||||
}
|
||||
}
|
||||
|
||||
function Parse-PRContent {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Parse AI output to extract PR title and body.
|
||||
Expected format:
|
||||
Line 1: feat(scope): title text
|
||||
Line 2+: ```markdown
|
||||
## Summary...
|
||||
```
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[string]$Content,
|
||||
[int]$IssueNumber
|
||||
)
|
||||
|
||||
$lines = $Content -split "`n"
|
||||
|
||||
# Title is the FIRST line that looks like a conventional commit
|
||||
# Body is the content INSIDE the ```markdown ... ``` block
|
||||
$title = $null
|
||||
$body = $null
|
||||
|
||||
# Find title - first line matching conventional commit format
|
||||
foreach ($line in $lines) {
|
||||
$trimmed = $line.Trim()
|
||||
if ($trimmed -match '^(feat|fix|docs|refactor|perf|test|build|ci|chore)(\([^)]+\))?:') {
|
||||
$title = $trimmed -replace '^#+\s*', ''
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
# Fallback title
|
||||
if (-not $title) {
|
||||
$title = "fix: address issue #$IssueNumber"
|
||||
}
|
||||
|
||||
# Extract body from markdown code block
|
||||
$fullContent = $Content
|
||||
if ($fullContent -match '```markdown\r?\n([\s\S]*?)\r?\n```') {
|
||||
$body = $Matches[1].Trim()
|
||||
} else {
|
||||
# No markdown block - use everything after the title line
|
||||
$titleIndex = [array]::IndexOf($lines, ($lines | Where-Object { $_.Trim() -eq $title } | Select-Object -First 1))
|
||||
if ($titleIndex -ge 0 -and $titleIndex -lt $lines.Count - 1) {
|
||||
$body = ($lines[($titleIndex + 1)..($lines.Count - 1)] -join "`n").Trim()
|
||||
# Clean up any remaining code fences
|
||||
$body = $body -replace '^```\w*\r?\n', '' -replace '\r?\n```\s*$', ''
|
||||
} else {
|
||||
$body = ""
|
||||
}
|
||||
}
|
||||
|
||||
# Ensure issue link is present
|
||||
if ($body -notmatch "Fixes\s*#$IssueNumber" -and $body -notmatch "Closes\s*#$IssueNumber" -and $body -notmatch "Resolves\s*#$IssueNumber") {
|
||||
$body = "$body`n`nFixes #$IssueNumber"
|
||||
}
|
||||
|
||||
return @{
|
||||
Title = $title
|
||||
Body = $body
|
||||
}
|
||||
}
|
||||
|
||||
function Submit-IssueFix {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Commit changes, push, and create PR for a single issue.
|
||||
#>
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[int]$IssueNumber,
|
||||
[Parameter(Mandatory)]
|
||||
[string]$WorktreePath,
|
||||
[Parameter(Mandatory)]
|
||||
[string]$Branch,
|
||||
[string]$TargetBranch = 'main',
|
||||
[string]$CLIType = 'copilot',
|
||||
[switch]$DryRun,
|
||||
[switch]$SkipCommit,
|
||||
[switch]$SkipPush,
|
||||
[switch]$Draft
|
||||
)
|
||||
|
||||
Push-Location $WorktreePath
|
||||
try {
|
||||
# Check for changes
|
||||
$status = git status --porcelain
|
||||
$hasUncommitted = $status.Count -gt 0
|
||||
|
||||
# Check for commits ahead of target
|
||||
git fetch origin $TargetBranch 2>$null
|
||||
$commitsAhead = git rev-list --count "origin/$TargetBranch..$Branch" 2>$null
|
||||
if (-not $commitsAhead) { $commitsAhead = 0 }
|
||||
|
||||
Info "Issue #$IssueNumber in $WorktreePath"
|
||||
Info " Branch: $Branch"
|
||||
Info " Uncommitted changes: $hasUncommitted"
|
||||
Info " Commits ahead of $TargetBranch`: $commitsAhead"
|
||||
|
||||
if (-not $hasUncommitted -and $commitsAhead -eq 0) {
|
||||
Warn " No changes to submit for issue #$IssueNumber"
|
||||
return @{ IssueNumber = $IssueNumber; Status = 'NoChanges' }
|
||||
}
|
||||
|
||||
# Step 1: Commit if there are uncommitted changes
|
||||
if ($hasUncommitted -and -not $SkipCommit) {
|
||||
Info " Generating commit title..."
|
||||
|
||||
if ($DryRun) {
|
||||
Info " [DRY RUN] Would generate commit title and commit changes"
|
||||
} else {
|
||||
$commitTitle = Get-AIGeneratedCommitTitle -WorktreePath $WorktreePath -CLIType $CLIType
|
||||
|
||||
if (-not $commitTitle) {
|
||||
throw "Failed to generate commit title"
|
||||
}
|
||||
|
||||
Info " Commit title: $commitTitle"
|
||||
|
||||
# Stage all changes and commit
|
||||
git add -A
|
||||
git commit -m $commitTitle
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
throw "Git commit failed"
|
||||
}
|
||||
|
||||
Success " ✓ Changes committed"
|
||||
}
|
||||
}
|
||||
|
||||
# Step 2: Push to remote
|
||||
if (-not $SkipPush) {
|
||||
if ($DryRun) {
|
||||
Info " [DRY RUN] Would push branch $Branch to origin"
|
||||
} else {
|
||||
Info " Pushing to origin..."
|
||||
git push -u origin $Branch 2>&1 | Out-Null
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
# Try force push if normal push fails (branch might have been reset)
|
||||
Warn " Normal push failed, trying force push..."
|
||||
git push -u origin $Branch --force-with-lease 2>&1 | Out-Null
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
throw "Git push failed"
|
||||
}
|
||||
}
|
||||
|
||||
Success " ✓ Pushed to origin"
|
||||
}
|
||||
}
|
||||
|
||||
# Step 3: Create PR
|
||||
Info " Generating PR summary..."
|
||||
|
||||
if ($DryRun) {
|
||||
Info " [DRY RUN] Would generate PR summary and create PR"
|
||||
Info " [DRY RUN] PR would link to issue #$IssueNumber"
|
||||
return @{ IssueNumber = $IssueNumber; Status = 'DryRun' }
|
||||
}
|
||||
|
||||
# Check if PR already exists
|
||||
$existingPR = gh pr list --head $Branch --json number,url 2>$null | ConvertFrom-Json
|
||||
if ($existingPR -and $existingPR.Count -gt 0) {
|
||||
Warn " PR already exists: $($existingPR[0].url)"
|
||||
return @{ IssueNumber = $IssueNumber; Status = 'PRExists'; PRUrl = $existingPR[0].url }
|
||||
}
|
||||
|
||||
$prContent = Get-AIGeneratedPRSummary -WorktreePath $WorktreePath -IssueNumber $IssueNumber -TargetBranch $TargetBranch -CLIType $CLIType
|
||||
$parsed = Parse-PRContent -Content $prContent -IssueNumber $IssueNumber
|
||||
|
||||
if (-not $parsed.Title) {
|
||||
throw "Failed to generate PR title"
|
||||
}
|
||||
|
||||
Info " PR Title: $($parsed.Title)"
|
||||
|
||||
# Create PR using gh CLI
|
||||
$ghArgs = @(
|
||||
'pr', 'create',
|
||||
'--base', $TargetBranch,
|
||||
'--head', $Branch,
|
||||
'--title', $parsed.Title,
|
||||
'--body', $parsed.Body
|
||||
)
|
||||
|
||||
if ($Draft) {
|
||||
$ghArgs += '--draft'
|
||||
}
|
||||
|
||||
$prResult = & gh @ghArgs 2>&1
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
throw "Failed to create PR: $prResult"
|
||||
}
|
||||
|
||||
# Extract PR URL from result
|
||||
$prUrl = $prResult | Select-String -Pattern 'https://github.com/[^\s]+' | ForEach-Object { $_.Matches[0].Value }
|
||||
|
||||
Success " ✓ PR created: $prUrl"
|
||||
|
||||
return @{
|
||||
IssueNumber = $IssueNumber
|
||||
Status = 'Success'
|
||||
PRUrl = $prUrl
|
||||
CommitTitle = $commitTitle
|
||||
PRTitle = $parsed.Title
|
||||
}
|
||||
}
|
||||
catch {
|
||||
Err " ✗ Failed: $($_.Exception.Message)"
|
||||
return @{
|
||||
IssueNumber = $IssueNumber
|
||||
Status = 'Failed'
|
||||
Error = $_.Exception.Message
|
||||
}
|
||||
}
|
||||
finally {
|
||||
Pop-Location
|
||||
}
|
||||
}
|
||||
|
||||
#region Main Script
|
||||
try {
|
||||
Info "Repository root: $repoRoot"
|
||||
Info "Target branch: $TargetBranch"
|
||||
Info "CLI type: $CLIType"
|
||||
|
||||
# Get all issue worktrees
|
||||
$allWorktrees = Get-WorktreeEntries | Where-Object { $_.Branch -like 'issue/*' }
|
||||
|
||||
if ($allWorktrees.Count -eq 0) {
|
||||
Warn "No issue worktrees found. Run Start-IssueAutoFix.ps1 first."
|
||||
return
|
||||
}
|
||||
|
||||
# Filter to specified issues if provided
|
||||
$worktreesToProcess = @()
|
||||
|
||||
if ($IssueNumbers -and $IssueNumbers.Count -gt 0) {
|
||||
foreach ($issueNum in $IssueNumbers) {
|
||||
$wt = $allWorktrees | Where-Object { $_.Branch -match "issue/$issueNum\b" }
|
||||
if ($wt) {
|
||||
$worktreesToProcess += $wt
|
||||
} else {
|
||||
Warn "No worktree found for issue #$issueNum"
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$worktreesToProcess = $allWorktrees
|
||||
}
|
||||
|
||||
if ($worktreesToProcess.Count -eq 0) {
|
||||
Warn "No worktrees to process."
|
||||
return
|
||||
}
|
||||
|
||||
# Display worktrees to process
|
||||
Info "`nWorktrees to submit:"
|
||||
Info ("-" * 80)
|
||||
foreach ($wt in $worktreesToProcess) {
|
||||
# Extract issue number from branch name
|
||||
if ($wt.Branch -match 'issue/(\d+)') {
|
||||
$issueNum = $Matches[1]
|
||||
Info " #$issueNum -> $($wt.Path) [$($wt.Branch)]"
|
||||
}
|
||||
}
|
||||
Info ("-" * 80)
|
||||
|
||||
if ($DryRun) {
|
||||
Warn "`nDry run mode - no changes will be made."
|
||||
}
|
||||
|
||||
# Confirm before proceeding
|
||||
if (-not $Force -and -not $DryRun) {
|
||||
$confirm = Read-Host "`nProceed with submitting $($worktreesToProcess.Count) fixes? (y/N)"
|
||||
if ($confirm -notmatch '^[yY]') {
|
||||
Info "Cancelled."
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
# Process each worktree
|
||||
$results = @{
|
||||
Success = @()
|
||||
Failed = @()
|
||||
NoChanges = @()
|
||||
PRExists = @()
|
||||
DryRun = @()
|
||||
}
|
||||
|
||||
foreach ($wt in $worktreesToProcess) {
|
||||
if ($wt.Branch -match 'issue/(\d+)') {
|
||||
$issueNum = [int]$Matches[1]
|
||||
|
||||
Info "`n" + ("=" * 60)
|
||||
Info "SUBMITTING ISSUE #$issueNum"
|
||||
Info ("=" * 60)
|
||||
|
||||
$result = Submit-IssueFix `
|
||||
-IssueNumber $issueNum `
|
||||
-WorktreePath $wt.Path `
|
||||
-Branch $wt.Branch `
|
||||
-TargetBranch $TargetBranch `
|
||||
-CLIType $CLIType `
|
||||
-DryRun:$DryRun `
|
||||
-SkipCommit:$SkipCommit `
|
||||
-SkipPush:$SkipPush `
|
||||
-Draft:$Draft
|
||||
|
||||
switch ($result.Status) {
|
||||
'Success' { $results.Success += $result }
|
||||
'Failed' { $results.Failed += $result }
|
||||
'NoChanges' { $results.NoChanges += $result }
|
||||
'PRExists' { $results.PRExists += $result }
|
||||
'DryRun' { $results.DryRun += $result }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Summary
|
||||
Info "`n" + ("=" * 80)
|
||||
Info "SUBMISSION COMPLETE"
|
||||
Info ("=" * 80)
|
||||
Info "Total worktrees: $($worktreesToProcess.Count)"
|
||||
|
||||
if ($results.Success.Count -gt 0) {
|
||||
Success "PRs created: $($results.Success.Count)"
|
||||
foreach ($r in $results.Success) {
|
||||
Success " #$($r.IssueNumber): $($r.PRUrl)"
|
||||
}
|
||||
}
|
||||
|
||||
if ($results.PRExists.Count -gt 0) {
|
||||
Warn "PRs already exist: $($results.PRExists.Count)"
|
||||
foreach ($r in $results.PRExists) {
|
||||
Warn " #$($r.IssueNumber): $($r.PRUrl)"
|
||||
}
|
||||
}
|
||||
|
||||
if ($results.NoChanges.Count -gt 0) {
|
||||
Warn "No changes: $($results.NoChanges.Count)"
|
||||
Warn " Issues: $($results.NoChanges.IssueNumber -join ', ')"
|
||||
}
|
||||
|
||||
if ($results.Failed.Count -gt 0) {
|
||||
Err "Failed: $($results.Failed.Count)"
|
||||
foreach ($r in $results.Failed) {
|
||||
Err " #$($r.IssueNumber): $($r.Error)"
|
||||
}
|
||||
}
|
||||
|
||||
if ($results.DryRun.Count -gt 0) {
|
||||
Info "Dry run: $($results.DryRun.Count)"
|
||||
}
|
||||
|
||||
Info ("=" * 80)
|
||||
|
||||
return $results
|
||||
}
|
||||
catch {
|
||||
Err "Error: $($_.Exception.Message)"
|
||||
exit 1
|
||||
}
|
||||
#endregion
|
||||
@@ -210,6 +210,11 @@
|
||||
"PowerToys.PowerAccentModuleInterface.dll",
|
||||
"PowerToys.PowerAccentKeyboardService.dll",
|
||||
|
||||
"PowerToys.PowerDisplayModuleInterface.dll",
|
||||
"WinUI3Apps\\PowerToys.PowerDisplay.dll",
|
||||
"WinUI3Apps\\PowerToys.PowerDisplay.exe",
|
||||
"PowerDisplay.Lib.dll",
|
||||
|
||||
"WinUI3Apps\\PowerToys.PowerRenameExt.dll",
|
||||
"WinUI3Apps\\PowerToys.PowerRename.exe",
|
||||
"WinUI3Apps\\PowerToys.PowerRenameContextMenu.dll",
|
||||
@@ -378,6 +383,8 @@
|
||||
"UnitsNet.dll",
|
||||
"UtfUnknown.dll",
|
||||
"Wpf.Ui.dll",
|
||||
"WmiLight.dll",
|
||||
"WmiLight.Native.dll",
|
||||
"Shmuelie.WinRTServer.dll",
|
||||
"ToolGood.Words.Pinyin.dll"
|
||||
],
|
||||
|
||||
@@ -91,6 +91,7 @@ extends:
|
||||
official: true
|
||||
codeSign: true
|
||||
runTests: false
|
||||
buildTests: false
|
||||
signingIdentity:
|
||||
serviceName: $(SigningServiceName)
|
||||
appId: $(SigningAppId)
|
||||
|
||||
@@ -258,6 +258,7 @@ jobs:
|
||||
-restore -graph
|
||||
/p:RestorePackagesConfig=true
|
||||
/p:CIBuild=true
|
||||
/p:BuildTests=${{ parameters.buildTests }}
|
||||
/bl:$(LogOutputDirectory)\build-0-main.binlog
|
||||
${{ parameters.additionalBuildOptions }}
|
||||
$(MSBuildCacheParameters)
|
||||
|
||||
@@ -59,6 +59,7 @@ stages:
|
||||
enableMsBuildCaching: ${{ parameters.enableMsBuildCaching }}
|
||||
msBuildCacheIsReadOnly: ${{ parameters.msBuildCacheIsReadOnly }}
|
||||
runTests: ${{ parameters.runTests }}
|
||||
buildTests: true
|
||||
useVSPreview: ${{ parameters.useVSPreview }}
|
||||
useLatestWinAppSDK: ${{ parameters.useLatestWinAppSDK }}
|
||||
${{ if eq(parameters.useLatestWinAppSDK, true) }}:
|
||||
@@ -78,7 +79,9 @@ stages:
|
||||
${{ else }}:
|
||||
name: SHINE-OSS-L
|
||||
${{ if eq(parameters.useVSPreview, true) }}:
|
||||
demands: ImageOverride -equals SHINE-VS17-Preview
|
||||
demands: ImageOverride -equals SHINE-VS18-Preview
|
||||
${{ else }}:
|
||||
demands: ImageOverride -equals SHINE-VS18-Latest
|
||||
buildConfigurations: [Release]
|
||||
official: false
|
||||
codeSign: false
|
||||
|
||||
@@ -90,9 +90,15 @@ if ($noticeMatch.Success) {
|
||||
$currentNoticePackageList = ""
|
||||
}
|
||||
|
||||
# Test-only packages that are allowed to be in NOTICE.md but not in the build
|
||||
# (e.g., when BuildTests=false, these packages won't appear in the NuGet list)
|
||||
$allowedExtraPackages = @(
|
||||
"- Moq"
|
||||
)
|
||||
|
||||
if (!$noticeFile.Trim().EndsWith($returnList.Trim()))
|
||||
{
|
||||
Write-Host -ForegroundColor Red "Notice.md does not match NuGet list."
|
||||
Write-Host -ForegroundColor Yellow "Notice.md does not exactly match NuGet list. Analyzing differences..."
|
||||
|
||||
# Show detailed differences
|
||||
$generatedPackages = $returnList -split "`r`n|`n" | Where-Object { $_.Trim() -ne "" } | Sort-Object
|
||||
@@ -105,7 +111,7 @@ if (!$noticeFile.Trim().EndsWith($returnList.Trim()))
|
||||
# Find packages in proj file list but not in NOTICE.md
|
||||
$missingFromNotice = $generatedPackages | Where-Object { $noticePackages -notcontains $_ }
|
||||
if ($missingFromNotice.Count -gt 0) {
|
||||
Write-Host -ForegroundColor Red "MissingFromNotice:"
|
||||
Write-Host -ForegroundColor Red "MissingFromNotice (ERROR - these must be added to NOTICE.md):"
|
||||
foreach ($pkg in $missingFromNotice) {
|
||||
Write-Host -ForegroundColor Red " $pkg"
|
||||
}
|
||||
@@ -114,10 +120,23 @@ if (!$noticeFile.Trim().EndsWith($returnList.Trim()))
|
||||
|
||||
# Find packages in NOTICE.md but not in proj file list
|
||||
$extraInNotice = $noticePackages | Where-Object { $generatedPackages -notcontains $_ }
|
||||
if ($extraInNotice.Count -gt 0) {
|
||||
Write-Host -ForegroundColor Yellow "ExtraInNotice:"
|
||||
foreach ($pkg in $extraInNotice) {
|
||||
Write-Host -ForegroundColor Yellow " $pkg"
|
||||
|
||||
# Filter out allowed extra packages (test-only dependencies)
|
||||
$unexpectedExtra = $extraInNotice | Where-Object { $allowedExtraPackages -notcontains $_ }
|
||||
$allowedExtra = $extraInNotice | Where-Object { $allowedExtraPackages -contains $_ }
|
||||
|
||||
if ($allowedExtra.Count -gt 0) {
|
||||
Write-Host -ForegroundColor Green "ExtraInNotice (OK - allowed test-only packages):"
|
||||
foreach ($pkg in $allowedExtra) {
|
||||
Write-Host -ForegroundColor Green " $pkg"
|
||||
}
|
||||
Write-Host ""
|
||||
}
|
||||
|
||||
if ($unexpectedExtra.Count -gt 0) {
|
||||
Write-Host -ForegroundColor Red "ExtraInNotice (ERROR - unexpected packages in NOTICE.md):"
|
||||
foreach ($pkg in $unexpectedExtra) {
|
||||
Write-Host -ForegroundColor Red " $pkg"
|
||||
}
|
||||
Write-Host ""
|
||||
}
|
||||
@@ -127,10 +146,17 @@ if (!$noticeFile.Trim().EndsWith($returnList.Trim()))
|
||||
Write-Host " Proj file list has $($generatedPackages.Count) packages"
|
||||
Write-Host " NOTICE.md has $($noticePackages.Count) packages"
|
||||
Write-Host " MissingFromNotice: $($missingFromNotice.Count) packages"
|
||||
Write-Host " ExtraInNotice: $($extraInNotice.Count) packages"
|
||||
Write-Host " ExtraInNotice (allowed): $($allowedExtra.Count) packages"
|
||||
Write-Host " ExtraInNotice (unexpected): $($unexpectedExtra.Count) packages"
|
||||
Write-Host ""
|
||||
|
||||
exit 1
|
||||
# Fail if there are missing packages OR unexpected extra packages
|
||||
if ($missingFromNotice.Count -gt 0 -or $unexpectedExtra.Count -gt 0) {
|
||||
Write-Host -ForegroundColor Red "FAILED: NOTICE.md mismatch detected."
|
||||
exit 1
|
||||
} else {
|
||||
Write-Host -ForegroundColor Green "PASSED: NOTICE.md matches (with allowed test-only packages)."
|
||||
}
|
||||
}
|
||||
|
||||
exit 0
|
||||
|
||||
@@ -2,6 +2,12 @@
|
||||
<Project ToolsVersion="4.0"
|
||||
xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
|
||||
<!-- Skip building C++ test projects when BuildTests=false -->
|
||||
<PropertyGroup Condition="'$(_IsSkippedTestProject)' == 'true'">
|
||||
<UsePrecompiledHeaders>false</UsePrecompiledHeaders>
|
||||
<RunCodeAnalysis>false</RunCodeAnalysis>
|
||||
</PropertyGroup>
|
||||
|
||||
<!-- Project configurations -->
|
||||
<ItemGroup Label="ProjectConfigurations">
|
||||
<ProjectConfiguration Include="Debug|x64">
|
||||
|
||||
@@ -19,6 +19,39 @@
|
||||
<PlatformTarget>$(Platform)</PlatformTarget>
|
||||
</PropertyGroup>
|
||||
|
||||
<!--
|
||||
Completely skip building test projects when BuildTests=false (e.g., Release pipeline).
|
||||
This avoids InternalsVisibleTo/signing issues by not compiling test code at all.
|
||||
Match: projects ending in Test, Tests, UnitTests, UITests, FuzzTests, or in a folder named Tests.
|
||||
Also matches projects starting with UnitTests- (e.g., UnitTests-CommonLib).
|
||||
Also removes all PackageReference/ProjectReference to prevent NuGet restore and dependency builds.
|
||||
Note: Checking both 'false' and 'False' to handle YAML boolean serialization.
|
||||
-->
|
||||
<PropertyGroup Condition="'$(BuildTests)' == 'false' or '$(BuildTests)' == 'False'">
|
||||
<_ProjectName>$(MSBuildProjectName)</_ProjectName>
|
||||
<!-- Match any project ending with "Test" or "Tests" (covers UnitTests, UITests, FuzzTests, etc.) -->
|
||||
<_IsSkippedTestProject Condition="$(_ProjectName.EndsWith('Test'))">true</_IsSkippedTestProject>
|
||||
<_IsSkippedTestProject Condition="$(_ProjectName.EndsWith('Tests'))">true</_IsSkippedTestProject>
|
||||
<!-- Match projects starting with UnitTests- or UITest- prefix -->
|
||||
<_IsSkippedTestProject Condition="$(_ProjectName.StartsWith('UnitTests-'))">true</_IsSkippedTestProject>
|
||||
<_IsSkippedTestProject Condition="$(_ProjectName.StartsWith('UITest-'))">true</_IsSkippedTestProject>
|
||||
<!-- Match projects in a Tests folder -->
|
||||
<_IsSkippedTestProject Condition="$(MSBuildProjectDirectory.Contains('\Tests\'))">true</_IsSkippedTestProject>
|
||||
</PropertyGroup>
|
||||
|
||||
<PropertyGroup Condition="'$(_IsSkippedTestProject)' == 'true'">
|
||||
<EnableDefaultItems>false</EnableDefaultItems>
|
||||
<EnableDefaultCompileItems>false</EnableDefaultCompileItems>
|
||||
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
|
||||
<GenerateGlobalUsings>false</GenerateGlobalUsings>
|
||||
<ImplicitUsings>disable</ImplicitUsings>
|
||||
<!-- Disable all code analysis for skipped test projects -->
|
||||
<EnableNETAnalyzers>false</EnableNETAnalyzers>
|
||||
<RunAnalyzers>false</RunAnalyzers>
|
||||
<RunAnalyzersDuringBuild>false</RunAnalyzersDuringBuild>
|
||||
<TreatWarningsAsErrors>false</TreatWarningsAsErrors>
|
||||
</PropertyGroup>
|
||||
|
||||
<PropertyGroup Condition="'$(MSBuildProjectExtension)' == '.csproj'">
|
||||
<Version>$(Version).0</Version>
|
||||
<RepositoryUrl>https://github.com/microsoft/PowerToys</RepositoryUrl>
|
||||
@@ -30,7 +63,9 @@
|
||||
<_PropertySheetDisplayName>PowerToys.Root.Props</_PropertySheetDisplayName>
|
||||
<ForceImportBeforeCppProps>$(MsbuildThisFileDirectory)\Cpp.Build.props</ForceImportBeforeCppProps>
|
||||
</PropertyGroup>
|
||||
<ItemGroup Condition="'$(MSBuildProjectExtension)' == '.csproj'">
|
||||
|
||||
|
||||
<ItemGroup Condition="'$(MSBuildProjectExtension)' == '.csproj' and '$(_IsSkippedTestProject)' != 'true'">
|
||||
<PackageReference Include="StyleCop.Analyzers">
|
||||
<PrivateAssets>all</PrivateAssets>
|
||||
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
|
||||
|
||||
@@ -28,4 +28,41 @@
|
||||
<PropertyGroup Condition="'$(IgnoreExperimentalWarnings)' == 'true'">
|
||||
<NoWarn>$(NoWarn);CS8305;SA1500;CA1852</NoWarn>
|
||||
</PropertyGroup>
|
||||
</Project>
|
||||
|
||||
<!-- Skipped test projects when BuildTests=false: no-op build and remove references.
|
||||
This must be in targets (not props) so it runs AFTER the project file adds its items. -->
|
||||
<PropertyGroup Condition="'$(_IsSkippedTestProject)' == 'true'">
|
||||
<BuildDependsOn />
|
||||
<CoreBuildDependsOn />
|
||||
<RebuildDependsOn />
|
||||
</PropertyGroup>
|
||||
|
||||
<!-- For C# projects: remove all items -->
|
||||
<ItemGroup Condition="'$(_IsSkippedTestProject)' == 'true' and '$(MSBuildProjectExtension)' == '.csproj'">
|
||||
<PackageReference Remove="@(PackageReference)" />
|
||||
<ProjectReference Remove="@(ProjectReference)" />
|
||||
<Reference Remove="@(Reference)" />
|
||||
<Compile Remove="@(Compile)" />
|
||||
<Content Remove="@(Content)" />
|
||||
<EmbeddedResource Remove="@(EmbeddedResource)" />
|
||||
<None Remove="@(None)" />
|
||||
<Using Remove="@(Using)" />
|
||||
<GlobalUsing Remove="@(GlobalUsing)" />
|
||||
</ItemGroup>
|
||||
|
||||
<!-- For C++ projects (vcxproj): remove all compile/link items to prevent build -->
|
||||
<ItemGroup Condition="'$(_IsSkippedTestProject)' == 'true' and '$(MSBuildProjectExtension)' == '.vcxproj'">
|
||||
<ClCompile Remove="@(ClCompile)" />
|
||||
<ClInclude Remove="@(ClInclude)" />
|
||||
<Link Remove="@(Link)" />
|
||||
<Lib Remove="@(Lib)" />
|
||||
<ProjectReference Remove="@(ProjectReference)" />
|
||||
<None Remove="@(None)" />
|
||||
<ResourceCompile Remove="@(ResourceCompile)" />
|
||||
<Midl Remove="@(Midl)" />
|
||||
</ItemGroup>
|
||||
|
||||
<!-- Note: For C++ skipped test projects, build is effectively skipped by removing all compile items above.
|
||||
We don't define empty Build/Rebuild/Clean targets here because MSBuild Target definitions with Condition
|
||||
on the Target element still override the default targets even when condition is false. -->
|
||||
</Project>
|
||||
|
||||
@@ -93,6 +93,7 @@
|
||||
<PackageVersion Include="NLog.Extensions.Logging" Version="5.3.8" />
|
||||
<PackageVersion Include="NLog.Schema" Version="5.2.8" />
|
||||
<PackageVersion Include="OpenAI" Version="2.5.0" />
|
||||
<PackageVersion Include="Polly.Core" Version="8.6.5" />
|
||||
<PackageVersion Include="ReverseMarkdown" Version="4.1.0" />
|
||||
<PackageVersion Include="RtfPipe" Version="2.0.7677.4303" />
|
||||
<PackageVersion Include="ScipBe.Common.Office.OneNote" Version="3.0.1" />
|
||||
@@ -104,6 +105,7 @@
|
||||
<PackageVersion Include="StyleCop.Analyzers" Version="1.2.0-beta.556" />
|
||||
<!-- Package System.CodeDom added as a hack for being able to exclude the runtime assets so they don't conflict with 8.0.1. This is a dependency of System.Management but the 8.0.1 version wasn't published to nuget. -->
|
||||
<PackageVersion Include="System.CodeDom" Version="9.0.10" />
|
||||
<PackageVersion Include="System.Collections.Immutable" Version="9.0.0" />
|
||||
<PackageVersion Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
|
||||
<PackageVersion Include="System.ComponentModel.Composition" Version="9.0.10" />
|
||||
<PackageVersion Include="System.Configuration.ConfigurationManager" Version="9.0.10" />
|
||||
@@ -133,6 +135,7 @@
|
||||
<PackageVersion Include="UnitsNet" Version="5.56.0" />
|
||||
<PackageVersion Include="UTF.Unknown" Version="2.6.0" />
|
||||
<PackageVersion Include="WinUIEx" Version="2.8.0" />
|
||||
<PackageVersion Include="WmiLight" Version="6.14.0" />
|
||||
<PackageVersion Include="WPF-UI" Version="3.0.5" />
|
||||
<PackageVersion Include="WyHash" Version="1.0.5" />
|
||||
<PackageVersion Include="WixToolset.Heat" Version="5.0.2" />
|
||||
|
||||
32
NOTICE.md
32
NOTICE.md
@@ -10,6 +10,7 @@ This software incorporates material from third parties.
|
||||
- Installer/Runner
|
||||
- Measure tool
|
||||
- Peek
|
||||
- PowerDisplay
|
||||
- Registry Preview
|
||||
|
||||
## Utility: Color Picker
|
||||
@@ -1519,6 +1520,35 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
|
||||
## Utility: PowerDisplay
|
||||
|
||||
### Twinkle Tray
|
||||
|
||||
PowerDisplay's DDC/CI implementation references techniques from Twinkle Tray.
|
||||
|
||||
**Source**: https://github.com/xanderfrangos/twinkle-tray
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright © 2020 Xander Frangos
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
## NuGet Packages used by PowerToys
|
||||
|
||||
@@ -1557,6 +1587,7 @@ SOFTWARE.
|
||||
- NLog.Extensions.Logging
|
||||
- NLog.Schema
|
||||
- OpenAI
|
||||
- Polly.Core
|
||||
- ReverseMarkdown
|
||||
- ScipBe.Common.Office.OneNote
|
||||
- SharpCompress
|
||||
@@ -1569,5 +1600,6 @@ SOFTWARE.
|
||||
- UnitsNet
|
||||
- UTF.Unknown
|
||||
- WinUIEx
|
||||
- WmiLight
|
||||
- WPF-UI
|
||||
- WyHash
|
||||
@@ -55,6 +55,7 @@
|
||||
<Platform Solution="*|x64" Project="x64" />
|
||||
</Project>
|
||||
<Project Path="src/common/UnitTests-CommonLib/UnitTests-CommonLib.vcxproj" Id="1a066c63-64b3-45f8-92fe-664e1cce8077" />
|
||||
<Project Path="src/common/UnitTests-CommonUtils/UnitTests-CommonUtils.vcxproj" Id="8b5cfb38-ccba-40a8-ad7a-89c57b070884" />
|
||||
<Project Path="src/common/updating/updating.vcxproj" Id="17da04df-e393-4397-9cf0-84dabe11032e" />
|
||||
<Project Path="src/common/version/version.vcxproj" Id="cc6e41ac-8174-4e8a-8d22-85dd7f4851df" />
|
||||
</Folder>
|
||||
@@ -684,6 +685,23 @@
|
||||
<Deploy />
|
||||
</Project>
|
||||
</Folder>
|
||||
<Folder Name="/modules/PowerDisplay/">
|
||||
<Project Path="src/modules/powerdisplay/PowerDisplay.Lib/PowerDisplay.Lib.csproj">
|
||||
<Platform Solution="*|ARM64" Project="ARM64" />
|
||||
<Platform Solution="*|x64" Project="x64" />
|
||||
</Project>
|
||||
<Project Path="src/modules/powerdisplay/PowerDisplay/PowerDisplay.csproj">
|
||||
<Platform Solution="*|ARM64" Project="ARM64" />
|
||||
<Platform Solution="*|x64" Project="x64" />
|
||||
</Project>
|
||||
<Project Path="src/modules/powerdisplay/PowerDisplayModuleInterface/PowerDisplayModuleInterface.vcxproj" Id="d1234567-8901-2345-6789-abcdef012345" />
|
||||
</Folder>
|
||||
<Folder Name="/modules/PowerDisplay/Tests/">
|
||||
<Project Path="src/modules/powerdisplay/PowerDisplay.Lib.UnitTests/PowerDisplay.Lib.UnitTests.csproj">
|
||||
<Platform Solution="*|ARM64" Project="ARM64" />
|
||||
<Platform Solution="*|x64" Project="x64" />
|
||||
</Project>
|
||||
</Folder>
|
||||
<Folder Name="/modules/MeasureTool/">
|
||||
<Project Path="src/modules/MeasureTool/MeasureToolCore/PowerToys.MeasureToolCore.vcxproj" Id="54a93af7-60c7-4f6c-99d2-fbb1f75f853a">
|
||||
<BuildDependency Project="src/common/Display/Display.vcxproj" />
|
||||
|
||||
1616
doc/devdocs/modules/powerdisplay/design.md
Normal file
1616
doc/devdocs/modules/powerdisplay/design.md
Normal file
File diff suppressed because it is too large
Load Diff
223
doc/devdocs/modules/powerdisplay/mccsParserDesign.md
Normal file
223
doc/devdocs/modules/powerdisplay/mccsParserDesign.md
Normal file
@@ -0,0 +1,223 @@
|
||||
# MCCS Capabilities String Parser - Recursive Descent Design
|
||||
|
||||
## Overview
|
||||
|
||||
This document describes the recursive descent parser implementation for DDC/CI MCCS (Monitor Control Command Set) capabilities strings.
|
||||
|
||||
### Attention!
|
||||
This document and the code implement are generated by Copilot.
|
||||
|
||||
## Grammar Definition (BNF)
|
||||
|
||||
```bnf
|
||||
capabilities ::= ['('] segment* [')']
|
||||
segment ::= identifier '(' segment_content ')'
|
||||
segment_content ::= text | vcp_entries | hex_list
|
||||
vcp_entries ::= vcp_entry*
|
||||
vcp_entry ::= hex_byte [ '(' hex_list ')' ]
|
||||
hex_list ::= hex_byte*
|
||||
hex_byte ::= [0-9A-Fa-f]{2}
|
||||
identifier ::= [a-z_A-Z]+
|
||||
text ::= [^()]+
|
||||
```
|
||||
|
||||
## Example Input
|
||||
|
||||
```
|
||||
(prot(monitor)type(lcd)model(PD3220U)cmds(01 02 03 07)vcp(10 12 14(04 05 06) 16 60(11 12 0F) DC DF)mccs_ver(2.2)vcpname(F0(Custom Setting)))
|
||||
```
|
||||
|
||||
## Parser Architecture
|
||||
|
||||
### Component Hierarchy
|
||||
|
||||
```
|
||||
MccsCapabilitiesParser (main parser)
|
||||
├── ParseCapabilities() → MccsParseResult
|
||||
├── ParseSegment() → ParsedSegment?
|
||||
├── ParseBalancedContent() → string
|
||||
├── ParseIdentifier() → ReadOnlySpan<char>
|
||||
├── ApplySegment() → void
|
||||
│ ├── ParseHexList() → List<byte>
|
||||
│ ├── ParseVcpEntries() → Dictionary<byte, VcpCodeInfo>
|
||||
│ └── ParseVcpNames() → void
|
||||
│
|
||||
├── VcpEntryParser (sub-parser for vcp() content)
|
||||
│ └── TryParseEntry() → VcpEntry
|
||||
│
|
||||
├── VcpNameParser (sub-parser for vcpname() content)
|
||||
│ └── TryParseEntry() → (byte code, string name)
|
||||
│
|
||||
└── WindowParser (sub-parser for windowN() content)
|
||||
├── Parse() → WindowCapability
|
||||
└── ParseSubSegment() → (name, content)?
|
||||
```
|
||||
|
||||
### Design Principles
|
||||
|
||||
1. **ref struct for Zero Allocation**
|
||||
- Main parser uses `ref struct` to avoid heap allocation
|
||||
- Works with `ReadOnlySpan<char>` for efficient string slicing
|
||||
- No intermediate string allocations during parsing
|
||||
|
||||
2. **Recursive Descent Pattern**
|
||||
- Each grammar rule has a corresponding parse method
|
||||
- Methods call each other recursively for nested structures
|
||||
- Single-character lookahead via `Peek()`
|
||||
|
||||
3. **Error Recovery**
|
||||
- Errors are accumulated, not thrown
|
||||
- Parser attempts to continue after errors
|
||||
- Returns partial results when possible
|
||||
|
||||
4. **Sub-parsers for Specialized Content**
|
||||
- `VcpEntryParser` for VCP code entries
|
||||
- `VcpNameParser` for custom VCP names
|
||||
- Each sub-parser handles its own grammar subset
|
||||
|
||||
## Parse Methods Detail
|
||||
|
||||
### ParseCapabilities()
|
||||
Entry point. Handles optional outer parentheses and iterates through segments.
|
||||
|
||||
```csharp
|
||||
private MccsParseResult ParseCapabilities()
|
||||
{
|
||||
// Handle optional outer parens
|
||||
// while (!IsAtEnd()) { ParseSegment() }
|
||||
// Return result with accumulated errors
|
||||
}
|
||||
```
|
||||
|
||||
### ParseSegment()
|
||||
Parses a single `identifier(content)` segment.
|
||||
|
||||
```csharp
|
||||
private ParsedSegment? ParseSegment()
|
||||
{
|
||||
// 1. ParseIdentifier()
|
||||
// 2. Expect '('
|
||||
// 3. ParseBalancedContent()
|
||||
// 4. Expect ')'
|
||||
}
|
||||
```
|
||||
|
||||
### ParseBalancedContent()
|
||||
Extracts content between balanced parentheses, handling nested parens.
|
||||
|
||||
```csharp
|
||||
private string ParseBalancedContent()
|
||||
{
|
||||
int depth = 1;
|
||||
while (depth > 0) {
|
||||
if (char == '(') depth++;
|
||||
if (char == ')') depth--;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### ParseVcpEntries()
|
||||
Delegates to `VcpEntryParser` for the specialized VCP entry grammar.
|
||||
|
||||
```csharp
|
||||
vcp_entry ::= hex_byte [ '(' hex_list ')' ]
|
||||
|
||||
Examples:
|
||||
- "10" → code=0x10, values=[]
|
||||
- "14(04 05 06)" → code=0x14, values=[4, 5, 6]
|
||||
- "60(11 12 0F)" → code=0x60, values=[0x11, 0x12, 0x0F]
|
||||
```
|
||||
|
||||
## Comparison with Other Approaches
|
||||
|
||||
| Approach | Pros | Cons |
|
||||
|----------|------|------|
|
||||
| **Recursive Descent** (this) | Clear structure, handles nesting, extensible | More code |
|
||||
| **Regex** (DDCSharp) | Concise | Hard to debug, limited nesting |
|
||||
| **Mixed** (original) | Pragmatic | Inconsistent, hard to maintain |
|
||||
|
||||
## Performance Characteristics
|
||||
|
||||
- **Time Complexity**: O(n) where n = input length
|
||||
- **Space Complexity**: O(1) for parsing + O(m) for output where m = number of VCP codes
|
||||
- **Allocations**: Minimal - only for output structures
|
||||
|
||||
## Supported Segments
|
||||
|
||||
| Segment | Description | Parser |
|
||||
|---------|-------------|--------|
|
||||
| `prot(...)` | Protocol type | Direct assignment |
|
||||
| `type(...)` | Display type (lcd/crt) | Direct assignment |
|
||||
| `model(...)` | Model name | Direct assignment |
|
||||
| `cmds(...)` | Supported commands | ParseHexList |
|
||||
| `vcp(...)` | VCP code entries | VcpEntryParser |
|
||||
| `mccs_ver(...)` | MCCS version | Direct assignment |
|
||||
| `vcpname(...)` | Custom VCP names | VcpNameParser |
|
||||
| `windowN(...)` | PIP/PBP window capabilities | WindowParser |
|
||||
|
||||
### Window Segment Format
|
||||
|
||||
The `windowN` segment (where N is 1, 2, 3, etc.) describes PIP/PBP window capabilities:
|
||||
|
||||
```
|
||||
window1(type(PIP) area(25 25 1895 1175) max(640 480) min(10 10) window(10))
|
||||
```
|
||||
|
||||
| Sub-field | Format | Description |
|
||||
|-----------|--------|-------------|
|
||||
| `type` | `type(PIP)` or `type(PBP)` | Window type (Picture-in-Picture or Picture-by-Picture) |
|
||||
| `area` | `area(x1 y1 x2 y2)` | Window area coordinates in pixels |
|
||||
| `max` | `max(width height)` | Maximum window dimensions |
|
||||
| `min` | `min(width height)` | Minimum window dimensions |
|
||||
| `window` | `window(id)` | Window identifier |
|
||||
|
||||
All sub-fields are optional; missing fields default to zero values.
|
||||
|
||||
## Error Handling
|
||||
|
||||
```csharp
|
||||
public readonly struct ParseError
|
||||
{
|
||||
public int Position { get; } // Character position
|
||||
public string Message { get; } // Human-readable error
|
||||
}
|
||||
|
||||
public sealed class MccsParseResult
|
||||
{
|
||||
public VcpCapabilities Capabilities { get; }
|
||||
public IReadOnlyList<ParseError> Errors { get; }
|
||||
public bool HasErrors => Errors.Count > 0;
|
||||
public bool IsValid => !HasErrors && Capabilities.SupportedVcpCodes.Count > 0;
|
||||
}
|
||||
```
|
||||
|
||||
## Usage Example
|
||||
|
||||
```csharp
|
||||
// Parse capabilities string
|
||||
var result = MccsCapabilitiesParser.Parse(capabilitiesString);
|
||||
|
||||
if (result.IsValid)
|
||||
{
|
||||
var caps = result.Capabilities;
|
||||
Console.WriteLine($"Model: {caps.Model}");
|
||||
Console.WriteLine($"MCCS Version: {caps.MccsVersion}");
|
||||
Console.WriteLine($"VCP Codes: {caps.SupportedVcpCodes.Count}");
|
||||
}
|
||||
|
||||
if (result.HasErrors)
|
||||
{
|
||||
foreach (var error in result.Errors)
|
||||
{
|
||||
Console.WriteLine($"Parse error at {error.Position}: {error.Message}");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Edge Cases Handled
|
||||
|
||||
1. **Missing outer parentheses** (Apple Cinema Display)
|
||||
2. **No spaces between hex bytes** (`010203` vs `01 02 03`)
|
||||
3. **Nested parentheses** in VCP values
|
||||
4. **Unknown segments** (logged but not fatal)
|
||||
5. **Malformed input** (partial results returned)
|
||||
@@ -1549,7 +1549,7 @@ UINT __stdcall TerminateProcessesCA(MSIHANDLE hInstall)
|
||||
}
|
||||
processes.resize(bytes / sizeof(processes[0]));
|
||||
|
||||
std::array<std::wstring_view, 44> processesToTerminate = {
|
||||
std::array<std::wstring_view, 45> processesToTerminate = {
|
||||
L"PowerToys.PowerLauncher.exe",
|
||||
L"PowerToys.Settings.exe",
|
||||
L"PowerToys.AdvancedPaste.exe",
|
||||
@@ -1565,6 +1565,7 @@ UINT __stdcall TerminateProcessesCA(MSIHANDLE hInstall)
|
||||
L"PowerToys.PowerRename.exe",
|
||||
L"PowerToys.ImageResizer.exe",
|
||||
L"PowerToys.LightSwitchService.exe",
|
||||
L"PowerToys.PowerDisplay.exe",
|
||||
L"PowerToys.GcodeThumbnailProvider.exe",
|
||||
L"PowerToys.BgcodeThumbnailProvider.exe",
|
||||
L"PowerToys.PdfThumbnailProvider.exe",
|
||||
|
||||
29
installer/PowerToysSetupVNext/PowerDisplay.wxs
Normal file
29
installer/PowerToysSetupVNext/PowerDisplay.wxs
Normal file
@@ -0,0 +1,29 @@
|
||||
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
|
||||
xmlns:util="http://wixtoolset.org/schemas/v4/wxs/util" >
|
||||
|
||||
<?include $(sys.CURRENTDIR)\Common.wxi?>
|
||||
|
||||
<?define PowerDisplayAssetsFiles=?>
|
||||
<?define PowerDisplayAssetsFilesPath=$(var.BinDir)WinUI3Apps\Assets\PowerDisplay?>
|
||||
|
||||
<Fragment>
|
||||
<!-- Power Display -->
|
||||
<DirectoryRef Id="WinUI3AppsAssetsFolder">
|
||||
<Directory Id="PowerDisplayAssetsInstallFolder" Name="PowerDisplay" />
|
||||
</DirectoryRef>
|
||||
<DirectoryRef Id="PowerDisplayAssetsInstallFolder" FileSource="$(var.PowerDisplayAssetsFilesPath)">
|
||||
<!-- Generated by generateFileComponents.ps1 -->
|
||||
<!--PowerDisplayAssetsFiles_Component_Def-->
|
||||
</DirectoryRef>
|
||||
|
||||
<ComponentGroup Id="PowerDisplayComponentGroup">
|
||||
<Component Id="RemovePowerDisplayFolder" Guid="B8F2E3A5-72C1-4A2D-9B3F-8E5D7C6A4F9B" Directory="PowerDisplayAssetsInstallFolder" >
|
||||
<RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
|
||||
<RegistryValue Type="string" Name="RemovePowerDisplayFolder" Value="" KeyPath="yes"/>
|
||||
</RegistryKey>
|
||||
<RemoveFolder Id="RemoveFolderPowerDisplayAssetsFolder" Directory="PowerDisplayAssetsInstallFolder" On="uninstall"/>
|
||||
</Component>
|
||||
</ComponentGroup>
|
||||
|
||||
</Fragment>
|
||||
</Wix>
|
||||
@@ -47,6 +47,7 @@ call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuil
|
||||
call move /Y ..\..\..\NewPlus.wxs.bk ..\..\..\NewPlus.wxs
|
||||
call move /Y ..\..\..\Peek.wxs.bk ..\..\..\Peek.wxs
|
||||
call move /Y ..\..\..\PowerRename.wxs.bk ..\..\..\PowerRename.wxs
|
||||
call move /Y ..\..\..\PowerDisplay.wxs.bk ..\..\..\PowerDisplay.wxs
|
||||
call move /Y ..\..\..\Product.wxs.bk ..\..\..\Product.wxs
|
||||
call move /Y ..\..\..\RegistryPreview.wxs.bk ..\..\..\RegistryPreview.wxs
|
||||
call move /Y ..\..\..\Resources.wxs.bk ..\..\..\Resources.wxs
|
||||
@@ -123,6 +124,7 @@ call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuil
|
||||
<Compile Include="KeyboardManager.wxs" />
|
||||
<Compile Include="Peek.wxs" />
|
||||
<Compile Include="PowerRename.wxs" />
|
||||
<Compile Include="PowerDisplay.wxs" />
|
||||
<Compile Include="DscResources.wxs" />
|
||||
<Compile Include="RegistryPreview.wxs" />
|
||||
<Compile Include="Run.wxs" />
|
||||
|
||||
@@ -53,6 +53,7 @@
|
||||
<ComponentGroupRef Id="LightSwitchComponentGroup" />
|
||||
<ComponentGroupRef Id="PeekComponentGroup" />
|
||||
<ComponentGroupRef Id="PowerRenameComponentGroup" />
|
||||
<ComponentGroupRef Id="PowerDisplayComponentGroup" />
|
||||
<ComponentGroupRef Id="RegistryPreviewComponentGroup" />
|
||||
<ComponentGroupRef Id="RunComponentGroup" />
|
||||
<ComponentGroupRef Id="SettingsComponentGroup" />
|
||||
|
||||
@@ -367,6 +367,12 @@
|
||||
</RegistryKey>
|
||||
<File Id="BgcodePreviewHandler_$(var.IdSafeLanguage)_File" Source="$(var.BinDir)\$(var.Language)\PowerToys.BgcodePreviewHandler.resources.dll" />
|
||||
</Component>
|
||||
<Component Id="CmdPalExtPowerToys_$(var.IdSafeLanguage)_Component" Directory="Resource$(var.IdSafeLanguage)INSTALLFOLDER" Guid="$(var.CompGUIDPrefix)23">
|
||||
<RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
|
||||
<RegistryValue Type="string" Name="CmdPalExtPowerToys_$(var.IdSafeLanguage)_Component" Value="" KeyPath="yes" />
|
||||
</RegistryKey>
|
||||
<File Id="CmdPalExtPowerToys_$(var.IdSafeLanguage)_File" Source="$(var.BinDir)\$(var.Language)\Microsoft.CmdPal.Ext.PowerToys.resources.dll" />
|
||||
</Component>
|
||||
<?undef IdSafeLanguage?>
|
||||
<?undef CompGUIDPrefix?>
|
||||
<?endforeach?>
|
||||
|
||||
@@ -176,6 +176,10 @@ Generate-FileComponents -fileListName "ImageResizerAssetsFiles" -wxsFilePath $PS
|
||||
Generate-FileList -fileDepsJson "" -fileListName LightSwitchFiles -wxsFilePath $PSScriptRoot\LightSwitch.wxs -depsPath "$PSScriptRoot..\..\..\$platform\Release\LightSwitchService"
|
||||
Generate-FileComponents -fileListName "LightSwitchFiles" -wxsFilePath $PSScriptRoot\LightSwitch.wxs
|
||||
|
||||
#PowerDisplay
|
||||
Generate-FileList -fileDepsJson "" -fileListName PowerDisplayAssetsFiles -wxsFilePath $PSScriptRoot\PowerDisplay.wxs -depsPath "$PSScriptRoot..\..\..\$platform\Release\WinUI3Apps\Assets\PowerDisplay"
|
||||
Generate-FileComponents -fileListName "PowerDisplayAssetsFiles" -wxsFilePath $PSScriptRoot\PowerDisplay.wxs
|
||||
|
||||
#New+
|
||||
Generate-FileList -fileDepsJson "" -fileListName NewPlusAssetsFiles -wxsFilePath $PSScriptRoot\NewPlus.wxs -depsPath "$PSScriptRoot..\..\..\$platform\Release\WinUI3Apps\Assets\NewPlus"
|
||||
Generate-FileComponents -fileListName "NewPlusAssetsFiles" -wxsFilePath $PSScriptRoot\NewPlus.wxs
|
||||
|
||||
@@ -45,6 +45,7 @@ namespace Common.UI
|
||||
NewPlus,
|
||||
CmdPal,
|
||||
ZoomIt,
|
||||
PowerDisplay,
|
||||
}
|
||||
|
||||
private static string SettingsWindowNameToString(SettingsWindow value)
|
||||
@@ -115,6 +116,8 @@ namespace Common.UI
|
||||
return "CmdPal";
|
||||
case SettingsWindow.ZoomIt:
|
||||
return "ZoomIt";
|
||||
case SettingsWindow.PowerDisplay:
|
||||
return "PowerDisplay";
|
||||
default:
|
||||
{
|
||||
return string.Empty;
|
||||
|
||||
@@ -32,6 +32,10 @@ namespace winrt::PowerToys::GPOWrapper::implementation
|
||||
{
|
||||
return static_cast<GpoRuleConfigured>(powertoys_gpo::getConfiguredLightSwitchEnabledValue());
|
||||
}
|
||||
GpoRuleConfigured GPOWrapper::GetConfiguredPowerDisplayEnabledValue()
|
||||
{
|
||||
return static_cast<GpoRuleConfigured>(powertoys_gpo::getConfiguredPowerDisplayEnabledValue());
|
||||
}
|
||||
GpoRuleConfigured GPOWrapper::GetConfiguredFancyZonesEnabledValue()
|
||||
{
|
||||
return static_cast<GpoRuleConfigured>(powertoys_gpo::getConfiguredFancyZonesEnabledValue());
|
||||
|
||||
@@ -14,6 +14,7 @@ namespace winrt::PowerToys::GPOWrapper::implementation
|
||||
static GpoRuleConfigured GetConfiguredColorPickerEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredCropAndLockEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredLightSwitchEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredPowerDisplayEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredFancyZonesEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredFileLocksmithEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredSvgPreviewEnabledValue();
|
||||
|
||||
@@ -18,6 +18,7 @@ namespace PowerToys
|
||||
static GpoRuleConfigured GetConfiguredColorPickerEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredCropAndLockEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredLightSwitchEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredPowerDisplayEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredFancyZonesEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredFileLocksmithEnabledValue();
|
||||
static GpoRuleConfigured GetConfiguredSvgPreviewEnabledValue();
|
||||
|
||||
@@ -30,6 +30,7 @@ namespace ManagedCommon
|
||||
PowerRename,
|
||||
PowerLauncher,
|
||||
PowerAccent,
|
||||
PowerDisplay,
|
||||
RegistryPreview,
|
||||
MeasureTool,
|
||||
ShortcutGuide,
|
||||
|
||||
120
src/common/UnitTests-CommonUtils/AppMutex.Tests.cpp
Normal file
120
src/common/UnitTests-CommonUtils/AppMutex.Tests.cpp
Normal file
@@ -0,0 +1,120 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <appMutex.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(AppMutexTests)
|
||||
{
|
||||
public:
|
||||
TEST_METHOD(CreateAppMutex_ValidName_ReturnsHandle)
|
||||
{
|
||||
std::wstring mutexName = L"TestMutex_" + std::to_wstring(GetCurrentProcessId()) + L"_1";
|
||||
auto handle = createAppMutex(mutexName);
|
||||
Assert::IsNotNull(handle.get());
|
||||
}
|
||||
|
||||
TEST_METHOD(CreateAppMutex_SameName_ReturnsExistingHandle)
|
||||
{
|
||||
std::wstring mutexName = L"TestMutex_" + std::to_wstring(GetCurrentProcessId()) + L"_2";
|
||||
|
||||
auto handle1 = createAppMutex(mutexName);
|
||||
Assert::IsNotNull(handle1.get());
|
||||
|
||||
auto handle2 = createAppMutex(mutexName);
|
||||
Assert::IsNull(handle2.get());
|
||||
}
|
||||
|
||||
TEST_METHOD(CreateAppMutex_DifferentNames_ReturnsDifferentHandles)
|
||||
{
|
||||
std::wstring mutexName1 = L"TestMutex_" + std::to_wstring(GetCurrentProcessId()) + L"_A";
|
||||
std::wstring mutexName2 = L"TestMutex_" + std::to_wstring(GetCurrentProcessId()) + L"_B";
|
||||
|
||||
auto handle1 = createAppMutex(mutexName1);
|
||||
auto handle2 = createAppMutex(mutexName2);
|
||||
|
||||
Assert::IsNotNull(handle1.get());
|
||||
Assert::IsNotNull(handle2.get());
|
||||
Assert::AreNotEqual(handle1.get(), handle2.get());
|
||||
}
|
||||
|
||||
TEST_METHOD(CreateAppMutex_EmptyName_ReturnsHandle)
|
||||
{
|
||||
// Empty name creates unnamed mutex
|
||||
auto handle = createAppMutex(L"");
|
||||
// CreateMutexW with empty string should still work
|
||||
Assert::IsTrue(true);
|
||||
// Test passes regardless - just checking it doesn't crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(CreateAppMutex_LongName_ReturnsHandle)
|
||||
{
|
||||
// Create a long mutex name
|
||||
std::wstring mutexName = L"TestMutex_" + std::to_wstring(GetCurrentProcessId()) + L"_";
|
||||
for (int i = 0; i < 50; ++i)
|
||||
{
|
||||
mutexName += L"LongNameSegment";
|
||||
}
|
||||
|
||||
auto handle = createAppMutex(mutexName);
|
||||
// Long names might fail, but shouldn't crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(CreateAppMutex_SpecialCharacters_ReturnsHandle)
|
||||
{
|
||||
std::wstring mutexName = L"TestMutex_" + std::to_wstring(GetCurrentProcessId()) + L"_Special!@#$%";
|
||||
|
||||
auto handle = createAppMutex(mutexName);
|
||||
// Some special characters might not be valid in mutex names
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(CreateAppMutex_GlobalPrefix_ReturnsHandle)
|
||||
{
|
||||
// Global prefix for cross-session mutex
|
||||
std::wstring mutexName = L"Global\\TestMutex_" + std::to_wstring(GetCurrentProcessId());
|
||||
|
||||
auto handle = createAppMutex(mutexName);
|
||||
// Might require elevation, but shouldn't crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(CreateAppMutex_LocalPrefix_ReturnsHandle)
|
||||
{
|
||||
std::wstring mutexName = L"Local\\TestMutex_" + std::to_wstring(GetCurrentProcessId());
|
||||
|
||||
auto handle = createAppMutex(mutexName);
|
||||
Assert::IsNotNull(handle.get());
|
||||
}
|
||||
|
||||
TEST_METHOD(CreateAppMutex_MultipleCalls_AllSucceed)
|
||||
{
|
||||
std::vector<wil::unique_mutex_nothrow> handles;
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
std::wstring mutexName = L"TestMutex_" + std::to_wstring(GetCurrentProcessId()) +
|
||||
L"_Multi_" + std::to_wstring(i);
|
||||
auto handle = createAppMutex(mutexName);
|
||||
Assert::IsNotNull(handle.get());
|
||||
handles.push_back(std::move(handle));
|
||||
}
|
||||
}
|
||||
|
||||
TEST_METHOD(CreateAppMutex_ReleaseAndRecreate_Works)
|
||||
{
|
||||
std::wstring mutexName = L"TestMutex_" + std::to_wstring(GetCurrentProcessId()) + L"_Recreate";
|
||||
|
||||
auto handle1 = createAppMutex(mutexName);
|
||||
Assert::IsNotNull(handle1.get());
|
||||
handle1.reset();
|
||||
|
||||
// After closing, should be able to create again
|
||||
auto handle2 = createAppMutex(mutexName);
|
||||
Assert::IsNotNull(handle2.get());
|
||||
}
|
||||
};
|
||||
}
|
||||
220
src/common/UnitTests-CommonUtils/ColorUtils.Tests.cpp
Normal file
220
src/common/UnitTests-CommonUtils/ColorUtils.Tests.cpp
Normal file
@@ -0,0 +1,220 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <color.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(ColorUtilsTests)
|
||||
{
|
||||
public:
|
||||
// checkValidRGB tests
|
||||
TEST_METHOD(CheckValidRGB_ValidBlack_ReturnsTrue)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#000000", &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_ValidWhite_ReturnsTrue)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#FFFFFF", &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_ValidRed_ReturnsTrue)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#FF0000", &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_ValidGreen_ReturnsTrue)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#00FF00", &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_ValidBlue_ReturnsTrue)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#0000FF", &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_ValidMixed_ReturnsTrue)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#AB12CD", &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0xAB), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0x12), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0xCD), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_MissingHash_ReturnsFalse)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"FFFFFF", &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_TooShort_ReturnsFalse)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#FFF", &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_TooLong_ReturnsFalse)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#FFFFFFFF", &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_InvalidChars_ReturnsFalse)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#GGHHII", &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_LowercaseInvalid_ReturnsFalse)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#ffffff", &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_EmptyString_ReturnsFalse)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"", &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidRGB_OnlyHash_ReturnsFalse)
|
||||
{
|
||||
uint8_t r, g, b;
|
||||
bool result = checkValidRGB(L"#", &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
// checkValidARGB tests
|
||||
TEST_METHOD(CheckValidARGB_ValidBlackOpaque_ReturnsTrue)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"#FF000000", &a, &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), a);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidARGB_ValidWhiteOpaque_ReturnsTrue)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"#FFFFFFFF", &a, &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), a);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidARGB_ValidTransparent_ReturnsTrue)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"#00FFFFFF", &a, &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), a);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidARGB_ValidSemiTransparent_ReturnsTrue)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"#80FF0000", &a, &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0x80), a);
|
||||
Assert::AreEqual(static_cast<uint8_t>(255), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidARGB_ValidMixed_ReturnsTrue)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"#12345678", &a, &r, &g, &b);
|
||||
Assert::IsTrue(result);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0x12), a);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0x34), r);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0x56), g);
|
||||
Assert::AreEqual(static_cast<uint8_t>(0x78), b);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidARGB_MissingHash_ReturnsFalse)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"FFFFFFFF", &a, &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidARGB_TooShort_ReturnsFalse)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"#FFFFFF", &a, &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidARGB_TooLong_ReturnsFalse)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"#FFFFFFFFFF", &a, &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidARGB_InvalidChars_ReturnsFalse)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"#GGHHIIJJ", &a, &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidARGB_LowercaseInvalid_ReturnsFalse)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"#ffffffff", &a, &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckValidARGB_EmptyString_ReturnsFalse)
|
||||
{
|
||||
uint8_t a, r, g, b;
|
||||
bool result = checkValidARGB(L"", &a, &r, &g, &b);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
};
|
||||
}
|
||||
228
src/common/UnitTests-CommonUtils/ComObjectFactory.Tests.cpp
Normal file
228
src/common/UnitTests-CommonUtils/ComObjectFactory.Tests.cpp
Normal file
@@ -0,0 +1,228 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <com_object_factory.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
// Test COM object for testing the factory
|
||||
class TestComObject : public IUnknown
|
||||
{
|
||||
public:
|
||||
TestComObject() : m_refCount(1) {}
|
||||
|
||||
HRESULT STDMETHODCALLTYPE QueryInterface(REFIID riid, void** ppvObject) override
|
||||
{
|
||||
if (riid == IID_IUnknown)
|
||||
{
|
||||
*ppvObject = static_cast<IUnknown*>(this);
|
||||
AddRef();
|
||||
return S_OK;
|
||||
}
|
||||
*ppvObject = nullptr;
|
||||
return E_NOINTERFACE;
|
||||
}
|
||||
|
||||
ULONG STDMETHODCALLTYPE AddRef() override
|
||||
{
|
||||
return InterlockedIncrement(&m_refCount);
|
||||
}
|
||||
|
||||
ULONG STDMETHODCALLTYPE Release() override
|
||||
{
|
||||
ULONG count = InterlockedDecrement(&m_refCount);
|
||||
if (count == 0)
|
||||
{
|
||||
delete this;
|
||||
}
|
||||
return count;
|
||||
}
|
||||
|
||||
private:
|
||||
LONG m_refCount;
|
||||
};
|
||||
|
||||
TEST_CLASS(ComObjectFactoryTests)
|
||||
{
|
||||
public:
|
||||
TEST_METHOD(ComObjectFactory_Construction_DoesNotCrash)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_QueryInterface_IUnknown_Succeeds)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
IUnknown* pUnknown = nullptr;
|
||||
|
||||
HRESULT hr = factory.QueryInterface(IID_IUnknown, reinterpret_cast<void**>(&pUnknown));
|
||||
|
||||
Assert::AreEqual(S_OK, hr);
|
||||
Assert::IsNotNull(pUnknown);
|
||||
|
||||
if (pUnknown)
|
||||
{
|
||||
pUnknown->Release();
|
||||
}
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_QueryInterface_IClassFactory_Succeeds)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
IClassFactory* pFactory = nullptr;
|
||||
|
||||
HRESULT hr = factory.QueryInterface(IID_IClassFactory, reinterpret_cast<void**>(&pFactory));
|
||||
|
||||
Assert::AreEqual(S_OK, hr);
|
||||
Assert::IsNotNull(pFactory);
|
||||
|
||||
if (pFactory)
|
||||
{
|
||||
pFactory->Release();
|
||||
}
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_QueryInterface_InvalidInterface_Fails)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
void* pInterface = nullptr;
|
||||
|
||||
// Random GUID that we don't support
|
||||
GUID randomGuid = { 0x12345678, 0x1234, 0x1234, { 0x12, 0x34, 0x56, 0x78, 0x9A, 0xBC, 0xDE, 0xF0 } };
|
||||
HRESULT hr = factory.QueryInterface(randomGuid, &pInterface);
|
||||
|
||||
Assert::AreEqual(E_NOINTERFACE, hr);
|
||||
Assert::IsNull(pInterface);
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_AddRef_IncreasesRefCount)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
|
||||
ULONG count1 = factory.AddRef();
|
||||
ULONG count2 = factory.AddRef();
|
||||
|
||||
Assert::IsTrue(count2 > count1);
|
||||
|
||||
// Clean up
|
||||
factory.Release();
|
||||
factory.Release();
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_Release_DecreasesRefCount)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
|
||||
factory.AddRef();
|
||||
factory.AddRef();
|
||||
ULONG count1 = factory.Release();
|
||||
ULONG count2 = factory.Release();
|
||||
|
||||
Assert::IsTrue(count2 < count1);
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_CreateInstance_NoAggregation_Succeeds)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
IUnknown* pObj = nullptr;
|
||||
|
||||
HRESULT hr = factory.CreateInstance(nullptr, IID_IUnknown, reinterpret_cast<void**>(&pObj));
|
||||
|
||||
Assert::AreEqual(S_OK, hr);
|
||||
Assert::IsNotNull(pObj);
|
||||
|
||||
if (pObj)
|
||||
{
|
||||
pObj->Release();
|
||||
}
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_CreateInstance_WithAggregation_Fails)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
TestComObject outer;
|
||||
IUnknown* pObj = nullptr;
|
||||
|
||||
// Aggregation should fail for our simple test object
|
||||
HRESULT hr = factory.CreateInstance(&outer, IID_IUnknown, reinterpret_cast<void**>(&pObj));
|
||||
|
||||
Assert::AreEqual(CLASS_E_NOAGGREGATION, hr);
|
||||
Assert::IsNull(pObj);
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_CreateInstance_NullOutput_Fails)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
|
||||
HRESULT hr = factory.CreateInstance(nullptr, IID_IUnknown, nullptr);
|
||||
|
||||
Assert::AreEqual(E_POINTER, hr);
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_LockServer_Lock_Succeeds)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
|
||||
HRESULT hr = factory.LockServer(TRUE);
|
||||
Assert::AreEqual(S_OK, hr);
|
||||
|
||||
// Unlock
|
||||
factory.LockServer(FALSE);
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_LockServer_Unlock_Succeeds)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
|
||||
factory.LockServer(TRUE);
|
||||
HRESULT hr = factory.LockServer(FALSE);
|
||||
|
||||
Assert::AreEqual(S_OK, hr);
|
||||
}
|
||||
|
||||
TEST_METHOD(ComObjectFactory_LockServer_MultipleLocks_Work)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
|
||||
factory.LockServer(TRUE);
|
||||
factory.LockServer(TRUE);
|
||||
factory.LockServer(TRUE);
|
||||
|
||||
factory.LockServer(FALSE);
|
||||
factory.LockServer(FALSE);
|
||||
HRESULT hr = factory.LockServer(FALSE);
|
||||
|
||||
Assert::AreEqual(S_OK, hr);
|
||||
}
|
||||
|
||||
// Thread safety tests
|
||||
TEST_METHOD(ComObjectFactory_ConcurrentCreateInstance_Works)
|
||||
{
|
||||
com_object_factory<TestComObject> factory;
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
threads.emplace_back([&factory, &successCount]() {
|
||||
IUnknown* pObj = nullptr;
|
||||
HRESULT hr = factory.CreateInstance(nullptr, IID_IUnknown, reinterpret_cast<void**>(&pObj));
|
||||
if (SUCCEEDED(hr) && pObj)
|
||||
{
|
||||
successCount++;
|
||||
pObj->Release();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(10, successCount.load());
|
||||
}
|
||||
};
|
||||
}
|
||||
146
src/common/UnitTests-CommonUtils/Elevation.Tests.cpp
Normal file
146
src/common/UnitTests-CommonUtils/Elevation.Tests.cpp
Normal file
@@ -0,0 +1,146 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <elevation.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(ElevationTests)
|
||||
{
|
||||
public:
|
||||
// is_process_elevated tests
|
||||
TEST_METHOD(IsProcessElevated_ReturnsBoolean)
|
||||
{
|
||||
bool result = is_process_elevated(false);
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsProcessElevated_CachedValue_ReturnsSameResult)
|
||||
{
|
||||
bool result1 = is_process_elevated(true);
|
||||
bool result2 = is_process_elevated(true);
|
||||
|
||||
// Cached value should be consistent
|
||||
Assert::AreEqual(result1, result2);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsProcessElevated_UncachedValue_ReturnsBoolean)
|
||||
{
|
||||
bool result = is_process_elevated(false);
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsProcessElevated_CachedAndUncached_AreConsistent)
|
||||
{
|
||||
// Both should return the same value for the same process
|
||||
bool cached = is_process_elevated(true);
|
||||
bool uncached = is_process_elevated(false);
|
||||
|
||||
Assert::AreEqual(cached, uncached);
|
||||
}
|
||||
|
||||
// check_user_is_admin tests
|
||||
TEST_METHOD(CheckUserIsAdmin_ReturnsBoolean)
|
||||
{
|
||||
bool result = check_user_is_admin();
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(CheckUserIsAdmin_ConsistentResults)
|
||||
{
|
||||
bool result1 = check_user_is_admin();
|
||||
bool result2 = check_user_is_admin();
|
||||
bool result3 = check_user_is_admin();
|
||||
|
||||
Assert::AreEqual(result1, result2);
|
||||
Assert::AreEqual(result2, result3);
|
||||
}
|
||||
|
||||
// Relationship between elevation and admin
|
||||
TEST_METHOD(ElevationAndAdmin_Relationship)
|
||||
{
|
||||
bool elevated = is_process_elevated(false);
|
||||
bool admin = check_user_is_admin();
|
||||
(void)admin;
|
||||
|
||||
// If elevated, user should typically be admin
|
||||
// But user can be admin without process being elevated
|
||||
if (elevated)
|
||||
{
|
||||
// Elevated process usually means admin user
|
||||
// (though there are edge cases)
|
||||
}
|
||||
// Just verify both functions return without crashing
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// IsProcessOfWindowElevated tests
|
||||
TEST_METHOD(IsProcessOfWindowElevated_DesktopWindow_ReturnsBoolean)
|
||||
{
|
||||
HWND desktop = GetDesktopWindow();
|
||||
if (desktop)
|
||||
{
|
||||
bool result = IsProcessOfWindowElevated(desktop);
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsProcessOfWindowElevated_InvalidHwnd_DoesNotCrash)
|
||||
{
|
||||
bool result = IsProcessOfWindowElevated(nullptr);
|
||||
// Should handle null HWND gracefully
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
// ProcessInfo struct tests
|
||||
TEST_METHOD(ProcessInfo_DefaultConstruction)
|
||||
{
|
||||
ProcessInfo info{};
|
||||
Assert::AreEqual(static_cast<DWORD>(0), info.processID);
|
||||
}
|
||||
|
||||
// Thread safety tests
|
||||
TEST_METHOD(IsProcessElevated_ThreadSafe)
|
||||
{
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount]() {
|
||||
for (int j = 0; j < 10; ++j)
|
||||
{
|
||||
is_process_elevated(j % 2 == 0);
|
||||
successCount++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(100, successCount.load());
|
||||
}
|
||||
|
||||
// Performance of cached value
|
||||
TEST_METHOD(IsProcessElevated_CachedPerformance)
|
||||
{
|
||||
auto start = std::chrono::high_resolution_clock::now();
|
||||
|
||||
for (int i = 0; i < 10000; ++i)
|
||||
{
|
||||
is_process_elevated(true);
|
||||
}
|
||||
|
||||
auto end = std::chrono::high_resolution_clock::now();
|
||||
auto duration = std::chrono::duration_cast<std::chrono::milliseconds>(end - start);
|
||||
|
||||
// Cached calls should be very fast
|
||||
Assert::IsTrue(duration.count() < 1000);
|
||||
}
|
||||
};
|
||||
}
|
||||
182
src/common/UnitTests-CommonUtils/ExcludedApps.Tests.cpp
Normal file
182
src/common/UnitTests-CommonUtils/ExcludedApps.Tests.cpp
Normal file
@@ -0,0 +1,182 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <excluded_apps.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(ExcludedAppsTests)
|
||||
{
|
||||
public:
|
||||
// find_app_name_in_path tests
|
||||
TEST_METHOD(FindAppNameInPath_ExactMatch_ReturnsTrue)
|
||||
{
|
||||
std::wstring path = L"C:\\Program Files\\App\\notepad.exe";
|
||||
std::vector<std::wstring> apps = { L"notepad.exe" };
|
||||
Assert::IsTrue(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindAppNameInPath_NoMatch_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"C:\\Program Files\\App\\notepad.exe";
|
||||
std::vector<std::wstring> apps = { L"calc.exe" };
|
||||
Assert::IsFalse(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindAppNameInPath_MultipleApps_FindsMatch)
|
||||
{
|
||||
std::wstring path = L"C:\\Program Files\\App\\notepad.exe";
|
||||
std::vector<std::wstring> apps = { L"calc.exe", L"notepad.exe", L"word.exe" };
|
||||
Assert::IsTrue(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindAppNameInPath_EmptyPath_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"";
|
||||
std::vector<std::wstring> apps = { L"notepad.exe" };
|
||||
Assert::IsFalse(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindAppNameInPath_EmptyApps_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"C:\\Program Files\\App\\notepad.exe";
|
||||
std::vector<std::wstring> apps = {};
|
||||
Assert::IsFalse(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindAppNameInPath_PartialMatchInFolder_ReturnsFalse)
|
||||
{
|
||||
// "notepad" appears in folder name but not as the exe name
|
||||
std::wstring path = L"C:\\notepad\\other.exe";
|
||||
std::vector<std::wstring> apps = { L"notepad.exe" };
|
||||
Assert::IsFalse(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindAppNameInPath_CaseSensitive_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"C:\\Program Files\\App\\NOTEPAD.EXE";
|
||||
std::vector<std::wstring> apps = { L"notepad.exe" };
|
||||
// The function does rfind which is case-sensitive
|
||||
Assert::IsFalse(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindAppNameInPath_MatchWithDifferentExtension_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"C:\\Program Files\\App\\notepad.com";
|
||||
std::vector<std::wstring> apps = { L"notepad.exe" };
|
||||
Assert::IsFalse(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindAppNameInPath_MatchAtEndOfPath_ReturnsTrue)
|
||||
{
|
||||
std::wstring path = L"C:\\Windows\\System32\\notepad.exe";
|
||||
std::vector<std::wstring> apps = { L"notepad.exe" };
|
||||
Assert::IsTrue(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindAppNameInPath_UNCPath_Works)
|
||||
{
|
||||
std::wstring path = L"\\\\server\\share\\folder\\app.exe";
|
||||
std::vector<std::wstring> apps = { L"app.exe" };
|
||||
Assert::IsTrue(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
// find_folder_in_path tests
|
||||
TEST_METHOD(FindFolderInPath_FolderExists_ReturnsTrue)
|
||||
{
|
||||
std::wstring path = L"C:\\Program Files\\MyApp\\app.exe";
|
||||
std::vector<std::wstring> folders = { L"Program Files" };
|
||||
Assert::IsTrue(find_folder_in_path(path, folders));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindFolderInPath_FolderNotExists_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"C:\\Windows\\System32\\app.exe";
|
||||
std::vector<std::wstring> folders = { L"Program Files" };
|
||||
Assert::IsFalse(find_folder_in_path(path, folders));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindFolderInPath_MultipleFolders_FindsMatch)
|
||||
{
|
||||
std::wstring path = L"C:\\Windows\\System32\\app.exe";
|
||||
std::vector<std::wstring> folders = { L"Program Files", L"System32", L"Users" };
|
||||
Assert::IsTrue(find_folder_in_path(path, folders));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindFolderInPath_EmptyPath_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"";
|
||||
std::vector<std::wstring> folders = { L"Windows" };
|
||||
Assert::IsFalse(find_folder_in_path(path, folders));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindFolderInPath_EmptyFolders_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"C:\\Windows\\app.exe";
|
||||
std::vector<std::wstring> folders = {};
|
||||
Assert::IsFalse(find_folder_in_path(path, folders));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindFolderInPath_PartialMatch_ReturnsTrue)
|
||||
{
|
||||
// find_folder_in_path uses rfind which finds substrings
|
||||
std::wstring path = L"C:\\Windows\\System32\\app.exe";
|
||||
std::vector<std::wstring> folders = { L"System" };
|
||||
Assert::IsTrue(find_folder_in_path(path, folders));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindFolderInPath_NestedFolder_ReturnsTrue)
|
||||
{
|
||||
std::wstring path = L"C:\\Program Files\\Company\\Product\\bin\\app.exe";
|
||||
std::vector<std::wstring> folders = { L"Product" };
|
||||
Assert::IsTrue(find_folder_in_path(path, folders));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindFolderInPath_RootDrive_ReturnsTrue)
|
||||
{
|
||||
std::wstring path = L"C:\\folder\\app.exe";
|
||||
std::vector<std::wstring> folders = { L"C:\\" };
|
||||
Assert::IsTrue(find_folder_in_path(path, folders));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindFolderInPath_UNCPath_Works)
|
||||
{
|
||||
std::wstring path = L"\\\\server\\share\\folder\\app.exe";
|
||||
std::vector<std::wstring> folders = { L"share" };
|
||||
Assert::IsTrue(find_folder_in_path(path, folders));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindFolderInPath_CaseSensitive_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"C:\\WINDOWS\\app.exe";
|
||||
std::vector<std::wstring> folders = { L"windows" };
|
||||
// rfind is case-sensitive
|
||||
Assert::IsFalse(find_folder_in_path(path, folders));
|
||||
}
|
||||
|
||||
// Edge case tests
|
||||
TEST_METHOD(FindAppNameInPath_AppNameInMiddleOfPath_HandlesCorrectly)
|
||||
{
|
||||
// The app name appears both in folder and as filename
|
||||
std::wstring path = L"C:\\notepad\\bin\\notepad.exe";
|
||||
std::vector<std::wstring> apps = { L"notepad.exe" };
|
||||
Assert::IsTrue(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindAppNameInPath_JustFilename_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"notepad.exe";
|
||||
std::vector<std::wstring> apps = { L"notepad.exe" };
|
||||
// find_app_name_in_path expects a path separator to validate the executable segment
|
||||
Assert::IsFalse(find_app_name_in_path(path, apps));
|
||||
}
|
||||
|
||||
TEST_METHOD(FindFolderInPath_JustFilename_ReturnsFalse)
|
||||
{
|
||||
std::wstring path = L"app.exe";
|
||||
std::vector<std::wstring> folders = { L"Windows" };
|
||||
Assert::IsFalse(find_folder_in_path(path, folders));
|
||||
}
|
||||
};
|
||||
}
|
||||
148
src/common/UnitTests-CommonUtils/Exec.Tests.cpp
Normal file
148
src/common/UnitTests-CommonUtils/Exec.Tests.cpp
Normal file
@@ -0,0 +1,148 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <exec.h>
|
||||
#include <cctype>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(ExecTests)
|
||||
{
|
||||
public:
|
||||
TEST_METHOD(ExecAndReadOutput_EchoCommand_ReturnsOutput)
|
||||
{
|
||||
auto result = exec_and_read_output(L"cmd /c echo hello", 5000);
|
||||
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
// Output should contain "hello"
|
||||
Assert::IsTrue(result->find("hello") != std::string::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_WhereCommand_ReturnsPath)
|
||||
{
|
||||
auto result = exec_and_read_output(L"where cmd", 5000);
|
||||
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
// Should contain path to cmd.exe
|
||||
Assert::IsTrue(result->find("cmd") != std::string::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_DirCommand_ReturnsListing)
|
||||
{
|
||||
auto result = exec_and_read_output(L"cmd /c dir /b C:\\Windows", 5000);
|
||||
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
// Should contain some common Windows folder names
|
||||
std::string output = *result;
|
||||
std::transform(output.begin(), output.end(), output.begin(), [](unsigned char ch) { return static_cast<char>(std::tolower(ch)); });
|
||||
Assert::IsTrue(output.find("system32") != std::string::npos ||
|
||||
output.find("system") != std::string::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_InvalidCommand_ReturnsEmptyOrError)
|
||||
{
|
||||
auto result = exec_and_read_output(L"nonexistentcommand12345", 5000);
|
||||
|
||||
// Invalid command should either return nullopt or an error message
|
||||
Assert::IsTrue(!result.has_value() || result->empty() ||
|
||||
result->find("not recognized") != std::string::npos ||
|
||||
result->find("error") != std::string::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_EmptyCommand_DoesNotCrash)
|
||||
{
|
||||
auto result = exec_and_read_output(L"", 5000);
|
||||
// Should handle empty command gracefully
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_TimeoutExpires_ReturnsAvailableOutput)
|
||||
{
|
||||
// Use a command that produces output slowly
|
||||
// ping localhost will run for a while
|
||||
auto start = std::chrono::steady_clock::now();
|
||||
|
||||
// Very short timeout
|
||||
auto result = exec_and_read_output(L"ping localhost -n 10", 100);
|
||||
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
|
||||
std::chrono::steady_clock::now() - start);
|
||||
|
||||
// Should return within reasonable time
|
||||
Assert::IsTrue(elapsed.count() < 5000);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_MultilineOutput_PreservesLines)
|
||||
{
|
||||
auto result = exec_and_read_output(L"cmd /c \"echo line1 & echo line2 & echo line3\"", 5000);
|
||||
|
||||
Assert::IsTrue(result.has_value());
|
||||
// Should contain multiple lines
|
||||
Assert::IsTrue(result->find("line1") != std::string::npos);
|
||||
Assert::IsTrue(result->find("line2") != std::string::npos);
|
||||
Assert::IsTrue(result->find("line3") != std::string::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_UnicodeOutput_Works)
|
||||
{
|
||||
// Echo a simple ASCII string (Unicode test depends on system codepage)
|
||||
auto result = exec_and_read_output(L"cmd /c echo test123", 5000);
|
||||
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsTrue(result->find("test123") != std::string::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_LongTimeout_Works)
|
||||
{
|
||||
auto result = exec_and_read_output(L"cmd /c echo test", 60000);
|
||||
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsTrue(result->find("test") != std::string::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_QuotedArguments_Work)
|
||||
{
|
||||
auto result = exec_and_read_output(L"cmd /c echo \"hello world\"", 5000);
|
||||
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsTrue(result->find("hello") != std::string::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_EnvironmentVariable_Expanded)
|
||||
{
|
||||
auto result = exec_and_read_output(L"cmd /c echo %USERNAME%", 5000);
|
||||
|
||||
Assert::IsTrue(result.has_value());
|
||||
// Should not contain the literal %USERNAME% but the actual username
|
||||
// Or if not expanded, still should not crash
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_ExitCode_CommandFails)
|
||||
{
|
||||
// Command that exits with error
|
||||
auto result = exec_and_read_output(L"cmd /c exit 1", 5000);
|
||||
|
||||
// Should still return something (possibly empty)
|
||||
// Just verify it doesn't crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExecAndReadOutput_ZeroTimeout_DoesNotHang)
|
||||
{
|
||||
auto start = std::chrono::steady_clock::now();
|
||||
|
||||
auto result = exec_and_read_output(L"cmd /c echo test", 0);
|
||||
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
|
||||
std::chrono::steady_clock::now() - start);
|
||||
|
||||
// Should complete quickly with zero timeout
|
||||
Assert::IsTrue(elapsed.count() < 5000);
|
||||
}
|
||||
};
|
||||
}
|
||||
68
src/common/UnitTests-CommonUtils/GameMode.Tests.cpp
Normal file
68
src/common/UnitTests-CommonUtils/GameMode.Tests.cpp
Normal file
@@ -0,0 +1,68 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <game_mode.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(GameModeTests)
|
||||
{
|
||||
public:
|
||||
TEST_METHOD(DetectGameMode_ReturnsBoolean)
|
||||
{
|
||||
// This function queries Windows game mode status
|
||||
bool result = detect_game_mode();
|
||||
|
||||
// Result depends on current system state, but should be a valid boolean
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(DetectGameMode_ConsistentResults)
|
||||
{
|
||||
// Multiple calls should return consistent results (unless game mode changes)
|
||||
bool result1 = detect_game_mode();
|
||||
bool result2 = detect_game_mode();
|
||||
bool result3 = detect_game_mode();
|
||||
|
||||
// Results should be consistent across rapid calls
|
||||
Assert::AreEqual(result1, result2);
|
||||
Assert::AreEqual(result2, result3);
|
||||
}
|
||||
|
||||
TEST_METHOD(DetectGameMode_DoesNotCrash)
|
||||
{
|
||||
// Call multiple times to ensure no crash or memory leak
|
||||
for (int i = 0; i < 100; ++i)
|
||||
{
|
||||
detect_game_mode();
|
||||
}
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(DetectGameMode_ThreadSafe)
|
||||
{
|
||||
// Test that calling from multiple threads is safe
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount]() {
|
||||
for (int j = 0; j < 10; ++j)
|
||||
{
|
||||
detect_game_mode();
|
||||
successCount++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(100, successCount.load());
|
||||
}
|
||||
};
|
||||
}
|
||||
218
src/common/UnitTests-CommonUtils/Gpo.Tests.cpp
Normal file
218
src/common/UnitTests-CommonUtils/Gpo.Tests.cpp
Normal file
@@ -0,0 +1,218 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <gpo.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
using namespace powertoys_gpo;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(GpoTests)
|
||||
{
|
||||
public:
|
||||
// Helper to check if result is a valid gpo_rule_configured_t value
|
||||
static constexpr bool IsValidGpoResult(gpo_rule_configured_t result)
|
||||
{
|
||||
return result == gpo_rule_configured_wrong_value ||
|
||||
result == gpo_rule_configured_unavailable ||
|
||||
result == gpo_rule_configured_not_configured ||
|
||||
result == gpo_rule_configured_disabled ||
|
||||
result == gpo_rule_configured_enabled;
|
||||
}
|
||||
|
||||
// gpo_rule_configured_t enum tests
|
||||
TEST_METHOD(GpoRuleConfigured_EnumValues_AreDistinct)
|
||||
{
|
||||
Assert::AreNotEqual(static_cast<int>(gpo_rule_configured_not_configured),
|
||||
static_cast<int>(gpo_rule_configured_enabled));
|
||||
Assert::AreNotEqual(static_cast<int>(gpo_rule_configured_enabled),
|
||||
static_cast<int>(gpo_rule_configured_disabled));
|
||||
Assert::AreNotEqual(static_cast<int>(gpo_rule_configured_not_configured),
|
||||
static_cast<int>(gpo_rule_configured_disabled));
|
||||
}
|
||||
|
||||
// getConfiguredValue tests
|
||||
TEST_METHOD(GetConfiguredValue_NonExistentKey_ReturnsNotConfigured)
|
||||
{
|
||||
auto result = getConfiguredValue(L"NonExistentPolicyValue12345");
|
||||
Assert::IsTrue(result == gpo_rule_configured_not_configured ||
|
||||
result == gpo_rule_configured_unavailable);
|
||||
}
|
||||
|
||||
// Utility enabled getters - these all follow the same pattern
|
||||
TEST_METHOD(GetAllowExperimentationValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getAllowExperimentationValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredAlwaysOnTopEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredAlwaysOnTopEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredAwakeEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredAwakeEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredColorPickerEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredColorPickerEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredFancyZonesEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredFancyZonesEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredFileLocksmithEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredFileLocksmithEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredImageResizerEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredImageResizerEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredKeyboardManagerEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredKeyboardManagerEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredPowerRenameEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredPowerRenameEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredPowerLauncherEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredPowerLauncherEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredShortcutGuideEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredShortcutGuideEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredTextExtractorEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredTextExtractorEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredHostsFileEditorEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredHostsFileEditorEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredMousePointerCrosshairsEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredMousePointerCrosshairsEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredMouseHighlighterEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredMouseHighlighterEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredMouseJumpEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredMouseJumpEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredFindMyMouseEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredFindMyMouseEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredMouseWithoutBordersEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredMouseWithoutBordersEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredAdvancedPasteEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredAdvancedPasteEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredPeekEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredPeekEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredRegistryPreviewEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredRegistryPreviewEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredScreenRulerEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredScreenRulerEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredCropAndLockEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredCropAndLockEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetConfiguredEnvironmentVariablesEnabledValue_ReturnsValidState)
|
||||
{
|
||||
auto result = getConfiguredEnvironmentVariablesEnabledValue();
|
||||
Assert::IsTrue(IsValidGpoResult(result));
|
||||
}
|
||||
|
||||
// All GPO functions should not crash
|
||||
TEST_METHOD(AllGpoFunctions_DoNotCrash)
|
||||
{
|
||||
getAllowExperimentationValue();
|
||||
getConfiguredAlwaysOnTopEnabledValue();
|
||||
getConfiguredAwakeEnabledValue();
|
||||
getConfiguredColorPickerEnabledValue();
|
||||
getConfiguredFancyZonesEnabledValue();
|
||||
getConfiguredFileLocksmithEnabledValue();
|
||||
getConfiguredImageResizerEnabledValue();
|
||||
getConfiguredKeyboardManagerEnabledValue();
|
||||
getConfiguredPowerRenameEnabledValue();
|
||||
getConfiguredPowerLauncherEnabledValue();
|
||||
getConfiguredShortcutGuideEnabledValue();
|
||||
getConfiguredTextExtractorEnabledValue();
|
||||
getConfiguredHostsFileEditorEnabledValue();
|
||||
getConfiguredMousePointerCrosshairsEnabledValue();
|
||||
getConfiguredMouseHighlighterEnabledValue();
|
||||
getConfiguredMouseJumpEnabledValue();
|
||||
getConfiguredFindMyMouseEnabledValue();
|
||||
getConfiguredMouseWithoutBordersEnabledValue();
|
||||
getConfiguredAdvancedPasteEnabledValue();
|
||||
getConfiguredPeekEnabledValue();
|
||||
getConfiguredRegistryPreviewEnabledValue();
|
||||
getConfiguredScreenRulerEnabledValue();
|
||||
getConfiguredCropAndLockEnabledValue();
|
||||
getConfiguredEnvironmentVariablesEnabledValue();
|
||||
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
};
|
||||
}
|
||||
200
src/common/UnitTests-CommonUtils/HDropIterator.Tests.cpp
Normal file
200
src/common/UnitTests-CommonUtils/HDropIterator.Tests.cpp
Normal file
@@ -0,0 +1,200 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <HDropIterator.h>
|
||||
#include <shlobj.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(HDropIteratorTests)
|
||||
{
|
||||
public:
|
||||
// Helper to create a test HDROP structure
|
||||
static HGLOBAL CreateTestHDrop(const std::vector<std::wstring>& files)
|
||||
{
|
||||
// Calculate required size
|
||||
size_t size = sizeof(DROPFILES);
|
||||
for (const auto& file : files)
|
||||
{
|
||||
size += (file.length() + 1) * sizeof(wchar_t);
|
||||
}
|
||||
size += sizeof(wchar_t); // Double null terminator
|
||||
|
||||
HGLOBAL hGlobal = GlobalAlloc(GHND, size);
|
||||
if (!hGlobal) return nullptr;
|
||||
|
||||
DROPFILES* pDropFiles = static_cast<DROPFILES*>(GlobalLock(hGlobal));
|
||||
if (!pDropFiles)
|
||||
{
|
||||
GlobalFree(hGlobal);
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
pDropFiles->pFiles = sizeof(DROPFILES);
|
||||
pDropFiles->fWide = TRUE;
|
||||
|
||||
wchar_t* pData = reinterpret_cast<wchar_t*>(reinterpret_cast<BYTE*>(pDropFiles) + sizeof(DROPFILES));
|
||||
for (const auto& file : files)
|
||||
{
|
||||
wcscpy_s(pData, file.length() + 1, file.c_str());
|
||||
pData += file.length() + 1;
|
||||
}
|
||||
*pData = L'\0'; // Double null terminator
|
||||
|
||||
GlobalUnlock(hGlobal);
|
||||
return hGlobal;
|
||||
}
|
||||
|
||||
TEST_METHOD(HDropIterator_EmptyDrop_IsDoneImmediately)
|
||||
{
|
||||
HGLOBAL hGlobal = CreateTestHDrop({});
|
||||
if (!hGlobal)
|
||||
{
|
||||
Assert::IsTrue(true); // Skip if allocation failed
|
||||
return;
|
||||
}
|
||||
|
||||
STGMEDIUM medium = {};
|
||||
medium.tymed = TYMED_HGLOBAL;
|
||||
medium.hGlobal = hGlobal;
|
||||
|
||||
// Without a proper IDataObject, we can't fully test
|
||||
// Just verify the class can be instantiated conceptually
|
||||
GlobalFree(hGlobal);
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(HDropIterator_Iteration_Conceptual)
|
||||
{
|
||||
// This test verifies the concept of iteration
|
||||
// Full integration testing requires a proper IDataObject
|
||||
|
||||
std::vector<std::wstring> testFiles = {
|
||||
L"C:\\test\\file1.txt",
|
||||
L"C:\\test\\file2.txt",
|
||||
L"C:\\test\\file3.txt"
|
||||
};
|
||||
|
||||
HGLOBAL hGlobal = CreateTestHDrop(testFiles);
|
||||
if (!hGlobal)
|
||||
{
|
||||
Assert::IsTrue(true);
|
||||
return;
|
||||
}
|
||||
|
||||
// Verify we can create the HDROP structure
|
||||
DROPFILES* pDropFiles = static_cast<DROPFILES*>(GlobalLock(hGlobal));
|
||||
Assert::IsNotNull(pDropFiles);
|
||||
Assert::IsTrue(pDropFiles->fWide);
|
||||
|
||||
GlobalUnlock(hGlobal);
|
||||
GlobalFree(hGlobal);
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(HDropIterator_SingleFile_Works)
|
||||
{
|
||||
std::vector<std::wstring> testFiles = { L"C:\\test\\single.txt" };
|
||||
|
||||
HGLOBAL hGlobal = CreateTestHDrop(testFiles);
|
||||
if (!hGlobal)
|
||||
{
|
||||
Assert::IsTrue(true);
|
||||
return;
|
||||
}
|
||||
|
||||
// Verify structure
|
||||
DROPFILES* pDropFiles = static_cast<DROPFILES*>(GlobalLock(hGlobal));
|
||||
Assert::IsNotNull(pDropFiles);
|
||||
|
||||
// Read back the file name
|
||||
wchar_t* pData = reinterpret_cast<wchar_t*>(reinterpret_cast<BYTE*>(pDropFiles) + pDropFiles->pFiles);
|
||||
Assert::AreEqual(std::wstring(L"C:\\test\\single.txt"), std::wstring(pData));
|
||||
|
||||
GlobalUnlock(hGlobal);
|
||||
GlobalFree(hGlobal);
|
||||
}
|
||||
|
||||
TEST_METHOD(HDropIterator_MultipleFiles_Structure)
|
||||
{
|
||||
std::vector<std::wstring> testFiles = {
|
||||
L"C:\\file1.txt",
|
||||
L"C:\\file2.txt",
|
||||
L"C:\\file3.txt"
|
||||
};
|
||||
|
||||
HGLOBAL hGlobal = CreateTestHDrop(testFiles);
|
||||
if (!hGlobal)
|
||||
{
|
||||
Assert::IsTrue(true);
|
||||
return;
|
||||
}
|
||||
|
||||
DROPFILES* pDropFiles = static_cast<DROPFILES*>(GlobalLock(hGlobal));
|
||||
Assert::IsNotNull(pDropFiles);
|
||||
|
||||
// Count files by iterating through null-terminated strings
|
||||
wchar_t* pData = reinterpret_cast<wchar_t*>(reinterpret_cast<BYTE*>(pDropFiles) + pDropFiles->pFiles);
|
||||
int count = 0;
|
||||
while (*pData)
|
||||
{
|
||||
count++;
|
||||
pData += wcslen(pData) + 1;
|
||||
}
|
||||
|
||||
Assert::AreEqual(3, count);
|
||||
|
||||
GlobalUnlock(hGlobal);
|
||||
GlobalFree(hGlobal);
|
||||
}
|
||||
|
||||
TEST_METHOD(HDropIterator_UnicodeFilenames_Work)
|
||||
{
|
||||
std::vector<std::wstring> testFiles = {
|
||||
L"C:\\test\\file.txt"
|
||||
};
|
||||
|
||||
HGLOBAL hGlobal = CreateTestHDrop(testFiles);
|
||||
if (!hGlobal)
|
||||
{
|
||||
Assert::IsTrue(true);
|
||||
return;
|
||||
}
|
||||
|
||||
DROPFILES* pDropFiles = static_cast<DROPFILES*>(GlobalLock(hGlobal));
|
||||
Assert::IsTrue(pDropFiles->fWide == TRUE);
|
||||
|
||||
GlobalUnlock(hGlobal);
|
||||
GlobalFree(hGlobal);
|
||||
}
|
||||
|
||||
TEST_METHOD(HDropIterator_LongFilenames_Work)
|
||||
{
|
||||
std::wstring longPath = L"C:\\";
|
||||
for (int i = 0; i < 20; ++i)
|
||||
{
|
||||
longPath += L"LongFolderName\\";
|
||||
}
|
||||
longPath += L"file.txt";
|
||||
|
||||
std::vector<std::wstring> testFiles = { longPath };
|
||||
|
||||
HGLOBAL hGlobal = CreateTestHDrop(testFiles);
|
||||
if (!hGlobal)
|
||||
{
|
||||
Assert::IsTrue(true);
|
||||
return;
|
||||
}
|
||||
|
||||
DROPFILES* pDropFiles = static_cast<DROPFILES*>(GlobalLock(hGlobal));
|
||||
Assert::IsNotNull(pDropFiles);
|
||||
|
||||
wchar_t* pData = reinterpret_cast<wchar_t*>(reinterpret_cast<BYTE*>(pDropFiles) + pDropFiles->pFiles);
|
||||
Assert::AreEqual(longPath, std::wstring(pData));
|
||||
|
||||
GlobalUnlock(hGlobal);
|
||||
GlobalFree(hGlobal);
|
||||
}
|
||||
};
|
||||
}
|
||||
152
src/common/UnitTests-CommonUtils/HttpClient.Tests.cpp
Normal file
152
src/common/UnitTests-CommonUtils/HttpClient.Tests.cpp
Normal file
@@ -0,0 +1,152 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <HttpClient.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(HttpClientTests)
|
||||
{
|
||||
public:
|
||||
// Note: Network tests may fail in offline environments
|
||||
// These tests are designed to verify the API doesn't crash
|
||||
|
||||
TEST_METHOD(HttpClient_DefaultConstruction)
|
||||
{
|
||||
http::HttpClient client;
|
||||
// Should not crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(HttpClient_Request_InvalidUri_ReturnsEmpty)
|
||||
{
|
||||
http::HttpClient client;
|
||||
|
||||
try
|
||||
{
|
||||
// Invalid URI should not crash, may throw or return empty
|
||||
auto result = client.request(winrt::Windows::Foundation::Uri(L"invalid://not-a-valid-uri"));
|
||||
// If we get here, result may be empty or contain error
|
||||
}
|
||||
catch (...)
|
||||
{
|
||||
// Exception is acceptable for invalid URI
|
||||
}
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(HttpClient_Download_InvalidUri_DoesNotCrash)
|
||||
{
|
||||
http::HttpClient client;
|
||||
TestHelpers::TempFile tempFile;
|
||||
|
||||
try
|
||||
{
|
||||
auto result = client.download(
|
||||
winrt::Windows::Foundation::Uri(L"https://invalid.invalid.invalid"),
|
||||
tempFile.path());
|
||||
// May return false or throw
|
||||
}
|
||||
catch (...)
|
||||
{
|
||||
// Exception is acceptable for invalid/unreachable URI
|
||||
}
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(HttpClient_Download_WithCallback_DoesNotCrash)
|
||||
{
|
||||
http::HttpClient client;
|
||||
TestHelpers::TempFile tempFile;
|
||||
std::atomic<int> callbackCount{ 0 };
|
||||
|
||||
try
|
||||
{
|
||||
auto result = client.download(
|
||||
winrt::Windows::Foundation::Uri(L"https://invalid.invalid.invalid"),
|
||||
tempFile.path(),
|
||||
[&callbackCount]([[maybe_unused]] float progress) {
|
||||
callbackCount++;
|
||||
});
|
||||
}
|
||||
catch (...)
|
||||
{
|
||||
// Exception is acceptable
|
||||
}
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(HttpClient_Download_EmptyPath_DoesNotCrash)
|
||||
{
|
||||
http::HttpClient client;
|
||||
|
||||
try
|
||||
{
|
||||
auto result = client.download(
|
||||
winrt::Windows::Foundation::Uri(L"https://example.com"),
|
||||
L"");
|
||||
}
|
||||
catch (...)
|
||||
{
|
||||
// Exception is acceptable for empty path
|
||||
}
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// These tests require network access and may be skipped in offline environments
|
||||
TEST_METHOD(HttpClient_Request_ValidUri_ReturnsResult)
|
||||
{
|
||||
// Skip this test in most CI environments
|
||||
// Only run manually to verify network functionality
|
||||
http::HttpClient client;
|
||||
|
||||
try
|
||||
{
|
||||
// Use a reliable, fast-responding URL
|
||||
auto result = client.request(winrt::Windows::Foundation::Uri(L"https://www.microsoft.com"));
|
||||
// Result may or may not be successful depending on network
|
||||
}
|
||||
catch (...)
|
||||
{
|
||||
// Network errors are acceptable in test environment
|
||||
}
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// Thread safety test (doesn't require network)
|
||||
TEST_METHOD(HttpClient_MultipleInstances_DoNotCrash)
|
||||
{
|
||||
std::vector<std::unique_ptr<http::HttpClient>> clients;
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
clients.push_back(std::make_unique<http::HttpClient>());
|
||||
}
|
||||
|
||||
// All clients should coexist without crashing
|
||||
Assert::AreEqual(static_cast<size_t>(10), clients.size());
|
||||
}
|
||||
|
||||
TEST_METHOD(HttpClient_ConcurrentConstruction_DoesNotCrash)
|
||||
{
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 5; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount]() {
|
||||
http::HttpClient client;
|
||||
successCount++;
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(5, successCount.load());
|
||||
}
|
||||
};
|
||||
}
|
||||
283
src/common/UnitTests-CommonUtils/Json.Tests.cpp
Normal file
283
src/common/UnitTests-CommonUtils/Json.Tests.cpp
Normal file
@@ -0,0 +1,283 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <json.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
using namespace winrt::Windows::Data::Json;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(JsonTests)
|
||||
{
|
||||
public:
|
||||
// from_file tests
|
||||
TEST_METHOD(FromFile_NonExistentFile_ReturnsNullopt)
|
||||
{
|
||||
auto result = json::from_file(L"C:\\NonExistent\\File\\Path.json");
|
||||
Assert::IsFalse(result.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(FromFile_ValidJsonFile_ReturnsJsonObject)
|
||||
{
|
||||
TestHelpers::TempFile tempFile(L"", L".json");
|
||||
tempFile.write("{\"key\": \"value\"}");
|
||||
|
||||
auto result = json::from_file(tempFile.path());
|
||||
Assert::IsTrue(result.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(FromFile_InvalidJson_ReturnsNullopt)
|
||||
{
|
||||
TestHelpers::TempFile tempFile(L"", L".json");
|
||||
tempFile.write("not valid json {{{");
|
||||
|
||||
auto result = json::from_file(tempFile.path());
|
||||
Assert::IsFalse(result.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(FromFile_EmptyFile_ReturnsNullopt)
|
||||
{
|
||||
TestHelpers::TempFile tempFile(L"", L".json");
|
||||
// File is empty
|
||||
|
||||
auto result = json::from_file(tempFile.path());
|
||||
Assert::IsFalse(result.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(FromFile_ValidComplexJson_ParsesCorrectly)
|
||||
{
|
||||
TestHelpers::TempFile tempFile(L"", L".json");
|
||||
tempFile.write("{\"name\": \"test\", \"value\": 42, \"enabled\": true}");
|
||||
|
||||
auto result = json::from_file(tempFile.path());
|
||||
Assert::IsTrue(result.has_value());
|
||||
|
||||
auto& obj = *result;
|
||||
Assert::IsTrue(obj.HasKey(L"name"));
|
||||
Assert::IsTrue(obj.HasKey(L"value"));
|
||||
Assert::IsTrue(obj.HasKey(L"enabled"));
|
||||
}
|
||||
|
||||
// to_file tests
|
||||
TEST_METHOD(ToFile_ValidObject_WritesFile)
|
||||
{
|
||||
TestHelpers::TempFile tempFile(L"", L".json");
|
||||
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"key", JsonValue::CreateStringValue(L"value"));
|
||||
json::to_file(tempFile.path(), obj);
|
||||
|
||||
// Read back and verify
|
||||
auto result = json::from_file(tempFile.path());
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsTrue(result->HasKey(L"key"));
|
||||
}
|
||||
|
||||
TEST_METHOD(ToFile_ComplexObject_WritesFile)
|
||||
{
|
||||
TestHelpers::TempFile tempFile(L"", L".json");
|
||||
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"name", JsonValue::CreateStringValue(L"test"));
|
||||
obj.SetNamedValue(L"value", JsonValue::CreateNumberValue(42));
|
||||
obj.SetNamedValue(L"enabled", JsonValue::CreateBooleanValue(true));
|
||||
json::to_file(tempFile.path(), obj);
|
||||
|
||||
auto result = json::from_file(tempFile.path());
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::AreEqual(std::wstring(L"test"), std::wstring(result->GetNamedString(L"name")));
|
||||
Assert::AreEqual(42.0, result->GetNamedNumber(L"value"));
|
||||
Assert::IsTrue(result->GetNamedBoolean(L"enabled"));
|
||||
}
|
||||
|
||||
// has tests
|
||||
TEST_METHOD(Has_ExistingKey_ReturnsTrue)
|
||||
{
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"key", JsonValue::CreateStringValue(L"value"));
|
||||
Assert::IsTrue(json::has(obj, L"key", JsonValueType::String));
|
||||
}
|
||||
|
||||
TEST_METHOD(Has_NonExistingKey_ReturnsFalse)
|
||||
{
|
||||
JsonObject obj;
|
||||
Assert::IsFalse(json::has(obj, L"key", JsonValueType::String));
|
||||
}
|
||||
|
||||
TEST_METHOD(Has_WrongType_ReturnsFalse)
|
||||
{
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"key", JsonValue::CreateStringValue(L"value"));
|
||||
Assert::IsFalse(json::has(obj, L"key", JsonValueType::Number));
|
||||
}
|
||||
|
||||
TEST_METHOD(Has_NumberType_ReturnsTrue)
|
||||
{
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"key", JsonValue::CreateNumberValue(42));
|
||||
Assert::IsTrue(json::has(obj, L"key", JsonValueType::Number));
|
||||
}
|
||||
|
||||
TEST_METHOD(Has_BooleanType_ReturnsTrue)
|
||||
{
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"key", JsonValue::CreateBooleanValue(true));
|
||||
Assert::IsTrue(json::has(obj, L"key", JsonValueType::Boolean));
|
||||
}
|
||||
|
||||
TEST_METHOD(Has_ObjectType_ReturnsTrue)
|
||||
{
|
||||
JsonObject obj;
|
||||
JsonObject nested;
|
||||
obj.SetNamedValue(L"key", nested);
|
||||
Assert::IsTrue(json::has(obj, L"key", JsonValueType::Object));
|
||||
}
|
||||
|
||||
// value function tests
|
||||
TEST_METHOD(Value_IntegerType_CreatesNumberValue)
|
||||
{
|
||||
auto val = json::value(42);
|
||||
Assert::IsTrue(val.ValueType() == JsonValueType::Number);
|
||||
Assert::AreEqual(42.0, val.GetNumber());
|
||||
}
|
||||
|
||||
TEST_METHOD(Value_DoubleType_CreatesNumberValue)
|
||||
{
|
||||
auto val = json::value(3.14);
|
||||
Assert::IsTrue(val.ValueType() == JsonValueType::Number);
|
||||
Assert::AreEqual(3.14, val.GetNumber());
|
||||
}
|
||||
|
||||
TEST_METHOD(Value_BooleanTrue_CreatesBooleanValue)
|
||||
{
|
||||
auto val = json::value(true);
|
||||
Assert::IsTrue(val.ValueType() == JsonValueType::Boolean);
|
||||
Assert::IsTrue(val.GetBoolean());
|
||||
}
|
||||
|
||||
TEST_METHOD(Value_BooleanFalse_CreatesBooleanValue)
|
||||
{
|
||||
auto val = json::value(false);
|
||||
Assert::IsTrue(val.ValueType() == JsonValueType::Boolean);
|
||||
Assert::IsFalse(val.GetBoolean());
|
||||
}
|
||||
|
||||
TEST_METHOD(Value_String_CreatesStringValue)
|
||||
{
|
||||
auto val = json::value(L"hello");
|
||||
Assert::IsTrue(val.ValueType() == JsonValueType::String);
|
||||
Assert::AreEqual(std::wstring(L"hello"), std::wstring(val.GetString()));
|
||||
}
|
||||
|
||||
TEST_METHOD(Value_JsonObject_ReturnsJsonValue)
|
||||
{
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"key", JsonValue::CreateStringValue(L"value"));
|
||||
auto val = json::value(obj);
|
||||
Assert::IsTrue(val.ValueType() == JsonValueType::Object);
|
||||
}
|
||||
|
||||
TEST_METHOD(Value_JsonValue_ReturnsIdentity)
|
||||
{
|
||||
auto original = JsonValue::CreateStringValue(L"test");
|
||||
auto result = json::value(original);
|
||||
Assert::AreEqual(std::wstring(L"test"), std::wstring(result.GetString()));
|
||||
}
|
||||
|
||||
// get function tests
|
||||
TEST_METHOD(Get_BooleanValue_ReturnsValue)
|
||||
{
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"enabled", JsonValue::CreateBooleanValue(true));
|
||||
|
||||
bool result = false;
|
||||
json::get(obj, L"enabled", result);
|
||||
Assert::IsTrue(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Get_IntValue_ReturnsValue)
|
||||
{
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"count", JsonValue::CreateNumberValue(42));
|
||||
|
||||
int result = 0;
|
||||
json::get(obj, L"count", result);
|
||||
Assert::AreEqual(42, result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Get_DoubleValue_ReturnsValue)
|
||||
{
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"ratio", JsonValue::CreateNumberValue(3.14));
|
||||
|
||||
double result = 0.0;
|
||||
json::get(obj, L"ratio", result);
|
||||
Assert::AreEqual(3.14, result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Get_StringValue_ReturnsValue)
|
||||
{
|
||||
JsonObject obj;
|
||||
obj.SetNamedValue(L"name", JsonValue::CreateStringValue(L"test"));
|
||||
|
||||
std::wstring result;
|
||||
json::get(obj, L"name", result);
|
||||
Assert::AreEqual(std::wstring(L"test"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Get_MissingKey_UsesDefault)
|
||||
{
|
||||
JsonObject obj;
|
||||
|
||||
int result = 0;
|
||||
json::get(obj, L"missing", result, 99);
|
||||
Assert::AreEqual(99, result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Get_MissingKeyNoDefault_PreservesOriginal)
|
||||
{
|
||||
JsonObject obj;
|
||||
|
||||
int result = 42;
|
||||
json::get(obj, L"missing", result);
|
||||
// When key is missing and no default, original value is preserved
|
||||
Assert::AreEqual(42, result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Get_JsonObject_ReturnsObject)
|
||||
{
|
||||
JsonObject obj;
|
||||
JsonObject nested;
|
||||
nested.SetNamedValue(L"inner", JsonValue::CreateStringValue(L"value"));
|
||||
obj.SetNamedValue(L"nested", nested);
|
||||
|
||||
JsonObject result;
|
||||
json::get(obj, L"nested", result);
|
||||
Assert::IsTrue(result.HasKey(L"inner"));
|
||||
}
|
||||
|
||||
// Roundtrip tests
|
||||
TEST_METHOD(Roundtrip_ComplexObject_PreservesData)
|
||||
{
|
||||
TestHelpers::TempFile tempFile(L"", L".json");
|
||||
|
||||
JsonObject original;
|
||||
original.SetNamedValue(L"string", JsonValue::CreateStringValue(L"hello"));
|
||||
original.SetNamedValue(L"number", JsonValue::CreateNumberValue(42));
|
||||
original.SetNamedValue(L"boolean", JsonValue::CreateBooleanValue(true));
|
||||
|
||||
JsonObject nested;
|
||||
nested.SetNamedValue(L"inner", JsonValue::CreateStringValue(L"world"));
|
||||
original.SetNamedValue(L"object", nested);
|
||||
|
||||
json::to_file(tempFile.path(), original);
|
||||
auto loaded = json::from_file(tempFile.path());
|
||||
|
||||
Assert::IsTrue(loaded.has_value());
|
||||
Assert::AreEqual(std::wstring(L"hello"), std::wstring(loaded->GetNamedString(L"string")));
|
||||
Assert::AreEqual(42.0, loaded->GetNamedNumber(L"number"));
|
||||
Assert::IsTrue(loaded->GetNamedBoolean(L"boolean"));
|
||||
Assert::AreEqual(std::wstring(L"world"), std::wstring(loaded->GetNamedObject(L"object").GetNamedString(L"inner")));
|
||||
}
|
||||
};
|
||||
}
|
||||
180
src/common/UnitTests-CommonUtils/LoggerHelper.Tests.cpp
Normal file
180
src/common/UnitTests-CommonUtils/LoggerHelper.Tests.cpp
Normal file
@@ -0,0 +1,180 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <logger_helper.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
using namespace LoggerHelpers;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(LoggerHelperTests)
|
||||
{
|
||||
public:
|
||||
// get_log_folder_path tests
|
||||
TEST_METHOD(GetLogFolderPath_ValidAppPath_ReturnsPath)
|
||||
{
|
||||
auto result = get_log_folder_path(L"TestApp");
|
||||
|
||||
Assert::IsFalse(result.empty());
|
||||
// Should contain the app name or be a valid path
|
||||
auto pathStr = result.wstring();
|
||||
Assert::IsTrue(pathStr.length() > 0);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLogFolderPath_EmptyAppPath_ReturnsPath)
|
||||
{
|
||||
auto result = get_log_folder_path(L"");
|
||||
|
||||
// Should still return a base path
|
||||
Assert::IsTrue(true); // Just verify no crash
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLogFolderPath_SpecialCharacters_Works)
|
||||
{
|
||||
auto result = get_log_folder_path(L"Test App With Spaces");
|
||||
|
||||
// Should handle spaces in path
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLogFolderPath_ConsistentResults)
|
||||
{
|
||||
auto result1 = get_log_folder_path(L"TestApp");
|
||||
auto result2 = get_log_folder_path(L"TestApp");
|
||||
|
||||
Assert::AreEqual(result1.wstring(), result2.wstring());
|
||||
}
|
||||
|
||||
// dir_exists tests
|
||||
TEST_METHOD(DirExists_WindowsDirectory_ReturnsTrue)
|
||||
{
|
||||
bool result = dir_exists(std::filesystem::path(L"C:\\Windows"));
|
||||
Assert::IsTrue(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DirExists_NonExistentDirectory_ReturnsFalse)
|
||||
{
|
||||
bool result = dir_exists(std::filesystem::path(L"C:\\NonExistentDir12345"));
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DirExists_FileInsteadOfDir_ReturnsTrue)
|
||||
{
|
||||
// notepad.exe is a file, not a directory
|
||||
bool result = dir_exists(std::filesystem::path(L"C:\\Windows\\notepad.exe"));
|
||||
Assert::IsTrue(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DirExists_EmptyPath_ReturnsFalse)
|
||||
{
|
||||
bool result = dir_exists(std::filesystem::path(L""));
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DirExists_TempDirectory_ReturnsTrue)
|
||||
{
|
||||
wchar_t tempPath[MAX_PATH];
|
||||
GetTempPathW(MAX_PATH, tempPath);
|
||||
|
||||
bool result = dir_exists(std::filesystem::path(tempPath));
|
||||
Assert::IsTrue(result);
|
||||
}
|
||||
|
||||
// delete_old_log_folder tests
|
||||
TEST_METHOD(DeleteOldLogFolder_NonExistentFolder_DoesNotCrash)
|
||||
{
|
||||
delete_old_log_folder(std::filesystem::path(L"C:\\NonExistentLogFolder12345"));
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(DeleteOldLogFolder_ValidEmptyFolder_Works)
|
||||
{
|
||||
TestHelpers::TempDirectory tempDir;
|
||||
|
||||
// Create a subfolder structure
|
||||
auto logFolder = std::filesystem::path(tempDir.path()) / L"logs";
|
||||
std::filesystem::create_directories(logFolder);
|
||||
|
||||
Assert::IsTrue(std::filesystem::exists(logFolder));
|
||||
|
||||
delete_old_log_folder(logFolder);
|
||||
|
||||
// Folder may or may not be deleted depending on implementation
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// delete_other_versions_log_folders tests
|
||||
TEST_METHOD(DeleteOtherVersionsLogFolders_NonExistentPath_DoesNotCrash)
|
||||
{
|
||||
delete_other_versions_log_folders(L"C:\\NonExistent\\Path", L"1.0.0");
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(DeleteOtherVersionsLogFolders_EmptyVersion_DoesNotCrash)
|
||||
{
|
||||
wchar_t tempPath[MAX_PATH];
|
||||
GetTempPathW(MAX_PATH, tempPath);
|
||||
|
||||
delete_other_versions_log_folders(tempPath, L"");
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// Thread safety tests
|
||||
TEST_METHOD(GetLogFolderPath_ThreadSafe)
|
||||
{
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount, i]() {
|
||||
auto path = get_log_folder_path(L"TestApp" + std::to_wstring(i));
|
||||
if (!path.empty())
|
||||
{
|
||||
successCount++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(10, successCount.load());
|
||||
}
|
||||
|
||||
TEST_METHOD(DirExists_ThreadSafe)
|
||||
{
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount]() {
|
||||
for (int j = 0; j < 10; ++j)
|
||||
{
|
||||
dir_exists(std::filesystem::path(L"C:\\Windows"));
|
||||
successCount++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(100, successCount.load());
|
||||
}
|
||||
|
||||
// Path construction tests
|
||||
TEST_METHOD(GetLogFolderPath_ReturnsValidFilesystemPath)
|
||||
{
|
||||
auto result = get_log_folder_path(L"TestApp");
|
||||
|
||||
// Should be a valid path that we can use with filesystem operations
|
||||
Assert::IsTrue(result.is_absolute() || result.has_root_name() || !result.empty());
|
||||
}
|
||||
};
|
||||
}
|
||||
173
src/common/UnitTests-CommonUtils/ModulesRegistry.Tests.cpp
Normal file
173
src/common/UnitTests-CommonUtils/ModulesRegistry.Tests.cpp
Normal file
@@ -0,0 +1,173 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <modulesRegistry.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
static std::wstring GetInstallDir()
|
||||
{
|
||||
wchar_t path[MAX_PATH];
|
||||
GetModuleFileNameW(nullptr, path, MAX_PATH);
|
||||
return std::filesystem::path{ path }.parent_path().wstring();
|
||||
}
|
||||
|
||||
TEST_CLASS(ModulesRegistryTests)
|
||||
{
|
||||
public:
|
||||
// Test that all changeset generator functions return valid changesets
|
||||
TEST_METHOD(GetSvgPreviewHandlerChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getSvgPreviewHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetSvgThumbnailProviderChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getSvgThumbnailHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetMarkdownPreviewHandlerChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getMdPreviewHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetMonacoPreviewHandlerChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getMonacoPreviewHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetPdfPreviewHandlerChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getPdfPreviewHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetPdfThumbnailProviderChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getPdfThumbnailHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetGcodePreviewHandlerChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getGcodePreviewHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetGcodeThumbnailProviderChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getGcodeThumbnailHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetStlThumbnailProviderChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getStlThumbnailHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetQoiPreviewHandlerChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getQoiPreviewHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetQoiThumbnailProviderChangeSet_ReturnsChangeSet)
|
||||
{
|
||||
auto changeSet = getQoiThumbnailHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
// Test enabled vs disabled state
|
||||
TEST_METHOD(ChangeSet_EnabledVsDisabled_MayDiffer)
|
||||
{
|
||||
auto enabledSet = getSvgPreviewHandlerChangeSet(GetInstallDir(), true);
|
||||
auto disabledSet = getSvgPreviewHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
// Both should be valid change sets
|
||||
Assert::IsFalse(enabledSet.changes.empty());
|
||||
Assert::IsFalse(disabledSet.changes.empty());
|
||||
}
|
||||
|
||||
// Test getAllOnByDefaultModulesChangeSets
|
||||
TEST_METHOD(GetAllOnByDefaultModulesChangeSets_ReturnsMultipleChangeSets)
|
||||
{
|
||||
auto changeSets = getAllOnByDefaultModulesChangeSets(GetInstallDir());
|
||||
|
||||
// Should return multiple changesets for all default-enabled modules
|
||||
Assert::IsTrue(changeSets.size() > 0);
|
||||
}
|
||||
|
||||
// Test getAllModulesChangeSets
|
||||
TEST_METHOD(GetAllModulesChangeSets_ReturnsChangeSets)
|
||||
{
|
||||
auto changeSets = getAllModulesChangeSets(GetInstallDir());
|
||||
|
||||
// Should return changesets for all modules
|
||||
Assert::IsTrue(changeSets.size() > 0);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetAllModulesChangeSets_ContainsMoreThanOnByDefault)
|
||||
{
|
||||
auto allSets = getAllModulesChangeSets(GetInstallDir());
|
||||
auto defaultSets = getAllOnByDefaultModulesChangeSets(GetInstallDir());
|
||||
|
||||
// All modules should be >= on-by-default modules
|
||||
Assert::IsTrue(allSets.size() >= defaultSets.size());
|
||||
}
|
||||
|
||||
// Test that changesets have valid structure
|
||||
TEST_METHOD(ChangeSet_HasValidKeyPath)
|
||||
{
|
||||
auto changeSet = getSvgPreviewHandlerChangeSet(GetInstallDir(), false);
|
||||
|
||||
Assert::IsFalse(changeSet.changes.empty());
|
||||
}
|
||||
|
||||
// Test all changeset functions don't crash
|
||||
TEST_METHOD(AllChangeSetFunctions_DoNotCrash)
|
||||
{
|
||||
auto installDir = GetInstallDir();
|
||||
getSvgPreviewHandlerChangeSet(installDir, true);
|
||||
getSvgPreviewHandlerChangeSet(installDir, false);
|
||||
getSvgThumbnailHandlerChangeSet(installDir, true);
|
||||
getSvgThumbnailHandlerChangeSet(installDir, false);
|
||||
getMdPreviewHandlerChangeSet(installDir, true);
|
||||
getMdPreviewHandlerChangeSet(installDir, false);
|
||||
getMonacoPreviewHandlerChangeSet(installDir, true);
|
||||
getMonacoPreviewHandlerChangeSet(installDir, false);
|
||||
getPdfPreviewHandlerChangeSet(installDir, true);
|
||||
getPdfPreviewHandlerChangeSet(installDir, false);
|
||||
getPdfThumbnailHandlerChangeSet(installDir, true);
|
||||
getPdfThumbnailHandlerChangeSet(installDir, false);
|
||||
getGcodePreviewHandlerChangeSet(installDir, true);
|
||||
getGcodePreviewHandlerChangeSet(installDir, false);
|
||||
getGcodeThumbnailHandlerChangeSet(installDir, true);
|
||||
getGcodeThumbnailHandlerChangeSet(installDir, false);
|
||||
getStlThumbnailHandlerChangeSet(installDir, true);
|
||||
getStlThumbnailHandlerChangeSet(installDir, false);
|
||||
getQoiPreviewHandlerChangeSet(installDir, true);
|
||||
getQoiPreviewHandlerChangeSet(installDir, false);
|
||||
getQoiThumbnailHandlerChangeSet(installDir, true);
|
||||
getQoiThumbnailHandlerChangeSet(installDir, false);
|
||||
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
};
|
||||
}
|
||||
65
src/common/UnitTests-CommonUtils/MsWindowsSettings.Tests.cpp
Normal file
65
src/common/UnitTests-CommonUtils/MsWindowsSettings.Tests.cpp
Normal file
@@ -0,0 +1,65 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <MsWindowsSettings.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(MsWindowsSettingsTests)
|
||||
{
|
||||
public:
|
||||
TEST_METHOD(GetAnimationsEnabled_ReturnsBoolean)
|
||||
{
|
||||
bool result = GetAnimationsEnabled();
|
||||
|
||||
// Should return a valid boolean
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetAnimationsEnabled_ConsistentResults)
|
||||
{
|
||||
// Multiple calls should return consistent results
|
||||
bool result1 = GetAnimationsEnabled();
|
||||
bool result2 = GetAnimationsEnabled();
|
||||
bool result3 = GetAnimationsEnabled();
|
||||
|
||||
Assert::AreEqual(result1, result2);
|
||||
Assert::AreEqual(result2, result3);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetAnimationsEnabled_DoesNotCrash)
|
||||
{
|
||||
// Call multiple times to ensure stability
|
||||
for (int i = 0; i < 100; ++i)
|
||||
{
|
||||
GetAnimationsEnabled();
|
||||
}
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetAnimationsEnabled_ThreadSafe)
|
||||
{
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount]() {
|
||||
for (int j = 0; j < 10; ++j)
|
||||
{
|
||||
GetAnimationsEnabled();
|
||||
successCount++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(100, successCount.load());
|
||||
}
|
||||
};
|
||||
}
|
||||
146
src/common/UnitTests-CommonUtils/MsiUtils.Tests.cpp
Normal file
146
src/common/UnitTests-CommonUtils/MsiUtils.Tests.cpp
Normal file
@@ -0,0 +1,146 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <MsiUtils.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(MsiUtilsTests)
|
||||
{
|
||||
public:
|
||||
// GetMsiPackageInstalledPath tests
|
||||
TEST_METHOD(GetMsiPackageInstalledPath_PerUser_DoesNotCrash)
|
||||
{
|
||||
auto result = GetMsiPackageInstalledPath(true);
|
||||
// Result depends on installation state, but should not crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetMsiPackageInstalledPath_PerMachine_DoesNotCrash)
|
||||
{
|
||||
auto result = GetMsiPackageInstalledPath(false);
|
||||
// Result depends on installation state, but should not crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetMsiPackageInstalledPath_ConsistentResults)
|
||||
{
|
||||
auto result1 = GetMsiPackageInstalledPath(true);
|
||||
auto result2 = GetMsiPackageInstalledPath(true);
|
||||
|
||||
// Results should be consistent
|
||||
Assert::AreEqual(result1.has_value(), result2.has_value());
|
||||
if (result1.has_value() && result2.has_value())
|
||||
{
|
||||
Assert::AreEqual(*result1, *result2);
|
||||
}
|
||||
}
|
||||
|
||||
TEST_METHOD(GetMsiPackageInstalledPath_PerUserVsPerMachine_MayDiffer)
|
||||
{
|
||||
auto perUser = GetMsiPackageInstalledPath(true);
|
||||
auto perMachine = GetMsiPackageInstalledPath(false);
|
||||
|
||||
// These may or may not be equal depending on installation
|
||||
// Just verify they don't crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// GetMsiPackagePath tests
|
||||
TEST_METHOD(GetMsiPackagePath_DoesNotCrash)
|
||||
{
|
||||
auto result = GetMsiPackagePath();
|
||||
// Result depends on installation state, but should not crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetMsiPackagePath_ConsistentResults)
|
||||
{
|
||||
auto result1 = GetMsiPackagePath();
|
||||
auto result2 = GetMsiPackagePath();
|
||||
|
||||
// Results should be consistent
|
||||
Assert::AreEqual(result1, result2);
|
||||
}
|
||||
|
||||
// Thread safety tests
|
||||
TEST_METHOD(GetMsiPackageInstalledPath_ThreadSafe)
|
||||
{
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 5; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount]() {
|
||||
for (int j = 0; j < 5; ++j)
|
||||
{
|
||||
GetMsiPackageInstalledPath(j % 2 == 0);
|
||||
successCount++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(25, successCount.load());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetMsiPackagePath_ThreadSafe)
|
||||
{
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 5; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount]() {
|
||||
for (int j = 0; j < 5; ++j)
|
||||
{
|
||||
GetMsiPackagePath();
|
||||
successCount++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(25, successCount.load());
|
||||
}
|
||||
|
||||
// Return value format tests
|
||||
TEST_METHOD(GetMsiPackageInstalledPath_ReturnsValidPathOrEmpty)
|
||||
{
|
||||
auto path = GetMsiPackageInstalledPath(true);
|
||||
|
||||
if (path.has_value() && !path->empty())
|
||||
{
|
||||
// If a path is returned, it should contain backslash or be a valid path format
|
||||
Assert::IsTrue(path->find(L'\\') != std::wstring::npos ||
|
||||
path->find(L'/') != std::wstring::npos ||
|
||||
path->length() >= 2); // At minimum drive letter + colon
|
||||
}
|
||||
// No value or empty is also valid (not installed)
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetMsiPackagePath_ReturnsValidPathOrEmpty)
|
||||
{
|
||||
auto path = GetMsiPackagePath();
|
||||
|
||||
if (!path.empty())
|
||||
{
|
||||
// If a path is returned, it should be a valid path format
|
||||
Assert::IsTrue(path.find(L'\\') != std::wstring::npos ||
|
||||
path.find(L'/') != std::wstring::npos ||
|
||||
path.length() >= 2);
|
||||
}
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
};
|
||||
}
|
||||
107
src/common/UnitTests-CommonUtils/OsDetect.Tests.cpp
Normal file
107
src/common/UnitTests-CommonUtils/OsDetect.Tests.cpp
Normal file
@@ -0,0 +1,107 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <os-detect.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(OsDetectTests)
|
||||
{
|
||||
public:
|
||||
// IsAPIContractVxAvailable tests
|
||||
TEST_METHOD(IsAPIContractV8Available_ReturnsBoolean)
|
||||
{
|
||||
// This test verifies the function runs without crashing
|
||||
// The actual result depends on the OS version
|
||||
bool result = IsAPIContractV8Available();
|
||||
// Result is either true or false, both are valid
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsAPIContractVxAvailable_V1_ReturnsTrue)
|
||||
{
|
||||
// API contract v1 should be available on any modern Windows
|
||||
bool result = IsAPIContractVxAvailable<1>();
|
||||
Assert::IsTrue(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsAPIContractVxAvailable_V5_ReturnsBooleanConsistently)
|
||||
{
|
||||
// Call multiple times to verify caching works correctly
|
||||
bool result1 = IsAPIContractVxAvailable<5>();
|
||||
bool result2 = IsAPIContractVxAvailable<5>();
|
||||
bool result3 = IsAPIContractVxAvailable<5>();
|
||||
Assert::AreEqual(result1, result2);
|
||||
Assert::AreEqual(result2, result3);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsAPIContractVxAvailable_V10_ReturnsBoolean)
|
||||
{
|
||||
bool result = IsAPIContractVxAvailable<10>();
|
||||
// Result depends on Windows version, but should not crash
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsAPIContractVxAvailable_V15_ReturnsBoolean)
|
||||
{
|
||||
bool result = IsAPIContractVxAvailable<15>();
|
||||
// Higher API versions, may or may not be available
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
// Is19H1OrHigher tests
|
||||
TEST_METHOD(Is19H1OrHigher_ReturnsBoolean)
|
||||
{
|
||||
bool result = Is19H1OrHigher();
|
||||
// Result depends on OS version, but should not crash
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(Is19H1OrHigher_ReturnsSameAsV8Contract)
|
||||
{
|
||||
// Is19H1OrHigher is implemented as IsAPIContractV8Available
|
||||
bool is19H1 = Is19H1OrHigher();
|
||||
bool isV8 = IsAPIContractV8Available();
|
||||
Assert::AreEqual(is19H1, isV8);
|
||||
}
|
||||
|
||||
TEST_METHOD(Is19H1OrHigher_ConsistentAcrossMultipleCalls)
|
||||
{
|
||||
bool result1 = Is19H1OrHigher();
|
||||
bool result2 = Is19H1OrHigher();
|
||||
bool result3 = Is19H1OrHigher();
|
||||
Assert::AreEqual(result1, result2);
|
||||
Assert::AreEqual(result2, result3);
|
||||
}
|
||||
|
||||
// Static caching behavior tests
|
||||
TEST_METHOD(StaticCaching_DifferentContractVersions_IndependentResults)
|
||||
{
|
||||
// Each template instantiation has its own static variable
|
||||
bool v1 = IsAPIContractVxAvailable<1>();
|
||||
(void)v1; // Suppress unused variable warning
|
||||
|
||||
// v1 should be true on any modern Windows
|
||||
Assert::IsTrue(v1);
|
||||
}
|
||||
|
||||
// Performance test (optional - verifies caching)
|
||||
TEST_METHOD(Performance_MultipleCallsAreFast)
|
||||
{
|
||||
// The static caching should make subsequent calls very fast
|
||||
auto start = std::chrono::high_resolution_clock::now();
|
||||
|
||||
for (int i = 0; i < 10000; ++i)
|
||||
{
|
||||
Is19H1OrHigher();
|
||||
}
|
||||
|
||||
auto end = std::chrono::high_resolution_clock::now();
|
||||
auto duration = std::chrono::duration_cast<std::chrono::milliseconds>(end - start);
|
||||
|
||||
// 10000 calls should complete in well under 1 second due to caching
|
||||
Assert::IsTrue(duration.count() < 1000);
|
||||
}
|
||||
};
|
||||
}
|
||||
180
src/common/UnitTests-CommonUtils/Package.Tests.cpp
Normal file
180
src/common/UnitTests-CommonUtils/Package.Tests.cpp
Normal file
@@ -0,0 +1,180 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <package.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
using namespace package;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(PackageTests)
|
||||
{
|
||||
public:
|
||||
// IsWin11OrGreater tests
|
||||
TEST_METHOD(IsWin11OrGreater_ReturnsBoolean)
|
||||
{
|
||||
bool result = IsWin11OrGreater();
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsWin11OrGreater_ConsistentResults)
|
||||
{
|
||||
bool result1 = IsWin11OrGreater();
|
||||
bool result2 = IsWin11OrGreater();
|
||||
bool result3 = IsWin11OrGreater();
|
||||
|
||||
Assert::AreEqual(result1, result2);
|
||||
Assert::AreEqual(result2, result3);
|
||||
}
|
||||
|
||||
// PACKAGE_VERSION struct tests
|
||||
TEST_METHOD(PackageVersion_DefaultConstruction)
|
||||
{
|
||||
PACKAGE_VERSION version{};
|
||||
Assert::AreEqual(static_cast<UINT16>(0), version.Major);
|
||||
Assert::AreEqual(static_cast<UINT16>(0), version.Minor);
|
||||
Assert::AreEqual(static_cast<UINT16>(0), version.Build);
|
||||
Assert::AreEqual(static_cast<UINT16>(0), version.Revision);
|
||||
}
|
||||
|
||||
TEST_METHOD(PackageVersion_Assignment)
|
||||
{
|
||||
PACKAGE_VERSION version{};
|
||||
version.Major = 1;
|
||||
version.Minor = 2;
|
||||
version.Build = 3;
|
||||
version.Revision = 4;
|
||||
|
||||
Assert::AreEqual(static_cast<UINT16>(1), version.Major);
|
||||
Assert::AreEqual(static_cast<UINT16>(2), version.Minor);
|
||||
Assert::AreEqual(static_cast<UINT16>(3), version.Build);
|
||||
Assert::AreEqual(static_cast<UINT16>(4), version.Revision);
|
||||
}
|
||||
|
||||
// ComInitializer tests
|
||||
TEST_METHOD(ComInitializer_InitializesAndUninitializesCom)
|
||||
{
|
||||
{
|
||||
ComInitializer comInit;
|
||||
// COM should be initialized within this scope
|
||||
}
|
||||
// COM should be uninitialized after scope
|
||||
|
||||
// Verify we can initialize again
|
||||
{
|
||||
ComInitializer comInit2;
|
||||
}
|
||||
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(ComInitializer_MultipleInstances)
|
||||
{
|
||||
ComInitializer init1;
|
||||
ComInitializer init2;
|
||||
ComInitializer init3;
|
||||
|
||||
// Multiple initializations should work (COM uses reference counting)
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// GetRegisteredPackage tests
|
||||
TEST_METHOD(GetRegisteredPackage_NonExistentPackage_ReturnsEmpty)
|
||||
{
|
||||
auto result = GetRegisteredPackage(L"NonExistentPackage12345", false);
|
||||
|
||||
// Should return empty for non-existent package
|
||||
Assert::IsFalse(result.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetRegisteredPackage_EmptyName_DoesNotCrash)
|
||||
{
|
||||
auto result = GetRegisteredPackage(L"", false);
|
||||
// Behavior may vary based on package enumeration; just ensure it doesn't crash.
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// IsPackageRegisteredWithPowerToysVersion tests
|
||||
TEST_METHOD(IsPackageRegisteredWithPowerToysVersion_NonExistentPackage_ReturnsFalse)
|
||||
{
|
||||
bool result = IsPackageRegisteredWithPowerToysVersion(L"NonExistentPackage12345");
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsPackageRegisteredWithPowerToysVersion_EmptyName_ReturnsFalse)
|
||||
{
|
||||
bool result = IsPackageRegisteredWithPowerToysVersion(L"");
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
// FindMsixFile tests
|
||||
TEST_METHOD(FindMsixFile_NonExistentDirectory_ReturnsEmpty)
|
||||
{
|
||||
auto result = FindMsixFile(L"C:\\NonExistentDirectory12345", false);
|
||||
Assert::IsTrue(result.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(FindMsixFile_SystemDirectory_DoesNotCrash)
|
||||
{
|
||||
// System32 probably doesn't have MSIX files, but shouldn't crash
|
||||
auto result = FindMsixFile(L"C:\\Windows\\System32", false);
|
||||
// May or may not find files, but should not crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(FindMsixFile_RecursiveSearch_DoesNotCrash)
|
||||
{
|
||||
// Use temp directory which should exist
|
||||
wchar_t tempPath[MAX_PATH];
|
||||
GetTempPathW(MAX_PATH, tempPath);
|
||||
|
||||
auto result = FindMsixFile(tempPath, true);
|
||||
// May or may not find files, but should not crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// GetPackageNameAndVersionFromAppx tests
|
||||
TEST_METHOD(GetPackageNameAndVersionFromAppx_NonExistentFile_ReturnsFalse)
|
||||
{
|
||||
std::wstring name;
|
||||
PACKAGE_VERSION version{};
|
||||
|
||||
bool result = GetPackageNameAndVersionFromAppx(L"C:\\NonExistent\\file.msix", name, version);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetPackageNameAndVersionFromAppx_EmptyPath_ReturnsFalse)
|
||||
{
|
||||
std::wstring name;
|
||||
PACKAGE_VERSION version{};
|
||||
|
||||
bool result = GetPackageNameAndVersionFromAppx(L"", name, version);
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
// Thread safety
|
||||
TEST_METHOD(IsWin11OrGreater_ThreadSafe)
|
||||
{
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount]() {
|
||||
for (int j = 0; j < 10; ++j)
|
||||
{
|
||||
IsWin11OrGreater();
|
||||
successCount++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(100, successCount.load());
|
||||
}
|
||||
};
|
||||
}
|
||||
136
src/common/UnitTests-CommonUtils/ProcessApi.Tests.cpp
Normal file
136
src/common/UnitTests-CommonUtils/ProcessApi.Tests.cpp
Normal file
@@ -0,0 +1,136 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <processApi.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(ProcessApiTests)
|
||||
{
|
||||
public:
|
||||
TEST_METHOD(GetProcessHandlesByName_CurrentProcess_ReturnsHandles)
|
||||
{
|
||||
// Get current process executable name
|
||||
wchar_t path[MAX_PATH];
|
||||
GetModuleFileNameW(nullptr, path, MAX_PATH);
|
||||
|
||||
// Extract just the filename
|
||||
std::wstring fullPath(path);
|
||||
auto lastSlash = fullPath.rfind(L'\\');
|
||||
std::wstring exeName = (lastSlash != std::wstring::npos) ?
|
||||
fullPath.substr(lastSlash + 1) : fullPath;
|
||||
|
||||
auto handles = getProcessHandlesByName(exeName, PROCESS_QUERY_LIMITED_INFORMATION);
|
||||
|
||||
// Should find at least our own process
|
||||
Assert::IsFalse(handles.empty());
|
||||
|
||||
// Handles are RAII-managed
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessHandlesByName_NonExistentProcess_ReturnsEmpty)
|
||||
{
|
||||
auto handles = getProcessHandlesByName(L"NonExistentProcess12345.exe", PROCESS_QUERY_LIMITED_INFORMATION);
|
||||
Assert::IsTrue(handles.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessHandlesByName_EmptyName_ReturnsEmpty)
|
||||
{
|
||||
auto handles = getProcessHandlesByName(L"", PROCESS_QUERY_LIMITED_INFORMATION);
|
||||
Assert::IsTrue(handles.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessHandlesByName_Explorer_ReturnsHandles)
|
||||
{
|
||||
// Explorer.exe should typically be running
|
||||
auto handles = getProcessHandlesByName(L"explorer.exe", PROCESS_QUERY_LIMITED_INFORMATION);
|
||||
|
||||
// Handles are RAII-managed
|
||||
|
||||
// May or may not find explorer depending on system state
|
||||
// Just verify it doesn't crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessHandlesByName_CaseInsensitive_Works)
|
||||
{
|
||||
// Get current process name in uppercase
|
||||
wchar_t path[MAX_PATH];
|
||||
GetModuleFileNameW(nullptr, path, MAX_PATH);
|
||||
|
||||
std::wstring fullPath(path);
|
||||
auto lastSlash = fullPath.rfind(L'\\');
|
||||
std::wstring exeName = (lastSlash != std::wstring::npos) ?
|
||||
fullPath.substr(lastSlash + 1) : fullPath;
|
||||
|
||||
// Convert to uppercase
|
||||
std::wstring upperName = exeName;
|
||||
std::transform(upperName.begin(), upperName.end(), upperName.begin(), ::towupper);
|
||||
|
||||
auto handles = getProcessHandlesByName(upperName, PROCESS_QUERY_LIMITED_INFORMATION);
|
||||
|
||||
// Handles are RAII-managed
|
||||
|
||||
// The function may or may not be case insensitive - just don't crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessHandlesByName_DifferentAccessRights_Works)
|
||||
{
|
||||
wchar_t path[MAX_PATH];
|
||||
GetModuleFileNameW(nullptr, path, MAX_PATH);
|
||||
|
||||
std::wstring fullPath(path);
|
||||
auto lastSlash = fullPath.rfind(L'\\');
|
||||
std::wstring exeName = (lastSlash != std::wstring::npos) ?
|
||||
fullPath.substr(lastSlash + 1) : fullPath;
|
||||
|
||||
// Try with different access rights
|
||||
auto handles1 = getProcessHandlesByName(exeName, PROCESS_QUERY_INFORMATION);
|
||||
auto handles2 = getProcessHandlesByName(exeName, PROCESS_VM_READ);
|
||||
|
||||
// Handles are RAII-managed
|
||||
|
||||
// Just verify no crashes
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessHandlesByName_SystemProcess_MayRequireElevation)
|
||||
{
|
||||
// System processes might require elevation
|
||||
auto handles = getProcessHandlesByName(L"System", PROCESS_QUERY_LIMITED_INFORMATION);
|
||||
|
||||
// Handles are RAII-managed
|
||||
|
||||
// Just verify no crashes
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessHandlesByName_ValidHandles_AreUsable)
|
||||
{
|
||||
wchar_t path[MAX_PATH];
|
||||
GetModuleFileNameW(nullptr, path, MAX_PATH);
|
||||
|
||||
std::wstring fullPath(path);
|
||||
auto lastSlash = fullPath.rfind(L'\\');
|
||||
std::wstring exeName = (lastSlash != std::wstring::npos) ?
|
||||
fullPath.substr(lastSlash + 1) : fullPath;
|
||||
|
||||
auto handles = getProcessHandlesByName(exeName, PROCESS_QUERY_LIMITED_INFORMATION);
|
||||
|
||||
bool foundValidHandle = false;
|
||||
for (auto& handle : handles)
|
||||
{
|
||||
// Try to use the handle
|
||||
DWORD exitCode;
|
||||
if (GetExitCodeProcess(handle.get(), &exitCode))
|
||||
{
|
||||
foundValidHandle = true;
|
||||
}
|
||||
}
|
||||
|
||||
Assert::IsTrue(foundValidHandle || handles.empty());
|
||||
}
|
||||
};
|
||||
}
|
||||
153
src/common/UnitTests-CommonUtils/ProcessPath.Tests.cpp
Normal file
153
src/common/UnitTests-CommonUtils/ProcessPath.Tests.cpp
Normal file
@@ -0,0 +1,153 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <process_path.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(ProcessPathTests)
|
||||
{
|
||||
public:
|
||||
// get_process_path (by PID) tests
|
||||
TEST_METHOD(GetProcessPath_CurrentProcess_ReturnsPath)
|
||||
{
|
||||
DWORD pid = GetCurrentProcessId();
|
||||
auto path = get_process_path(pid);
|
||||
|
||||
Assert::IsFalse(path.empty());
|
||||
Assert::IsTrue(path.find(L".exe") != std::wstring::npos ||
|
||||
path.find(L".dll") != std::wstring::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessPath_InvalidPid_ReturnsEmpty)
|
||||
{
|
||||
DWORD invalidPid = 0xFFFFFFFF;
|
||||
auto path = get_process_path(invalidPid);
|
||||
|
||||
// Should return empty for invalid PID
|
||||
Assert::IsTrue(path.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessPath_ZeroPid_ReturnsEmpty)
|
||||
{
|
||||
auto path = get_process_path(static_cast<DWORD>(0));
|
||||
// PID 0 is the System Idle Process, might return empty or a path
|
||||
// Just verify it doesn't crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessPath_SystemPid_DoesNotCrash)
|
||||
{
|
||||
// PID 4 is typically the System process
|
||||
auto path = get_process_path(static_cast<DWORD>(4));
|
||||
// May return empty due to access rights, but shouldn't crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// get_module_filename tests
|
||||
TEST_METHOD(GetModuleFilename_NullModule_ReturnsExePath)
|
||||
{
|
||||
auto path = get_module_filename(nullptr);
|
||||
|
||||
Assert::IsFalse(path.empty());
|
||||
Assert::IsTrue(path.find(L".exe") != std::wstring::npos ||
|
||||
path.find(L".dll") != std::wstring::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetModuleFilename_Kernel32_ReturnsPath)
|
||||
{
|
||||
HMODULE kernel32 = GetModuleHandleW(L"kernel32.dll");
|
||||
Assert::IsNotNull(kernel32);
|
||||
|
||||
auto path = get_module_filename(kernel32);
|
||||
|
||||
Assert::IsFalse(path.empty());
|
||||
// Should contain kernel32 (case insensitive check)
|
||||
std::wstring lowerPath = path;
|
||||
std::transform(lowerPath.begin(), lowerPath.end(), lowerPath.begin(), ::towlower);
|
||||
Assert::IsTrue(lowerPath.find(L"kernel32") != std::wstring::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetModuleFilename_InvalidModule_ReturnsEmpty)
|
||||
{
|
||||
auto path = get_module_filename(reinterpret_cast<HMODULE>(0x12345678));
|
||||
// Invalid module should return empty
|
||||
Assert::IsTrue(path.empty());
|
||||
}
|
||||
|
||||
// get_module_folderpath tests
|
||||
TEST_METHOD(GetModuleFolderpath_NullModule_ReturnsFolder)
|
||||
{
|
||||
auto folder = get_module_folderpath(nullptr, true);
|
||||
|
||||
Assert::IsFalse(folder.empty());
|
||||
// Should not end with .exe when removeFilename is true
|
||||
Assert::IsTrue(folder.find(L".exe") == std::wstring::npos);
|
||||
// Should end with backslash or be a valid folder path
|
||||
Assert::IsTrue(folder.back() == L'\\' || folder.find(L"\\") != std::wstring::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetModuleFolderpath_KeepFilename_ReturnsFullPath)
|
||||
{
|
||||
auto fullPath = get_module_folderpath(nullptr, false);
|
||||
|
||||
Assert::IsFalse(fullPath.empty());
|
||||
// Should contain .exe or .dll when not removing filename
|
||||
Assert::IsTrue(fullPath.find(L".exe") != std::wstring::npos ||
|
||||
fullPath.find(L".dll") != std::wstring::npos);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetModuleFolderpath_Kernel32_ReturnsSystem32)
|
||||
{
|
||||
HMODULE kernel32 = GetModuleHandleW(L"kernel32.dll");
|
||||
Assert::IsNotNull(kernel32);
|
||||
|
||||
auto folder = get_module_folderpath(kernel32, true);
|
||||
|
||||
Assert::IsFalse(folder.empty());
|
||||
// Should be in system32 folder
|
||||
std::wstring lowerPath = folder;
|
||||
std::transform(lowerPath.begin(), lowerPath.end(), lowerPath.begin(), ::towlower);
|
||||
Assert::IsTrue(lowerPath.find(L"system32") != std::wstring::npos ||
|
||||
lowerPath.find(L"syswow64") != std::wstring::npos);
|
||||
}
|
||||
|
||||
// get_process_path (by HWND) tests
|
||||
TEST_METHOD(GetProcessPath_DesktopWindow_ReturnsPath)
|
||||
{
|
||||
HWND desktop = GetDesktopWindow();
|
||||
Assert::IsNotNull(desktop);
|
||||
|
||||
auto path = get_process_path(desktop);
|
||||
// Desktop window should return a path
|
||||
// (could be explorer.exe or empty depending on system)
|
||||
Assert::IsTrue(true); // Just verify it doesn't crash
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessPath_InvalidHwnd_ReturnsEmpty)
|
||||
{
|
||||
auto path = get_process_path(reinterpret_cast<HWND>(0x12345678));
|
||||
Assert::IsTrue(path.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetProcessPath_NullHwnd_ReturnsEmpty)
|
||||
{
|
||||
auto path = get_process_path(static_cast<HWND>(nullptr));
|
||||
Assert::IsTrue(path.empty());
|
||||
}
|
||||
|
||||
// Consistency tests
|
||||
TEST_METHOD(Consistency_ModuleFilenameAndFolderpath_AreRelated)
|
||||
{
|
||||
auto fullPath = get_module_filename(nullptr);
|
||||
auto folder = get_module_folderpath(nullptr, true);
|
||||
|
||||
Assert::IsFalse(fullPath.empty());
|
||||
Assert::IsFalse(folder.empty());
|
||||
|
||||
// Full path should start with the folder
|
||||
Assert::IsTrue(fullPath.find(folder) == 0 || folder.find(fullPath.substr(0, folder.length())) == 0);
|
||||
}
|
||||
};
|
||||
}
|
||||
127
src/common/UnitTests-CommonUtils/ProcessWaiter.Tests.cpp
Normal file
127
src/common/UnitTests-CommonUtils/ProcessWaiter.Tests.cpp
Normal file
@@ -0,0 +1,127 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <ProcessWaiter.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
using namespace ProcessWaiter;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(ProcessWaiterTests)
|
||||
{
|
||||
public:
|
||||
TEST_METHOD(OnProcessTerminate_InvalidPid_DoesNotCrash)
|
||||
{
|
||||
std::atomic<bool> called{ false };
|
||||
|
||||
// Use a very unlikely PID (negative value as string will fail conversion)
|
||||
OnProcessTerminate(L"invalid", [&called](DWORD) {
|
||||
called = true;
|
||||
});
|
||||
|
||||
// Wait briefly
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
|
||||
// Should not crash, callback may or may not be called depending on implementation
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(OnProcessTerminate_NonExistentPid_DoesNotCrash)
|
||||
{
|
||||
std::atomic<bool> called{ false };
|
||||
|
||||
// Use a PID that likely doesn't exist
|
||||
OnProcessTerminate(L"999999999", [&called](DWORD) {
|
||||
called = true;
|
||||
});
|
||||
|
||||
// Wait briefly
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
|
||||
// Should not crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(OnProcessTerminate_ZeroPid_DoesNotCrash)
|
||||
{
|
||||
std::atomic<bool> called{ false };
|
||||
|
||||
OnProcessTerminate(L"0", [&called](DWORD) {
|
||||
called = true;
|
||||
});
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(OnProcessTerminate_CurrentProcessPid_DoesNotTerminate)
|
||||
{
|
||||
std::atomic<bool> called{ false };
|
||||
|
||||
// Use current process PID - it shouldn't terminate during test
|
||||
std::wstring pid = std::to_wstring(GetCurrentProcessId());
|
||||
|
||||
OnProcessTerminate(pid, [&called](DWORD) {
|
||||
called = true;
|
||||
});
|
||||
|
||||
// Wait briefly - current process should not terminate
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(200));
|
||||
|
||||
// Callback should not have been called since process is still running
|
||||
Assert::IsFalse(called);
|
||||
}
|
||||
|
||||
TEST_METHOD(OnProcessTerminate_EmptyCallback_DoesNotCrash)
|
||||
{
|
||||
// Test with an empty function
|
||||
OnProcessTerminate(L"999999999", std::function<void(DWORD)>());
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(OnProcessTerminate_MultipleCallsForSamePid_DoesNotCrash)
|
||||
{
|
||||
std::atomic<int> counter{ 0 };
|
||||
std::wstring pid = std::to_wstring(GetCurrentProcessId());
|
||||
|
||||
// Multiple waits on same (running) process
|
||||
for (int i = 0; i < 5; ++i)
|
||||
{
|
||||
OnProcessTerminate(pid, [&counter](DWORD) {
|
||||
counter++;
|
||||
});
|
||||
}
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(200));
|
||||
|
||||
// None should have been called since process is running
|
||||
Assert::AreEqual(0, counter.load());
|
||||
}
|
||||
|
||||
TEST_METHOD(OnProcessTerminate_NegativeNumberString_DoesNotCrash)
|
||||
{
|
||||
std::atomic<bool> called{ false };
|
||||
|
||||
OnProcessTerminate(L"-1", [&called](DWORD) {
|
||||
called = true;
|
||||
});
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(OnProcessTerminate_LargeNumber_DoesNotCrash)
|
||||
{
|
||||
std::atomic<bool> called{ false };
|
||||
|
||||
OnProcessTerminate(L"18446744073709551615", [&called](DWORD) {
|
||||
called = true;
|
||||
});
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
};
|
||||
}
|
||||
61
src/common/UnitTests-CommonUtils/Registry.Tests.cpp
Normal file
61
src/common/UnitTests-CommonUtils/Registry.Tests.cpp
Normal file
@@ -0,0 +1,61 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <registry.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(RegistryTests)
|
||||
{
|
||||
public:
|
||||
// Note: These tests use HKCU which doesn't require elevation
|
||||
|
||||
TEST_METHOD(InstallScope_Registry_CanReadAndWrite)
|
||||
{
|
||||
TestHelpers::TestRegistryKey testKey(L"RegistryTest");
|
||||
Assert::IsTrue(testKey.isValid());
|
||||
|
||||
// Write a test value
|
||||
Assert::IsTrue(testKey.setStringValue(L"TestValue", L"TestData"));
|
||||
Assert::IsTrue(testKey.setDwordValue(L"TestDword", 42));
|
||||
}
|
||||
|
||||
TEST_METHOD(Registry_ValueChange_StringValue)
|
||||
{
|
||||
registry::ValueChange change{ HKEY_CURRENT_USER, L"Software\\PowerToys\\Test", L"TestValue", std::wstring{ L"TestData" } };
|
||||
|
||||
Assert::AreEqual(std::wstring(L"Software\\PowerToys\\Test"), change.path);
|
||||
Assert::IsTrue(change.name.has_value());
|
||||
Assert::AreEqual(std::wstring(L"TestValue"), *change.name);
|
||||
Assert::AreEqual(std::wstring(L"TestData"), std::get<std::wstring>(change.value));
|
||||
}
|
||||
|
||||
TEST_METHOD(Registry_ValueChange_DwordValue)
|
||||
{
|
||||
registry::ValueChange change{ HKEY_CURRENT_USER, L"Software\\PowerToys\\Test", L"TestDword", static_cast<DWORD>(42) };
|
||||
|
||||
Assert::AreEqual(std::wstring(L"Software\\PowerToys\\Test"), change.path);
|
||||
Assert::IsTrue(change.name.has_value());
|
||||
Assert::AreEqual(std::wstring(L"TestDword"), *change.name);
|
||||
Assert::AreEqual(static_cast<DWORD>(42), std::get<DWORD>(change.value));
|
||||
}
|
||||
|
||||
TEST_METHOD(Registry_ChangeSet_AddChanges)
|
||||
{
|
||||
registry::ChangeSet changeSet;
|
||||
|
||||
changeSet.changes.push_back({ HKEY_CURRENT_USER, L"Software\\PowerToys\\Test", L"Value1", std::wstring{ L"Data1" } });
|
||||
changeSet.changes.push_back({ HKEY_CURRENT_USER, L"Software\\PowerToys\\Test", L"Value2", static_cast<DWORD>(123) });
|
||||
|
||||
Assert::AreEqual(static_cast<size_t>(2), changeSet.changes.size());
|
||||
}
|
||||
|
||||
TEST_METHOD(InstallScope_GetCurrentInstallScope_ReturnsValidValue)
|
||||
{
|
||||
auto scope = registry::install_scope::get_current_install_scope();
|
||||
Assert::IsTrue(scope == registry::install_scope::InstallScope::PerMachine ||
|
||||
scope == registry::install_scope::InstallScope::PerUser);
|
||||
}
|
||||
};
|
||||
}
|
||||
144
src/common/UnitTests-CommonUtils/Resources.Tests.cpp
Normal file
144
src/common/UnitTests-CommonUtils/Resources.Tests.cpp
Normal file
@@ -0,0 +1,144 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <resources.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(ResourcesTests)
|
||||
{
|
||||
public:
|
||||
// get_resource_string tests with current module
|
||||
TEST_METHOD(GetResourceString_NonExistentId_ReturnsFallback)
|
||||
{
|
||||
HINSTANCE instance = GetModuleHandleW(nullptr);
|
||||
|
||||
auto result = get_resource_string(99999, instance, L"fallback");
|
||||
Assert::AreEqual(std::wstring(L"fallback"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetResourceString_NullInstance_UsesFallback)
|
||||
{
|
||||
auto result = get_resource_string(99999, nullptr, L"fallback");
|
||||
// Should return fallback or empty string
|
||||
Assert::IsTrue(result == L"fallback" || result.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetResourceString_EmptyFallback_ReturnsEmpty)
|
||||
{
|
||||
HINSTANCE instance = GetModuleHandleW(nullptr);
|
||||
|
||||
auto result = get_resource_string(99999, instance, L"");
|
||||
Assert::IsTrue(result.empty());
|
||||
}
|
||||
|
||||
// get_english_fallback_string tests
|
||||
TEST_METHOD(GetEnglishFallbackString_NonExistentId_ReturnsEmpty)
|
||||
{
|
||||
HINSTANCE instance = GetModuleHandleW(nullptr);
|
||||
|
||||
auto result = get_english_fallback_string(99999, instance);
|
||||
// Should return empty or the resource if it exists
|
||||
Assert::IsTrue(true); // Just verify no crash
|
||||
}
|
||||
|
||||
TEST_METHOD(GetEnglishFallbackString_NullInstance_DoesNotCrash)
|
||||
{
|
||||
auto result = get_english_fallback_string(99999, nullptr);
|
||||
Assert::IsTrue(true); // Just verify no crash
|
||||
}
|
||||
|
||||
// get_resource_string_language_override tests
|
||||
TEST_METHOD(GetResourceStringLanguageOverride_NonExistentId_ReturnsEmpty)
|
||||
{
|
||||
HINSTANCE instance = GetModuleHandleW(nullptr);
|
||||
|
||||
auto result = get_resource_string_language_override(99999, instance);
|
||||
// Should return empty for non-existent resource
|
||||
Assert::IsTrue(result.empty() || !result.empty()); // Valid either way
|
||||
}
|
||||
|
||||
TEST_METHOD(GetResourceStringLanguageOverride_NullInstance_DoesNotCrash)
|
||||
{
|
||||
auto result = get_resource_string_language_override(99999, nullptr);
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// Thread safety tests
|
||||
TEST_METHOD(GetResourceString_ThreadSafe)
|
||||
{
|
||||
HINSTANCE instance = GetModuleHandleW(nullptr);
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount, instance]() {
|
||||
for (int j = 0; j < 10; ++j)
|
||||
{
|
||||
get_resource_string(99999, instance, L"fallback");
|
||||
successCount++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(100, successCount.load());
|
||||
}
|
||||
|
||||
// Kernel32 resource tests (has known resources)
|
||||
TEST_METHOD(GetResourceString_Kernel32_DoesNotCrash)
|
||||
{
|
||||
HMODULE kernel32 = GetModuleHandleW(L"kernel32.dll");
|
||||
if (kernel32)
|
||||
{
|
||||
// Kernel32 has resources, but we don't know exact IDs
|
||||
// Just verify it doesn't crash
|
||||
get_resource_string(1, kernel32, L"fallback");
|
||||
get_resource_string(100, kernel32, L"fallback");
|
||||
get_resource_string(1000, kernel32, L"fallback");
|
||||
}
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// Performance test
|
||||
TEST_METHOD(GetResourceString_Performance_Acceptable)
|
||||
{
|
||||
HINSTANCE instance = GetModuleHandleW(nullptr);
|
||||
|
||||
auto start = std::chrono::high_resolution_clock::now();
|
||||
|
||||
for (int i = 0; i < 1000; ++i)
|
||||
{
|
||||
get_resource_string(99999, instance, L"fallback");
|
||||
}
|
||||
|
||||
auto end = std::chrono::high_resolution_clock::now();
|
||||
auto duration = std::chrono::duration_cast<std::chrono::milliseconds>(end - start);
|
||||
|
||||
// 1000 lookups should complete in under 1 second
|
||||
Assert::IsTrue(duration.count() < 1000);
|
||||
}
|
||||
|
||||
// Edge case tests
|
||||
TEST_METHOD(GetResourceString_ZeroId_DoesNotCrash)
|
||||
{
|
||||
HINSTANCE instance = GetModuleHandleW(nullptr);
|
||||
auto result = get_resource_string(0, instance, L"fallback");
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetResourceString_MaxUintId_DoesNotCrash)
|
||||
{
|
||||
HINSTANCE instance = GetModuleHandleW(nullptr);
|
||||
auto result = get_resource_string(UINT_MAX, instance, L"fallback");
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
};
|
||||
}
|
||||
286
src/common/UnitTests-CommonUtils/Serialized.Tests.cpp
Normal file
286
src/common/UnitTests-CommonUtils/Serialized.Tests.cpp
Normal file
@@ -0,0 +1,286 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <serialized.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(SerializedTests)
|
||||
{
|
||||
public:
|
||||
// Basic Read tests
|
||||
TEST_METHOD(Read_DefaultState_ReturnsDefaultValue)
|
||||
{
|
||||
Serialized<int> s;
|
||||
int value = -1;
|
||||
s.Read([&value](const int& v) {
|
||||
value = v;
|
||||
});
|
||||
Assert::AreEqual(0, value); // Default constructed int is 0
|
||||
}
|
||||
|
||||
TEST_METHOD(Read_StringType_ReturnsEmpty)
|
||||
{
|
||||
Serialized<std::string> s;
|
||||
std::string value = "initial";
|
||||
s.Read([&value](const std::string& v) {
|
||||
value = v;
|
||||
});
|
||||
Assert::AreEqual(std::string(""), value);
|
||||
}
|
||||
|
||||
// Basic Access tests
|
||||
TEST_METHOD(Access_ModifyValue_ValueIsModified)
|
||||
{
|
||||
Serialized<int> s;
|
||||
s.Access([](int& v) {
|
||||
v = 42;
|
||||
});
|
||||
|
||||
int value = 0;
|
||||
s.Read([&value](const int& v) {
|
||||
value = v;
|
||||
});
|
||||
Assert::AreEqual(42, value);
|
||||
}
|
||||
|
||||
TEST_METHOD(Access_ModifyString_StringIsModified)
|
||||
{
|
||||
Serialized<std::string> s;
|
||||
s.Access([](std::string& v) {
|
||||
v = "hello";
|
||||
});
|
||||
|
||||
std::string value;
|
||||
s.Read([&value](const std::string& v) {
|
||||
value = v;
|
||||
});
|
||||
Assert::AreEqual(std::string("hello"), value);
|
||||
}
|
||||
|
||||
TEST_METHOD(Access_MultipleModifications_LastValuePersists)
|
||||
{
|
||||
Serialized<int> s;
|
||||
s.Access([](int& v) { v = 1; });
|
||||
s.Access([](int& v) { v = 2; });
|
||||
s.Access([](int& v) { v = 3; });
|
||||
|
||||
int value = 0;
|
||||
s.Read([&value](const int& v) {
|
||||
value = v;
|
||||
});
|
||||
Assert::AreEqual(3, value);
|
||||
}
|
||||
|
||||
// Reset tests
|
||||
TEST_METHOD(Reset_AfterModification_ReturnsDefault)
|
||||
{
|
||||
Serialized<int> s;
|
||||
s.Access([](int& v) { v = 42; });
|
||||
s.Reset();
|
||||
|
||||
int value = -1;
|
||||
s.Read([&value](const int& v) {
|
||||
value = v;
|
||||
});
|
||||
Assert::AreEqual(0, value);
|
||||
}
|
||||
|
||||
TEST_METHOD(Reset_String_ReturnsEmpty)
|
||||
{
|
||||
Serialized<std::string> s;
|
||||
s.Access([](std::string& v) { v = "hello"; });
|
||||
s.Reset();
|
||||
|
||||
std::string value = "initial";
|
||||
s.Read([&value](const std::string& v) {
|
||||
value = v;
|
||||
});
|
||||
Assert::AreEqual(std::string(""), value);
|
||||
}
|
||||
|
||||
// Complex type tests
|
||||
TEST_METHOD(Serialized_VectorType_Works)
|
||||
{
|
||||
Serialized<std::vector<int>> s;
|
||||
s.Access([](std::vector<int>& v) {
|
||||
v.push_back(1);
|
||||
v.push_back(2);
|
||||
v.push_back(3);
|
||||
});
|
||||
|
||||
size_t size = 0;
|
||||
int sum = 0;
|
||||
s.Read([&size, &sum](const std::vector<int>& v) {
|
||||
size = v.size();
|
||||
for (int i : v) sum += i;
|
||||
});
|
||||
|
||||
Assert::AreEqual(static_cast<size_t>(3), size);
|
||||
Assert::AreEqual(6, sum);
|
||||
}
|
||||
|
||||
TEST_METHOD(Serialized_MapType_Works)
|
||||
{
|
||||
Serialized<std::map<std::string, int>> s;
|
||||
s.Access([](std::map<std::string, int>& v) {
|
||||
v["one"] = 1;
|
||||
v["two"] = 2;
|
||||
});
|
||||
|
||||
int value = 0;
|
||||
s.Read([&value](const std::map<std::string, int>& v) {
|
||||
auto it = v.find("two");
|
||||
if (it != v.end()) {
|
||||
value = it->second;
|
||||
}
|
||||
});
|
||||
|
||||
Assert::AreEqual(2, value);
|
||||
}
|
||||
|
||||
// Thread safety tests
|
||||
TEST_METHOD(ThreadSafety_ConcurrentReads_NoDataRace)
|
||||
{
|
||||
Serialized<int> s;
|
||||
s.Access([](int& v) { v = 42; });
|
||||
|
||||
std::atomic<int> readCount{ 0 };
|
||||
std::vector<std::thread> threads;
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
threads.emplace_back([&s, &readCount]() {
|
||||
for (int j = 0; j < 100; ++j)
|
||||
{
|
||||
s.Read([&readCount](const int& v) {
|
||||
if (v == 42) {
|
||||
readCount++;
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(1000, readCount.load());
|
||||
}
|
||||
|
||||
TEST_METHOD(ThreadSafety_ConcurrentAccessAndRead_NoDataRace)
|
||||
{
|
||||
Serialized<int> s;
|
||||
std::atomic<bool> done{ false };
|
||||
std::atomic<int> accessCount{ 0 };
|
||||
std::atomic<int> readersReady{ 0 };
|
||||
std::atomic<bool> start{ false };
|
||||
|
||||
// Writer thread
|
||||
std::thread writer([&s, &done, &accessCount, &readersReady, &start]() {
|
||||
while (readersReady.load() < 5)
|
||||
{
|
||||
std::this_thread::yield();
|
||||
}
|
||||
start = true;
|
||||
for (int i = 0; i < 100; ++i)
|
||||
{
|
||||
s.Access([i](int& v) {
|
||||
v = i;
|
||||
});
|
||||
accessCount++;
|
||||
}
|
||||
done = true;
|
||||
});
|
||||
|
||||
// Reader threads
|
||||
std::vector<std::thread> readers;
|
||||
std::atomic<int> readAttempts{ 0 };
|
||||
|
||||
for (int i = 0; i < 5; ++i)
|
||||
{
|
||||
readers.emplace_back([&s, &done, &readAttempts, &readersReady, &start]() {
|
||||
readersReady++;
|
||||
while (!start)
|
||||
{
|
||||
std::this_thread::yield();
|
||||
}
|
||||
while (!done)
|
||||
{
|
||||
s.Read([](const int& v) {
|
||||
// Just read the value
|
||||
(void)v;
|
||||
});
|
||||
readAttempts++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
writer.join();
|
||||
for (auto& t : readers)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
// Verify all access calls completed
|
||||
Assert::AreEqual(100, accessCount.load());
|
||||
// Verify reads happened
|
||||
Assert::IsTrue(readAttempts > 0);
|
||||
}
|
||||
|
||||
// Struct type test
|
||||
TEST_METHOD(Serialized_StructType_Works)
|
||||
{
|
||||
struct TestStruct
|
||||
{
|
||||
int x = 0;
|
||||
std::string name;
|
||||
};
|
||||
|
||||
Serialized<TestStruct> s;
|
||||
s.Access([](TestStruct& v) {
|
||||
v.x = 10;
|
||||
v.name = "test";
|
||||
});
|
||||
|
||||
int x = 0;
|
||||
std::string name;
|
||||
s.Read([&x, &name](const TestStruct& v) {
|
||||
x = v.x;
|
||||
name = v.name;
|
||||
});
|
||||
|
||||
Assert::AreEqual(10, x);
|
||||
Assert::AreEqual(std::string("test"), name);
|
||||
}
|
||||
|
||||
TEST_METHOD(Reset_StructType_ResetsToDefault)
|
||||
{
|
||||
struct TestStruct
|
||||
{
|
||||
int x = 0;
|
||||
std::string name;
|
||||
};
|
||||
|
||||
Serialized<TestStruct> s;
|
||||
s.Access([](TestStruct& v) {
|
||||
v.x = 10;
|
||||
v.name = "test";
|
||||
});
|
||||
s.Reset();
|
||||
|
||||
int x = -1;
|
||||
std::string name = "not empty";
|
||||
s.Read([&x, &name](const TestStruct& v) {
|
||||
x = v.x;
|
||||
name = v.name;
|
||||
});
|
||||
|
||||
Assert::AreEqual(0, x);
|
||||
Assert::AreEqual(std::string(""), name);
|
||||
}
|
||||
};
|
||||
}
|
||||
283
src/common/UnitTests-CommonUtils/StringUtils.Tests.cpp
Normal file
283
src/common/UnitTests-CommonUtils/StringUtils.Tests.cpp
Normal file
@@ -0,0 +1,283 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <string_utils.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(StringUtilsTests)
|
||||
{
|
||||
public:
|
||||
// left_trim tests
|
||||
TEST_METHOD(LeftTrim_EmptyString_ReturnsEmpty)
|
||||
{
|
||||
std::string_view input = "";
|
||||
auto result = left_trim(input);
|
||||
Assert::AreEqual(std::string_view(""), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(LeftTrim_NoWhitespace_ReturnsOriginal)
|
||||
{
|
||||
std::string_view input = "hello";
|
||||
auto result = left_trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(LeftTrim_LeadingSpaces_TrimsSpaces)
|
||||
{
|
||||
std::string_view input = " hello";
|
||||
auto result = left_trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(LeftTrim_LeadingTabs_TrimsTabs)
|
||||
{
|
||||
std::string_view input = "\t\thello";
|
||||
auto result = left_trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(LeftTrim_LeadingNewlines_TrimsNewlines)
|
||||
{
|
||||
std::string_view input = "\r\n\nhello";
|
||||
auto result = left_trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(LeftTrim_MixedWhitespace_TrimsAll)
|
||||
{
|
||||
std::string_view input = " \t\r\nhello";
|
||||
auto result = left_trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(LeftTrim_TrailingWhitespace_PreservesTrailing)
|
||||
{
|
||||
std::string_view input = " hello ";
|
||||
auto result = left_trim(input);
|
||||
Assert::AreEqual(std::string_view("hello "), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(LeftTrim_OnlyWhitespace_ReturnsEmpty)
|
||||
{
|
||||
std::string_view input = " \t\r\n";
|
||||
auto result = left_trim(input);
|
||||
Assert::AreEqual(std::string_view(""), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(LeftTrim_CustomChars_TrimsSpecified)
|
||||
{
|
||||
std::string_view input = "xxxhello";
|
||||
auto result = left_trim(input, std::string_view("x"));
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(LeftTrim_WideString_Works)
|
||||
{
|
||||
std::wstring_view input = L" hello";
|
||||
auto result = left_trim(input);
|
||||
Assert::AreEqual(std::wstring_view(L"hello"), result);
|
||||
}
|
||||
|
||||
// right_trim tests
|
||||
TEST_METHOD(RightTrim_EmptyString_ReturnsEmpty)
|
||||
{
|
||||
std::string_view input = "";
|
||||
auto result = right_trim(input);
|
||||
Assert::AreEqual(std::string_view(""), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(RightTrim_NoWhitespace_ReturnsOriginal)
|
||||
{
|
||||
std::string_view input = "hello";
|
||||
auto result = right_trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(RightTrim_TrailingSpaces_TrimsSpaces)
|
||||
{
|
||||
std::string_view input = "hello ";
|
||||
auto result = right_trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(RightTrim_TrailingTabs_TrimsTabs)
|
||||
{
|
||||
std::string_view input = "hello\t\t";
|
||||
auto result = right_trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(RightTrim_TrailingNewlines_TrimsNewlines)
|
||||
{
|
||||
std::string_view input = "hello\r\n\n";
|
||||
auto result = right_trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(RightTrim_LeadingWhitespace_PreservesLeading)
|
||||
{
|
||||
std::string_view input = " hello ";
|
||||
auto result = right_trim(input);
|
||||
Assert::AreEqual(std::string_view(" hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(RightTrim_OnlyWhitespace_ReturnsEmpty)
|
||||
{
|
||||
std::string_view input = " \t\r\n";
|
||||
auto result = right_trim(input);
|
||||
Assert::AreEqual(std::string_view(""), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(RightTrim_CustomChars_TrimsSpecified)
|
||||
{
|
||||
std::string_view input = "helloxxx";
|
||||
auto result = right_trim(input, std::string_view("x"));
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(RightTrim_WideString_Works)
|
||||
{
|
||||
std::wstring_view input = L"hello ";
|
||||
auto result = right_trim(input);
|
||||
Assert::AreEqual(std::wstring_view(L"hello"), result);
|
||||
}
|
||||
|
||||
// trim tests
|
||||
TEST_METHOD(Trim_EmptyString_ReturnsEmpty)
|
||||
{
|
||||
std::string_view input = "";
|
||||
auto result = trim(input);
|
||||
Assert::AreEqual(std::string_view(""), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Trim_NoWhitespace_ReturnsOriginal)
|
||||
{
|
||||
std::string_view input = "hello";
|
||||
auto result = trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Trim_BothSides_TrimsBoth)
|
||||
{
|
||||
std::string_view input = " hello ";
|
||||
auto result = trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Trim_MixedWhitespace_TrimsAll)
|
||||
{
|
||||
std::string_view input = " \t\r\nhello \t\r\n";
|
||||
auto result = trim(input);
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Trim_InternalWhitespace_Preserved)
|
||||
{
|
||||
std::string_view input = " hello world ";
|
||||
auto result = trim(input);
|
||||
Assert::AreEqual(std::string_view("hello world"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Trim_OnlyWhitespace_ReturnsEmpty)
|
||||
{
|
||||
std::string_view input = " \t\r\n ";
|
||||
auto result = trim(input);
|
||||
Assert::AreEqual(std::string_view(""), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Trim_CustomChars_TrimsSpecified)
|
||||
{
|
||||
std::string_view input = "xxxhelloxxx";
|
||||
auto result = trim(input, std::string_view("x"));
|
||||
Assert::AreEqual(std::string_view("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Trim_WideString_Works)
|
||||
{
|
||||
std::wstring_view input = L" hello ";
|
||||
auto result = trim(input);
|
||||
Assert::AreEqual(std::wstring_view(L"hello"), result);
|
||||
}
|
||||
|
||||
// replace_chars tests
|
||||
TEST_METHOD(ReplaceChars_EmptyString_NoChange)
|
||||
{
|
||||
std::string s = "";
|
||||
replace_chars(s, std::string_view("abc"), 'x');
|
||||
Assert::AreEqual(std::string(""), s);
|
||||
}
|
||||
|
||||
TEST_METHOD(ReplaceChars_NoMatchingChars_NoChange)
|
||||
{
|
||||
std::string s = "hello";
|
||||
replace_chars(s, std::string_view("xyz"), '_');
|
||||
Assert::AreEqual(std::string("hello"), s);
|
||||
}
|
||||
|
||||
TEST_METHOD(ReplaceChars_SingleChar_Replaces)
|
||||
{
|
||||
std::string s = "hello";
|
||||
replace_chars(s, std::string_view("l"), '_');
|
||||
Assert::AreEqual(std::string("he__o"), s);
|
||||
}
|
||||
|
||||
TEST_METHOD(ReplaceChars_MultipleChars_ReplacesAll)
|
||||
{
|
||||
std::string s = "hello world";
|
||||
replace_chars(s, std::string_view("lo"), '_');
|
||||
Assert::AreEqual(std::string("he___ w_r_d"), s);
|
||||
}
|
||||
|
||||
TEST_METHOD(ReplaceChars_WideString_Works)
|
||||
{
|
||||
std::wstring s = L"hello";
|
||||
replace_chars(s, std::wstring_view(L"l"), L'_');
|
||||
Assert::AreEqual(std::wstring(L"he__o"), s);
|
||||
}
|
||||
|
||||
// unwide tests
|
||||
TEST_METHOD(Unwide_EmptyString_ReturnsEmpty)
|
||||
{
|
||||
std::wstring input = L"";
|
||||
auto result = unwide(input);
|
||||
Assert::AreEqual(std::string(""), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Unwide_AsciiString_Converts)
|
||||
{
|
||||
std::wstring input = L"hello";
|
||||
auto result = unwide(input);
|
||||
Assert::AreEqual(std::string("hello"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Unwide_WithNumbers_Converts)
|
||||
{
|
||||
std::wstring input = L"test123";
|
||||
auto result = unwide(input);
|
||||
Assert::AreEqual(std::string("test123"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Unwide_WithSpecialChars_Converts)
|
||||
{
|
||||
std::wstring input = L"test!@#$%";
|
||||
auto result = unwide(input);
|
||||
Assert::AreEqual(std::string("test!@#$%"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Unwide_MixedCase_PreservesCase)
|
||||
{
|
||||
std::wstring input = L"HeLLo WoRLd";
|
||||
auto result = unwide(input);
|
||||
Assert::AreEqual(std::string("HeLLo WoRLd"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(Unwide_LongString_Works)
|
||||
{
|
||||
std::wstring input = L"This is a longer string with multiple words and punctuation!";
|
||||
auto result = unwide(input);
|
||||
Assert::AreEqual(std::string("This is a longer string with multiple words and punctuation!"), result);
|
||||
}
|
||||
};
|
||||
}
|
||||
192
src/common/UnitTests-CommonUtils/TestHelpers.h
Normal file
192
src/common/UnitTests-CommonUtils/TestHelpers.h
Normal file
@@ -0,0 +1,192 @@
|
||||
#pragma once
|
||||
|
||||
#include "pch.h"
|
||||
#include <string>
|
||||
#include <filesystem>
|
||||
#include <fstream>
|
||||
#include <random>
|
||||
|
||||
namespace TestHelpers
|
||||
{
|
||||
// RAII helper for creating and cleaning up temporary files
|
||||
class TempFile
|
||||
{
|
||||
public:
|
||||
TempFile(const std::wstring& content = L"", const std::wstring& extension = L".txt")
|
||||
{
|
||||
wchar_t tempPath[MAX_PATH];
|
||||
GetTempPathW(MAX_PATH, tempPath);
|
||||
|
||||
// Generate a unique filename
|
||||
std::random_device rd;
|
||||
std::mt19937 gen(rd());
|
||||
std::uniform_int_distribution<> dis(10000, 99999);
|
||||
|
||||
m_path = std::wstring(tempPath) + L"test_" + std::to_wstring(dis(gen)) + extension;
|
||||
|
||||
if (!content.empty())
|
||||
{
|
||||
std::wofstream file(m_path);
|
||||
file << content;
|
||||
}
|
||||
}
|
||||
|
||||
~TempFile()
|
||||
{
|
||||
if (std::filesystem::exists(m_path))
|
||||
{
|
||||
std::filesystem::remove(m_path);
|
||||
}
|
||||
}
|
||||
|
||||
TempFile(const TempFile&) = delete;
|
||||
TempFile& operator=(const TempFile&) = delete;
|
||||
|
||||
const std::wstring& path() const { return m_path; }
|
||||
|
||||
void write(const std::string& content)
|
||||
{
|
||||
std::ofstream file(m_path, std::ios::binary);
|
||||
file << content;
|
||||
}
|
||||
|
||||
void write(const std::wstring& content)
|
||||
{
|
||||
std::wofstream file(m_path);
|
||||
file << content;
|
||||
}
|
||||
|
||||
std::wstring read()
|
||||
{
|
||||
std::wifstream file(m_path);
|
||||
return std::wstring((std::istreambuf_iterator<wchar_t>(file)),
|
||||
std::istreambuf_iterator<wchar_t>());
|
||||
}
|
||||
|
||||
private:
|
||||
std::wstring m_path;
|
||||
};
|
||||
|
||||
// RAII helper for creating and cleaning up temporary directories
|
||||
class TempDirectory
|
||||
{
|
||||
public:
|
||||
TempDirectory()
|
||||
{
|
||||
wchar_t tempPath[MAX_PATH];
|
||||
GetTempPathW(MAX_PATH, tempPath);
|
||||
|
||||
std::random_device rd;
|
||||
std::mt19937 gen(rd());
|
||||
std::uniform_int_distribution<> dis(10000, 99999);
|
||||
|
||||
m_path = std::wstring(tempPath) + L"testdir_" + std::to_wstring(dis(gen));
|
||||
std::filesystem::create_directories(m_path);
|
||||
}
|
||||
|
||||
~TempDirectory()
|
||||
{
|
||||
if (std::filesystem::exists(m_path))
|
||||
{
|
||||
std::filesystem::remove_all(m_path);
|
||||
}
|
||||
}
|
||||
|
||||
TempDirectory(const TempDirectory&) = delete;
|
||||
TempDirectory& operator=(const TempDirectory&) = delete;
|
||||
|
||||
const std::wstring& path() const { return m_path; }
|
||||
|
||||
private:
|
||||
std::wstring m_path;
|
||||
};
|
||||
|
||||
// Registry test key path - use HKCU for non-elevated tests
|
||||
inline const std::wstring TestRegistryPath = L"Software\\PowerToys\\UnitTests";
|
||||
|
||||
// RAII helper for registry key creation/cleanup
|
||||
class TestRegistryKey
|
||||
{
|
||||
public:
|
||||
TestRegistryKey(const std::wstring& subKey = L"")
|
||||
{
|
||||
m_path = TestRegistryPath;
|
||||
if (!subKey.empty())
|
||||
{
|
||||
m_path += L"\\" + subKey;
|
||||
}
|
||||
|
||||
HKEY key;
|
||||
if (RegCreateKeyExW(HKEY_CURRENT_USER, m_path.c_str(), 0, nullptr,
|
||||
REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, nullptr,
|
||||
&key, nullptr) == ERROR_SUCCESS)
|
||||
{
|
||||
RegCloseKey(key);
|
||||
m_created = true;
|
||||
}
|
||||
}
|
||||
|
||||
~TestRegistryKey()
|
||||
{
|
||||
if (m_created)
|
||||
{
|
||||
RegDeleteTreeW(HKEY_CURRENT_USER, m_path.c_str());
|
||||
}
|
||||
}
|
||||
|
||||
TestRegistryKey(const TestRegistryKey&) = delete;
|
||||
TestRegistryKey& operator=(const TestRegistryKey&) = delete;
|
||||
|
||||
bool isValid() const { return m_created; }
|
||||
const std::wstring& path() const { return m_path; }
|
||||
|
||||
bool setStringValue(const std::wstring& name, const std::wstring& value)
|
||||
{
|
||||
HKEY key;
|
||||
if (RegOpenKeyExW(HKEY_CURRENT_USER, m_path.c_str(), 0, KEY_SET_VALUE, &key) != ERROR_SUCCESS)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
auto result = RegSetValueExW(key, name.c_str(), 0, REG_SZ,
|
||||
reinterpret_cast<const BYTE*>(value.c_str()),
|
||||
static_cast<DWORD>((value.length() + 1) * sizeof(wchar_t)));
|
||||
RegCloseKey(key);
|
||||
return result == ERROR_SUCCESS;
|
||||
}
|
||||
|
||||
bool setDwordValue(const std::wstring& name, DWORD value)
|
||||
{
|
||||
HKEY key;
|
||||
if (RegOpenKeyExW(HKEY_CURRENT_USER, m_path.c_str(), 0, KEY_SET_VALUE, &key) != ERROR_SUCCESS)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
auto result = RegSetValueExW(key, name.c_str(), 0, REG_DWORD,
|
||||
reinterpret_cast<const BYTE*>(&value), sizeof(DWORD));
|
||||
RegCloseKey(key);
|
||||
return result == ERROR_SUCCESS;
|
||||
}
|
||||
|
||||
private:
|
||||
std::wstring m_path;
|
||||
bool m_created = false;
|
||||
};
|
||||
|
||||
// Helper to wait for a condition with timeout
|
||||
template<typename Predicate>
|
||||
bool WaitFor(Predicate pred, std::chrono::milliseconds timeout = std::chrono::milliseconds(5000))
|
||||
{
|
||||
auto start = std::chrono::steady_clock::now();
|
||||
while (!pred())
|
||||
{
|
||||
if (std::chrono::steady_clock::now() - start > timeout)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(10));
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
||||
14
src/common/UnitTests-CommonUtils/TestStubs.cpp
Normal file
14
src/common/UnitTests-CommonUtils/TestStubs.cpp
Normal file
@@ -0,0 +1,14 @@
|
||||
#include "pch.h"
|
||||
#include <common/logger/logger.h>
|
||||
#include <common/SettingsAPI/settings_helpers.h>
|
||||
#include <spdlog/sinks/null_sink.h>
|
||||
|
||||
std::shared_ptr<spdlog::logger> Logger::logger = spdlog::null_logger_mt("Common.Utils.UnitTests");
|
||||
|
||||
namespace PTSettingsHelper
|
||||
{
|
||||
std::wstring get_root_save_folder_location()
|
||||
{
|
||||
return L"";
|
||||
}
|
||||
}
|
||||
336
src/common/UnitTests-CommonUtils/Threading.Tests.cpp
Normal file
336
src/common/UnitTests-CommonUtils/Threading.Tests.cpp
Normal file
@@ -0,0 +1,336 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <OnThreadExecutor.h>
|
||||
#include <EventWaiter.h>
|
||||
#include <EventLocker.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(OnThreadExecutorTests)
|
||||
{
|
||||
public:
|
||||
TEST_METHOD(Constructor_CreatesInstance)
|
||||
{
|
||||
OnThreadExecutor executor;
|
||||
// Should not crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(Submit_SingleTask_Executes)
|
||||
{
|
||||
OnThreadExecutor executor;
|
||||
std::atomic<bool> executed{ false };
|
||||
|
||||
auto future = executor.submit(OnThreadExecutor::task_t([&executed]() {
|
||||
executed = true;
|
||||
}));
|
||||
|
||||
future.wait();
|
||||
Assert::IsTrue(executed);
|
||||
}
|
||||
|
||||
TEST_METHOD(Submit_MultipleTasks_ExecutesAll)
|
||||
{
|
||||
OnThreadExecutor executor;
|
||||
std::atomic<int> counter{ 0 };
|
||||
|
||||
std::vector<std::future<void>> futures;
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
futures.push_back(executor.submit(OnThreadExecutor::task_t([&counter]() {
|
||||
counter++;
|
||||
})));
|
||||
}
|
||||
|
||||
for (auto& f : futures)
|
||||
{
|
||||
f.wait();
|
||||
}
|
||||
|
||||
Assert::AreEqual(10, counter.load());
|
||||
}
|
||||
|
||||
TEST_METHOD(Submit_TasksExecuteInOrder)
|
||||
{
|
||||
OnThreadExecutor executor;
|
||||
std::vector<int> order;
|
||||
std::mutex orderMutex;
|
||||
|
||||
std::vector<std::future<void>> futures;
|
||||
for (int i = 0; i < 5; ++i)
|
||||
{
|
||||
futures.push_back(executor.submit(OnThreadExecutor::task_t([&order, &orderMutex, i]() {
|
||||
std::lock_guard lock(orderMutex);
|
||||
order.push_back(i);
|
||||
})));
|
||||
}
|
||||
|
||||
for (auto& f : futures)
|
||||
{
|
||||
f.wait();
|
||||
}
|
||||
|
||||
Assert::AreEqual(static_cast<size_t>(5), order.size());
|
||||
for (int i = 0; i < 5; ++i)
|
||||
{
|
||||
Assert::AreEqual(i, order[i]);
|
||||
}
|
||||
}
|
||||
|
||||
TEST_METHOD(Submit_TaskReturnsResult)
|
||||
{
|
||||
OnThreadExecutor executor;
|
||||
std::atomic<int> result{ 0 };
|
||||
|
||||
auto future = executor.submit(OnThreadExecutor::task_t([&result]() {
|
||||
result = 42;
|
||||
}));
|
||||
|
||||
future.wait();
|
||||
Assert::AreEqual(42, result.load());
|
||||
}
|
||||
|
||||
TEST_METHOD(Cancel_ClearsPendingTasks)
|
||||
{
|
||||
OnThreadExecutor executor;
|
||||
std::atomic<int> counter{ 0 };
|
||||
|
||||
// Submit a slow task first
|
||||
executor.submit(OnThreadExecutor::task_t([&counter]() {
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
counter++;
|
||||
}));
|
||||
|
||||
// Submit more tasks
|
||||
for (int i = 0; i < 5; ++i)
|
||||
{
|
||||
executor.submit(OnThreadExecutor::task_t([&counter]() {
|
||||
counter++;
|
||||
}));
|
||||
}
|
||||
|
||||
// Cancel pending tasks
|
||||
executor.cancel();
|
||||
|
||||
// Wait a bit for any running task to complete
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(200));
|
||||
|
||||
// Not all tasks should have executed
|
||||
Assert::IsTrue(counter < 6);
|
||||
}
|
||||
|
||||
TEST_METHOD(Destructor_WaitsForCompletion)
|
||||
{
|
||||
std::atomic<bool> completed{ false };
|
||||
std::future<void> future;
|
||||
|
||||
{
|
||||
OnThreadExecutor executor;
|
||||
future = executor.submit(OnThreadExecutor::task_t([&completed]() {
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(50));
|
||||
completed = true;
|
||||
}));
|
||||
future.wait();
|
||||
} // Destructor no longer required to wait for completion
|
||||
|
||||
Assert::IsTrue(completed);
|
||||
}
|
||||
|
||||
TEST_METHOD(Submit_AfterCancel_StillWorks)
|
||||
{
|
||||
OnThreadExecutor executor;
|
||||
std::atomic<int> counter{ 0 };
|
||||
|
||||
executor.submit(OnThreadExecutor::task_t([&counter]() {
|
||||
counter++;
|
||||
}));
|
||||
executor.cancel();
|
||||
|
||||
auto future = executor.submit(OnThreadExecutor::task_t([&counter]() {
|
||||
counter = 42;
|
||||
}));
|
||||
future.wait();
|
||||
|
||||
Assert::AreEqual(42, counter.load());
|
||||
}
|
||||
};
|
||||
|
||||
TEST_CLASS(EventWaiterTests)
|
||||
{
|
||||
public:
|
||||
TEST_METHOD(Constructor_CreatesInstance)
|
||||
{
|
||||
EventWaiter waiter;
|
||||
Assert::IsFalse(waiter.is_listening());
|
||||
}
|
||||
|
||||
TEST_METHOD(Start_ValidEvent_ReturnsTrue)
|
||||
{
|
||||
EventWaiter waiter;
|
||||
bool result = waiter.start(L"TestEvent_Start", [](DWORD) {});
|
||||
Assert::IsTrue(result);
|
||||
Assert::IsTrue(waiter.is_listening());
|
||||
waiter.stop();
|
||||
}
|
||||
|
||||
TEST_METHOD(Start_AlreadyListening_ReturnsFalse)
|
||||
{
|
||||
EventWaiter waiter;
|
||||
waiter.start(L"TestEvent_Double1", [](DWORD) {});
|
||||
bool result = waiter.start(L"TestEvent_Double2", [](DWORD) {});
|
||||
Assert::IsFalse(result);
|
||||
waiter.stop();
|
||||
}
|
||||
|
||||
TEST_METHOD(Stop_WhileListening_StopsListening)
|
||||
{
|
||||
EventWaiter waiter;
|
||||
waiter.start(L"TestEvent_Stop", [](DWORD) {});
|
||||
Assert::IsTrue(waiter.is_listening());
|
||||
|
||||
waiter.stop();
|
||||
Assert::IsFalse(waiter.is_listening());
|
||||
}
|
||||
|
||||
TEST_METHOD(Stop_WhenNotListening_DoesNotCrash)
|
||||
{
|
||||
EventWaiter waiter;
|
||||
waiter.stop(); // Should not crash
|
||||
Assert::IsFalse(waiter.is_listening());
|
||||
}
|
||||
|
||||
TEST_METHOD(Stop_CalledMultipleTimes_DoesNotCrash)
|
||||
{
|
||||
EventWaiter waiter;
|
||||
waiter.start(L"TestEvent_MultiStop", [](DWORD) {});
|
||||
waiter.stop();
|
||||
waiter.stop();
|
||||
waiter.stop();
|
||||
Assert::IsFalse(waiter.is_listening());
|
||||
}
|
||||
|
||||
TEST_METHOD(Callback_EventSignaled_CallsCallback)
|
||||
{
|
||||
EventWaiter waiter;
|
||||
std::atomic<bool> called{ false };
|
||||
std::atomic<DWORD> errorCode{ 0xFFFFFFFF };
|
||||
|
||||
// Create a named event we can signal
|
||||
std::wstring eventName = L"TestEvent_Callback_" + std::to_wstring(GetCurrentProcessId());
|
||||
HANDLE signalEvent = CreateEventW(nullptr, FALSE, FALSE, eventName.c_str());
|
||||
Assert::IsNotNull(signalEvent);
|
||||
|
||||
waiter.start(eventName, [&called, &errorCode](DWORD err) {
|
||||
errorCode = err;
|
||||
called = true;
|
||||
});
|
||||
|
||||
// Signal the event
|
||||
SetEvent(signalEvent);
|
||||
|
||||
// Wait for callback
|
||||
bool waitResult = TestHelpers::WaitFor([&called]() { return called.load(); }, std::chrono::milliseconds(1000));
|
||||
|
||||
waiter.stop();
|
||||
CloseHandle(signalEvent);
|
||||
|
||||
Assert::IsTrue(waitResult);
|
||||
Assert::AreEqual(static_cast<DWORD>(ERROR_SUCCESS), errorCode.load());
|
||||
}
|
||||
|
||||
TEST_METHOD(Destructor_StopsListening)
|
||||
{
|
||||
std::atomic<bool> isListening{ false };
|
||||
{
|
||||
EventWaiter waiter;
|
||||
waiter.start(L"TestEvent_Destructor", [](DWORD) {});
|
||||
isListening = waiter.is_listening();
|
||||
}
|
||||
// After destruction, the waiter should have stopped
|
||||
Assert::IsTrue(isListening);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsListening_InitialState_ReturnsFalse)
|
||||
{
|
||||
EventWaiter waiter;
|
||||
Assert::IsFalse(waiter.is_listening());
|
||||
}
|
||||
|
||||
TEST_METHOD(IsListening_AfterStart_ReturnsTrue)
|
||||
{
|
||||
EventWaiter waiter;
|
||||
waiter.start(L"TestEvent_IsListening", [](DWORD) {});
|
||||
Assert::IsTrue(waiter.is_listening());
|
||||
waiter.stop();
|
||||
}
|
||||
|
||||
TEST_METHOD(IsListening_AfterStop_ReturnsFalse)
|
||||
{
|
||||
EventWaiter waiter;
|
||||
waiter.start(L"TestEvent_AfterStop", [](DWORD) {});
|
||||
waiter.stop();
|
||||
Assert::IsFalse(waiter.is_listening());
|
||||
}
|
||||
};
|
||||
|
||||
TEST_CLASS(EventLockerTests)
|
||||
{
|
||||
public:
|
||||
TEST_METHOD(Get_ValidEventName_ReturnsLocker)
|
||||
{
|
||||
std::wstring eventName = L"TestEventLocker_" + std::to_wstring(GetCurrentProcessId());
|
||||
auto locker = EventLocker::Get(eventName);
|
||||
Assert::IsTrue(locker.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(Get_UniqueNames_CreatesSeparateLockers)
|
||||
{
|
||||
auto locker1 = EventLocker::Get(L"TestEventLocker1_" + std::to_wstring(GetCurrentProcessId()));
|
||||
auto locker2 = EventLocker::Get(L"TestEventLocker2_" + std::to_wstring(GetCurrentProcessId()));
|
||||
Assert::IsTrue(locker1.has_value());
|
||||
Assert::IsTrue(locker2.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(Destructor_CleansUpHandle)
|
||||
{
|
||||
std::wstring eventName = L"TestEventLockerCleanup_" + std::to_wstring(GetCurrentProcessId());
|
||||
{
|
||||
auto locker = EventLocker::Get(eventName);
|
||||
Assert::IsTrue(locker.has_value());
|
||||
}
|
||||
// After destruction, the event should be cleaned up
|
||||
// Creating a new one should succeed
|
||||
auto newLocker = EventLocker::Get(eventName);
|
||||
Assert::IsTrue(newLocker.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(MoveConstructor_TransfersOwnership)
|
||||
{
|
||||
std::wstring eventName = L"TestEventLockerMove_" + std::to_wstring(GetCurrentProcessId());
|
||||
auto locker1 = EventLocker::Get(eventName);
|
||||
Assert::IsTrue(locker1.has_value());
|
||||
|
||||
EventLocker locker2 = std::move(*locker1);
|
||||
// Move should transfer ownership without crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
TEST_METHOD(MoveAssignment_TransfersOwnership)
|
||||
{
|
||||
std::wstring eventName1 = L"TestEventLockerMoveAssign1_" + std::to_wstring(GetCurrentProcessId());
|
||||
std::wstring eventName2 = L"TestEventLockerMoveAssign2_" + std::to_wstring(GetCurrentProcessId());
|
||||
|
||||
auto locker1 = EventLocker::Get(eventName1);
|
||||
auto locker2 = EventLocker::Get(eventName2);
|
||||
|
||||
Assert::IsTrue(locker1.has_value());
|
||||
Assert::IsTrue(locker2.has_value());
|
||||
|
||||
*locker1 = std::move(*locker2);
|
||||
// Should not crash
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
};
|
||||
}
|
||||
248
src/common/UnitTests-CommonUtils/TimeUtils.Tests.cpp
Normal file
248
src/common/UnitTests-CommonUtils/TimeUtils.Tests.cpp
Normal file
@@ -0,0 +1,248 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <timeutil.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(TimeUtilsTests)
|
||||
{
|
||||
public:
|
||||
// to_string tests
|
||||
TEST_METHOD(ToString_ZeroTime_ReturnsZero)
|
||||
{
|
||||
time_t t = 0;
|
||||
auto result = timeutil::to_string(t);
|
||||
Assert::AreEqual(std::wstring(L"0"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(ToString_PositiveTime_ReturnsString)
|
||||
{
|
||||
time_t t = 1234567890;
|
||||
auto result = timeutil::to_string(t);
|
||||
Assert::AreEqual(std::wstring(L"1234567890"), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(ToString_LargeTime_ReturnsString)
|
||||
{
|
||||
time_t t = 1700000000;
|
||||
auto result = timeutil::to_string(t);
|
||||
Assert::AreEqual(std::wstring(L"1700000000"), result);
|
||||
}
|
||||
|
||||
// from_string tests
|
||||
TEST_METHOD(FromString_ZeroString_ReturnsZero)
|
||||
{
|
||||
auto result = timeutil::from_string(L"0");
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::AreEqual(static_cast<time_t>(0), result.value());
|
||||
}
|
||||
|
||||
TEST_METHOD(FromString_ValidNumber_ReturnsTime)
|
||||
{
|
||||
auto result = timeutil::from_string(L"1234567890");
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::AreEqual(static_cast<time_t>(1234567890), result.value());
|
||||
}
|
||||
|
||||
TEST_METHOD(FromString_InvalidString_ReturnsNullopt)
|
||||
{
|
||||
auto result = timeutil::from_string(L"invalid");
|
||||
Assert::IsFalse(result.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(FromString_EmptyString_ReturnsNullopt)
|
||||
{
|
||||
auto result = timeutil::from_string(L"");
|
||||
Assert::IsFalse(result.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(FromString_MixedAlphaNumeric_ReturnsNullopt)
|
||||
{
|
||||
auto result = timeutil::from_string(L"123abc");
|
||||
Assert::IsFalse(result.has_value());
|
||||
}
|
||||
|
||||
TEST_METHOD(FromString_NegativeNumber_ReturnsNullopt)
|
||||
{
|
||||
auto result = timeutil::from_string(L"-1");
|
||||
Assert::IsFalse(result.has_value());
|
||||
}
|
||||
|
||||
// Roundtrip test
|
||||
TEST_METHOD(ToStringFromString_Roundtrip_Works)
|
||||
{
|
||||
time_t original = 1609459200; // 2021-01-01 00:00:00 UTC
|
||||
auto str = timeutil::to_string(original);
|
||||
auto result = timeutil::from_string(str);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::AreEqual(original, result.value());
|
||||
}
|
||||
|
||||
// now tests
|
||||
TEST_METHOD(Now_ReturnsReasonableTime)
|
||||
{
|
||||
auto result = timeutil::now();
|
||||
// Should be after 2020 and before 2100
|
||||
Assert::IsTrue(result > 1577836800); // 2020-01-01
|
||||
Assert::IsTrue(result < 4102444800); // 2100-01-01
|
||||
}
|
||||
|
||||
TEST_METHOD(Now_TwoCallsAreCloseInTime)
|
||||
{
|
||||
auto first = timeutil::now();
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
auto second = timeutil::now();
|
||||
// Difference should be less than 2 seconds
|
||||
Assert::IsTrue(second >= first);
|
||||
Assert::IsTrue(second - first < 2);
|
||||
}
|
||||
|
||||
// diff::in_seconds tests
|
||||
TEST_METHOD(DiffInSeconds_SameTime_ReturnsZero)
|
||||
{
|
||||
time_t t = 1000000;
|
||||
auto result = timeutil::diff::in_seconds(t, t);
|
||||
Assert::AreEqual(static_cast<int64_t>(0), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInSeconds_OneDifference_ReturnsOne)
|
||||
{
|
||||
time_t to = 1000001;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_seconds(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(1), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInSeconds_60Seconds_Returns60)
|
||||
{
|
||||
time_t to = 1000060;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_seconds(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(60), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInSeconds_NegativeDiff_ReturnsNegative)
|
||||
{
|
||||
time_t to = 1000000;
|
||||
time_t from = 1000060;
|
||||
auto result = timeutil::diff::in_seconds(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(-60), result);
|
||||
}
|
||||
|
||||
// diff::in_minutes tests
|
||||
TEST_METHOD(DiffInMinutes_SameTime_ReturnsZero)
|
||||
{
|
||||
time_t t = 1000000;
|
||||
auto result = timeutil::diff::in_minutes(t, t);
|
||||
Assert::AreEqual(static_cast<int64_t>(0), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInMinutes_OneMinute_ReturnsOne)
|
||||
{
|
||||
time_t to = 1000060;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_minutes(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(1), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInMinutes_60Minutes_Returns60)
|
||||
{
|
||||
time_t to = 1003600;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_minutes(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(60), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInMinutes_LessThanMinute_ReturnsZero)
|
||||
{
|
||||
time_t to = 1000059;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_minutes(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(0), result);
|
||||
}
|
||||
|
||||
// diff::in_hours tests
|
||||
TEST_METHOD(DiffInHours_SameTime_ReturnsZero)
|
||||
{
|
||||
time_t t = 1000000;
|
||||
auto result = timeutil::diff::in_hours(t, t);
|
||||
Assert::AreEqual(static_cast<int64_t>(0), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInHours_OneHour_ReturnsOne)
|
||||
{
|
||||
time_t to = 1003600;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_hours(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(1), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInHours_24Hours_Returns24)
|
||||
{
|
||||
time_t to = 1086400;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_hours(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(24), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInHours_LessThanHour_ReturnsZero)
|
||||
{
|
||||
time_t to = 1003599;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_hours(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(0), result);
|
||||
}
|
||||
|
||||
// diff::in_days tests
|
||||
TEST_METHOD(DiffInDays_SameTime_ReturnsZero)
|
||||
{
|
||||
time_t t = 1000000;
|
||||
auto result = timeutil::diff::in_days(t, t);
|
||||
Assert::AreEqual(static_cast<int64_t>(0), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInDays_OneDay_ReturnsOne)
|
||||
{
|
||||
time_t to = 1086400;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_days(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(1), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInDays_7Days_Returns7)
|
||||
{
|
||||
time_t to = 1604800;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_days(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(7), result);
|
||||
}
|
||||
|
||||
TEST_METHOD(DiffInDays_LessThanDay_ReturnsZero)
|
||||
{
|
||||
time_t to = 1086399;
|
||||
time_t from = 1000000;
|
||||
auto result = timeutil::diff::in_days(to, from);
|
||||
Assert::AreEqual(static_cast<int64_t>(0), result);
|
||||
}
|
||||
|
||||
// format_as_local tests
|
||||
TEST_METHOD(FormatAsLocal_YearFormat_ReturnsYear)
|
||||
{
|
||||
time_t t = 1609459200; // 2021-01-01 00:00:00 UTC
|
||||
auto result = timeutil::format_as_local("%Y", t);
|
||||
// Result depends on local timezone, but year should be 2020 or 2021
|
||||
Assert::IsTrue(result == "2020" || result == "2021");
|
||||
}
|
||||
|
||||
TEST_METHOD(FormatAsLocal_DateFormat_ReturnsDate)
|
||||
{
|
||||
time_t t = 0; // 1970-01-01 00:00:00 UTC
|
||||
auto result = timeutil::format_as_local("%Y-%m-%d", t);
|
||||
// Result should be a date around 1970-01-01 depending on timezone
|
||||
Assert::IsTrue(result.length() == 10); // YYYY-MM-DD format
|
||||
Assert::IsTrue(result.substr(0, 4) == "1969" || result.substr(0, 4) == "1970");
|
||||
}
|
||||
};
|
||||
}
|
||||
210
src/common/UnitTests-CommonUtils/UnhandledException.Tests.cpp
Normal file
210
src/common/UnitTests-CommonUtils/UnhandledException.Tests.cpp
Normal file
@@ -0,0 +1,210 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <UnhandledExceptionHandler.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(UnhandledExceptionTests)
|
||||
{
|
||||
public:
|
||||
// exceptionDescription tests
|
||||
TEST_METHOD(ExceptionDescription_AccessViolation_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_ACCESS_VIOLATION);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
// Should contain meaningful description
|
||||
std::string desc{ result };
|
||||
Assert::IsTrue(desc.find("ACCESS") != std::string::npos ||
|
||||
desc.find("access") != std::string::npos ||
|
||||
desc.find("violation") != std::string::npos ||
|
||||
desc.length() > 0);
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_StackOverflow_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_STACK_OVERFLOW);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_DivideByZero_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_INT_DIVIDE_BY_ZERO);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_IllegalInstruction_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_ILLEGAL_INSTRUCTION);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_ArrayBoundsExceeded_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_ARRAY_BOUNDS_EXCEEDED);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_Breakpoint_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_BREAKPOINT);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_SingleStep_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_SINGLE_STEP);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_FloatDivideByZero_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_FLT_DIVIDE_BY_ZERO);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_FloatOverflow_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_FLT_OVERFLOW);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_FloatUnderflow_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_FLT_UNDERFLOW);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_FloatInvalidOperation_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_FLT_INVALID_OPERATION);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_PrivilegedInstruction_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_PRIV_INSTRUCTION);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_InPageError_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(EXCEPTION_IN_PAGE_ERROR);
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_UnknownCode_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(0x12345678);
|
||||
// Should return something (possibly "Unknown exception" or similar)
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
TEST_METHOD(ExceptionDescription_ZeroCode_ReturnsDescription)
|
||||
{
|
||||
auto result = exceptionDescription(0);
|
||||
// Should handle zero gracefully
|
||||
Assert::IsTrue(result && *result != '\0');
|
||||
}
|
||||
|
||||
// GetFilenameStart tests (if accessible)
|
||||
TEST_METHOD(GetFilenameStart_ValidPath_ReturnsFilename)
|
||||
{
|
||||
wchar_t path[] = L"C:\\folder\\subfolder\\file.exe";
|
||||
int start = GetFilenameStart(path);
|
||||
|
||||
Assert::IsTrue(start >= 0);
|
||||
Assert::AreEqual(std::wstring(L"file.exe"), std::wstring(path + start));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetFilenameStart_NoPath_ReturnsOriginal)
|
||||
{
|
||||
wchar_t path[] = L"file.exe";
|
||||
int start = GetFilenameStart(path);
|
||||
|
||||
Assert::IsTrue(start >= 0);
|
||||
Assert::AreEqual(std::wstring(L"file.exe"), std::wstring(path + start));
|
||||
}
|
||||
|
||||
TEST_METHOD(GetFilenameStart_TrailingBackslash_ReturnsEmpty)
|
||||
{
|
||||
wchar_t path[] = L"C:\\folder\\";
|
||||
int start = GetFilenameStart(path);
|
||||
|
||||
// Should point to empty string after last backslash
|
||||
Assert::IsTrue(start >= 0);
|
||||
}
|
||||
|
||||
TEST_METHOD(GetFilenameStart_NullPath_HandlesGracefully)
|
||||
{
|
||||
// This might crash or return null depending on implementation
|
||||
// Just document the behavior
|
||||
int start = GetFilenameStart(nullptr);
|
||||
(void)start;
|
||||
// Result is implementation-defined for null input
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
|
||||
// Thread safety tests
|
||||
TEST_METHOD(ExceptionDescription_ThreadSafe)
|
||||
{
|
||||
std::vector<std::thread> threads;
|
||||
std::atomic<int> successCount{ 0 };
|
||||
|
||||
for (int i = 0; i < 10; ++i)
|
||||
{
|
||||
threads.emplace_back([&successCount]() {
|
||||
for (int j = 0; j < 10; ++j)
|
||||
{
|
||||
auto desc = exceptionDescription(EXCEPTION_ACCESS_VIOLATION);
|
||||
if (desc && *desc != '\0')
|
||||
{
|
||||
successCount++;
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (auto& t : threads)
|
||||
{
|
||||
t.join();
|
||||
}
|
||||
|
||||
Assert::AreEqual(100, successCount.load());
|
||||
}
|
||||
|
||||
// All exception codes test
|
||||
TEST_METHOD(ExceptionDescription_AllCommonCodes_ReturnDescriptions)
|
||||
{
|
||||
std::vector<DWORD> codes = {
|
||||
EXCEPTION_ACCESS_VIOLATION,
|
||||
EXCEPTION_ARRAY_BOUNDS_EXCEEDED,
|
||||
EXCEPTION_BREAKPOINT,
|
||||
EXCEPTION_DATATYPE_MISALIGNMENT,
|
||||
EXCEPTION_FLT_DENORMAL_OPERAND,
|
||||
EXCEPTION_FLT_DIVIDE_BY_ZERO,
|
||||
EXCEPTION_FLT_INEXACT_RESULT,
|
||||
EXCEPTION_FLT_INVALID_OPERATION,
|
||||
EXCEPTION_FLT_OVERFLOW,
|
||||
EXCEPTION_FLT_STACK_CHECK,
|
||||
EXCEPTION_FLT_UNDERFLOW,
|
||||
EXCEPTION_ILLEGAL_INSTRUCTION,
|
||||
EXCEPTION_IN_PAGE_ERROR,
|
||||
EXCEPTION_INT_DIVIDE_BY_ZERO,
|
||||
EXCEPTION_INT_OVERFLOW,
|
||||
EXCEPTION_INVALID_DISPOSITION,
|
||||
EXCEPTION_NONCONTINUABLE_EXCEPTION,
|
||||
EXCEPTION_PRIV_INSTRUCTION,
|
||||
EXCEPTION_SINGLE_STEP,
|
||||
EXCEPTION_STACK_OVERFLOW
|
||||
};
|
||||
|
||||
for (DWORD code : codes)
|
||||
{
|
||||
auto desc = exceptionDescription(code);
|
||||
Assert::IsTrue(desc && *desc != '\0', (L"Empty description for code: " + std::to_wstring(code)).c_str());
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
36
src/common/UnitTests-CommonUtils/UnitTests-CommonUtils.rc
Normal file
36
src/common/UnitTests-CommonUtils/UnitTests-CommonUtils.rc
Normal file
@@ -0,0 +1,36 @@
|
||||
#include <windows.h>
|
||||
#include "resource.h"
|
||||
#include "../version/version.h"
|
||||
|
||||
1 VERSIONINFO
|
||||
FILEVERSION FILE_VERSION
|
||||
PRODUCTVERSION PRODUCT_VERSION
|
||||
FILEFLAGSMASK VS_FFI_FILEFLAGSMASK
|
||||
#ifdef _DEBUG
|
||||
FILEFLAGS VS_FF_DEBUG
|
||||
#else
|
||||
FILEFLAGS 0x0L
|
||||
#endif
|
||||
FILEOS VOS_NT_WINDOWS32
|
||||
FILETYPE VFT_DLL
|
||||
FILESUBTYPE VFT2_UNKNOWN
|
||||
BEGIN
|
||||
BLOCK "StringFileInfo"
|
||||
BEGIN
|
||||
BLOCK "040904b0" // US English (0x0409), Unicode (0x04B0) charset
|
||||
BEGIN
|
||||
VALUE "CompanyName", COMPANY_NAME
|
||||
VALUE "FileDescription", FILE_DESCRIPTION
|
||||
VALUE "FileVersion", FILE_VERSION_STRING
|
||||
VALUE "InternalName", INTERNAL_NAME
|
||||
VALUE "LegalCopyright", COPYRIGHT_NOTE
|
||||
VALUE "OriginalFilename", ORIGINAL_FILENAME
|
||||
VALUE "ProductName", PRODUCT_NAME
|
||||
VALUE "ProductVersion", PRODUCT_VERSION_STRING
|
||||
END
|
||||
END
|
||||
BLOCK "VarFileInfo"
|
||||
BEGIN
|
||||
VALUE "Translation", 0x409, 1200 // US English (0x0409), Unicode (1200) charset
|
||||
END
|
||||
END
|
||||
@@ -0,0 +1,96 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
<Import Project="..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.props" Condition="Exists('..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.props')" />
|
||||
<PropertyGroup Label="Globals">
|
||||
<VCProjectVersion>16.0</VCProjectVersion>
|
||||
<ProjectGuid>{8B5CFB38-CCBA-40A8-AD7A-89C57B070884}</ProjectGuid>
|
||||
<Keyword>Win32Proj</Keyword>
|
||||
<RootNamespace>UnitTestsCommonUtils</RootNamespace>
|
||||
<ProjectSubType>NativeUnitTestProject</ProjectSubType>
|
||||
<ProjectName>Common.Utils.UnitTests</ProjectName>
|
||||
</PropertyGroup>
|
||||
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
|
||||
<PropertyGroup Label="Configuration">
|
||||
<ConfigurationType>DynamicLibrary</ConfigurationType>
|
||||
<UseOfMfc>false</UseOfMfc>
|
||||
<PlatformToolset>v143</PlatformToolset>
|
||||
<OutDir>$(SolutionDir)$(Platform)\$(Configuration)\tests\UnitTestsCommonUtils\</OutDir>
|
||||
</PropertyGroup>
|
||||
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
|
||||
<ImportGroup Label="ExtensionSettings">
|
||||
</ImportGroup>
|
||||
<ImportGroup Label="Shared">
|
||||
</ImportGroup>
|
||||
<ImportGroup Label="PropertySheets">
|
||||
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
|
||||
</ImportGroup>
|
||||
<PropertyGroup Label="UserMacros" />
|
||||
<ItemDefinitionGroup>
|
||||
<ClCompile>
|
||||
<AdditionalIncludeDirectories>..\;..\utils;..\Telemetry;..\..\;..\..\..\deps\;..\..\..\deps\spdlog\include;..\..\..\packages\Microsoft.Windows.ImplementationLibrary.1.0.231216.1\include;$(VCInstallDir)UnitTest\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
|
||||
<LanguageStandard>stdcpp23</LanguageStandard>
|
||||
<PreprocessorDefinitions>SPDLOG_WCHAR_TO_UTF8_SUPPORT;SPDLOG_HEADER_ONLY;%(PreprocessorDefinitions)</PreprocessorDefinitions>
|
||||
</ClCompile>
|
||||
<Link>
|
||||
<AdditionalLibraryDirectories>$(VCInstallDir)UnitTest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
|
||||
<AdditionalDependencies>RuntimeObject.lib;Msi.lib;Shlwapi.lib;%(AdditionalDependencies)</AdditionalDependencies>
|
||||
</Link>
|
||||
</ItemDefinitionGroup>
|
||||
<ItemGroup>
|
||||
<ClCompile Include="pch.cpp">
|
||||
<PrecompiledHeader Condition="'$(UsePrecompiledHeaders)' != 'false'">Create</PrecompiledHeader>
|
||||
</ClCompile>
|
||||
<ClCompile Include="StringUtils.Tests.cpp" />
|
||||
<ClCompile Include="ColorUtils.Tests.cpp" />
|
||||
<ClCompile Include="TimeUtils.Tests.cpp" />
|
||||
<ClCompile Include="WinApiError.Tests.cpp" />
|
||||
<ClCompile Include="Serialized.Tests.cpp" />
|
||||
<ClCompile Include="Json.Tests.cpp" />
|
||||
<ClCompile Include="OsDetect.Tests.cpp" />
|
||||
<ClCompile Include="Threading.Tests.cpp" />
|
||||
<ClCompile Include="ProcessPath.Tests.cpp" />
|
||||
<ClCompile Include="Window.Tests.cpp" />
|
||||
<ClCompile Include="GameMode.Tests.cpp" />
|
||||
<ClCompile Include="Gpo.Tests.cpp" />
|
||||
<ClCompile Include="MsiUtils.Tests.cpp" />
|
||||
<ClCompile Include="HttpClient.Tests.cpp" />
|
||||
<ClCompile Include="ComObjectFactory.Tests.cpp" />
|
||||
<ClCompile Include="AppMutex.Tests.cpp" />
|
||||
<ClCompile Include="Elevation.Tests.cpp" />
|
||||
<ClCompile Include="Exec.Tests.cpp" />
|
||||
<ClCompile Include="ExcludedApps.Tests.cpp" />
|
||||
<ClCompile Include="HDropIterator.Tests.cpp" />
|
||||
<ClCompile Include="LoggerHelper.Tests.cpp" />
|
||||
<ClCompile Include="ModulesRegistry.Tests.cpp" />
|
||||
<ClCompile Include="MsWindowsSettings.Tests.cpp" />
|
||||
<ClCompile Include="Package.Tests.cpp" />
|
||||
<ClCompile Include="ProcessApi.Tests.cpp" />
|
||||
<ClCompile Include="ProcessWaiter.Tests.cpp" />
|
||||
<ClCompile Include="Registry.Tests.cpp" />
|
||||
<ClCompile Include="Resources.Tests.cpp" />
|
||||
<ClCompile Include="TestStubs.cpp" />
|
||||
<ClCompile Include="UnhandledException.Tests.cpp" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<ClInclude Include="pch.h" />
|
||||
<ClInclude Include="resource.h" />
|
||||
<ClInclude Include="TestHelpers.h" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<ResourceCompile Include="UnitTests-CommonUtils.rc" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<None Include="packages.config" />
|
||||
</ItemGroup>
|
||||
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
|
||||
<ImportGroup Label="ExtensionTargets">
|
||||
<Import Project="..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.targets" Condition="Exists('..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.targets')" />
|
||||
</ImportGroup>
|
||||
<Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
|
||||
<PropertyGroup>
|
||||
<ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
|
||||
</PropertyGroup>
|
||||
<Error Condition="!Exists('..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.props'))" />
|
||||
<Error Condition="!Exists('..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.targets'))" />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,143 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
<ItemGroup>
|
||||
<Filter Include="Source Files">
|
||||
<UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>
|
||||
<Extensions>cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx</Extensions>
|
||||
</Filter>
|
||||
<Filter Include="Header Files">
|
||||
<UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>
|
||||
<Extensions>h;hh;hpp;hxx;hm;inl;inc;ipp;xsd</Extensions>
|
||||
</Filter>
|
||||
<Filter Include="Resource Files">
|
||||
<UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>
|
||||
<Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
|
||||
</Filter>
|
||||
<Filter Include="Source Files\Pure Functions">
|
||||
<UniqueIdentifier>{A1B2C3D4-E5F6-4A5B-8C9D-0E1F2A3B4C5D}</UniqueIdentifier>
|
||||
</Filter>
|
||||
<Filter Include="Source Files\Threading">
|
||||
<UniqueIdentifier>{B2C3D4E5-F6A7-4B6C-9D0E-1F2A3B4C5D6E}</UniqueIdentifier>
|
||||
</Filter>
|
||||
<Filter Include="Source Files\Process">
|
||||
<UniqueIdentifier>{C3D4E5F6-A7B8-4C7D-0E1F-2A3B4C5D6E7F}</UniqueIdentifier>
|
||||
</Filter>
|
||||
<Filter Include="Source Files\Registry">
|
||||
<UniqueIdentifier>{D4E5F6A7-B8C9-4D8E-1F2A-3B4C5D6E7F8A}</UniqueIdentifier>
|
||||
</Filter>
|
||||
<Filter Include="Source Files\Integration">
|
||||
<UniqueIdentifier>{E5F6A7B8-C9D0-4E9F-2A3B-4C5D6E7F8A9B}</UniqueIdentifier>
|
||||
</Filter>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<ClCompile Include="pch.cpp">
|
||||
<Filter>Source Files</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="StringUtils.Tests.cpp">
|
||||
<Filter>Source Files\Pure Functions</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="ColorUtils.Tests.cpp">
|
||||
<Filter>Source Files\Pure Functions</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="TimeUtils.Tests.cpp">
|
||||
<Filter>Source Files\Pure Functions</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="WinApiError.Tests.cpp">
|
||||
<Filter>Source Files\Pure Functions</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="Serialized.Tests.cpp">
|
||||
<Filter>Source Files\Pure Functions</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="Json.Tests.cpp">
|
||||
<Filter>Source Files\Pure Functions</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="ExcludedApps.Tests.cpp">
|
||||
<Filter>Source Files\Pure Functions</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="OsDetect.Tests.cpp">
|
||||
<Filter>Source Files\Pure Functions</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="Threading.Tests.cpp">
|
||||
<Filter>Source Files\Threading</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="AppMutex.Tests.cpp">
|
||||
<Filter>Source Files\Threading</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="ProcessWaiter.Tests.cpp">
|
||||
<Filter>Source Files\Threading</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="ProcessPath.Tests.cpp">
|
||||
<Filter>Source Files\Process</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="ProcessApi.Tests.cpp">
|
||||
<Filter>Source Files\Process</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="Window.Tests.cpp">
|
||||
<Filter>Source Files\Process</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="Exec.Tests.cpp">
|
||||
<Filter>Source Files\Process</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="GameMode.Tests.cpp">
|
||||
<Filter>Source Files\Process</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="MsWindowsSettings.Tests.cpp">
|
||||
<Filter>Source Files\Process</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="Registry.Tests.cpp">
|
||||
<Filter>Source Files\Registry</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="Gpo.Tests.cpp">
|
||||
<Filter>Source Files\Registry</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="ModulesRegistry.Tests.cpp">
|
||||
<Filter>Source Files\Registry</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="Elevation.Tests.cpp">
|
||||
<Filter>Source Files\Integration</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="Package.Tests.cpp">
|
||||
<Filter>Source Files\Integration</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="MsiUtils.Tests.cpp">
|
||||
<Filter>Source Files\Integration</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="HttpClient.Tests.cpp">
|
||||
<Filter>Source Files\Integration</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="Resources.Tests.cpp">
|
||||
<Filter>Source Files\Integration</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="LoggerHelper.Tests.cpp">
|
||||
<Filter>Source Files\Integration</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="ComObjectFactory.Tests.cpp">
|
||||
<Filter>Source Files\Integration</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="HDropIterator.Tests.cpp">
|
||||
<Filter>Source Files\Integration</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="UnhandledException.Tests.cpp">
|
||||
<Filter>Source Files\Integration</Filter>
|
||||
</ClCompile>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<ClInclude Include="pch.h">
|
||||
<Filter>Header Files</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="resource.h">
|
||||
<Filter>Header Files</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="TestHelpers.h">
|
||||
<Filter>Header Files</Filter>
|
||||
</ClInclude>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<ResourceCompile Include="UnitTests-CommonUtils.rc">
|
||||
<Filter>Resource Files</Filter>
|
||||
</ResourceCompile>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<None Include="packages.config" />
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
130
src/common/UnitTests-CommonUtils/WinApiError.Tests.cpp
Normal file
130
src/common/UnitTests-CommonUtils/WinApiError.Tests.cpp
Normal file
@@ -0,0 +1,130 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <winapi_error.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(WinApiErrorTests)
|
||||
{
|
||||
public:
|
||||
// get_last_error_message tests
|
||||
TEST_METHOD(GetLastErrorMessage_Success_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_message(ERROR_SUCCESS);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorMessage_FileNotFound_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_message(ERROR_FILE_NOT_FOUND);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorMessage_AccessDenied_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_message(ERROR_ACCESS_DENIED);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorMessage_PathNotFound_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_message(ERROR_PATH_NOT_FOUND);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorMessage_InvalidHandle_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_message(ERROR_INVALID_HANDLE);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorMessage_NotEnoughMemory_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_message(ERROR_NOT_ENOUGH_MEMORY);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorMessage_InvalidParameter_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_message(ERROR_INVALID_PARAMETER);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
|
||||
// get_last_error_or_default tests
|
||||
TEST_METHOD(GetLastErrorOrDefault_Success_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_or_default(ERROR_SUCCESS);
|
||||
Assert::IsFalse(result.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorOrDefault_FileNotFound_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_or_default(ERROR_FILE_NOT_FOUND);
|
||||
Assert::IsFalse(result.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorOrDefault_AccessDenied_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_or_default(ERROR_ACCESS_DENIED);
|
||||
Assert::IsFalse(result.empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorOrDefault_UnknownError_ReturnsEmptyOrMessage)
|
||||
{
|
||||
// For an unknown error code, should return empty string or a default message
|
||||
auto result = get_last_error_or_default(0xFFFFFFFF);
|
||||
// Either empty or has content, both are valid
|
||||
Assert::IsTrue(result.empty() || !result.empty());
|
||||
}
|
||||
|
||||
// Comparison tests
|
||||
TEST_METHOD(BothFunctions_SameError_ProduceSameContent)
|
||||
{
|
||||
auto message = get_last_error_message(ERROR_FILE_NOT_FOUND);
|
||||
auto defaultMessage = get_last_error_or_default(ERROR_FILE_NOT_FOUND);
|
||||
|
||||
Assert::IsTrue(message.has_value());
|
||||
Assert::AreEqual(*message, defaultMessage);
|
||||
}
|
||||
|
||||
TEST_METHOD(BothFunctions_SuccessError_ProduceSameContent)
|
||||
{
|
||||
auto message = get_last_error_message(ERROR_SUCCESS);
|
||||
auto defaultMessage = get_last_error_or_default(ERROR_SUCCESS);
|
||||
|
||||
Assert::IsTrue(message.has_value());
|
||||
Assert::AreEqual(*message, defaultMessage);
|
||||
}
|
||||
|
||||
// Error code specific tests
|
||||
TEST_METHOD(GetLastErrorMessage_SharingViolation_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_message(ERROR_SHARING_VIOLATION);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorMessage_FileExists_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_message(ERROR_FILE_EXISTS);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
|
||||
TEST_METHOD(GetLastErrorMessage_DirNotEmpty_ReturnsMessage)
|
||||
{
|
||||
auto result = get_last_error_message(ERROR_DIR_NOT_EMPTY);
|
||||
Assert::IsTrue(result.has_value());
|
||||
Assert::IsFalse(result->empty());
|
||||
}
|
||||
};
|
||||
}
|
||||
159
src/common/UnitTests-CommonUtils/Window.Tests.cpp
Normal file
159
src/common/UnitTests-CommonUtils/Window.Tests.cpp
Normal file
@@ -0,0 +1,159 @@
|
||||
#include "pch.h"
|
||||
#include "TestHelpers.h"
|
||||
#include <window.h>
|
||||
|
||||
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
|
||||
|
||||
namespace UnitTestsCommonUtils
|
||||
{
|
||||
TEST_CLASS(WindowTests)
|
||||
{
|
||||
public:
|
||||
// is_system_window tests
|
||||
TEST_METHOD(IsSystemWindow_DesktopWindow_ReturnsResult)
|
||||
{
|
||||
HWND desktop = GetDesktopWindow();
|
||||
Assert::IsNotNull(desktop);
|
||||
|
||||
// Get class name
|
||||
char className[256] = {};
|
||||
GetClassNameA(desktop, className, sizeof(className));
|
||||
|
||||
bool result = is_system_window(desktop, className);
|
||||
// Just verify it doesn't crash and returns a boolean
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsSystemWindow_NullHwnd_ReturnsFalse)
|
||||
{
|
||||
auto shell = GetShellWindow();
|
||||
auto desktop = GetDesktopWindow();
|
||||
bool result = is_system_window(nullptr, "ClassName");
|
||||
bool expected = (shell == nullptr) || (desktop == nullptr);
|
||||
Assert::AreEqual(expected, result);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsSystemWindow_InvalidHwnd_ReturnsFalse)
|
||||
{
|
||||
bool result = is_system_window(reinterpret_cast<HWND>(0x12345678), "ClassName");
|
||||
Assert::IsFalse(result);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsSystemWindow_EmptyClassName_DoesNotCrash)
|
||||
{
|
||||
HWND desktop = GetDesktopWindow();
|
||||
bool result = is_system_window(desktop, "");
|
||||
// Just verify it doesn't crash
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
TEST_METHOD(IsSystemWindow_NullClassName_DoesNotCrash)
|
||||
{
|
||||
HWND desktop = GetDesktopWindow();
|
||||
bool result = is_system_window(desktop, nullptr);
|
||||
// Should handle null className gracefully
|
||||
Assert::IsTrue(result == true || result == false);
|
||||
}
|
||||
|
||||
// GetWindowCreateParam tests
|
||||
TEST_METHOD(GetWindowCreateParam_ValidLparam_ReturnsValue)
|
||||
{
|
||||
struct TestData
|
||||
{
|
||||
int value;
|
||||
};
|
||||
|
||||
TestData data{ 42 };
|
||||
CREATESTRUCT cs{};
|
||||
cs.lpCreateParams = &data;
|
||||
|
||||
auto result = GetWindowCreateParam<TestData*>(reinterpret_cast<LPARAM>(&cs));
|
||||
Assert::IsNotNull(result);
|
||||
Assert::AreEqual(42, result->value);
|
||||
}
|
||||
|
||||
// Window data storage tests
|
||||
TEST_METHOD(WindowData_StoreAndRetrieve_Works)
|
||||
{
|
||||
// Create a simple message-only window for testing
|
||||
WNDCLASSW wc = {};
|
||||
wc.lpfnWndProc = DefWindowProcW;
|
||||
wc.hInstance = GetModuleHandleW(nullptr);
|
||||
wc.lpszClassName = L"TestWindowClass_DataTest";
|
||||
RegisterClassW(&wc);
|
||||
|
||||
HWND hwnd = CreateWindowExW(0, L"TestWindowClass_DataTest", L"Test",
|
||||
0, 0, 0, 0, 0, HWND_MESSAGE, nullptr,
|
||||
GetModuleHandleW(nullptr), nullptr);
|
||||
|
||||
if (hwnd)
|
||||
{
|
||||
int value = 42;
|
||||
int* testValue = &value;
|
||||
StoreWindowParam(hwnd, testValue);
|
||||
|
||||
auto retrieved = GetWindowParam<int*>(hwnd);
|
||||
Assert::AreEqual(testValue, retrieved);
|
||||
|
||||
DestroyWindow(hwnd);
|
||||
}
|
||||
|
||||
UnregisterClassW(L"TestWindowClass_DataTest", GetModuleHandleW(nullptr));
|
||||
Assert::IsTrue(true); // Window creation might fail in test environment
|
||||
}
|
||||
|
||||
// run_message_loop tests
|
||||
TEST_METHOD(RunMessageLoop_UntilIdle_Completes)
|
||||
{
|
||||
// Run message loop until idle with a timeout
|
||||
// This should complete quickly since there are no messages
|
||||
auto start = std::chrono::steady_clock::now();
|
||||
|
||||
run_message_loop(true, 100);
|
||||
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
|
||||
std::chrono::steady_clock::now() - start);
|
||||
|
||||
// Should complete within reasonable time
|
||||
Assert::IsTrue(elapsed.count() < 500);
|
||||
}
|
||||
|
||||
TEST_METHOD(RunMessageLoop_WithTimeout_RespectsTimeout)
|
||||
{
|
||||
auto start = std::chrono::steady_clock::now();
|
||||
|
||||
run_message_loop(false, 50);
|
||||
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
|
||||
std::chrono::steady_clock::now() - start);
|
||||
|
||||
// Should take at least the timeout duration
|
||||
// Allow some tolerance for timing
|
||||
Assert::IsTrue(elapsed.count() >= 40 && elapsed.count() < 500);
|
||||
}
|
||||
|
||||
TEST_METHOD(RunMessageLoop_ZeroTimeout_CompletesImmediately)
|
||||
{
|
||||
auto start = std::chrono::steady_clock::now();
|
||||
|
||||
run_message_loop(false, 0);
|
||||
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
|
||||
std::chrono::steady_clock::now() - start);
|
||||
|
||||
// Should complete very quickly
|
||||
Assert::IsTrue(elapsed.count() < 100);
|
||||
}
|
||||
|
||||
TEST_METHOD(RunMessageLoop_NoTimeout_ProcessesMessages)
|
||||
{
|
||||
// Post a quit message before starting the loop
|
||||
PostQuitMessage(0);
|
||||
|
||||
// Should process the quit message and exit
|
||||
run_message_loop(false, std::nullopt);
|
||||
|
||||
Assert::IsTrue(true);
|
||||
}
|
||||
};
|
||||
}
|
||||
4
src/common/UnitTests-CommonUtils/packages.config
Normal file
4
src/common/UnitTests-CommonUtils/packages.config
Normal file
@@ -0,0 +1,4 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<packages>
|
||||
<package id="Microsoft.Windows.CppWinRT" version="2.0.240111.5" targetFramework="native" />
|
||||
</packages>
|
||||
5
src/common/UnitTests-CommonUtils/pch.cpp
Normal file
5
src/common/UnitTests-CommonUtils/pch.cpp
Normal file
@@ -0,0 +1,5 @@
|
||||
// pch.cpp: source file corresponding to the pre-compiled header
|
||||
|
||||
#include "pch.h"
|
||||
|
||||
// When you are using pre-compiled headers, this source file is necessary for compilation to succeed.
|
||||
39
src/common/UnitTests-CommonUtils/pch.h
Normal file
39
src/common/UnitTests-CommonUtils/pch.h
Normal file
@@ -0,0 +1,39 @@
|
||||
// pch.h: This is a precompiled header file.
|
||||
// Files listed below are compiled only once, improving build performance for future builds.
|
||||
// This also affects IntelliSense performance, including code completion and many code browsing features.
|
||||
// However, files listed here are ALL re-compiled if any one of them is updated between builds.
|
||||
// Do not add files here that you will be updating frequently as this negates the performance advantage.
|
||||
|
||||
#ifndef PCH_H
|
||||
#define PCH_H
|
||||
|
||||
// add headers that you want to pre-compile here
|
||||
#include <Windows.h>
|
||||
#include <winrt/base.h>
|
||||
#include <winrt/Windows.Foundation.h>
|
||||
#include <winrt/Windows.Foundation.Collections.h>
|
||||
#include <winrt/Windows.Foundation.Metadata.h>
|
||||
#include <winrt/Windows.Data.Json.h>
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
#include <optional>
|
||||
#include <functional>
|
||||
#include <thread>
|
||||
#include <atomic>
|
||||
#include <mutex>
|
||||
#include <shared_mutex>
|
||||
#include <future>
|
||||
#include <queue>
|
||||
#include <filesystem>
|
||||
#include <fstream>
|
||||
#include <chrono>
|
||||
#include <ctime>
|
||||
|
||||
// Suppressing 26466 - Don't use static_cast downcasts - in CppUnitTest.h
|
||||
#pragma warning(push)
|
||||
#pragma warning(disable : 26466)
|
||||
#include "CppUnitTest.h"
|
||||
#pragma warning(pop)
|
||||
|
||||
#endif //PCH_H
|
||||
13
src/common/UnitTests-CommonUtils/resource.h
Normal file
13
src/common/UnitTests-CommonUtils/resource.h
Normal file
@@ -0,0 +1,13 @@
|
||||
//{{NO_DEPENDENCIES}}
|
||||
// Microsoft Visual C++ generated include file.
|
||||
// Used by UnitTests-CommonUtils.rc
|
||||
|
||||
//////////////////////////////
|
||||
// Non-localizable
|
||||
|
||||
#define FILE_DESCRIPTION "PowerToys UnitTests-CommonUtils"
|
||||
#define INTERNAL_NAME "UnitTests-CommonUtils"
|
||||
#define ORIGINAL_FILENAME "UnitTests-CommonUtils.dll"
|
||||
|
||||
// Non-localizable
|
||||
//////////////////////////////
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user