Skip to content

Instantly share code, notes, and snippets.

@punker76
Created January 21, 2021 09:40
Show Gist options
  • Save punker76/3ce10bcee4a0ac72c082ff3527501634 to your computer and use it in GitHub Desktop.
Save punker76/3ce10bcee4a0ac72c082ff3527501634 to your computer and use it in GitHub Desktop.
Build Delphi projects with Cake
///////////////////////////////////////////////////////////////////////////////
// TOOLS / ADDINS
///////////////////////////////////////////////////////////////////////////////
#tool "nuget:?package=GitVersion.CommandLine&version=5.6.3"
#addin "nuget:?package=Cake.Figlet&version=1.3.1"
#addin "nuget:?package=Cake.Incubator&version=5.1.0"
#addin "nuget:?package=Cake.FileHelpers&version=3.3.0"
///////////////////////////////////////////////////////////////////////////////
// ARGUMENTS
///////////////////////////////////////////////////////////////////////////////
var target = Argument("target", "Default");
var configuration = Argument("configuration", "Release");
var verbosity = Argument("verbosity", Verbosity.Minimal);
var projectName = Argument("ProjectName", "");
var companyName = Argument("CompanyName", "");
var productName = Argument("ProductName", "");
var setupFile = Argument("SetupFile", $"./Setups/{projectName}.iss");
var compilerDefines = Argument("DCC_Define", "");
var bdsVersion = Argument("BDS", "20.0");
var madExceptPatch = Argument("madExceptPatch", @"c:\_COMPILE_TOOLS\madCollection\madExcept\Tools\madExceptPatch.exe");
var innoSetup = Argument("InnoSetup", @"c:\_COMPILE_TOOLS\InnoSetup_v5.6.1\ISCC.exe");
///////////////////////////////////////////////////////////////////////////////
// PREPARATION
///////////////////////////////////////////////////////////////////////////////
var isLocal = BuildSystem.IsLocalBuild;
// Set build version
if (isLocal == false || verbosity == Verbosity.Verbose)
{
GitVersion(new GitVersionSettings { OutputType = GitVersionOutput.BuildServer });
}
var gitVersion = GitVersion(new GitVersionSettings { OutputType = GitVersionOutput.Json });
var branchName = gitVersion.BranchName;
var ProductVersion = $"{gitVersion.Major}.{gitVersion.Minor}";
///////////////////////////////////////////////////////////////////////////////
// SETUP / TEARDOWN
///////////////////////////////////////////////////////////////////////////////
Setup(ctx =>
{
Information(Figlet(productName));
Environment.SetEnvironmentVariable("BDS", @$"C:\Program Files (x86)\Embarcadero\Studio\{bdsVersion}", EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable("BDSINCLUDE", @$"C:\Program Files (x86)\Embarcadero\Studio\{bdsVersion}\include", EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable("BDSCOMMONDIR", @$"C:\Users\Public\Documents\Embarcadero\Studio\{bdsVersion}", EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable("FrameworkDir", @"C:\Windows\Microsoft.NET\Framework\v4.0.30319", EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable("FrameworkSDKDir", "", EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable("FrameworkVersion", "v4.5", EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable("LANGDIR", "EN", EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable("PATH", @$"%FrameworkDir%;%FrameworkSDKDir%;C:\Program Files (x86)\Embarcadero\Studio\{bdsVersion}\bin;C:\Program Files (x86)\Embarcadero\Studio\{bdsVersion}\bin64;C:\Program Files (x86)\Embarcadero\Studio\{bdsVersion}\cmake;C:\Users\Public\Documents\Embarcadero\InterBase\redist\InterBase2017\IDE_spoof;%PATH%", EnvironmentVariableTarget.Process);
if (TeamCity.IsRunningOnTeamCity)
{
Environment.SetEnvironmentVariable("APPDATA", @"c:\Users\Administrator\AppData\Roaming\", EnvironmentVariableTarget.Process);
}
Information("Project : {0}", projectName);
Information("Add. DCC_Define : {0}", compilerDefines);
Information("Informational Version: {0}", gitVersion.InformationalVersion);
Information("SemVer Version: {0}", gitVersion.SemVer);
Information("AssemblySemVer Version: {0}", gitVersion.AssemblySemVer);
Information("MajorMinorPatch Version: {0}", gitVersion.MajorMinorPatch);
Information("NuGet Version: {0}", gitVersion.NuGetVersion);
Information("IsLocalBuild : {0}", isLocal);
Information("Branch : {0}", branchName);
Information("Configuration : {0}", configuration);
Information("Verbosity : {0}", verbosity);
if (!FileExists(madExceptPatch))
{
Information($"Could not resolve madExceptPatch at {madExceptPatch}.");
}
});
TaskSetup(setupContext =>
{
if (TeamCity.IsRunningOnTeamCity)
{
TeamCity.WriteStartBuildBlock(setupContext.Task.Description ?? setupContext.Task.Name);
TeamCity.WriteStartProgress(setupContext.Task.Description ?? setupContext.Task.Name);
}
});
TaskTeardown(teardownContext =>
{
if (TeamCity.IsRunningOnTeamCity)
{
TeamCity.WriteEndProgress(teardownContext.Task.Description ?? teardownContext.Task.Name);
TeamCity.WriteEndBuildBlock(teardownContext.Task.Description ?? teardownContext.Task.Name);
}
});
///////////////////////////////////////////////////////////////////////////////
// TASKS
///////////////////////////////////////////////////////////////////////////////
Task("Clean")
.ContinueOnError()
.Does(() =>
{
var directoriesToDelete = GetDirectories("./Projects/**/dcu");
DeleteDirectories(directoriesToDelete, new DeleteDirectorySettings { Recursive = true, Force = true });
});
Task("CreateVersionInfo")
.Does(() =>
{
var projectFiles = GetFiles("./Projects/*.dproj");
foreach(var file in projectFiles)
{
Information($"Create version info for: {file}");
CreateVersionInfo(MakeAbsolute(file).FullPath, "");
CreateVersion(MakeAbsolute(file).FullPath);
}
});
Task("BuildAll")
.Does(() =>
{
if (!string.IsNullOrEmpty(compilerDefines))
{
Environment.SetEnvironmentVariable("DCC_Define", $"{compilerDefines}", EnvironmentVariableTarget.Process);
}
var projectFiles = GetFiles("./Projects/*.dproj");
foreach(var file in projectFiles)
{
Information($"Build {file}");
BuildProject(MakeAbsolute(file).FullPath);
PatchProject(MakeAbsolute(file).FullPath);
}
});
Task("CreateSetups")
.WithCriteria(() => FileExists(setupFile))
.Does(() =>
{
var outputDirectory = MakeAbsolute(Directory("./bin/setup/"));
var source = MakeAbsolute(Directory("."));
EnsureDirectoryExists(outputDirectory);
var innoSettings = new InnoSetupSettings
{
Version = InnoSetupVersion.InnoSetup5,
QuietMode = InnoSetupQuietMode.QuietWithProgress,
OutputDirectory = outputDirectory,
Defines = new Dictionary<string, string>
{
{ "SourceDir", source.ToString() },
{ "ProjectName", projectName },
{ "ProductName", productName },
{ "ProjectVersion", ProductVersion },
{ "FileVerStr", gitVersion.MajorMinorPatch },
{ "SetupVerStr", gitVersion.FullSemVer },
{ "VersionInfoVersion", gitVersion.AssemblySemFileVer },
{ "VersionInfoTextVersion", gitVersion.InformationalVersion }
}
};
innoSettings.ToolPath =
innoSettings.ToolPath != null && FileExists(innoSettings.ToolPath)
? innoSettings.ToolPath
: MakeAbsolute(File(innoSetup));
if (!FileExists(innoSettings.ToolPath))
{
throw new Exception($"Could not resolve InnoSetup at {innoSetup}.");
}
InnoSetup(MakeAbsolute(File(setupFile)), innoSettings);
});
///////////////////////////////////////////////////////////////////////////////
// HELPER
///////////////////////////////////////////////////////////////////////////////
void CreateVersionInfo(string project, string fileDesc)
{
var projectFile = new FilePath(project);
var fileLines = new StringBuilder();
fileLines.AppendLine("// --------------------------------");
fileLines.AppendLine($"// VersionInfo for {projectFile.GetFilename()}");
fileLines.AppendLine("// --------------------------------");
fileLines.AppendLine("LANGUAGE LANG_GERMAN, SUBLANG_NEUTRAL");
fileLines.AppendLine("VS_VERSION_INFO VERSIONINFO");
fileLines.AppendLine($"FILEVERSION {gitVersion.AssemblySemFileVer.Replace(".", ", ")}");
fileLines.AppendLine($"PRODUCTVERSION {gitVersion.AssemblySemFileVer.Replace(".", ", ")}");
fileLines.AppendLine("FILEFLAGSMASK VS_FFI_FILEFLAGSMASK");
fileLines.AppendLine("FILEFLAGS (VS_FF_PRERELEASE | VS_FF_DEBUG)");
fileLines.AppendLine("FILEOS VOS__WINDOWS32");
fileLines.AppendLine("FILETYPE VFT_APP");
fileLines.AppendLine("BEGIN");
fileLines.AppendLine(" BLOCK \"VarFileInfo\"");
fileLines.AppendLine(" BEGIN");
fileLines.AppendLine(" VALUE \"TRANSLATION\", 0x0407, 1252");
fileLines.AppendLine(" END");
WriteStringFileInfoBlock(fileLines, "040704E4", fileDesc, projectFile.GetFilenameWithoutExtension().ToString()); // DE
WriteStringFileInfoBlock(fileLines, "040904E4", fileDesc, projectFile.GetFilenameWithoutExtension().ToString()); // EN
fileLines.AppendLine("END");
FileWriteText(projectFile.ChangeExtension(".vrc"), fileLines.ToString());
}
void WriteStringFileInfoBlock(StringBuilder fileLines, string blockInfo, string fileDesc, string fileName)
{
fileLines.AppendLine(" BLOCK \"StringFileInfo\"");
fileLines.AppendLine(" BEGIN");
fileLines.AppendLine($" BLOCK \"{blockInfo}\"");
fileLines.AppendLine(" BEGIN");
fileLines.AppendLine($" VALUE \"CompanyName\", {GetValue(companyName)}");
fileLines.AppendLine($" VALUE \"FileDescription\", {GetValue(fileDesc)}");
fileLines.AppendLine($" VALUE \"FileVersion\", {GetValue(gitVersion.AssemblySemFileVer)}");
fileLines.AppendLine($" VALUE \"InternalName\", {GetValue(projectName)}");
fileLines.AppendLine($" VALUE \"LegalCopyright\", {GetValue($"Copyright (C) {System.DateTime.Now.ToString("yyyy")} {companyName}")}");
fileLines.AppendLine($" VALUE \"OriginalFilename\", {GetValue($"{fileName}.exe")}");
fileLines.AppendLine($" VALUE \"ProductName\", {GetValue(productName)}");
fileLines.AppendLine($" VALUE \"ProductVersion\", {GetValue(ProductVersion)}");
fileLines.AppendLine($" VALUE \"Comments\", {GetValue(gitVersion.InformationalVersion)}");
fileLines.AppendLine(" END");
fileLines.AppendLine(" END");
}
string GetValue(string aValue)
{
return $"\"{aValue}\\0\"";
}
void CreateVersion(string project)
{
var projectFile = MakeAbsolute(new FilePath(project));
Information($"{Environment.NewLine}Create Version for {projectFile.GetFilename()}{Environment.NewLine}");
//brcc32 -fo"xyz.ver" "xyz.vrc"
var versionFile = projectFile.ChangeExtension(".ver");
var versionInfoFile = projectFile.ChangeExtension(".vrc");
var brcc = Directory(EnvironmentVariable("BDS")) + Directory("bin") + File("brcc32.exe");
ExecuteProcess(brcc,
new ProcessArgumentBuilder()
.AppendSwitchQuoted("-fo", versionFile.FullPath)
.AppendQuoted(versionInfoFile.FullPath));
}
void BuildProject(string project)
{
var projectFile = MakeAbsolute(new FilePath(project));
Information($"{Environment.NewLine}Build Project {projectFile.GetFilename()}{Environment.NewLine}");
MSBuild(project,
new MSBuildSettings
{
ToolPath = Directory(EnvironmentVariable("FrameworkDir")) + File("msbuild.exe"),
Verbosity = verbosity,
Configuration = configuration,
ArgumentCustomization = args => args.Append("/m").Append("/nr:false")
}
.SetMaxCpuCount(0)
.WithProperty("Config", configuration)
.WithTarget("Clean,Build")
);
}
void PatchProject(string project)
{
if (!FileExists(madExceptPatch))
{
return;
}
var projectFile = MakeAbsolute(new FilePath(project));
Information($"{Environment.NewLine}Patch Project {projectFile.GetFilename()}{Environment.NewLine}");
var fileName = projectFile.GetFilenameWithoutExtension().ToString();
var mesFile = projectFile.ChangeExtension(".mes");
var exeFile = MakeAbsolute(new FilePath($"./bin/{fileName}.exe"));
var mapFile = MakeAbsolute(new FilePath($"./bin/{fileName}.map"));
ExecuteProcess(madExceptPatch,
new ProcessArgumentBuilder()
.AppendQuoted(exeFile.FullPath)
.AppendQuoted(mesFile.FullPath)
.AppendQuoted(mapFile.FullPath));
}
void ExecuteProcess(FilePath fileName, ProcessArgumentBuilder arguments, bool executeInDirectory = false)
{
var processSettings = new ProcessSettings
{
RedirectStandardOutput = true,
RedirectStandardError = true,
Arguments = arguments
};
if (executeInDirectory)
{
processSettings.WorkingDirectory = fileName.GetDirectory();
}
using(var process = StartAndReturnProcess(fileName, processSettings))
{
process.WaitForExit();
if (process.GetStandardOutput().Any())
{
Information($"Output:{Environment.NewLine} {string.Join(Environment.NewLine, process.GetStandardOutput())}");
}
if (process.GetStandardError().Any())
{
Information($"Errors occurred:{Environment.NewLine} {string.Join(Environment.NewLine, process.GetStandardError())}");
}
// This should output 0 as valid arguments supplied
Information($"Exit code: {process.GetExitCode()}");
}
}
///////////////////////////////////////////////////////////////////////////////
// TASK TARGETS
///////////////////////////////////////////////////////////////////////////////
Task("Default")
.IsDependentOn("Clean")
.IsDependentOn("CreateVersionInfo")
.IsDependentOn("BuildAll")
.IsDependentOn("CreateSetups");
///////////////////////////////////////////////////////////////////////////////
// EXECUTION
///////////////////////////////////////////////////////////////////////////////
RunTarget(target);
##########################################################################
# This is the Cake bootstrapper script for PowerShell.
# This file was downloaded from https://github.com/cake-build/resources
# Feel free to change this file to fit your needs.
##########################################################################
<#
.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 = "build.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).
[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
# 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
}
Write-Verbose -Message "Restoring tools from NuGet..."
$NuGetOutput = Invoke-Expression "&`"$NUGET_EXE`" 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 "&`"$NUGET_EXE`" 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 "&`"$NUGET_EXE`" 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"
}
# Build Cake arguments
$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
# Start Cake
Write-Host "Running build script..."
& "$CAKE_EXE" ./build.cake --bootstrap
if ($LASTEXITCODE -eq 0)
{
& "$CAKE_EXE" $cakeArguments
}
exit $LASTEXITCODE
; This is the default configuration file for Cake.
; This file was downloaded from https://github.com/cake-build/resources
[Nuget]
Source=https://api.nuget.org/v3/index.json
UseInProcessClient=true
LoadDependencies=false
[Paths]
Tools=./tools
Addins=./tools/Addins
Modules=./tools/Modules
[Settings]
SkipVerification=false
SkipPackageVersionCheck=true
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment