diff --git a/.appveyor.yml b/.appveyor.yml new file mode 100644 index 0000000..ee3a13f --- /dev/null +++ b/.appveyor.yml @@ -0,0 +1,39 @@ +environment: + # Disable publishing to GitHub package repository, since it will fail for + # Cake.Issues.Reporting and Cake.Issues.PullRequests because an archived repo with that name exists. + GPR_SOURCE: + +#---------------------------------# +# Build Image # +#---------------------------------# +image: Visual Studio 2019 + +#---------------------------------# +# Build Script # +#---------------------------------# +install: + # Update to latest NuGet version since we require 5.3.0 for embedded icon + - ps: nuget update -self + +build_script: + - ps: .\build.ps1 -Target CI + +# Tests +test: off + +#---------------------------------# +# Branches to build # +#---------------------------------# +branches: + # Whitelist + only: + - develop + - main + - /release/.*/ + - /hotfix/.*/ + +#---------------------------------# +# Build Cache # +#---------------------------------# +cache: +- tools -> recipe.cake diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..9cc4965 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.cs diff=csharp diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..59b22b9 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# These owners will be the default owners for everything in the repo and +# will be requested for review when someone opens a pull request. +* @pascalberger \ No newline at end of file diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..b7681b8 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +version: 2 +updates: +- package-ecosystem: dotnet:nuget + directory: "/src" + schedule: + interval: live + open-pull-requests-limit: 10 \ No newline at end of file diff --git a/.gitignore b/.gitignore index dfcfd56..4e1c687 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,11 @@ +# Project specific + +BuildArtifacts/ + +### Cake ### +tools/* +!tools/packages.config + ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. ## diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..078295e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contribution Guidelines + +This repository uses [GitFlow] with default configuration. +Development is happening on `develop` branch. + +To contribute: + +* Fork this repository. +* Create a feature branch from `develop`. +* Implement your changes. +* Push your feature branch. +* Create a pull request. + +## Build + +To build this package we are using Cake. + +On Windows PowerShell run: + +```powershell +./build +``` + +On OSX/Linux run: + +```bash +./build.sh +``` + +## Release + +See [Cake.Recipe documentation] how to create a new release of this addin. + +[GitFlow]: (http://nvie.com/posts/a-successful-git-branching-model/) +[Cake.Recipe documentation]: https://cake-contrib.github.io/Cake.Recipe/docs/usage/creating-release \ No newline at end of file diff --git a/GitReleaseManager.yaml b/GitReleaseManager.yaml new file mode 100644 index 0000000..721c1ba --- /dev/null +++ b/GitReleaseManager.yaml @@ -0,0 +1,12 @@ +issue-labels-include: +- Breaking change +- Feature +- Bug +- Improvement +- Documentation +issue-labels-exclude: +- Build +issue-labels-alias: + - name: Documentation + header: Documentation + plural: Documentation \ No newline at end of file diff --git a/README.md b/README.md index 47fc3e8..b672823 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ -# cake.issues.terraform -Addin for providing issues from Terraform to Cake.Issues Addin +# Terraform Provider for Cake.Issues Addin + +This addin for the Cake Build Automation System allows you to read issues from `terraform validate` +using the [Cake Issues addin](https://github.com/cake-contrib/Cake.Issues). + +For more information about this add-in see the [Cake.Issues website](https://cakeissues.net) +and for general information about the Cake build automation system see the [Cake website](http://cakebuild.net). + +[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/cake-contrib/Cake.Issues.Terraform/blob/feature/build/LICENSE) + +## Information + +| | Stable | Pre-release | +|:--:|:--:|:--:| +|GitHub Release|-|[![GitHub release](https://img.shields.io/github/release/cake-contrib/Cake.Issues.Terraform.svg)](https://github.com/cake-contrib/Cake.Issues.Terraform/releases/latest)| +|NuGet|[![NuGet](https://img.shields.io/nuget/v/Cake.Issues.Terraform.svg)](https://www.nuget.org/packages/Cake.Issues.Terraform)|[![NuGet](https://img.shields.io/nuget/vpre/Cake.Issues.Terraform.svg)](https://www.nuget.org/packages/Cake.Issues.Terraform)| + +## Build Status + +| | Develop | Main | +|:--:|:--:|:--:| +|AppVeyor Windows|[![Build status](https://ci.appveyor.com/api/projects/status/vmjky1dv3fwlpg7h/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-issues-terraform/branch/develop)|[![Build status](https://ci.appveyor.com/api/projects/status/vmjky1dv3fwlpg7h/branch/main?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-issues-terraform/branch/main)| +|Azure DevOps Windows|[![Build Status](https://dev.azure.com/cake-contrib/Cake.Issues.Terraform/_apis/build/status/cake-contrib.Cake.Issues.Terraform?branchName=develop&jobName=Windows)](https://dev.azure.com/cake-contrib/Cake.Issues.Terraform/_build/latest?definitionId=13?&branchName=develop)|[![Build Status](https://dev.azure.com/cake-contrib/Cake.Issues.Terraform/_apis/build/status/cake-contrib.Cake.Issues.Terraform?branchName=main&jobName=Windows)](https://dev.azure.com/cake-contrib/Cake.Issues.Terraform/_build/latest?definitionId=13&branchName=main)| + +## Code Coverage + +[![Coverage Status](https://coveralls.io/repos/github/cake-contrib/Cake.Issues.Terraform/badge.svg?branch=develop)](https://coveralls.io/github/cake-contrib/Cake.Issues.Terraform?branch=develop) + +## Quick Links + +- [Documentation](https://cakeissues.net) + +## Discussion + +For questions and to discuss ideas & feature requests, use the [GitHub discussions on the Cake GitHub repository](https://github.com/cake-build/cake/discussions), under the [Extension Q&A](https://github.com/cake-build/cake/discussions/categories/extension-q-a) category. + +[![Join in the discussion on the Cake repository](https://img.shields.io/badge/GitHub-Discussions-green?logo=github)](https://github.com/cake-build/cake/discussions) + +## Contributing + +Contributions are welcome. See [Contribution Guidelines](CONTRIBUTING.md). diff --git a/azure-pipelines.yml b/azure-pipelines.yml new file mode 100644 index 0000000..e6f836f --- /dev/null +++ b/azure-pipelines.yml @@ -0,0 +1,18 @@ +trigger: +- develop +- main +- release/* +- hotfix/* + +pr: +- develop +- release/* +- hotfix/* + +jobs: +- job: Windows + pool: + vmImage: 'windows-2019' + steps: + - powershell: ./build.ps1 + displayName: 'Cake Build' \ No newline at end of file diff --git a/build.ps1 b/build.ps1 new file mode 100644 index 0000000..285bb72 --- /dev/null +++ b/build.ps1 @@ -0,0 +1,261 @@ +########################################################################## +# This is the Cake bootstrapper script for PowerShell. +# Based on boostrapper from https://github.com/cake-build/resources +########################################################################## + +<# + +.SYNOPSIS +This is a Powershell script to bootstrap a Cake build. + +.DESCRIPTION +This Powershell script will download NuGet if missing, restore NuGet tools (including Cake) +and execute your Cake build script with the parameters you provide. + +.PARAMETER Script +The build script to execute. +.PARAMETER Target +The build script target to run. +.PARAMETER Configuration +The build configuration to use. +.PARAMETER Verbosity +Specifies the amount of information to be displayed. +.PARAMETER ShowDescription +Shows description about tasks. +.PARAMETER DryRun +Performs a dry run. +.PARAMETER SkipToolPackageRestore +Skips restoring of packages. +.PARAMETER ScriptArgs +Remaining arguments are added here. + +.LINK +https://cakebuild.net + +#> + +[CmdletBinding()] +Param( + [string]$Script = "recipe.cake", + [string]$Target, + [string]$Configuration, + [ValidateSet("Quiet", "Minimal", "Normal", "Verbose", "Diagnostic")] + [string]$Verbosity, + [switch]$ShowDescription, + [Alias("WhatIf", "Noop")] + [switch]$DryRun, + [switch]$SkipToolPackageRestore, + [Parameter(Position=0,Mandatory=$false,ValueFromRemainingArguments=$true)] + [string[]]$ScriptArgs +) + +# Attempt to set highest encryption available for SecurityProtocol. +# PowerShell will not set this by default (until maybe .NET 4.6.x). This +# will typically produce a message for PowerShell v2 (just an info +# message though) +try { + # Set TLS 1.2 (3072), then TLS 1.1 (768), then TLS 1.0 (192), finally SSL 3.0 (48) + # Use integers because the enumeration values for TLS 1.2 and TLS 1.1 won't + # exist in .NET 4.0, even though they are addressable if .NET 4.5+ is + # installed (.NET 4.5 is an in-place upgrade). + # PowerShell Core already has support for TLS 1.2 so we can skip this if running in that. + if (-not $IsCoreCLR) { + [System.Net.ServicePointManager]::SecurityProtocol = 3072 -bor 768 -bor 192 -bor 48 + } + } catch { + Write-Output 'Unable to set PowerShell to use TLS 1.2 and TLS 1.1 due to old .NET Framework installed. If you see underlying connection closed or trust errors, you may need to upgrade to .NET Framework 4.5+ and PowerShell v3' + } + +[Reflection.Assembly]::LoadWithPartialName("System.Security") | Out-Null +function MD5HashFile([string] $filePath) +{ + if ([string]::IsNullOrEmpty($filePath) -or !(Test-Path $filePath -PathType Leaf)) + { + return $null + } + + [System.IO.Stream] $file = $null; + [System.Security.Cryptography.MD5] $md5 = $null; + try + { + $md5 = [System.Security.Cryptography.MD5]::Create() + $file = [System.IO.File]::OpenRead($filePath) + return [System.BitConverter]::ToString($md5.ComputeHash($file)) + } + finally + { + if ($file -ne $null) + { + $file.Dispose() + } + } +} + +function GetProxyEnabledWebClient +{ + $wc = New-Object System.Net.WebClient + $proxy = [System.Net.WebRequest]::GetSystemWebProxy() + $proxy.Credentials = [System.Net.CredentialCache]::DefaultCredentials + $wc.Proxy = $proxy + return $wc +} + +Write-Host "Preparing to run build script..." + +if(!$PSScriptRoot){ + $PSScriptRoot = Split-Path $MyInvocation.MyCommand.Path -Parent +} + +$TOOLS_DIR = Join-Path $PSScriptRoot "tools" +$ADDINS_DIR = Join-Path $TOOLS_DIR "Addins" +$MODULES_DIR = Join-Path $TOOLS_DIR "Modules" +$NUGET_EXE = Join-Path $TOOLS_DIR "nuget.exe" +$CAKE_EXE = Join-Path $TOOLS_DIR "Cake/Cake.exe" +$NUGET_URL = "https://dist.nuget.org/win-x86-commandline/latest/nuget.exe" +$PACKAGES_CONFIG = Join-Path $TOOLS_DIR "packages.config" +$PACKAGES_CONFIG_MD5 = Join-Path $TOOLS_DIR "packages.config.md5sum" +$ADDINS_PACKAGES_CONFIG = Join-Path $ADDINS_DIR "packages.config" +$MODULES_PACKAGES_CONFIG = Join-Path $MODULES_DIR "packages.config" + +# Make sure tools folder exists +if ((Test-Path $PSScriptRoot) -and !(Test-Path $TOOLS_DIR)) { + Write-Verbose -Message "Creating tools directory..." + New-Item -Path $TOOLS_DIR -Type Directory | Out-Null +} + +# Make sure that packages.config exist. +if (!(Test-Path $PACKAGES_CONFIG)) { + Write-Verbose -Message "Downloading packages.config..." + try { + $wc = GetProxyEnabledWebClient + $wc.DownloadFile("https://cakebuild.net/download/bootstrapper/packages", $PACKAGES_CONFIG) + } catch { + Throw "Could not download packages.config." + } +} + +# Try find NuGet.exe in path if not exists +if (!(Test-Path $NUGET_EXE)) { + Write-Verbose -Message "Trying to find nuget.exe in PATH..." + $existingPaths = $Env:Path -Split ';' | Where-Object { (![string]::IsNullOrEmpty($_)) -and (Test-Path $_ -PathType Container) } + $NUGET_EXE_IN_PATH = Get-ChildItem -Path $existingPaths -Filter "nuget.exe" | Select -First 1 + if ($NUGET_EXE_IN_PATH -ne $null -and (Test-Path $NUGET_EXE_IN_PATH.FullName)) { + Write-Verbose -Message "Found in PATH at $($NUGET_EXE_IN_PATH.FullName)." + $NUGET_EXE = $NUGET_EXE_IN_PATH.FullName + } +} + +# Try download NuGet.exe if not exists +if (!(Test-Path $NUGET_EXE)) { + Write-Verbose -Message "Downloading NuGet.exe..." + try { + $wc = GetProxyEnabledWebClient + $wc.DownloadFile($NUGET_URL, $NUGET_EXE) + } catch { + Throw "Could not download NuGet.exe." + } +} + +# Save nuget.exe path to environment to be available to child processed +$env:NUGET_EXE = $NUGET_EXE +$env:NUGET_EXE_INVOCATION = if ($IsLinux -or $IsMacOS) { + "mono `"$NUGET_EXE`"" +} else { + "`"$NUGET_EXE`"" +} + +# Restore tools from NuGet? +if(-Not $SkipToolPackageRestore.IsPresent) { + Push-Location + Set-Location $TOOLS_DIR + + # Check for changes in packages.config and remove installed tools if true. + [string] $md5Hash = MD5HashFile $PACKAGES_CONFIG + if((!(Test-Path $PACKAGES_CONFIG_MD5)) -Or + ($md5Hash -ne (Get-Content $PACKAGES_CONFIG_MD5 ))) { + Write-Verbose -Message "Missing or changed package.config hash..." + Get-ChildItem -Exclude packages.config,nuget.exe,Cake.Bakery | + Remove-Item -Recurse -Force + } + + Write-Verbose -Message "Restoring tools from NuGet..." + + $NuGetOutput = Invoke-Expression "& $env:NUGET_EXE_INVOCATION install -ExcludeVersion -OutputDirectory `"$TOOLS_DIR`"" + + if ($LASTEXITCODE -ne 0) { + Throw "An error occurred while restoring NuGet tools." + } + else + { + $md5Hash | Out-File $PACKAGES_CONFIG_MD5 -Encoding "ASCII" + } + Write-Verbose -Message ($NuGetOutput | Out-String) + + Pop-Location +} + +# Restore addins from NuGet +if (Test-Path $ADDINS_PACKAGES_CONFIG) { + Push-Location + Set-Location $ADDINS_DIR + + Write-Verbose -Message "Restoring addins from NuGet..." + $NuGetOutput = Invoke-Expression "& $env:NUGET_EXE_INVOCATION install -ExcludeVersion -OutputDirectory `"$ADDINS_DIR`"" + + if ($LASTEXITCODE -ne 0) { + Throw "An error occurred while restoring NuGet addins." + } + + Write-Verbose -Message ($NuGetOutput | Out-String) + + Pop-Location +} + +# Restore modules from NuGet +if (Test-Path $MODULES_PACKAGES_CONFIG) { + Push-Location + Set-Location $MODULES_DIR + + Write-Verbose -Message "Restoring modules from NuGet..." + $NuGetOutput = Invoke-Expression "& $env:NUGET_EXE_INVOCATION install -ExcludeVersion -OutputDirectory `"$MODULES_DIR`"" + + if ($LASTEXITCODE -ne 0) { + Throw "An error occurred while restoring NuGet modules." + } + + Write-Verbose -Message ($NuGetOutput | Out-String) + + Pop-Location +} + +# Make sure that Cake has been installed. +if (!(Test-Path $CAKE_EXE)) { + Throw "Could not find Cake.exe at $CAKE_EXE" +} + +$CAKE_EXE_INVOCATION = if ($IsLinux -or $IsMacOS) { + "mono `"$CAKE_EXE`"" +} else { + "`"$CAKE_EXE`"" +} + + # Build an array (not a string) of Cake arguments to be joined later +$cakeArguments = @() +if ($Script) { $cakeArguments += "`"$Script`"" } +if ($Target) { $cakeArguments += "-target=`"$Target`"" } +if ($Configuration) { $cakeArguments += "-configuration=$Configuration" } +if ($Verbosity) { $cakeArguments += "-verbosity=$Verbosity" } +if ($ShowDescription) { $cakeArguments += "-showdescription" } +if ($DryRun) { $cakeArguments += "-dryrun" } +$cakeArguments += $ScriptArgs + +# Bootstrap & start Cake +Write-Host "Bootstrapping Cake..." +Invoke-Expression "& $CAKE_EXE_INVOCATION $Script --bootstrap" +if ($LASTEXITCODE -eq 0) +{ + Write-Host "Running build script..." + Invoke-Expression "& $CAKE_EXE_INVOCATION $($cakeArguments -join " ")" +} + +exit $LASTEXITCODE \ No newline at end of file diff --git a/build.sh b/build.sh new file mode 100644 index 0000000..878a2f2 --- /dev/null +++ b/build.sh @@ -0,0 +1,116 @@ +#!/usr/bin/env bash + +########################################################################## +# This is the Cake bootstrapper script for Linux and OS X. +# Based on bootstrapper from https://github.com/cake-build/resources +########################################################################## + +# Define directories. +SCRIPT_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) +TOOLS_DIR=$SCRIPT_DIR/tools +ADDINS_DIR=$TOOLS_DIR/Addins +MODULES_DIR=$TOOLS_DIR/Modules +NUGET_EXE=$TOOLS_DIR/nuget.exe +CAKE_EXE=$TOOLS_DIR/Cake/Cake.exe +PACKAGES_CONFIG=$TOOLS_DIR/packages.config +PACKAGES_CONFIG_MD5=$TOOLS_DIR/packages.config.md5sum +ADDINS_PACKAGES_CONFIG=$ADDINS_DIR/packages.config +MODULES_PACKAGES_CONFIG=$MODULES_DIR/packages.config + +# Define md5sum or md5 depending on Linux/OSX +MD5_EXE= +if [[ "$(uname -s)" == "Darwin" ]]; then + MD5_EXE="md5 -r" +else + MD5_EXE="md5sum" +fi + +# Define default arguments. +SCRIPT="recipe.cake" +CAKE_ARGUMENTS=() + +# Parse arguments. +for i in "$@"; do + case $1 in + -s|--script) SCRIPT="$2"; shift ;; + --) shift; CAKE_ARGUMENTS+=("$@"); break ;; + *) CAKE_ARGUMENTS+=("$1") ;; + esac + shift +done + +# Make sure the tools folder exist. +if [ ! -d "$TOOLS_DIR" ]; then + mkdir "$TOOLS_DIR" +fi + +# Make sure that packages.config exist. +if [ ! -f "$TOOLS_DIR/packages.config" ]; then + echo "Downloading packages.config..." + curl -Lsfo "$TOOLS_DIR/packages.config" https://cakebuild.net/download/bootstrapper/packages + if [ $? -ne 0 ]; then + echo "An error occurred while downloading packages.config." + exit 1 + fi +fi + +# Download NuGet if it does not exist. +if [ ! -f "$NUGET_EXE" ]; then + echo "Downloading NuGet..." + curl -Lsfo "$NUGET_EXE" https://dist.nuget.org/win-x86-commandline/latest/nuget.exe + if [ $? -ne 0 ]; then + echo "An error occurred while downloading nuget.exe." + exit 1 + fi +fi + +# Restore tools from NuGet. +pushd "$TOOLS_DIR" >/dev/null +if [ ! -f "$PACKAGES_CONFIG_MD5" ] || [ "$( cat "$PACKAGES_CONFIG_MD5" | sed 's/\r$//' )" != "$( $MD5_EXE "$PACKAGES_CONFIG" | awk '{ print $1 }' )" ]; then + find . -type d ! -name . ! -name 'Cake.Bakery' | xargs rm -rf +fi + +mono "$NUGET_EXE" install -ExcludeVersion +if [ $? -ne 0 ]; then + echo "Could not restore NuGet tools." + exit 1 +fi + +$MD5_EXE "$PACKAGES_CONFIG" | awk '{ print $1 }' >| "$PACKAGES_CONFIG_MD5" + +popd >/dev/null + +# Restore addins from NuGet. +if [ -f "$ADDINS_PACKAGES_CONFIG" ]; then + pushd "$ADDINS_DIR" >/dev/null + + mono "$NUGET_EXE" install -ExcludeVersion + if [ $? -ne 0 ]; then + echo "Could not restore NuGet addins." + exit 1 + fi + + popd >/dev/null +fi + +# Restore modules from NuGet. +if [ -f "$MODULES_PACKAGES_CONFIG" ]; then + pushd "$MODULES_DIR" >/dev/null + + mono "$NUGET_EXE" install -ExcludeVersion + if [ $? -ne 0 ]; then + echo "Could not restore NuGet modules." + exit 1 + fi + + popd >/dev/null +fi + +# Make sure that Cake has been installed. +if [ ! -f "$CAKE_EXE" ]; then + echo "Could not find Cake.exe at '$CAKE_EXE'." + exit 1 +fi + +# Bootstrap & start Cake +(exec mono "$CAKE_EXE" $SCRIPT --bootstrap) && (exec mono "$CAKE_EXE" $SCRIPT "${CAKE_ARGUMENTS[@]}") \ No newline at end of file diff --git a/cake.config b/cake.config new file mode 100644 index 0000000..8615723 --- /dev/null +++ b/cake.config @@ -0,0 +1,3 @@ +[Nuget] +; Use the new InProcess client, because some packages have long file paths. +UseInProcessClient=true \ No newline at end of file diff --git a/docs/features.md b/docs/features.md new file mode 100644 index 0000000..dbb414f --- /dev/null +++ b/docs/features.md @@ -0,0 +1,37 @@ +--- +Order: 20 +Title: Features +Description: Features of the Cake.Issues.Terraform addin. +--- +The [Cake.Issues.Terraform addin] provides the following features: + +# Basic features + +* Reads warnings from [Terraform validate command]. + +# Supported IIssue properties + +| | Property | Remarks | +|--------------------------------------------------------------------|-----------------------------------|----------------------------------| +| | `IIssue.ProviderType` | | +| | `IIssue.ProviderName` | | +| | `IIssue.Run` | Can be set while reading issues | +| | `IIssue.Identifier` | Set to `IIssue.MessageText` | +| | `IIssue.ProjectName` | | +| | `IIssue.ProjectFileRelativePath` | | +| | `IIssue.AffectedFileRelativePath` | | +| | `IIssue.Line` | | +| | `IIssue.EndLine` | | +| | `IIssue.Column` | | +| | `IIssue.EndColumn` | | +| | `IIssue.FileLink` | Can be set while reading issues | +| | `IIssue.MessageText` | | +| | `IIssue.MessageHtml` | | +| | `IIssue.MessageMarkdown` | | +| | `IIssue.Priority` | | +| | `IIssue.PriorityName` | | +| | `IIssue.Rule` | | +| | `IIssue.RuleUrl` | | + +[Terraform validate command]: https://www.terraform.io/docs/cli/commands/validate.html +[Cake.Issues.Terraform addin]: https://cakebuild.net/extensions/cake-issues-terraform/ diff --git a/docs/index.cshtml b/docs/index.cshtml new file mode 100644 index 0000000..184598e --- /dev/null +++ b/docs/index.cshtml @@ -0,0 +1,12 @@ +--- +Title: Terraform +Description: Issue provider which allows you to read issues from Terraform validate command. +--- +

@Html.Raw(Model.String(DocsKeys.Description))

+ +

+ Support for reading issues reported by Terraform validate command + is implemented in the Cake.Issues.Terraform addin. +

+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/requirements.md b/docs/requirements.md new file mode 100644 index 0000000..4b7a408 --- /dev/null +++ b/docs/requirements.md @@ -0,0 +1,9 @@ +--- +Order: 10 +Title: Requirements +Description: Requirements for the Cake.Issues.Terraform addin. +--- +The requirements for using the [Cake.Issues.Terraform addin] are listed in the [release notes] for any specific version. + +[Cake.Issues.Terraform addin]: https://cakebuild.net/extensions/cake-issues-terraform/ +[release notes]: release-notes diff --git a/nuspec/nuget/Cake.Issues.Terraform.nuspec b/nuspec/nuget/Cake.Issues.Terraform.nuspec new file mode 100644 index 0000000..4fa78fc --- /dev/null +++ b/nuspec/nuget/Cake.Issues.Terraform.nuspec @@ -0,0 +1,35 @@ + + + + Cake.Issues.Terraform + Cake.Issues.Terraform + 0.0.0 + Pascal Berger + pascalberger, cake-contrib + Terraform support for the Cake.Issues addin for Cake Build Automation System + +The Terraform support for the Cake.Issues addin for Cake allows you to read issues logged by terraform validate. + +This addin provides the aliases for reading terraform validate output and providing them to the Cake.Issues addin. +It also requires the core Cake.Issues addin. + +There are also additional addins for generating reports or posting issues to pull requests. + +See the Project Site for an overview of the whole ecosystem of addins for working with issues in Cake scripts. + + MIT + https://cakeissues.net + icon.png + false + + Copyright © Pascal Berger + cake cake-addin cake-issues cake-issueprovider linting terraform + https://github.com/cake-contrib/Cake.Issues.Terraform/releases/tag/1.0.0 + + + + + + + + \ No newline at end of file diff --git a/nuspec/nuget/icon.png b/nuspec/nuget/icon.png new file mode 100644 index 0000000..84c2a82 Binary files /dev/null and b/nuspec/nuget/icon.png differ diff --git a/recipe.cake b/recipe.cake new file mode 100644 index 0000000..8a9b93e --- /dev/null +++ b/recipe.cake @@ -0,0 +1,28 @@ +#load nuget:?package=Cake.Recipe&version=2.2.0 + +Environment.SetVariableNames(); + +BuildParameters.SetParameters( + context: Context, + buildSystem: BuildSystem, + sourceDirectoryPath: "./src", + title: "Cake.Issues.Terraform", + repositoryOwner: "cake-contrib", + repositoryName: "Cake.Issues.Terraform", + appVeyorAccountName: "cakecontrib", + shouldGenerateDocumentation: false); + +BuildParameters.PrintParameters(Context); + +ToolSettings.SetToolSettings( + context: Context, + dupFinderExcludePattern: new string[] + { + BuildParameters.RootDirectoryPath + "/src/Cake.Issues.Terraform.Tests/*.cs", + BuildParameters.RootDirectoryPath + "/src/Cake.Issues.Terraform*/**/*.AssemblyInfo.cs" + }, + testCoverageFilter: "+[*]* -[xunit.*]* -[Cake.Core]* -[Cake.Testing]* -[*.Tests]* -[Cake.Issues]* -[Cake.Issues.Testing]* -[Shouldly]* -[DiffEngine]* -[EmptyFiles]*", + testCoverageExcludeByAttribute: "*.ExcludeFromCodeCoverage*", + testCoverageExcludeByFile: "*/*Designer.cs;*/*.g.cs;*/*.g.i.cs"); + +Build.RunDotNetCore(); diff --git a/src/Cake.Issues.Terraform.Tests.ruleset b/src/Cake.Issues.Terraform.Tests.ruleset new file mode 100644 index 0000000..01beee8 --- /dev/null +++ b/src/Cake.Issues.Terraform.Tests.ruleset @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/src/Cake.Issues.Terraform.Tests/Cake.Issues.Terraform.Tests.csproj b/src/Cake.Issues.Terraform.Tests/Cake.Issues.Terraform.Tests.csproj new file mode 100644 index 0000000..de069b8 --- /dev/null +++ b/src/Cake.Issues.Terraform.Tests/Cake.Issues.Terraform.Tests.csproj @@ -0,0 +1,56 @@ + + + + Library + netcoreapp2.1 + false + Tests for the Cake.Issues.Terraform addin + Pascal Berger + Cake.Issues + Copyright © Pascal Berger + + + ..\Cake.Issues.Terraform.Tests.ruleset + + + ..\Cake.Issues.Terraform.Tests.ruleset + + + + + + + + + + + + + + + + + 1.0.0 + + + 1.0.0 + + + 4.0.3 + + + 1.1.118 + runtime; build; native; contentfiles; analyzers + all + + + + 2.4.1 + + + 2.4.3 + runtime; build; native; contentfiles; analyzers + all + + + \ No newline at end of file diff --git a/src/Cake.Issues.Terraform.Tests/Properties/ProjectInfo.cs b/src/Cake.Issues.Terraform.Tests/Properties/ProjectInfo.cs new file mode 100644 index 0000000..51a16e4 --- /dev/null +++ b/src/Cake.Issues.Terraform.Tests/Properties/ProjectInfo.cs @@ -0,0 +1,16 @@ +using System.Reflection; +using System.Runtime.InteropServices; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("3c1e1ff5-c57e-4e46-85a9-ba3dde8b00b5")] diff --git a/src/Cake.Issues.Terraform.Tests/TerraformProviderFixture.cs b/src/Cake.Issues.Terraform.Tests/TerraformProviderFixture.cs new file mode 100644 index 0000000..dfd0a0f --- /dev/null +++ b/src/Cake.Issues.Terraform.Tests/TerraformProviderFixture.cs @@ -0,0 +1,30 @@ +namespace Cake.Issues.Terraform.Tests +{ + using System.Collections.Generic; + using Cake.Core.IO; + using Cake.Issues.Testing; + + internal class TerraformProviderFixture : BaseConfigurableIssueProviderFixture + { + private readonly DirectoryPath docRootPath; + + public TerraformProviderFixture(string fileResourceName, DirectoryPath docRootPath) + : base(fileResourceName) + { + docRootPath.NotNull(nameof(docRootPath)); + + this.docRootPath = docRootPath; + this.ReadIssuesSettings = + new ReadIssuesSettings(@"c:\Source\Cake.Issues"); + } + + protected override string FileResourceNamespace => "Cake.Issues.Terraform.Tests.Testfiles."; + + protected override IList GetCreateIssueProviderSettingsArguments() + { + var result = base.GetCreateIssueProviderSettingsArguments(); + result.Add(this.docRootPath); + return result; + } + } +} diff --git a/src/Cake.Issues.Terraform.Tests/TerraformProviderTests.cs b/src/Cake.Issues.Terraform.Tests/TerraformProviderTests.cs new file mode 100644 index 0000000..49462ca --- /dev/null +++ b/src/Cake.Issues.Terraform.Tests/TerraformProviderTests.cs @@ -0,0 +1,93 @@ +namespace Cake.Issues.Terraform.Tests +{ + using System.Linq; + using Cake.Issues.Testing; + using Cake.Testing; + using Shouldly; + using Xunit; + + public sealed class TerraformProviderTests + { + public sealed class TheCtor + { + [Fact] + public void Should_Throw_If_Log_Is_Null() + { + // Given / When + var result = Record.Exception(() => + new TerraformIssuesProvider( + null, + new TerraformIssuesSettings("Foo".ToByteArray(), @"c:\Source\Cake.Issues"))); + + // Then + result.IsArgumentNullException("log"); + } + + [Fact] + public void Should_Throw_If_IssueProviderSettings_Are_Null() + { + var result = Record.Exception(() => + new TerraformIssuesProvider( + new FakeLog(), + null)); + + // Then + result.IsArgumentNullException("issueProviderSettings"); + } + } + + // Test cases based on https://github.com/hashicorp/terraform-json/blob/master/validate_test.go + public sealed class TheReadIssuesMethod + { + [Fact] + public void Should_Read_Basic_Issues_Correct() + { + // Given + var fixture = new TerraformProviderFixture("basic.json", @"./"); + + // When + var issues = fixture.ReadIssues().ToList(); + + // Then + issues.Count.ShouldBe(2); + IssueChecker.Check( + issues[0], + IssueBuilder.NewIssue( + "\"anonymous\": [DEPRECATED] For versions later than 3.0.0, absence of a token enables this mode", + "Cake.Issues.Terraform.TerraformIssuesProvider", + "Terraform") + .WithPriority(IssuePriority.Warning)); + IssueChecker.Check( + issues[1], + IssueBuilder.NewIssue( + "The argument \"name\" is required, but no definition was found.", + "Cake.Issues.Terraform.TerraformIssuesProvider", + "Terraform") + .InFile("main.tf", 14, 14, 37, 37) + .OfRule("Missing required argument") + .WithPriority(IssuePriority.Error)); + } + + [Fact] + public void Should_Read_Error_Correct() + { + // Given + var fixture = new TerraformProviderFixture("error.json", @"./"); + + // When + var issues = fixture.ReadIssues().ToList(); + + // Then + issues.Count.ShouldBe(1); + IssueChecker.Check( + issues[0], + IssueBuilder.NewIssue( + "\nPlugin reinitialization required...", + "Cake.Issues.Terraform.TerraformIssuesProvider", + "Terraform") + .OfRule("Could not load plugin") + .WithPriority(IssuePriority.Error)); + } + } + } +} diff --git a/src/Cake.Issues.Terraform.Tests/TerraformSettingsTests.cs b/src/Cake.Issues.Terraform.Tests/TerraformSettingsTests.cs new file mode 100644 index 0000000..6cc0950 --- /dev/null +++ b/src/Cake.Issues.Terraform.Tests/TerraformSettingsTests.cs @@ -0,0 +1,147 @@ +namespace Cake.Issues.Terraform.Tests +{ + using System; + using Cake.Core.IO; + using Cake.Issues.Testing; + using Shouldly; + using Xunit; + + public sealed class TerraformSettingsTests + { + public sealed class TheCtor + { + [Fact] + public void Should_Throw_If_ValidateOutputFilePath_Is_Null() + { + // Given + FilePath validateOutputFilePath = null; + var terraformRootPath = @"c:\Source\Cake.Issues\docs"; + + // When + var result = Record.Exception(() => + new TerraformIssuesSettings(validateOutputFilePath, terraformRootPath)); + + // Then + result.IsArgumentNullException("logFilePath"); + } + + [Fact] + public void Should_Throw_If_TerraformRootPath_For_ValidateOutputFilePath_Is_Null() + { + // Given + DirectoryPath terraformRootPath = null; + + using (var tempFile = new ResourceTempFile("Cake.Issues.Terraform.Tests.Testfiles.basic.json")) + { + // When + var result = Record.Exception(() => + new TerraformIssuesSettings(tempFile.FileName, terraformRootPath)); + + // Then + result.IsArgumentNullException("terraformRootPath"); + } + } + + [Fact] + public void Should_Throw_If_ValidateOutput_Is_Null() + { + // Given + byte[] validateOutput = null; + var terraformRootPath = @"c:\Source\Cake.Issues\docs"; + + // When + var result = Record.Exception(() => new TerraformIssuesSettings(validateOutput, terraformRootPath)); + + // Then + result.IsArgumentNullException("logFileContent"); + } + + [Fact] + public void Should_Throw_If_TerraformRootPath_For_ValidateOutput_Is_Null() + { + // Given + var validateOutput = "foo".ToByteArray(); + DirectoryPath terraformRootPath = null; + + // When + var result = Record.Exception(() => + new TerraformIssuesSettings(validateOutput, terraformRootPath)); + + // Then + result.IsArgumentNullException("terraformRootPath"); + } + + [Fact] + public void Should_Set_ValidateOutput() + { + // Given + var validateOutput = "Foo".ToByteArray(); + var terraformRootPath = @"c:\Source\Cake.Issues\docs"; + + // When + var settings = new TerraformIssuesSettings(validateOutput, terraformRootPath); + + // Then + settings.LogFileContent.ShouldBe(validateOutput); + } + + [Fact] + public void Should_Set_ValidateOutput_If_Empty() + { + // Given + byte[] validateOutput = Array.Empty(); + var terraformRootPath = @"c:\Source\Cake.Issues\docs"; + + // When + var settings = new TerraformIssuesSettings(validateOutput, terraformRootPath); + + // Then + settings.LogFileContent.ShouldBe(validateOutput); + } + + [Fact] + public void Should_Set_TerraformRootPath() + { + // Given + var validateOutput = "Foo".ToByteArray(); + var terraformRootPath = @"c:/Source/Cake.Issues/docs"; + + // When + var settings = new TerraformIssuesSettings(validateOutput, terraformRootPath); + + // Then + settings.TerraformRootPath.ToString().ShouldBe(terraformRootPath); + } + + [Fact] + public void Should_Set_ValidateOutput_From_ValidateOutputFilePath() + { + // Given + var terraformRootPath = @"c:\Source\Cake.Issues\docs"; + using (var tempFile = new ResourceTempFile("Cake.Issues.Terraform.Tests.Testfiles.basic.json")) + { + // When + var settings = new TerraformIssuesSettings(tempFile.FileName, terraformRootPath); + + // Then + settings.LogFileContent.ShouldBe(tempFile.Content); + } + } + + [Fact] + public void Should_Set_TerraformRootPath_From_ValidateOutputFilePath() + { + // Given + var terraformRootPath = @"c:/Source/Cake.Issues/docs"; + using (var tempFile = new ResourceTempFile("Cake.Issues.Terraform.Tests.Testfiles.basic.json")) + { + // When + var settings = new TerraformIssuesSettings(tempFile.FileName, terraformRootPath); + + // Then + settings.TerraformRootPath.ToString().ShouldBe(terraformRootPath); + } + } + } + } +} diff --git a/src/Cake.Issues.Terraform.Tests/Testfiles/basic.json b/src/Cake.Issues.Terraform.Tests/Testfiles/basic.json new file mode 100644 index 0000000..d52ebcf --- /dev/null +++ b/src/Cake.Issues.Terraform.Tests/Testfiles/basic.json @@ -0,0 +1,29 @@ +{ + "valid": false, + "error_count": 1, + "warning_count": 1, + "diagnostics": [ + { + "severity": "warning", + "summary": "\"anonymous\": [DEPRECATED] For versions later than 3.0.0, absence of a token enables this mode" + }, + { + "severity": "error", + "summary": "Missing required argument", + "detail": "The argument \"name\" is required, but no definition was found.", + "range": { + "filename": "main.tf", + "start": { + "line": 14, + "column": 37, + "byte": 200 + }, + "end": { + "line": 14, + "column": 37, + "byte": 200 + } + } + } + ] +} \ No newline at end of file diff --git a/src/Cake.Issues.Terraform.Tests/Testfiles/error.json b/src/Cake.Issues.Terraform.Tests/Testfiles/error.json new file mode 100644 index 0000000..10b1d4e --- /dev/null +++ b/src/Cake.Issues.Terraform.Tests/Testfiles/error.json @@ -0,0 +1,12 @@ +{ + "valid": false, + "error_count": 1, + "warning_count": 0, + "diagnostics": [ + { + "severity": "error", + "summary": "Could not load plugin", + "detail": "\nPlugin reinitialization required..." + } + ] +} \ No newline at end of file diff --git a/src/Cake.Issues.Terraform.ruleset b/src/Cake.Issues.Terraform.ruleset new file mode 100644 index 0000000..80e6f36 --- /dev/null +++ b/src/Cake.Issues.Terraform.ruleset @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/Cake.Issues.Terraform.sln b/src/Cake.Issues.Terraform.sln new file mode 100644 index 0000000..0f729a5 --- /dev/null +++ b/src/Cake.Issues.Terraform.sln @@ -0,0 +1,44 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 15 +VisualStudioVersion = 15.0.26730.8 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cake.Issues.Terraform", "Cake.Issues.Terraform\Cake.Issues.Terraform.csproj", "{9774EC64-94A9-4260-9886-4F02635F0D89}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cake.Issues.Terraform.Tests", "Cake.Issues.Terraform.Tests\Cake.Issues.Terraform.Tests.csproj", "{29F83008-7B25-4BF6-9B8A-3E17E79D8881}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{CE25C309-7FBA-48E7-B03E-5F8D014774AF}" + ProjectSection(SolutionItems) = preProject + ..\recipe.cake = ..\recipe.cake + EndProjectSection +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "nuspec", "nuspec", "{0E6A55DD-0E2C-42C5-9444-F5F894A0A11E}" + ProjectSection(SolutionItems) = preProject + ..\nuspec\nuget\Cake.Issues.Terraform.nuspec = ..\nuspec\nuget\Cake.Issues.Terraform.nuspec + EndProjectSection +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {9774EC64-94A9-4260-9886-4F02635F0D89}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9774EC64-94A9-4260-9886-4F02635F0D89}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9774EC64-94A9-4260-9886-4F02635F0D89}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9774EC64-94A9-4260-9886-4F02635F0D89}.Release|Any CPU.Build.0 = Release|Any CPU + {29F83008-7B25-4BF6-9B8A-3E17E79D8881}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {29F83008-7B25-4BF6-9B8A-3E17E79D8881}.Debug|Any CPU.Build.0 = Debug|Any CPU + {29F83008-7B25-4BF6-9B8A-3E17E79D8881}.Release|Any CPU.ActiveCfg = Release|Any CPU + {29F83008-7B25-4BF6-9B8A-3E17E79D8881}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {0E6A55DD-0E2C-42C5-9444-F5F894A0A11E} = {CE25C309-7FBA-48E7-B03E-5F8D014774AF} + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {3EAE9FDF-D402-43A1-981E-5070EEB3D48B} + EndGlobalSection +EndGlobal diff --git a/src/Cake.Issues.Terraform.sln.DotSettings b/src/Cake.Issues.Terraform.sln.DotSettings new file mode 100644 index 0000000..7cc51a4 --- /dev/null +++ b/src/Cake.Issues.Terraform.sln.DotSettings @@ -0,0 +1,3 @@ + + DO_NOT_SHOW + <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> \ No newline at end of file diff --git a/src/Cake.Issues.Terraform/Cake.Issues.Terraform.csproj b/src/Cake.Issues.Terraform/Cake.Issues.Terraform.csproj new file mode 100644 index 0000000..f39a8cd --- /dev/null +++ b/src/Cake.Issues.Terraform/Cake.Issues.Terraform.csproj @@ -0,0 +1,42 @@ + + + + Library + netstandard2.0 + Terraform support for the Cake.Issues Addin for Cake Build Automation System + Pascal Berger + Cake.Issues + Copyright © Pascal Berger + + + bin\Debug\Cake.Issues.Terraform.xml + ..\Cake.Issues.Terraform.ruleset + DEBUG;TRACE + + + bin\Release\Cake.Issues.Terraform.xml + ..\Cake.Issues.Terraform.ruleset + TRACE + + + full + AllEnabledByDefault + + + + 1.0.0 + + + 1.0.0 + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + 1.1.118 + runtime; build; native; contentfiles; analyzers + all + + + \ No newline at end of file diff --git a/src/Cake.Issues.Terraform/Properties/ProjectInfo.cs b/src/Cake.Issues.Terraform/Properties/ProjectInfo.cs new file mode 100644 index 0000000..67e8715 --- /dev/null +++ b/src/Cake.Issues.Terraform/Properties/ProjectInfo.cs @@ -0,0 +1,21 @@ +using System; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("0d5b570e-dfca-4fcb-8528-c7b96ee0f5d3")] + +[assembly: CLSCompliant(true)] +[assembly: InternalsVisibleTo("Cake.Issues.Terraform.Tests")] \ No newline at end of file diff --git a/src/Cake.Issues.Terraform/TerraformIssuesAliases.cs b/src/Cake.Issues.Terraform/TerraformIssuesAliases.cs new file mode 100644 index 0000000..f24a8fe --- /dev/null +++ b/src/Cake.Issues.Terraform/TerraformIssuesAliases.cs @@ -0,0 +1,191 @@ +namespace Cake.Issues.Terraform +{ + using Cake.Core; + using Cake.Core.Annotations; + using Cake.Core.IO; + + /// + /// Contains functionality related to reading output from terraform validate -json. + /// + [CakeAliasCategory(IssuesAliasConstants.MainCakeAliasCategory)] + public static class TerraformIssuesAliases + { + /// + /// Gets the name of the Terraform issue provider. + /// This name can be used to identify issues based on the property. + /// + /// The context. + /// Name of the Terraform issue provider. + [CakePropertyAlias] + [CakeAliasCategory(IssuesAliasConstants.IssueProviderCakeAliasCategory)] + public static string TerraformIssuesProviderTypeName( + this ICakeContext context) + { + context.NotNull(nameof(context)); + + return TerraformIssuesProvider.ProviderTypeName; + } + + /// + /// Gets an instance of a provider for reading output from terraform validate -json from disk + /// for Terraform scripts in the repository root. + /// + /// The context. + /// Path to the output of the terraform validate command. + /// Instance of a provider for warnings reported by terraform validate. + /// + /// Read warnings reported by terraform validate: + /// + /// + /// + /// + [CakeMethodAlias] + [CakeAliasCategory(IssuesAliasConstants.IssueProviderCakeAliasCategory)] + public static IIssueProvider TerraformIssuesFromFilePath( + this ICakeContext context, + FilePath validateOutputFilePath) + { + context.NotNull(nameof(context)); + validateOutputFilePath.NotNull(nameof(validateOutputFilePath)); + + return context.TerraformIssuesFromFilePath(validateOutputFilePath, "/"); + } + + /// + /// Gets an instance of a provider for reading output from terraform validate -json from disk. + /// + /// The context. + /// Path to the output of the terraform validate command. + /// Path to the directory of the Terraform scripts. + /// Either the full path or the path relative to the repository root. + /// Instance of a provider for warnings reported by terraform validate. + /// + /// Read warnings reported by terraform validate: + /// + /// + /// + /// + [CakeMethodAlias] + [CakeAliasCategory(IssuesAliasConstants.IssueProviderCakeAliasCategory)] + public static IIssueProvider TerraformIssuesFromFilePath( + this ICakeContext context, + FilePath validateOutputFilePath, + DirectoryPath terraformRootPath) + { + context.NotNull(nameof(context)); + validateOutputFilePath.NotNull(nameof(validateOutputFilePath)); + terraformRootPath.NotNull(nameof(terraformRootPath)); + + return context.TerraformIssues(new TerraformIssuesSettings(validateOutputFilePath, terraformRootPath)); + } + + /// + /// Gets an instance of a provider for reading output from terraform validate -json + /// for Terraform scripts in the repository root. + /// + /// The context. + /// Content of the terraform validate command. + /// Instance of a provider for warnings reported by terraform validate. + /// + /// Read warnings reported by terraform validate: + /// + /// + /// + /// + [CakeMethodAlias] + [CakeAliasCategory(IssuesAliasConstants.IssueProviderCakeAliasCategory)] + public static IIssueProvider TerraformIssuesFromContent( + this ICakeContext context, + string validateOutput) + { + context.NotNull(nameof(context)); + validateOutput.NotNullOrWhiteSpace(nameof(validateOutput)); + + return context.TerraformIssues(new TerraformIssuesSettings(validateOutput.ToByteArray(), "/")); + } + + /// + /// Gets an instance of a provider for reading output from terraform validate -json. + /// + /// The context. + /// Content of the terraform validate command. + /// Path to the directory of the Terraform scripts. + /// Either the full path or the path relative to the repository root. + /// Instance of a provider for warnings reported by terraform validate. + /// + /// Read warnings reported by terraform validate: + /// + /// + /// + /// + [CakeMethodAlias] + [CakeAliasCategory(IssuesAliasConstants.IssueProviderCakeAliasCategory)] + public static IIssueProvider TerraformIssuesFromContent( + this ICakeContext context, + string validateOutput, + DirectoryPath terraformRootPath) + { + context.NotNull(nameof(context)); + validateOutput.NotNullOrWhiteSpace(nameof(validateOutput)); + terraformRootPath.NotNull(nameof(terraformRootPath)); + + return context.TerraformIssues(new TerraformIssuesSettings(validateOutput.ToByteArray(), terraformRootPath)); + } + + /// + /// Gets an instance of a provider for reading output from terraform validate -json using specified settings. + /// + /// The context. + /// Settings for reading the issues. + /// Instance of a provider for warnings reported by terraform validate. + /// + /// Read warnings reported by terraform validate: + /// + /// + /// + /// + [CakeMethodAlias] + [CakeAliasCategory(IssuesAliasConstants.IssueProviderCakeAliasCategory)] + public static IIssueProvider TerraformIssues( + this ICakeContext context, + TerraformIssuesSettings settings) + { + context.NotNull(nameof(context)); + settings.NotNull(nameof(settings)); + + return new TerraformIssuesProvider(context.Log, settings); + } + } +} diff --git a/src/Cake.Issues.Terraform/TerraformIssuesProvider.cs b/src/Cake.Issues.Terraform/TerraformIssuesProvider.cs new file mode 100644 index 0000000..f8c78ef --- /dev/null +++ b/src/Cake.Issues.Terraform/TerraformIssuesProvider.cs @@ -0,0 +1,155 @@ +namespace Cake.Issues.Terraform +{ + using System.Collections.Generic; + using System.IO; + using System.Linq; + using System.Runtime.Serialization.Json; + using System.Text; + using Cake.Core.Diagnostics; + using Cake.Core.IO; + + /// + /// Provider for warnings reported by Terraform. + /// + internal class TerraformIssuesProvider : BaseConfigurableIssueProvider + { + /// + /// Initializes a new instance of the class. + /// + /// The Cake log context. + /// Settings for the issue provider. + public TerraformIssuesProvider(ICakeLog log, TerraformIssuesSettings issueProviderSettings) + : base(log, issueProviderSettings) + { + } + + /// + /// Gets the name of the Terraform issue provider. + /// This name can be used to identify issues based on the property. + /// + public static string ProviderTypeName => typeof(TerraformIssuesProvider).FullName; + + /// + public override string ProviderName => "Terraform"; + + /// + protected override IEnumerable InternalReadIssues() + { + // Determine path of the doc root. + var terraformRootPath = this.IssueProviderSettings.TerraformRootPath; + if (terraformRootPath.IsRelative) + { + terraformRootPath = terraformRootPath.MakeAbsolute(this.Settings.RepositoryRoot); + } + + ValidateFile validateFile = null; + + var logFileContent = this.IssueProviderSettings.LogFileContent.ToStringUsingEncoding(true); + + using (var ms = new MemoryStream(Encoding.UTF8.GetBytes(logFileContent))) + { + var jsonSerializer = new DataContractJsonSerializer(typeof(ValidateFile)); + validateFile = jsonSerializer.ReadObject(ms) as ValidateFile; + } + + return + from diagnostic in validateFile.diagnostics + select + IssueBuilder + .NewIssue(GetMessage(diagnostic.summary, diagnostic.detail), this) + .InFile( + this.TryGetFile(diagnostic.range?.filename, terraformRootPath), + diagnostic.range?.start?.line, + diagnostic.range?.end?.line, + diagnostic.range?.start?.column, + diagnostic.range?.end?.column) + .OfRule(GetRule(diagnostic.summary, diagnostic.detail)) + .WithPriority(GetPriority(diagnostic.severity)) + .Create(); + } + + /// + /// Returns the message for an issue based on summary and detail. + /// + /// Summary of the diagnostic entry. + /// Detail of the diagnostic entry. + /// Issue message. + private static string GetMessage(string summary, string detail) + { + // If a diagnostic entry only contains a summary we use it for message instead of rule. + if (string.IsNullOrWhiteSpace(detail)) + { + return summary; + } + + return detail; + } + + /// + /// Returns the rule for an issue based on summary and detail. + /// + /// Summary of the diagnostic entry. + /// Detail of the diagnostic entry. + /// Issue message. + private static string GetRule(string summary, string detail) + { + // If a diagnostic entry only contains a summary we don't use it for rule as it is already used for message. + if (string.IsNullOrWhiteSpace(detail)) + { + return null; + } + + return summary; + } + + /// + /// Converts the severity to a priority. + /// + /// Severity as reported by Terraform. + /// Priority. + private static IssuePriority GetPriority(string severity) + { + switch (severity.ToLower()) + { + case "error": + return IssuePriority.Error; + + case "warning": + return IssuePriority.Warning; + + default: + return IssuePriority.Undefined; + } + } + + /// + /// Reads the affected file path from a issue logged by terraform validate. + /// + /// The file name in the current log entry. + /// Absolute path to the root directory of the Terraform scripts. + /// The full path to the affected file. + private string TryGetFile( + string fileName, + DirectoryPath terraformRootPath) + { + if (string.IsNullOrWhiteSpace(fileName)) + { + return null; + } + + // Add path to repository root + fileName = terraformRootPath.CombineWithFilePath(fileName).FullPath; + + // Make path relative to repository root. + fileName = fileName.Substring(this.Settings.RepositoryRoot.FullPath.Length); + + // Remove leading directory separator. + if (fileName.StartsWith("/")) + { + fileName = fileName.Substring(1); + } + + return fileName; + } + } +} \ No newline at end of file diff --git a/src/Cake.Issues.Terraform/TerraformIssuesSettings.cs b/src/Cake.Issues.Terraform/TerraformIssuesSettings.cs new file mode 100644 index 0000000..219897b --- /dev/null +++ b/src/Cake.Issues.Terraform/TerraformIssuesSettings.cs @@ -0,0 +1,44 @@ +namespace Cake.Issues.Terraform +{ + using Cake.Core.IO; + + /// + /// Settings for . + /// + public class TerraformIssuesSettings : IssueProviderSettings + { + /// + /// Initializes a new instance of the class. + /// + /// Path to the the Terraform output file. + /// Path to the directory of the Terraform scripts. + /// Either the full path or the path relative to the repository root. + public TerraformIssuesSettings(FilePath validateOutputFilePath, DirectoryPath terraformRootPath) + : base(validateOutputFilePath) + { + terraformRootPath.NotNull(nameof(terraformRootPath)); + + this.TerraformRootPath = terraformRootPath; + } + + /// + /// Initializes a new instance of the class. + /// + /// Output of the Terraform validate command. + /// Path to the directory of the Terraform scripts. + /// Either the full path or the path relative to the repository root. + public TerraformIssuesSettings(byte[] validateOutput, DirectoryPath terraformRootPath) + : base(validateOutput) + { + terraformRootPath.NotNull(nameof(terraformRootPath)); + + this.TerraformRootPath = terraformRootPath; + } + + /// + /// Gets the path to the directory of the Terraform scripts. + /// Either the full path or the path relative to the repository root. + /// + public DirectoryPath TerraformRootPath { get; private set; } + } +} diff --git a/src/Cake.Issues.Terraform/ValidateOutputDataContract.cs b/src/Cake.Issues.Terraform/ValidateOutputDataContract.cs new file mode 100644 index 0000000..c7b8763 --- /dev/null +++ b/src/Cake.Issues.Terraform/ValidateOutputDataContract.cs @@ -0,0 +1,73 @@ +namespace Cake.Issues.Terraform +{ + using System.Runtime.Serialization; + +#pragma warning disable SA1310 // Field names must not contain underscore +#pragma warning disable SA1401 // Fields must be private +#pragma warning disable SA1307 // Accessible fields must begin with upper-case letter +#pragma warning disable SA1402 // File may only contain a single class +#pragma warning disable SA1600 // Elements must be documented +#pragma warning disable SA1649 // File name must match first type name + + [DataContract] + internal class ValidateFile + { + [DataMember] + public bool valid; + + [DataMember] + public int error_count; + + [DataMember] + public int warning_count; + + [DataMember] + public Diagnostic[] diagnostics; + } + + [DataContract] + internal class Diagnostic + { + [DataMember] + public string severity; + + [DataMember] + public string summary; + + [DataMember] + public string detail; + + [DataMember] + public Range range; + } + + [DataContract] + internal class Range + { + [DataMember] + public string filename; + + [DataMember] + public Location start; + + [DataMember] + public Location end; + } + + [DataContract] + internal class Location + { + [DataMember] + public int line; + + [DataMember] + public int column; + } + +#pragma warning restore SA1310 // Field names must not contain underscore +#pragma warning restore SA1401 // Fields must be private +#pragma warning restore SA1307 // Accessible fields must begin with upper-case letter +#pragma warning restore SA1402 // File may only contain a single class +#pragma warning restore SA1600 // Elements must be documented +#pragma warning restore SA1649 // File name must match first type name +} \ No newline at end of file diff --git a/tools/packages.config b/tools/packages.config new file mode 100644 index 0000000..5ab376a --- /dev/null +++ b/tools/packages.config @@ -0,0 +1,4 @@ + + + +