Add custom ObjectName field to all exported objects - Fix #73 (#76)

* Add custom ObjectName field to all exported objects - Fix #73

Author: webtonize

.gitignore

@@ -1,3 +1,4 @@
 tests/out*
 coverage.xml
-myenv.ps1
+myenv.ps1
+.vscode/

src/PSRule.Rules.AzureDevOps/Functions/DevOps.Pipelines.Core.ps1

@@ -228,12 +228,14 @@ function Export-AzDevOpsPipelineYaml {
 
     Write-Verbose "Getting YAML definition for pipeline $PipelineId"
     $yaml = "ObjectType: Azure.DevOps.Pipelines.PipelineYaml`n"
-    $yaml += Get-AzDevOpsPipelineYaml -Project $Project -PipelineId $PipelineId
+    $yaml += "ObjectName: '$($script:connection.Organization).$Project.$PipelineName.Yaml'`n"
+    $yamlTemp = Get-AzDevOpsPipelineYaml -Project $Project -PipelineId $PipelineId
     # Export the YAML definition to a file if it is not empty
-    if ($yaml -eq "ObjectType: Azure.DevOps.Pipelines.PipelineYaml`n" -or $null -eq $yaml) {
+    if ($null -eq $yamlTemp) {
         Write-Warning "YAML definition for pipeline $PipelineId is empty"
         return $null
-    }
+    } else {
+        $yaml += $yamlTemp}
     Write-Verbose "Exporting YAML definition to $OutputPath\$PipelineName.yaml"
     $yaml | Out-File "$OutputPath\$PipelineName.yaml"
 }
@@ -277,6 +279,7 @@ function Export-AzDevOpsPipelines {
     foreach ($pipeline in $pipelines) {
         # Add ObjectType Azure.DevOps.Pipeline to the pipeline object
         $pipeline | Add-Member -MemberType NoteProperty -Name ObjectType -Value "Azure.DevOps.Pipeline"
+        $pipeline | Add-Member -MemberType NoteProperty -Name ObjectName -Value ("{0}.{1}.{2}" -f $script:connection.Organization,$Project,$pipeline.name)
         # Get the project ID from the pipeline object web.href property
         $ProjectId = $pipeline._links.web.href.Split('/')[4]
 

src/PSRule.Rules.AzureDevOps/Functions/DevOps.Pipelines.Environments.ps1

@@ -156,6 +156,7 @@ function Export-AzDevOpsEnvironmentChecks {
                 $environment = $_
                 # Add a ObjectType indicator for Azure.DevOps.Pipelines.Environment
                 $environment | Add-Member -MemberType NoteProperty -Name ObjectType -Value 'Azure.DevOps.Pipelines.Environment'
+                $environment | Add-Member -MemberType NoteProperty -Name ObjectName -Value ("{0}.{1}.{2}" -f $script:connection.Organization,$Project,$environment.name)
                 $checks = @(Get-AzDevOpsEnvironmentChecks -Project $Project -Environment $environment.id)
                 $environment | Add-Member -MemberType NoteProperty -Name checks -Value $checks
                 Write-Verbose "Exporting environment $($environment.name) to JSON"

src/PSRule.Rules.AzureDevOps/Functions/DevOps.Pipelines.Releases.ps1

@@ -159,6 +159,7 @@ Function Export-AzDevOpsReleaseDefinitions {
             $definitionPath = Join-Path -Path $OutputPath -ChildPath "$definitionName.ado.rd.json"
             # Add an ObjectType of Azure.DevOps.Pipelines.Releases.Definition to the response
             $response | Add-Member -MemberType NoteProperty -Name 'ObjectType' -Value 'Azure.DevOps.Pipelines.Releases.Definition'
+            $response | Add-Member -MemberType NoteProperty -Name 'ObjectName' -Value ("{0}.{1}.{2}" -f $script:connection.Organization,$Project,$definitionName)
             # Get the project ID from the url in the response
             $projectId = $response.url.Split('/')[4]
             # Get the folder from the path in the response

src/PSRule.Rules.AzureDevOps/Functions/DevOps.Pipelines.Settings.ps1

@@ -72,6 +72,7 @@ function Export-AzDevOpsPipelinesSettings {
     Write-Verbose "Getting pipelines settings from Azure DevOps"
     $pipelinesSettings = Get-AzDevOpsPipelinesSettings -Project $Project
     $pipelinesSettings | Add-Member -MemberType NoteProperty -Name ObjectType -Value 'Azure.DevOps.Pipelines.Settings'
+    $pipelinesSettings | Add-Member -MemberType NoteProperty -Name ObjectName -Value ("{0}.{1}.PipelineSettings" -f $script:connection.Organization,$Project)
     $pipelinesSettings | Add-Member -MemberType NoteProperty -Name Name -Value $Project
     $pipelinesSettings | ConvertTo-Json -Depth 10 | Out-File (Join-Path -Path $OutputPath -ChildPath "$Project.ado.pls.json")
 }

src/PSRule.Rules.AzureDevOps/Functions/DevOps.Repos.ps1

@@ -370,6 +370,8 @@ function Export-AzDevOpsReposAndBranchPolicies {
             $repo = $_
             # Add ObjectType Azure.DevOps.Repo to repo object
             $repo | Add-Member -MemberType NoteProperty -Name ObjectType -Value "Azure.DevOps.Repo"
+            # Add ObjectName to repo object
+            $repo | Add-Member -MemberType NoteProperty -Name ObjectName -Value ("{0}.{1}.{2}" -f $Organization,$Project,$repo.name)
             Write-Verbose "Getting branch policy for repo $($repo.name)"
             If($repo.defaultBranch) {
                 $branchPolicy = Get-AzDevOpsBranchPolicy -Project $Project -Repository $repo.id -Branch $repo.defaultBranch

src/PSRule.Rules.AzureDevOps/Functions/DevOps.ServiceConnections.ps1

@@ -130,6 +130,8 @@ function Export-AzDevOpsServiceConnections {
         $serviceConnection = $_
         # Set JSON ObjectType field to Azure.DevOps.ServiceConnection
         $serviceConnection | Add-Member -MemberType NoteProperty -Name ObjectType -Value 'Azure.DevOps.ServiceConnection'
+        # Set JSON ObjectName field to organiztion.project.service connection name
+        $serviceConnection | Add-Member -MemberType NoteProperty -Name ObjectName -Value "$Organization.$Project.$($serviceConnection.name)"
         # Get checks for service connection
         $serviceConnectionChecks = @(Get-AzDevOpsServiceConnectionChecks -Project $Project -ServiceConnectionId $serviceConnection.id)
         $serviceConnection | Add-Member -MemberType NoteProperty -Name Checks -Value $serviceConnectionChecks

src/PSRule.Rules.AzureDevOps/Functions/DevOps.Tasks.VariableGroups.ps1

@@ -81,6 +81,7 @@ Function Export-AzDevOpsVariableGroups {
     $variableGroups | ForEach-Object {
         $variableGroup = $_
         $variableGroup | Add-Member -MemberType NoteProperty -Name 'ObjectType' -Value 'Azure.DevOps.Tasks.VariableGroup'
+        $variableGroup | Add-Member -MemberType NoteProperty -Name 'ObjectName' -Value "$Organization.$Project.$($variableGroup.name)"
         $variableGroupName = $variableGroup.name
         $variableGroupPath = Join-Path -Path $OutputPath -ChildPath "$variableGroupName.ado.vg.json"
         Write-Verbose "Exporting variable group $variableGroupName as file $variableGroupName.ado.vg.json"

src/PSRule.Rules.AzureDevOps/rules/Config.Rule.yaml

@@ -8,6 +8,7 @@ spec:
   binding:
     useQualifiedName: true
     targetName:
+    - ObjectName
     - name
     - displayName
     - id