Add VMR sync functionality into dotnet/dotnet's Codespaces (#15750)

src/SourceBuild/content/.devcontainer/README.md

@@ -0,0 +1,52 @@
+<!--
+########  ########    ###    ########     ######## ##     ## ####  ######
+##     ## ##         ## ##   ##     ##       ##    ##     ##  ##  ##    ##
+##     ## ##        ##   ##  ##     ##       ##    ##     ##  ##  ##
+########  ######   ##     ## ##     ##       ##    #########  ##   ######
+##   ##   ##       ######### ##     ##       ##    ##     ##  ##        ##
+##    ##  ##       ##     ## ##     ##       ##    ##     ##  ##  ##    ##
+##     ## ######## ##     ## ########        ##    ##     ## ####  ######
+-->
+
+This Codespace can help you debug the source build of .NET. This build takes about
+45 minutes and, after completion, produces an archived .NET SDK located in
+`/workspaces/dotnet/artifacts/x64/Release`. In case you selected the `prebuilt-sdk`
+Codespace, the SDK will already be there.
+
+## Build the SDK
+
+To build the VMR, run following:
+```bash
+./prep.sh && ./build.sh --online
+```
+
+> Please note that, at this time, the build modifies some of the checked-in sources so it might
+be preferential to rebuild the Codespace between attempts (or reset the working tree changes).
+
+For more details, see the instructions at https://github.com/dotnet/dotnet.
+
+## Synchronize your changes in locally
+
+When debugging the build, you have two options how to test your changes in this environment.
+
+### Making changes to the VMR directly
+
+You can make the changes directly to the local checkout of the VMR at `/workspaces/dotnet`. You
+can then try to build the VMR and see if the change works for you.
+
+### Pull changes into the Codespace from your fork
+
+You can also make a fix in the individual source repository (e.g. `dotnet/runtime`) and push the
+fix into a branch; can be in your fork too. Once you have the commit pushed, you can pull this
+version of the repository into the Codespace by running:
+
+```
+/workspaces/synchronize-vmr.sh                \
+  --repository <repo>:<commit, tag or branch> \
+  --remote <repo>:<fork URI>
+```
+
+You can now proceed building the VMR in the Codespace using instructions above. You can repeat
+this process and sync a new commit from your fork. Only note that, at this time, Source-Build
+modifies some of the checked-in sources so you'll need to revert the working tree changes
+between attempts.

src/SourceBuild/content/.devcontainer/devcontainer.json

@@ -11,6 +11,12 @@
             "extensions": [
                 "ms-dotnettools.csharp"
             ]
+        },
+        "codespaces": {
+            "openFiles": [
+                ".devcontainer/README.md"
+            ]
         }
-    }
+    },
+    "onCreateCommand": ".devcontainer/init.sh"
 }

src/SourceBuild/content/.devcontainer/init.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -eux
+
+source="${BASH_SOURCE[0]}"
+script_root="$( cd -P "$( dirname "$source" )" && pwd )"
+
+workspace_dir=$(realpath "$script_root/../../")
+tmp_dir=$(realpath "$workspace_dir/tmp")
+vmr_dir=$(realpath "$workspace_dir/dotnet")
+
+cp "$vmr_dir/.devcontainer/synchronize-vmr.sh" "$workspace_dir"
+
+mkdir -p "$tmp_dir"

src/SourceBuild/content/.devcontainer/prebuilt-sdk/build.sh

@@ -1,11 +0,0 @@
-#!/usr/bin/env bash
-
-source="${BASH_SOURCE[0]}"
-scriptroot="$( cd -P "$( dirname "$source" )" && pwd )"
-
-"$scriptroot"/../../prep.sh
-
-# GitHub Codespaces sets this and it conflicts with source-build scripts.
-unset RepositoryName
-
-"$scriptroot"/../../build.sh --online --clean-while-building || exit 0

src/SourceBuild/content/.devcontainer/prebuilt-sdk/devcontainer.json

@@ -11,7 +11,12 @@
             "extensions": [
                 "ms-dotnettools.csharp"
             ]
+        },
+        "codespaces": {
+            "openFiles": [
+                ".devcontainer/README.md"
+            ]
         }
     },
-    "onCreateCommand": "${containerWorkspaceFolder}/.devcontainer/prebuilt-sdk/build.sh"
+    "onCreateCommand": ".devcontainer/prebuilt-sdk/init.sh"
 }

src/SourceBuild/content/.devcontainer/prebuilt-sdk/init.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+source="${BASH_SOURCE[0]}"
+script_root="$( cd -P "$( dirname "$source" )" && pwd )"
+
+"$script_root"/../../prep.sh
+
+cp "$script_root/../synchronize-vmr.sh" "/workspaces/"
+"$script_root"/../../build.sh --online --clean-while-building || exit 0

src/SourceBuild/content/.devcontainer/synchronize-vmr.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+(cd /workspaces/dotnet/src/installer \
+    && ./eng/vmr-sync.sh --vmr /workspaces/dotnet --tmp /workspaces/tmp --no-vmr-prepare $*)

src/SourceBuild/content/build.sh

@@ -19,7 +19,6 @@ usage() {
 SCRIPT_ROOT="$(cd -P "$( dirname "$0" )" && pwd)"
 
 MSBUILD_ARGUMENTS=("-flp:v=detailed")
-CUSTOM_REF_PACKAGES_DIR=''
 CUSTOM_PACKAGES_DIR=''
 alternateTarget=false
 runningSmokeTests=false
@@ -34,7 +33,7 @@ while :; do
         break
     fi
 
-    lowerI="$(echo $1 | awk '{print tolower($0)}')"
+    lowerI="$(echo "$1" | awk '{print tolower($0)}')"
     case $lowerI in
         --clean-while-building)
             MSBUILD_ARGUMENTS+=( "-p:CleanWhileBuilding=true")
@@ -78,7 +77,7 @@ while :; do
             echo "Detected '--': passing remaining parameters '$@' as build.sh arguments."
             break
             ;;
-        -?|-h|--help)
+        '-?'|-h|--help)
             usage
             exit 0
             ;;
@@ -115,13 +114,13 @@ if [ -f "${packagesArchiveDir}archiveArtifacts.txt" ]; then
 fi
 
 if [ -d "$CUSTOM_SDK_DIR" ]; then
-  export SDK_VERSION=`"$CUSTOM_SDK_DIR/dotnet" --version`
+  export SDK_VERSION=$("$CUSTOM_SDK_DIR/dotnet" --version)
   export CLI_ROOT="$CUSTOM_SDK_DIR"
   export _InitializeDotNetCli="$CLI_ROOT/dotnet"
   export CustomDotNetSdkDir="$CLI_ROOT"
   echo "Using custom bootstrap SDK from '$CLI_ROOT', version '$SDK_VERSION'"
 else
-  sdkLine=`grep -m 1 'dotnet' "$SCRIPT_ROOT/global.json"`
+  sdkLine=$(grep -m 1 'dotnet' "$SCRIPT_ROOT/global.json")
   sdkPattern="\"dotnet\" *: *\"(.*)\""
   if [[ $sdkLine =~ $sdkPattern ]]; then
     export SDK_VERSION=${BASH_REMATCH[1]}
@@ -134,7 +133,7 @@ packageVersionsPath=''
 if [[ "$CUSTOM_PACKAGES_DIR" != "" && -f "$CUSTOM_PACKAGES_DIR/PackageVersions.props" ]]; then
   packageVersionsPath="$CUSTOM_PACKAGES_DIR/PackageVersions.props"
 elif [ -d "$packagesArchiveDir" ]; then
-  sourceBuiltArchive=`find $packagesArchiveDir -maxdepth 1 -name 'Private.SourceBuilt.Artifacts*.tar.gz'`
+  sourceBuiltArchive=$(find "$packagesArchiveDir" -maxdepth 1 -name 'Private.SourceBuilt.Artifacts*.tar.gz')
   if [ -f "${packagesPreviouslySourceBuiltDir}}PackageVersions.props" ]; then
     packageVersionsPath=${packagesPreviouslySourceBuiltDir}PackageVersions.props
   elif [ -f "$sourceBuiltArchive" ]; then
@@ -150,7 +149,7 @@ if [ ! -f "$packageVersionsPath" ]; then
   exit 1
 fi
 
-arcadeSdkLine=`grep -m 1 'MicrosoftDotNetArcadeSdkVersion' "$packageVersionsPath"`
+arcadeSdkLine=$(grep -m 1 'MicrosoftDotNetArcadeSdkVersion' "$packageVersionsPath")
 versionPattern="<MicrosoftDotNetArcadeSdkVersion>(.*)</MicrosoftDotNetArcadeSdkVersion>"
 if [[ $arcadeSdkLine =~ $versionPattern ]]; then
   export ARCADE_BOOTSTRAP_VERSION=${BASH_REMATCH[1]}
@@ -163,7 +162,7 @@ if [[ $arcadeSdkLine =~ $versionPattern ]]; then
   export SOURCE_BUILT_SDK_DIR_ARCADE=$packagesRestoredDir/ArcadeBootstrapPackage/microsoft.dotnet.arcade.sdk/$ARCADE_BOOTSTRAP_VERSION
 fi
 
-sourceLinkLine=`grep -m 1 'MicrosoftSourceLinkCommonVersion' "$packageVersionsPath"`
+sourceLinkLine=$(grep -m 1 'MicrosoftSourceLinkCommonVersion' "$packageVersionsPath")
 versionPattern="<MicrosoftSourceLinkCommonVersion>(.*)</MicrosoftSourceLinkCommonVersion>"
 if [[ $sourceLinkLine =~ $versionPattern ]]; then
   export SOURCE_LINK_BOOTSTRAP_VERSION=${BASH_REMATCH[1]}
@@ -179,11 +178,11 @@ LogDateStamp=$(date +"%m%d%H%M%S")
 "$CLI_ROOT/dotnet" build-server shutdown
 
 if [ "$alternateTarget" == "true" ]; then
-  "$CLI_ROOT/dotnet" msbuild "$SCRIPT_ROOT/build.proj" -bl:$SCRIPT_ROOT/artifacts/log/Debug/BuildTests_$LogDateStamp.binlog -flp:LogFile=$SCRIPT_ROOT/artifacts/logs/BuildTests_$LogDateStamp.log -clp:v=m ${MSBUILD_ARGUMENTS[@]} "$@"
+  "$CLI_ROOT/dotnet" msbuild "$SCRIPT_ROOT/build.proj" -bl:"$SCRIPT_ROOT/artifacts/log/Debug/BuildTests_$LogDateStamp.binlog" -flp:"LogFile=$SCRIPT_ROOT/artifacts/logs/BuildTests_$LogDateStamp.log" -clp:v=m ${MSBUILD_ARGUMENTS[@]} "$@"
 else
-  "$CLI_ROOT/dotnet" msbuild "$SCRIPT_ROOT/eng/tools/init-build.proj" -bl:$SCRIPT_ROOT/artifacts/log/Debug/BuildXPlatTasks_$LogDateStamp.binlog -flp:LogFile=$SCRIPT_ROOT/artifacts/logs/BuildXPlatTasks_$LogDateStamp.log -t:PrepareOfflineLocalTools ${MSBUILD_ARGUMENTS[@]} "$@"
+  "$CLI_ROOT/dotnet" msbuild "$SCRIPT_ROOT/eng/tools/init-build.proj" -bl:"$SCRIPT_ROOT/artifacts/log/Debug/BuildXPlatTasks_$LogDateStamp.binlog" -flp:LogFile="$SCRIPT_ROOT/artifacts/logs/BuildXPlatTasks_$LogDateStamp.log" -t:PrepareOfflineLocalTools ${MSBUILD_ARGUMENTS[@]} "$@"
   # kill off the MSBuild server so that on future invocations we pick up our custom SDK Resolver
   "$CLI_ROOT/dotnet" build-server shutdown
 
-  "$CLI_ROOT/dotnet" msbuild "$SCRIPT_ROOT/build.proj" -bl:$SCRIPT_ROOT/artifacts/log/Debug/Build_$LogDateStamp.binlog -flp:LogFile=$SCRIPT_ROOT/artifacts/logs/Build_$LogDateStamp.log ${MSBUILD_ARGUMENTS[@]} "$@"
+  "$CLI_ROOT/dotnet" msbuild "$SCRIPT_ROOT/build.proj" -bl:"$SCRIPT_ROOT/artifacts/log/Debug/Build_$LogDateStamp.binlog" -flp:"LogFile=$SCRIPT_ROOT/artifacts/logs/Build_$LogDateStamp.log" ${MSBUILD_ARGUMENTS[@]} "$@"
 fi

src/SourceBuild/content/repo-projects/Directory.Build.props

@@ -1,7 +1,7 @@
 <Project>
 
   <PropertyGroup>
-    <RepositoryName Condition="'$(RepositoryName)' == ''">$(MSBuildProjectName)</RepositoryName>
+    <RepositoryName>$(MSBuildProjectName)</RepositoryName>
   </PropertyGroup>
 
   <Import Project="$([MSBuild]::GetPathOfFileAbove(Directory.Build.props, $(MSBuildThisFileDirectory)..))" />