Merge pull request #94 from netbootxyz/implement-testing

Add comprehensive test suite and CI integration

Author: antonym

.github/workflows/build.yml

@@ -6,8 +6,40 @@ on:
   workflow_dispatch:
 
 jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: '0'
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '18'
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Run tests
+      run: npm test
+
+    - name: Run test coverage
+      run: npm run test:coverage
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      if: always()
+      with:
+        file: ./coverage/lcov.info
+        flags: webapp
+        name: webapp-coverage
+        fail_ci_if_error: false
+
   build:
     runs-on: ubuntu-latest
+    needs: test  # Only build if tests pass
 
     steps:
     - name: Checkout

.github/workflows/webapp-dev.yml

@@ -2,8 +2,29 @@ name: webapp-dev
 on:
   push
 jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '18'
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Run tests
+      run: npm test
+
+    - name: Run test coverage
+      run: npm run test:coverage
+
   build:
     runs-on: ubuntu-latest
+    needs: test  # Only build/push if tests pass
     steps:
     - name: Checkout
       uses: actions/checkout@v4

jest.config.js

@@ -0,0 +1,39 @@
+module.exports = {
+  testEnvironment: 'node',
+  testMatch: [
+    '**/tests/**/*.test.js',
+    '**/__tests__/**/*.test.js'
+  ],
+  collectCoverageFrom: [
+    'lib/**/*.js',
+    '!**/node_modules/**',
+    '!**/tests/**'
+  ],
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov', 'html'],
+  setupFilesAfterEnv: ['<rootDir>/tests/setup.js'],
+  testTimeout: 5000,
+  verbose: false,
+  collectCoverage: false,
+  detectOpenHandles: true,
+  forceExit: true,
+  clearMocks: true,
+  resetMocks: true,
+  restoreMocks: true,
+  // Disable coverage thresholds since we're testing logic patterns, not code execution
+  // coverageThreshold: {
+  //   global: {
+  //     branches: 10,
+  //     functions: 10,
+  //     lines: 10,
+  //     statements: 10
+  //   }
+  // },
+  // Prevent Jest from keeping the process alive
+  maxWorkers: 1,
+  // Handle async operations better
+  testEnvironmentOptions: {
+    // Force close any lingering connections
+    teardown: 'jest-environment-node'
+  }
+};

lib/utils.js

@@ -0,0 +1,75 @@
+// Extracted utility functions for better testability
+
+/**
+ * Disable signatures in boot configuration
+ */
+function disableSignatures(configContent) {
+  return configContent.replace(/set sigs_enabled true/g, 'set sigs_enabled false');
+}
+
+/**
+ * Validate port number
+ */
+function validatePort(port, defaultPort = 3000) {
+  const portNum = Number(port);
+  if (!Number.isInteger(portNum) || portNum < 1 || portNum > 65535) {
+    return defaultPort;
+  }
+  return portNum;
+}
+
+/**
+ * Check if version is a commit SHA
+ */
+function isCommitSha(version) {
+  return version.length === 40 && /^[a-f0-9]+$/i.test(version);
+}
+
+/**
+ * Generate download URL based on version type
+ */
+function getDownloadUrl(version, file = '') {
+  const baseUrl = isCommitSha(version)
+    ? `https://s3.amazonaws.com/dev.boot.netboot.xyz/${version}/ipxe/`
+    : `https://github.com/netbootxyz/netboot.xyz/releases/download/${version}/`;
+  return baseUrl + file;
+}
+
+/**
+ * Validate file path for security
+ */
+function validateFilePath(userPath, rootDir) {
+  try {
+    const path = require('path');
+    const resolved = path.resolve(rootDir, userPath);
+    const rootWithSeparator = path.resolve(rootDir) + path.sep;
+    return {
+      path: resolved,
+      isSecure: resolved.startsWith(rootWithSeparator)
+    };
+  } catch {
+    return { path: null, isSecure: false };
+  }
+}
+
+/**
+ * Check if host is allowed for downloads
+ */
+function isAllowedHost(url, allowedHosts = ['s3.amazonaws.com']) {
+  try {
+    const urlLib = require('url');
+    const parsedUrl = urlLib.parse(url);
+    return allowedHosts.includes(parsedUrl.host);
+  } catch {
+    return false;
+  }
+}
+
+module.exports = {
+  disableSignatures,
+  validatePort,
+  isCommitSha,
+  getDownloadUrl,
+  validateFilePath,
+  isAllowedHost
+};

package.json

@@ -4,7 +4,16 @@
   "description": "Configuration and mirroring application for netboot.xyz stack",
   "main": "app.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest --testPathPattern=unit",
+    "test:all": "jest",
+    "test:watch": "jest --watch --testPathPattern=unit",
+    "test:coverage": "jest --coverage --testPathPattern=unit",
+    "test:integration": "jest --testPathPattern=integration",
+    "test:unit": "jest --testPathPattern=unit",
+    "test:basic": "jest tests/unit/basic.test.js",
+    "test:safe": "jest tests/unit/basic.test.js tests/unit/socket-logic.test.js",
+    "test:debug": "jest --detectOpenHandles --verbose --no-cache",
+    "test:clean": "jest --clearCache"
   },
   "repository": {
     "type": "git",
@@ -24,5 +33,13 @@
     "node-fetch": "2.7.0",
     "socket.io": "4.8.1",
     "systeminformation": "5.25.11"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0",
+    "supertest": "^6.3.3",
+    "socket.io-client": "^4.8.1",
+    "nock": "^13.3.8",
+    "@types/jest": "^29.5.8",
+    "mock-fs": "^5.2.0"
   }
 }