Merge pull request #336 from e-korolevskii/refactor-nuget-cfg-parse

Refactor nuget cfg parse

package-lock.json

@@ -14,9 +14,8 @@
         "@actions/github": "^1.1.0",
         "@actions/http-client": "^2.0.1",
         "@actions/io": "^1.0.2",
-        "fast-xml-parser": "^3.15.1",
+        "fast-xml-parser": "^4.0.10",
-        "semver": "^6.3.0",
+        "semver": "^6.3.0"
-        "xmlbuilder": "^13.0.2"
       },
       "devDependencies": {
         "@types/jest": "^27.0.2",
@@ -1992,12 +1991,14 @@
       "dev": true
     },
     "node_modules/fast-xml-parser": {
-      "version": "3.17.4",
+      "version": "4.0.10",
-      "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-3.17.4.tgz",
+      "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-4.0.10.tgz",
-      "integrity": "sha512-qudnQuyYBgnvzf5Lj/yxMcf4L9NcVWihXJg7CiU1L+oUCq8MUnFEfH2/nXR/W5uq+yvUN1h7z6s7vs2v1WkL1A==",
+      "integrity": "sha512-mYMMIk7Ho1QOiedyvafdyPamn1Vlda+5n95lcn0g79UiCQoLQ2xfPQ8m3pcxBMpVaftYXtoIE2wrNTjmLQnnkg==",
-      "hasInstallScript": true,
+      "dependencies": {
+        "strnum": "^1.0.5"
+      },
       "bin": {
-        "xml2js": "cli.js"
+        "fxparser": "src/cli/cli.js"
       },
       "funding": {
         "type": "paypal",
@@ -4207,6 +4208,11 @@
         "node": ">=6"
       }
     },
+    "node_modules/strnum": {
+      "version": "1.0.5",
+      "resolved": "https://registry.npmjs.org/strnum/-/strnum-1.0.5.tgz",
+      "integrity": "sha512-J8bbNyKKXl5qYcR36TIO8W3mVGVHrmmxsd5PAItGkmyzwJvybiw2IVq5nqd0i4LSNSkB/sx9VHllbfFdr9k1JA=="
+    },
     "node_modules/supports-color": {
       "version": "7.1.0",
       "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz",
@@ -4669,14 +4675,6 @@
       "integrity": "sha512-A5CUptxDsvxKJEU3yO6DuWBSJz/qizqzJKOMIfUJHETbBw/sFaDxgd6fxm1ewUaM0jZ444Fc5vC5ROYurg/4Pw==",
       "dev": true
     },
-    "node_modules/xmlbuilder": {
-      "version": "13.0.2",
-      "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-13.0.2.tgz",
-      "integrity": "sha512-Eux0i2QdDYKbdbA6AM6xE4m6ZTZr4G4xF9kahI2ukSEMCzwce2eX9WlTI5J3s+NU7hpasFsr8hWIONae7LluAQ==",
-      "engines": {
-        "node": ">=6.0"
-      }
-    },
     "node_modules/xmlchars": {
       "version": "2.2.0",
       "resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz",
@@ -6296,9 +6294,12 @@
       "dev": true
     },
     "fast-xml-parser": {
-      "version": "3.17.4",
+      "version": "4.0.10",
-      "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-3.17.4.tgz",
+      "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-4.0.10.tgz",
-      "integrity": "sha512-qudnQuyYBgnvzf5Lj/yxMcf4L9NcVWihXJg7CiU1L+oUCq8MUnFEfH2/nXR/W5uq+yvUN1h7z6s7vs2v1WkL1A=="
+      "integrity": "sha512-mYMMIk7Ho1QOiedyvafdyPamn1Vlda+5n95lcn0g79UiCQoLQ2xfPQ8m3pcxBMpVaftYXtoIE2wrNTjmLQnnkg==",
+      "requires": {
+        "strnum": "^1.0.5"
+      }
     },
     "fb-watchman": {
       "version": "2.0.1",
@@ -7970,6 +7971,11 @@
       "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==",
       "dev": true
     },
+    "strnum": {
+      "version": "1.0.5",
+      "resolved": "https://registry.npmjs.org/strnum/-/strnum-1.0.5.tgz",
+      "integrity": "sha512-J8bbNyKKXl5qYcR36TIO8W3mVGVHrmmxsd5PAItGkmyzwJvybiw2IVq5nqd0i4LSNSkB/sx9VHllbfFdr9k1JA=="
+    },
     "supports-color": {
       "version": "7.1.0",
       "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz",
@@ -8301,11 +8307,6 @@
       "integrity": "sha512-A5CUptxDsvxKJEU3yO6DuWBSJz/qizqzJKOMIfUJHETbBw/sFaDxgd6fxm1ewUaM0jZ444Fc5vC5ROYurg/4Pw==",
       "dev": true
     },
-    "xmlbuilder": {
-      "version": "13.0.2",
-      "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-13.0.2.tgz",
-      "integrity": "sha512-Eux0i2QdDYKbdbA6AM6xE4m6ZTZr4G4xF9kahI2ukSEMCzwce2eX9WlTI5J3s+NU7hpasFsr8hWIONae7LluAQ=="
-    },
     "xmlchars": {
       "version": "2.2.0",
       "resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz",

package.json

@@ -29,9 +29,8 @@
     "@actions/github": "^1.1.0",
     "@actions/http-client": "^2.0.1",
     "@actions/io": "^1.0.2",
-    "fast-xml-parser": "^3.15.1",
+    "fast-xml-parser": "^4.0.10",
-    "semver": "^6.3.0",
+    "semver": "^6.3.0"
-    "xmlbuilder": "^13.0.2"
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",

src/authutil.ts

@@ -2,8 +2,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as core from '@actions/core';
 import * as github from '@actions/github';
-import * as xmlbuilder from 'xmlbuilder';
+import {XMLParser, XMLBuilder} from 'fast-xml-parser';
-import * as xmlParser from 'fast-xml-parser';
 
 export function configAuthentication(
   feedUrl: string,
@@ -49,7 +48,6 @@ function writeFeedToFile(
   core.info(
     `dotnet-auth: Finding any source references in ${existingFileLocation}, writing a new temporary configuration file with credentials to ${tempFileLocation}`
   );
-  let xml: xmlbuilder.XMLElement;
   let sourceKeys: string[] = [];
   let owner: string = core.getInput('owner');
   let sourceUrl: string = feedUrl;
@@ -66,64 +64,90 @@ function writeFeedToFile(
   if (fs.existsSync(existingFileLocation)) {
     // get key from existing NuGet.config so NuGet/dotnet can match credentials
     const curContents: string = fs.readFileSync(existingFileLocation, 'utf8');
-    const json = xmlParser.parse(curContents, {ignoreAttributes: false});
+
+    const parserOptions = {
+      ignoreAttributes: false
+    };
+    const parser = new XMLParser(parserOptions);
+    const json = parser.parse(curContents);
 
     if (typeof json.configuration === 'undefined') {
       throw new Error(`The provided NuGet.config seems invalid.`);
     }
-    if (typeof json.configuration.packageSources != 'undefined') {
+    if (json.configuration?.packageSources?.add) {
-      if (typeof json.configuration.packageSources.add != 'undefined') {
+      const packageSources = json.configuration.packageSources.add;
-        // file has at least one <add>
+
-        if (typeof json.configuration.packageSources.add[0] === 'undefined') {
+      if (Array.isArray(packageSources)) {
-          // file has only one <add>
+        packageSources.forEach(source => {
-          if (
+          const value = source['@_value'];
-            json.configuration.packageSources.add['@_value']
+          core.debug(`source '${value}'`);
-              .toLowerCase()
+          if (value.toLowerCase().includes(feedUrl.toLowerCase())) {
-              .includes(feedUrl.toLowerCase())
+            const key = source['@_key'];
-          ) {
-            const key = json.configuration.packageSources.add['@_key'];
             sourceKeys.push(key);
             core.debug(`Found a URL with key ${key}`);
           }
-        } else {
+        });
-          // file has 2+ <add>
+      } else {
-          for (
+        if (
-            let i = 0;
+          packageSources['@_value']
-            i < json.configuration.packageSources.add.length;
+            .toLowerCase()
-            i++
+            .includes(feedUrl.toLowerCase())
-          ) {
+        ) {
-            const source = json.configuration.packageSources.add[i];
+          const key = packageSources['@_key'];
-            const value = source['@_value'];
+          sourceKeys.push(key);
-            core.debug(`source '${value}'`);
+          core.debug(`Found a URL with key ${key}`);
-            if (value.toLowerCase().includes(feedUrl.toLowerCase())) {
-              const key = source['@_key'];
-              sourceKeys.push(key);
-              core.debug(`Found a URL with key ${key}`);
-            }
-          }
         }
       }
     }
   }
 
-  xml = xmlbuilder
+  const xmlSource: any[] = [
-    .create('configuration')
+    {
-    .ele('config')
+      '?xml': [
-    .ele('add', {key: 'defaultPushSource', value: sourceUrl})
+        {
-    .up()
+          '#text': ''
-    .up();
+        }
+      ],
+      ':@': {
+        '@_version': '1.0'
+      }
+    },
+    {
+      configuration: [
+        {
+          config: [
+            {
+              add: [],
+              ':@': {
+                '@_key': 'defaultPushSource',
+                '@_value': sourceUrl
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ];
 
   if (!sourceKeys.length) {
     let keystring = 'Source';
-    xml = xml
+
-      .ele('packageSources')
+    xmlSource[1].configuration.push({
-      .ele('add', {key: keystring, value: sourceUrl})
+      packageSources: [
-      .up()
+        {
-      .up();
+          add: [],
+          ':@': {
+            '@_key': keystring,
+            '@_value': sourceUrl
+          }
+        }
+      ]
+    });
+
     sourceKeys.push(keystring);
   }
-  xml = xml.ele('packageSourceCredentials');
 
+  const packageSourceCredentials: any[] = [];
   sourceKeys.forEach(key => {
     if (!isValidKey(key)) {
       throw new Error(
@@ -131,24 +155,42 @@ function writeFeedToFile(
       );
     }
 
-    xml = xml
+    packageSourceCredentials.push({
-      .ele(key)
+      [key]: [
-      .ele('add', {key: 'Username', value: owner})
+        {
-      .up()
+          add: [],
-      .ele('add', {
+          ':@': {
-        key: 'ClearTextPassword',
+            '@_key': 'Username',
-        value: process.env.NUGET_AUTH_TOKEN
+            '@_value': owner
-      })
+          }
-      .up()
+        },
-      .up();
+        {
+          add: [],
+          ':@': {
+            '@_key': 'ClearTextPassword',
+            '@_value': process.env.NUGET_AUTH_TOKEN
+          }
+        }
+      ]
+    });
   });
 
-  // If NuGet fixes itself such that on Linux it can look for environment variables in the config file (it doesn't seem to work today),
+  xmlSource[1].configuration.push({
-  // use this for the value above
+    packageSourceCredentials
-  //           process.platform == 'win32'
+  });
-  //             ? '%NUGET_AUTH_TOKEN%'
+
-  //             : '$NUGET_AUTH_TOKEN'
+  const xmlBuilderOptions = {
+    format: true,
+    ignoreAttributes: false,
+    preserveOrder: true,
+    allowBooleanAttributes: true,
+    suppressBooleanAttributes: true,
+    suppressEmptyNode: true
+  };
+
+  const builder = new XMLBuilder(xmlBuilderOptions);
+
+  const output = builder.build(xmlSource).trim();
 
-  const output = xml.end({pretty: true});
   fs.writeFileSync(tempFileLocation, output);
 }