functions/invoke-d365modulecompile.ps1


<#
    .SYNOPSIS
        Compile a package / module / model
         
    .DESCRIPTION
        Compile a package / module / model using the builtin "xppc.exe" executable to compile source code
         
    .PARAMETER Module
        The package to compile
         
    .PARAMETER OutputDir
        The path to the folder to save generated artifacts
         
    .PARAMETER LogPath
        Path where you want to store the log outputs generated from the compiler
         
        Also used as the path where the log file(s) will be saved
         
        When running without the ShowOriginalProgress parameter, the log files will be the standard output and the error output from the underlying tool executed
         
    .PARAMETER MetaDataDir
        The path to the meta data directory for the environment
         
        Default path is the same as the aos service PackagesLocalDirectory
         
    .PARAMETER ReferenceDir
        The full path of a folder containing all assemblies referenced from X++ code
         
        Default path is the same as the aos service PackagesLocalDirectory
         
    .PARAMETER BinDir
        The path to the bin directory for the environment
         
        Default path is the same as the aos service PackagesLocalDirectory\bin
         
    .PARAMETER XRefSqlServer
        The name of the SQL server where the cross references database is located; the default is "$env:COMPUTERNAME"
        This parameter is only used for XRefGenerationOnly
         
    .PARAMETER XRefDbName
        The name of the cross references database; the default is "DYNAMICSXREFDB"
        This parameter is only used for XRefGenerationOnly
         
    .PARAMETER XRefGeneration
        Instruct the cmdlet to enable the generation of XRef metadata while running the compile
         
    .PARAMETER XRefGenerationOnly
        Instruct the cmdlet to only generate XRef metadata while running the compile and not update the assemblies and PDB files
         
    .PARAMETER ShowOriginalProgress
        Instruct the cmdlet to show the standard output in the console
         
        Default is $false which will silence the standard output
         
    .PARAMETER OutputCommandOnly
        Instruct the cmdlet to only output the command that you would have to execute by hand
         
        Will include full path to the executable and the needed parameters based on your selection
         
    .EXAMPLE
        PS C:\> Invoke-D365ModuleCompile -Module MyModel
         
        This will use the default paths and start the xppc.exe with the needed parameters to compile MyModel package.
        The default output from the compile will be silenced.
         
        If an error should occur, both the standard output and error output will be written to the console / host.
         
    .EXAMPLE
        PS C:\> Invoke-D365ModuleCompile -Module MyModel -ShowOriginalProgress
         
        This will use the default paths and start the xppc.exe with the needed parameters to compile MyModel package.
        The output from the compile will be written to the console / host.
         
    .EXAMPLE
        PS C:\> Invoke-D365ModuleCompile -Module MyModel -XRefGeneration
         
        This will use the default paths and start the xppc.exe with the needed parameters to compile MyModel package.
        The default output from the compile will be silenced.
        The compiler will generate XRef metadata while compiling.
         
        If an error should occur, both the standard output and error output will be written to the console / host.
         
    .EXAMPLE
        PS C:\> Invoke-D365ModuleCompile -Module MyModel -XRefGenerationOnly
         
        This will use the default paths and start the xppc.exe with the needed parameters to only generate cross references for the MyModel package.
         
    .EXAMPLE
        PS C:\> Get-D365Module -ExcludeBinaryModules -InDependencyOrder | Invoke-D365ModuleCompile -XRefGenerationOnly -ShowOriginalProgress
         
        This will update all cross references, keeping the assemblies and PDB files unmodified.
        The output from the compile will be written to the console / host.
         
    .NOTES
        Tags: Compile, Model, Servicing, X++
         
        Author: Ievgen Miroshnikov (@IevgenMir)
         
        Author: Mötz Jensen (@Splaxi)
         
        Author: Frank Hüther (@FrankHuether)
#>


function Invoke-D365ModuleCompile {
    [CmdletBinding()]
    [OutputType('[PsCustomObject]')]
    param (
        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
        [Alias("ModuleName")]
        [string] $Module,

        [Alias('Output')]
        [string] $OutputDir = $Script:MetaDataDir,

        [Alias('LogDir')]
        [string] $LogPath = $(Join-Path -Path $Script:DefaultTempPath -ChildPath "Logs\ModuleCompile"),

        [string] $MetaDataDir = $Script:MetaDataDir,

        [string] $ReferenceDir = $Script:MetaDataDir,

        [string] $BinDir = $Script:BinDirTools,

        [string] $XRefSqlServer = $env:COMPUTERNAME,

        [string] $XRefDbName = "DYNAMICSXREFDB",

        [switch] $XRefGeneration,

        [switch] $XRefGenerationOnly,

        [switch] $ShowOriginalProgress,

        [switch] $OutputCommandOnly
    )

    begin {
        Invoke-TimeSignal -Start

        $tool = "xppc.exe"
        $executable = Join-Path -Path $BinDir -ChildPath $tool

        if (-not (Test-PathExists -Path $MetaDataDir, $BinDir -Type Container)) { return }
        if (-not (Test-PathExists -Path $executable -Type Leaf)) { return }
        if (-not (Test-PathExists -Path $LogPath -Type Container -Create)) { return }

    }

    process {
        $logDirModule = Join-Path -Path $LogPath -ChildPath $Module
        $outputDirModule = Join-Path -Path $OutputDir -ChildPath $Module
        
        if (-not (Test-PathExists -Path $logDirModule -Type Container -Create)) { return }

        if (Test-PSFFunctionInterrupt) { return }
        
        $logFile = Join-Path -Path $logDirModule -ChildPath "Dynamics.AX.$Module.xppc.log"
        $logXmlFile = Join-Path -Path $logDirModule -ChildPath "Dynamics.AX.$Module.xppc.xml"

        $params = @("-metadata=`"$MetaDataDir`"",
            "-modelmodule=`"$Module`"",
            "-output=`"$outputDirModule\bin`"",
            "-referencefolder=`"$ReferenceDir`"",
            "-log=`"$logFile`"",
            "-xmlLog=`"$logXmlFile`"",
            "-verbose"
        )

        if ($XRefGenerationOnly) {
            $params += @("-xrefonly",
                "-xrefSqlServer=`"$XRefSqlServer`"",
                "-xrefDbName=`"$XRefDbName`""
            )
        }
        elseif ($XRefGeneration) {
            $params += "-xref"
        }

        Invoke-Process -Executable $executable -Params $params -ShowOriginalProgress:$ShowOriginalProgress -OutputCommandOnly:$OutputCommandOnly -LogPath $logDirModule

        if ($OutputCommandOnly) { return }

        [PSCustomObject]@{
            LogFile    = $logFile
            XmlLogFile = $logXmlFile
            PSTypeName = 'D365FO.TOOLS.ModuleCompileOutput'
        }
    
    }

    end {
        Invoke-TimeSignal -End
    }
}