Merge b11b91564e into 99b8673ff6

Merge branch 'main' into main
Patch for java version file (#610 )
2024-03-21 09:41:44 +00:00 · 2024-03-21 17:41:41 +08:00 · 2024-03-14 09:12:58 -05:00 · 2024-03-12 08:45:42 -05:00 · 2024-03-01 16:16:24 +08:00
10 changed files with 138 additions and 40 deletions
--- a/.github/workflows/e2e-publishing.yml
+++ b/.github/workflows/e2e-publishing.yml
@ -36,6 +36,10 @@ jobs:
          server-username: MAVEN_USERNAME
          server-password: MAVEN_CENTRAL_TOKEN
          gpg-passphrase: MAVEN_GPG_PASSPHRASE
+        env:
+          MAVEN_USERNAME: MAVEN_USERNAME
+          MAVEN_CENTRAL_TOKEN: MAVEN_CENTRAL_TOKEN
+          MAVEN_GPG_PASSPHRASE: MAVEN_GPG_PASSPHRASE
      - name: Validate settings.xml
        run: |
          $xmlPath = Join-Path $HOME ".m2" "settings.xml"
@ -43,11 +47,11 @@ jobs:

          [xml]$xml = Get-Content $xmlPath
          $servers = $xml.settings.servers.server
-          if (($servers[0].id -ne 'maven') -or ($servers[0].username -ne '${env.MAVEN_USERNAME}') -or ($servers[0].password -ne '${env.MAVEN_CENTRAL_TOKEN}')) {
+          if (($servers[0].id -ne 'maven') -or ($servers[0].username -ne 'MAVEN_USERNAME') -or ($servers[0].password -ne 'MAVEN_CENTRAL_TOKEN')) {
            throw "Generated XML file is incorrect"
          }

-          if (($servers[1].id -ne 'gpg.passphrase') -or ($servers[1].passphrase -ne '${env.MAVEN_GPG_PASSPHRASE}')) {
+          if (($servers[1].id -ne 'gpg.passphrase') -or ($servers[1].passphrase -ne 'MAVEN_GPG_PASSPHRASE')) {
            throw "Generated XML file is incorrect"
          }

@ -77,6 +81,10 @@ jobs:
          server-username: MAVEN_USERNAME
          server-password: MAVEN_CENTRAL_TOKEN
          gpg-passphrase: MAVEN_GPG_PASSPHRASE
+        env:
+          MAVEN_USERNAME: MAVEN_USERNAME
+          MAVEN_CENTRAL_TOKEN: MAVEN_CENTRAL_TOKEN
+          MAVEN_GPG_PASSPHRASE: MAVEN_GPG_PASSPHRASE
      - name: Validate settings.xml is overwritten
        run: |
          $xmlPath = Join-Path $HOME ".m2" "settings.xml"
@ -114,6 +122,10 @@ jobs:
          server-password: MAVEN_CENTRAL_TOKEN
          overwrite-settings: false
          gpg-passphrase: MAVEN_GPG_PASSPHRASE
+        env:
+          MAVEN_USERNAME: MAVEN_USERNAME
+          MAVEN_CENTRAL_TOKEN: MAVEN_CENTRAL_TOKEN
+          MAVEN_GPG_PASSPHRASE: MAVEN_GPG_PASSPHRASE
      - name: Validate that settings.xml is not overwritten
        run: |
          $xmlPath = Join-Path $HOME ".m2" "settings.xml"
@ -145,6 +157,10 @@ jobs:
          server-password: MAVEN_CENTRAL_TOKEN
          gpg-passphrase: MAVEN_GPG_PASSPHRASE
          settings-path: ${{ runner.temp }}
+        env:
+          MAVEN_USERNAME: MAVEN_USERNAME
+          MAVEN_CENTRAL_TOKEN: MAVEN_CENTRAL_TOKEN
+          MAVEN_GPG_PASSPHRASE: MAVEN_GPG_PASSPHRASE
      - name: Validate settings.xml location
        run: |
          $path = Join-Path $env:RUNNER_TEMP "settings.xml"
--- a/.github/workflows/e2e-versions.yml
+++ b/.github/workflows/e2e-versions.yml
@ -288,19 +288,23 @@ jobs:
      matrix:
        os: [macos-latest, windows-latest, ubuntu-latest]
        distribution: ['temurin', 'microsoft', 'corretto']
+        java-version-file: ['.java-version', '.tool-versions']
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Create .java-version file
        shell: bash
        run: echo "8" > .java-version
+      - name: Create .tool-versions file
+        shell: bash
+        run: echo "java 8" > .tool-versions
      - name: setup-java
        uses: ./
        id: setup-java
        with:
          distribution: ${{ matrix.distribution }}
          java-version: 11
-          java-version-file: '.java-version'
+          java-version-file: ${{matrix.java-version-file }}
      - name: Verify Java
        run: bash __tests__/verify-java.sh "11" "${{ steps.setup-java.outputs.path }}"
        shell: bash
@ -313,18 +317,22 @@ jobs:
      matrix:
        os: [macos-latest, windows-latest, ubuntu-latest]
        distribution: ['temurin', 'zulu', 'liberica', 'microsoft', 'corretto']
+        java-version-file: ['.java-version', '.tool-versions']
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Create .java-version file
        shell: bash
        run: echo "11" > .java-version
+      - name: Create .tool-versions file
+        shell: bash
+        run: echo "java 11" > .tool-versions
      - name: setup-java
        uses: ./
        id: setup-java
        with:
          distribution: ${{ matrix.distribution }}
-          java-version-file: '.java-version'
+          java-version-file: ${{matrix.java-version-file }}
      - name: Verify Java
        run: bash __tests__/verify-java.sh "11" "${{ steps.setup-java.outputs.path }}"
        shell: bash
@ -337,18 +345,22 @@ jobs:
      matrix:
        os: [macos-latest, windows-latest, ubuntu-latest]
        distribution: ['adopt', 'adopt-openj9', 'zulu']
+        java-version-file: ['.java-version', '.tool-versions']
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Create .java-version file
        shell: bash
        run: echo "11.0.2" > .java-version
+      - name: Create .tool-versions file
+        shell: bash
+        run: echo "java 11.0.2" > .tool-versions
      - name: setup-java
        uses: ./
        id: setup-java
        with:
          distribution: ${{ matrix.distribution }}
-          java-version-file: '.java-version'
+          java-version-file: ${{matrix.java-version-file }}
      - name: Verify Java
        run: bash __tests__/verify-java.sh "11.0.2" "${{ steps.setup-java.outputs.path }}"
        shell: bash
@ -361,18 +373,22 @@ jobs:
      matrix:
        os: [macos-latest, windows-latest, ubuntu-latest]
        distribution: ['adopt', 'zulu', 'liberica']
+        java-version-file: ['.java-version', '.tool-versions']
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Create .java-version file
        shell: bash
        run: echo "openjdk64-11.0.2" > .java-version
+      - name: Create .tool-versions file
+        shell: bash
+        run: echo "java openjdk64-11.0.2" > .tool-versions
      - name: setup-java
        uses: ./
        id: setup-java
        with:
          distribution: ${{ matrix.distribution }}
-          java-version-file: '.java-version'
+          java-version-file: ${{matrix.java-version-file }}
      - name: Verify Java
        run: bash __tests__/verify-java.sh "11.0.2" "${{ steps.setup-java.outputs.path }}"
        shell: bash
--- a/README.md
+++ b/README.md
@ -27,7 +27,7 @@ This action allows you to work with Java and Scala projects.

  - `java-version`: The Java version that is going to be set up. Takes a whole or [semver](#supported-version-syntax) Java version. If not specified, the action will expect `java-version-file` input to be specified.

-  - `java-version-file`: The path to the `.java-version` file. See more details in [about `.java-version` file](docs/advanced-usage.md#Java-version-file).
+  - `java-version-file`: The path to a file containing java version. Supported file types are `.java-version` and `.tool-versions`. See more details in [about .java-version-file](docs/advanced-usage.md#Java-version-file).
   
  - `distribution`: _(required)_ Java [distribution](#supported-distributions).

@ -266,6 +266,7 @@ In the example above multiple JDKs are installed for the same job. The result af
 - [Publishing using Gradle](docs/advanced-usage.md#Publishing-using-Gradle)
 - [Hosted Tool Cache](docs/advanced-usage.md#Hosted-Tool-Cache)
 - [Modifying Maven Toolchains](docs/advanced-usage.md#Modifying-Maven-Toolchains)
+- [Java Version File](docs/advanced-usage.md#Java-version-file)

 ## License

--- a/tests/auth.test.ts
+++ b/tests/auth.test.ts
@ -1,8 +1,8 @@
-import * as io from '@actions/io';
 import * as core from '@actions/core';
+import * as io from '@actions/io';
 import * as fs from 'fs';
-import * as path from 'path';
 import os from 'os';
+import * as path from 'path';

 import * as auth from '../src/auth';
 import {M2_DIR, MVN_SETTINGS_FILE} from '../src/constants';
@ -10,6 +10,14 @@ import {M2_DIR, MVN_SETTINGS_FILE} from '../src/constants';
 const m2Dir = path.join(__dirname, M2_DIR);
 const settingsFile = path.join(m2Dir, MVN_SETTINGS_FILE);

+// escape xml special characters
+function escapeXml(unsafeStr: string) {
+  return unsafeStr
+    .replace(/&/g, '&amp;')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;');
+}
+
 describe('auth tests', () => {
  let spyOSHomedir: jest.SpyInstance;
  let spyInfo: jest.SpyInstance;
@ -157,19 +165,22 @@ describe('auth tests', () => {
    const username = 'USER';
    const password = '&<>"\'\'"><&';

+    process.env['username'] = username;
+    process.env['password'] = password;
+
    const expectedSettings = `<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
  <servers>
    <server>
-      <id>${id}</id>
-      <username>\${env.${username}}</username>
-      <password>\${env.&amp;&lt;&gt;"''"&gt;&lt;&amp;}</password>
+      <id>${escapeXml(id)}</id>
+      <username>${escapeXml(username)}</username>
+      <password>${escapeXml(password)}</password>
    </server>
  </servers>
 </settings>`;

-    expect(auth.generate(id, username, password)).toEqual(expectedSettings);
+    expect(auth.generate(id, 'username', 'password')).toEqual(expectedSettings);
  });

  it('generates valid settings.xml with additional configuration', () => {
@ -178,23 +189,27 @@ describe('auth tests', () => {
    const password = '&<>"\'\'"><&';
    const gpgPassphrase = 'PASSPHRASE';

+    process.env['username'] = username;
+    process.env['password'] = password;
+    process.env['gpgPassphrase'] = gpgPassphrase;
+
    const expectedSettings = `<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
  <servers>
    <server>
-      <id>${id}</id>
-      <username>\${env.${username}}</username>
-      <password>\${env.&amp;&lt;&gt;"''"&gt;&lt;&amp;}</password>
+      <id>${escapeXml(id)}</id>
+      <username>${escapeXml(username)}</username>
+      <password>${escapeXml(password)}</password>
    </server>
    <server>
      <id>gpg.passphrase</id>
-      <passphrase>\${env.${gpgPassphrase}}</passphrase>
+      <passphrase>${escapeXml(gpgPassphrase)}</passphrase>
    </server>
  </servers>
 </settings>`;

-    expect(auth.generate(id, username, password, gpgPassphrase)).toEqual(
+    expect(auth.generate(id, 'username', 'password', 'gpgPassphrase')).toEqual(
      expectedSettings
    );
  });
--- a/dist/cleanup/index.js
+++ b/dist/cleanup/index.js
@ -88352,9 +88352,20 @@ function isCacheFeatureAvailable() {
    return false;
 }
 exports.isCacheFeatureAvailable = isCacheFeatureAvailable;
-function getVersionFromFileContent(content, distributionName) {
+function getVersionFromFileContent(content, distributionName, versionFile) {
    var _a, _b, _c, _d, _e;
-    const javaVersionRegExp = /(?<version>(?<=(^|\s|-))(\d+\S*))(\s|$)/;
+    let javaVersionRegExp;
+    function getFileName(versionFile) {
+        return path_1.default.basename(versionFile);
+    }
+    const versionFileName = getFileName(versionFile);
+    if (versionFileName == '.tool-versions') {
+        javaVersionRegExp =
+            /^(java\s+)(?:\S*-)?v?(?<version>(\d+)(\.\d+)?(\.\d+)?(\+\d+)?(-ea(\.\d+)?)?)$/m;
+    }
+    else {
+        javaVersionRegExp = /(?<version>(?<=(^|\s|-))(\d+\S*))(\s|$)/;
+    }
    const fileContent = ((_b = (_a = content.match(javaVersionRegExp)) === null || _a === void 0 ? void 0 : _a.groups) === null || _b === void 0 ? void 0 : _b.version)
        ? (_d = (_c = content.match(javaVersionRegExp)) === null || _c === void 0 ? void 0 : _c.groups) === null || _d === void 0 ? void 0 : _d.version
        : '';
--- a/dist/setup/index.js
+++ b/dist/setup/index.js
@ -122928,9 +122928,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.generate = exports.createAuthenticationSettings = exports.configureAuthentication = void 0;
-const path = __importStar(__nccwpck_require__(71017));
 const core = __importStar(__nccwpck_require__(42186));
 const io = __importStar(__nccwpck_require__(47351));
+const path = __importStar(__nccwpck_require__(71017));
 const fs = __importStar(__nccwpck_require__(57147));
 const os = __importStar(__nccwpck_require__(22037));
 const xmlbuilder2_1 = __nccwpck_require__(70151);
@ -122982,8 +122982,8 @@ function generate(id, username, password, gpgPassphrase) {
                server: [
                    {
                        id: id,
-                        username: `\${env.${username}}`,
-                        password: `\${env.${password}}`
+                        username: process.env[username],
+                        password: process.env[password]
                    }
                ]
            }
@ -122992,7 +122992,7 @@ function generate(id, username, password, gpgPassphrase) {
    if (gpgPassphrase) {
        const gpgServer = {
            id: 'gpg.passphrase',
-            passphrase: `\${env.${gpgPassphrase}}`
+            passphrase: process.env[gpgPassphrase]
        };
        xmlObj.settings.servers.server.push(gpgServer);
    }
@ -125372,7 +125372,7 @@ function run() {
            if (!versions.length) {
                core.debug('java-version input is empty, looking for java-version-file input');
                const content = fs_1.default.readFileSync(versionFile).toString().trim();
-                const version = (0, util_1.getVersionFromFileContent)(content, distributionName);
+                const version = (0, util_1.getVersionFromFileContent)(content, distributionName, versionFile);
                core.debug(`Parsed version from file '${version}'`);
                if (!version) {
                    throw new Error(`No supported version was found in file ${versionFile}`);
@ -125726,9 +125726,20 @@ function isCacheFeatureAvailable() {
    return false;
 }
 exports.isCacheFeatureAvailable = isCacheFeatureAvailable;
-function getVersionFromFileContent(content, distributionName) {
+function getVersionFromFileContent(content, distributionName, versionFile) {
    var _a, _b, _c, _d, _e;
-    const javaVersionRegExp = /(?<version>(?<=(^|\s|-))(\d+\S*))(\s|$)/;
+    let javaVersionRegExp;
+    function getFileName(versionFile) {
+        return path_1.default.basename(versionFile);
+    }
+    const versionFileName = getFileName(versionFile);
+    if (versionFileName == '.tool-versions') {
+        javaVersionRegExp =
+            /^(java\s+)(?:\S*-)?v?(?<version>(\d+)(\.\d+)?(\.\d+)?(\+\d+)?(-ea(\.\d+)?)?)$/m;
+    }
+    else {
+        javaVersionRegExp = /(?<version>(?<=(^|\s|-))(\d+\S*))(\s|$)/;
+    }
    const fileContent = ((_b = (_a = content.match(javaVersionRegExp)) === null || _a === void 0 ? void 0 : _a.groups) === null || _b === void 0 ? void 0 : _b.version)
        ? (_d = (_c = content.match(javaVersionRegExp)) === null || _c === void 0 ? void 0 : _c.groups) === null || _d === void 0 ? void 0 : _d.version
        : '';
--- a/docs/advanced-usage.md
+++ b/docs/advanced-usage.md
@ -182,7 +182,7 @@ steps:
    jdkFile: ${{ runner.temp }}/java_package.tar.gz
    java-version: '11.0.0'
    architecture: x64
-    
+
 - run: java -cp java HelloWorldApp
 ```

@ -285,7 +285,10 @@ jobs:
        server-password: MAVEN_CENTRAL_TOKEN # env variable for token in deploy
        gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
        gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
-
+      env:
+        MAVEN_USERNAME: ${{ vars.MAVEN_USERNAME }} # set the env variable for username
+        MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }} # set the env variable for token
+        MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }} # set the env variable for GPG private key passphrase
    - name: Publish to Apache Maven Central
      run: mvn deploy
      env:
@ -525,14 +528,21 @@ steps:
      something_other
 ```

-## Java-version file
-If the `java-version-file` input is specified, the action will try to extract the version from the file and install it.
-Action is able to recognize all variants of the version description according to [jenv](https://github.com/jenv/jenv). 
+## Java version file
+If the `java-version-file` input is specified, the action will extract the version from the file and install it.
+
+Supported files are .java-version and .tool-versions.
+In .java-version file, only the version should be specified, e.g., 17.0.7.
+In .tool-versions file, java version should be preceded by the java keyword, e.g., java 17.0.7.
+.java-version recognizes all variants of the version description according to [jenv](https://github.com/jenv/jenv) and .tool-version recognizes all variants of the version description according to [asdf](https://github.com/asdf-vm/asdf).
+
+If both java-version and java-version-file inputs are provided, the java-version input will be used.
+
 Valid entry options:
 ```
 major versions: 8, 11, 16, 17, 21
 more specific versions: 1.8.0.2, 17.0, 11.0, 11.0.4, 8.0.232, 8.0.282+8
-early access (EA) versions: 15-ea, 15.0.0-ea, 15.0.0-ea.2, 15.0.0+2-ea
+early access (EA) versions: 15-ea, 15.0.0-ea
 versions with specified distribution: openjdk64-11.0.2
 ```
 If the file contains multiple versions, only the first one will be recognized.
--- a/src/auth.ts
+++ b/src/auth.ts
@ -1,6 +1,6 @@
-import * as path from 'path';
 import * as core from '@actions/core';
 import * as io from '@actions/io';
+import * as path from 'path';

 import * as fs from 'fs';
 import * as os from 'os';
@ -84,8 +84,8 @@ export function generate(
        server: [
          {
            id: id,
-            username: `\${env.${username}}`,
-            password: `\${env.${password}}`
+            username: process.env[username],
+            password: process.env[password]
          }
        ]
      }
@ -95,7 +95,7 @@ export function generate(
  if (gpgPassphrase) {
    const gpgServer = {
      id: 'gpg.passphrase',
-      passphrase: `\${env.${gpgPassphrase}}`
+      passphrase: process.env[gpgPassphrase]
    };
    xmlObj.settings.servers.server.push(gpgServer);
  }
--- a/src/setup-java.ts
+++ b/src/setup-java.ts
@ -55,7 +55,11 @@ async function run() {
      );
      const content = fs.readFileSync(versionFile).toString().trim();

-      const version = getVersionFromFileContent(content, distributionName);
+      const version = getVersionFromFileContent(
+        content,
+        distributionName,
+        versionFile
+      );
      core.debug(`Parsed version from file '${version}'`);

      if (!version) {
--- a/src/util.ts
+++ b/src/util.ts
@ -115,9 +115,23 @@ export function isCacheFeatureAvailable(): boolean {

 export function getVersionFromFileContent(
  content: string,
-  distributionName: string
+  distributionName: string,
+  versionFile: string
 ): string | null {
-  const javaVersionRegExp = /(?<version>(?<=(^|\s|-))(\d+\S*))(\s|$)/;
+  let javaVersionRegExp: RegExp;
+
+  function getFileName(versionFile: string) {
+    return path.basename(versionFile);
+  }
+
+  const versionFileName = getFileName(versionFile);
+  if (versionFileName == '.tool-versions') {
+    javaVersionRegExp =
+      /^(java\s+)(?:\S*-)?v?(?<version>(\d+)(\.\d+)?(\.\d+)?(\+\d+)?(-ea(\.\d+)?)?)$/m;
+  } else {
+    javaVersionRegExp = /(?<version>(?<=(^|\s|-))(\d+\S*))(\s|$)/;
+  }
+
  const fileContent = content.match(javaVersionRegExp)?.groups?.version
    ? (content.match(javaVersionRegExp)?.groups?.version as string)
    : '';
Author	SHA1	Message	Date
Parry	80faa3116a	Merge `b11b91564e` into `99b8673ff6`	2024-03-21 09:41:44 +00:00
Parry	b11b91564e	Merge branch 'main' into main	2024-03-21 17:41:41 +08:00
mahabaleshwars	99b8673ff6	Patch for java version file (#610 ) * patch to extract file from other location * patch to extract filename from other directories * removed code failing checks * changed the validation for .java-version type	2024-03-14 09:12:58 -05:00
mahabaleshwars	5896cecc08	Added .tool-versions file support (#606 ) * added support for tool version file * testing with one regex * working regex * Checked for the file extension * added e2e checks for tool version * removed error warning * updated regex to support early version * updated regex for early version support * updated regex for early version * updated regex to accept early versions * added coreinfo to analyze * updated the regex * updated regex * new regex for early version * updated regex to match the new version file format * new regex * changed the regex * redex updated * used java version regex * regex updated * regex modified * regex updated * regex updated * regex updated * updated regex to support early versions * Regex updated to support all java versions * Documentation updated to add tool version description * Documentation updated for the tool version file * update the advanced doc and readme file to specify tool version changes	2024-03-12 08:45:42 -05:00
Parry	c0786a2b6c	fix(auth): Update authentication logic in settings.xml, unit tests (#1 ) * fix(auth): Update authentication logic in settings.xml, unit tests Enhanced the logic for reading authentication information in the settings.xml file to address an issue where attempts to configure a GitHub Action for fetching packages from a repository within the same organization resulted in authentication errors. Despite the correct configuration, the process failed with a 401 Unauthorized status during dependency download from GitHub's Maven package repository. The error was pinpointed to a non-resolvable parent POM due to authentication failure, with an incorrect 'parent.relativePath' exacerbating the issue. To resolve this, I made significant updates to the logic within settings.xml for better handling of authentication information. Additionally, unit tests have been updated to reflect these changes and ensure robust verification. The documentation and examples have also been revised to provide clearer guidance on configuring and utilizing this updated process successfully.	2024-03-01 16:16:24 +08:00