A new build, using GitHub Actions

Merge pull request #107 from PoshCode/jaykul/wip

Author: Jaykul

.editorconfig

@@ -1,13 +1,13 @@
 # EditorConfig is awesome: http://EditorConfig.org
-#
-# Settings follow https://github.com/PowerShell/PowerShellEditorServices/blob/master/.editorconfig
-
-# top-most EditorConfig file
-root = true
 
 [*]
 indent_style = space
 insert_final_newline = true
+end_of_line = crlf
+
+[*.{ps1,psm1,psd1}]
+indent_size = 4
+trim_trailing_whitespace = true
 
 [*.{cs}]
 indent_size = 4
@@ -17,9 +17,5 @@ trim_trailing_whitespace = true
 indent_size = 2
 trim_trailing_whitespace = true
 
-[*.{ps1,psm1,psd1}]
-indent_size = 4
-trim_trailing_whitespace = true
-
 [*.{ps1xml,props,xml,yaml,yml}]
 indent_size = 2

.github/workflows/build.yml

@@ -0,0 +1,77 @@
+name: Build on push
+on: [push]
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: GitVersion
+      id: gitversion
+      uses: PoshCode/Actions/gitversion@v1
+    - name: Install-RequiredModules
+      uses: PoshCode/Actions/install-requiredmodules@v1
+    - name: Build Module
+      id: build
+      uses: PoshCode/actions/build-module@v1
+      with:
+        path: ${{github.workspace}}/Source
+        version: ${{ steps.gitversion.outputs.LegacySemVerPadded }}
+        destination: ${{github.workspace}}/output
+    - name: Upload Build Output
+      uses: actions/upload-artifact@v2
+      with:
+        name: Modules
+        path: ${{github.workspace}}/output
+    - name: Upload Tests
+      uses: actions/upload-artifact@v2
+      with:
+        name: PesterTests
+        path: ${{github.workspace}}/Tests
+    - name: Upload RequiredModules.psd1
+      uses: actions/upload-artifact@v2
+      with:
+        name: RequiredModules
+        path: ${{github.workspace}}/RequiredModules.psd1
+    - name: Upload PSScriptAnalyzerSettings.psd1
+      uses: actions/upload-artifact@v2
+      with:
+        name: ScriptAnalyzer
+        path: ${{github.workspace}}/PSScriptAnalyzerSettings.psd1
+  lint:
+    needs: build
+    name: Run PSScriptAnalyzer
+    runs-on: ubuntu-latest
+    steps:
+    - name: Download Build Output
+      uses: actions/download-artifact@v2
+    - name: Invoke-ScriptAnalyzer
+      uses: devblackops/github-action-psscriptanalyzer@master
+      with:
+        rootPath: Modules/ModuleBuilder
+        repoToken: ${{ secrets.GITHUB_TOKEN }}
+  test:
+    needs: build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-2016, windows-latest, ubuntu-latest, macos-latest]
+    steps:
+    - name: Download Build Output
+      uses: actions/download-artifact@v2
+    - uses: PoshCode/Actions/install-requiredmodules@v1
+    - uses: PoshCode/Actions/pester@v1
+      with:
+        codeCoveragePath: Modules/ModuleBuilder
+        moduleUnderTest: ModuleBuilder
+        additionalModulePaths: ${{github.workspace}}/Modules
+    - name: Publish Test Results
+      uses: zyborg/dotnet-tests-report@v1
+      with:
+        test_results_path: results.xml
+    - name: Upload Results
+      uses: actions/upload-artifact@v2
+      with:
+        name: Pester Results
+        path: ${{github.workspace}}/*.xml

.vscode/settings.json

@@ -7,6 +7,10 @@
     "powershell.codeFormatting.preset": "OTBS",
     "powershell.codeFormatting.ignoreOneLineBlock": false,
     "powershell.codeFormatting.newLineAfterCloseBrace": false,
+    "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
+    "powershell.codeFormatting.alignPropertyValuePairs": true,
+    "powershell.codeFormatting.autoCorrectAliases": true,
+    "powershell.codeFormatting.useCorrectCasing": true,
     "files.associations": {
         "*.ps1xml": "xml"
     }

RequiredModules.psd1

@@ -2,7 +2,7 @@
 @{
     "Configuration"    = "[1.3.1,2.0)"
     "ModuleBuilder"    = "1.*"
-    "Pester"           = "[4.5.0,5.0)"
+    "Pester"           = "[4.10.1,5.0)"
     "PowerShellGet"    = "2.0.4"
     "PSScriptAnalyzer" = "1.*"
 }

Source/ModuleBuilder.psd1

@@ -1,13 +1,13 @@
 @{
     # The module version should be SemVer.org compatible
-    ModuleVersion          = "1.1.0"
+    ModuleVersion          = "0.0.0"
 
     # PrivateData is where all third-party metadata goes
     PrivateData            = @{
         # PrivateData.PSData is the PowerShell Gallery data
         PSData             = @{
             # Prerelease string should be here, so we can set it
-            Prerelease     = 'beta'
+            Prerelease     = 'source'
 
             # Release Notes have to be here, so we can update them
             ReleaseNotes   = '

Source/ModuleBuilder.psm1

@@ -0,0 +1,3 @@
+foreach ($file in Get-ChildItem "Private", "Public") {
+    . $file.FullName
+}

Source/Private/GetBuildInfo.ps1

@@ -65,10 +65,13 @@ function GetBuildInfo {
     }
     # BuildInfo.SourcePath should point to a module manifest
     if ($BuildInfo.SourcePath -and $BuildInfo.SourcePath -ne $BuildManifest) {
+        Write-Debug "  Updating: SourcePath"
+        Write-Debug "    To: $($BuildInfo.SourcePath)"
         $ParameterValues["SourcePath"] = $BuildInfo.SourcePath
     }
     # If SourcePath point to build.psd1, we should clear it
     if ($ParameterValues["SourcePath"] -eq $BuildManifest) {
+        Write-Debug "  Removing: SourcePath"
         $ParameterValues.Remove("SourcePath")
     }
     Write-Debug "Finished parsing Build Manifest $BuildManifest"
@@ -80,25 +83,31 @@ function GetBuildInfo {
     }
 
     if ((-not $BuildInfo.SourcePath) -and $ParameterValues["SourcePath"] -notmatch '\.psd1') {
+        Write-Debug "  Searching: SourcePath"
         # Find a module manifest (or maybe several)
         $ModuleInfo = Get-ChildItem $BuildManifestParent -Recurse -Filter *.psd1 -ErrorAction SilentlyContinue |
             ImportModuleManifest -ErrorAction SilentlyContinue
         # If we found more than one module info, the only way we have of picking just one is if it matches a folder name
         if (@($ModuleInfo).Count -gt 1) {
-            # Resolve Build Manifest's parent folder to find the Absolute path
-            $ModuleName = Split-Path -Leaf $BuildManifestParent
-            # If we're in a "well known" source folder, look higher for a name
-            if ($ModuleName -in 'Source', 'src') {
-                $ModuleName = Split-Path (Split-Path -Parent $BuildManifestParent) -Leaf
+            Write-Debug (@(@("  Found $(@($ModuleInfo).Count):") + @($ModuleInfo.Path)) -join "`n            ")
+            # It can't be a module that needs building unless it has either:
+            $ModuleInfo = $ModuleInfo.Where{
+                $Root = Split-Path $_.Path
+                @(
+                    # - A build.psd1 next to it
+                    Test-Path (Join-Path $Root "build.ps1") -PathType Leaf
+                    # - A Public (or Private) folder with source scripts in it
+                    Test-Path (Join-Path $Root "Public") -PathType Container
+                    Test-Path (Join-Path $Root "Private") -PathType Container
+                ) -contains $true
             }
-            $ModuleInfo = @($ModuleInfo).Where{ $_.Name -eq $ModuleName }
+            Write-Debug (@(@("  Filtered $(@($ModuleInfo).Count):") + @($ModuleInfo.Path)) -join "`n            ")
         }
         if (@($ModuleInfo).Count -eq 1) {
             Write-Debug "Updating BuildInfo SourcePath to $($ModuleInfo.Path)"
             $ParameterValues["SourcePath"] = $ModuleInfo.Path
-        }
-        if (-Not $ModuleInfo) {
-            throw "Can't find a module manifest in $BuildManifestParent"
+        } else {
+            throw "Can't determine the module manifest in $BuildManifestParent"
         }
     }
 

Source/Private/MoveUsingStatements.ps1

@@ -8,12 +8,6 @@ function MoveUsingStatements {
 
             This function uses AST to comment out those statements (to preserver line numbering)
             and insert them (conserving order) at the top of the script.
-
-            Should the merged RootModule already have errors not related to the Using statements,
-            or no errors caused by misplaced Using statements, this steps is skipped.
-
-            If moving (comment & copy) the Using statements introduce parsing errors to the script,
-            those changes won't be applied to the file.
     #>
     [CmdletBinding()]
     param(
@@ -52,15 +46,14 @@ function MoveUsingStatements {
         # Edit the Script content by commenting out existing statements (conserving line numbering)
         $ScriptText = $AST.Extent.Text
         $InsertedCharOffset = 0
-        $StatementsToCopy = New-Object System.Collections.ArrayList
+        $StatementsToCopy = [System.Collections.Generic.HashSet[string]]::new([StringComparer]::OrdinalIgnoreCase)
+
         foreach ($UsingSatement in $UsingStatementExtents) {
             $ScriptText = $ScriptText.Insert($UsingSatement.StartOffset + $InsertedCharOffset, '#')
             $InsertedCharOffset++
 
             # Keep track of unique statements we'll need to insert at the top
-            if (!$StatementsToCopy.Contains($UsingSatement.Text)) {
-                $null = $StatementsToCopy.Add($UsingSatement.Text)
-            }
+            $null = $StatementsToCopy.Add($UsingSatement.Text)
         }
 
         $ScriptText = $ScriptText.Insert(0, ($StatementsToCopy -join "`r`n") + "`r`n")

Source/Public/Convert-Breakpoint.ps1

@@ -0,0 +1,35 @@
+function Convert-Breakpoint {
+    <#
+        .SYNOPSIS
+            Convert any breakpoints on source files to module files and vice-versa
+    #>
+    [CmdletBinding(DefaultParameterSetName="All")]
+    param(
+        [Parameter(ParameterSetName="Module")]
+        [switch]$ModuleOnly,
+        [Parameter(ParameterSetName="Source")]
+        [switch]$SourceOnly
+    )
+
+    if (!$SourceOnly) {
+        foreach ($ModuleBreakPoint in Get-PSBreakpoint | ConvertFrom-SourceLineNumber) {
+            Set-PSBreakpoint -Script $ModuleBreakPoint.Script -Line $ModuleBreakPoint.Line
+            if ($ModuleOnly) {
+                # TODO: | Remove-PSBreakpoint
+            }
+        }
+    }
+
+    if (!$ModuleOnly) {
+        foreach ($SourceBreakPoint in Get-PSBreakpoint | ConvertTo-SourceLineNumber) {
+            if (!(Test-Path $SourceBreakPoint.SourceFile)) {
+                Write-Warning "Can't find source path: $($SourceBreakPoint.SourceFile)"
+            } else {
+                Set-PSBreakpoint -Script $SourceBreakPoint.SourceFile -Line $SourceBreakPoint.SourceLineNumber
+            }
+            if ($SourceOnly) {
+                # TODO: | Remove-PSBreakpoint
+            }
+        }
+    }
+}

Source/Public/ConvertFrom-SourceLineNumber.ps1

@@ -0,0 +1,74 @@
+function ConvertFrom-SourceLineNumber {
+    <#
+        .SYNOPSIS
+            Convert a source file path and line number to the line number in the built output
+        .EXAMPLE
+            ConvertFrom-SourceLineNumber -Module ~\2.0.0\ModuleBuilder.psm1 -SourceFile ~\Source\Public\Build-Module.ps1 -Line 27
+    #>
+    [CmdletBinding(DefaultParameterSetName="FromString")]
+    param(
+        # The SourceFile is the source script file that was built into the module
+        [Parameter(Mandatory, ValueFromPipelineByPropertyName, Position=0)]
+        [Alias("PSCommandPath", "File", "ScriptName", "Script")]
+        [string]$SourceFile,
+
+        # The SourceLineNumber (from an InvocationInfo) is the line number in the source file
+        [Parameter(Mandatory, ValueFromPipelineByPropertyName, Position=1)]
+        [Alias("LineNumber", "Line", "ScriptLineNumber")]
+        [int]$SourceLineNumber,
+
+        # The name of the module in memory, or the full path to the module psm1
+        [Parameter()]
+        [string]$Module
+    )
+    begin {
+        $filemap = @{}
+    }
+    process {
+        if (!$Module) {
+            $Command = [IO.Path]::GetFileNameWithoutExtension($SourceFile)
+            $Module = (Get-Command $Command -ErrorAction SilentlyContinue).Source
+            if (!$Module) {
+                Write-Warning "Please specify -Module for breakpoint ${SourceFile}: $SourceLineNumber"
+                return
+            }
+        }
+        if ($Module -and -not (Test-Path $Module)) {
+            $Module = (Get-Module $Module -ErrorAction Stop).Path
+        }
+        # Push-Location (Split-Path $SourceFile)
+        try {
+            if (!$filemap.ContainsKey($Module)) {
+                # Note: the new pattern is #Region but the old one was # BEGIN
+                $regions = Select-String '^(?:#Region|# BEGIN) (?<SourceFile>.*) (?<LineNumber>\d+)?$' -Path $Module
+                $filemap[$Module] = @($regions.ForEach{
+                    [PSCustomObject]@{
+                        PSTypeName = "BuildSourceMapping"
+                        SourceFile = $_.Matches[0].Groups["SourceFile"].Value.Trim("'")
+                        StartLineNumber = $_.LineNumber
+                    }
+                })
+            }
+
+            $hit = $filemap[$Module]
+
+            if ($Source = $hit.Where{ $SourceFile.EndsWith($_.SourceFile.TrimStart(".\")) }) {
+                [PSCustomObject]@{
+                    PSTypeName = "OutputLocation"
+                    Script     = $Module
+                    Line       = $Source.StartLineNumber + $SourceLineNumber
+                }
+            } elseif($Source -eq $Module) {
+                [PSCustomObject]@{
+                    PSTypeName = "OutputLocation"
+                    Script     = $Module
+                    Line       = $SourceLineNumber
+                }
+            } else {
+                Write-Warning "'$SourceFile' not found in $Module"
+            }
+        } finally {
+            Pop-Location
+        }
+    }
+}