feat: import test cases from excel files (xlsx, xls) (#334)

backend/routes/cases/import.js

@@ -0,0 +1,145 @@
+import path from 'path';
+import express from 'express';
+const router = express.Router();
+import multer from 'multer';
+import XLSX from 'xlsx';
+import { DataTypes } from 'sequelize';
+import defineCase from '../../models/cases.js';
+import authMiddleware from '../../middleware/auth.js';
+import editableMiddleware from '../../middleware/verifyEditable.js';
+import { priorities, testTypes, automationStatus, templates } from '../../config/enums.js';
+
+const fileFilter = (req, file, cb) => {
+  const allowedFileTypes = ['.xlsx', '.xls'];
+  const allowedMimeTypes = [
+    'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+    'application/vnd.ms-excel',
+  ];
+  const extname = allowedFileTypes.includes(path.extname(file.originalname).toLowerCase());
+  const mimetype = allowedMimeTypes.includes(file.mimetype);
+
+  if (extname && mimetype) {
+    return cb(null, true);
+  } else {
+    cb(new Error('Only Excel files (.xlsx, .xls) are allowed!'));
+  }
+};
+
+const storage = multer.memoryStorage();
+const upload = multer({
+  storage: storage,
+  fileFilter,
+  limits: { fileSize: 50 * 1024 * 1024 }, // 50 MB limit
+});
+
+export default function (sequelize) {
+  const Case = defineCase(sequelize, DataTypes);
+  const { verifySignedIn } = authMiddleware(sequelize);
+  const { verifyProjectDeveloperFromFolderId } = editableMiddleware(sequelize);
+
+  router.post(
+    '/import',
+    (req, res, next) => {
+      upload.single('file')(req, res, function (err) {
+        if (err) {
+          return res.status(400).json({ error: err.message });
+        }
+        next();
+      });
+    },
+    verifySignedIn,
+    verifyProjectDeveloperFromFolderId,
+    async (req, res) => {
+      const { folderId } = req.query;
+
+      if (!req.file || !req.file.buffer) {
+        return res.status(400).json({ error: 'No file uploaded' });
+      }
+
+      if (!folderId) {
+        return res.status(400).json({ error: 'folderId is required' });
+      }
+
+      try {
+        const workbook = XLSX.read(req.file.buffer, { type: 'buffer' });
+        const sheetName = workbook.SheetNames[0];
+        const worksheet = workbook.Sheets[sheetName];
+        const jsonData = XLSX.utils.sheet_to_json(worksheet);
+
+        let errorMessage = null;
+        const casesToCreate = [];
+        const requiredFields = ['title', 'preConditions', 'expectedResults'];
+        for (const [index, row] of jsonData.entries()) {
+          const rowNumber = index + 2;
+          for (const field of requiredFields) {
+            if (!row[field]) {
+              errorMessage = `Row ${rowNumber} is missing required field: ${field}`;
+              console.log(`Error found for field: ${errorMessage}`);
+            }
+          }
+
+          // Validate priority if provided
+          let priorityIndex = priorities.indexOf('medium'); // default to 'medium'
+          if (row['priority']) {
+            priorityIndex = priorities.indexOf(row['priority'].toLowerCase());
+            if (priorityIndex === -1) {
+              errorMessage = `Row ${rowNumber} has invalid priority: ${row['priority']}`;
+            }
+          }
+
+          // Validate type if provided
+          let typeIndex = testTypes.indexOf('other'); // default to 'other'
+          if (row['type']) {
+            typeIndex = testTypes.indexOf(row['type'].toLowerCase());
+            if (typeIndex === -1) {
+              errorMessage = `Row ${rowNumber} has invalid type: ${row['type']}`;
+            }
+          }
+
+          // Validate automationStatus if provided
+          let automationStatusIndex = automationStatus.indexOf('automation-not-required'); // default to 'automation-not-required'
+          if (row['automationStatus']) {
+            automationStatusIndex = automationStatus.indexOf(row['automationStatus'].toLowerCase());
+            if (automationStatusIndex === -1) {
+              errorMessage = `Row ${rowNumber} has invalid automationStatus: ${row['automationStatus']}`;
+            }
+          }
+
+          // Validate template if provided
+          let templateIndex = templates.indexOf('text'); // default to 'text'
+          if (row['template']) {
+            templateIndex = templates.indexOf(row['template'].toLowerCase());
+            if (templateIndex === -1) {
+              errorMessage = `Row ${rowNumber} has invalid template: ${row['template']}`;
+            }
+          }
+
+          if (errorMessage) {
+            return res.status(400).json({ error: errorMessage });
+          }
+
+          casesToCreate.push({
+            folderId: folderId,
+            title: row['title'],
+            description: row['description'] || '',
+            state: 0, // default state
+            priority: priorityIndex,
+            type: typeIndex,
+            preConditions: row['preConditions'],
+            expectedResults: row['expectedResults'],
+            automationStatus: automationStatusIndex,
+            template: templateIndex,
+          });
+        }
+
+        const createdCases = await Case.bulkCreate(casesToCreate);
+        res.json(createdCases);
+      } catch (error) {
+        console.error(error);
+        res.status(500).send('Internal Server Error');
+      }
+    }
+  );
+
+  return router;
+}