Completed the attribute support for servers. (#95)

* Completed the attribute support for servers, and password is optional. Resolves #92.

* Updated oracleServers.xml template to match new servers.xml template.

* Revised tests to match code and template changes.

* Added documentation for server attributes.

* Added additional use cases to exercise server attribute handling.

README.md

@@ -40,6 +40,18 @@ steps:
     servers: '[{"id": "serverId", "username": "username", "password": "password"}]'
 ```
 
+All `server` attributes may be specified:
+  * `id` _(required)_
+  * `username`
+  * `password`
+  * `privateKey`
+  * `passphrase`
+  * `filePermissions`
+  * `directoryPermissions`
+  * `configuration`
+
+Please refer to the [servers](http://maven.apache.org/settings.html#Servers) documentation for more information.
+
 ## ```settings.xml``` with servers section and additional configuration
 
 ``` yml

index.test.js

@@ -63,11 +63,11 @@ afterAll(() => {
 
 test('run with all feature', () => {
 
-    process.env['INPUT_SERVERS'] =  '[{"id": "serverId", "username": "sUsername", "password": "sPassword", "configuration": {"props1": "value1"}}]';
+    process.env['INPUT_SERVERS'] = '[{"id": "serverId", "username": "sUsername", "password": "sPassword", "configuration": {"props1": "value1"}}]';
-    process.env['INPUT_ORACLESERVERS'] =  '[{"id": "oServerId", "username": "oUsername", "password": "oPassword"}]';
+    process.env['INPUT_ORACLESERVERS'] = '[{"id": "oServerId", "username": "oUsername", "password": "oPassword"}]';
-    process.env['INPUT_GITHUBSERVER'] =  true;
+    process.env['INPUT_GITHUBSERVER'] = true;
 
-    process.env['INPUT_MIRRORS'] =  '[{"id": "mirrorId", "name": "mirror Name", "mirrorOf": "mirror Off *", "url": "mirror url"}]';
+    process.env['INPUT_MIRRORS'] = '[{"id": "mirrorId", "name": "mirror Name", "mirrorOf": "mirror Off *", "url": "mirror url"}]';
     process.env['INPUT_PROPERTIES'] = '[{"prop1": "value1"}, {"prop2": "value2"}]'
 
     process.env['INPUT_APACHESNAPSHOTS'] = true;
@@ -80,7 +80,7 @@ test('run with all feature', () => {
     expect(settingsStatus.isFile()).toBeTruthy();
     expect(settingsStatus.size).toBeGreaterThan(0);
 
-    const settingsBody = fs.readFileSync(settingsPath).toString().replace(/^    $/mg, '');
+    const settingsBody = fs.readFileSync(settingsPath).toString().replace(/^\s*$(?:\r\n?|\n)/gm, '');
     expect(settingsBody).toBe(`<settings>
     <interactiveMode>false</interactiveMode>
     <profiles>
@@ -214,7 +214,6 @@ test('run with all feature', () => {
     <id>github</id>
     <username>\${env.GITHUB_ACTOR}</username>
     <password>\${env.GITHUB_TOKEN}</password>
-
 </server></servers>
     <mirrors>
 <mirror>

settings.js

@@ -54,7 +54,7 @@ function jsonToXml(templateXml, xmlTag, json) {
     for (const key in json) {
         const keyXml = templateXml.createElement(key);
         const value = json[key];
-        if ( value instanceof Object) {
+        if (value instanceof Object) {
             jsonToXml(templateXml, keyXml, value);
         } else {
             keyXml.textContent = value;
@@ -63,28 +63,32 @@ function jsonToXml(templateXml, xmlTag, json) {
     }
 }
 
-function fillServer(templateXml, templateName, id, username, password, configurations) {
+function fillServer(templateXml, templateName, id, username, password, privateKey, passphrase, filePermissions, directoryPermissions, configurations) {
 
-    if (!id || ((!username || !password) && !configurations) ) {
+    if (!id || (!username && !configurations)) {
-        core.setFailed(templateName + ' must contain id, (username and password) or configuration');
+        core.setFailed(templateName + ' must contain id, and username or configuration');
         return;
     }
 
     const serverXml = getTemplate(templateName + '.xml')
     serverXml.getElementsByTagName('id')[0].textContent = id;
 
-    const usernameTag = serverXml.getElementsByTagName('username')[0];
+    const serverTags = {
-    if (username) {
+        'username': username,
-        usernameTag.textContent = username;
+        'password': password,
-    } else {
+        'privateKey': privateKey,
-        serverXml.documentElement.removeChild(usernameTag);
+        'passphrase': passphrase,
-    }
+        'filePermissions': filePermissions,
-
+        'directoryPermissions': directoryPermissions
-    const passwordTag = serverXml.getElementsByTagName('password')[0];
+    };
-    if (password) {
+    for (const tag in serverTags) {
-        passwordTag.textContent = password;
+        const serverTag = serverXml.getElementsByTagName(tag)[0];
-    } else {
+        const tagValue = serverTags[tag];
-        serverXml.documentElement.removeChild(passwordTag);
+        if (tagValue) {
+            serverTag.textContent = tagValue;
+        } else {
+            serverXml.documentElement.removeChild(serverTag);
+        }
     }
 
     const configurationTag = serverXml.getElementsByTagName('configuration')[0];
@@ -109,7 +113,10 @@ function fillServers(template, templateName) {
     }
 
     JSON.parse(servers).forEach((server) =>
-        fillServer(template, templateName, server.id, server.username, server.password, server.configuration));
+        fillServer(template, templateName, server.id, server.username,
+            server.password, server.privateKey, server.passphrase,
+            server.filePermissions, server.directoryPermissions,
+            server.configuration));
 }
 
 function fillMirror(template, id, name, mirrorOf, url) {

settings.test.js

@@ -38,6 +38,14 @@ const settingsPath = path.join(testHomePath, '.m2', 'settings.xml');
 
 var consoleOutput = [];
 
+function stringAsXml(str) {
+    return new DOMParser().parseFromString(str, 'text/xml');
+}
+
+function xmlAsString(xml) {
+    return new XMLSerializer().serializeToString(xml).replace(/^\s*$(?:\r\n?|\n)/gm, '');
+}
+
 beforeAll(() => {
     if (!fs.existsSync(testHomePath)) {
         fs.mkdirSync(testHomePath);
@@ -51,7 +59,7 @@ beforeAll(() => {
 });
 
 beforeEach(() => {
-    xmlTestProfile = new DOMParser().parseFromString(`<settings>
+    xmlTestProfile = stringAsXml(`<settings>
         <profiles>
             <profile>
                 <id>_properties_</id>
@@ -119,7 +127,7 @@ test('xml should be write', () => {
 
 test('fillServers do nothing if no params', () => {
 
-    const xml = new DOMParser().parseFromString("<servers/>");
+    const xml = stringAsXml("<servers/>");
 
     settings.fillServers(xml, 'servers');
 
@@ -130,54 +138,46 @@ test('fillServers do nothing if no params', () => {
 
 test('fillServers one server', () => {
 
-    const xml = new DOMParser().parseFromString("<servers/>");
+    const xml = stringAsXml("<servers/>");
 
     process.env['INPUT_SERVERS'] = '[{"id": "id1", "username": "username1", "password":"password1"}]';
 
     settings.fillServers(xml, 'servers');
 
-    const xmlStr = new XMLSerializer().serializeToString(xml).replace(/^    $/mg, '');
+    expect(xmlAsString(xml)).toBe(`<servers>
-
-    expect(xmlStr).toBe(`<servers>
 <server>
     <id>id1</id>
     <username>username1</username>
     <password>password1</password>
-
 </server></servers>`);
 
 });
 
 test('fillServers with username and configuration', () => {
 
-    const xml = new DOMParser().parseFromString("<servers/>");
+    const xml = stringAsXml("<servers/>");
 
     process.env['INPUT_SERVERS'] = '[{"id": "id1", "username": "username", "configuration": {"prop1": "prop1Value", "prop2": "prop2Value"}}]';
 
     settings.fillServers(xml, 'servers');
 
-    const xmlStr = new XMLSerializer().serializeToString(xml).replace(/^    $/mg, '')
+    expect(xmlAsString(xml)).toBe(`<servers>
-
-    expect(xmlStr).toBe(`<servers>
 <server>
     <id>id1</id>
     <username>username</username>
-
     <configuration><prop1>prop1Value</prop1><prop2>prop2Value</prop2></configuration>
 </server></servers>`);
 });
 
 test('fillServers with username, password and configuration', () => {
 
-    const xml = new DOMParser().parseFromString("<servers/>");
+    const xml = stringAsXml("<servers/>");
 
     process.env['INPUT_SERVERS'] = '[{"id": "id1", "username": "username", "password": "password", "configuration": {"prop1": "prop1Value", "prop2": "prop2Value"}}]';
 
     settings.fillServers(xml, 'servers');
 
-    const xmlStr = new XMLSerializer().serializeToString(xml).replace(/^    $/mg, '')
+    expect(xmlAsString(xml)).toBe(`<servers>
-
-    expect(xmlStr).toBe(`<servers>
 <server>
     <id>id1</id>
     <username>username</username>
@@ -186,73 +186,115 @@ test('fillServers with username, password and configuration', () => {
 </server></servers>`);
 });
 
+test('fillServers with username, privateKey', () => {
+
+    const xml = stringAsXml("<servers/>");
+
+    process.env['INPUT_SERVERS'] = '[{"id": "id1", "username": "username", "privateKey": "${user.home}/.ssh/id_rsa"}]';
+
+    settings.fillServers(xml, 'servers');
+
+    expect(xmlAsString(xml)).toBe(`<servers>
+<server>
+    <id>id1</id>
+    <username>username</username>
+    <privateKey>\${user.home}/.ssh/id_rsa</privateKey>
+</server></servers>`);
+});
+
+test('fillServers with username, privateKey, and passphrase', () => {
+
+    const xml = stringAsXml("<servers/>");
+
+    process.env['INPUT_SERVERS'] = '[{"id": "id1", "username": "username", "privateKey": "${user.home}/.ssh/id_rsa", "passphrase": "secret"}]';
+
+    settings.fillServers(xml, 'servers');
+
+    expect(xmlAsString(xml)).toBe(`<servers>
+<server>
+    <id>id1</id>
+    <username>username</username>
+    <privateKey>\${user.home}/.ssh/id_rsa</privateKey>
+    <passphrase>secret</passphrase>
+</server></servers>`);
+});
+
+test('fillServers with all attributes', () => {
+
+    const xml = stringAsXml("<servers/>");
+
+    process.env['INPUT_SERVERS'] = '[{"id": "server001", "username": "my_login", "password": "my_password", "privateKey": "${user.home}/.ssh/id_dsa", "passphrase": "some_passphrase", "filePermissions": "664", "directoryPermissions": "775", "configuration": {"prop1": "prop1Value", "prop2": "prop2Value"} }]';
+
+    settings.fillServers(xml, 'servers');
+
+    expect(xmlAsString(xml)).toBe(`<servers>
+<server>
+    <id>server001</id>
+    <username>my_login</username>
+    <password>my_password</password>
+    <privateKey>\${user.home}/.ssh/id_dsa</privateKey>
+    <passphrase>some_passphrase</passphrase>
+    <filePermissions>664</filePermissions>
+    <directoryPermissions>775</directoryPermissions>
+    <configuration><prop1>prop1Value</prop1><prop2>prop2Value</prop2></configuration>
+</server></servers>`);
+});
+
 test('fillServers with configuration', () => {
 
-    const xml = new DOMParser().parseFromString("<servers/>");
+    const xml = stringAsXml("<servers/>");
 
     process.env['INPUT_SERVERS'] = '[{"id": "id1", "configuration": {"prop1": "prop1Value", "prop2": "prop2Value"}}]';
 
     settings.fillServers(xml, 'servers');
 
-    const xmlStr = new XMLSerializer().serializeToString(xml).replace(/^    $/mg, '')
+    expect(xmlAsString(xml)).toBe(`<servers>
-
-    expect(xmlStr).toBe(`<servers>
 <server>
     <id>id1</id>
-
-
     <configuration><prop1>prop1Value</prop1><prop2>prop2Value</prop2></configuration>
 </server></servers>`);
 });
 
 test('fillServers with configuration subLevel', () => {
 
-    const xml = new DOMParser().parseFromString("<servers/>");
+    const xml = stringAsXml("<servers/>");
 
     process.env['INPUT_SERVERS'] = '[{"id": "id1", "configuration": {"prop1": {"prop11": "value11", "prop12": "value12"}, "prop2": "value2"}}]';
 
     settings.fillServers(xml, 'servers');
 
-    const xmlStr = new XMLSerializer().serializeToString(xml).replace(/^    $/mg, '')
+    expect(xmlAsString(xml)).toBe(`<servers>
-
-    expect(xmlStr).toBe(`<servers>
 <server>
     <id>id1</id>
-
-
     <configuration><prop1><prop11>value11</prop11><prop12>value12</prop12></prop1><prop2>value2</prop2></configuration>
 </server></servers>`);
 });
 
 test('fillServers two servers', () => {
 
-    const xml = new DOMParser().parseFromString("<servers/>");
+    const xml = stringAsXml("<servers/>");
 
     process.env['INPUT_SERVERS'] = '[{"id": "id1", "username": "username1", "password":"password1"},\
         {"id": "id2", "username": "username2", "password":"password2"}]';
 
     settings.fillServers(xml, 'servers');
 
-    const xmlStr = new XMLSerializer().serializeToString(xml).replace(/^    $/mg, '');
+    expect(xmlAsString(xml)).toBe(`<servers>
-
-    expect(xmlStr).toBe(`<servers>
 <server>
     <id>id1</id>
     <username>username1</username>
     <password>password1</password>
-
 </server>
 <server>
     <id>id2</id>
     <username>username2</username>
     <password>password2</password>
-
 </server></servers>`);
 });
 
 test('fill servers incorrect fields', () => {
 
-    const xml = new DOMParser().parseFromString("<servers/>");
+    const xml = stringAsXml("<servers/>");
 
     process.env['INPUT_SERVERS'] = '[{"idx": "id1"}]';
 
@@ -263,22 +305,20 @@ test('fill servers incorrect fields', () => {
     expect(xmlStr).toBe('<servers/>');
     expect(consoleOutput).toEqual(
         expect.arrayContaining([
-            expect.stringMatching(/::error::servers must contain id, \(username and password\) or configuration/)
+            expect.stringMatching(/::error::servers must contain id, and username or configuration/)
         ])
     );
 });
 
 test('fill oracleServers', () => {
 
-    const xml = new DOMParser().parseFromString("<servers/>");
+    const xml = stringAsXml("<servers/>");
 
     process.env['INPUT_ORACLESERVERS'] = '[{"id": "id1", "username": "username1", "password":"password1"}]';
 
     settings.fillServers(xml, 'oracleServers');
 
-    const xmlStr = new XMLSerializer().serializeToString(xml);
+    expect(xmlAsString(xml)).toBe(`<servers>
-
-    expect(xmlStr).toBe(`<servers>
 <server>
     <id>id1</id>
     <username>username1</username>
@@ -305,27 +345,24 @@ test('fill oracleServers', () => {
 
 test('fillServers github', () => {
 
-    const xml = new DOMParser().parseFromString("<servers/>");
+    const xml = stringAsXml("<servers/>");
 
     process.env['INPUT_GITHUBSERVER'] = 'true';
 
     settings.fillServerForGithub(xml);
 
-    const xmlStr = new XMLSerializer().serializeToString(xml).replace(/^    $/mg, '');
+    expect(xmlAsString(xml)).toBe(`<servers>
-
-    expect(xmlStr).toBe(`<servers>
 <server>
     <id>github</id>
     <username>\${env.GITHUB_ACTOR}</username>
     <password>\${env.GITHUB_TOKEN}</password>
-
 </server></servers>`);
     expect(consoleOutput).toEqual([]);
 });
 
 test('fillMirrors do nothing if no params', () => {
 
-    const xml = new DOMParser().parseFromString("<mirrors/>");
+    const xml = stringAsXml("<mirrors/>");
 
     settings.fillMirrors(xml);
 
@@ -337,7 +374,7 @@ test('fillMirrors do nothing if no params', () => {
 
 test('fillMirrors one mirror', () => {
 
-    const xml = new DOMParser().parseFromString("<mirrors/>");
+    const xml = stringAsXml("<mirrors/>");
 
     process.env['INPUT_MIRRORS'] = '[{"id": "id1", "name": "name", "mirrorOf":"mirrorOf", "url":"url"}]';
 
@@ -357,7 +394,7 @@ test('fillMirrors one mirror', () => {
 
 test('fillMirrors two mirrors', () => {
 
-    const xml = new DOMParser().parseFromString("<mirrors/>");
+    const xml = stringAsXml("<mirrors/>");
 
     process.env['INPUT_MIRRORS'] = '[{"id": "id1", "name": "name1", "mirrorOf":"mirrorOf1", "url":"url1"},{"id": "id2", "name": "name2", "mirrorOf":"mirrorOf2", "url":"url2"}]';
 
@@ -383,7 +420,7 @@ test('fillMirrors two mirrors', () => {
 
 test('fillMirrors incorrect fields', () => {
 
-    const xml = new DOMParser().parseFromString("<mirrors/>");
+    const xml = stringAsXml("<mirrors/>");
 
     process.env['INPUT_MIRRORS'] = '[{"idx": "id1"}]';
 
@@ -403,7 +440,7 @@ test('addApacheSnapshots', () => {
 
     process.env['INPUT_APACHESNAPSHOTS'] = "true";
 
-    const xml = new DOMParser().parseFromString('<profiles/>');
+    const xml = stringAsXml('<profiles/>');
 
     settings.addApacheSnapshots(xml);
 
@@ -445,7 +482,7 @@ test('addSonatypeSnapshots', () => {
 
     process.env['INPUT_SONATYPESNAPSHOTS'] = "true";
 
-    const xml = new DOMParser().parseFromString('<profiles/>');
+    const xml = stringAsXml('<profiles/>');
 
     settings.addSonatypeSnapshots(xml);
 
@@ -487,7 +524,7 @@ test('addOracleRepo', () => {
 
     process.env['INPUT_ORACLEREPO'] = "true";
 
-    const xml = new DOMParser().parseFromString('<profiles/>');
+    const xml = stringAsXml('<profiles/>');
 
     settings.addOracleRepo(xml);
 
@@ -529,7 +566,7 @@ test('fillProperties', () => {
 
     process.env['INPUT_PROPERTIES'] = '[{"propertyName1": "propertyValue1"}, {"propertyName2": "propertyValue2"}]';
 
-    const xml = new DOMParser().parseFromString('<profiles/>');
+    const xml = stringAsXml('<profiles/>');
 
     settings.fillProperties(xml);
 

templates/oracleServers.xml

@@ -3,6 +3,10 @@
     <id />
     <username />
     <password />
+    <privateKey />
+    <passphrase />
+    <filePermissions />
+    <directoryPermissions />
     <configuration>
         <basicAuthScope>
             <host>ANY</host>

templates/servers.xml

@@ -3,5 +3,9 @@
     <id />
     <username />
     <password />
+    <privateKey />
+    <passphrase />
+    <filePermissions />
+    <directoryPermissions />
     <configuration />
 </server>