Merge pull request #4266 from miterosan/CakeBuildImprovements

Improve the build script (and move to a better location)

.gitignore

@@ -11,8 +11,9 @@
 *.userprefs
 
 ### Cake ###
-tools/*
-!tools/cakebuild.csproj
+tools/**
+build/tools/**
+
 
 # Build results
 bin/[Dd]ebug/

.vscode/launch.json

@@ -68,6 +68,20 @@
                 }
             },
             "console": "internalConsole"
+        },
+        {
+            "name": "Cake: Debug Script",
+            "type": "coreclr",
+            "request": "launch",
+            "program": "${workspaceRoot}/build/tools/Cake.CoreCLR/0.30.0/Cake.dll",
+            "args": [
+                "${workspaceRoot}/build/build.cake",
+                "--debug",
+                "--verbosity=diagnostic"
+            ],
+            "cwd": "${workspaceRoot}/build",
+            "stopAtEntry": true,
+            "externalConsole": false
         }
     ]
 }

build.ps1

@@ -41,27 +41,28 @@ Param(
     [switch]$ShowDescription,
     [Alias("WhatIf", "Noop")]
     [switch]$DryRun,
-    [Parameter(Position=0,Mandatory=$false,ValueFromRemainingArguments=$true)]
+    [Parameter(Position = 0, Mandatory = $false, ValueFromRemainingArguments = $true)]
     [string[]]$ScriptArgs
 )
 
 Write-Host "Preparing to run build script..."
 
 # Determine the script root for resolving other paths.
-if(!$PSScriptRoot){
+if(!$PSScriptRoot) {
     $PSScriptRoot = Split-Path $MyInvocation.MyCommand.Path -Parent
 }
 
 # Resolve the paths for resources used for debugging.
-$TOOLS_DIR = Join-Path $PSScriptRoot "tools"
-$CAKE_CSPROJ = Join-Path $TOOLS_DIR "cakebuild.csproj"
+$BUILD_DIR = Join-Path $PSScriptRoot "build"
+$TOOLS_DIR = Join-Path $BUILD_DIR "tools"
+$CAKE_CSPROJ = Join-Path $BUILD_DIR "cakebuild.csproj"
 
 # Install the required tools locally.
 Write-Host "Restoring cake tools..."
 Invoke-Expression "dotnet restore `"$CAKE_CSPROJ`" --packages `"$TOOLS_DIR`"" | Out-Null
 
 # Find the Cake executable
-$CAKE_EXECUTABLE = (Get-ChildItem -Path ./tools/cake.coreclr/ -Filter Cake.dll -Recurse).FullName
+$CAKE_EXECUTABLE = (Get-ChildItem -Path "$TOOLS_DIR/cake.coreclr/" -Filter Cake.dll -Recurse).FullName
 
 # Build Cake arguments
 $cakeArguments = @("$Script");
@@ -75,5 +76,7 @@ $cakeArguments += $ScriptArgs
 
 # Start Cake
 Write-Host "Running build script..."
+Push-Location -Path $BUILD_DIR
 Invoke-Expression "dotnet `"$CAKE_EXECUTABLE`" $cakeArguments"
+Pop-Location
 exit $LASTEXITCODE

build.sh

@@ -6,12 +6,13 @@
 
 echo "Preparing to run build script..."
 
+cd build
 SCRIPT_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
 TOOLS_DIR=$SCRIPT_DIR/tools
 CAKE_BINARY_PATH=$TOOLS_DIR/"cake.coreclr"
 
 SCRIPT="build.cake"
-CAKE_CSPROJ=$TOOLS_DIR/"cakebuild.csproj"
+CAKE_CSPROJ=$SCRIPT_DIR/"cakebuild.csproj"
 
 # Parse arguments.
 CAKE_ARGUMENTS=()

build/build.cake

@@ -1,6 +1,7 @@
 #addin "nuget:?package=CodeFileSanity&version=0.0.21"
 #addin "nuget:?package=JetBrains.ReSharper.CommandLineTools&version=2018.2.2"
 #tool "nuget:?package=NVika.MSBuild&version=1.0.1"
+var nVikaToolPath = GetFiles("./tools/NVika.MSBuild.*/tools/NVika.exe").First();
 
 ///////////////////////////////////////////////////////////////////////////////
 // ARGUMENTS
@@ -9,30 +10,24 @@
 var target = Argument("target", "Build");
 var configuration = Argument("configuration", "Release");
 
-var osuSolution = new FilePath("./osu.sln");
+var rootDirectory = new DirectoryPath("..");
+var solution = rootDirectory.CombineWithFilePath("osu.sln");
 
 ///////////////////////////////////////////////////////////////////////////////
 // TASKS
 ///////////////////////////////////////////////////////////////////////////////
 
-Task("Restore")
-    .Does(() => {
-        DotNetCoreRestore(osuSolution.FullPath);
-    });
-
 Task("Compile")
-    .IsDependentOn("Restore")
     .Does(() => {
-        DotNetCoreBuild(osuSolution.FullPath, new DotNetCoreBuildSettings {
+        DotNetCoreBuild(solution.FullPath, new DotNetCoreBuildSettings {
             Configuration = configuration,
-            NoRestore = true,
         });
     });
 
 Task("Test")
     .IsDependentOn("Compile")
     .Does(() => {
-        var testAssemblies = GetFiles("**/*.Tests/bin/**/*.Tests.dll");
+        var testAssemblies = GetFiles(rootDirectory + "/**/*.Tests/bin/**/*.Tests.dll");
 
         DotNetCoreVSTest(testAssemblies, new DotNetCoreVSTestSettings {
             Logger = AppVeyor.IsRunningOnAppVeyor ? "Appveyor" : $"trx",
@@ -46,9 +41,7 @@ Task("InspectCode")
     .WithCriteria(IsRunningOnWindows())
     .IsDependentOn("Compile")
     .Does(() => {
-        var nVikaToolPath = GetFiles("./tools/NVika.MSBuild.*/tools/NVika.exe").First();
-
-        InspectCode(osuSolution, new InspectCodeSettings {
+        InspectCode(solution, new InspectCodeSettings {
             CachesHome = "inspectcode",
             OutputFile = "inspectcodereport.xml",
         });
@@ -59,7 +52,7 @@ Task("InspectCode")
 Task("CodeFileSanity")
     .Does(() => {
         ValidateCodeSanity(new ValidateCodeSanitySettings {
-            RootDirectory = ".",
+            RootDirectory = rootDirectory.FullPath,
             IsAppveyorBuild = AppVeyor.IsRunningOnAppVeyor
         });
     });