Merge remote-tracking branch 'origin/master' into releases/v2

Add mirror support

.github/workflows/audit.yml

@@ -0,0 +1,27 @@
+name: "Audit"
+on:
+  pull_request:
+  push:
+    branches-ignore:
+      - 'dependabot/*'
+  schedule:
+    - cron: '09 22 * * *'
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
+
+    - run: npm version
+    - run: npm ci
+    - run: npm audit

.github/workflows/test.yml

@@ -1,7 +1,9 @@
-name: "Test Action"
+name: "Test"
 on:
   pull_request:
   push:
+    branches-ignore:
+      - 'dependabot/*'
   schedule:
     - cron: '22 22 * * 5'
 
@@ -26,13 +28,13 @@ jobs:
 
     - run: npm version
     - run: npm ci
-    - run: npm audit
     - run: npm test
 
     - uses: ./
       with:
-        servers: '[{"id": "serverId", "username": "username", "password": "password"}]'
+        servers:    '[{"id": "serverId", "username": "username", "password": "password"}]'
         properties: '[{"prop1": "value1"}, {"prop2": "value2"}]'
+        mirrors:    '[{"id": "mirrorId", "name": "mirrorName", "mirrorOf": "mirrorOf", "url": "mirrorUrl"}]'
         sonatypeSnapshots: true
 
     - run: cat ~/.m2/settings.xml

.gitignore

@@ -3,6 +3,7 @@
 
 # Editors
 .vscode
+.idea
 
 # Logs
 logs

README.md

@@ -1,5 +1,7 @@
 # maven-settings-action
-[![Test Action](https://github.com/s4u/maven-settings-action/workflows/Test%20Action/badge.svg)](https://github.com/s4u/maven-settings-action/actions)
+[![Test](https://github.com/s4u/maven-settings-action/workflows/Test/badge.svg)](https://github.com/s4u/maven-settings-action/actions?query=workflow%3ATest)
+[![Audit](https://github.com/s4u/maven-settings-action/workflows/Audit/badge.svg)](https://github.com/s4u/maven-settings-action/actions?query=workflow%3AAudit)
+
 
 This action setup maven environment for use in action by:
  - create maven settings.xml
@@ -8,10 +10,17 @@ This action setup maven environment for use in action by:
  - add server to servers with id=github, username=$GITHUB_ACTOR and password=$GITHUB_TOKEN
 
 # Contributions
-
 - Contributions are welcome!
-- Give a star - if you want to encourage me to work on a project
-- Don't hesitate create issue
+- Give :star: - if you want to encourage me to work on a project
+- Don't hesitate create issue for new feature you dream of or if you suspect some bug
+
+# Project versioning
+Project use [Semantic Versioning](https://semver.org/).
+We recommended to use the latest and specific release version.
+
+In order to keep your project dependencies up to date you can watch this repository *(Releases only)*
+or use automatic tools like [Dependabot](https://dependabot.com/).
+
 
  # Usage
 See [action.yml](action.yml)
@@ -19,21 +28,29 @@ See [action.yml](action.yml)
 Create default ```settings.xml```:
 ```yml
 steps:
-- uses: s4u/maven-settings-action@v2.0
+- uses: s4u/maven-settings-action@v2
 ```
 
-Create ```settings.xml``` with server section:
+Create ```settings.xml``` with servers section:
 ```yml
 steps:
-- uses: s4u/maven-settings-action@v2.0
+- uses: s4u/maven-settings-action@v2
   with:
     servers: '[{"id": "serverId", "username": "username", "password": "password"}]'
 ```
 
+Create ```settings.xml``` with mirrors section:
+```yml
+steps:
+- uses: s4u/maven-settings-action@v2
+  with:
+    mirrors: '[{"id": "mirrorId", "name": "mirrorName", "mirrorOf": "mirrorOf", "url": "mirrorUrl"}]'
+```
+
 Create ```settings.xml``` with maven properties:
 ```yml
 steps:
-- uses: s4u/maven-settings-action@v2.0
+- uses: s4u/maven-settings-action@v2
   with:
     properties: '[{"propertyName1": "propertyValue1"}, {"propertyName2": "propertyValue2"}]'
 ```
@@ -41,7 +58,7 @@ steps:
 Create ```settings.xml``` with https://oss.sonatype.org/content/repositories/snapshots in repository list
 ```yml
 steps:
-- uses: s4u/maven-settings-action@v2.0
+- uses: s4u/maven-settings-action@v2
   with:
     sonatypeSnapshots: true
 ```
@@ -49,7 +66,7 @@ steps:
 Do not override existing ```settings.xml```, from version 2.0 file is override by default :
 ```yml
 steps:
-- uses: s4u/maven-settings-action@v2.0
+- uses: s4u/maven-settings-action@v2
   with:
     override: false
 ```
@@ -57,7 +74,7 @@ steps:
 Do not add github to server in ```settings.xml```, by default is added:
 ```yml
 steps:
-- uses: s4u/maven-settings-action@v2.0
+- uses: s4u/maven-settings-action@v2
   with:
     githubServer: false
 ```

action.yml

@@ -9,6 +9,9 @@ inputs:
   servers:
     description: 'servers definition in joson array, eg: [{"id": "serverId", "username": "username", "password": "password"}]'
     required: false
+  mirrors:
+    description: 'mirrors definition in json array, eg: [{"id": "id", "name": "name", "mirrorOf": "mirrorOf", "url": "url"}]'
+    required: false
   properties:
     description: 'json array with properties, eg [{"propertyName1": "propertyValue1"}, {"propertyName2": "propertyValue2"}]'
     required: false

package.json

@@ -30,6 +30,6 @@
   },
   "devDependencies": {
     "eslint": "^6.8.0",
-    "jest": "^25.1.0"
+    "jest": "^25.2.7"
   }
 }

settings.js

@@ -91,6 +91,42 @@ function fillServers(template) {
     JSON.parse(servers).forEach((server) => fillServer(template, server.id, server.username, server.password));
 }
 
+function fillMirror(template, id, name, mirrorOf, url) {
+
+    const mirrorXml = template.createElement('mirror');
+
+    if (!id || !name || !mirrorOf || !url) {
+        core.setFailed('mirrors must contain id, name, mirrorOf and url');
+        return;
+    }
+
+    const idXml = createElementWithText(template, 'id', id);
+    mirrorXml.appendChild(idXml);
+
+    const nameXml = createElementWithText(template, 'name', name);
+    mirrorXml.appendChild(nameXml);
+
+    const mirrorOfXml = createElementWithText(template, 'mirrorOf', mirrorOf);
+    mirrorXml.appendChild(mirrorOfXml);
+
+    const urlXml = createElementWithText(template, 'url', url);
+    mirrorXml.appendChild(urlXml);
+
+    const mirrorsXml = template.getElementsByTagName('mirrors')[0];
+    mirrorsXml.appendChild(mirrorXml);
+}
+
+function fillMirrors(template) {
+
+    const mirrors = core.getInput('mirrors');
+
+    if (!mirrors) {
+        return;
+    }
+
+    JSON.parse(mirrors).forEach((mirror) => fillMirror(template, mirror.id, mirror.name, mirror.mirrorOf, mirror.url));
+}
+
 function isInputTrue(inputName) {
     const val = core.getInput(inputName);
     return val && val.toLocaleLowerCase() == 'true';
@@ -157,6 +193,7 @@ function generate() {
     }
 
     const templateXml = getSettingsTemplate();
+    fillMirrors(templateXml);
     fillServers(templateXml);
     fillServerForGithub(templateXml);
     fillProperties(templateXml);
@@ -184,6 +221,7 @@ function cleanup() {
 module.exports = {
     getSettingsTemplate,
     writeSettings,
+    fillMirrors,
     fillServers,
     fillServerForGithub,
     fillProperties,

settings.test.js

@@ -99,7 +99,6 @@ afterEach(() => {
 });
 
 test('template should be read', () => {
-
     const template = settings.getSettingsTemplate();
 
     expect(template).toBeDefined();
@@ -133,7 +132,6 @@ test('fillServers one server', () => {
 
     const xml = new DOMParser().parseFromString("<servers/>");
 
-
     process.env['INPUT_SERVERS'] = '[{"id": "id1", "username": "username1", "password":"password1"}]';
 
     settings.fillServers(xml);
@@ -194,6 +192,65 @@ test('fillServers github', () => {
     expect(consoleOutput).toEqual([]);
 });
 
+test('fillMirrors do nothing if no params', () => {
+
+    const xml = new DOMParser().parseFromString("<mirrors/>");
+
+    settings.fillMirrors(xml);
+
+    const xmlStr = new XMLSerializer().serializeToString(xml);
+
+    expect(xmlStr).toBe("<mirrors/>");
+});
+
+test('fillMirrors one mirror', () => {
+
+    const xml = new DOMParser().parseFromString("<mirrors/>");
+
+    process.env['INPUT_MIRRORS'] = '[{"id": "id1", "name": "name", "mirrorOf":"mirrorOf", "url":"url"}]';
+
+    settings.fillMirrors(xml);
+
+    const xmlStr = new XMLSerializer().serializeToString(xml);
+
+    expect(xmlStr).toBe("<mirrors>" +
+        "<mirror><id>id1</id><name>name</name><mirrorOf>mirrorOf</mirrorOf><url>url</url></mirror>" +
+        "</mirrors>");
+});
+
+test('fillMirrors two mirrors', () => {
+
+    const xml = new DOMParser().parseFromString("<mirrors/>");
+
+    process.env['INPUT_MIRRORS'] = '[{"id": "id1", "name": "name1", "mirrorOf":"mirrorOf1", "url":"url1"},{"id": "id2", "name": "name2", "mirrorOf":"mirrorOf2", "url":"url2"}]';
+
+    settings.fillMirrors(xml);
+
+    const xmlStr = new XMLSerializer().serializeToString(xml);
+
+    expect(xmlStr).toBe("<mirrors>" +
+        "<mirror><id>id1</id><name>name1</name><mirrorOf>mirrorOf1</mirrorOf><url>url1</url></mirror><mirror><id>id2</id><name>name2</name><mirrorOf>mirrorOf2</mirrorOf><url>url2</url></mirror>" +
+        "</mirrors>");
+});
+
+test('fillMirrors incorrect fields', () => {
+
+    const xml = new DOMParser().parseFromString("<mirrors/>");
+
+    process.env['INPUT_MIRRORS'] = '[{"idx": "id1"}]';
+
+    settings.fillMirrors(xml);
+
+    const xmlStr = new XMLSerializer().serializeToString(xml);
+
+    expect(xmlStr).toBe('<mirrors/>');
+    expect(consoleOutput).toEqual(
+        expect.arrayContaining([
+            expect.stringMatching(/::error::mirrors must contain id, name, mirrorOf and url/)
+        ])
+    );
+});
+
 test('addSonatypeSnapshots activate', () => {
 
     process.env['INPUT_SONATYPESNAPSHOTS'] = "true";

templates/settings.xml

@@ -1,48 +1,46 @@
 <settings>
-
-    <interactiveMode>false</interactiveMode>
-
-    <profiles>
-        <profile>
-            <id>_properties_</id>
-            <activation>
-                <activeByDefault>false</activeByDefault>
-            </activation>
-            <properties />
-        </profile>
-
-        <profile>
-            <id>_sonatype-snapshots_</id>
-            <activation>
-                <activeByDefault>false</activeByDefault>
-            </activation>
-            <repositories>
-                <repository>
-                    <id>sonatype-snapshots</id>
-                    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
-                    <releases>
-                        <enabled>false</enabled>
-                    </releases>
-                    <snapshots>
-                        <enabled>true</enabled>
-                    </snapshots>
-                </repository>
-            </repositories>
-            <pluginRepositories>
-                <pluginRepository>
-                    <id>sonatype-snapshots</id>
-                    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
-                    <releases>
-                        <enabled>false</enabled>
-                    </releases>
-                    <snapshots>
-                        <enabled>true</enabled>
-                    </snapshots>
-                </pluginRepository>
-            </pluginRepositories>
-        </profile>
-
-    </profiles>
-
-    <servers />
+   <interactiveMode>false</interactiveMode>
+   <profiles>
+      <!-- generic ############################################################# -->
+      <profile>
+         <id>_properties_</id>
+         <activation>
+            <activeByDefault>false</activeByDefault>
+         </activation>
+         <properties />
+      </profile>
+      <!-- sonatype ############################################################# -->
+      <profile>
+         <id>_sonatype-snapshots_</id>
+         <activation>
+            <activeByDefault>false</activeByDefault>
+         </activation>
+         <repositories>
+            <repository>
+               <id>sonatype-snapshots</id>
+               <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+               <releases>
+                  <enabled>false</enabled>
+               </releases>
+               <snapshots>
+                  <enabled>true</enabled>
+               </snapshots>
+            </repository>
+         </repositories>
+         <pluginRepositories>
+            <pluginRepository>
+               <id>sonatype-snapshots</id>
+               <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+               <releases>
+                  <enabled>false</enabled>
+               </releases>
+               <snapshots>
+                  <enabled>true</enabled>
+               </snapshots>
+            </pluginRepository>
+         </pluginRepositories>
+      </profile>
+   </profiles>
+   <servers />
+   <mirrors />
 </settings>