Refactor offline package test to use build info.

Author: Fabricio-ESP

.github/workflows/test_offline.yml

@@ -52,32 +52,26 @@ jobs:
         with:
           node-version: "20"
 
-      - name: Download Archive
+      - name: Download Build Info files
         uses: actions/download-artifact@v5
         with:
-          pattern: offline_installer-${{ matrix.package_name }}-*
+          pattern: build-info-*-${{ matrix.package_name }}
           merge-multiple: true
           path: ./artifacts
           github-token: ${{ secrets.GITHUB_TOKEN }}
           run-id: ${{ inputs.run_id }}
 
       # Non-Windows steps
 
-      - name: Get CLI application version number (non-Windows)
+      - name: Download latest EIM CLI binary (non-Windows)
         if: matrix.os != 'windows-latest'
         run: |
-          git fetch --tags
-          LATEST_TAG=$(git tag --sort=-creatordate | head -n 1)
-          STRIPPED_TAG=${LATEST_TAG#v}
-          echo "CLI_TAG=$STRIPPED_TAG" >> $GITHUB_ENV
+          latest_release=$(curl -s https://api.github.com/repos/espressif/idf-im-ui/releases/latest)
+          eim_cli_url=$(echo "$latest_release" | jq -r '.assets[] | select(.name | test("eim-cli-${{matrix.package_name}}.zip")) | .browser_download_url')
+          curl -L -o ./artifacts/eim-cli.zip "$eim_cli_url"
 
-      - name: Make EIM executable (non-Windows)
-        if: matrix.os != 'windows-latest'
-        run: |
-          ls -la ./artifacts/
-          unzip ./artifacts/offline_installer*.zip -d ./artifacts/
-          mv ./artifacts/archive_v*.zst ./artifacts/archive.zst
           ls -la ./artifacts/
+          unzip ./artifacts/eim-cli.zip -d ./artifacts/
           chmod +x artifacts/eim
 
       - name: Install dependencies and node.js (Ubuntu)
@@ -102,28 +96,20 @@ jobs:
         run: |
           export LOG_TO_FILE="true"
           export EIM_CLI_PATH="../artifacts/eim"
-          export EIM_OFFLINE_ARCHIVE="../artifacts/archive.zst"
-          export EIM_CLI_VERSION="eim ${{ env.CLI_TAG }}"
+          export BUILD_INFO_PATH="../artifacts"
           cd tests
-          npm run test-CLI --file=CLI-offline
+          npm run test-offline
         continue-on-error: true
 
       # Windows steps
 
-      - name: Get CLI application version number (Windows)
+      - name: Download latest EIM CLI binary (Windows)
         if: matrix.os == 'windows-latest'
         run: |
-          git fetch --tags
-          $LATEST_TAG = (git tag --sort=-creatordate | Select-Object -First 1)
-          $STRIPPED_TAG = $LATEST_TAG -replace '^v', ''
-          echo "CLI_TAG=$STRIPPED_TAG" | Out-File -FilePath $env:GITHUB_ENV -Append
+          latest_release=$(curl -s https://api.github.com/repos/espressif/idf-im-ui/releases/latest)
+          eim_cli_url=$(echo "$latest_release" | jq -r '.assets[] | select(.name | test("eim-cli-${{matrix.package_name}}.exe")) | .browser_download_url')
+          curl -L -o ./artifacts/eim-cli.exe "$eim_cli_url"
 
-      - name: Check artifact (Windows)
-        if: matrix.os == 'windows-latest'
-        run: |
-          ls ./artifacts/
-          Expand-Archive ./artifacts/offline_installer*.zip -DestinationPath ./artifacts/
-          Move-Item "./artifacts/archive_v*.zst" "artifacts/archive.zst"
           ls ./artifacts/
 
       - name: Update Python (Windows)
@@ -137,11 +123,10 @@ jobs:
         run: |
           $env:LOG_TO_FILE="true"
           $env:EIM_CLI_PATH = "..\artifacts\eim.exe"
-          $env:EIM_OFFLINE_ARCHIVE = "..\artifacts\archive.zst"
-          $env:EIM_CLI_VERSION = "eim ${{ env.CLI_TAG }}"
+          $env:BUILD_INFO_PATH = "..\artifacts"
           Set-Location -Path "./tests"
           Expand-Archive node_modules.zip
-          npm run test-CLI-win --file=CLI-offline
+          npm run test-offline
         continue-on-error: true
 
       # Copy eim log files to standard location for easier access

tests/config.js

@@ -96,6 +96,9 @@ const getEIMPath = (pathFromCI, defaultFolder) =>
 const pathToEIMCLI = getEIMPath(process.env.EIM_CLI_PATH, "eim-cli");
 const pathToEIMGUI = getEIMPath(process.env.EIM_GUI_PATH, "eim-gui");
 
+// Get path for build info file
+const pathToBuildInfo = process.env.BUILD_INFO_PATH || "~/build_info";
+
 // Default installation folder
 const INSTALLFOLDER =
   os.platform() !== "win32" ? path.join(os.homedir(), `.espressif`) : `C:\\esp`;
@@ -117,6 +120,7 @@ export {
   availableTargets,
   pathToEIMCLI,
   pathToEIMGUI,
+  pathToBuildInfo,
   EIMGUIVersion,
   EIMCLIVersion,
   INSTALLFOLDER,

tests/offlineRunner.test.js

@@ -0,0 +1,91 @@
+/**
+ * Test runner to execute offline based on entries of archive index json file.
+ * Entries should follow this format:
+  {
+    "filename": "<archive filename>",    //required file to download and test
+    "version": "vx.x.x",                // IDF version contained in the archive
+    "size": <number>,
+    "platform": "windows-x64"           // Platform where this archive can be used
+  },
+ */
+
+import { describe } from "mocha";
+import { runCLICustomInstallTest } from "./scripts/CLICustomInstall.test.js";
+import { runInstallVerification } from "./scripts/installationVerification.test.js";
+import { runCleanUp } from "./scripts/cleanUpRunner.test.js";
+import logger from "./classes/logger.class.js";
+import {
+  pathToEIMCLI,
+  INSTALLFOLDER,
+  TOOLSFOLDER,
+  downloadOfflineArchive,
+  runInDebug,
+  pathToBuildInfo,
+} from "./config.js";
+import os from "os";
+import path from "path";
+import fs from "fs";
+
+let buildInfo = {};
+
+if (fs.existsSync(pathToBuildInfo)) {
+  const files = fs
+    .readdirSync(pathToBuildInfo)
+    .filter((file) => file.endsWith(".json"));
+  files.forEach((file) => {
+    const filePath = path.join(pathToBuildInfo, file);
+    try {
+      const content = fs.readFileSync(filePath, "utf8");
+      const jsonData = JSON.parse(content);
+      buildInfo[file] = jsonData;
+    } catch (err) {
+      logger.error(`Failed to read or parse ${file}: ${err.message}`);
+    }
+  });
+} else {
+  logger.error(`Directory not found: ${pathToBuildInfo}`);
+}
+
+logger.info("Running test script:", buildInfo);
+
+// testRun(buildInfo);
+
+// function testRun(archiveInfo) {
+//   // run tests for each archive information
+//   archiveInfo.forEach(async (info) => {
+//     const pathToOfflineArchive = await downloadOfflineArchive({
+//       idfVersion: info.version,
+//     });
+
+//     const offlineArg = [
+//       `${
+//         runInDebug ? "-vvv " : ""
+//       }--use-local-archive "${pathToOfflineArchive}"`,
+//     ];
+
+//     const deleteAfterTest = test.deleteAfterTest ?? true;
+//     const testProxyMode = test.testProxyMode ?? "block";
+
+//     describe(`Test${test.id} - ${test.name} ->`, function () {
+//       this.timeout(6000000);
+
+//       runCLICustomInstallTest({
+//         pathToEim: pathToEIMCLI,
+//         args: offlineArg,
+//         testProxyMode,
+//       });
+
+//       runInstallVerification({
+//         installFolder: INSTALLFOLDER,
+//         idfList: [IDFDefaultVersion],
+//         toolsFolder: TOOLSFOLDER,
+//       });
+
+//       runCleanUp({
+//         installFolder: INSTALLFOLDER,
+//         toolsFolder: TOOLSFOLDER,
+//         deleteAfterTest,
+//       });
+//     });
+//   });
+// }

tests/package.json

@@ -8,7 +8,8 @@
     "test-CLI": "export JSON_FILENAME=$npm_config_file && npx mocha --exit --reporter json --reporter-options output=./results-$JSON_FILENAME.json CLIRunner.test.js",
     "test-CLI-win": "powershell -Command \"$env:JSON_FILENAME=$env:npm_config_file; npx mocha --exit --reporter json --reporter-options output=./results-$env:JSON_FILENAME.json CLIRunner.test.js\"",
     "test-GUI": "export JSON_FILENAME=$npm_config_file && npx mocha --exit --reporter json --reporter-options output=./results-$JSON_FILENAME.json GUIRunner.test.js",
-    "test-GUI-win": "powershell -Command \"$env:JSON_FILENAME=$env:npm_config_file; npx mocha --exit --reporter json --reporter-options output=./results-$env:JSON_FILENAME.json GUIRunner.test.js\""
+    "test-GUI-win": "powershell -Command \"$env:JSON_FILENAME=$env:npm_config_file; npx mocha --exit --reporter json --reporter-options output=./results-$env:JSON_FILENAME.json GUIRunner.test.js\"",
+    "test-offline": "npx mocha --exit --reporter json --reporter-options output=./results-offline.json offlineRunner.test.js"
   },
   "author": "",
   "license": "ISC",