Add Xcsync tool to workload package (#20931)

Co-authored-by: Haritha Mohan <[email protected]> Co-authored-by: Alex Soto <[email protected]> Co-authored-by: Rolf Bjarne Kvinge <[email protected]>
xamarin · Aug 5, 2024 · 6aca25a · 6aca25a · vs-mobiletools-engineering-service2 · Aug 5, 2024
1 parent 2c7fce4
commit 6aca25a
Show file tree

Hide file tree

Showing 14 changed files with 122 additions and 4 deletions.
diff --git a/dotnet/Microsoft.MacCatalyst.Sdk/data/UnixFilePermissions.xml b/dotnet/Microsoft.MacCatalyst.Sdk/data/UnixFilePermissions.xml
@@ -2,4 +2,7 @@
 	<!-- bgen -->
 	<File Path="tools/bin/bgen" Permission="755" />
 	<File Path="tools/lib/bgen/bgen" Permission="755" />
+    <!-- xcsync -->
+	<File Path="tools/bin/xcsync" Permission="755" />
+	<File Path="tools/lib/xcsync" Permission="755" />
  </FileList>
diff --git a/dotnet/Microsoft.iOS.Sdk/data/UnixFilePermissions.xml b/dotnet/Microsoft.iOS.Sdk/data/UnixFilePermissions.xml
@@ -5,4 +5,7 @@
 	<!-- mlaunch -->
 	<File Path="tools/bin/mlaunch" Permission="755" />
 	<File Path="tools/lib/mlaunch/mlaunch.app/Contents/MacOS/mlaunch" Permission="755" />
+     <!-- xcsync -->
+	<File Path="tools/bin/xcsync" Permission="755" />
+	<File Path="tools/lib/xcsync" Permission="755" />
  </FileList>
diff --git a/dotnet/Microsoft.macOS.Sdk/data/UnixFilePermissions.xml b/dotnet/Microsoft.macOS.Sdk/data/UnixFilePermissions.xml
@@ -2,4 +2,7 @@
 	<!-- bgen -->
 	<File Path="tools/bin/bgen" Permission="755" />
 	<File Path="tools/lib/bgen/bgen" Permission="755" />
+    <!-- xcsync -->
+	<File Path="tools/bin/xcsync" Permission="755" />
+	<File Path="tools/lib/xcsync" Permission="755" />
  </FileList>
diff --git a/dotnet/Microsoft.tvOS.Sdk/data/UnixFilePermissions.xml b/dotnet/Microsoft.tvOS.Sdk/data/UnixFilePermissions.xml
@@ -5,4 +5,7 @@
 	<!-- mlaunch -->
 	<File Path="tools/bin/mlaunch" Permission="755" />
 	<File Path="tools/lib/mlaunch/mlaunch.app/Contents/MacOS/mlaunch" Permission="755" />
+    <!-- xcsync -->
+	<File Path="tools/bin/xcsync" Permission="755" />
+	<File Path="tools/lib/xcsync" Permission="755" />
  </FileList>
diff --git a/dotnet/targets/Xamarin.Shared.Sdk.props b/dotnet/targets/Xamarin.Shared.Sdk.props
@@ -91,6 +91,8 @@
 		<!-- Tell .NET to skip sanity checks that trigger too eagerly for builds with multiple RuntimeIdentifiers -->
 		<AllowPublishAotWithoutRuntimeIdentifier Condition="'$(AllowPublishAotWithoutRuntimeIdentifier)' == '' And '$(_UseNativeAot)' == 'true'">true</AllowPublishAotWithoutRuntimeIdentifier>
 		<AllowSelfContainedWithoutRuntimeIdentifier Condition="'$(AllowSelfContainedWithoutRuntimeIdentifier)' == ''">true</AllowSelfContainedWithoutRuntimeIdentifier>
+
+		<XcsyncPath Condition="'$(XcsyncPath)' == ''">$(_XamarinSdkRootDirectoryOnMac)tools/bin</XcsyncPath>
 	</PropertyGroup>
 
 	<!-- Set the default RuntimeIdentifier if not already specified. -->

diff --git a/dotnet/targets/Xamarin.Shared.Sdk.targets b/dotnet/targets/Xamarin.Shared.Sdk.targets
@@ -2416,6 +2416,41 @@ global using nfloat = global::System.Runtime.InteropServices.NFloat%3B
 		</ItemGroup>
 	</Target>
 
+	<Target Name="ComputeXcsyncArguments">
+		<PropertyGroup>
+			<xcSyncExecute>PATH=$(XcsyncPath):$PATH $(DOTNET_HOST_PATH) xcsync</xcSyncExecute>
+			<xcSyncProjectFile Condition="'$(xcSyncProjectFile)' == ''">$(MSBuildProjectFullPath)</xcSyncProjectFile>
+			<xcSyncXcodeFolder Condition="'$(xcSyncXcodeFolder)' == ''">$(IntermediateOutputPath)xcode</xcSyncXcodeFolder>
+			<xcSyncTargetFrameworkMoniker Condition="'$(xcSyncTargetFrameworkMoniker)' == ''">$(TargetFramework)</xcSyncTargetFrameworkMoniker>
+			<xcSyncVerbosity Condition="'$(xcSyncVerbosity)' == ''">Diagnostic</xcSyncVerbosity>
+
+
+			<XcsyncCommonArguments Condition="'$(xcSyncProjectFile)' != ''">$(XcsyncCommonArguments) -p "$(xcSyncProjectFile)"</XcsyncCommonArguments>
+			<XcsyncCommonArguments Condition="'$(xcSyncXcodeFolder)' != ''">$(XcsyncCommonArguments) -t "$(xcSyncXcodeFolder)"</XcsyncCommonArguments>
+			<XcsyncCommonArguments Condition="'$(xcSyncTargetFrameworkMoniker)' != ''">$(XcsyncCommonArguments) -tfm $(xcSyncTargetFrameworkMoniker)</XcsyncCommonArguments>
+			<XcsyncCommonArguments Condition="'$(xcSyncVerbosity)' != ''">$(XcsyncCommonArguments) -v $(xcSyncVerbosity)</XcsyncCommonArguments>
+			<XcsyncCommonArguments>$(XcsyncCommonArguments) --dotnet-path "$([System.IO.Path]::GetDirectoryName($(DOTNET_HOST_PATH)))"</XcsyncCommonArguments>
+
+			<XcsyncGenerateArguments>$(XcsyncCommonArguments) --force</XcsyncGenerateArguments>
+
+			<XcsyncSyncArguments>$(XcsyncCommonArguments)</XcsyncSyncArguments>
+		</PropertyGroup>
+	</Target>
+
+	<Target Name="xcsync-generate" DependsOnTargets="ComputeXcsyncArguments">
+		<Message Importance="Normal" Text="Add $(XcsyncPath) to your path to invoke xcSync directly from the commandline." />
+		<Message Importance="Low" Text="Executing xcSync using: $(xcSyncExecute) generate $(XcsyncGenerateArguments)" />
+
+		<Exec SessionId="$(BuildSessionId)" Command="$(xcSyncExecute) generate $(XcsyncGenerateArguments)" />
+	</Target>
+
+	<Target Name="xcsync-sync" DependsOnTargets="ComputeXcsyncArguments">
+		<Message Importance="Normal" Text="Add $(XcsyncPath) to your path to invoke xcSync directly from the commandline." />
+		<Message Importance="Low" Text="Executing xcSync using: $(xcSyncExecute) sync $(XcsyncSyncArguments)" />
+
+		<Exec SessionId="$(BuildSessionId)" Command="$(xcSyncExecute) sync $(XcsyncSyncArguments)" />
+	</Target>
+
 	<!-- Import existing targets -->
 
 	<PropertyGroup>

diff --git a/mk/xamarin.mk b/mk/xamarin.mk
@@ -18,7 +18,9 @@ endif
 
 # Available versions can be seen here:
 # https://dev.azure.com/dnceng/public/_artifacts/feed/dotnet-eng/NuGet/Microsoft.Tools.Mlaunch/versions
+# https://dev.azure.com/dnceng/public/_artifacts/feed/dotnet-eng/NuGet/Microsoft.Tools.xcsync/versions
 MLAUNCH_NUGET_VERSION=1.0.142
+XCSYNC_NUGET_VERSION=1.0.86
 
 define CheckVersionTemplate
 check-$(1)::

diff --git a/tools/Makefile b/tools/Makefile
@@ -30,7 +30,7 @@ ifdef INCLUDE_MTOUCH
 SUBDIRS += mtouch
 endif
 
-SUBDIRS+=mlaunch siminstaller
+SUBDIRS+=mlaunch siminstaller xcsync
 
 ifdef ENABLE_DOTNET
 ifdef INCLUDE_XAMARIN_LEGACY

diff --git a/tools/devops/governance/CredScanSuppressions.json b/tools/devops/governance/CredScanSuppressions.json
@@ -850,11 +850,11 @@
             "_justification": "External repo dependency, mono."
         },
         {
-            "file": "maccore\\tools\\provisioning-profiles\\certificates-and-profiles\\developer-id-application-luis-aguilera-aug-2024.p12",
+            "file": "maccore\\tools\\provisioning-profiles\\certificates-and-profiles\\developer-id-application-luis-aguilera-jul-2029.p12",
             "_justification": "Testing certificate."
         },
         {
-            "file": "maccore\\tools\\provisioning-profiles\\certificates-and-profiles\\developer-id-installer-luis-aguilera-aug-2024.p12",
+            "file": "maccore\\tools\\provisioning-profiles\\certificates-and-profiles\\developer-id-installer-luis-aguilera-jul-2029.p12",
             "_justification": "Testing certificate."
         },
         {

diff --git a/tools/mlaunch/Makefile b/tools/mlaunch/Makefile
@@ -16,7 +16,7 @@ endif
 TARGETS += $(foreach platform,$(DOTNET_PLATFORMS_MOBILE),$(DOTNET_DESTDIR)/Microsoft.$(platform).Sdk/tools/bin/mlaunch)
 
 $(DOWNLOAD_STAMP_FILE):
-	$(Q) $(DOTNET) restore download-mlaunch.csproj /bl:$@.binlog $(NSBUILD_VERBOSITY) /p:MlaunchNuGetVersion=$(MLAUNCH_NUGET_VERSION)
+	$(Q) $(DOTNET) restore download-mlaunch.csproj /bl:$@.binlog $(MSBUILD_VERBOSITY) /p:MlaunchNuGetVersion=$(MLAUNCH_NUGET_VERSION)
 	$(Q) touch $@
 
 $(IOS_DESTDIR)/Library/Frameworks/Xamarin.iOS.framework/Versions/Current/bin/mlaunch: $(DOWNLOAD_STAMP_FILE)

diff --git a/tools/xcsync/.gitignore b/tools/xcsync/.gitignore
@@ -0,0 +1,2 @@
+*.stamp
+
diff --git a/tools/xcsync/Makefile b/tools/xcsync/Makefile
@@ -0,0 +1,37 @@
+TOP=../..
+
+include $(TOP)/Make.config
+include $(TOP)/mk/xamarin.mk
+
+DOWNLOAD_STAMP_FILE=.download-$(XCSYNC_NUGET_VERSION).stamp
+
+TARGETS += $(foreach platform,$(DOTNET_PLATFORMS),$(DOTNET_DESTDIR)/Microsoft.$(platform).Sdk/tools/bin/xcsync)
+
+$(DOWNLOAD_STAMP_FILE):
+	$(Q) $(DOTNET) restore download-xcsync.csproj /bl:$@.binlog $(MSBUILD_VERBOSITY) /p:XcsyncNuGetVersion=$(XCSYNC_NUGET_VERSION)
+	$(Q) touch $@
+
+define DotNetInstall
+$$(DOTNET_DESTDIR)/Microsoft.$(1).Sdk/tools/bin/xcsync: $$(DOWNLOAD_STAMP_FILE)
+	$$(Q) rm -rf $$(DOTNET_DESTDIR)/$($(1)_NUGET_SDK_NAME)/tools/bin/xcsync
+	$$(Q) rm -rf $$(DOTNET_DESTDIR)/$($(1)_NUGET_SDK_NAME)/tools/lib/xcsync
+	$$(Q) mkdir -p $$(DOTNET_DESTDIR)/$($(1)_NUGET_SDK_NAME)/tools/bin
+	$$(Q) mkdir -p $$(DOTNET_DESTDIR)/$($(1)_NUGET_SDK_NAME)/tools/lib/xcsync
+	$$(Q) $$(CP) -R $(TOP)/packages/microsoft.tools.xcsync/$$(XCSYNC_NUGET_VERSION)/bin/dotnet-xcsync $$(DOTNET_DESTDIR)/$($(1)_NUGET_SDK_NAME)/tools/bin/xcsync
+	$$(Q) $$(CP) -R $(TOP)/packages/microsoft.tools.xcsync/$$(XCSYNC_NUGET_VERSION)/lib/. $$(DOTNET_DESTDIR)/$($(1)_NUGET_SDK_NAME)/tools/lib/xcsync
+	$$(Q) chmod a+x $$(DOTNET_DESTDIR)/$($(1)_NUGET_SDK_NAME)/tools/bin/xcsync
+	$$(Q) chmod a+x $$(DOTNET_DESTDIR)/$($(1)_NUGET_SDK_NAME)/tools/lib/xcsync/xcsync
+endef
+
+$(foreach platform,$(DOTNET_PLATFORMS),$(eval $(call DotNetInstall,$(platform))))
+
+clean-local::
+ifdef ENABLE_DOTNET
+	$(Q) rm -rf $(foreach platform,$(DOTNET_PLATFORMS),$(DOTNET_DESTDIR)/$($(platform)_NUGET_SDK_NAME)/tools/bin/xcsync)
+	$(Q) rm -rf $(foreach platform,$(DOTNET_PLATFORMS),$(DOTNET_DESTDIR)/$($(platform)_NUGET_SDK_NAME)/tools/lib/xcsync)
+endif
+	$(Q) rm -rf .*.stamp obj .*.binlog
+
+all-local:: $(TARGETS)
+install-local:: $(TARGETS)
+download: $(DOWNLOAD_STAMP_FILE)
diff --git a/tools/xcsync/README.md b/tools/xcsync/README.md
@@ -0,0 +1,15 @@
+xcsync
+-------
+
+xcsync is a closed source tool used to interact with Xcode.
+
+We'll build this tool from souce if the xamarin build is enabled (configured
+with --enable-xamarin).
+
+Otherwise we'll get a binary version from the macios-binaries repository. This
+version may be somewhat out of date, but should work at least for running
+tests.
+
+To update the binary version of xcsync in macios-binaries execute `make publish`
+in this directory (when the xamarin build is enabled, so that xcsync
+is built from source).
diff --git a/tools/xcsync/download-xcsync.csproj b/tools/xcsync/download-xcsync.csproj
@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net$(BundledNETCoreAppTargetFrameworkVersion)</TargetFramework>
+  </PropertyGroup>
+
+  <Import Project="../../eng/Versions.props" />
+
+  <ItemGroup>
+    <PackageDownload Include="Microsoft.Tools.xcsync" Version="[$(XcsyncNuGetVersion)]" />
+  </ItemGroup>
+
+  <Target Name="Download" />
+</Project>