@testflowkit/cli 3.0.0 → 3.1.0

package/README.md

@@ -43,20 +43,20 @@ tkit --version
 
 ## Configuration
 
-Create a `config.yml` file in your project root:
-
-```yaml
-mode: frontend
-browser:
-  type: chromium
-  headless: true
-features:
-  - path: ./features
-```
+The `tkit init` command generates a `config.yml` file in your project root. You can edit it to match your needs.
+
+## 📚 Documentation
 
-## Documentation
+For comprehensive documentation, guides, examples, and best practices, please visit the **[TestFlowKit Web Documentation](https://testflowkit.github.io/testflowkit/)** on GitHub Pages.
 
-For full documentation, visit [TestFlowKit Documentation](https://testflowkit.github.io/testflowkit/testflowkit/).
+The documentation includes:
+- Getting Started Guide
+- Configuration Options
+- Step Definitions & Sentences
+- Variable System
+- API Testing
+- Advanced Features
+- FAQ & Troubleshooting
 
 ## Supported Platforms
 

package/lib/install.js

@@ -1,10 +1,12 @@
 #!/usr/bin/env node
 
 const https = require("https");
+const http = require("http");
+
 const fs = require("fs");
 const path = require("path");
+const os = require("os");
 const AdmZip = require("adm-zip");
-
 const PACKAGE_JSON = require("../package.json");
 const VERSION = PACKAGE_JSON.version;
 const BINARY_NAME = "tkit";
@@ -58,35 +60,9 @@ function downloadFile(url, maxRedirects = 5) {
       return;
     }
 
-    const protocol = url.startsWith("https") ? https : require("http");
-
-    protocol
-      .get(url, (response) => {
-        // Handle redirects (GitHub releases use redirects)
-        if (
-          response.statusCode >= 300 &&
-          response.statusCode < 400 &&
-          response.headers.location
-        ) {
-          downloadFile(response.headers.location, maxRedirects - 1)
-            .then(resolve)
-            .catch(reject);
-          return;
-        }
-
-        if (response.statusCode !== 200) {
-          reject(
-            new Error(`Failed to download: HTTP ${response.statusCode}`)
-          );
-          return;
-        }
-
-        const chunks = [];
-        response.on("data", (chunk) => chunks.push(chunk));
-        response.on("end", () => resolve(Buffer.concat(chunks)));
-        response.on("error", reject);
-      })
-      .on("error", reject);
+    const protocol = url.startsWith("https") ? https : http;
+
+    protocol.get(url, (response) => handleDownloadResponse(response, resolve, reject, maxRedirects)).on("error", reject);
   });
 }
 
@@ -102,6 +78,62 @@ async function extractZip(zipBuffer, destDir) {
   }
 }
 
+/**
+ *
+ * @param {http.IncomingMessage} response
+ * @returns
+ */
+function handleDownloadResponse(response, resolve, reject, maxRedirects) {
+  // Handle redirects (GitHub releases use redirects)
+  const mustHandleRedirects =
+    response.statusCode >= 300 &&
+    response.statusCode < 400 &&
+    response.headers.location;
+
+  if (mustHandleRedirects) {
+    downloadFile(response.headers.location, maxRedirects - 1)
+      .then(resolve)
+      .catch(reject);
+    return;
+  }
+
+  if (response.statusCode !== 200) {
+    reject(new Error(`Failed to download: HTTP ${response.statusCode}`));
+    return;
+  }
+
+  const chunks = [];
+  const totalBytes = parseInt(response.headers["content-length"] || "0", 10);
+  let downloadedBytes = 0;
+  let nextLogPercent = 0;
+
+  if (totalBytes > 0) {
+    console.log("Download progress: 0%");
+    nextLogPercent = 10;
+  }
+
+  response.on("data", (chunk) => {
+    chunks.push(chunk);
+    downloadedBytes += chunk.length;
+
+    if (totalBytes > 0) {
+      const percent = Math.floor((downloadedBytes / totalBytes) * 100);
+      while (percent >= nextLogPercent && nextLogPercent <= 100) {
+        console.log(`Download progress: ${nextLogPercent}%`);
+        nextLogPercent += 10;
+      }
+    }
+  });
+
+  response.on("end", () => {
+    if (totalBytes <= 0 || nextLogPercent <= 100) {
+      console.log("Download progress: 100%");
+    }
+    resolve(Buffer.concat(chunks));
+  });
+  response.on("error", reject);
+}
+
 /**
  * Make the binary executable (Unix only)
  */
@@ -111,6 +143,7 @@ function makeExecutable(filePath) {
   }
 }
 
+
 /**
  * Main installation function
  */
@@ -118,12 +151,7 @@ async function install() {
   const binDir = path.join(__dirname, "..", "cli");
   const binaryName = getBinaryName();
   const binaryPath = path.join(binDir, binaryName);
-
-  // Check if binary already exists
-  if (fs.existsSync(binaryPath)) {
-    console.log(`✓ ${BINARY_NAME} binary already exists`);
-    return;
-  }
+  const binaryExists = fs.existsSync(binaryPath);
 
   // Ensure bin directory exists
   if (!fs.existsSync(binDir)) {
@@ -132,29 +160,69 @@ async function install() {
 
   const downloadUrl = getDownloadUrl();
   console.log(`Downloading ${BINARY_NAME} v${VERSION}...`);
-  console.log(`  Platform: ${process.platform} (${PLATFORM_MAP[process.platform]})`);
+  console.log(
+    `  Platform: ${process.platform} (${PLATFORM_MAP[process.platform]})`,
+  );
   console.log(`  Architecture: ${process.arch} (${ARCH_MAP[process.arch]})`);
   console.log(`  URL: ${downloadUrl}`);
 
+  if (binaryExists) {
+    console.log(
+      `ℹ Existing ${BINARY_NAME} binary found, downloading new version...`,
+    );
+  }
+
+  let tempDir;
   try {
+    // Create temporary directory in system temp location
+    tempDir = fs.mkdtempSync(path.join(os.tmpdir(), `${BINARY_NAME}-`));
+
     // Download the zip file
     const zipBuffer = await downloadFile(downloadUrl);
     console.log(`Downloaded ${(zipBuffer.length / 1024 / 1024).toFixed(2)} MB`);
 
-    // Extract to bin directory
+    // Extract to temporary directory first
     console.log("Extracting...");
-    await extractZip(zipBuffer, binDir);
+    await extractZip(zipBuffer, tempDir);
+
+    // Get the extracted binary path from temp directory
+    const tempBinaryPath = path.join(tempDir, binaryName);
+
+    if (!fs.existsSync(tempBinaryPath)) {
+      throw new Error("Binary not found after extraction");
+    }
 
     // Make executable
-    makeExecutable(binaryPath);
+    makeExecutable(tempBinaryPath);
+
+    // Remove old binary if it exists, then move new binary
+    if (binaryExists) {
+      try {
+        removeExistingBinary(binaryPath);
+      } catch (error) {
+        // If removal fails, clean up temp and rethrow
+        fs.rmSync(tempDir, { recursive: true, force: true });
+        throw error;
+      }
+    }
+
+    // Move new binary from temp to final location
+    fs.renameSync(tempBinaryPath, binaryPath);
+
+    // Clean up temporary directory
+    fs.rmSync(tempDir, { recursive: true, force: true });
 
     // Verify installation
     if (fs.existsSync(binaryPath)) {
       console.log(`✓ Successfully installed ${BINARY_NAME} v${VERSION}`);
     } else {
-      throw new Error("Binary not found after extraction");
+      throw new Error("Binary not found after installation");
     }
   } catch (error) {
+    // Clean up temp directory on error
+    if (tempDir && fs.existsSync(tempDir)) {
+      fs.rmSync(tempDir, { recursive: true, force: true });
+    }
     console.error(`✗ Failed to install ${BINARY_NAME}: ${error.message}`);
     console.error("");
     console.error("You can manually download the binary from:");
@@ -166,5 +234,29 @@ async function install() {
   }
 }
 
+function removeExistingBinary(binaryPath) {
+  try {
+    fs.unlinkSync(binaryPath);
+  } catch (error) {
+    console.error(
+      `✗ Failed to remove existing ${BINARY_NAME} binary: ${error.message}`,
+    );
+    process.exit(1);
+  }
+}
+
+
 // Run installation
 install();
+
+// Export functions for testing
+module.exports = {
+  install,
+  downloadFile,
+  extractZip,
+  makeExecutable,
+  removeExistingBinary,
+  getBinaryName,
+  getDownloadUrl,
+  handleDownloadResponse,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testflowkit/cli",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "publishConfig": {
     "access": "public"
   },
@@ -10,7 +10,10 @@
     "tkit": "bin/cli.js"
   },
   "scripts": {
-    "postinstall": "node ./lib/install.js"
+    "postinstall": "node -e \"process.env.CI || require('./lib/install.js')\"",
+    "test": "node --test ./lib/install.*.test.js",
+    "test:unit": "node --test ./lib/install.test.js",
+    "test:integration": "node ./lib/install.integration.test.js"
   },
   "repository": {
     "type": "git",
@@ -32,7 +35,7 @@
   "bugs": {
     "url": "https://github.com/TestFlowKit/testflowkit/issues"
   },
-  "homepage": "https://github.com/TestFlowKit/testflowkit#readme",
+  "homepage": "https://testflowkit.github.io/testflowkit",
   "os": [
     "darwin",
     "linux",

package/lib/index.js

@@ -1,48 +0,0 @@
-/**
- * @testflowkit/cli
- *
- * This package provides the TestFlowKit CLI (tkit) for running
- * end-to-end tests using Gherkin syntax.
- *
- * Usage:
- *   npx @testflowkit/cli run
- *   npx @testflowkit/cli init
- *   npx @testflowkit/cli validate
- *   npx @testflowkit/cli --version
- *
- * For programmatic usage, you can get the path to the binary:
- */
-
-const path = require("path");
-const fs = require("fs");
-
-const BINARY_NAME = process.platform === "win32" ? "tkit.exe" : "tkit";
-const binaryPath = path.join(__dirname, "..", "cli", BINARY_NAME);
-
-/**
- * Get the path to the tkit binary
- * @returns {string} Absolute path to the tkit binary
- * @throws {Error} If the binary is not found
- */
-function getBinaryPath() {
-  if (!fs.existsSync(binaryPath)) {
-    throw new Error(
-      `tkit binary not found. Please reinstall @testflowkit/cli`
-    );
-  }
-  return binaryPath;
-}
-
-/**
- * Check if the binary is installed
- * @returns {boolean} True if the binary exists
- */
-function isInstalled() {
-  return fs.existsSync(binaryPath);
-}
-
-module.exports = {
-  getBinaryPath,
-  isInstalled,
-  binaryPath,
-};