Add Front-End Code Coverage with Jest and Backend PyTests for BRAM API Endpoints (#153)

* adding the lines to upload the npm coverage report

* added the necessary packages to run the npm test

* Deleted App.test.js as it's no longer needed

* updating rpe_test.yml to include front-end test coverage using npm and Codecov

* doing changes for codecov > pytests and npm tests

* PyTests for BRAM API endpoints

* adding necessary packages and changes in config files

* doing changres in jest.config.js

Author: shivaahir158

.github/workflows/rpe_test.yml

@@ -243,6 +243,7 @@ jobs:
       - name: Install dependencies
         run: | 
               pip install -r requirements.txt
+              npm install
     
       - name: Run pytest with Codecov
         run: python3 -m pytest --cov=. --cov-report=term-missing 
@@ -252,9 +253,12 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           slug: os-fpga/rapid_power_estimator
-    
-      
-    
-
-  
 
+      - name: Run npm test with Codecov
+        run: npm test
+        
+      - name: Upload results to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: os-fpga/rapid_power_estimator

babel.config.js

@@ -1,6 +1,8 @@
 module.exports = {
-  presets: [
-    '@babel/preset-env',
-    ['@babel/preset-react', { runtime: 'automatic' }],
-  ],
+  presets: ['@babel/preset-env', '@babel/preset-react'],
+  env: {
+    test: {
+      plugins: ['istanbul']
+    }
+  }
 };

jest.config.js

@@ -1,8 +1,16 @@
 module.exports = {
   moduleNameMapper: {
-    '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
-        '<rootDir>/__mocks__/fileMock.js',
+    '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir>/__mocks__/fileMock.js',
     '\\.(css|less)$': 'identity-obj-proxy',
   },
   testEnvironment: 'jsdom',
+  
+  collectCoverage: true,
+  collectCoverageFrom: [
+    "src/**/*.{js,jsx}",  
+    "!src/**/*.test.{js,jsx}", 
+    "!src/**/index.{js,jsx}", 
+  ],
+  coverageReporters: ['text', 'lcov'],  
+  coverageDirectory: "coverage",  
 };

package.json

@@ -7,10 +7,10 @@
   "scripts": {
     "start": "webpack --mode development && electron . --development",
     "build": "webpack --mode production && electron .",
-    "test": "jest src/tests",
+    "test": "jest --coverage --coverageDirectory=coverage", 
     "postinstall": "electron-builder install-app-deps",
     "pack": "electron-builder --dir",
-    "dist": "pyinstaller --distpath backend --workpath dist -y --clean -n restapi_server.exe --onefile  backend/restapi_server.py && webpack --mode production && electron-builder -p never"
+    "dist": "pyinstaller --distpath backend --workpath dist -y --clean -n restapi_server.exe --onefile backend/restapi_server.py && webpack --mode production && electron-builder -p never"
   },
   "build": {
     "appId": "org.rapidsilicon.rapid_power_estimator",
@@ -86,11 +86,12 @@
     "@babel/core": "^7.23.9",
     "@babel/preset-env": "^7.24.4",
     "@babel/preset-react": "^7.24.1",
-    "@testing-library/jest-dom": "^6.4.2",
-    "@testing-library/react": "^14.3.0",
+    "@testing-library/jest-dom": "^6.5.0",
+    "@testing-library/react": "^14.3.1",
     "@testing-library/user-event": "^14.5.2",
     "babel-jest": "^29.7.0",
     "babel-loader": "^9.1.3",
+    "babel-plugin-istanbul": "^7.0.0",  
     "css-loader": "^6.10.0",
     "electron": "^28.2.2",
     "electron-builder": "^24.13.3",
@@ -101,15 +102,15 @@
     "identity-obj-proxy": "^3.0.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "react-test-renderer": "^18.2.0",
+    "react-test-renderer": "^18.3.1",
     "style-loader": "^3.3.4",
     "webpack": "^5.90.1",
     "webpack-cli": "^5.1.4"
   },
   "dependencies": {
     "antd": "^5.15.4",
-    "electron-store": "^8.2.0",
     "electron-log": "^5.1.2",
+    "electron-store": "^8.2.0",
     "moment": "^2.30.1",
     "prop-types": "^15.8.1",
     "react": "^18.2.0",

src/tests/App.test.js

@@ -0,0 +1,59 @@
+import pytest
+from flask import Flask
+from flask.testing import FlaskClient
+from unittest.mock import patch
+from submodule.rs_device_manager import RsDeviceManager
+from submodule.rs_device_resources import DeviceNotFoundException, BramNotFoundException
+from api.bram import bram_api 
+
+@pytest.fixture
+def client() -> FlaskClient:
+    app = Flask(__name__)
+    app.register_blueprint(bram_api)  
+    return app.test_client()
+
+# Test for BramsApi GET
+@patch('submodule.rs_device_manager.RsDeviceManager.get_instance')
+def test_get_brams(mock_get_instance, client):
+    mock_device = mock_get_instance.return_value.get_device.return_value
+    mock_bram_module = mock_device.get_module.return_value
+    mock_bram_module.get_all.return_value = []
+    
+    response = client.get('/devices/test-device/bram')
+    
+    assert response.status_code == 200
+    assert response.json == []
+
+# Test for BramApi GET
+@patch('submodule.rs_device_manager.RsDeviceManager.get_instance')
+def test_get_bram(mock_get_instance, client):
+    mock_device = mock_get_instance.return_value.get_device.return_value
+    mock_bram_module = mock_device.get_module.return_value
+    mock_bram_module.get.return_value = {}
+
+    response = client.get('/devices/test-device/bram/0')
+    
+    assert response.status_code == 200
+
+# Test for BramApi DELETE
+@patch('submodule.rs_device_manager.RsDeviceManager.get_instance')
+@patch('submodule.rs_project.RsProjectManager.get_instance')
+def test_delete_bram(mock_get_instance, mock_project_mgr, client):
+    mock_device = mock_get_instance.return_value.get_device.return_value
+    mock_bram_module = mock_device.get_module.return_value
+
+    response = client.delete('/devices/test-device/bram/0')
+    
+    assert response.status_code == 204
+
+# Test for BramConsumptionApi GET
+@patch('submodule.rs_device_manager.RsDeviceManager.get_instance')
+def test_get_bram_consumption(mock_get_instance, client):
+    mock_device = mock_get_instance.return_value.get_device.return_value
+    mock_bram_module = mock_device.get_module.return_value
+    mock_bram_module.get_resources.return_value = (10, 20, 10, 20)
+    mock_bram_module.get_power_consumption.return_value = (0.5, 0.5)
+
+    response = client.get('/devices/test-device/bram/consumption')
+    
+    assert response.status_code == 200