Updating MavenAuthenticateV0 to allow new service connection type (#20229)

* Updating MavenAuthenticateV0 to allow new service connection type

* Updated task.loc.json to not use str literals

* Updated L0 tests to be compatible with mockery and generated wif version

* Updated username for service connection and task version

* Wrapping wif code

* Reorganized code to authenticate federated connection first and then other connections if there is none

* Specifying os type even for empty input test

* Using additional feedName input for auth id and checked task works with new service connection

* Parsing url for feed name

* Added example feed url and check for both feed url and entra connection

* Matching task.loc.json files

* Updated task str's

* Updated maven auth for cfs compliance

* Updated other task components since removing feedUrl

* task.loc.json needs full string

* Updated task version for BuildConfigGen

* Trying to match task.loc.json files for WIF

* Updated str's

* Matched task.loc.json strings

* Using dependency range and sp guid for wif username

* Reusing utils method for wif registries

* Going back one commit

---------

Co-authored-by: Abby Powell <[email protected]>

Author: amp-powell

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

@@ -3,17 +3,23 @@
   "loc.helpMarkDown": "[Learn more about this task](https://docs.microsoft.com/azure/devops/pipelines/tasks/package/maven-authenticate)",
   "loc.description": "Provides credentials for Azure Artifacts feeds and external maven repositories",
   "loc.instanceNameFormat": "Maven Authenticate",
+  "loc.input.label.workloadIdentityServiceConnection": "'Entra Workload ID-backed Azure DevOps user' Service Connection",
+  "loc.input.help.workloadIdentityServiceConnection": "This is an Entra Workload ID-backed Azure DevOps user Service Connection. If this is set, the input mavenServiceConnections will be ignored.",
   "loc.input.label.artifactsFeeds": "Feeds",
   "loc.input.label.mavenServiceConnections": "Credentials for repositories outside this organization/collection",
   "loc.input.help.mavenServiceConnections": "Credentials to use for external repositories located in the project's pom.xml.",
   "loc.messages.Warning_FeedEntryAlreadyExists": "The settings for the feed or repository '%s' already exists in the users settings.xml file.",
   "loc.messages.Warning_NoEndpointsToAuth": "No repositories were selected to authenticate, please check your task configuration.",
+  "loc.messages.Warning_TokenNotGenerated": "Unable to use a federated token",
   "loc.messages.Info_GeneratingExternalRepositories": "Generating configs for %s external repositories.",
   "loc.messages.Info_GeneratingInternalFeeds": "Generating configs for %s internal feeds.",
   "loc.messages.Info_M2FolderDoesntExist": ".m2 folder not found at location %s, creating new folder.",
   "loc.messages.Info_SettingsXmlRead": "Adding authentication to settings file %s.",
   "loc.messages.Info_CreatingSettingsXml": "Creating new settings.xml at path %s.",
   "loc.messages.Info_WritingToSettingsXml": "Writing new settings.xml with added authentication.",
+  "loc.messages.Info_AddingFederatedFeedAuth": "Adding auth information from federated service connection %s for feed %s",
+  "loc.messages.Info_SuccessAddingFederatedFeedAuth": "Successfully added auth for feed %s with federated credentials.",
   "loc.messages.Error_InvalidServiceConnection": "The service connection for %s is invalid.",
-  "loc.messages.Error_FailedCleanupM2": "Failed to delete credentials from the user settings.xml file: %s"
+  "loc.messages.Error_FailedCleanupM2": "Failed to delete credentials from the user settings.xml file: %s",
+  "loc.messages.Error_FailedToGetServiceConnectionAuth": "Unable to get federated credentials from service connection: %s."
 }

Tasks/MavenAuthenticateV0/Tests/L0.ts

@@ -19,32 +19,32 @@ describe("authenticate azure artifacts feeds for maven", function() {
     this.timeout(parseInt(process.env.TASK_TEST_TIMEOUT) || 20000);
     var env;
 
-    this.beforeAll(() => {
+    this.beforeAll(async () => {
         env = Object.assign({}, process.env);
         process.env["USERPROFILE"] = testUserHomeDir;
         process.env["HOME"] = testUserHomeDir;
     });
 
-    beforeEach(() => {
+    beforeEach(async () => {
         tl.mkdirP(m2DirPath);
     })
 
-    this.afterAll(() => {
+    this.afterAll(async () => {
         process.env = env;
     })
 
-    afterEach(() => {
+    afterEach(async () => {
         tl.rmRF(m2DirPath);
     });
 
-    it("it should create a new settings.xml in the .m2 folder and add auth for 1 feed.", (done: MochaDone) => {
+    it("it should create a new settings.xml in the .m2 folder and add auth for 1 feed.", async () => {
         this.timeout(1000);
 
         let tp: string = path.join(__dirname, "L0AuthSettingsXml.js");
 
         let tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
 
-        tr.run();
+        await tr.runAsync();
 
         assert.equal(tl.ls(null, [m2DirPath]).length, 1, "Should have one file.");
         const settingsXmlStats = tl.stats(settingsXmlPath);
@@ -58,11 +58,9 @@ describe("authenticate azure artifacts feeds for maven", function() {
 
         assert(tr.stderr.length === 0, "should not have written to stderr");
         assert(tr.succeeded, "task should have succeeded");
-
-        done();
     });
 
-    it("it should read the existing settings.xml and add auth for 1 new feed", (done: Mocha.Done) => {
+    it("it should read the existing settings.xml and add auth for 1 new feed", async () => {
         this.timeout(1000);
 
         let tp: string = path.join(__dirname, "L0AuthSettingsXmlExists.js");
@@ -71,7 +69,7 @@ describe("authenticate azure artifacts feeds for maven", function() {
 
         tl.cp(settingsOtherFeedName, settingsXmlPath);
 
-        tr.run();
+        await tr.runAsync();
 
         assert.equal(tl.ls(null, [m2DirPath]).length, 1, "Should have one file.");
         const settingsXmlStats = tl.stats(settingsXmlPath);
@@ -86,11 +84,9 @@ describe("authenticate azure artifacts feeds for maven", function() {
 
         assert(tr.stderr.length === 0, "should not have written to stderr");
         assert(tr.succeeded, "task should have succeeded");
-
-        done();
     });
 
-    it("it should read the existing settings.xml and not add any new entries.", (done: Mocha.Done) => {
+    it("it should read the existing settings.xml and not add any new entries.", async () => {
         this.timeout(1000);
 
         let tp: string = path.join(__dirname, "L0AuthSettingsXmlExists.js");
@@ -99,7 +95,7 @@ describe("authenticate azure artifacts feeds for maven", function() {
 
         tl.cp(settingsFeedName1, settingsXmlPath);
 
-        tr.run();
+        await tr.runAsync();
 
         assert.equal(tl.ls(null, [m2DirPath]).length, 1, "Should have one file.");
         const settingsXmlStats = tl.stats(settingsXmlPath);
@@ -112,20 +108,18 @@ describe("authenticate azure artifacts feeds for maven", function() {
         assert.equal(data.match(/<id>feedName1<\/id>/gi).length, 1, "Only one id entry should be present.");
 
         assert(tr.stderr.length === 0, "should not have written to stderr");
-        assert(tr.stdOutContained("vso[task.issue type=warning;]loc_mock_Warning_FeedEntryAlreadyExists"), "Entry already exists warning should be displayed");
+        assert(tr.stdOutContained("vso[task.issue type=warning;source=TaskInternal;]loc_mock_Warning_FeedEntryAlreadyExists"), "Entry already exists warning should be displayed");
         assert(tr.succeeded, "task should have succeeded");
-
-        done();
     });
 
-    it("it should create a new settings.xml in the .m2 folder and add auth for 3 different types of service connections.", (done: Mocha.Done) => {
+    it("it should create a new settings.xml in the .m2 folder and add auth for 3 different types of service connections.", async () => {
         this.timeout(1000);
 
         let tp: string = path.join(__dirname, "L0ServiceConnections.js");
 
         let tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
 
-        tr.run();
+        await tr.runAsync();
 
         assert.equal(tl.ls(null, [m2DirPath]).length, 1, "Should have one file.");
         const settingsXmlStats = tl.stats(settingsXmlPath);
@@ -151,25 +145,21 @@ describe("authenticate azure artifacts feeds for maven", function() {
 
         assert(tr.stderr.length === 0, "should not have written to stderr");
         assert(tr.succeeded, "task should have succeeded");
-
-        done();
     });
 
-    it("it should warn if no inputs are provided.", (done: Mocha.Done) => {
+    it("it should warn if no inputs are provided.", async () => {
         this.timeout(1000);
 
         let tp: string = path.join(__dirname, "L0EmptyInput.js");
 
         let tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
 
-        tr.run();
+        await tr.runAsync();
 
         assert.equal(tl.ls(null, [m2DirPath]).length, 0, "Settings.xml file should not be created.");
 
         assert(tr.stderr.length === 0, "should not have written to stderr");
         assert(tr.succeeded, "task should have succeeded");
-        assert(tr.stdOutContained("vso[task.issue type=warning;]loc_mock_Warning_NoEndpointsToAuth"), "No endpoints warning should be displayed");
-
-        done();
+        assert(tr.stdOutContained("vso[task.issue type=warning;source=TaskInternal;]loc_mock_Warning_NoEndpointsToAuth"), "The no endpoints warning should be displayed");
     });
 });

Tasks/MavenAuthenticateV0/Tests/L0EmptyInput.ts

@@ -16,4 +16,10 @@ let mockApi = {
 };
 tr.registerMock('azure-pipelines-tasks-artifacts-common/webapi', mockApi);
 
+tr.setAnswers({
+    osType: {
+        "osType": "Windows NT"
+    }
+});
+
 tr.run();