Merge branch 'main' into user-guide-ToC

Author: MustafaAbdaal

backend/restapi_server.py

@@ -4,6 +4,7 @@
 #
 import argparse
 import os
+import signal
 import sys
 from flask import Flask, request, jsonify
 from flasgger import Swagger
@@ -34,7 +35,7 @@ def main():
     args = parser.parse_args()
 
     # setup app logger
-    log_setup(filename=args.logfile, max_bytes=args.maxbytes*1024, backup_count=args.backupcount)
+    log_setup(filename=args.logfile, max_bytes=args.maxbytes * 1024, backup_count=args.backupcount)
 
     # Check if the device_file exists
     if os.path.exists(args.device_file) == False:
@@ -54,7 +55,7 @@ def main():
         "swagger": "2.0",
         "info": {
             "title": "RPE Backend API",
-            "description": "The RPE Backend APIs which consumed by the RPE frontend for power and thermal estimation of the Rapid Silicon devices.",
+            "description": "The RPE Backend APIs which are consumed by the RPE frontend for power and thermal estimation of the Rapid Silicon devices.",
             "version": "0.1.0"
         }
     }
@@ -81,6 +82,25 @@ def after_request(response):
         log(f"{request.method} {request.url} {response.status_code} - DONE")
         return response
 
+    # Graceful shutdown function
+    def shutdown_server():
+        log("Shutting down server...")
+        func = request.environ.get('werkzeug.server.shutdown')
+        if func is not None:
+            func()
+        else:
+            log("Server shutdown function not found.", RsLogLevel.ERROR)
+
+    # Signal handler for smooth shutdown
+    def signal_handler(signal_received, frame):
+        log(f"Signal {signal_received} received, initiating shutdown...")
+        shutdown_server()
+        sys.exit(0)
+
+    # Register the signal handler for SIGINT (Ctrl+C) and SIGTERM
+    signal.signal(signal.SIGINT, signal_handler)
+    signal.signal(signal.SIGTERM, signal_handler)
+
     # log app server started
     log("App server is running...")
 

cleanup.js

@@ -1,12 +1,36 @@
-const isWindows = process.platform === 'win32';
+const os = require('os');
+const platform = os.platform();
 
 const kill = (process) => {
-  if (isWindows) {
-    const kill = require('tree-kill');
-    kill(process.pid);
-  } else {
-    process.kill('SIGINT');
-  }
+    console.log(`Attempting to kill process with PID: ${process.pid}`);
+    const { spawn } = require('child_process');
+    if (platform === 'win32') {
+        // used taskkill for Windows to terminate the process tree
+        const taskKill = spawn('taskkill', ['/PID', process.pid, '/T', '/F']);
+        taskKill.on('close', (code) => {
+            if (code === 0) {
+                console.log('Process killed successfully on Windows.');
+            } else {
+                console.error(`taskkill failed with exit code: ${code}`);
+            }
+        });
+    } else if (platform === 'darwin' || platform === 'linux') {
+        const taskKill = spawn('kill', ['-9', process.pid]);
+        taskKill.on('close', (code) => {
+            if (code === 0) {
+                console.log('Process killed successfully on Unix.');
+            } else {
+                console.error(`taskkill failed with exit code: ${code}`);
+            }
+        });
+    } else {
+        try {
+            process.kill('SIGINT');
+            console.log('SIGINT sent to process');
+        } catch (error) {
+            console.error(`Failed to send SIGINT: ${error.message}`);
+        }
+    }
 };
 
 module.exports = { kill };

docs/source/user_guide/FPGA_index.rst

@@ -2,7 +2,6 @@
 FPGA Input
 =============
 
-This section will document FPGA input for Rapid Power Estimator.
 
 To begin inputting FPGA information, the user must have an RTL design that they would like to run on an FPGA platform. For users who have used other FPGA vendors' EDA tools, they can directly enter the FPGA input using their estimated FPGA utilization. 
 
@@ -77,4 +76,5 @@ Selecting the IO section displays an empty table, click the "Add" button above t
 
 .. image:: figures/FPGA-figures-IO-input_IO_info2.JPG
 
-Enter I/O port name, bus width, select clock, enter duty cycle, select IO direction & standard, drive strength (current in Amperes), slew rate, differential termination, pullup/pulldown resistors, data type, enter input enable rate, output enable rate, select synchronization & enter toggle rate
+Enter I/O port name, bus width, select clock, enter duty cycle, select IO direction & standard, drive strength (current in Amperes), slew rate, differential termination, pullup/pulldown resistors, data type, enter input enable rate, output enable rate, select synchronization & enter toggle rate
+

docs/source/user_guide/SoC_index.rst

@@ -105,3 +105,4 @@ Enable/disable each channel using the checkboxes under the Enable column, then c
 .. image:: figures/SoC-figures-DMA-put_DMA_info.JPG
 
 For each channel, select a source & destination, typically a peripheral will be connected to a memory or vice-versa. Then select the active state, read/write rate & toggle rate.
+

main.js

@@ -317,7 +317,10 @@ app.whenReady().then(() => {
   });
 });
 
-app.on('window-all-closed', () => {
+app.on("before-quit", function () {
   kill(serverProcess);
+})
+
+app.on('window-all-closed', () => {
   if (process.platform !== 'darwin') app.quit();
 });

tests/e2e/acpu.test.js

@@ -1,44 +1,38 @@
-// const { _electron: electron } = require('playwright');
-// const { test, expect } = require('@playwright/test');
-
-// test('Launch Electron app, select device MPW1 Gemini, and click on BCPU block', async () => {
-//   const app = await electron.launch({ args: ['main.js'], headless: false });
-
-//   const window = await app.firstWindow();
-
-//   // selecting MPW1 Gemini from device dropdown
-//   const deviceDropdown = await window.waitForSelector('#deviceId');
-//   await deviceDropdown.selectOption('MPW1');
-//   await window.waitForTimeout(2000); // wait for UI update
-
-//   // click on the BCPU block
-//   const bcpuSelector = '#app > div > div.top-row-container > div.main-table-container.main-border > div.top-l2 > div.top-l2-col1 > div.top-l2-col1-row1 > div:nth-child(2) > div';
-//   await window.waitForSelector(bcpuSelector); 
-//   await window.click(bcpuSelector); 
-
-//   // click on "Add" button
-//   const addButtonSelector = '#app > div > div.table-container.main-border > div > div.cpu-container > div.table-wrapper > button';
-//   await window.waitForSelector(addButtonSelector, { state: 'visible' });
-//   await window.click(addButtonSelector); 
-
-//   // click on "OK" button
-//   const okButtonSelector = 'button.ant-btn-primary';
-//   await window.waitForSelector(okButtonSelector, { state: 'visible' });
-//   await window.click(okButtonSelector);
-
-//   // click on Peripherals tab
-//   const peripheralsTabSelector = '#app > div > div.top-row-container > div.main-table-container.main-border > div.top-l2 > div.top-l2-col1 > div:nth-child(3) > div > div:nth-child(2) > div:nth-child(2) > div.periph-internal-font-header';
-//   await window.waitForSelector(peripheralsTabSelector, { state: 'visible' });
-//   await window.click(peripheralsTabSelector);
-
-//   // check SPI/QSPI block
-//   const spiQspiCheckSelector = '#\\30';
-//   await window.waitForSelector(spiQspiCheckSelector, { state: 'visible' });
-//   await window.click(spiQspiCheckSelector);
-
-//   // waiting to observe result on UI
-//   await window.waitForTimeout(5000);
-
-//   // closing RPE
-//   await app.close();
-// });
+const { _electron: electron } = require('playwright');
+const { test, expect } = require('@playwright/test');
+
+test('Launch Electron app, select device MPW1 Gemini, and click on BCPU block', async () => {
+  const app = await electron.launch({ args: ['main.js'], headless: false });
+  const window = await app.firstWindow();
+
+  // Selecting MPW1 Gemini from device dropdown
+  const deviceDropdown = await window.waitForSelector('#deviceId');
+  await deviceDropdown.selectOption('MPW1');
+
+  // Click on the BCPU block
+  const bcpuSelector = '#app > div > div.top-row-container > div.main-table-container.main-border > div.top-l2 > div.top-l2-col1 > div.top-l2-col1-row1 > div:nth-child(2) > div';
+  await window.click(bcpuSelector);
+
+  // Click on "Add" button
+  const addButtonSelector = '#app > div > div.table-container.main-border > div > div.cpu-container > div.table-wrapper > button';
+  await window.waitForSelector(addButtonSelector, { state: 'visible' });
+  await window.click(addButtonSelector);
+
+  // Click on "OK" button
+  const okButtonSelector = 'button.ant-btn-primary';
+  await window.waitForSelector(okButtonSelector, { state: 'visible' });
+  await window.click(okButtonSelector);
+
+  // Click on Peripherals tab
+  const peripheralsTabSelector = '#app > div > div.top-row-container > div.main-table-container.main-border > div.top-l2 > div.top-l2-col1 > div:nth-child(3)';
+  await window.click(peripheralsTabSelector);
+
+  // Check SPI/QSPI block
+  const spiQspiCheckSelector = '#\\30';
+  await window.click(spiQspiCheckSelector);
+
+  console.log('BCPU power verified.');
+
+  // Close the app
+  await app.close();
+});

tests/e2e/bcpu.test.js

@@ -1,51 +1,51 @@
-// const { _electron: electron } = require('playwright');
-// const { test, expect } = require('@playwright/test');
-
-// test('Launch Electron app, select device, toggle ACPU power, click Clocking, Add clock source, and submit form', async () => {
-//   const app = await electron.launch({ args: ['main.js'] });
-//   const window = await app.firstWindow();
-
-//   // Selecting the device (MPW1 Gemini)
-//   const deviceDropdown = await window.waitForSelector('#deviceId');
-//   await deviceDropdown.selectOption('MPW1');
-//   await new Promise((resolve) => setTimeout(resolve, 2000)); // Wait for 2 seconds
-
-//   // Selecting Clocking block
-//   const clockingBlockSelector = '#app > div > div.top-row-container > div.main-table-container.main-border > div.top-l2 > div.top-l2-col2 > div.top-l2-col2-elem > div > div:nth-child(2) > div:nth-child(1) > div';
-//   const clockingBlock = await window.waitForSelector(clockingBlockSelector);
-//   await clockingBlock.click();
-//   await new Promise((resolve) => setTimeout(resolve, 2000)); // Wait for 2 seconds
-
-//   // Clicking on Add button
-//   const addButtonSelector = '#app > div > div.table-container.main-border > div > div.power-and-table-wrapper > div.table-wrapper > button';
-//   const addButton = await window.waitForSelector(addButtonSelector);
-//   await addButton.click();
-//   await new Promise((resolve) => setTimeout(resolve, 2000)); // Wait for 2 seconds
-
-//   // Ensure modal is visible before interacting
-//   const modalSelector = 'body > div:nth-child(3) > div > div.ant-modal-wrap > div';
-//   await window.waitForSelector(modalSelector, { state: 'visible', timeout: 5000 }); // Wait for modal
-
-//   // Typing description as 'test'
-//   const descriptionSelector = 'body > div:nth-child(3) > div > div.ant-modal-wrap > div > div:nth-child(1) > div > div.ant-modal-body > div > form > div:nth-child(2) > input[type=text]';
-//   const descriptionInput = await window.waitForSelector(descriptionSelector);
-//   await descriptionInput.click();
-//   await descriptionInput.fill('test');
-//   await new Promise((resolve) => setTimeout(resolve, 1000)); // Wait for 1 second
-
-//   // Typing Port/Signal name as 'test'
-//   const portSignalSelector = 'body > div:nth-child(3) > div > div.ant-modal-wrap > div > div:nth-child(1) > div > div.ant-modal-body > div > form > div:nth-child(3) > input[type=text]';
-//   const portSignalInput = await window.waitForSelector(portSignalSelector);
-//   await portSignalInput.click();
-//   await portSignalInput.fill('test');
-//   await new Promise((resolve) => setTimeout(resolve, 1000)); // Wait for 1 second
-
-//   // Clicking OK to submit the form
-//   const okButtonSelector = 'body > div:nth-child(3) > div > div.ant-modal-wrap > div > div:nth-child(1) > div > div.ant-modal-footer > button.ant-btn.css-dev-only-do-not-override-apn68.ant-btn-primary.ant-btn-color-primary.ant-btn-variant-solid';
-//   const okButton = await window.waitForSelector(okButtonSelector);
-//   await okButton.click();
-
-//   // Closing the test
-//   await app.close();
-// });
+const { _electron: electron } = require('playwright');
+const { test, expect } = require('@playwright/test');
+
+test('Launch Electron app, select device, toggle ACPU power, click Clocking, Add clock source, and submit form', async () => {
+  const app = await electron.launch({ args: ['main.js'] });
+  const window = await app.firstWindow();
+
+  // Selecting the device (MPW1 Gemini)
+  const deviceDropdown = await window.waitForSelector('#deviceId');
+  await deviceDropdown.selectOption('MPW1');
+  await new Promise((resolve) => setTimeout(resolve, 2000)); // Wait for 2 seconds
+
+  // Selecting Clocking block
+  const clockingBlockSelector = '#app > div > div.top-row-container > div.main-table-container.main-border > div.top-l2 > div.top-l2-col2 > div.top-l2-col2-elem > div > div:nth-child(2) > div:nth-child(1) > div';
+  const clockingBlock = await window.waitForSelector(clockingBlockSelector);
+  await clockingBlock.click();
+  await new Promise((resolve) => setTimeout(resolve, 2000)); // Wait for 2 seconds
+
+  // Clicking on Add button
+  const addButtonSelector = '#app > div > div.table-container.main-border > div > div.power-and-table-wrapper > div.table-wrapper > button';
+  const addButton = await window.waitForSelector(addButtonSelector);
+  await addButton.click();
+  await new Promise((resolve) => setTimeout(resolve, 2000)); // Wait for 2 seconds
+
+  // Ensure modal is visible before interacting
+  const modalSelector = 'body > div:nth-child(3) > div > div.ant-modal-wrap > div';
+  await window.waitForSelector(modalSelector, { state: 'visible', timeout: 5000 }); // Wait for modal
+
+  // Typing description as 'test'
+  const descriptionSelector = 'body > div:nth-child(3) > div > div.ant-modal-wrap > div > div:nth-child(1) > div > div.ant-modal-body > div > form > div:nth-child(2) > input[type=text]';
+  const descriptionInput = await window.waitForSelector(descriptionSelector);
+  await descriptionInput.click();
+  await descriptionInput.fill('test');
+  await new Promise((resolve) => setTimeout(resolve, 1000)); // Wait for 1 second
+
+  // Typing Port/Signal name as 'test'
+  const portSignalSelector = 'body > div:nth-child(3) > div > div.ant-modal-wrap > div > div:nth-child(1) > div > div.ant-modal-body > div > form > div:nth-child(3) > input[type=text]';
+  const portSignalInput = await window.waitForSelector(portSignalSelector);
+  await portSignalInput.click();
+  await portSignalInput.fill('test');
+  await new Promise((resolve) => setTimeout(resolve, 1000)); // Wait for 1 second
+
+  // Clicking OK to submit the form
+  const okButtonSelector = 'body > div:nth-child(3) > div > div.ant-modal-wrap > div > div:nth-child(1) > div > div.ant-modal-footer > button.ant-btn.css-dev-only-do-not-override-49qm.ant-btn-primary.ant-btn-color-primary.ant-btn-variant-solid > span';
+  const okButton = await window.waitForSelector(okButtonSelector);
+  await okButton.click();
+
+  // Closing the test
+  await app.close();
+});