mirror of https://github.com/ansible/ansible.git
PowerShell - Added coverage collector (#59009)
* Added coverage collection for PowerShell - ci_complete ci_coverage * uncomment out coverage uploader call * Generate XML for PowerShell coverage * Use whitelist to exclude coverage run on non content plugins * Remove uneeded ignore entry * Try to reduce diff in cover.py * Fix up coverage report package - ci_complete ci_coveragepull/61414/head
Jordan Borean
5 years ago
committed by
GitHub
parent
5438013191
commit
faaa669764
@ -0,0 +1,190 @@
|
||||
# (c) 2019 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
param(
|
||||
[Parameter(Mandatory=$true)][System.Collections.IDictionary]$Payload
|
||||
)
|
||||
|
||||
#AnsibleRequires -Wrapper module_wrapper
|
||||
|
||||
$ErrorActionPreference = "Stop"
|
||||
|
||||
Write-AnsibleLog "INFO - starting coverage_wrapper" "coverage_wrapper"
|
||||
|
||||
# Required to be set for psrp to we can set a breakpoint in the remote runspace
|
||||
if ($PSVersionTable.PSVersion -ge [Version]'4.0') {
|
||||
$host.Runspace.Debugger.SetDebugMode([System.Management.Automation.DebugModes]::RemoteScript)
|
||||
}
|
||||
|
||||
Function New-CoverageBreakpoint {
|
||||
Param (
|
||||
[String]$Path,
|
||||
[ScriptBlock]$Code,
|
||||
[String]$AnsiblePath
|
||||
)
|
||||
|
||||
# It is quicker to pass in the code as a string instead of calling ParseFile as we already know the contents
|
||||
$predicate = {
|
||||
$args[0] -is [System.Management.Automation.Language.CommandBaseAst]
|
||||
}
|
||||
$script_cmds = $Code.Ast.FindAll($predicate, $true)
|
||||
|
||||
# Create an object that tracks the Ansible path of the file and the breakpoints that have been set in it
|
||||
$info = [PSCustomObject]@{
|
||||
Path = $AnsiblePath
|
||||
Breakpoints = [System.Collections.Generic.List`1[System.Management.Automation.Breakpoint]]@()
|
||||
}
|
||||
|
||||
# Keep track of lines that are already scanned. PowerShell can contains multiple commands in 1 line
|
||||
$scanned_lines = [System.Collections.Generic.HashSet`1[System.Int32]]@()
|
||||
foreach ($cmd in $script_cmds) {
|
||||
if (-not $scanned_lines.Add($cmd.Extent.StartLineNumber)) {
|
||||
continue
|
||||
}
|
||||
|
||||
# Do not add any -Action value, even if it is $null or {}. Doing so will balloon the runtime.
|
||||
$params = @{
|
||||
Script = $Path
|
||||
Line = $cmd.Extent.StartLineNumber
|
||||
Column = $cmd.Extent.StartColumnNumber
|
||||
}
|
||||
$info.Breakpoints.Add((Set-PSBreakpoint @params))
|
||||
}
|
||||
|
||||
$info
|
||||
}
|
||||
|
||||
Function Compare-WhitelistPattern {
|
||||
Param (
|
||||
[String[]]$Patterns,
|
||||
[String]$Path
|
||||
)
|
||||
|
||||
foreach ($pattern in $Patterns) {
|
||||
if ($Path -like $pattern) {
|
||||
return $true
|
||||
}
|
||||
}
|
||||
return $false
|
||||
}
|
||||
|
||||
$module_name = $Payload.module_args["_ansible_module_name"]
|
||||
Write-AnsibleLog "INFO - building coverage payload for '$module_name'" "coverage_wrapper"
|
||||
|
||||
# A PS Breakpoint needs an actual path to work properly, we create a temp directory that will store the module and
|
||||
# module_util code during execution
|
||||
$temp_path = Join-Path -Path ([System.IO.Path]::GetTempPath()) -ChildPath "ansible-coverage-$([System.IO.Path]::GetRandomFileName())"
|
||||
Write-AnsibleLog "INFO - Creating temp path for coverage files '$temp_path'" "coverage_wrapper"
|
||||
New-Item -Path $temp_path -ItemType Directory > $null
|
||||
$breakpoint_info = [System.Collections.Generic.List`1[PSObject]]@()
|
||||
|
||||
try {
|
||||
$scripts = [System.Collections.Generic.List`1[System.Object]]@($script:common_functions)
|
||||
|
||||
$coverage_whitelist = $Payload.coverage.whitelist.Split(":", [StringSplitOptions]::RemoveEmptyEntries)
|
||||
|
||||
# We need to track what utils have already been added to the script for loading. This is because the load
|
||||
# order is important and can have module_utils that rely on other utils.
|
||||
$loaded_utils = [System.Collections.Generic.HashSet`1[System.String]]@()
|
||||
$parse_util = {
|
||||
$util_name = $args[0]
|
||||
if (-not $loaded_utils.Add($util_name)) {
|
||||
return
|
||||
}
|
||||
|
||||
$util_code = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($Payload.powershell_modules.$util_name))
|
||||
$util_sb = [ScriptBlock]::Create($util_code)
|
||||
$util_path = Join-Path -Path $temp_path -ChildPath "$($util_name).psm1"
|
||||
|
||||
Write-AnsibleLog "INFO - Outputting module_util $util_name to temp file '$util_path'" "coverage_wrapper"
|
||||
Set-Content -LiteralPath $util_path -Value $util_code
|
||||
|
||||
$ansible_path = $Payload.coverage.module_util_paths.$util_name
|
||||
if ((Compare-WhitelistPattern -Patterns $coverage_whitelist -Path $ansible_path)) {
|
||||
$cov_params = @{
|
||||
Path = $util_path
|
||||
Code = $util_sb
|
||||
AnsiblePath = $ansible_path
|
||||
}
|
||||
$breakpoints = New-CoverageBreakpoint @cov_params
|
||||
$breakpoint_info.Add($breakpoints)
|
||||
}
|
||||
|
||||
if ($null -ne $util_sb.Ast.ScriptRequirements) {
|
||||
foreach ($required_util in $util_sb.Ast.ScriptRequirements.RequiredModules) {
|
||||
&$parse_util $required_util.Name
|
||||
}
|
||||
}
|
||||
Write-AnsibleLog "INFO - Adding util $util_name to scripts to run" "coverage_wrapper"
|
||||
$scripts.Add("Import-Module -Name '$util_path'")
|
||||
}
|
||||
foreach ($util in $Payload.powershell_modules.Keys) {
|
||||
&$parse_util $util
|
||||
}
|
||||
|
||||
$module = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($Payload.module_entry))
|
||||
$module_path = Join-Path -Path $temp_path -ChildPath "$($module_name).ps1"
|
||||
Write-AnsibleLog "INFO - Ouputting module $module_name to temp file '$module_path'" "coverage_wrapper"
|
||||
Set-Content -LiteralPath $module_path -Value $module
|
||||
$scripts.Add($module_path)
|
||||
|
||||
$ansible_path = $Payload.coverage.module_path
|
||||
if ((Compare-WhitelistPattern -Patterns $coverage_whitelist -Path $ansible_path)) {
|
||||
$cov_params = @{
|
||||
Path = $module_path
|
||||
Code = [ScriptBlock]::Create($module)
|
||||
AnsiblePath = $Payload.coverage.module_path
|
||||
}
|
||||
$breakpoints = New-CoverageBreakpoint @cov_params
|
||||
$breakpoint_info.Add($breakpoints)
|
||||
}
|
||||
|
||||
$variables = [System.Collections.ArrayList]@(@{ Name = "complex_args"; Value = $Payload.module_args; Scope = "Global" })
|
||||
$entrypoint = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($payload.module_wrapper))
|
||||
$entrypoint = [ScriptBlock]::Create($entrypoint)
|
||||
|
||||
$params = @{
|
||||
Scripts = $scripts
|
||||
Variables = $variables
|
||||
Environment = $Payload.environment
|
||||
ModuleName = $module_name
|
||||
}
|
||||
if ($breakpoint_info) {
|
||||
$params.Breakpoints = $breakpoint_info.Breakpoints
|
||||
}
|
||||
|
||||
try {
|
||||
&$entrypoint @params
|
||||
} finally {
|
||||
# Processing here is kept to an absolute minimum to make sure each task runtime is kept as small as
|
||||
# possible. Once all the tests have been run ansible-test will collect this info and process it locally in
|
||||
# one go.
|
||||
Write-AnsibleLog "INFO - Creating coverage result output" "coverage_wrapper"
|
||||
$coverage_info = @{}
|
||||
foreach ($info in $breakpoint_info) {
|
||||
$coverage_info.($info.Path) = $info.Breakpoints | Select-Object -Property Line, HitCount
|
||||
}
|
||||
|
||||
# The coverage.output value is a filename set by the Ansible controller. We append some more remote side
|
||||
# info to the filename to make it unique and identify the remote host a bit more.
|
||||
$ps_version = "$($PSVersionTable.PSVersion.Major).$($PSVersionTable.PSVersion.Minor)"
|
||||
$coverage_output_path = "$($Payload.coverage.output)=powershell-$ps_version=coverage.$($env:COMPUTERNAME).$PID.$(Get-Random)"
|
||||
$code_cov_json = ConvertTo-Json -InputObject $coverage_info -Compress
|
||||
|
||||
Write-AnsibleLog "INFO - Outputting coverage json to '$coverage_output_path'" "coverage_wrapper"
|
||||
Set-Content -LiteralPath $coverage_output_path -Value $code_cov_json
|
||||
}
|
||||
} finally {
|
||||
try {
|
||||
if ($breakpoint_info) {
|
||||
foreach ($b in $breakpoint_info.Breakpoints) {
|
||||
Remove-PSBreakpoint -Breakpoint $b
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
Write-AnsibleLog "INFO - Remove temp coverage folder '$temp_path'" "coverage_wrapper"
|
||||
Remove-Item -LiteralPath $temp_path -Force -Recurse
|
||||
}
|
||||
}
|
||||
|
||||
Write-AnsibleLog "INFO - ending coverage_wrapper" "coverage_wrapper"
|
||||
@ -0,0 +1,19 @@
|
||||
---
|
||||
- name: setup global coverage directory for Windows test targets
|
||||
hosts: windows
|
||||
gather_facts: no
|
||||
tasks:
|
||||
- name: create temp directory
|
||||
win_file:
|
||||
path: '{{ remote_temp_path }}'
|
||||
state: directory
|
||||
|
||||
- name: allow everyone to write to coverage test dir
|
||||
win_acl:
|
||||
path: '{{ remote_temp_path }}'
|
||||
user: Everyone
|
||||
rights: Modify
|
||||
inherit: ContainerInherit, ObjectInherit
|
||||
propagation: 'None'
|
||||
type: allow
|
||||
state: present
|
||||
@ -0,0 +1,77 @@
|
||||
---
|
||||
- name: collect the coverage files from the Windows host
|
||||
hosts: windows
|
||||
gather_facts: no
|
||||
tasks:
|
||||
- name: make sure all vars have been set
|
||||
assert:
|
||||
that:
|
||||
- local_temp_path is defined
|
||||
- remote_temp_path is defined
|
||||
|
||||
- name: zip up all coverage files in the
|
||||
win_shell: |
|
||||
$coverage_dir = '{{ remote_temp_path }}'
|
||||
$zip_file = Join-Path -Path $coverage_dir -ChildPath 'coverage.zip'
|
||||
if (Test-Path -LiteralPath $zip_file) {
|
||||
Remove-Item -LiteralPath $zip_file -Force
|
||||
}
|
||||
|
||||
$coverage_files = Get-ChildItem -LiteralPath $coverage_dir -Include '*=coverage*' -File
|
||||
|
||||
$legacy = $false
|
||||
try {
|
||||
# Requires .NET 4.5+ which isn't present on older WIndows versions. Remove once 2008/R2 is EOL.
|
||||
# We also can't use the Shell.Application as it will fail on GUI-less servers (Server Core).
|
||||
Add-Type -AssemblyName System.IO.Compression -ErrorAction Stop > $null
|
||||
} catch {
|
||||
$legacy = $true
|
||||
}
|
||||
|
||||
if ($legacy) {
|
||||
New-Item -Path $zip_file -ItemType File > $null
|
||||
$shell = New-Object -ComObject Shell.Application
|
||||
$zip = $shell.Namespace($zip_file)
|
||||
foreach ($file in $coverage_files) {
|
||||
$zip.CopyHere($file.FullName)
|
||||
}
|
||||
} else {
|
||||
$fs = New-Object -TypeName System.IO.FileStream -ArgumentList $zip_file, 'CreateNew'
|
||||
try {
|
||||
$archive = New-Object -TypeName System.IO.Compression.ZipArchive -ArgumentList @(
|
||||
$fs,
|
||||
[System.IO.Compression.ZipArchiveMode]::Create
|
||||
)
|
||||
try {
|
||||
foreach ($file in $coverage_files) {
|
||||
$archive_entry = $archive.CreateEntry($file.Name, 'Optimal')
|
||||
$entry_fs = $archive_entry.Open()
|
||||
try {
|
||||
$file_fs = [System.IO.File]::OpenRead($file.FullName)
|
||||
try {
|
||||
$file_fs.CopyTo($entry_fs)
|
||||
} finally {
|
||||
$file_fs.Dispose()
|
||||
}
|
||||
} finally {
|
||||
$entry_fs.Dispose()
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
$archive.Dispose()
|
||||
}
|
||||
} finally {
|
||||
$fs.Dispose()
|
||||
}
|
||||
}
|
||||
|
||||
- name: fetch coverage zip file to localhost
|
||||
fetch:
|
||||
src: '{{ remote_temp_path }}\coverage.zip'
|
||||
dest: '{{ local_temp_path }}/coverage-{{ inventory_hostname }}.zip'
|
||||
flat: yes
|
||||
|
||||
- name: remove the temporary coverage directory
|
||||
win_file:
|
||||
path: '{{ remote_temp_path }}'
|
||||
state: absent
|
||||
Loading…
Reference in New Issue