Add function VM-Get-Category to retrieve the category from the nuspec #1272

sara-rn · 2025-02-10T12:59:14Z

Retrieves the category from the nuspec file through the helper function VM-Get-Category
Make lint.py compatible with the new nuspec format: add tags to the list of required tags and validate categories from the nuspec file
Closes #1107

Ana06

Nice first step to move the categories to the nuspec! 😄

Ana06 · 2025-02-11T10:00:55Z

packages/common.vm/tools/vm.common/vm.common.psm1

+# Returns the category if the tags exist in the nuspec
+function VM-Get-Category {
+    $installPath = $MyInvocation.MyCommand.Definition
+    $toolDir = "$(Split-Path -parent (Split-Path -parent $installPath))"


According to our documentation $toolDir should only be used for directory where the tool is actually installed. We need a different name here. I think you can also remove the "

Suggested change

$toolDir = "$(Split-Path -parent (Split-Path -parent $installPath))"

$chocolateyToolDir = $(Split-Path -parent (Split-Path -parent $installPath))

Ana06 · 2025-02-11T10:08:59Z

packages/common.vm/tools/vm.common/vm.common.psm1

+function VM-Get-Category {
+    $installPath = $MyInvocation.MyCommand.Definition
+    $toolDir = "$(Split-Path -parent (Split-Path -parent $installPath))"
+    $packageName = Split-Path -Path (Split-Path -parent $installPath) | Split-Path -Leaf


you can get the package name from the environment variable ChocolateyPackageName

Ana06 · 2025-02-11T10:09:35Z

packages/common.vm/tools/vm.common/vm.common.psm1

+    $toolDir = "$(Split-Path -parent (Split-Path -parent $installPath))"
+    $packageName = Split-Path -Path (Split-Path -parent $installPath) | Split-Path -Leaf
+    $nuspec = $packageName + ".nuspec"
+    if (Test-Path ($toolDir)){


the directory must exist, otherwise we return an invalid category here

@Ana06 if $toolDir doesn't exist, the return value should be None?

how is it possible that it does not exists? I think it MUST exists and you should check it with VM-Assert-Path or -Resolve which would raise an exception if it does not exist.

ah ok, so I remove the condition Test-Path, I misunderstood your comment, thanks!

Ana06 · 2025-02-13T07:25:50Z

scripts/test/lint.py

@@ -94,6 +94,7 @@ class IncludesRequiredFieldsOnly(Lint):
        "description",
        "authors",
        "dependencies",
+        "tags",


Please remove this change and add it after all packages have the category in the nuspec.

scripts/test/lint.py

Ana06 · 2025-02-13T07:29:37Z

packages/010editor.vm/tools/chocolateyinstall.ps1

@@ -3,7 +3,7 @@ Import-Module vm.common -Force -DisableNameChecking

 try {
  $toolName = '010Editor'
-  $category = 'Hex Editors'
+  $category = VM-Get-Category($MyInvocation.MyCommand.Definition)


Documenting discussion: It is a good idea to edit two packages (common and an extra one) in this PR to test VM-Get-Category. But it is a good idea to split the update of other packages in separate PR (for example 30 packages per PR) so that the CI takes less to run and we do not encounter any issues when pushing the packages to MyGet.

Note the issue with 010Editor (just in case you notice slow local testing or CI): #1275

@Ana06 2 test packages have been removed from current PR

Ana06

[nipick] Remember to keep the commit subject short (50 chars is a common convention):

Also update the commit description, it mentions 7z which is not being updated.

scripts/test/lint.py

packages/common.vm/tools/vm.common/vm.common.psm1

Retrieves the category from the nuspec file through the helper function `VM-Get-Category` Make lint.py compatible with the new nuspec format: add tags to the list of required tags and validate categories from the nuspec file

Comment out the line that validates the categories from the chocolatey install package. This needs to be termporarily disabled until the new linter is ready and all the packages have the new structure. This is needed because the choco install package won't longer have a category, it will read it from the nuspec instead.

sara-rn requested a review from Ana06 February 10, 2025 12:59

sara-rn changed the title ~~Add new function VM-Get-Category to retrieve the category from the nu…~~ Add function VM-Get-Category to retrieve the category from the nuspec Feb 10, 2025

sara-rn self-assigned this Feb 10, 2025

sara-rn force-pushed the add-vm-get-category branch 3 times, most recently from 334ab62 to 42b0194 Compare February 10, 2025 13:26

Ana06 reviewed Feb 11, 2025

View reviewed changes

sara-rn force-pushed the add-vm-get-category branch from 07f3d18 to e9754f3 Compare February 11, 2025 09:47

Ana06 reviewed Feb 11, 2025

View reviewed changes

sara-rn force-pushed the add-vm-get-category branch 2 times, most recently from 42b0194 to 7576727 Compare February 11, 2025 11:00

Ana06 reviewed Feb 13, 2025

View reviewed changes

sara-rn force-pushed the add-vm-get-category branch 6 times, most recently from ec6ff24 to e48bcf5 Compare February 13, 2025 10:16

sara-rn requested a review from Ana06 February 13, 2025 10:23

sara-rn mentioned this pull request Feb 13, 2025

Modify list of packages tags from 0 to c #1277

Merged

Ana06 reviewed Feb 14, 2025

View reviewed changes

scripts/test/lint.py Show resolved Hide resolved

packages/common.vm/tools/vm.common/vm.common.psm1 Outdated Show resolved Hide resolved

sara-rn force-pushed the add-vm-get-category branch 3 times, most recently from ed87abc to 90c6e5a Compare February 14, 2025 09:45

sara-rn requested a review from Ana06 February 14, 2025 09:50

Ana06 approved these changes Feb 14, 2025

View reviewed changes

sara-rn added 2 commits February 14, 2025 16:44

Add new function to retrieve the category from the nuspec

026dd15

Retrieves the category from the nuspec file through the helper function `VM-Get-Category` Make lint.py compatible with the new nuspec format: add tags to the list of required tags and validate categories from the nuspec file

sara-rn force-pushed the add-vm-get-category branch from 90c6e5a to 944cddf Compare February 14, 2025 15:47

Ana06 approved these changes Feb 14, 2025

View reviewed changes

Ana06 merged commit a204833 into mandiant:main Feb 14, 2025
4 checks passed

sara-rn deleted the add-vm-get-category branch February 17, 2025 08:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add function VM-Get-Category to retrieve the category from the nuspec #1272

Add function VM-Get-Category to retrieve the category from the nuspec #1272

sara-rn commented Feb 10, 2025 •

edited

Loading

Ana06 left a comment

Ana06 Feb 11, 2025

Ana06 Feb 11, 2025

Ana06 Feb 11, 2025

sara-rn Feb 11, 2025 •

edited

Loading

Ana06 Feb 12, 2025 •

edited

Loading

sara-rn Feb 12, 2025 •

edited

Loading

Ana06 Feb 13, 2025

Ana06 Feb 13, 2025

Ana06 Feb 13, 2025

sara-rn Feb 14, 2025

Ana06 left a comment

	$toolDir = "$(Split-Path -parent (Split-Path -parent $installPath))"
	$chocolateyToolDir = $(Split-Path -parent (Split-Path -parent $installPath))

Add function VM-Get-Category to retrieve the category from the nuspec #1272

Add function VM-Get-Category to retrieve the category from the nuspec #1272

Conversation

sara-rn commented Feb 10, 2025 • edited Loading

Ana06 left a comment

Choose a reason for hiding this comment

Ana06 Feb 11, 2025

Choose a reason for hiding this comment

Ana06 Feb 11, 2025

Choose a reason for hiding this comment

Ana06 Feb 11, 2025

Choose a reason for hiding this comment

sara-rn Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Ana06 Feb 12, 2025 • edited Loading

Choose a reason for hiding this comment

sara-rn Feb 12, 2025 • edited Loading

Choose a reason for hiding this comment

Ana06 Feb 13, 2025

Choose a reason for hiding this comment

Ana06 Feb 13, 2025

Choose a reason for hiding this comment

Ana06 Feb 13, 2025

Choose a reason for hiding this comment

sara-rn Feb 14, 2025

Choose a reason for hiding this comment

Ana06 left a comment

Choose a reason for hiding this comment

sara-rn commented Feb 10, 2025 •

edited

Loading

sara-rn Feb 11, 2025 •

edited

Loading

Ana06 Feb 12, 2025 •

edited

Loading

sara-rn Feb 12, 2025 •

edited

Loading