add tests for preset json files

.github/workflows/code.yml

@@ -26,7 +26,7 @@ jobs:
           fetch-depth: 0
 
       - name: Install
-        run: npm install
+        run: npm ci
 
       - name: lint
         run: npm run lint

.github/workflows/deploy.yml

@@ -3,15 +3,12 @@ name: github-pages-deploy
 on:
   push:
     branches: ["main"]
-  pull_request:
-    branches: ["main"]
   workflow_dispatch:
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
     concurrency: ci-${{github.ref}}
-
     steps:
       - name: Checkout Source
         uses: actions/checkout@v3

README.md

@@ -3,13 +3,13 @@
 [![dedi-web code CI](https://github.com/tizayi/dedi-web/actions/workflows/code.yml/badge.svg)](https://github.com/tizayi/dedi-web/actions/workflows/code.yml)
 [![gh-pages](https://github.com/tizayi/dedi-web/actions/workflows/deploy.yml/badge.svg)](https://github.com/tizayi/dedi-web/actions/workflows/deploy.yml)
 
-A client only Q-Range calculator. Based on dedi within dawn science. Built using react, typescript, mui, zustand, three.js, and h5web/lib.
+A client only Q-Range calculator. Based on dedi within dawn science. Built using react, typescript, vite, mui, zustand, three.js, and h5web/lib.
 
 https://tizayi.github.io/dedi-web/
 
 ## Start dev server
 
-Start up
+Start dev server
 
 ```bash
   cd dedi-web

package.json

@@ -42,4 +42,4 @@
     "vite": "^4.4.5",
     "vitest": "^0.34.1"
   }
-}
+}

src/calculations/qvalue.ts

@@ -47,6 +47,6 @@ export const getPointForQ = (
   );
   return ray.getPointAtDistance(
     1.0e3 *
-      (calculateDistanceFromQValue(qValue, cameralength, wavelength) ?? 0),
+    (calculateDistanceFromQValue(qValue, cameralength, wavelength) ?? 0),
   );
 };

src/presets/preset.test.ts

@@ -0,0 +1,52 @@
+import { expect, test } from "vitest";
+import detectorData from "../presets/detectors.json";
+import presetData from "../presets/presetConfigs.json";
+import { Detector } from "../utils/types";
+import { AppDataFormat } from "./presetManager";
+
+const detectorList = detectorData as Record<string, Detector>;
+const presetList = presetData as Record<string, AppDataFormat>;
+const defaultConfig = presetList[Object.keys(presetList)[0]];
+
+
+// Also add some tests for input types
+
+
+
+test("Test detectors exist and are valid", () => {
+    expect(detectorList).toBeTruthy()
+    for (const detector in detectorList) {
+        expect(detectorList[detector]).toHaveProperty("resolution.width")
+        expect(detectorList[detector]).toHaveProperty("resolution.height")
+        expect(detectorList[detector]).toHaveProperty("pixelSize.width")
+        expect(detectorList[detector]).toHaveProperty("pixelSize.height")
+    }
+})
+
+test("Test beamstop and camera tube are valid", () => {
+    for (const preset in presetList) {
+        expect(presetList[preset]).toHaveProperty("beamstop.diameter")
+        expect(presetList[preset]).toHaveProperty("beamstop.centre.x")
+        expect(presetList[preset]).toHaveProperty("beamstop.centre.y")
+        expect(presetList[preset]).toHaveProperty("beamstop.clearance")
+        expect(presetList[preset]).toHaveProperty("cameraTube.centre.x")
+        expect(presetList[preset]).toHaveProperty("cameraTube.centre.y")
+        expect(presetList[preset]).toHaveProperty("cameraTube.diameter")
+    }
+
+})
+
+test("Test presets exist and are valid", () => {
+    expect(presetList).toBeTruthy()
+    expect(defaultConfig).toBeTruthy()
+    for (const preset in presetList) {
+        expect(Object.keys(detectorList)).toContain(presetList[preset].detector)
+        expect(presetList[preset]).toHaveProperty("angle")
+        expect(presetList[preset]).toHaveProperty("wavelength")
+        expect(presetList[preset]).toHaveProperty("cameraLength")
+        expect(presetList[preset]).toHaveProperty("minWavelength")
+        expect(presetList[preset]).toHaveProperty("maxWavelength")
+        expect(presetList[preset]).toHaveProperty("minCameraLength")
+        expect(presetList[preset]).toHaveProperty("maxCameraLength")
+    }
+})