Break deprecated tasks DownloadPackageV0, NuGetInstallerV0, NuGetRestoreV1 (#19325)

* Breaking deprecated tasks after they complete

* Bumped versions

* Added str to DownloadPackageV0's english reources.resjson

* Added str to english reources.resjson

* Removed non pre-existing DownloadPackageV0 L0 tests

* Checking 2nd error NuGetInstallerV0 throws

* L0 tests check for 2 errors: 1 for deprecation + 1 for failure

* Updated expected error message

* Made error messages clearer

* Updated removal date

* Make strings match

* Added feature flag to breaking tasks

* Changed logic to fail when ff is on

* Added env var to tests

* Made sure FF check only passes when true

* Updated generated files

---------

Co-authored-by: Abby Powell (from Dev Box) <[email protected]>

Author: amp-powell

Tasks/DownloadPackageV0/Strings/resources.resjson/en-US/resources.resjson

@@ -22,5 +22,6 @@
   "loc.messages.RetryingOperation": "Error: in %s, so retrying => retries pending: %s",
   "loc.messages.OperationFailed": "Failed in %s with error: %s",
   "loc.messages.Info_ResolvedToolFromCache": "Resolved from tool cache: %s",
-  "loc.messages.UnsupportedProjectScopedFeeds": "Project-scoped feeds are not supported by this version of the \"Download Package\" task. Please use version 1 or higher."
+  "loc.messages.UnsupportedProjectScopedFeeds": "Project-scoped feeds are not supported by this version of the \"Download Package\" task. Please use version 1 or higher.",
+  "loc.messages.DeprecatedTask": "This task is deprecated. Please switch to using DownloadPackage@1 https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/download-package-v1"
 }

Tasks/DownloadPackageV0/Tests/L0.ts

@@ -1,6 +1,8 @@
 import fs = require('fs');
 import assert = require('assert');
 import path = require('path');
+import * as ttm from 'azure-pipelines-task-lib/mock-test';
+import * as tl from "azure-pipelines-task-lib/task";
 
 describe('DownloadPackageV0 Suite', function () {
     before(() => {
@@ -9,7 +11,7 @@ describe('DownloadPackageV0 Suite', function () {
     after(() => {
     });
 
-    it('Does a basic hello world test', function(done: MochaDone) {
+    it('Does a basic hello world test', function(done: Mocha.Done) {
         // TODO - add real tests
         done();
     });

Tasks/DownloadPackageV0/download.ts

@@ -13,7 +13,7 @@ import { WebApi } from 'azure-devops-node-api';
 tl.setResourcePath(path.join(__dirname, 'task.json'));
 
 async function main(): Promise<void> {
-	tl.warning("This task is deprecated. Builds that use it will break on 11-27-2023. Please switch to using DownloadPackage@1 as soon as possible.");
+	tl.warning(tl.loc("DeprecatedTask"));
 	var feed = getProjectAndFeedIdFromInputParam("feed");
 	if(feed.projectId) {
 		throw new Error(tl.loc("UnsupportedProjectScopedFeeds"));
@@ -42,6 +42,12 @@ async function main(): Promise<void> {
 	await executeWithRetries("downloadPackage", () => downloadPackage(feedConnection, pkgsConnection, feedId, packageId, version, downloadPath).catch((reason) => {
 		throw reason;
 	}), retryLimit);
+
+	let shouldFail = tl.getVariable('FAIL_DEPRECATED_TASK');
+
+	if (shouldFail != null && shouldFail.toLowerCase() === 'true') {
+	    throw new Error(tl.loc("DeprecatedTask"));
+	}
 }
 
 function getAuthToken() {

Tasks/DownloadPackageV0/task.json

@@ -9,13 +9,13 @@
   "author": "ms-vscs-rm",
   "version": {
     "Major": 0,
-    "Minor": 231,
+    "Minor": 232,
     "Patch": 0
   },
   "demands": [],
   "minimumAgentVersion": "2.144.0",
   "deprecated": true,
-  "removalDate": "2023-11-27",
+  "removalDate": "2023-12-11",
   "inputs": [
     {
       "name": "feed",
@@ -112,6 +112,7 @@
     "RetryingOperation": "Error: in %s, so retrying => retries pending: %s",
     "OperationFailed": "Failed in %s with error: %s",
     "Info_ResolvedToolFromCache": "Resolved from tool cache: %s",
-    "UnsupportedProjectScopedFeeds": "Project-scoped feeds are not supported by this version of the \"Download Package\" task. Please use version 1 or higher."
+    "UnsupportedProjectScopedFeeds": "Project-scoped feeds are not supported by this version of the \"Download Package\" task. Please use version 1 or higher.",
+    "DeprecatedTask": "This task is deprecated. Please switch to using DownloadPackage@1 https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/download-package-v1"
   }
 }

Tasks/DownloadPackageV0/task.loc.json

@@ -9,13 +9,13 @@
   "author": "ms-vscs-rm",
   "version": {
     "Major": 0,
-    "Minor": 231,
+    "Minor": 232,
     "Patch": 0
   },
   "demands": [],
   "minimumAgentVersion": "2.144.0",
   "deprecated": true,
-  "removalDate": "2023-11-27",
+  "removalDate": "2023-12-11",
   "inputs": [
     {
       "name": "feed",
@@ -112,6 +112,7 @@
     "RetryingOperation": "ms-resource:loc.messages.RetryingOperation",
     "OperationFailed": "ms-resource:loc.messages.OperationFailed",
     "Info_ResolvedToolFromCache": "ms-resource:loc.messages.Info_ResolvedToolFromCache",
-    "UnsupportedProjectScopedFeeds": "ms-resource:loc.messages.UnsupportedProjectScopedFeeds"
+    "UnsupportedProjectScopedFeeds": "ms-resource:loc.messages.UnsupportedProjectScopedFeeds",
+    "DeprecatedTask": "ms-resource:loc.messages.DeprecatedTask"
   }
 }

Tasks/NuGetInstallerV0/Strings/resources.resjson/en-US/resources.resjson

@@ -42,5 +42,6 @@
   "loc.messages.NGCommon_RemovingSources": "Preparing to set credentials in NuGet.config",
   "loc.messages.NGCommon_AddingSources": "Setting credentials in NuGet.config",
   "loc.messages.NGCommon_NoSourcesFoundInConfig": "No package sources were found in the NuGet.config file at %s",
-  "loc.messages.NGCommon_UnabletoDetectNuGetVersion": "Unknown NuGet version selected."
+  "loc.messages.NGCommon_UnabletoDetectNuGetVersion": "Unknown NuGet version selected.",
+  "loc.messages.DeprecatedTask": "This task is deprecated. Please switch to using NuGetCommand@2's 'restore' or 'custom' option https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/nuget-command-v2"
 }

Tasks/NuGetInstallerV0/Tests/L0.ts

@@ -16,9 +16,10 @@ describe('NuGetInstaller Suite', function () {
         assert(tr.ran('c:\\from\\tool\\installer\\nuget.exe restore -NonInteractive c:\\agent\\home\\directory\\single.sln'), 'it should have run NuGet');
         assert(tr.stdOutContained('setting console code page'), 'it should have run chcp');
         assert(tr.stdOutContained('NuGet output here'), "should have nuget output");
-        assert(tr.succeeded, 'should have succeeded');
         assert(tr.invokedToolCount == 1, 'should have run NuGet');
-        assert.equal(tr.errorIssues.length, 0, "should have no errors");
+        assert(tr.failed, 'should have failed');
+        assert.equal(tr.errorIssues.length, 2, "should have 2 errors");
+        assert.equal(tr.errorIssues[0], "Error: loc_mock_DeprecatedTask", "Error should be about deprecation");
         done();
     }).timeout(20000);
 
@@ -31,10 +32,10 @@ describe('NuGetInstaller Suite', function () {
         assert(tr.stdOutContained('setting console code page'), 'it should have run chcp');
         assert(tr.stdOutContained('NuGet output here'), "should have nuget output");
         assert(tr.stdout.indexOf('credProviderPath = ') >= 0, "should have found credential provider path");
-        assert(tr.succeeded, 'should have succeeded');
         assert(tr.invokedToolCount == 1, 'should have run NuGet');
-        assert.equal(tr.warningIssues[0], "This task is deprecated. Builds that use it will break on 11-27-2023. Please switch to using NuGetCommand@2's 'restore' option as soon as possible.", "should have deprecation warning");
-        assert.equal(tr.errorIssues.length, 0, "should have no errors");
+        assert(tr.failed, 'should have failed');
+        assert.equal(tr.errorIssues.length, 2, "should have 2 errors");
+        assert.equal(tr.errorIssues[0], "Error: loc_mock_DeprecatedTask", "Error should be about deprecation");
         done();
     }).timeout(20000);
 
@@ -46,9 +47,10 @@ describe('NuGetInstaller Suite', function () {
         assert(tr.ran('c:\\from\\tool\\installer\\nuget.exe restore -NonInteractive c:\\agent\\home\\directory\\packages.config'), 'it should have run NuGet');
         assert(tr.stdOutContained('setting console code page'), 'it should have run chcp');
         assert(tr.stdOutContained('NuGet output here'), "should have nuget output");
-        assert(tr.succeeded, 'should have succeeded');
         assert(tr.invokedToolCount == 1, 'should have run NuGet');
-        assert.equal(tr.errorIssues.length, 0, "should have no errors");
+        assert(tr.failed, 'should have failed');
+        assert.equal(tr.errorIssues.length, 2, "should have 2 errors");
+        assert.equal(tr.errorIssues[0], "Error: loc_mock_DeprecatedTask", "Error should be about deprecation");
         done();
     }).timeout(20000);   
 
@@ -60,9 +62,10 @@ describe('NuGetInstaller Suite', function () {
         assert(tr.ran('c:\\from\\tool\\installer\\nuget.exe restore -NonInteractive c:\\agent\\home\\directory\\single.sln -NoCache'), 'it should have run NuGet');
         assert(tr.stdOutContained('setting console code page'), 'it should have run chcp');
         assert(tr.stdOutContained('NuGet output here'), "should have nuget output");
-        assert(tr.succeeded, 'should have succeeded');
         assert(tr.invokedToolCount == 1, 'should have run NuGet');
-        assert.equal(tr.errorIssues.length, 0, "should have no errors");
+        assert(tr.failed, 'should have failed');
+        assert.equal(tr.errorIssues.length, 2, "should have 2 errors");
+        assert.equal(tr.errorIssues[0], "Error: loc_mock_DeprecatedTask", "Error should be about deprecation");
         done();
     }).timeout(20000);
 
@@ -74,9 +77,10 @@ describe('NuGetInstaller Suite', function () {
         assert(tr.ran('c:\\from\\tool\\installer\\nuget.exe restore -NonInteractive c:\\agent\\home\\directory\\single.sln -Foo'), 'it should have run NuGet');
         assert(tr.stdOutContained('setting console code page'), 'it should have run chcp');
         assert(tr.stdOutContained('NuGet output here'), "should have nuget output");
-        assert(tr.succeeded, 'should have succeeded');
         assert(tr.invokedToolCount == 1, 'should have run NuGet');
-        assert.equal(tr.errorIssues.length, 0, "should have no errors");
+        assert(tr.failed, 'should have failed');
+        assert.equal(tr.errorIssues.length, 2, "should have 2 errors");
+        assert.equal(tr.errorIssues[0], "Error: loc_mock_DeprecatedTask", "Error should be about deprecation");
         done();
     }).timeout(20000);
 
@@ -91,9 +95,10 @@ describe('NuGetInstaller Suite', function () {
         assert(tr.stdOutContained('setting console code page'), 'it should have run chcp');
         assert(tr.stdOutContained("adding package source uri: mockFeedUri"), "should have added content to temp config");
         assert(tr.stdOutContained('NuGet output here'), "should have nuget output");
-        assert(tr.succeeded, 'should have succeeded');
         assert(tr.invokedToolCount == 1, 'should have run NuGet');
-        assert.equal(tr.errorIssues.length, 0, "should have no errors");
+        assert(tr.failed, 'should have failed');
+        assert.equal(tr.errorIssues.length, 2, "should have 2 errors");
+        assert.equal(tr.errorIssues[0], "Error: loc_mock_DeprecatedTask", "Error should be about deprecation");
         done();
     }).timeout(20000);
 
@@ -105,9 +110,10 @@ describe('NuGetInstaller Suite', function () {
         assert(tr.ran('c:\\custompath\\nuget.exe restore -NonInteractive c:\\agent\\home\\directory\\single.sln'), 'it should have run NuGet');
         assert(tr.stdOutContained('setting console code page'), 'it should have run chcp');
         assert(tr.stdOutContained('NuGet output here'), "should have nuget output");
-        assert(tr.succeeded, 'should have succeeded');
         assert(tr.invokedToolCount == 1, 'should have run NuGet');
-        assert.equal(tr.errorIssues.length, 0, "should have no errors");
+        assert(tr.failed, 'should have failed');
+        assert.equal(tr.errorIssues.length, 2, "should have 2 errors");
+        assert.equal(tr.errorIssues[0], "Error: loc_mock_DeprecatedTask", "Error should be about deprecation");
         done();
     }).timeout(20000);
 
@@ -120,9 +126,10 @@ describe('NuGetInstaller Suite', function () {
         assert(tr.ran('c:\\from\\tool\\installer\\nuget.exe restore -NonInteractive c:\\agent\\home\\directory\\double\\double.sln'), 'it should have run NuGet on double.sln');
         assert(tr.stdOutContained('setting console code page'), 'it should have run chcp');
         assert(tr.stdOutContained('NuGet output here'), "should have nuget output");
-        assert(tr.succeeded, 'should have succeeded');
         assert(tr.invokedToolCount == 2, 'should have run NuGet twice');
-        assert.equal(tr.errorIssues.length, 0, "should have no errors");
+        assert(tr.failed, 'should have failed');
+        assert.equal(tr.errorIssues.length, 2, "should have 2 errors");
+        assert.equal(tr.errorIssues[0], "Error: loc_mock_DeprecatedTask", "Error should be about deprecation");
         done();
     }).timeout(20000);
 
@@ -133,9 +140,10 @@ describe('NuGetInstaller Suite', function () {
         tr.run()
         assert(tr.ran('/usr/bin/mono ~/myagent/_work/_tasks/NuGet/nuget.exe restore -NonInteractive ~/myagent/_work/1/s/single.sln'), 'it should have run NuGet with mono');
         assert(tr.stdOutContained('NuGet output here'), "should have nuget output");
-        assert(tr.succeeded, 'should have succeeded');
         assert(tr.invokedToolCount == 1, 'should have run NuGet');
-        assert.equal(tr.errorIssues.length, 0, "should have no errors");
+        assert(tr.failed, 'should have failed');
+        assert.equal(tr.errorIssues.length, 2, "should have 2 errors");
+        assert.equal(tr.errorIssues[0], "Error: loc_mock_DeprecatedTask", "Error should be about deprecation");
         done();
     }).timeout(20000);
 });

Tasks/NuGetInstallerV0/Tests/multiplesln.ts

@@ -11,6 +11,8 @@ let nmh: util.NugetMockHelper = new util.NugetMockHelper(tmr);
 nmh.setNugetVersionInputDefault();
 tmr.setInput('solution', '**//*.sln');
 
+process.env['FAIL_DEPRECATED_TASK'] = "true";
+
 let a: ma.TaskLibAnswers = <ma.TaskLibAnswers>{
     "osType": {},
     "checkPath": {

Tasks/NuGetInstallerV0/Tests/pkgconfig.ts

@@ -12,6 +12,8 @@ let nmh: util.NugetMockHelper = new util.NugetMockHelper(tmr);
 nmh.setNugetVersionInputDefault();
 tmr.setInput('solution', 'packages.config');
 
+process.env['FAIL_DEPRECATED_TASK'] = "true";
+
 let a: ma.TaskLibAnswers = <ma.TaskLibAnswers>{
     "osType": {},
     "checkPath": {

Tasks/NuGetInstallerV0/Tests/singlesln.ts

@@ -12,6 +12,8 @@ let nmh: util.NugetMockHelper = new util.NugetMockHelper(tmr);
 nmh.setNugetVersionInputDefault();
 tmr.setInput('solution', 'single.sln');
 
+process.env['FAIL_DEPRECATED_TASK'] = "true";
+
 let a: ma.TaskLibAnswers = <ma.TaskLibAnswers>{
     "osType": {},
     "checkPath": {

Tasks/NuGetInstallerV0/Tests/singleslnConfigFile.ts

@@ -13,6 +13,8 @@ nmh.setNugetVersionInputDefault();
 tmr.setInput('solution', 'single.sln');
 tmr.setInput('nugetConfigPath', 'c:\\agent\\home\\directory\\nuget.config');
 
+process.env['FAIL_DEPRECATED_TASK'] = "true";
+
 let a: ma.TaskLibAnswers = <ma.TaskLibAnswers>{
     "osType": {},
     "checkPath": {

Tasks/NuGetInstallerV0/Tests/singleslnCredentialProvider.ts

@@ -12,6 +12,8 @@ let nmh: util.NugetMockHelper = new util.NugetMockHelper(tmr);
 nmh.setNugetVersionInputDefault();
 tmr.setInput('solution', 'single.sln');
 
+process.env['FAIL_DEPRECATED_TASK'] = "true";
+
 let a: ma.TaskLibAnswers = <ma.TaskLibAnswers>{
     "osType": {},
     "checkPath": {

Tasks/NuGetInstallerV0/Tests/singleslnCustomPath.ts

@@ -13,6 +13,8 @@ nmh.setNugetVersionInputDefault();
 tmr.setInput('solution', 'single.sln');
 tmr.setInput('nuGetPath', 'c:\\custompath\\nuget.exe');
 
+process.env['FAIL_DEPRECATED_TASK'] = "true";
+
 let a: ma.TaskLibAnswers = <ma.TaskLibAnswers>{
     "osType": {},
     "checkPath": {

Tasks/NuGetInstallerV0/Tests/singleslnExtraArgs.ts

@@ -13,6 +13,8 @@ nmh.setNugetVersionInputDefault();
 tmr.setInput('solution', 'single.sln');
 tmr.setInput('nuGetRestoreArgs', '-Foo');
 
+process.env['FAIL_DEPRECATED_TASK'] = "true";
+
 let a: ma.TaskLibAnswers = <ma.TaskLibAnswers>{
     "osType": {},
     "checkPath": {

Tasks/NuGetInstallerV0/Tests/singleslnMono.ts

@@ -12,6 +12,8 @@ let nmh: util.NugetMockHelper = new util.NugetMockHelper(tmr, true);
 nmh.setNugetVersionInputDefault();
 tmr.setInput('solution', 'single.sln');
 
+process.env['FAIL_DEPRECATED_TASK'] = "true";
+
 let a: ma.TaskLibAnswers = <ma.TaskLibAnswers>{
     "osType": {
         "osType" : "Linux"

Tasks/NuGetInstallerV0/Tests/singleslnNoCache.ts

@@ -13,6 +13,8 @@ nmh.setNugetVersionInputDefault();
 tmr.setInput('solution', 'single.sln');
 tmr.setInput('noCache', 'True');
 
+process.env['FAIL_DEPRECATED_TASK'] = "true";
+
 let a: ma.TaskLibAnswers = <ma.TaskLibAnswers>{
     "osType": {},
     "checkPath": {

Tasks/NuGetInstallerV0/nugetinstaller.ts

@@ -24,7 +24,7 @@ class RestoreOptions implements INuGetCommandOptions {
 }
 
 async function main(): Promise<void> {
-    tl.warning("This task is deprecated. Builds that use it will break on 11-27-2023. Please switch to using NuGetCommand@2's 'restore' option as soon as possible.");
+    tl.warning(tl.loc("DeprecatedTask"));
     let packagingLocation: pkgLocationUtils.PackagingLocation;
     try {
         packagingLocation = await pkgLocationUtils.getPackagingUris(pkgLocationUtils.ProtocolType.NuGet);
@@ -188,7 +188,14 @@ async function main(): Promise<void> {
             credCleanup();
         }
 
+        let shouldFail = tl.getVariable('FAIL_DEPRECATED_TASK');
+
+	    if (shouldFail != null && shouldFail.toLowerCase() === 'true') {
+	        throw new Error(tl.loc("DeprecatedTask"));
+	    }
+
         tl.setResult(tl.TaskResult.Succeeded, tl.loc("PackagesInstalledSuccessfully"));
+
     } catch (err) {
         tl.error(err);
 

Tasks/NuGetInstallerV0/task.json

@@ -9,7 +9,7 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 0,
-    "Minor": 231,
+    "Minor": 232,
     "Patch": 0
   },
   "runsOn": [
@@ -18,7 +18,7 @@
   ],
   "minimumAgentVersion": "2.115.0",
   "deprecated": true,
-  "removalDate": "2023-11-27",
+  "removalDate": "2023-12-11",
   "groups": [
     {
       "name": "advanced",
@@ -145,6 +145,7 @@
     "NGCommon_RemovingSources": "Preparing to set credentials in NuGet.config",
     "NGCommon_AddingSources": "Setting credentials in NuGet.config",
     "NGCommon_NoSourcesFoundInConfig": "No package sources were found in the NuGet.config file at %s",
-    "NGCommon_UnabletoDetectNuGetVersion": "Unknown NuGet version selected."
+    "NGCommon_UnabletoDetectNuGetVersion": "Unknown NuGet version selected.",
+    "DeprecatedTask": "This task is deprecated. Please switch to using NuGetCommand@2's 'restore' or 'custom' option https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/nuget-command-v2"
   }
 }

Tasks/NuGetInstallerV0/task.loc.json

@@ -9,7 +9,7 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 0,
-    "Minor": 231,
+    "Minor": 232,
     "Patch": 0
   },
   "runsOn": [
@@ -18,7 +18,7 @@
   ],
   "minimumAgentVersion": "2.115.0",
   "deprecated": true,
-  "removalDate": "2023-11-27",
+  "removalDate": "2023-12-11",
   "groups": [
     {
       "name": "advanced",
@@ -145,6 +145,7 @@
     "NGCommon_RemovingSources": "ms-resource:loc.messages.NGCommon_RemovingSources",
     "NGCommon_AddingSources": "ms-resource:loc.messages.NGCommon_AddingSources",
     "NGCommon_NoSourcesFoundInConfig": "ms-resource:loc.messages.NGCommon_NoSourcesFoundInConfig",
-    "NGCommon_UnabletoDetectNuGetVersion": "ms-resource:loc.messages.NGCommon_UnabletoDetectNuGetVersion"
+    "NGCommon_UnabletoDetectNuGetVersion": "ms-resource:loc.messages.NGCommon_UnabletoDetectNuGetVersion",
+    "DeprecatedTask": "ms-resource:loc.messages.DeprecatedTask"
   }
 }

Tasks/NuGetRestoreV1/Strings/resources.resjson/en-US/resources.resjson

@@ -55,5 +55,6 @@
   "loc.messages.Warning_UpdatingNuGetVersion": "Updating version of NuGet.exe to %s from %s. Behavior changes or breaking changes might occur as NuGet updates to a new version. If this is not desired, uncheck the 'Check for Latest Version' option in the task.",
   "loc.messages.UnsupportedProjectScopedFeeds": "Project-scoped feeds are not supported by this version of the \"NuGet Restore\" task. Please use the \"NuGet\" task version 2 or higher.",
   "loc.messages.Warning_IncludeNuGetOrgEnabled": "IncludeNugetOrg is currently enabled for this task. To resolve this warning, edit your build task and set 'includeNuGetOrg' to 'false' or deselect 'Use packages from NuGet.org'.",
-  "loc.messages.Error_IncludeNuGetOrgEnabled": "Packages failed to restore. Edit your build task and set 'includeNuGetOrg' to 'false' or deselect 'Use packages from NuGet.org'."
+  "loc.messages.Error_IncludeNuGetOrgEnabled": "Packages failed to restore. Edit your build task and set 'includeNuGetOrg' to 'false' or deselect 'Use packages from NuGet.org'.",
+  "loc.messages.DeprecatedTask": "This task is deprecated. Please switch to using NuGetCommand@2's 'restore' option https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/nuget-command-v2"
 }