Adds ErrorIfLinkFails attribute for Copy Tasks. #4657

gregwoodio · 2019-08-24T15:36:08Z

When ErrorIfLinkFails is set, we error if a symbolic link or hard link fails. We also error if ErrorIfLinkFails is set without specifying we should use symbolic or hard linking for Copy tasks.

Addresses #4433.

dnfclas · 2019-08-24T15:36:22Z

All CLA requirements met.

Addresses dotnet#4433.

rainersigwald

Thank you for the contribution! This looks like a good implementation of the idea, but I think it needs one more thing besides my comments before we can accept it: easy use of the new functionality!

Can you please introduce a new property similar to CreateHardLinksForCopyFilesToOutputDirectoryIfPossible that is passed to the Copy task in the same places in Microsoft.Common.CurrentVersion.targets? ErrorIfLinkFailsForCopyFilesToOutputDirectory seems like a reasonable name, but if you can think of one that's less of a mouthful I'd love to hear it :)

rainersigwald · 2019-08-26T14:24:42Z

src/Tasks/Resources/Strings.resx

@@ -2682,6 +2682,14 @@
  <data name="Copy.ExactlyOneTypeOfLink">
    <value>MSB3891: Both "{0}" and "{1}" were specified in the project file. Please choose one or the other.</value>
  </data>
+  <data name="Copy.ErrorIfLinkFailsSetWithoutLinkOption" xml:space="preserve">
+    <value>MSB3892: ErrorIfLinkedFails requires UseHardlinksIfPossible or UseSymbolicLinksIfPossible to be set.</value>


Suggested change

<value>MSB3892: ErrorIfLinkedFails requires UseHardlinksIfPossible or UseSymbolicLinksIfPossible to be set.</value>

<value>MSB3892: ErrorIfLinkFails requires UseHardlinksIfPossible or UseSymbolicLinksIfPossible to be set.</value>

rainersigwald · 2019-08-26T14:26:55Z

src/Tasks/Resources/Strings.resx

@@ -2682,6 +2682,14 @@
  <data name="Copy.ExactlyOneTypeOfLink">
    <value>MSB3891: Both "{0}" and "{1}" were specified in the project file. Please choose one or the other.</value>
  </data>
+  <data name="Copy.ErrorIfLinkFailsSetWithoutLinkOption" xml:space="preserve">
+    <value>MSB3892: ErrorIfLinkedFails requires UseHardlinksIfPossible or UseSymbolicLinksIfPossible to be set.</value>
+    <comment>{StrBegin="MSB3892: "}</comment>


This is probably clear enough from context, but we try to be explicit about it in other cases:

Suggested change

<comment>{StrBegin="MSB3892: "}</comment>

<comment>{StrBegin="MSB3892: "} LOCALIZATION: Do not localize "ErrorIfLinkFails", "UseHardLinksIfPossible", or "UseSymbolicLinksIfPossible".</comment>

rainersigwald · 2019-08-26T14:27:34Z

src/Tasks/Resources/Strings.resx

+  </data>
+  <data name="Copy.LinkFailed" xml:space="preserve">
+    <value>MSB3893: Could not use a link to copy "{0}" to "{1}".</value>
+    <comment>{StrBegin="MSB3893: "}</comment>


Suggested change

<comment>{StrBegin="MSB3893: "}</comment>

<comment>{StrBegin="MSB3893: "} LOCALIZATION: LOCALIZATION: {0} and {1} are paths.</comment>

rainersigwald · 2019-08-26T14:29:30Z

src/Tasks.UnitTests/Copy_Tests.cs

@@ -1929,6 +1929,51 @@ public void TooFewRetriesThrows()
            engine.AssertLogContains("MSB3027");
        }

+        [Fact(Skip = "Only run if either UseHardlinksIfPossible or UseSymboliclinksIfPossible is true")]


Would it be better to just not mark this as a Fact, and let that be only in the overrides?

Suggested change

[Fact(Skip = "Only run if either UseHardlinksIfPossible or UseSymboliclinksIfPossible is true")]

// Base implementation; only run if either UseHardlinksIfPossible or UseSymboliclinksIfPossible is true

Another option would be to use

Suggested change

[Fact(Skip = "Only run if either UseHardlinksIfPossible or UseSymboliclinksIfPossible is true")]

[ConditionalFact(nameof(LinkOptionIsSpecified)]

(and implement such a method). That may be a bit cleaner but I don't feel strongly either way.

rainersigwald · 2019-08-26T14:29:51Z

src/Tasks.UnitTests/Copy_Tests.cs

@@ -1929,6 +1929,51 @@ public void TooFewRetriesThrows()
            engine.AssertLogContains("MSB3027");
        }

+        [Fact(Skip = "Only run if either UseHardlinksIfPossible or UseSymboliclinksIfPossible is true")]
+        [PlatformSpecific(TestPlatforms.Windows)]


Is this necessary? And does it actually apply when the "real" test is the overrides?

It seems to apply when set on the base method. I found this scenario (trying to copy over a read-only file) fails on Mac and Linux because the link is still successfully created. If you can think of another scenario that should fail to create a link for all platforms I can implement that instead.

gregwoodio · 2019-09-02T22:48:24Z

@rainersigwald please see code review changes.

rainersigwald

Thanks! The targets change looks good to me.

While I was trying to see if I could easily cause the link-creation failures on macOS (I couldn't either, so let's just leave the test Windows-only for the moment), I made some changes (7ae4357) to use some new test infrastructure that makes things a bit more streamlined. This isn't how other tests in this file are written--so you wouldn't have easily known to do so yourself--but we're trying to move newer tests to the newer technique.

rainersigwald · 2019-09-03T14:14:46Z

src/Tasks/Microsoft.Common.CurrentVersion.targets

@@ -4194,6 +4194,7 @@ Copyright (C) Microsoft Corporation. All rights reserved.
      <!-- By default we're not using Hard Links to copy to the output directory, and never when building in VS -->
      <CreateHardLinksForCopyFilesToOutputDirectoryIfPossible Condition="'$(BuildingInsideVisualStudio)' == 'true' or '$(CreateHardLinksForCopyFilesToOutputDirectoryIfPossible)' == ''">false</CreateHardLinksForCopyFilesToOutputDirectoryIfPossible>
      <CreateSymbolicLinksForCopyFilesToOutputDirectoryIfPossible Condition="'$(BuildingInsideVisualStudio)' == 'true' or '$(CreateSymbolicLinksForCopyFilesToOutputDirectoryIfPossible)' == ''">false</CreateSymbolicLinksForCopyFilesToOutputDirectoryIfPossible>
+      <ErrorIfLinkFailsForCopyFilesToOutputDirectory Condition="'$(BuildingInsideVisualStudio)' == 'true' or '$(ErrorIfLinkFailsForCopyFilesToOutputDirectory)' == ''">false</ErrorIfLinkFailsForCopyFilesToOutputDirectory>


Hmm. I'd rather not have to have the in-VS condition, but since the other properties are conditioned on it and there's now an error for specifying this new option when not specifying one of the others, I guess this is the right way to go.

gregwoodio · 2019-09-04T01:27:45Z

Great! Thanks for the review.

rainersigwald · 2019-09-17T20:43:51Z

Thanks again!

Adds ErrorIfLinkFails attribute for Copy Tasks.

b25a1ce

Addresses dotnet#4433.

gregwoodio force-pushed the error-if-link-fails branch from 1b7d632 to b25a1ce Compare August 24, 2019 23:32

rainersigwald requested changes Aug 26, 2019

View reviewed changes

rainersigwald self-assigned this Aug 27, 2019

Code review changes

f42402c

gregwoodio force-pushed the error-if-link-fails branch from f100afd to f42402c Compare September 2, 2019 21:28

Use TestEnvironment in ErrorIfLinkFailedCheck

7ae4357

rainersigwald approved these changes Sep 3, 2019

View reviewed changes

rainersigwald merged commit 037db14 into dotnet:master Sep 17, 2019

rainersigwald added this to the MSBuild 16.4 milestone Sep 17, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds ErrorIfLinkFails attribute for Copy Tasks. #4657

Adds ErrorIfLinkFails attribute for Copy Tasks. #4657

gregwoodio commented Aug 24, 2019

dnfclas commented Aug 24, 2019 •

edited

Loading

rainersigwald left a comment

rainersigwald Aug 26, 2019

rainersigwald Aug 26, 2019

rainersigwald Aug 26, 2019

rainersigwald Aug 26, 2019

rainersigwald Aug 26, 2019

rainersigwald Aug 26, 2019

gregwoodio Aug 26, 2019

gregwoodio commented Sep 2, 2019

rainersigwald left a comment

rainersigwald Sep 3, 2019

gregwoodio commented Sep 4, 2019

rainersigwald commented Sep 17, 2019

	<value>MSB3892: ErrorIfLinkedFails requires UseHardlinksIfPossible or UseSymbolicLinksIfPossible to be set.</value>
	<value>MSB3892: ErrorIfLinkFails requires UseHardlinksIfPossible or UseSymbolicLinksIfPossible to be set.</value>

	<comment>{StrBegin="MSB3892: "}</comment>
	<comment>{StrBegin="MSB3892: "} LOCALIZATION: Do not localize "ErrorIfLinkFails", "UseHardLinksIfPossible", or "UseSymbolicLinksIfPossible".</comment>

	<comment>{StrBegin="MSB3893: "}</comment>
	<comment>{StrBegin="MSB3893: "} LOCALIZATION: LOCALIZATION: {0} and {1} are paths.</comment>

	[Fact(Skip = "Only run if either UseHardlinksIfPossible or UseSymboliclinksIfPossible is true")]
	// Base implementation; only run if either UseHardlinksIfPossible or UseSymboliclinksIfPossible is true

	[Fact(Skip = "Only run if either UseHardlinksIfPossible or UseSymboliclinksIfPossible is true")]
	[ConditionalFact(nameof(LinkOptionIsSpecified)]

Adds ErrorIfLinkFails attribute for Copy Tasks. #4657

Adds ErrorIfLinkFails attribute for Copy Tasks. #4657

Conversation

gregwoodio commented Aug 24, 2019

dnfclas commented Aug 24, 2019 • edited Loading

rainersigwald left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gregwoodio commented Sep 2, 2019

rainersigwald left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gregwoodio commented Sep 4, 2019

rainersigwald commented Sep 17, 2019

dnfclas commented Aug 24, 2019 •

edited

Loading